Merge pull request #1851 from gofractally/improve-user-prompt-implementation

Improve user prompt implementation

Author: James-Mart

packages/user/Supervisor/ui/src/constants.ts

@@ -1,5 +1,3 @@
-import { REDIRECT_ERROR_CODE } from "@/constants";
-
 import {
     QualifiedDynCallArgs,
     QualifiedFunctionCallArgs,
@@ -14,7 +12,7 @@ import {
     HttpResponse,
 } from "../host-interface";
 import { Supervisor } from "../supervisor";
-import { chainId, isEmbedded, networkName } from "../utils";
+import { chainId, networkName } from "../utils";
 import { RecoverableErrorPayload } from "./errors";
 
 function convert(
@@ -228,16 +226,7 @@ export class PluginHost implements HostInterface {
                 remove: (duration, key) => this.dbRemove(duration, key),
             },
             "supervisor:bridge/prompt": {
-                requestPrompt: () => {
-                    if (isEmbedded) {
-                        throw this.recoverableError(
-                            "Cannot prompt in embedded mode",
-                        );
-                    }
-                    const err = this.recoverableError("user_prompt_request");
-                    err.code = REDIRECT_ERROR_CODE;
-                    throw err;
-                },
+                requestPrompt: () => this.supervisor.requestPrompt(),
             },
         };
     }

packages/user/Supervisor/ui/src/plugin/plugin-host.ts

@@ -20,7 +20,6 @@ import { pluginId } from "@psibase/common-lib/messaging/plugin-id";
 
 import { AppInterface } from "./app-interface";
 import { CallContext } from "./call-context";
-import { REDIRECT_ERROR_CODE } from "./constants";
 import { getRecoverableError } from "./plugin/errors";
 import { PluginLoader } from "./plugin/plugin-loader";
 import { Plugins } from "./plugin/plugins";
@@ -49,6 +48,19 @@ const systemPlugins: Array<QualifiedPluginId> = [
     pluginId("webcrypto", "plugin"),
 ];
 
