donobu 5.27.3 → 5.28.0

package/dist/apis/FileUploadsApi.d.ts

@@ -0,0 +1,18 @@
+import type { Request, Response } from 'express';
+/**
+ * Admin endpoints for observing the local file upload queue. Used by the
+ * desktop app's quit flow: query status, surface to the user, let them
+ * decide between waiting for drain and quitting anyway.
+ *
+ * No mutating endpoint is needed — the worker is always trying to drain.
+ * Callers wanting a "wait for drain" UX poll this until the active count
+ * hits zero, then exit the backend.
+ */
+export declare class FileUploadsApi {
+    /**
+     * GET /api/uploads/status — returns total + per-platform counts of files
+     * pending upload, currently in-flight, or failed.
+     */
+    getStatus(_req: Request, res: Response): Promise<void>;
+}
+//# sourceMappingURL=FileUploadsApi.d.ts.map

package/dist/apis/FileUploadsApi.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileUploadsApi = void 0;
+const fileUploadWorkerRegistry_1 = require("../persistence/files/fileUploadWorkerRegistry");
+/**
+ * Admin endpoints for observing the local file upload queue. Used by the
+ * desktop app's quit flow: query status, surface to the user, let them
+ * decide between waiting for drain and quitting anyway.
+ *
+ * No mutating endpoint is needed — the worker is always trying to drain.
+ * Callers wanting a "wait for drain" UX poll this until the active count
+ * hits zero, then exit the backend.
+ */
+class FileUploadsApi {
+    /**
+     * GET /api/uploads/status — returns total + per-platform counts of files
+     * pending upload, currently in-flight, or failed.
+     */
+    async getStatus(_req, res) {
+        const status = await (0, fileUploadWorkerRegistry_1.getFileUploadAggregateStatus)();
+        res.json(status);
+    }
+}
+exports.FileUploadsApi = FileUploadsApi;
+//# sourceMappingURL=FileUploadsApi.js.map

package/dist/apis/ToolsApi.js

@@ -2,24 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ToolsApi = void 0;
 const v4_1 = require("zod/v4");
-const AcknowledgeUserInstruction_1 = require("../tools/AcknowledgeUserInstruction");
-const AssertPageTextTool_1 = require("../tools/AssertPageTextTool");
-const DetectBrokenLinksTool_1 = require("../tools/DetectBrokenLinksTool");
-const DownloadPdfTool_1 = require("../tools/DownloadPdfTool");
-const HandleBrowserDialogTool_1 = require("../tools/HandleBrowserDialogTool");
-const PauseForUserInteractionTool_1 = require("../tools/PauseForUserInteractionTool");
-const SaveWebpageAsPdfTool_1 = require("../tools/SaveWebpageAsPdfTool");
-const TriggerDonobuFlowTool_1 = require("../tools/TriggerDonobuFlowTool");
-const SUPPRESSED_TOOLS_BY_NAME = new Set([
-    AcknowledgeUserInstruction_1.AcknowledgeUserInstructionTool.NAME,
-    AssertPageTextTool_1.AssertPageTextTool.NAME,
-    DownloadPdfTool_1.DownloadPdfTool.NAME,
-    DetectBrokenLinksTool_1.DetectBrokenLinksTool.NAME,
-    HandleBrowserDialogTool_1.HandleBrowserDialogTool.NAME,
-    PauseForUserInteractionTool_1.PauseForUserInteractionTool.NAME,
-    SaveWebpageAsPdfTool_1.SaveWebpageAsPdfTool.NAME,
-    TriggerDonobuFlowTool_1.TriggerDonobuFlowTool.NAME,
-]);
+const toolConstants_1 = require("../tools/toolConstants");
 /**
  * This class reports the tools supported by the Donobu runtime.
  */
