feat: Extract app-init-no-cleanup-on-error subworkflow for proper cleanup

Calling `app-init-no-cleanup-on-error` as a child execution has the benefit
of containing execution failures (traps) and also catching and handling them.

Author: tomasol

workflow/deployer-workflow/impl-flyio/src/lib.rs

@@ -5,19 +5,25 @@ mod generated {
 use const_format::formatcp;
 use generated::{
     export,
-    exports::obelisk_flyio::workflow::workflow::{
-        AppCleanupFailed, AppInitError, AppInitModifyError, Guest, ObeliskConfig, SecretKey,
-        ServeError,
-    },
+    exports::obelisk_flyio::workflow::workflow::Guest,
     obelisk::{types::time::ScheduleAt, workflow::workflow_support},
-    obelisk_flyio::activity_fly_http::{
-        self,
-        machines::{
-            CpuKind, GuestConfig, InitConfig, MachineConfig, MachineRestart, MachineState, Mount,
-            RestartPolicy,
+    obelisk_flyio::{
+        activity_fly_http::{
+            self,
+            machines::{
+                CpuKind, GuestConfig, InitConfig, MachineConfig, MachineRestart, MachineState,
+                Mount, RestartPolicy,
+            },
+            regions::Region,
+            volumes::VolumeCreateRequest,
+        },
+        workflow::{
+            types::{AppCleanupFailed, AppInitModifyError},
+            workflow::{
+                self as workflow_import, AppInitError, AppInitNoCleanupError, ObeliskConfig,
+                SecretKey, ServeError,
+            },
         },
-        regions::Region,
-        volumes::VolumeCreateRequest,
     },
 };
 
@@ -142,43 +148,66 @@ fn app_modify_without_cleanup(
         )));
     }
     // Attempt to shutdown the temp VM.
-    let _ = activity_fly_http::machines::stop(app_name, &temp_vm); // Ignore failure to shut down, temp VM will be deleted with force.
+    // Ignore failure to shut down, temp VM will be deleted with force.
+    let _ = activity_fly_http::machines::stop(app_name, &temp_vm);
     activity_fly_http::machines::delete(app_name, &temp_vm, true)
         .map_err(AppInitModifyError::TempVmError)?;
 
     // All OK, return secrets that are needed by the configuration.
     Ok(get_secret_keys(&config))
 }
 
