@dbos-inc/dbos-sdk 3.0.27-preview → 3.0.35-preview

package/dist/src/dbos.js

@@ -1,4 +1,7 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InitContext = exports.DBOS = exports.runInternalStep = exports.getExecutor = void 0;
 const context_1 = require("./context");
@@ -8,6 +11,7 @@ const logs_1 = require("./telemetry/logs");
 const error_1 = require("./error");
 const config_1 = require("./dbos-runtime/config");
 const runtime_1 = require("./dbos-runtime/runtime");
+const scheduler_1 = require("./scheduler/scheduler");
 const decorators_1 = require("./decorators");
 const utils_1 = require("./utils");
 const server_1 = require("./httpServer/server");
@@ -17,14 +21,13 @@ const node_crypto_1 = require("node:crypto");
 const _1 = require(".");
 const _2 = require(".");
 const handlerTypes_1 = require("./httpServer/handlerTypes");
-const lodash_1 = require("lodash");
 const conductor_1 = require("./conductor/conductor");
-const system_database_1 = require("./system_database");
 const wfqueue_1 = require("./wfqueue");
 const authdecorators_1 = require("./authdecorators");
+const node_assert_1 = __importDefault(require("node:assert"));
 function httpApiDec(verb, url) {
     return function apidec(target, propertyKey, inDescriptor) {
-        const { descriptor, registration } = (0, decorators_1.registerAndWrapDBOSFunction)(target, propertyKey, inDescriptor);
+        const { descriptor, registration } = (0, decorators_1.wrapDBOSFunctionAndRegisterDec)(target, propertyKey, inDescriptor);
         const handlerRegistration = registration;
         handlerRegistration.apiURL = url;
         handlerRegistration.apiType = verb;
@@ -62,49 +65,13 @@ class DBOS {
     static adminServer = undefined;
     static appServer = undefined;
     static conductor = undefined;
-    static getDebugModeFromEnv() {
-        const debugWorkflowId = process.env.DBOS_DEBUG_WORKFLOW_ID;
-        return debugWorkflowId !== undefined;
-    }
     /**
      * Set configuration of `DBOS` prior to `launch`
      * @param config - configuration of services needed by DBOS
-     * @param runtimeConfig - configuration of runtime access to DBOS
      */
-    static setConfig(config, runtimeConfig) {
+    static setConfig(config) {
+        (0, node_assert_1.default)(!DBOS.isInitialized(), 'Cannot call DBOS.setConfig after DBOS.launch');
         DBOS.#dbosConfig = config;
-        DBOS.#runtimeConfig = runtimeConfig;
-        DBOS.translateConfig();
-    }
-    static translateConfig() {
-        if (DBOS.#dbosConfig && !(0, dbos_executor_1.isDeprecatedDBOSConfig)(DBOS.#dbosConfig)) {
-            const debugMode = DBOS.getDebugModeFromEnv();
-            [DBOS.#dbosConfig, DBOS.#runtimeConfig] = (0, config_1.translatePublicDBOSconfig)(DBOS.#dbosConfig, debugMode);
-            if (process.env.DBOS__CLOUD === 'true') {
-                [DBOS.#dbosConfig, DBOS.#runtimeConfig] = (0, config_1.overwrite_config)(DBOS.#dbosConfig, DBOS.#runtimeConfig);
-            }
-        }
-    }
-    /**
-     * @deprecated For unit testing purposes only
-     *   Use `setConfig`
-     */
-    static setAppConfig(key, newValue) {
-        const conf = DBOS.#dbosConfig?.application;
-        if (!conf)
-            throw new error_1.DBOSExecutorNotInitializedError();
-        (0, lodash_1.set)(conf, key, newValue);
-    }
-    /**
-     * Drop DBOS system database.
-     * USE IN TESTS ONLY - ALL WORKFLOWS, QUEUES, ETC. WILL BE LOST.
-     */
-    static async dropSystemDB() {
-        if (!DBOS.#dbosConfig) {
-            DBOS.#dbosConfig = (0, config_1.parseConfigFile)()[0];
-        }
-        DBOS.translateConfig();
-        return system_database_1.PostgresSystemDatabase.dropSystemDB(DBOS.#dbosConfig);
     }
     /**
      * Use ORMEntities to set up database schema.
@@ -141,25 +108,55 @@ class DBOS {
         if (DBOS.isInitialized()) {
             return;
         }
-        const debugMode = options?.debugMode ?? DBOS.getDebugModeFromEnv();
         if (options?.conductorKey) {
             // Use a generated executor ID.
             utils_1.globalParams.executorID = (0, node_crypto_1.randomUUID)();
         }
-        // Initialize the DBOS executor
-        if (!DBOS.#dbosConfig) {
-            [DBOS.#dbosConfig, DBOS.#runtimeConfig] = (0, config_1.parseConfigFile)({ forceConsole: debugMode });
-        }
-        else if (!(0, dbos_executor_1.isDeprecatedDBOSConfig)(DBOS.#dbosConfig)) {
-            DBOS.translateConfig(); // This is a defensive measure for users who'd do DBOS.config = X instead of using DBOS.setConfig()
-        }
-        if (!DBOS.#dbosConfig) {
-            throw new error_1.DBOSError('DBOS configuration not set');
+        const debugMode = options?.debugMode ?? process.env.DBOS_DEBUG_WORKFLOW_ID !== undefined;
+        const configFile = (0, config_1.readConfigFile)();
+        const $dbosConfig = DBOS.#dbosConfig;
+        let [internalConfig, runtimeConfig] = $dbosConfig
+            ? (0, config_1.translatePublicDBOSconfig)(
+            // copy config settings to ensure no unexpected fields are passed thru
+            {
+                adminPort: $dbosConfig.adminPort,
+                name: $dbosConfig.name,
+                databaseUrl: $dbosConfig.databaseUrl,
+                userDbclient: $dbosConfig.userDbclient,
+                userDbPoolSize: $dbosConfig.userDbPoolSize,
+                sysDbName: $dbosConfig.sysDbName,
+                sysDbPoolSize: $dbosConfig.sysDbPoolSize,
+                logLevel: $dbosConfig.logLevel,
+                addContextMetadata: $dbosConfig.addContextMetadata,
+                runAdminServer: $dbosConfig.runAdminServer,
+                otlpTracesEndpoints: [...($dbosConfig.otlpTracesEndpoints ?? [])],
+                otlpLogsEndpoints: [...($dbosConfig.otlpLogsEndpoints ?? [])],
+            }, debugMode)
+            : (0, config_1.processConfigFile)(configFile, { forceConsole: debugMode });
+        if (process.env.DBOS__CLOUD === 'true') {
+            [internalConfig, runtimeConfig] = (0, config_1.overwrite_config)(internalConfig, runtimeConfig, configFile);
+        }
+        DBOS.#port = runtimeConfig.port;
+        DBOS.#poolConfig = internalConfig.poolConfig;
+        DBOS.#dbosConfig = {
+            name: internalConfig.name,
+            databaseUrl: internalConfig.databaseUrl,
+            userDbclient: internalConfig.userDbclient,
+            userDbPoolSize: DBOS.#dbosConfig?.userDbPoolSize,
+            sysDbName: internalConfig.system_database,
+            sysDbPoolSize: internalConfig.sysDbPoolSize,
+            logLevel: internalConfig.telemetry.logs?.logLevel,
+            addContextMetadata: internalConfig.telemetry.logs?.addContextMetadata,
+            otlpTracesEndpoints: [...(internalConfig.telemetry.OTLPExporter?.tracesEndpoint ?? [])],
+            otlpLogsEndpoints: [...(internalConfig.telemetry.OTLPExporter?.logsEndpoint ?? [])],
+            adminPort: runtimeConfig.admin_port,
+            runAdminServer: runtimeConfig.runAdminServer,
+        };
+        if (utils_1.globalParams.appName === '' && DBOS.#dbosConfig.name) {
+            utils_1.globalParams.appName = DBOS.#dbosConfig.name;
         }
         dbos_executor_1.DBOSExecutor.createInternalQueue();
-        dbos_executor_1.DBOSExecutor.globalInstance = new dbos_executor_1.DBOSExecutor(DBOS.#dbosConfig, {
-            debugMode,
-        });
+        dbos_executor_1.DBOSExecutor.globalInstance = new dbos_executor_1.DBOSExecutor(internalConfig, { debugMode });
         const executor = dbos_executor_1.DBOSExecutor.globalInstance;
         await executor.init();
         const debugWorkflowId = process.env.DBOS_DEBUG_WORKFLOW_ID;
@@ -186,14 +183,14 @@ class DBOS {
         }
         // Start the DBOS admin server
         const logger = DBOS.logger;
-        if (DBOS.#runtimeConfig && DBOS.#runtimeConfig.runAdminServer) {
+        if (runtimeConfig.runAdminServer) {
             const adminApp = server_1.DBOSHttpServer.setupAdminApp(executor);
             try {
-                await server_1.DBOSHttpServer.checkPortAvailabilityIPv4Ipv6(DBOS.#runtimeConfig.admin_port, logger);
+                await server_1.DBOSHttpServer.checkPortAvailabilityIPv4Ipv6(runtimeConfig.admin_port, logger);
                 // Wrap the listen call in a promise to properly catch errors
                 DBOS.adminServer = await new Promise((resolve, reject) => {
-                    const server = adminApp.listen(DBOS.#runtimeConfig?.admin_port, () => {
-                        DBOS.logger.debug(`DBOS Admin Server is running at http://localhost:${DBOS.#runtimeConfig?.admin_port}`);
+                    const server = adminApp.listen(runtimeConfig?.admin_port, () => {
+                        DBOS.logger.debug(`DBOS Admin Server is running at http://localhost:${runtimeConfig?.admin_port}`);
                         resolve(server);
                     });
                     server.on('error', (err) => {
@@ -202,7 +199,7 @@ class DBOS {
                 });
             }
             catch (e) {
-                logger.warn(`Unable to start DBOS admin server on port ${DBOS.#runtimeConfig.admin_port}`);
+                logger.warn(`Unable to start DBOS admin server on port ${runtimeConfig.admin_port}`);
             }
         }
         if (options?.koaApp) {
@@ -242,11 +239,7 @@ class DBOS {
         if (!dbos_executor_1.DBOSExecutor.globalInstance)
             return;
         dbos_executor_1.DBOSExecutor.globalInstance.logRegisteredHTTPUrls();
-        dbos_executor_1.DBOSExecutor.globalInstance.scheduler?.logRegisteredSchedulerEndpoints();
         wfqueue_1.wfQueueRunner.logRegisteredEndpoints(dbos_executor_1.DBOSExecutor.globalInstance);
-        for (const evtRcvr of dbos_executor_1.DBOSExecutor.globalInstance.eventReceivers) {
-            evtRcvr.logRegisteredEndpoints();
-        }
         for (const lcl of (0, decorators_1.getLifecycleListeners)()) {
             lcl.logRegisteredEndpoints?.();
         }
@@ -325,9 +318,9 @@ class DBOS {
      */
     static async launchAppHTTPServer() {
         const server = DBOS.setUpHandlerCallback();
-        if (DBOS.#runtimeConfig) {
+        if (DBOS.#port) {
             // This will not listen if there's no decorated endpoint
-            DBOS.appServer = await server.appListen(DBOS.#runtimeConfig.port);
+            DBOS.appServer = await server.appListen(DBOS.#port);
         }
     }
     /**
@@ -353,9 +346,10 @@ class DBOS {
     // Globals
     //////
     static #dbosConfig;
-    static #runtimeConfig = undefined;
+    static #poolConfig;
+    static #port;
     static get dbosConfig() {
-        return DBOS.#dbosConfig;
+        return { ...DBOS.#dbosConfig, poolConfig: DBOS.#poolConfig };
     }
     //////
     // Context
@@ -543,17 +537,6 @@ class DBOS {
         const client = DBOS.sqlClient;
         return client;
     }
-    /**
-     * Gets configuration information from the `application` section
-     *  of `DBOSConfig`
-     * @param key - name of configuration item
-     * @param defaultValue - value to return if `key` does not exist in the configuration
-     */
-    static getConfig(key, defaultValue) {
-        if (DBOS.#executor)
-            return DBOS.#executor.getConfig(key, defaultValue);
-        return defaultValue;
-    }
     /**
      * Query the current application database
      * @param sql - parameterized SQL statement (string) to execute
@@ -921,7 +904,7 @@ class DBOS {
         const regOps = (0, decorators_1.getRegisteredOperations)(target);
         const handler = {
             apply(target, _thisArg, args) {
-                const regOp = (0, decorators_1.getRegistrationForFunction)(target);
+                const regOp = (0, decorators_1.getFunctionRegistration)(target);
                 if (!regOp) {
                     // eslint-disable-next-line @typescript-eslint/no-base-to-string
                     const name = typeof target === 'function' ? target.name : target.toString();
@@ -932,7 +915,7 @@ class DBOS {
             get(target, p, receiver) {
                 // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
                 const func = Reflect.get(target, p, receiver);
-                const regOp = (0, decorators_1.getRegistrationForFunction)(func) ?? regOps.find((op) => op.name === p);
+                const regOp = (0, decorators_1.getFunctionRegistration)(func) ?? regOps.find((op) => op.name === p);
                 if (regOp) {
                     return (...args) => DBOS.#invokeWorkflow(instance, regOp, args, params);
                 }
@@ -964,7 +947,7 @@ class DBOS {
             const functionID = (0, context_1.functionIDGetIncrement)();
             return await dbos_executor_1.DBOSExecutor.globalInstance.systemDatabase.send(DBOS.workflowID, functionID, destinationID, utils_1.DBOSJSON.stringify(message), topic);
         }
-        return DBOS.#executor.send(destinationID, message, topic, idempotencyKey); // Temp WF variant
+        return DBOS.#executor.runSendTempWF(destinationID, message, topic, idempotencyKey); // Temp WF variant
     }
     /**
      * Receive a message on optional `topic` from within a workflow.
@@ -1036,21 +1019,33 @@ class DBOS {
         }
         return DBOS.#executor.getEvent(workflowID, key, timeoutSeconds);
     }
+    /**
+     * registers a workflow method or function with an invocation schedule
+     * @param func - The workflow method or function to register with an invocation schedule
+     * @param options - Configuration information for the scheduled workflow
+     */
+    static registerScheduled(func, config) {
+        scheduler_1.ScheduledReceiver.registerScheduled(func, config);
+    }
     //////
     // Decorators
     //////
     /**
      * Decorator associating a class static method with an invocation schedule
-     * @param schedulerConfig - The schedule, consisting of a crontab and policy for "make-up work"
-     */
-    static scheduled(schedulerConfig) {
-        function scheddec(target, propertyKey, inDescriptor) {
-            const { descriptor, registration } = (0, decorators_1.registerAndWrapDBOSFunction)(target, propertyKey, inDescriptor);
-            const schedRegistration = registration;
-            schedRegistration.schedulerConfig = schedulerConfig;
+     * @param config - The schedule, consisting of a crontab and policy for "make-up work"
+     */
+    static scheduled(config) {
+        function methodDecorator(target, propertyKey, descriptor) {
+            if (descriptor.value) {
+                DBOS.registerScheduled(descriptor.value, {
+                    ...config,
+                    ctorOrProto: target,
+                    name: String(propertyKey),
+                });
+            }
             return descriptor;
         }
-        return scheddec;
+        return methodDecorator;
     }
     /**
      * Decorator designating a method as a DBOS workflow
@@ -1060,10 +1055,11 @@ class DBOS {
      */
     static workflow(config = {}) {
         function decorator(target, propertyKey, inDescriptor) {
-            const { descriptor, registration } = (0, decorators_1.registerAndWrapDBOSFunction)(target, propertyKey, inDescriptor);
+            const { descriptor, registration } = (0, decorators_1.wrapDBOSFunctionAndRegisterByUniqueNameDec)(target, propertyKey, inDescriptor);
             const invoker = DBOS.#getWorkflowInvoker(registration, config);
             descriptor.value = invoker;
             registration.wrappedFunction = invoker;
+            (0, decorators_1.registerFunctionWrapper)(invoker, registration);
             return descriptor;
         }
         return decorator;
@@ -1077,9 +1073,9 @@ class DBOS {
      * @param name - The name of the registered workflow
      * @param options - Configuration information for the registered workflow
      */
-    static registerWorkflow(func, options = {}) {
-        const { registration } = (0, decorators_1.registerAndWrapDBOSFunctionByName)(options.ctorOrProto, options.className, options.name ?? func.name, func);
-        return DBOS.#getWorkflowInvoker(registration, options.config);
+    static registerWorkflow(func, config) {
+        const registration = (0, decorators_1.wrapDBOSFunctionAndRegisterByUniqueName)(config?.ctorOrProto, config?.className, config?.name ?? func.name, func);
+        return DBOS.#getWorkflowInvoker(registration, config);
     }
     static async #invokeWorkflow($this, regOP, args, params = {}) {
         const wfId = (0, context_1.getNextWFID)(params.workflowID);
@@ -1169,7 +1165,7 @@ class DBOS {
      */
     static transaction(config = {}) {
         function decorator(target, propertyKey, inDescriptor) {
-            const { descriptor, registration } = (0, decorators_1.registerAndWrapDBOSFunction)(target, propertyKey, inDescriptor);
+            const { descriptor, registration } = (0, decorators_1.wrapDBOSFunctionAndRegisterByUniqueNameDec)(target, propertyKey, inDescriptor);
             registration.setTxnConfig(config);
             const invokeWrapper = async function (...rawArgs) {
                 let inst = undefined;
@@ -1207,10 +1203,11 @@ class DBOS {
                     configuredInstance: inst,
                     workflowUUID: wfId,
                 };
-                return await DBOS.#executor.transaction(registration.registeredFunction, wfParams, ...rawArgs);
+                return await DBOS.#executor.runTransactionTempWF(registration.registeredFunction, wfParams, ...rawArgs);
             };
             descriptor.value = invokeWrapper;
             registration.wrappedFunction = invokeWrapper;
+            (0, decorators_1.registerFunctionWrapper)(invokeWrapper, registration);
             Object.defineProperty(invokeWrapper, 'name', {
                 value: registration.name,
             });
@@ -1226,7 +1223,7 @@ class DBOS {
      */
     static storedProcedure(config = {}) {
         function decorator(target, propertyKey, inDescriptor) {
-            const { descriptor, registration } = (0, decorators_1.registerAndWrapDBOSFunction)(target, propertyKey, inDescriptor);
+            const { descriptor, registration } = (0, decorators_1.wrapDBOSFunctionAndRegisterByUniqueNameDec)(target, propertyKey, inDescriptor);
             registration.setProcConfig(config);
             const invokeWrapper = async function (...rawArgs) {
                 if (typeof this !== 'function') {
@@ -1250,10 +1247,11 @@ class DBOS {
                 const wfParams = {
                     workflowUUID: wfId,
                 };
-                return await DBOS.#executor.procedure(registration.registeredFunction, wfParams, ...rawArgs);
+                return await DBOS.#executor.runProcedureTempWF(registration.registeredFunction, wfParams, ...rawArgs);
             };
             descriptor.value = invokeWrapper;
             registration.wrappedFunction = invokeWrapper;
+            (0, decorators_1.registerFunctionWrapper)(invokeWrapper, registration);
             Object.defineProperty(invokeWrapper, 'name', {
                 value: registration.name,
             });
@@ -1271,7 +1269,7 @@ class DBOS {
      */
     static step(config = {}) {
         function decorator(target, propertyKey, inDescriptor) {
-            const { descriptor, registration } = (0, decorators_1.registerAndWrapDBOSFunction)(target, propertyKey, inDescriptor);
+            const { descriptor, registration } = (0, decorators_1.wrapDBOSFunctionAndRegisterByUniqueNameDec)(target, propertyKey, inDescriptor);
             registration.setStepConfig(config);
             const invokeWrapper = async function (...rawArgs) {
                 let inst = undefined;
@@ -1310,10 +1308,11 @@ class DBOS {
                     configuredInstance: inst,
                     workflowUUID: wfId,
                 };
-                return await DBOS.#executor.external(registration.registeredFunction, wfParams, ...rawArgs);
+                return await DBOS.#executor.runStepTempWF(registration.registeredFunction, wfParams, ...rawArgs);
             };
             descriptor.value = invokeWrapper;
             registration.wrappedFunction = invokeWrapper;
+            (0, decorators_1.registerFunctionWrapper)(invokeWrapper, registration);
             Object.defineProperty(invokeWrapper, 'name', {
                 value: registration.name,
             });
@@ -1328,29 +1327,31 @@ class DBOS {
      *   This ensures "at least once" execution of the step, and that the step will not
      *    be executed again once the checkpoint is recorded
      * @param func - The function to register as a step
-     * @param config - Configuration information for the step, particularly the retry policy
-     * @param config.name - The name of the step; if not provided, the function name will be used
+     * @param config - Configuration information for the step, particularly the retry policy and name
      */
     static registerStep(func, config = {}) {
         const name = config.name ?? func.name;
+        const reg = (0, decorators_1.wrapDBOSFunctionAndRegister)(config?.ctorOrProto, config?.className, name, func);
         const invokeWrapper = async function (...rawArgs) {
             // eslint-disable-next-line @typescript-eslint/no-this-alias
             const inst = this;
+            const callFunc = reg.registeredFunction ?? reg.origFunction;
             if (DBOS.isWithinWorkflow()) {
                 if (DBOS.isInTransaction()) {
                     throw new error_1.DBOSInvalidWorkflowTransitionError('Invalid call to a `step` function from within a `transaction`');
                 }
                 if (DBOS.isInStep()) {
                     // There should probably be checks here about the compatibility of the StepConfig...
-                    return func.call(this, ...rawArgs);
+                    return callFunc.call(this, ...rawArgs);
                 }
-                return await dbos_executor_1.DBOSExecutor.globalInstance.callStepFunction(func, name, config, inst ?? null, ...rawArgs);
+                return await dbos_executor_1.DBOSExecutor.globalInstance.callStepFunction(callFunc, name, config, inst ?? null, ...rawArgs);
             }
             if ((0, context_1.getNextWFID)(undefined)) {
                 throw new error_1.DBOSInvalidWorkflowTransitionError(`Invalid call to step '${name}' outside of a workflow; with directive to start a workflow.`);
             }
-            return func.call(this, ...rawArgs);
+            return callFunc.call(this, ...rawArgs);
         };
+        (0, decorators_1.registerFunctionWrapper)(invokeWrapper, reg);
         Object.defineProperty(invokeWrapper, 'name', { value: name });
         return invokeWrapper;
     }
@@ -1430,14 +1431,6 @@ class DBOS {
     /////
     // Registration, etc
     /////
-    /**
-     * Construct and register an object.
-     * Calling this is not necessary; calling the constructor of any `ConfiguredInstance` subclass is sufficient
-     * @deprecated Use `new` directly
-     */
-    static configureInstance(cls, name, ...args) {
-        return (0, decorators_1.configureInstance)(cls, name, ...args);
-    }
     /**
      * Register a lifecycle listener
      */
@@ -1460,13 +1453,13 @@ class DBOS {
      * Register information to be associated with a DBOS function
      */
     static associateFunctionWithInfo(external, func, target) {
-        return (0, decorators_1.associateMethodWithExternal)(external, target.ctorOrProto, target.className, target.name, func);
+        return (0, decorators_1.associateMethodWithExternal)(external, target.ctorOrProto, target.className, target.name ?? func.name, func);
     }
     /**
      * Register information to be associated with a DBOS function
      */
     static associateParamWithInfo(external, func, target) {
-        return (0, decorators_1.associateParameterWithExternal)(external, target.ctorOrProto, target.className, target.name, func, target.param);
+        return (0, decorators_1.associateParameterWithExternal)(external, target.ctorOrProto, target.className, target.name ?? func.name, func, target.param);
     }
     /** Get registrations */
     static getAssociatedInfo(external, cls, funcName) {
@@ -1487,14 +1480,6 @@ class InitContext {
     queryUserDB(sql, ...params) {
         return DBOS.queryUserDB(sql, params);
     }
-    getConfig(key, defaultValue) {
-        const value = DBOS.getConfig(key, defaultValue);
-        // If the key is found and the default value is provided, check whether the value is of the same type.
-        if (value && defaultValue && typeof value !== typeof defaultValue) {
-            throw new error_1.DBOSConfigKeyTypeError(key, typeof defaultValue, typeof value);
-        }
-        return value;
-    }
 }
 exports.InitContext = InitContext;
 //# sourceMappingURL=dbos.js.map