@@ -36,7 +19,7 @@ class ToolsApi {
             ? this.toolRegistry.toolsForTarget(targetType)
             : this.toolRegistry.allTools();
         const response = tools
-            .filter((tool) => !SUPPRESSED_TOOLS_BY_NAME.has(tool.name))
+            .filter((tool) => !toolConstants_1.SUPPRESSED_TOOLS_BY_NAME.has(tool.name))
             .map((tool) => ({
             name: tool.name,
             description: tool.description,

package/dist/clients/AnthropicGptClient.js

@@ -7,6 +7,7 @@ const GptPlatformAuthenticationFailedException_1 = require("../exceptions/GptPla
 const GptPlatformInsufficientQuotaException_1 = require("../exceptions/GptPlatformInsufficientQuotaException");
 const GptPlatformInternalErrorException_1 = require("../exceptions/GptPlatformInternalErrorException");
 const GptPlatformNotReachableException_1 = require("../exceptions/GptPlatformNotReachableException");
+const InvalidParamValueException_1 = require("../exceptions/InvalidParamValueException");
 const JsonUtils_1 = require("../utils/JsonUtils");
 const Logger_1 = require("../utils/Logger");
 const MiscUtils_1 = require("../utils/MiscUtils");
@@ -19,6 +20,9 @@ class AnthropicGptClient extends GptClient_1.GptClient {
     constructor(anthropicConfig) {
         super(anthropicConfig);
         this.anthropicConfig = anthropicConfig;
+        if (!/^[\x21-\x7e]{1,128}$/.test(anthropicConfig.apiKey)) {
+            throw new InvalidParamValueException_1.InvalidParamValueException('apiKey', 'REDACTED', 'it is malformed');
+        }
         this.headers = new Headers({
             [AnthropicGptClient.API_KEY_HEADER_NAME]: anthropicConfig.apiKey,
             [AnthropicGptClient.API_VERSION_HEADER_NAME]: AnthropicGptClient.API_VERSION_HEADER_VALUE,

package/dist/clients/OpenAiGptClient.js

@@ -7,6 +7,7 @@ const GptPlatformAuthenticationFailedException_1 = require("../exceptions/GptPla
 const GptPlatformInsufficientQuotaException_1 = require("../exceptions/GptPlatformInsufficientQuotaException");
 const GptPlatformInternalErrorException_1 = require("../exceptions/GptPlatformInternalErrorException");
 const GptPlatformNotReachableException_1 = require("../exceptions/GptPlatformNotReachableException");
+const InvalidParamValueException_1 = require("../exceptions/InvalidParamValueException");
 const JsonUtils_1 = require("../utils/JsonUtils");
 const Logger_1 = require("../utils/Logger");
 const MiscUtils_1 = require("../utils/MiscUtils");
@@ -20,6 +21,9 @@ class OpenAiGptClient extends GptClient_1.GptClient {
         super(openAiConfig);
         this.openAiConfig = openAiConfig;
         this.apiUrl = apiUrl;
+        if (!/^[\x21-\x7e]{1,128}$/.test(openAiConfig.apiKey)) {
+            throw new InvalidParamValueException_1.InvalidParamValueException('apiKey', 'REDACTED', 'it is malformed');
+        }
         this.headers = new Headers({
             Authorization: `Bearer ${openAiConfig.apiKey}`,
             'Content-Type': 'application/json',

package/dist/esm/apis/FileUploadsApi.d.ts

@@ -0,0 +1,18 @@
+import type { Request, Response } from 'express';
+/**
+ * Admin endpoints for observing the local file upload queue. Used by the
+ * desktop app's quit flow: query status, surface to the user, let them
+ * decide between waiting for drain and quitting anyway.
+ *
+ * No mutating endpoint is needed — the worker is always trying to drain.
+ * Callers wanting a "wait for drain" UX poll this until the active count
+ * hits zero, then exit the backend.
+ */
+export declare class FileUploadsApi {
+    /**
+     * GET /api/uploads/status — returns total + per-platform counts of files
+     * pending upload, currently in-flight, or failed.
+     */
+    getStatus(_req: Request, res: Response): Promise<void>;
+}
+//# sourceMappingURL=FileUploadsApi.d.ts.map

package/dist/esm/apis/FileUploadsApi.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileUploadsApi = void 0;
+const fileUploadWorkerRegistry_1 = require("../persistence/files/fileUploadWorkerRegistry");
+/**
+ * Admin endpoints for observing the local file upload queue. Used by the
+ * desktop app's quit flow: query status, surface to the user, let them
+ * decide between waiting for drain and quitting anyway.
+ *
+ * No mutating endpoint is needed — the worker is always trying to drain.
+ * Callers wanting a "wait for drain" UX poll this until the active count
+ * hits zero, then exit the backend.
+ */
+class FileUploadsApi {
+    /**
+     * GET /api/uploads/status — returns total + per-platform counts of files
+     * pending upload, currently in-flight, or failed.
+     */
+    async getStatus(_req, res) {
+        const status = await (0, fileUploadWorkerRegistry_1.getFileUploadAggregateStatus)();
+        res.json(status);
+    }
+}
+exports.FileUploadsApi = FileUploadsApi;
+//# sourceMappingURL=FileUploadsApi.js.map

package/dist/esm/apis/ToolsApi.js

@@ -2,24 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ToolsApi = void 0;
 const v4_1 = require("zod/v4");
-const AcknowledgeUserInstruction_1 = require("../tools/AcknowledgeUserInstruction");
-const AssertPageTextTool_1 = require("../tools/AssertPageTextTool");
-const DetectBrokenLinksTool_1 = require("../tools/DetectBrokenLinksTool");
-const DownloadPdfTool_1 = require("../tools/DownloadPdfTool");
-const HandleBrowserDialogTool_1 = require("../tools/HandleBrowserDialogTool");
-const PauseForUserInteractionTool_1 = require("../tools/PauseForUserInteractionTool");
-const SaveWebpageAsPdfTool_1 = require("../tools/SaveWebpageAsPdfTool");
-const TriggerDonobuFlowTool_1 = require("../tools/TriggerDonobuFlowTool");
-const SUPPRESSED_TOOLS_BY_NAME = new Set([
-    AcknowledgeUserInstruction_1.AcknowledgeUserInstructionTool.NAME,
-    AssertPageTextTool_1.AssertPageTextTool.NAME,
-    DownloadPdfTool_1.DownloadPdfTool.NAME,
-    DetectBrokenLinksTool_1.DetectBrokenLinksTool.NAME,
-    HandleBrowserDialogTool_1.HandleBrowserDialogTool.NAME,
-    PauseForUserInteractionTool_1.PauseForUserInteractionTool.NAME,
-    SaveWebpageAsPdfTool_1.SaveWebpageAsPdfTool.NAME,
-    TriggerDonobuFlowTool_1.TriggerDonobuFlowTool.NAME,
-]);
+const toolConstants_1 = require("../tools/toolConstants");
 /**
  * This class reports the tools supported by the Donobu runtime.
  */
@@ -36,7 +19,7 @@ class ToolsApi {
             ? this.toolRegistry.toolsForTarget(targetType)
             : this.toolRegistry.allTools();
         const response = tools
-            .filter((tool) => !SUPPRESSED_TOOLS_BY_NAME.has(tool.name))
+            .filter((tool) => !toolConstants_1.SUPPRESSED_TOOLS_BY_NAME.has(tool.name))
             .map((tool) => ({
             name: tool.name,
             description: tool.description,

package/dist/esm/clients/AnthropicGptClient.js

@@ -7,6 +7,7 @@ const GptPlatformAuthenticationFailedException_1 = require("../exceptions/GptPla
 const GptPlatformInsufficientQuotaException_1 = require("../exceptions/GptPlatformInsufficientQuotaException");
 const GptPlatformInternalErrorException_1 = require("../exceptions/GptPlatformInternalErrorException");
 const GptPlatformNotReachableException_1 = require("../exceptions/GptPlatformNotReachableException");
+const InvalidParamValueException_1 = require("../exceptions/InvalidParamValueException");
 const JsonUtils_1 = require("../utils/JsonUtils");
 const Logger_1 = require("../utils/Logger");
 const MiscUtils_1 = require("../utils/MiscUtils");
@@ -19,6 +20,9 @@ class AnthropicGptClient extends GptClient_1.GptClient {
     constructor(anthropicConfig) {
         super(anthropicConfig);
         this.anthropicConfig = anthropicConfig;
+        if (!/^[\x21-\x7e]{1,128}$/.test(anthropicConfig.apiKey)) {
+            throw new InvalidParamValueException_1.InvalidParamValueException('apiKey', 'REDACTED', 'it is malformed');
+        }
         this.headers = new Headers({
             [AnthropicGptClient.API_KEY_HEADER_NAME]: anthropicConfig.apiKey,
             [AnthropicGptClient.API_VERSION_HEADER_NAME]: AnthropicGptClient.API_VERSION_HEADER_VALUE,

package/dist/esm/clients/OpenAiGptClient.js

@@ -7,6 +7,7 @@ const GptPlatformAuthenticationFailedException_1 = require("../exceptions/GptPla
 const GptPlatformInsufficientQuotaException_1 = require("../exceptions/GptPlatformInsufficientQuotaException");
 const GptPlatformInternalErrorException_1 = require("../exceptions/GptPlatformInternalErrorException");
 const GptPlatformNotReachableException_1 = require("../exceptions/GptPlatformNotReachableException");
+const InvalidParamValueException_1 = require("../exceptions/InvalidParamValueException");
 const JsonUtils_1 = require("../utils/JsonUtils");
 const Logger_1 = require("../utils/Logger");
 const MiscUtils_1 = require("../utils/MiscUtils");
@@ -20,6 +21,9 @@ class OpenAiGptClient extends GptClient_1.GptClient {
         super(openAiConfig);
         this.openAiConfig = openAiConfig;
         this.apiUrl = apiUrl;
+        if (!/^[\x21-\x7e]{1,128}$/.test(openAiConfig.apiKey)) {
+            throw new InvalidParamValueException_1.InvalidParamValueException('apiKey', 'REDACTED', 'it is malformed');
+        }
         this.headers = new Headers({
             Authorization: `Bearer ${openAiConfig.apiKey}`,
             'Content-Type': 'application/json',

package/dist/esm/init.d.ts

@@ -15,4 +15,29 @@
  * long-lived processes unexpectedly.
  */
 export declare function installCrashHandlers(): void;
+/**
+ * Installs SIGTERM/SIGINT handlers that drain any in-flight file uploads
+ * (bounded by {@link SHUTDOWN_FLUSH_TIMEOUT_MS}) before exiting cleanly.
+ *
+ * **Intended primarily as a developer / CLI fallback.** In production the
+ * desktop app drives shutdown explicitly: it queries
+ * `GET /api/uploads/status`, surfaces the count to the user, and either
+ * (a) waits for the worker to drain on its own and then terminates the
+ * backend, or (b) terminates immediately on user request. In that path
+ * these handlers may not fire at all — terminations from the host are
+ * what they are.
+ *
+ * For `node dist/main.js` runs (developers, integration tests), Ctrl+C
+ * still benefits from a graceful drain so test artefacts don't pile up
+ * as `.uploading.<token>` markers.
+ *
+ * Same constraint as {@link installCrashHandlers}: only call this when
+ * running as a standalone server, never when imported as a library —
+ * process-wide signal handlers would hijack the host.
+ *
+ * Uploads that don't complete within the timeout stay on disk as
+ * `.uploading.<token>` markers; another Studio process will reclaim them
+ * once the claim goes stale (5 min default).
+ */
+export declare function installShutdownHandlers(): void;
 //# sourceMappingURL=init.d.ts.map

package/dist/esm/init.js

@@ -8,8 +8,11 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.installCrashHandlers = installCrashHandlers;
+exports.installShutdownHandlers = installShutdownHandlers;
+const fileUploadWorkerRegistry_1 = require("./persistence/files/fileUploadWorkerRegistry");
 const JsonUtils_1 = require("./utils/JsonUtils");
 const Logger_1 = require("./utils/Logger");
+const SHUTDOWN_FLUSH_TIMEOUT_MS = 30_000;
 /**
  * Installs global error handlers that crash the process on unhandled errors.
  *
@@ -62,4 +65,53 @@ function installCrashHandlers() {
         process.exit(1);
     });
 }
+/**
+ * Installs SIGTERM/SIGINT handlers that drain any in-flight file uploads
+ * (bounded by {@link SHUTDOWN_FLUSH_TIMEOUT_MS}) before exiting cleanly.
+ *
+ * **Intended primarily as a developer / CLI fallback.** In production the
+ * desktop app drives shutdown explicitly: it queries
+ * `GET /api/uploads/status`, surfaces the count to the user, and either
+ * (a) waits for the worker to drain on its own and then terminates the
+ * backend, or (b) terminates immediately on user request. In that path
+ * these handlers may not fire at all — terminations from the host are
+ * what they are.
+ *
+ * For `node dist/main.js` runs (developers, integration tests), Ctrl+C
+ * still benefits from a graceful drain so test artefacts don't pile up
+ * as `.uploading.<token>` markers.
+ *
+ * Same constraint as {@link installCrashHandlers}: only call this when
+ * running as a standalone server, never when imported as a library —
+ * process-wide signal handlers would hijack the host.
+ *
+ * Uploads that don't complete within the timeout stay on disk as
+ * `.uploading.<token>` markers; another Studio process will reclaim them
+ * once the claim goes stale (5 min default).
+ */
+function installShutdownHandlers() {
+    let shuttingDown = false;
+    const handle = (signal) => {
+        if (shuttingDown) {
+            return;
+        }
+        shuttingDown = true;
+        void (async () => {
+            Logger_1.appLogger.info(`Received ${signal}; draining file upload workers.`);
+            try {
+                const result = await (0, fileUploadWorkerRegistry_1.shutdownFileUploadWorkers)(SHUTDOWN_FLUSH_TIMEOUT_MS);
+                if (!result.drained) {
+                    Logger_1.appLogger.warn(`File upload queue did not fully drain at shutdown; ` +
+                        `${result.totalRemaining} upload(s) remain on disk and will resume on next start.`);
+                }
+            }
+            catch (err) {
+                Logger_1.appLogger.error(`Error draining file upload workers at shutdown: ${err.message}`);
+            }
+            process.exit(0);
+        })();
+    };
+    process.on('SIGTERM', handle);
+    process.on('SIGINT', handle);
+}
 //# sourceMappingURL=init.js.map

package/dist/esm/lib/page/extendPage.js

@@ -21,6 +21,7 @@ const ChangeWebBrowserTabTool_1 = require("../../tools/ChangeWebBrowserTabTool")
 const CreateBrowserCookieReportTool_1 = require("../../tools/CreateBrowserCookieReportTool");
 const GoToWebpageTool_1 = require("../../tools/GoToWebpageTool");
 const RunAccessibilityTestTool_1 = require("../../tools/RunAccessibilityTestTool");
+const ansi_1 = require("../../utils/ansi");
 const BrowserUtils_1 = require("../../utils/BrowserUtils");
 const Logger_1 = require("../../utils/Logger");
 const MiscUtils_1 = require("../../utils/MiscUtils");
@@ -241,7 +242,11 @@ Valid options:
                     // All retry attempts exhausted
                     throw new ToolCallFailedException_1.ToolCallFailedException(AssertTool_1.AssertTool.NAME, {
                         isSuccessful: false,
-                        forLlm: `Assertion FAILED (cached) for: ${assertion}\nPlaywright Error: ${lastError?.message}`,
+                        // Strip ANSI: Playwright matchers style their messages for the
+                        // terminal, but this string flows into JSON-stringified exception
+                        // messages, the LLM, and HTML/markdown reports — places where the
+                        // codes never render and just become visible junk.
+                        forLlm: `Assertion FAILED (cached) for: ${assertion}\nPlaywright Error: ${(0, ansi_1.stripAnsi)(lastError?.message ?? '')}`,
                         metadata: {
                             cached: true,
                             steps: cached.steps,

package/dist/esm/lib/test/testExtension.d.ts

@@ -1,3 +1,4 @@
+import type { PlaywrightWorkerOptions } from '@playwright/test';
 import type { GptClient } from '../../clients/GptClient';
 import type { BrowserStorageState } from '../../models/BrowserStorageState';
 import { FlowLogBuffer } from '../../utils/FlowLogBuffer';
@@ -11,5 +12,18 @@ export declare const test: import("@playwright/test").TestType<import("@playwrig
     storageState?: BrowserStorageState | Promise<BrowserStorageState>;
     gptClient?: GptClient;
     page: DonobuExtendedPage;
-}, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
+}, import("@playwright/test").PlaywrightWorkerArgs & PlaywrightWorkerOptions & {
+    /**
+     * Auto worker-scoped fixture that drains pending file uploads to
+     * Donobu Cloud at the end of each Playwright worker's lifetime. Without
+     * this, the worker process would exit while uploads are still in-flight
+     * — fine for local dev (the next process resumes them) but a real
+     * data-loss case in ephemeral CI runners.
+     *
+     * Logs loudly when it has work to do so the user understands why
+     * teardown is taking time instead of wondering why the process isn't
+     * exiting.
+     */
+    donobuFileUploadDrainGuard: void;
+}>;
 //# sourceMappingURL=testExtension.d.ts.map