+fn cleanup(app_name: &str, modify_error: Option<AppInitModifyError>) -> AppInitError {
+    // Delete the app with force.
+    match activity_fly_http::apps::delete(app_name, true) {
+        Ok(()) => AppInitError::CleanupOk,
+        Err(cleanup_error) => AppInitError::CleanupFailed(AppCleanupFailed {
+            modify_error,
+            cleanup_error,
+        }),
+    }
+}
+
 impl Guest for Component {
-    fn app_init(
+    fn app_init_no_cleanup_on_error(
         org_slug: String,
         app_name: String,
-        cleanup: bool,
         config: ObeliskConfig,
-    ) -> Result<Vec<SecretKey>, AppInitError> {
+    ) -> Result<Vec<SecretKey>, AppInitNoCleanupError> {
         // If the app already exists, fail with AppNameConflict
         if activity_fly_http::apps::get(&app_name)
-            .map_err(AppInitError::AppCreateError)?
+            .map_err(AppInitNoCleanupError::AppCreateError)?
             .is_some()
         {
-            return Err(AppInitError::AppNameConflict);
+            return Err(AppInitNoCleanupError::AppNameConflict);
         }
-        // Create app, clean up on error
-        activity_fly_http::apps::put(&org_slug, &app_name).map_err(AppInitError::AppCreateError)?;
-        app_modify_without_cleanup(&app_name, config).map_err(|modify_error| {
-            if cleanup {
-                match activity_fly_http::apps::delete(&app_name, true) {
-                    Ok(()) => AppInitError::CleanupOk(modify_error),
-                    Err(cleanup_error) => AppInitError::CleanupFailed(AppCleanupFailed {
-                        modify_error,
-                        cleanup_error,
-                    }),
+        // Create the app
+        activity_fly_http::apps::put(&org_slug, &app_name)
+            .map_err(AppInitNoCleanupError::AppCreateError)?;
+        app_modify_without_cleanup(&app_name, config)
+            .map_err(AppInitNoCleanupError::AppInitModifyError)
+    }
+
+    fn app_init(
+        org_slug: String,
+        app_name: String,
+        config: ObeliskConfig,
+    ) -> Result<Vec<SecretKey>, AppInitError> {
+        // Launch a child workflow by using import
+        workflow_import::app_init_no_cleanup_on_error(&org_slug, &app_name, &config).map_err(
+            |err| match err {
+                AppInitNoCleanupError::AppCreateError(err) => {
+                    // No cleanup needed, app creation failed.
+                    AppInitError::AppCreateError(err)
                 }
-            } else {
-                AppInitError::CleanupSkipped(modify_error)
-            }
-        })
+                AppInitNoCleanupError::AppNameConflict => {
+                    // No cleanup needed, app creation failed on name conflict.
+                    AppInitError::AppNameConflict
+                }
+                AppInitNoCleanupError::AppInitModifyError(err) => cleanup(&app_name, Some(err)),
+                AppInitNoCleanupError::ExecutionFailure => cleanup(&app_name, None),
+            },
+        )
     }
 
     fn serve(_app_name: String) -> Result<(), ServeError> {

workflow/deployer-workflow/impl-flyio/wit/impl.wit

@@ -1,10 +1,15 @@
 package any:any;
 
 world any {
-    include obelisk-flyio:workflow/exports@1.0.0-beta;
+    //include obelisk-flyio:workflow/exports@1.0.0-beta;
+    export obelisk-flyio:workflow/workflow@1.0.0-beta;
+
+    // Import the same interface for creating child workflows.
+    import obelisk-flyio:workflow/workflow@1.0.0-beta;
 
     import obelisk-flyio:activity-fly-http/apps@1.0.0-beta;
     import obelisk-flyio:activity-fly-http/machines@1.0.0-beta;
     import obelisk-flyio:activity-fly-http/volumes@1.0.0-beta;
+
     import obelisk:workflow/workflow-support@3.0.0;
 }

workflow/deployer-workflow/wit/obelisk-flyio_workflow@1.0.0-beta/types.wit

@@ -0,0 +1,87 @@
+package obelisk-flyio:workflow@1.0.0-beta;
+
+interface types {
+
+    // Same syntax as in obelisk.toml - "key" or "key=val"
+    type env-var = string;
+
+    record obelisk-config {
+        activity-wasm-list: option<list<activity-wasm>>,
+        workflow-list: option<list<workflow>>,
+        webhook-endpoint-list: option<list<webhok-endpoint>>,
+    }
+
+    record activity-wasm {
+        name: string,
+        location-oci: string,
+        env-vars: option<list<env-var>>,
+        lock-expiry-seconds: option<u32>,
+    }
+
+    record workflow {
+        name: string,
+        location-oci: string,
+    }
+
+    record webhok-endpoint {
+        name: string,
+        location-oci: string,
+        routes: list<route>,
+        env-vars: option<list<env-var>>,
+    }
+
+    record route {
+        methods: list<string>,
+        path: string,
+    }
+
+    record secret-key {
+        name: string,
+        /// Set to true if the app already contains this secret.
+        present: bool,
+    }
+
+    variant app-init-modify-error {
+        /// Cannot create the volume
+        volume-create-error(string),
+        /// Cannot start the temporary VM
+        temp-vm-error(string),
+        /// Cannot place files on the volume.
+        volume-write-error(string),
+        /// Error running `obelisk server verify -i`
+        verify-error(string),
+    }
+
+    record app-cleanup-failed {
+        /// The associated value contains the reason of failure, if available.
+        /// If the payload is missing a trap in child workflow occurred.
+        modify-error: option<app-init-modify-error>,
+        /// Reason why cleanup failed.
+        cleanup-error: string,
+    }
+
+    variant app-init-no-cleanup-error {
+        app-name-conflict,
+        app-create-error(string),
+        app-init-modify-error(app-init-modify-error),
+        execution-failure,
+    }
+
+    variant app-init-error {
+        app-name-conflict,
+        app-create-error(string),
+        /// App init failed, cleanup was successful.
+        cleanup-ok,
+        /// App init failed, cleanup failed.
+        /// The associated value contains the reason of failure, if available.
+        cleanup-failed(app-cleanup-failed),
+        execution-failure,
+    }
+
+    variant serve-error {
+        vm-start-error(string),
+        healthcheck-error(string),
+        execution-failure,
+    }
+
+}

workflow/deployer-workflow/wit/obelisk-flyio_workflow@1.0.0-beta/workflow.wit

@@ -1,76 +1,7 @@
 package obelisk-flyio:workflow@1.0.0-beta;
 
 interface workflow {
-
-    // Same syntax as in obelisk.toml - "key" or "key=val"
-    type env-var = string;
-
-    record obelisk-config {
-        activity-wasm-list: option<list<activity-wasm>>,
-        workflow-list: option<list<workflow>>,
-        webhook-endpoint-list: option<list<webhok-endpoint>>,
-    }
-
-    record activity-wasm {
-        name: string,
-        location-oci: string,
-        env-vars: option<list<env-var>>,
-        lock-expiry-seconds: option<u32>,
-    }
-
-    record workflow {
-        name: string,
-        location-oci: string,
-    }
-
-    record webhok-endpoint {
-        name: string,
-        location-oci: string,
-        routes: list<route>,
-        env-vars: option<list<env-var>>,
-    }
-
-    record route {
-        methods: list<string>,
-        path: string,
-    }
-
-    record secret-key {
-        name: string,
-        /// Set to true if the app already contains this secret.
-        present: bool,
-    }
-
-    variant app-init-modify-error {
-        /// Cannot create the volume
-        volume-create-error(string),
-        /// Cannot start the temporary VM
-        temp-vm-error(string),
-        /// Cannot place files on the volume.
-        volume-write-error(string),
-        /// Error running `obelisk server verify -i`
-        verify-error(string),
-    }
-
-    record app-cleanup-failed {
-        modify-error: app-init-modify-error,
-        cleanup-error: string,
-    }
-
-    variant app-init-error {
-        app-name-conflict,
-        app-create-error(string),
-        cleanup-ok(app-init-modify-error),
-        cleanup-failed(app-cleanup-failed),
-        cleanup-skipped(app-init-modify-error),
-        execution-failure,
-    }
-
-    variant serve-error {
-        vm-start-error(string),
-        healthcheck-error(string),
-        execution-failure,
-    }
+    use types.{obelisk-config, secret-key, app-init-no-cleanup-error, app-init-error, serve-error};
 
     /// Chcek whether the app_name exists. If it does, return app-name-conflict.
     /// Create a fly app.
@@ -79,11 +10,19 @@ interface workflow {
     /// Store the config file and download WASM components + AOT generated code (`obelisk server verify --ignore-missing-env-vars`).
     /// Shutdown and delete the temporary VM.
     /// Return list of secret keys the config requires.
-    /// Any error except for app-name-conflict will trigger the whole app to be deleted, leaving the state as it was before this function was called.
+    app-init-no-cleanup-on-error: func(
+        org-slug: string,
+        app-name: string,
+        config: obelisk-config,
+        ) -> result<list<secret-key>, app-init-no-cleanup-error>;
+
+    /// Same as `app-init-no-cleanup` but performs cleanup on errors.
+    /// If an error occurs during app configuration
+    /// the app is deleted, leaving the state as it was before this function was called.
+    /// If the cleanup fails as well `cleanup-error` is raised.
     app-init: func(
         org-slug: string,
         app-name: string,
-        cleanup: bool,
         config: obelisk-config,
         ) -> result<list<secret-key>, app-init-error>;