feat(shorebird_code_push): rewrite Dart API (#225)

Author: felangel

.github/workflows/main.yaml

@@ -58,7 +58,7 @@ jobs:
       matrix:
         crate: ${{ fromJSON(needs.changes.outputs.needs_rust_build) }}
 
-    runs-on: ubuntu-latest
+    runs-on: macos-latest
 
     name: 🦀 Build ${{ matrix.crate }}
 
@@ -98,12 +98,7 @@ jobs:
           working_directory: ${{ matrix.package }}
 
   ci:
-    needs:
-      [
-        semantic_pull_request,
-        build_flutter_packages,
-        build_rust_crates,
-      ]
+    needs: [semantic_pull_request, build_flutter_packages, build_rust_crates]
     if: ${{ always() }}
 
     runs-on: ubuntu-latest

library/include/updater.h

@@ -14,6 +14,33 @@
 #endif
 
 
+/**
+ * An unknown error occurred while updating. The update was not installed.
+ * This is a catch-all for errors that don't fit into the other categories.
+ */
+#define SHOREBIRD_UPDATE_ERROR -1
+
+/**
+ * No update is available (e.g. the app is already up-to-date)
+ */
+#define SHOREBIRD_NO_UPDATE 0
+
+/**
+ * An update was installed successfully. It will boot from the update on the
+ * next app launch.
+ */
+#define SHOREBIRD_UPDATE_INSTALLED 1
+
+/**
+ * An error occurred while updating. The update was not installed.
+ */
+#define SHOREBIRD_UPDATE_HAD_ERROR 2
+
+/**
+ * The downloaded patch was not installed because it was invalid.
+ */
+#define SHOREBIRD_UPDATE_IS_BAD_PATCH 3
+
 /**
  * Struct containing configuration parameters for the updater.
  * Passed to all updater functions.
@@ -69,6 +96,11 @@ typedef struct FileCallbacks {
   void (*close)(void *file_handle);
 } FileCallbacks;
 
+typedef struct UpdateResult {
+  int32_t status;
+  const char *message;
+} UpdateResult;
+
 #ifdef __cplusplus
 extern "C" {
 #endif // __cplusplus
@@ -114,7 +146,9 @@ SHOREBIRD_EXPORT char *shorebird_next_boot_patch_path(void);
  * If this function is called with a non-null pointer, it must be a pointer
  * returned by the updater library.
  */
-SHOREBIRD_EXPORT void shorebird_free_string(char *c_string);
+SHOREBIRD_EXPORT void shorebird_free_string(const char *c_string);
+
+SHOREBIRD_EXPORT void shorebird_free_update_result(struct UpdateResult *result);
 
 /**
  * Check for an update.  Returns true if an update is available.
@@ -126,6 +160,12 @@ SHOREBIRD_EXPORT bool shorebird_check_for_update(void);
  */
 SHOREBIRD_EXPORT void shorebird_update(void);
 
+/**
+ * Synchronously download an update if one is available.
+ * Returns an [UpdateResult] indicating whether the update was successful.
+ */
+SHOREBIRD_EXPORT const struct UpdateResult *shorebird_update_with_result(void);
+
 /**
  * Start a thread to download an update if one is available.
  */