@dbos-inc/dbos-sdk 3.6.3-preview → 3.6.7-preview

package/dist/src/httpServer/server.js

@@ -1,737 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DBOSHttpServer = exports.WorkflowQueuesMetadataUrl = exports.DeactivateUrl = exports.PerfUrl = exports.HealthUrl = exports.WorkflowRecoveryUrl = exports.WorkflowUUIDHeader = void 0;
-const koa_1 = __importDefault(require("koa"));
-const router_1 = __importDefault(require("@koa/router"));
-const bodyparser_1 = require("@koa/bodyparser");
-const cors_1 = __importDefault(require("@koa/cors"));
-const handlerTypes_1 = require("./handlerTypes");
-const error_1 = require("../error");
-const dbos_executor_1 = require("../dbos-executor");
-const middleware_1 = require("./middleware");
-const api_1 = require("@opentelemetry/api");
-const net = __importStar(require("net"));
-const perf_hooks_1 = require("perf_hooks");
-const utils_1 = require("../utils");
-const context_1 = require("../context");
-const wfqueue_1 = require("../wfqueue");
-const serialize_error_1 = require("serialize-error");
-const workflow_management_1 = require("../dbos-runtime/workflow_management");
-const core_1 = require("@opentelemetry/core");
-const dbos_1 = require("../dbos");
-const protocol = __importStar(require("../conductor/protocol"));
-const decorators_1 = require("../decorators");
-exports.WorkflowUUIDHeader = 'dbos-idempotency-key';
-exports.WorkflowRecoveryUrl = '/dbos-workflow-recovery';
-exports.HealthUrl = '/dbos-healthz';
-exports.PerfUrl = '/dbos-perf';
-// FIXME this should be /dbos-deactivate to be consistent with other endpoints.
-exports.DeactivateUrl = '/deactivate';
-exports.WorkflowQueuesMetadataUrl = '/dbos-workflow-queues-metadata';
-class DBOSHttpServer {
-    dbosExec;
-    app;
-    adminApp;
-    applicationRouter;
-    logger;
-    static nRegisteredEndpoints = 0;
-    static instance = undefined;
-    /**
-     * Create a Koa app.
-     * @param dbosExec User pass in an DBOS workflow executor instance.
-     * TODO: maybe call dbosExec.init() somewhere in this class?
-     */
-    constructor(dbosExec) {
-        this.dbosExec = dbosExec;
-        this.applicationRouter = new router_1.default();
-        this.logger = dbosExec.logger;
-        this.app = new koa_1.default();
-        this.adminApp = DBOSHttpServer.setupAdminApp(this.dbosExec);
-        DBOSHttpServer.registerDecoratedEndpoints(this.dbosExec, this.applicationRouter, this.app);
-        this.app.use(this.applicationRouter.routes()).use(this.applicationRouter.allowedMethods());
-        DBOSHttpServer.instance = this;
-    }
-    static setupAdminApp(dbosExec) {
-        const adminRouter = new router_1.default();
-        const adminApp = new koa_1.default();
-        adminApp.use((0, bodyparser_1.bodyParser)());
-        adminApp.use((0, cors_1.default)());
-        // Register HTTP endpoints.
-        DBOSHttpServer.registerHealthEndpoint(dbosExec, adminRouter);
-        DBOSHttpServer.registerRecoveryEndpoint(dbosExec, adminRouter);
-        DBOSHttpServer.registerPerfEndpoint(dbosExec, adminRouter);
-        DBOSHttpServer.registerDeactivateEndpoint(dbosExec, adminRouter);
-        DBOSHttpServer.registerCancelWorkflowEndpoint(dbosExec, adminRouter);
-        DBOSHttpServer.registerResumeWorkflowEndpoint(dbosExec, adminRouter);
-        DBOSHttpServer.registerRestartWorkflowEndpoint(dbosExec, adminRouter);
-        DBOSHttpServer.registerQueueMetadataEndpoint(dbosExec, adminRouter);
-        DBOSHttpServer.registerListWorkflowStepsEndpoint(dbosExec, adminRouter);
-        DBOSHttpServer.registerListWorkflowsEndpoint(dbosExec, adminRouter);
-        DBOSHttpServer.registerListQueuedWorkflowsEndpoint(dbosExec, adminRouter);
-        DBOSHttpServer.registerGetWorkflowEndpoint(dbosExec, adminRouter);
-        DBOSHttpServer.registerForkWorkflowEndpoint(dbosExec, adminRouter);
-        DBOSHttpServer.registerGarbageCollectEndpoint(dbosExec, adminRouter);
-        DBOSHttpServer.registerGlobalTimeoutEndpoint(dbosExec, adminRouter);
-        adminApp.use(adminRouter.routes()).use(adminRouter.allowedMethods());
-        return adminApp;
-    }
-    async appListen(port) {
-        await DBOSHttpServer.checkPortAvailabilityIPv4Ipv6(port, this.logger);
-        const appServer = DBOSHttpServer.nRegisteredEndpoints === 0
-            ? undefined
-            : this.app.listen(port, () => {
-                this.logger.info(`DBOS Server is running at http://localhost:${port}`);
-            });
-        return appServer;
-    }
-    static async checkPortAvailabilityIPv4Ipv6(port, logger) {
-        try {
-            await this.checkPortAvailability(port, '127.0.0.1');
-        }
-        catch (error) {
-            const err = error;
-            if (err.code === 'EADDRINUSE') {
-                logger.warn(`Port ${port} is already used for IPv4 address "127.0.0.1". Please use the -p option to choose another port.\n${err.message}`);
-                throw error;
-            }
-            else {
-                logger.warn(`Error occurred while checking port availability for IPv4 address "127.0.0.1" : ${err.code}\n${err.message}`);
-            }
-        }
-        try {
-            await this.checkPortAvailability(port, '::1');
-        }
-        catch (error) {
-            const err = error;
-            if (err.code === 'EADDRINUSE') {
-                logger.warn(`Port ${port} is already used for IPv6 address "::1". Please use the -p option to choose another port.\n${err.message}`);
-                throw error;
-            }
-            else {
-                logger.warn(`Error occurred while checking port availability for IPv6 address "::1" : ${err.code}\n${err.message}`);
-            }
-        }
-    }
-    static async checkPortAvailability(port, host) {
-        return new Promise((resolve, reject) => {
-            const server = new net.Server();
-            server.on('error', (error) => {
-                reject(error);
-            });
-            server.on('listening', () => {
-                server.close();
-                resolve();
-            });
-            server.listen({ port: port, host: host }, () => {
-                resolve();
-            });
-        });
-    }
-    /**
-     * Health check endpoint.
-     */
-    static registerHealthEndpoint(dbosExec, router) {
-        // Handler function that parses request for recovery.
-        const healthHandler = async (koaCtxt, koaNext) => {
-            koaCtxt.body = 'healthy';
-            await koaNext();
-        };
-        router.get(exports.HealthUrl, healthHandler);
-        dbosExec.logger.debug(`DBOS Server Registered Healthz GET ${exports.HealthUrl}`);
-    }
-    /**
-     * Register workflow queue metadata endpoint.
-     */
-    static registerQueueMetadataEndpoint(dbosExec, router) {
-        const queueMetadataHandler = async (koaCtxt, koaNext) => {
-            const queueDetailsArray = [];
-            wfqueue_1.wfQueueRunner.wfQueuesByName.forEach((q, qn) => {
-                queueDetailsArray.push({
-                    name: qn,
-                    concurrency: q.concurrency,
-                    workerConcurrency: q.workerConcurrency,
-                    rateLimit: q.rateLimit,
-                });
-            });
-            koaCtxt.body = queueDetailsArray;
-            await koaNext();
-        };
-        router.get(exports.WorkflowQueuesMetadataUrl, queueMetadataHandler);
-        dbosExec.logger.debug(`DBOS Server Registered Queue Metadata GET ${exports.WorkflowQueuesMetadataUrl}`);
-    }
-    /**
-     * Register workflow recovery endpoint.
-     * Receives a list of executor IDs and returns a list of workflowUUIDs.
-     */
-    static registerRecoveryEndpoint(dbosExec, router) {
-        // Handler function that parses request for recovery.
-        const recoveryHandler = async (koaCtxt, koaNext) => {
-            const executorIDs = koaCtxt.request.body;
-            dbosExec.logger.info('Recovering workflows for executors: ' + executorIDs.toString());
-            const recoverHandles = await dbosExec.recoverPendingWorkflows(executorIDs);
-            // Return a list of workflowUUIDs being recovered.
-            koaCtxt.body = await Promise.allSettled(recoverHandles.map((i) => i.workflowID)).then((results) => results.filter((i) => i.status === 'fulfilled').map((i) => i.value));
-            await koaNext();
-        };
-        router.post(exports.WorkflowRecoveryUrl, recoveryHandler);
-        dbosExec.logger.debug(`DBOS Server Registered Recovery POST ${exports.WorkflowRecoveryUrl}`);
-    }
-    /**
-     * Register performance endpoint.
-     * Returns information on VM performance since last call.
-     */
-    static registerPerfEndpoint(dbosExec, router) {
-        let lastELU = perf_hooks_1.performance.eventLoopUtilization();
-        const perfHandler = async (koaCtxt, koaNext) => {
-            const currELU = perf_hooks_1.performance.eventLoopUtilization();
-            const elu = perf_hooks_1.performance.eventLoopUtilization(currELU, lastELU);
-            koaCtxt.body = elu;
-            lastELU = currELU;
-            await koaNext();
-        };
-        router.get(exports.PerfUrl, perfHandler);
-        dbosExec.logger.debug(`DBOS Server Registered Perf GET ${exports.PerfUrl}`);
-    }
-    /**
-     * Register Deactivate endpoint.
-     * Deactivate consumers so that they don't start new workflows.
-     *
-     */
-    static isDeactivated = false;
-    static registerDeactivateEndpoint(dbosExec, router) {
-        const deactivateHandler = async (koaCtxt, koaNext) => {
-            if (!DBOSHttpServer.isDeactivated) {
-                dbosExec.logger.info(`Deactivating DBOS executor ${utils_1.globalParams.executorID} with version ${utils_1.globalParams.appVersion}. This executor will complete existing workflows but will not create new workflows.`);
-                DBOSHttpServer.isDeactivated = true;
-            }
-            await dbosExec.deactivateEventReceivers(false);
-            koaCtxt.body = 'Deactivated';
-            await koaNext();
-        };
-        router.get(exports.DeactivateUrl, deactivateHandler);
-        dbosExec.logger.debug(`DBOS Server Registered Deactivate GET ${exports.DeactivateUrl}`);
-    }
-    static registerGarbageCollectEndpoint(dbosExec, router) {
-        const url = '/dbos-garbage-collect';
-        const handler = async (koaCtxt) => {
-            const body = koaCtxt.request.body;
-            await dbosExec.systemDatabase.garbageCollect(body.cutoff_epoch_timestamp_ms, body.rows_threshold);
-            koaCtxt.status = 204;
-        };
-        router.post(url, handler);
-    }
-    static registerGlobalTimeoutEndpoint(dbosExec, router) {
-        const url = '/dbos-global-timeout';
-        const handler = async (koaCtxt) => {
-            const body = koaCtxt.request.body;
-            await (0, workflow_management_1.globalTimeout)(dbosExec.systemDatabase, body.cutoff_epoch_timestamp_ms);
-            koaCtxt.status = 204;
-        };
-        router.post(url, handler);
-    }
-    /**
-     *
-     * Register Cancel Workflow endpoint.
-     * Cancels a workflow by setting its status to CANCELLED.
-     */
-    static registerCancelWorkflowEndpoint(dbosExec, router) {
-        const workflowCancelUrl = '/workflows/:workflow_id/cancel';
-        const workflowCancelHandler = async (koaCtxt) => {
-            const workflowId = koaCtxt.params.workflow_id;
-            await dbosExec.cancelWorkflow(workflowId);
-            koaCtxt.status = 204;
-        };
-        router.post(workflowCancelUrl, workflowCancelHandler);
-        dbosExec.logger.debug(`DBOS Server Registered Cancel Workflow POST ${workflowCancelUrl}`);
-    }
-    /**
-     *
-     * Register Resume Workflow endpoint.
-     * Resume a workflow.
-     */
-    static registerResumeWorkflowEndpoint(dbosExec, router) {
-        const workflowResumeUrl = '/workflows/:workflow_id/resume';
-        const workflowResumeHandler = async (koaCtxt) => {
-            const workflowId = koaCtxt.params.workflow_id;
-            dbosExec.logger.info(`Resuming workflow with ID: ${workflowId}`);
-            try {
-                await dbosExec.resumeWorkflow(workflowId);
-            }
-            catch (e) {
-                let errorMessage = '';
-                if (e instanceof error_1.DBOSError) {
-                    errorMessage = e.message;
-                }
-                else {
-                    errorMessage = `Unknown error`;
-                }
-                dbosExec.logger.error(`Error resuming workflow ${workflowId}: ${errorMessage}`);
-                koaCtxt.status = 500;
-                koaCtxt.body = {
-                    error: `Error resuming workflow ${workflowId}: ${errorMessage}`,
-                };
-                return;
-            }
-            koaCtxt.status = 204;
-        };
-        router.post(workflowResumeUrl, workflowResumeHandler);
-        dbosExec.logger.debug(`DBOS Server Registered Cancel Workflow POST ${workflowResumeUrl}`);
-    }
-    /**
-     *
-     * Register Restart Workflow endpoint.
-     * Restart a workflow.
-     */
-    static registerRestartWorkflowEndpoint(dbosExec, router) {
-        const workflowResumeUrl = '/workflows/:workflow_id/restart';
-        const workflowRestartHandler = async (koaCtxt) => {
-            const workflowId = koaCtxt.params.workflow_id;
-            dbosExec.logger.info(`Restarting workflow: ${workflowId} with a new id`);
-            const workflowID = await dbosExec.forkWorkflow(workflowId, 0);
-            koaCtxt.body = {
-                workflow_id: workflowID,
-            };
-            koaCtxt.status = 200;
-        };
-        router.post(workflowResumeUrl, workflowRestartHandler);
-        dbosExec.logger.debug(`DBOS Server Registered Cancel Workflow POST ${workflowResumeUrl}`);
-    }
-    /**
-     *
-     * Register Fork Workflow endpoint.
-     *
-     */
-    static registerForkWorkflowEndpoint(dbosExec, router) {
-        const workflowResumeUrl = '/workflows/:workflow_id/fork';
-        const workflowForkHandler = async (koaCtxt) => {
-            const workflowId = koaCtxt.params.workflow_id;
-            const body = koaCtxt.request.body;
-            if (body.start_step === undefined) {
-                throw new error_1.DBOSDataValidationError('Missing start_step in request body');
-            }
-            dbosExec.logger.info(`Forking workflow: ${workflowId} from step ${body.start_step} with a new id`);
-            try {
-                const workflowID = await dbosExec.forkWorkflow(workflowId, body.start_step, {
-                    newWorkflowID: body.new_workflow_id,
-                    applicationVersion: body.application_version,
-                    timeoutMS: body.timeout_ms,
-                });
-                koaCtxt.body = {
-                    workflow_id: workflowID,
-                };
-            }
-            catch (e) {
-                let errorMessage = '';
-                if (e instanceof error_1.DBOSError) {
-                    errorMessage = e.message;
-                }
-                else {
-                    errorMessage = `Unknown error`;
-                }
-                dbosExec.logger.error(`Error forking workflow ${workflowId}: ${errorMessage}`);
-                koaCtxt.status = 500;
-                koaCtxt.body = {
-                    error: `Error forking workflow ${workflowId}: ${errorMessage}`,
-                };
-                return;
-            }
-            dbosExec.logger.info(`Forked workflow: ${workflowId} with a new id`);
-            koaCtxt.status = 200;
-        };
-        router.post(workflowResumeUrl, workflowForkHandler);
-        dbosExec.logger.debug(`DBOS Server Registered Cancel Workflow POST ${workflowResumeUrl}`);
-    }
-    /**
-     *
-     * Register List Workflow Steps endpoint.
-     * List steps for a given workflow.
-     */
-    static registerListWorkflowStepsEndpoint(dbosExec, router) {
-        const workflowStepsUrl = '/workflows/:workflow_id/steps';
-        const workflowStepsHandler = async (koaCtxt) => {
-            const workflowId = koaCtxt.params.workflow_id;
-            const steps = await dbosExec.listWorkflowSteps(workflowId);
-            koaCtxt.body = steps?.map((step) => ({
-                function_name: step.name,
-                function_id: step.functionID,
-                output: step.output ? utils_1.DBOSJSON.stringify(step.output) : undefined,
-                error: step.error ? utils_1.DBOSJSON.stringify((0, serialize_error_1.serializeError)(step.error)) : undefined,
-                child_workflow_id: step.childWorkflowID,
-            }));
-            koaCtxt.status = 200;
-        };
-        router.get(workflowStepsUrl, workflowStepsHandler);
-        dbosExec.logger.debug(`DBOS Server Registered List Workflow steps Get ${workflowStepsUrl}`);
-    }
-    /**
-     *
-     * Register List Workflows endpoint.
-     * List workflows with optional filtering via request body.
-     */
-    static registerListWorkflowsEndpoint(dbosExec, router) {
-        const listWorkflowsUrl = '/workflows';
-        const listWorkflowsHandler = async (koaCtxt) => {
-            const body = koaCtxt.request.body;
-            // Map request body keys to GetWorkflowsInput properties
-            const input = {
-                workflowIDs: body.workflow_uuids,
-                workflowName: body.workflow_name,
-                authenticatedUser: body.authenticated_user,
-                startTime: body.start_time,
-                endTime: body.end_time,
-                status: body.status,
-                applicationVersion: body.application_version,
-                limit: body.limit,
-                offset: body.offset,
-                sortDesc: body.sort_desc,
-                workflow_id_prefix: body.workflow_id_prefix,
-                loadInput: body.load_input ?? false, // Default to false
-                loadOutput: body.load_output ?? false, // Default to false
-            };
-            const workflows = await dbosExec.listWorkflows(input);
-            // Map result to the underscore format.
-            koaCtxt.body = workflows.map((wf) => new protocol.WorkflowsOutput(wf));
-            koaCtxt.status = 200;
-        };
-        router.post(listWorkflowsUrl, listWorkflowsHandler);
-        dbosExec.logger.debug(`DBOS Server Registered List Workflows POST ${listWorkflowsUrl}`);
-    }
-    /**
-     *
-     * Register List Queued Workflows endpoint.
-     * List queued workflows with optional filtering via request body.
-     */
-    static registerListQueuedWorkflowsEndpoint(dbosExec, router) {
-        const listQueuedWorkflowsUrl = '/queues';
-        const listQueuedWorkflowsHandler = async (koaCtxt) => {
-            const body = koaCtxt.request.body;
-            // Map request body keys to GetQueuedWorkflowsInput properties
-            const input = {
-                workflowName: body.workflow_name,
-                startTime: body.start_time,
-                endTime: body.end_time,
-                status: body.status,
-                queueName: body.queue_name,
-                limit: body.limit,
-                offset: body.offset,
-                sortDesc: body.sort_desc,
-                loadInput: body.load_input ?? false, // Default to false
-            };
-            const workflows = await dbosExec.listQueuedWorkflows(input);
-            // Map result to the underscore format.
-            koaCtxt.body = workflows.map((wf) => new protocol.WorkflowsOutput(wf));
-            koaCtxt.status = 200;
-        };
-        router.post(listQueuedWorkflowsUrl, listQueuedWorkflowsHandler);
-        dbosExec.logger.debug(`DBOS Server Registered List Queued Workflows POST ${listQueuedWorkflowsUrl}`);
-    }
-    /**
-     *
-     * Register Get Workflow endpoint.
-     * Get detailed information about a specific workflow by ID.
-     */
-    static registerGetWorkflowEndpoint(dbosExec, router) {
-        const getWorkflowUrl = '/workflows/:workflow_id';
-        const getWorkflowHandler = async (koaCtxt) => {
-            const workflowId = koaCtxt.params.workflow_id;
-            const workflow = await dbosExec.getWorkflowStatus(workflowId);
-            if (workflow) {
-                koaCtxt.body = new protocol.WorkflowsOutput(workflow);
-                koaCtxt.status = 200;
-            }
-            else {
-                koaCtxt.status = 404;
-                koaCtxt.body = { error: `Workflow ${workflowId} not found` };
-            }
-        };
-        router.get(getWorkflowUrl, getWorkflowHandler);
-        dbosExec.logger.debug(`DBOS Server Registered Get Workflow GET ${getWorkflowUrl}`);
-    }
-    /**
-     * Register decorated functions as HTTP endpoints.
-     */
-    static registerDecoratedEndpoints(dbosExec, router, app) {
-        const globalMiddlewares = new Set();
-        // Register user declared endpoints, wrap around the endpoint with request parsing and response.
-        DBOSHttpServer.nRegisteredEndpoints = 0;
-        (0, decorators_1.getAllRegisteredFunctions)().forEach((registeredOperation) => {
-            const ro = registeredOperation;
-            if (!ro.apiURL)
-                return;
-            if (ro.isInstance) {
-                dbosExec.logger.warn(`Operation ${ro.className}/${ro.name} is registered with an endpoint (${ro.apiURL}) but cannot be invoked.`);
-                return;
-            }
-            ++DBOSHttpServer.nRegisteredEndpoints;
-            const defaults = ro.defaults;
-            // Check if we need to apply a custom CORS
-            if (defaults.koaCors) {
-                router.all(ro.apiURL, defaults.koaCors); // Use router.all to register with all methods including preflight requests
-            }
-            else {
-                if (dbosExec.config.http?.cors_middleware ?? true) {
-                    router.all(ro.apiURL, (0, cors_1.default)({
-                        credentials: dbosExec.config.http?.credentials ?? true,
-                        origin: (o) => {
-                            const whitelist = dbosExec.config.http?.allowed_origins;
-                            const origin = o.request.header.origin ?? '*';
-                            if (whitelist && whitelist.length > 0) {
-                                return whitelist.includes(origin) ? origin : '';
-                            }
-                            return o.request.header.origin || '*';
-                        },
-                        allowMethods: 'GET,HEAD,PUT,POST,DELETE,PATCH,OPTIONS',
-                        allowHeaders: ['Origin', 'X-Requested-With', 'Content-Type', 'Accept', 'Authorization'],
-                    }));
-                }
-            }
-            // Check if we need to apply any Koa global middleware.
-            if (defaults?.koaGlobalMiddlewares) {
-                defaults.koaGlobalMiddlewares.forEach((koaMiddleware) => {
-                    if (globalMiddlewares.has(koaMiddleware)) {
-                        return;
-                    }
-                    dbosExec.logger.debug(`DBOS Server applying middleware ${koaMiddleware.name} globally`);
-                    globalMiddlewares.add(koaMiddleware);
-                    app.use(koaMiddleware);
-                });
-            }
-            // Wrapper function that parses request and send response.
-            const wrappedHandler = async (koaCtxt, koaNext) => {
-                const requestID = (0, middleware_1.getOrGenerateRequestID)(koaCtxt.request.headers);
-                koaCtxt.set(middleware_1.RequestIDHeader, requestID);
-                const httpTracer = new core_1.W3CTraceContextPropagator();
-                const extractedSpanContext = api_1.trace.getSpanContext(httpTracer.extract(api_1.ROOT_CONTEXT, koaCtxt.request.headers, api_1.defaultTextMapGetter));
-                let span;
-                const spanAttributes = {
-                    operationType: dbos_executor_1.OperationType.HANDLER,
-                    requestID: requestID,
-                    requestIP: koaCtxt.request.ip,
-                    requestURL: koaCtxt.request.url,
-                    requestMethod: koaCtxt.request.method,
-                };
-                if (extractedSpanContext === undefined) {
-                    span = dbosExec.tracer.startSpan(koaCtxt.url, spanAttributes);
-                }
-                else {
-                    extractedSpanContext.isRemote = true;
-                    span = dbosExec.tracer.startSpanWithContext(extractedSpanContext, koaCtxt.url, spanAttributes);
-                }
-                const dctx = {
-                    request: {
-                        headers: koaCtxt.request.headers,
-                        rawHeaders: koaCtxt.req.rawHeaders,
-                        params: koaCtxt.params,
-                        body: koaCtxt.request.body,
-                        rawBody: koaCtxt.request.rawBody,
-                        query: koaCtxt.request.query,
-                        querystring: koaCtxt.request.querystring,
-                        url: koaCtxt.request.url,
-                        ip: koaCtxt.request.ip,
-                        requestID: requestID,
-                    },
-                    koaContext: koaCtxt,
-                    operationType: dbos_executor_1.OperationType.HANDLER,
-                };
-                try {
-                    // Check for auth first
-                    if (defaults?.authMiddleware) {
-                        await api_1.context.with(api_1.trace.setSpan(api_1.context.active(), span), async () => {
-                            await (0, context_1.runWithTopContext)(dctx, async () => {
-                                const res = await defaults.authMiddleware({
-                                    name: ro.name,
-                                    requiredRole: ro.getRequiredRoles(),
-                                    koaContext: koaCtxt,
-                                    logger: dbosExec.ctxLogger,
-                                    span,
-                                    query: (query, ...args) => {
-                                        return dbosExec.queryUserDbFunction(query, ...args);
-                                    },
-                                });
-                                if (res) {
-                                    dctx.authenticatedUser = res.authenticatedUser;
-                                    dctx.authenticatedRoles = res.authenticatedRoles;
-                                }
-                            });
-                        });
-                    }
-                    // Parse the arguments.
-                    const args = [];
-                    ro.args.forEach((marg) => {
-                        marg.argSource = marg.argSource ?? handlerTypes_1.ArgSources.DEFAULT; // Assign a default value.
-                        let foundArg = undefined;
-                        const isQueryMethod = ro.apiType === handlerTypes_1.APITypes.GET || ro.apiType === handlerTypes_1.APITypes.DELETE;
-                        const isBodyMethod = ro.apiType === handlerTypes_1.APITypes.POST || ro.apiType === handlerTypes_1.APITypes.PUT || ro.apiType === handlerTypes_1.APITypes.PATCH;
-                        if ((isQueryMethod && marg.argSource === handlerTypes_1.ArgSources.DEFAULT) || marg.argSource === handlerTypes_1.ArgSources.QUERY) {
-                            foundArg = koaCtxt.request.query[marg.name];
-                            if (foundArg !== undefined) {
-                                args.push(foundArg);
-                            }
-                            else {
-                                if (marg.argSource === handlerTypes_1.ArgSources.DEFAULT && koaCtxt.request.body) {
-                                    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-assignment
-                                    foundArg = koaCtxt.request.body[marg.name];
-                                    if (foundArg !== undefined) {
-                                        args.push(foundArg);
-                                    }
-                                }
-                            }
-                        }
-                        else if ((isBodyMethod && marg.argSource === handlerTypes_1.ArgSources.DEFAULT) || marg.argSource === handlerTypes_1.ArgSources.BODY) {
-                            if (koaCtxt.request.body) {
-                                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-assignment
-                                foundArg = koaCtxt.request.body[marg.name];
-                                if (foundArg !== undefined) {
-                                    args.push(foundArg);
-                                }
-                            }
-                            if (!foundArg && marg.argSource === handlerTypes_1.ArgSources.DEFAULT) {
-                                foundArg = koaCtxt.request.query[marg.name];
-                                if (foundArg !== undefined) {
-                                    args.push(foundArg);
-                                }
-                            }
-                        }
-                        // Try to parse the argument from the URL if nothing found.
-                        if (foundArg === undefined) {
-                            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-                            args.push(koaCtxt.params[marg.name]);
-                        }
-                        //console.log(`found arg ${marg.name} ${idx} ${args[idx-1]}`);
-                    });
-                    // Extract workflow ID from headers (if any).
-                    // We pass in the specified workflow ID to workflows and transactions, but doesn't restrict how handlers use it.
-                    dctx.idAssignedForNextWorkflow = koaCtxt.get(exports.WorkflowUUIDHeader);
-                    // Finally, invoke the transaction/workflow/plain function and properly set HTTP response.
-                    // If functions return successfully and hasn't set the body, we set the body to the function return value. The status code will be automatically set to 200 or 204 (if the body is null/undefined).
-                    // In case of an exception:
-                    // - If a client-side error is thrown, we return 400.
-                    // - If an error contains a `status` field, we return the specified status code.
-                    // - Otherwise, we return 500.
-                    // configuredInstance is currently null; we don't allow configured handlers now.
-                    const wfParams = {
-                        workflowUUID: dctx.idAssignedForNextWorkflow,
-                        configuredInstance: null,
-                    };
-                    await api_1.context.with(api_1.trace.setSpan(api_1.context.active(), span), async () => {
-                        await (0, context_1.runWithTopContext)(dctx, async () => {
-                            if (ro.txnConfig) {
-                                koaCtxt.body = await dbosExec.runTransactionTempWF(ro.registeredFunction, wfParams, ...args);
-                            }
-                            else if (ro.workflowConfig) {
-                                koaCtxt.body = await (await dbosExec.workflow(ro.registeredFunction, wfParams, ...args)).getResult();
-                            }
-                            else if (ro.stepConfig) {
-                                koaCtxt.body = await dbosExec.runStepTempWF(ro.registeredFunction, wfParams, ...args);
-                            }
-                            else {
-                                // Directly invoke the handler code.
-                                const cresult = await ro.invoke(undefined, [...args]);
-                                const retValue = cresult;
-                                // Set the body to the return value unless the body is already set by the handler.
-                                if (koaCtxt.body === undefined) {
-                                    koaCtxt.body = retValue;
-                                }
-                            }
-                        });
-                    });
-                    span?.setStatus({ code: api_1.SpanStatusCode.OK });
-                }
-                catch (e) {
-                    if (e instanceof Error) {
-                        const annotated_e = e;
-                        if (annotated_e.dbos_already_logged !== true) {
-                            dbos_1.DBOS.logger.error(e);
-                        }
-                        span?.setStatus({ code: api_1.SpanStatusCode.ERROR, message: e.message });
-                        let st = e?.status || 500;
-                        if ((0, error_1.isDataValidationError)(e)) {
-                            st = 400; // Set to 400: client-side error.
-                        }
-                        koaCtxt.status = st;
-                        koaCtxt.message = e.message;
-                        koaCtxt.body = {
-                            status: st,
-                            message: e.message,
-                            details: e,
-                        };
-                    }
-                    else {
-                        // FIXME we should have a standard, user friendly message for errors that are not instances of Error.
-                        // using stringify() will not produce a pretty output, because our format function uses stringify() too.
-                        dbos_1.DBOS.logger.error(utils_1.DBOSJSON.stringify(e));
-                        span?.setStatus({ code: api_1.SpanStatusCode.ERROR, message: utils_1.DBOSJSON.stringify(e) });
-                        koaCtxt.body = e;
-                        koaCtxt.status = 500;
-                    }
-                }
-                finally {
-                    httpTracer.inject(api_1.trace.setSpanContext(api_1.ROOT_CONTEXT, span.spanContext()), {
-                        context: koaCtxt,
-                    }, {
-                        set: (carrier, key, value) => {
-                            carrier.context.set(key, value);
-                        },
-                    });
-                    dbosExec.tracer.endSpan(span);
-                    await koaNext();
-                }
-            };
-            // Actually register the endpoint.
-            // Middleware functions are applied directly to router verb methods to prevent duplicate calls.
-            const routeMiddlewares = [defaults.koaBodyParser ?? (0, bodyparser_1.bodyParser)()].concat(defaults.koaMiddlewares ?? []);
-            switch (ro.apiType) {
-                case handlerTypes_1.APITypes.GET:
-                    router.get(ro.apiURL, ...routeMiddlewares, wrappedHandler);
-                    dbosExec.logger.debug(`DBOS Server Registered GET ${ro.apiURL}`);
-                    break;
-                case handlerTypes_1.APITypes.POST:
-                    router.post(ro.apiURL, ...routeMiddlewares, wrappedHandler);
-                    dbosExec.logger.debug(`DBOS Server Registered POST ${ro.apiURL}`);
-                    break;
-                case handlerTypes_1.APITypes.PUT:
-                    router.put(ro.apiURL, ...routeMiddlewares, wrappedHandler);
-                    dbosExec.logger.debug(`DBOS Server Registered PUT ${ro.apiURL}`);
-                    break;
-                case handlerTypes_1.APITypes.PATCH:
-                    router.patch(ro.apiURL, ...routeMiddlewares, wrappedHandler);
-                    dbosExec.logger.debug(`DBOS Server Registered PATCH ${ro.apiURL}`);
-                    break;
-                case handlerTypes_1.APITypes.DELETE:
-                    router.delete(ro.apiURL, ...routeMiddlewares, wrappedHandler);
-                    dbosExec.logger.debug(`DBOS Server Registered DELETE ${ro.apiURL}`);
-                    break;
-                default:
-                    (0, utils_1.exhaustiveCheckGuard)(ro.apiType);
-            }
-        });
-    }
-}
-exports.DBOSHttpServer = DBOSHttpServer;
-//# sourceMappingURL=server.js.map