+// Control-flow signal thrown to unwind out of a plugin call.
+//
+// It extends Error so that JCO-transpiled glue never intercepts it: JCO's
+// getErrorPayload() re-throws Error instances rather than converting them into a
+// component Result::Err. The one exception is an Error carrying its own "payload"
+// property, so this class must NOT define one.
+class PromptSignal extends Error {
+    constructor(readonly kind: "prompt" | "embedded-error" | "preload-error") {
+        super(`prompt-signal:${kind}`);
+        this.name = "PromptSignal";
+    }
+}
+
 // The supervisor facilitates all communication
 export class Supervisor implements AppInterface {
     private plugins: Plugins;
@@ -59,6 +71,8 @@ export class Supervisor implements AppInterface {
 
     private embedder: string | undefined;
 
+    private inPreload = false;
+
     parser: Promise<any>;
 
     parentOrigination: OriginationData | undefined;
@@ -111,55 +125,72 @@ export class Supervisor implements AppInterface {
     }
 
     private async doPreload(plugins: QualifiedPluginId[]) {
-        await chainIdPromise;
+        this.inPreload = true;
+        try {
+            await chainIdPromise;
 
-        if (plugins.length === 0) {
-            return;
-        }
+            if (plugins.length === 0) {
+                return;
+            }
 
-        // Phase 0: Loads systemPlugins, including those needed to get current user, i.e., accounts, host:auth
-        this.loader.trackPlugins([...systemPlugins]);
-        await this.loader.processPlugins();
-        await this.loader.awaitReady();
+            // Phase 0: Loads systemPlugins, including those needed to get current user, i.e., accounts, host:auth
+            this.loader.trackPlugins([...systemPlugins]);
+            await this.loader.processPlugins();
+            await this.loader.awaitReady();
 
-        // Required to instantiate system plugins to execute the plugin calls below
-        await this.plugins.instantiateAll();
+            // Required to instantiate system plugins to execute the plugin calls below
+            await this.plugins.instantiateAll();
 
-        if (isEmbedded) {
-            const promptDetails = await this.supervisorCall(
-                getCallArgs("host", "prompt", "admin", "get-active-prompt", []),
-            );
-            if (promptDetails) {
-                this.embedder = promptDetails.activeApp;
-                delete this.context; // A new one will be created with the embedder
+            if (isEmbedded) {
+                const promptDetails = await this.supervisorCall(
+                    getCallArgs(
+                        "host",
+                        "prompt",
+                        "admin",
+                        "get-active-prompt",
+                        [],
+                    ),
+                );
+                if (promptDetails) {
+                    this.embedder = promptDetails.activeApp;
+                    delete this.context; // A new one will be created with the embedder
+                }
             }
-        }
 
-        setQueryToken(this.getActiveQueryToken());
-
-        // Phase 1: Compile app plugins (NO instantiation yet — Memory deferred).
-        // The sync call to getAuthServices below only touches Phase 0 plugins.
-        this.loader.trackPlugins([...plugins]);
-        await this.loader.processPlugins();
-        await this.loader.awaitReady();
+            setQueryToken(this.getActiveQueryToken());
+
+            // Phase 1: Compile app plugins (NO instantiation yet — Memory deferred).
+            // The sync call to getAuthServices below only touches Phase 0 plugins.
+            this.loader.trackPlugins([...plugins]);
+            await this.loader.processPlugins();
+            await this.loader.awaitReady();
+
+            // Phase 2: Load the auth services for all connected accounts.
+            // This sync call uses accounts:plugin (Phase 0, already instantiated).
+            const auth_services: string[] = this.supervisorCall(
+                getCallArgs(
+                    "accounts",
+                    "plugin",
+                    "admin",
+                    "get-auth-services",
+                    [],
+                ),
+            );
 
-        // Phase 2: Load the auth services for all connected accounts.
-        // This sync call uses accounts:plugin (Phase 0, already instantiated).
-        const auth_services: string[] = this.supervisorCall(
-            getCallArgs("accounts", "plugin", "admin", "get-auth-services", []),
-        );
+            const addtl_plugins: QualifiedPluginId[] = [];
+            for (const service of auth_services) {
+                if (!service) continue;
 
-        const addtl_plugins: QualifiedPluginId[] = [];
-        for (const service of auth_services) {
-            if (!service) continue;
+                // Current limitation: an auth service plugin must be called "plugin" ("<service>:plugin")
+                addtl_plugins.push(pluginId(service, "plugin"));
+            }
+            this.loader.trackPlugins(addtl_plugins);
 
-            // Current limitation: an auth service plugin must be called "plugin" ("<service>:plugin")
-            addtl_plugins.push(pluginId(service, "plugin"));
+            await this.loader.processPlugins();
+            await this.loader.awaitReady();
+        } finally {
+            this.inPreload = false;
         }
-        this.loader.trackPlugins(addtl_plugins);
-
-        await this.loader.processPlugins();
-        await this.loader.awaitReady();
     }
 
     private replyToParent(id: string, result: any) {
@@ -270,6 +301,13 @@ export class Supervisor implements AppInterface {
         );
     }
 
+    requestPrompt(): never {
+        if (this.inPreload) {
+            throw new PromptSignal("preload-error");
+        }
+        throw new PromptSignal(isEmbedded ? "embedded-error" : "prompt");
+    }
+
     call(args: QualifiedFunctionCallArgs): any {
         assertTruthy(this.context, "Uninitialized call context");
 
@@ -431,21 +469,35 @@ export class Supervisor implements AppInterface {
             // Send plugin result to parent window
             this.replyToParent(id, result);
         } catch (e) {
-            const err = getRecoverableError(e);
-            if (err) {
-                let newError;
-                if (err.code === REDIRECT_ERROR_CODE) {
-                    newError = new RedirectErrorObject(
-                        err.producer,
-                        err.message,
-                    );
-                } else {
-                    newError = new PluginErrorObject(err.producer, err.message);
-                }
-                this.replyToParent(id, newError);
+            let result: any;
+            if (e instanceof PromptSignal && e.kind === "prompt") {
+                result = new RedirectErrorObject(
+                    { service: "host", plugin: "prompt" },
+                    "user_prompt_request",
+                );
+            } else if (
+                e instanceof PromptSignal &&
+                e.kind === "embedded-error"
+            ) {
+                result = new PluginErrorObject(
+                    { service: "host", plugin: "prompt" },
+                    "Cannot prompt in embedded mode",
+                );
+            } else if (
+                e instanceof PromptSignal &&
+                e.kind === "preload-error"
+            ) {
+                result = new PluginErrorObject(
+                    { service: "host", plugin: "prompt" },
+                    "Cannot trigger user prompt during plugin preload",
+                );
             } else {
-                this.replyToParent(id, e);
+                const err = getRecoverableError(e);
+                result = err
+                    ? new PluginErrorObject(err.producer, err.message)
+                    : e;
             }
+            this.replyToParent(id, result);
         } finally {
             this.plugins.disposeAll();
             this.cleanupSessionState();

packages/user/Supervisor/ui/src/supervisor.ts

@@ -156,11 +156,11 @@ pub fn authorized_with_whitelist<T: TrustConfig + ?Sized>(
 ) -> Result<bool, Error> {
     let whitelist: Vec<String> = whitelist.iter().map(|s| s.to_string()).collect();
     let descriptions = T::get_descriptions();
-    Ok(permissions::api::is_authorized(
+    permissions::api::is_authorized(
         &host::client::get_sender(),
         level,
         &descriptions,
         fn_name,
         &whitelist,
-    )?)
+    )
 }