@dbos-inc/dbos-sdk 0.7.18-preview

package/dist/src/httpServer/server.js

@@ -0,0 +1,231 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DBOSHttpServer = 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 handler_1 = require("./handler");
+const error_1 = require("../error");
+const api_1 = require("@opentelemetry/api");
+exports.WorkflowUUIDHeader = "dbos-workflowuuid";
+exports.WorkflowRecoveryUrl = "/dbos-workflow-recovery";
+class DBOSHttpServer {
+    dbosExec;
+    app;
+    router;
+    logger;
+    /**
+     * Create a Koa app.
+     * @param dbosExec User pass in an DBOS workflow executor instance.
+     * TODO: maybe call wfe.init() somewhere in this class?
+     */
+    constructor(dbosExec, config = {}) {
+        this.dbosExec = dbosExec;
+        if (!config.router) {
+            config.router = new router_1.default();
+        }
+        this.router = config.router;
+        this.logger = dbosExec.logger;
+        if (!config.koa) {
+            config.koa = new koa_1.default();
+            // Note: we definitely need bodyParser.
+            // For cors(), it doesn't work if we use it in a router, and thus we have to use it in app.
+            config.koa.use((0, bodyparser_1.bodyParser)());
+            config.koa.use((0, cors_1.default)());
+        }
+        this.app = config.koa;
+        // Register HTTP endpoints.
+        DBOSHttpServer.registerRecoveryEndpoint(this.dbosExec, this.router);
+        DBOSHttpServer.registerDecoratedEndpoints(this.dbosExec, this.router);
+        this.app.use(this.router.routes()).use(this.router.allowedMethods());
+    }
+    /**
+     * Register HTTP endpoints and attach to the app. Then start the server at the given port.
+     * @param port
+     */
+    listen(port) {
+        // Start the HTTP server.
+        return this.app.listen(port, () => {
+            this.logger.info(`DBOS Server is running at http://localhost:${port}`);
+        });
+    }
+    /**
+     * Register workflow recovery endpoint.
+     * Receives a list of executor IDs and returns a list of workflowUUIDs.
+     */
+    static registerRecoveryEndpoint(wfe, router) {
+        // Handler function that parses request for recovery.
+        const recoveryHandler = async (koaCtxt, koaNext) => {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+            const executorIDs = koaCtxt.request.body;
+            wfe.logger.info("Recovering workflows for executors: " + executorIDs.toString());
+            const recoverHandles = await wfe.recoverPendingWorkflows(executorIDs);
+            // Return a list of workflowUUIDs being recovered.
+            koaCtxt.body = await Promise.allSettled(recoverHandles.map((i) => i.getWorkflowUUID())).then((results) => results.filter((i) => i.status === "fulfilled").map((i) => i.value));
+            await koaNext();
+        };
+        router.post(exports.WorkflowRecoveryUrl, recoveryHandler);
+        wfe.logger.debug(`DBOS Server Registered Recovery POST ${exports.WorkflowRecoveryUrl}`);
+    }
+    /**
+     * Register decorated functions as HTTP endpoints.
+     */
+    static registerDecoratedEndpoints(wfe, router) {
+        // Register user declared endpoints, wrap around the endpoint with request parsing and response.
+        wfe.registeredOperations.forEach((registeredOperation) => {
+            const ro = registeredOperation;
+            if (ro.apiURL) {
+                // Ignore URL with "/dbos-workflow-recovery" prefix.
+                if (ro.apiURL.startsWith(exports.WorkflowRecoveryUrl)) {
+                    wfe.logger.error(`Invalid URL: ${ro.apiURL} -- should not start with ${exports.WorkflowRecoveryUrl}!`);
+                    return;
+                }
+                // Check if we need to apply any Koa middleware.
+                const defaults = ro.defaults;
+                if (defaults?.koaMiddlewares) {
+                    defaults.koaMiddlewares.forEach((koaMiddleware) => {
+                        wfe.logger.debug(`DBOS Server applying middleware ${koaMiddleware.name} to ${ro.apiURL}`);
+                        router.use(ro.apiURL, koaMiddleware);
+                    });
+                }
+                // Wrapper function that parses request and send response.
+                const wrappedHandler = async (koaCtxt, koaNext) => {
+                    const oc = new handler_1.HandlerContextImpl(wfe, koaCtxt);
+                    try {
+                        // Check for auth first
+                        if (defaults?.authMiddleware) {
+                            const res = await defaults.authMiddleware({
+                                name: ro.name,
+                                requiredRole: ro.getRequiredRoles(),
+                                koaContext: koaCtxt,
+                                logger: oc.logger,
+                                span: oc.span,
+                                getConfig: (key, def) => {
+                                    return oc.getConfig(key, def);
+                                },
+                                query: (query, ...args) => {
+                                    return wfe.userDatabase.queryFunction(query, ...args);
+                                },
+                            });
+                            if (res) {
+                                oc.authenticatedUser = res.authenticatedUser;
+                                oc.authenticatedRoles = res.authenticatedRoles;
+                            }
+                        }
+                        // Parse the arguments.
+                        const args = [];
+                        ro.args.forEach((marg, idx) => {
+                            marg.argSource = marg.argSource ?? handler_1.ArgSources.DEFAULT; // Assign a default value.
+                            if (idx === 0) {
+                                return; // Do not parse the context.
+                            }
+                            let foundArg = undefined;
+                            if ((ro.apiType === handler_1.APITypes.GET && marg.argSource === handler_1.ArgSources.DEFAULT) || marg.argSource === handler_1.ArgSources.QUERY) {
+                                foundArg = koaCtxt.request.query[marg.name];
+                                if (foundArg) {
+                                    args.push(foundArg);
+                                }
+                            }
+                            else if ((ro.apiType === handler_1.APITypes.POST && marg.argSource === handler_1.ArgSources.DEFAULT) || marg.argSource === handler_1.ArgSources.BODY) {
+                                if (!koaCtxt.request.body) {
+                                    throw new error_1.DBOSDataValidationError(`Argument ${marg.name} requires a method body.`);
+                                }
+                                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-assignment
+                                foundArg = koaCtxt.request.body[marg.name];
+                                if (foundArg) {
+                                    args.push(foundArg);
+                                }
+                            }
+                            // Try to parse the argument from the URL if nothing found.
+                            if (!foundArg) {
+                                // 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 UUID from headers (if any).
+                        // We pass in the specified workflow UUID to workflows and transactions, but doesn't restrict how handlers use it.
+                        const headerWorkflowUUID = 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.
+                        const wfParams = { parentCtx: oc, workflowUUID: headerWorkflowUUID };
+                        if (ro.txnConfig) {
+                            koaCtxt.body = await wfe.transaction(ro.registeredFunction, wfParams, ...args);
+                        }
+                        else if (ro.workflowConfig) {
+                            koaCtxt.body = await (await wfe.workflow(ro.registeredFunction, wfParams, ...args)).getResult();
+                        }
+                        else if (ro.commConfig) {
+                            koaCtxt.body = await wfe.external(ro.registeredFunction, wfParams, ...args);
+                        }
+                        else {
+                            // Directly invoke the handler code.
+                            const retValue = await ro.invoke(undefined, [oc, ...args]);
+                            // Set the body to the return value unless the body is already set by the handler.
+                            if (koaCtxt.body === undefined) {
+                                koaCtxt.body = retValue;
+                            }
+                        }
+                        oc.span.setStatus({ code: api_1.SpanStatusCode.OK });
+                    }
+                    catch (e) {
+                        if (e instanceof Error) {
+                            oc.logger.error(e.message);
+                            oc.span.setStatus({ code: api_1.SpanStatusCode.ERROR, message: e.message });
+                            let st = e?.status || 500;
+                            const dbosErrorCode = e?.dbosErrorCode;
+                            if (dbosErrorCode && (0, error_1.isClientError)(dbosErrorCode)) {
+                                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.
+                            oc.logger.error(JSON.stringify(e));
+                            oc.span.setStatus({ code: api_1.SpanStatusCode.ERROR, message: JSON.stringify(e) });
+                            koaCtxt.body = e;
+                            koaCtxt.status = 500;
+                        }
+                    }
+                    finally {
+                        oc.W3CTraceContextPropagator.inject(api_1.trace.setSpanContext(api_1.ROOT_CONTEXT, oc.span.spanContext()), {
+                            context: koaCtxt,
+                        }, {
+                            set: (carrier, key, value) => {
+                                carrier.context.set(key, value);
+                            },
+                        });
+                        wfe.tracer.endSpan(oc.span);
+                        await koaNext();
+                    }
+                };
+                // Actually register the endpoint.
+                if (ro.apiType === handler_1.APITypes.GET) {
+                    router.get(ro.apiURL, wrappedHandler);
+                    wfe.logger.debug(`DBOS Server Registered GET ${ro.apiURL}`);
+                }
+                else if (ro.apiType === handler_1.APITypes.POST) {
+                    router.post(ro.apiURL, wrappedHandler);
+                    wfe.logger.debug(`DBOS Server Registered POST ${ro.apiURL}`);
+                }
+            }
+        });
+    }
+}
+exports.DBOSHttpServer = DBOSHttpServer;
+//# sourceMappingURL=server.js.map

package/dist/src/httpServer/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../../../src/httpServer/server.ts"],"names":[],"mappings":";;;;;;AAAA,8CAAsB;AACtB,yDAAiC;AACjC,gDAA6C;AAC7C,qDAA6B;AAC7B,uCAKmB;AAGnB,oCAKkB;AAIlB,4CAAyE;AAG5D,QAAA,kBAAkB,GAAG,mBAAmB,CAAC;AACzC,QAAA,mBAAmB,GAAG,yBAAyB,CAAA;AAE5D,MAAa,cAAc;IAUJ;IATZ,GAAG,CAAM;IACT,MAAM,CAAS;IACf,MAAM,CAAS;IAExB;;;;OAIG;IACH,YAAqB,QAAsB,EAAE,SAAyC,EAAE;QAAnE,aAAQ,GAAR,QAAQ,CAAc;QACzC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;YAClB,MAAM,CAAC,MAAM,GAAG,IAAI,gBAAM,EAAE,CAAC;SAC9B;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;QAE9B,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE;YACf,MAAM,CAAC,GAAG,GAAG,IAAI,aAAG,EAAE,CAAC;YAEvB,uCAAuC;YACvC,2FAA2F;YAC3F,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAA,uBAAU,GAAE,CAAC,CAAC;YAC7B,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAA,cAAI,GAAE,CAAC,CAAC;SACxB;QACD,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC;QAEtB,2BAA2B;QAC3B,cAAc,CAAC,wBAAwB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACpE,cAAc,CAAC,0BAA0B,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACtE,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,IAAY;QACjB,yBAAyB;QACzB,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE;YAChC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,8CAA8C,IAAI,EAAE,CAAC,CAAC;QACzE,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,wBAAwB,CAAC,GAAiB,EAAE,MAAc;QAC/D,qDAAqD;QACrD,MAAM,eAAe,GAAG,KAAK,EAAE,OAAoB,EAAE,OAAiB,EAAE,EAAE;YACxE,sEAAsE;YACtE,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,CAAC,IAAgB,CAAC;YACrD,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,sCAAsC,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;YACjF,MAAM,cAAc,GAAG,MAAM,GAAG,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;YAEtE,kDAAkD;YAClD,OAAO,CAAC,IAAI,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CACvG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAE,CAAqC,CAAC,KAAK,CAAC,CACzG,CAAC;YACF,MAAM,OAAO,EAAE,CAAC;QAClB,CAAC,CAAC;QAEF,MAAM,CAAC,IAAI,CAAC,2BAAmB,EAAE,eAAe,CAAC,CAAC;QAClD,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,wCAAwC,2BAAmB,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,0BAA0B,CAAC,GAAiB,EAAE,MAAc;QACjE,gGAAgG;QAChG,GAAG,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,mBAAmB,EAAE,EAAE;YACvD,MAAM,EAAE,GAAG,mBAAuE,CAAC;YACnF,IAAI,EAAE,CAAC,MAAM,EAAE;gBACb,oDAAoD;gBACpD,IAAI,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,2BAAmB,CAAC,EAAE;oBAC7C,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC,MAAM,6BAA6B,2BAAmB,GAAG,CAAC,CAAC;oBAC/F,OAAO;iBACR;gBAED,gDAAgD;gBAChD,MAAM,QAAQ,GAAG,EAAE,CAAC,QAA8B,CAAC;gBACnD,IAAI,QAAQ,EAAE,cAAc,EAAE;oBAC5B,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;wBAChD,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,mCAAmC,aAAa,CAAC,IAAI,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;wBAC1F,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;oBACvC,CAAC,CAAC,CAAC;iBACJ;gBAED,0DAA0D;gBAC1D,MAAM,cAAc,GAAG,KAAK,EAAE,OAAoB,EAAE,OAAiB,EAAE,EAAE;oBACvE,MAAM,EAAE,GAAuB,IAAI,4BAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;oBAEpE,IAAI;wBACF,uBAAuB;wBACvB,IAAI,QAAQ,EAAE,cAAc,EAAE;4BAC5B,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,cAAc,CAAC;gCACxC,IAAI,EAAE,EAAE,CAAC,IAAI;gCACb,YAAY,EAAE,EAAE,CAAC,gBAAgB,EAAE;gCACnC,UAAU,EAAE,OAAO;gCACnB,MAAM,EAAE,EAAE,CAAC,MAAM;gCACjB,IAAI,EAAE,EAAE,CAAC,IAAI;gCACb,SAAS,EAAE,CAAC,GAAW,EAAE,GAAG,EAAE,EAAE;oCAC9B,OAAO,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;gCAChC,CAAC;gCACD,KAAK,EAAE,CAAC,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE;oCACxB,OAAO,GAAG,CAAC,YAAY,CAAC,aAAa,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;gCACxD,CAAC;6BACF,CAAC,CAAC;4BACH,IAAI,GAAG,EAAE;gCACP,EAAE,CAAC,iBAAiB,GAAG,GAAG,CAAC,iBAAiB,CAAC;gCAC7C,EAAE,CAAC,kBAAkB,GAAG,GAAG,CAAC,kBAAkB,CAAC;6BAChD;yBACF;wBAED,uBAAuB;wBACvB,MAAM,IAAI,GAAc,EAAE,CAAC;wBAC3B,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;4BAC5B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,IAAI,oBAAU,CAAC,OAAO,CAAC,CAAC,0BAA0B;4BACjF,IAAI,GAAG,KAAK,CAAC,EAAE;gCACb,OAAO,CAAC,4BAA4B;6BACrC;4BAED,IAAI,QAAQ,GAAG,SAAS,CAAC;4BACzB,IAAI,CAAC,EAAE,CAAC,OAAO,KAAK,kBAAQ,CAAC,GAAG,IAAI,IAAI,CAAC,SAAS,KAAK,oBAAU,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,SAAS,KAAK,oBAAU,CAAC,KAAK,EAAE;gCACjH,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gCAC5C,IAAI,QAAQ,EAAE;oCACZ,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;iCACrB;6BACF;iCAAM,IAAI,CAAC,EAAE,CAAC,OAAO,KAAK,kBAAQ,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,oBAAU,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,SAAS,KAAK,oBAAU,CAAC,IAAI,EAAE;gCACxH,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE;oCACzB,MAAM,IAAI,+BAAuB,CAAC,YAAY,IAAI,CAAC,IAAI,0BAA0B,CAAC,CAAC;iCACpF;gCACD,+GAA+G;gCAC/G,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gCAC3C,IAAI,QAAQ,EAAE;oCACZ,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;iCACrB;6BACF;4BAED,2DAA2D;4BAC3D,IAAI,CAAC,QAAQ,EAAE;gCACb,sEAAsE;gCACtE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;6BACtC;4BAED,8DAA8D;wBAChE,CAAC,CAAC,CAAC;wBAEH,+CAA+C;wBAC/C,kHAAkH;wBAClH,MAAM,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,0BAAkB,CAAC,CAAC;wBAE3D,0FAA0F;wBAC1F,mMAAmM;wBACnM,2BAA2B;wBAC3B,qDAAqD;wBACrD,gFAAgF;wBAChF,8BAA8B;wBAC9B,MAAM,QAAQ,GAAG,EAAE,SAAS,EAAE,EAAE,EAAE,YAAY,EAAE,kBAAkB,EAAE,CAAC;wBACrE,IAAI,EAAE,CAAC,SAAS,EAAE;4BAChB,OAAO,CAAC,IAAI,GAAG,MAAM,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,kBAAqD,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAC;yBACnH;6BAAM,IAAI,EAAE,CAAC,cAAc,EAAE;4BAC5B,OAAO,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,kBAAkD,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;yBACjI;6BAAM,IAAI,EAAE,CAAC,UAAU,EAAE;4BACxB,OAAO,CAAC,IAAI,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,kBAAsD,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAC;yBACjH;6BAAM;4BACL,oCAAoC;4BACpC,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;4BAE3D,kFAAkF;4BAClF,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE;gCAC9B,OAAO,CAAC,IAAI,GAAG,QAAQ,CAAC;6BACzB;yBACF;wBACD,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,oBAAc,CAAC,EAAE,EAAE,CAAC,CAAC;qBAChD;oBAAC,OAAO,CAAC,EAAE;wBACV,IAAI,CAAC,YAAY,KAAK,EAAE;4BACtB,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;4BAC3B,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,oBAAc,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;4BACtE,IAAI,EAAE,GAAI,CAAuB,EAAE,MAAM,IAAI,GAAG,CAAC;4BACjD,MAAM,aAAa,GAAI,CAAe,EAAE,aAAa,CAAC;4BACtD,IAAI,aAAa,IAAI,IAAA,qBAAa,EAAC,aAAa,CAAC,EAAE;gCACjD,EAAE,GAAG,GAAG,CAAC,CAAC,iCAAiC;6BAC5C;4BACD,OAAO,CAAC,MAAM,GAAG,EAAE,CAAC;4BACpB,OAAO,CAAC,OAAO,GAAG,CAAC,CAAC,OAAO,CAAC;4BAC5B,OAAO,CAAC,IAAI,GAAG;gCACb,MAAM,EAAE,EAAE;gCACV,OAAO,EAAE,CAAC,CAAC,OAAO;gCAClB,OAAO,EAAE,CAAC;6BACX,CAAC;yBACH;6BAAM;4BACL,qGAAqG;4BACrG,wGAAwG;4BACxG,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;4BACnC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,oBAAc,CAAC,KAAK,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;4BAC9E,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;4BACjB,OAAO,CAAC,MAAM,GAAG,GAAG,CAAC;yBACtB;qBACF;4BAAS;wBAQR,EAAE,CAAC,yBAAyB,CAAC,MAAM,CACjC,WAAK,CAAC,cAAc,CAAC,kBAAY,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EACzD;4BACE,OAAO,EAAE,OAAO;yBACjB,EACD;4BACE,GAAG,EAAE,CAAC,OAAgB,EAAE,GAAW,EAAE,KAAa,EAAE,EAAE;gCACpD,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;4BAClC,CAAC;yBACF,CACF,CAAC;wBACF,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;wBAC5B,MAAM,OAAO,EAAE,CAAC;qBACjB;gBACH,CAAC,CAAC;gBAEF,kCAAkC;gBAClC,IAAI,EAAE,CAAC,OAAO,KAAK,kBAAQ,CAAC,GAAG,EAAE;oBAC/B,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;oBACtC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,8BAA8B,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;iBAC7D;qBAAM,IAAI,EAAE,CAAC,OAAO,KAAK,kBAAQ,CAAC,IAAI,EAAE;oBACvC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;oBACvC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,EAAE,CAAC,MAAM,EAAE,CAAC,CAAC;iBAC9D;aACF;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA5OD,wCA4OC"}

package/dist/src/index.d.ts

@@ -0,0 +1,12 @@
+export { createTestingRuntime, TestingRuntime, } from './testing/testing_runtime';
+export { DBOSContext, InitContext, } from './context';
+export { TransactionContext, TransactionConfig, } from './transaction';
+export { WorkflowContext, WorkflowConfig, WorkflowHandle, StatusString, } from './workflow';
+export { CommunicatorContext, CommunicatorConfig, } from './communicator';
+export * as Error from './error';
+export { DBOSResponseError } from './error';
+export { LogMasks, Debug, ArgRequired, ArgOptional, SkipLogging, LogMask, ArgName, ArgDate, ArgVarchar, DefaultRequiredRole, DefaultArgRequired, DefaultArgOptional, OrmEntities, Transaction, Workflow, Communicator, RequiredRole, DBOSInitializer, DBOSDeploy, } from "./decorators";
+export { ArgSources, HandlerContext, ArgSource, GetApi, PostApi, } from "./httpServer/handler";
+export { DBOSHttpServer, } from "./httpServer/server";
+export { DBOSHttpAuthMiddleware, DBOSHttpAuthReturn, MiddlewareContext, Authentication, KoaMiddleware, OpenApiSecurityScheme } from "./httpServer/middleware";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,cAAc,GACf,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EACL,WAAW,EACX,WAAW,GACZ,MAAM,WAAW,CAAC;AAEnB,OAAO,EACL,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,eAAe,CAAC;AAEvB,OAAO,EACL,eAAe,EACf,cAAc,EACd,cAAc,EACd,YAAY,GACb,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,mBAAmB,EACnB,kBAAkB,GACnB,MAAM,gBAAgB,CAAC;AAExB,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AAEjC,OAAO,EACL,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAEjB,OAAO,EACL,QAAQ,EACR,KAAK,EAGL,WAAW,EACX,WAAW,EACX,WAAW,EACX,OAAO,EACP,OAAO,EACP,OAAO,EACP,UAAU,EAGV,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAElB,WAAW,EAGX,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,YAAY,EACZ,eAAe,EACf,UAAU,GACX,MAAM,cAAc,CAAC;AAEtB,OAAO,EACL,UAAU,EACV,cAAc,EAGd,SAAS,EAGT,MAAM,EACN,OAAO,GACR,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EACL,cAAc,GACf,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,sBAAsB,EACtB,kBAAkB,EAClB,iBAAiB,EAGjB,cAAc,EACd,aAAa,EAGb,qBAAqB,EACtB,MAAM,yBAAyB,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,75 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenApiSecurityScheme = exports.KoaMiddleware = exports.Authentication = exports.DBOSHttpServer = exports.PostApi = exports.GetApi = exports.ArgSource = exports.ArgSources = exports.DBOSDeploy = exports.DBOSInitializer = exports.RequiredRole = exports.Communicator = exports.Workflow = exports.Transaction = exports.OrmEntities = exports.DefaultArgOptional = exports.DefaultArgRequired = exports.DefaultRequiredRole = exports.ArgVarchar = exports.ArgDate = exports.ArgName = exports.LogMask = exports.SkipLogging = exports.ArgOptional = exports.ArgRequired = exports.Debug = exports.LogMasks = exports.DBOSResponseError = exports.Error = exports.StatusString = exports.InitContext = exports.createTestingRuntime = void 0;
+var testing_runtime_1 = require("./testing/testing_runtime");
+Object.defineProperty(exports, "createTestingRuntime", { enumerable: true, get: function () { return testing_runtime_1.createTestingRuntime; } });
+var context_1 = require("./context");
+Object.defineProperty(exports, "InitContext", { enumerable: true, get: function () { return context_1.InitContext; } });
+var workflow_1 = require("./workflow");
+Object.defineProperty(exports, "StatusString", { enumerable: true, get: function () { return workflow_1.StatusString; } });
+exports.Error = __importStar(require("./error"));
+var error_1 = require("./error");
+Object.defineProperty(exports, "DBOSResponseError", { enumerable: true, get: function () { return error_1.DBOSResponseError; } });
+var decorators_1 = require("./decorators");
+Object.defineProperty(exports, "LogMasks", { enumerable: true, get: function () { return decorators_1.LogMasks; } });
+Object.defineProperty(exports, "Debug", { enumerable: true, get: function () { return decorators_1.Debug; } });
+// Parameter Decorators
+Object.defineProperty(exports, "ArgRequired", { enumerable: true, get: function () { return decorators_1.ArgRequired; } });
+Object.defineProperty(exports, "ArgOptional", { enumerable: true, get: function () { return decorators_1.ArgOptional; } });
+Object.defineProperty(exports, "SkipLogging", { enumerable: true, get: function () { return decorators_1.SkipLogging; } });
+Object.defineProperty(exports, "LogMask", { enumerable: true, get: function () { return decorators_1.LogMask; } });
+Object.defineProperty(exports, "ArgName", { enumerable: true, get: function () { return decorators_1.ArgName; } });
+Object.defineProperty(exports, "ArgDate", { enumerable: true, get: function () { return decorators_1.ArgDate; } });
+Object.defineProperty(exports, "ArgVarchar", { enumerable: true, get: function () { return decorators_1.ArgVarchar; } });
+// Class Decorators
+Object.defineProperty(exports, "DefaultRequiredRole", { enumerable: true, get: function () { return decorators_1.DefaultRequiredRole; } });
+Object.defineProperty(exports, "DefaultArgRequired", { enumerable: true, get: function () { return decorators_1.DefaultArgRequired; } });
+Object.defineProperty(exports, "DefaultArgOptional", { enumerable: true, get: function () { return decorators_1.DefaultArgOptional; } });
+// Typeorm Class Decorators
+Object.defineProperty(exports, "OrmEntities", { enumerable: true, get: function () { return decorators_1.OrmEntities; } });
+// Method Decorators
+Object.defineProperty(exports, "Transaction", { enumerable: true, get: function () { return decorators_1.Transaction; } });
+Object.defineProperty(exports, "Workflow", { enumerable: true, get: function () { return decorators_1.Workflow; } });
+Object.defineProperty(exports, "Communicator", { enumerable: true, get: function () { return decorators_1.Communicator; } });
+Object.defineProperty(exports, "RequiredRole", { enumerable: true, get: function () { return decorators_1.RequiredRole; } });
+Object.defineProperty(exports, "DBOSInitializer", { enumerable: true, get: function () { return decorators_1.DBOSInitializer; } });
+Object.defineProperty(exports, "DBOSDeploy", { enumerable: true, get: function () { return decorators_1.DBOSDeploy; } });
+var handler_1 = require("./httpServer/handler");
+Object.defineProperty(exports, "ArgSources", { enumerable: true, get: function () { return handler_1.ArgSources; } });
+// Endpoint Parameter Decorators
+Object.defineProperty(exports, "ArgSource", { enumerable: true, get: function () { return handler_1.ArgSource; } });
+// Endpoint Decorators
+Object.defineProperty(exports, "GetApi", { enumerable: true, get: function () { return handler_1.GetApi; } });
+Object.defineProperty(exports, "PostApi", { enumerable: true, get: function () { return handler_1.PostApi; } });
+var server_1 = require("./httpServer/server");
+Object.defineProperty(exports, "DBOSHttpServer", { enumerable: true, get: function () { return server_1.DBOSHttpServer; } });
+var middleware_1 = require("./httpServer/middleware");
+// Middleware Decorators
+Object.defineProperty(exports, "Authentication", { enumerable: true, get: function () { return middleware_1.Authentication; } });
+Object.defineProperty(exports, "KoaMiddleware", { enumerable: true, get: function () { return middleware_1.KoaMiddleware; } });
+// OpenApi Decorators
+Object.defineProperty(exports, "OpenApiSecurityScheme", { enumerable: true, get: function () { return middleware_1.OpenApiSecurityScheme; } });
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6DAGmC;AAFjC,uHAAA,oBAAoB,OAAA;AAItB,qCAGmB;AADjB,sGAAA,WAAW,OAAA;AAQb,uCAKoB;AADlB,wGAAA,YAAY,OAAA;AAQd,iDAAiC;AAEjC,iCAEiB;AADf,0GAAA,iBAAiB,OAAA;AAGnB,2CA2BsB;AA1BpB,sGAAA,QAAQ,OAAA;AACR,mGAAA,KAAK,OAAA;AAEL,uBAAuB;AACvB,yGAAA,WAAW,OAAA;AACX,yGAAA,WAAW,OAAA;AACX,yGAAA,WAAW,OAAA;AACX,qGAAA,OAAO,OAAA;AACP,qGAAA,OAAO,OAAA;AACP,qGAAA,OAAO,OAAA;AACP,wGAAA,UAAU,OAAA;AAEV,mBAAmB;AACnB,iHAAA,mBAAmB,OAAA;AACnB,gHAAA,kBAAkB,OAAA;AAClB,gHAAA,kBAAkB,OAAA;AAClB,2BAA2B;AAC3B,yGAAA,WAAW,OAAA;AAEX,oBAAoB;AACpB,yGAAA,WAAW,OAAA;AACX,sGAAA,QAAQ,OAAA;AACR,0GAAA,YAAY,OAAA;AACZ,0GAAA,YAAY,OAAA;AACZ,6GAAA,eAAe,OAAA;AACf,wGAAA,UAAU,OAAA;AAGZ,gDAU8B;AAT5B,qGAAA,UAAU,OAAA;AAGV,gCAAgC;AAChC,oGAAA,SAAS,OAAA;AAET,sBAAsB;AACtB,iGAAA,MAAM,OAAA;AACN,kGAAA,OAAO,OAAA;AAGT,8CAE6B;AAD3B,wGAAA,cAAc,OAAA;AAGhB,sDAWiC;AAN/B,wBAAwB;AACxB,4GAAA,cAAc,OAAA;AACd,2GAAA,aAAa,OAAA;AAEb,qBAAqB;AACrB,mHAAA,qBAAqB,OAAA"}

package/dist/src/provenance/provenance_daemon.d.ts

@@ -0,0 +1,34 @@
+/// <reference types="node" />
+import { Client } from "pg";
+import { TelemetryCollector } from "../telemetry/collector";
+import { DBOSConfig } from "../dbos-executor";
+/**
+ * A class implementing a daemon which collects and exports provenance information,
+ * specifically a record of all INSERTs, UPDATEs, and DELETEs in the target database.
+ * Only one daemon is needed per database. The daemon need not run in the same process as workflow runtime.
+ * The daemon has three requirements and will fail to launch if any is not met:
+ *
+ *  1.  The database must be configured with wal_level=logical.
+ *  2.  An open replication slot must be available.
+ *  3.  The wal2json Postgres plugin must be installed. It is installed by default on most cloud databases, including RDS.
+ *
+ * Because the daemon depends on Postgres logical replication, it can only export information on updates and deletes in tables
+ * whose rows are uniquely identifiable, either because the table has a primary key or a replica identity.
+ */
+export declare class ProvenanceDaemon {
+    readonly slotName: string;
+    readonly client: Client;
+    readonly daemonID: NodeJS.Timeout;
+    readonly recordProvenanceIntervalMs = 1000;
+    readonly telemetryCollector: TelemetryCollector;
+    initialized: boolean;
+    /**
+     * @param dbosConfig An DBOS config defining exporters and database connection information.
+     * @param slotName  The name of a logical replication slot. This slot is persistent and must be deleted if the daemon is no longer to be used.
+     */
+    constructor(dbosConfig: DBOSConfig, slotName: string);
+    start(): Promise<void>;
+    recordProvenance(): Promise<void>;
+    stop(): Promise<void>;
+}
+//# sourceMappingURL=provenance_daemon.d.ts.map

package/dist/src/provenance/provenance_daemon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"provenance_daemon.d.ts","sourceRoot":"","sources":["../../../src/provenance/provenance_daemon.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAiB,MAAM,IAAI,CAAC;AAE3C,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAqB9C;;;;;;;;;;;;GAYG;AACH,qBAAa,gBAAgB;IAWS,QAAQ,CAAC,QAAQ,EAAE,MAAM;IAV7D,QAAQ,CAAC,MAAM,SAAC;IAChB,QAAQ,CAAC,QAAQ,iBAAC;IAClB,QAAQ,CAAC,0BAA0B,QAAQ;IAC3C,QAAQ,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;IAChD,WAAW,UAAS;IAEpB;;;OAGG;gBACS,UAAU,EAAE,UAAU,EAAW,QAAQ,EAAE,MAAM;IASvD,KAAK;IAkBL,gBAAgB;IAqBhB,IAAI;CAKX"}

package/dist/src/provenance/provenance_daemon.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProvenanceDaemon = void 0;
+const pg_1 = require("pg");
+const exporters_1 = require("../telemetry/exporters");
+const collector_1 = require("../telemetry/collector");
+/**
+ * A class implementing a daemon which collects and exports provenance information,
+ * specifically a record of all INSERTs, UPDATEs, and DELETEs in the target database.
+ * Only one daemon is needed per database. The daemon need not run in the same process as workflow runtime.
+ * The daemon has three requirements and will fail to launch if any is not met:
+ *
+ *  1.  The database must be configured with wal_level=logical.
+ *  2.  An open replication slot must be available.
+ *  3.  The wal2json Postgres plugin must be installed. It is installed by default on most cloud databases, including RDS.
+ *
+ * Because the daemon depends on Postgres logical replication, it can only export information on updates and deletes in tables
+ * whose rows are uniquely identifiable, either because the table has a primary key or a replica identity.
+ */
+class ProvenanceDaemon {
+    slotName;
+    client;
+    daemonID;
+    recordProvenanceIntervalMs = 1000;
+    telemetryCollector;
+    initialized = false;
+    /**
+     * @param dbosConfig An DBOS config defining exporters and database connection information.
+     * @param slotName  The name of a logical replication slot. This slot is persistent and must be deleted if the daemon is no longer to be used.
+     */
+    constructor(dbosConfig, slotName) {
+        this.slotName = slotName;
+        this.client = new pg_1.Client(dbosConfig.poolConfig);
+        this.daemonID = setInterval(() => {
+            void this.recordProvenance();
+        }, this.recordProvenanceIntervalMs);
+        const telemetryExporters = [new exporters_1.PostgresExporter(dbosConfig.poolConfig, dbosConfig?.observability_database)];
+        this.telemetryCollector = new collector_1.TelemetryCollector(telemetryExporters);
+    }
+    async start() {
+        await this.client.connect();
+        // Create a logical replication slot with the given name.
+        try { // TODO: Make this robust to daemon crashes, so records are not consumed until they've been exported.
+            await this.client.query("SELECT pg_create_logical_replication_slot($1, 'wal2json');", [this.slotName]);
+        }
+        catch (error) {
+            const err = error;
+            if (err.code === "42710") {
+                // The slot has already been created.
+            }
+            else {
+                console.error(err);
+                throw err;
+            }
+        }
+        await this.telemetryCollector.init();
+        this.initialized = true;
+    }
+    async recordProvenance() {
+        if (this.initialized) {
+            const { rows } = await this.client.query("SELECT CAST(xid AS TEXT), data FROM pg_logical_slot_get_changes($1, NULL, NULL, 'filter-tables', 'dbos.*')", [this.slotName]);
+            for (const row of rows) {
+                const data = JSON.parse(row.data).change;
+                for (const change of data) {
+                    const signal = {
+                        provTransactionID: row.xid,
+                        kind: change.kind,
+                        schema: change.schema,
+                        table: change.table,
+                        columnnames: change.columnnames,
+                        columntypes: change.columntypes,
+                        columnvalues: change.columnvalues
+                    };
+                    this.telemetryCollector.push(signal);
+                }
+            }
+        }
+    }
+    async stop() {
+        clearInterval(this.daemonID);
+        await this.client.end();
+        await this.telemetryCollector.destroy();
+    }
+}
+exports.ProvenanceDaemon = ProvenanceDaemon;
+//# sourceMappingURL=provenance_daemon.js.map

package/dist/src/provenance/provenance_daemon.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"provenance_daemon.js","sourceRoot":"","sources":["../../../src/provenance/provenance_daemon.ts"],"names":[],"mappings":";;;AAAA,2BAA2C;AAC3C,sDAA0D;AAC1D,sDAA4D;AAsB5D;;;;;;;;;;;;GAYG;AACH,MAAa,gBAAgB;IAWkB;IAVpC,MAAM,CAAC;IACP,QAAQ,CAAC;IACT,0BAA0B,GAAG,IAAI,CAAC;IAClC,kBAAkB,CAAqB;IAChD,WAAW,GAAG,KAAK,CAAC;IAEpB;;;OAGG;IACH,YAAY,UAAsB,EAAW,QAAgB;QAAhB,aAAQ,GAAR,QAAQ,CAAQ;QAC3D,IAAI,CAAC,MAAM,GAAG,IAAI,WAAM,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QAChD,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;YAC/B,KAAK,IAAI,CAAC,gBAAgB,EAAE,CAAC;QAC/B,CAAC,EAAE,IAAI,CAAC,0BAA0B,CAAC,CAAC;QACpC,MAAM,kBAAkB,GAAG,CAAC,IAAI,4BAAgB,CAAC,UAAU,CAAC,UAAU,EAAE,UAAU,EAAE,sBAAsB,CAAC,CAAC,CAAC;QAC7G,IAAI,CAAC,kBAAkB,GAAG,IAAI,8BAAkB,CAAC,kBAAkB,CAAC,CAAC;IACvE,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QAC5B,yDAAyD;QACzD,IAAI,EAAE,qGAAqG;YACzG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,4DAA4D,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;SACxG;QAAC,OAAO,KAAK,EAAE;YACd,MAAM,GAAG,GAAkB,KAAsB,CAAC;YAClD,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,EAAE;gBACxB,qCAAqC;aACtC;iBAAM;gBACL,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBACnB,MAAM,GAAG,CAAC;aACX;SACF;QACD,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,gBAAgB;QACpB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAc,4GAA4G,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;YACrL,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;gBACtB,MAAM,IAAI,GAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAkB,CAAC,MAAM,CAAC;gBAC3D,KAAK,MAAM,MAAM,IAAI,IAAI,EAAE;oBACzB,MAAM,MAAM,GAAqB;wBAC/B,iBAAiB,EAAE,GAAG,CAAC,GAAG;wBAC1B,IAAI,EAAE,MAAM,CAAC,IAAI;wBACjB,MAAM,EAAE,MAAM,CAAC,MAAM;wBACrB,KAAK,EAAE,MAAM,CAAC,KAAK;wBACnB,WAAW,EAAE,MAAM,CAAC,WAAW;wBAC/B,WAAW,EAAE,MAAM,CAAC,WAAW;wBAC/B,YAAY,EAAE,MAAM,CAAC,YAAY;qBAClC,CAAA;oBACD,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;iBACtC;aACF;SACF;IACH,CAAC;IAED,KAAK,CAAC,IAAI;QACR,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7B,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;QACxB,MAAM,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC;IAC1C,CAAC;CACF;AAhED,4CAgEC"}

package/dist/src/system_database.d.ts

@@ -0,0 +1,69 @@
+import { DBOSNull } from "./dbos-executor";
+import { Pool, PoolClient, PoolConfig } from "pg";
+import { WorkflowStatus } from "./workflow";
+import { HTTPRequest } from "./context";
+import { Logger } from "winston";
+export declare const DBOSExecutorIDHeader = "dbos-executor-id";
+export interface SystemDatabase {
+    init(): Promise<void>;
+    destroy(): Promise<void>;
+    checkWorkflowOutput<R>(workflowUUID: string): Promise<DBOSNull | R>;
+    initWorkflowStatus<T extends any[]>(workflowUUID: string, name: string, authenticatedUser: string, assumedRole: string, authenticatedRoles: string[], request: HTTPRequest | null, args: T): Promise<T>;
+    bufferWorkflowOutput<R>(workflowUUID: string, output: R): void;
+    flushWorkflowStatusBuffer(): Promise<Array<string>>;
+    recordWorkflowError(workflowUUID: string, error: Error): Promise<void>;
+    getPendingWorkflows(executorID: string): Promise<Array<string>>;
+    getWorkflowInputs<T extends any[]>(workflowUUID: string): Promise<T | null>;
+    checkOperationOutput<R>(workflowUUID: string, functionID: number): Promise<DBOSNull | R>;
+    recordOperationOutput<R>(workflowUUID: string, functionID: number, output: R): Promise<void>;
+    recordOperationError(workflowUUID: string, functionID: number, error: Error): Promise<void>;
+    getWorkflowStatus(workflowUUID: string, callerUUID?: string, functionID?: number): Promise<WorkflowStatus | null>;
+    getWorkflowResult<R>(workflowUUID: string): Promise<R>;
+    send<T extends NonNullable<any>>(workflowUUID: string, functionID: number, destinationUUID: string, message: T, topic?: string): Promise<void>;
+    recv<T extends NonNullable<any>>(workflowUUID: string, functionID: number, topic?: string, timeoutSeconds?: number): Promise<T | null>;
+    setEvent<T extends NonNullable<any>>(workflowUUID: string, functionID: number, key: string, value: T): Promise<void>;
+    getEvent<T extends NonNullable<any>>(workflowUUID: string, key: string, timeoutSeconds: number, callerUUID?: string, functionID?: number): Promise<T | null>;
+}
+export declare class PostgresSystemDatabase implements SystemDatabase {
+    readonly pgPoolConfig: PoolConfig;
+    readonly systemDatabaseName: string;
+    readonly logger: Logger;
+    readonly pool: Pool;
+    notificationsClient: PoolClient | null;
+    readonly notificationsMap: Record<string, () => void>;
+    readonly workflowEventsMap: Record<string, () => void>;
+    readonly workflowStatusBuffer: Map<string, any>;
+    constructor(pgPoolConfig: PoolConfig, systemDatabaseName: string, logger: Logger);
+    init(): Promise<void>;
+    destroy(): Promise<void>;
+    checkWorkflowOutput<R>(workflowUUID: string): Promise<DBOSNull | R>;
+    initWorkflowStatus<T extends any[]>(workflowUUID: string, name: string, authenticatedUser: string, assumedRole: string, authenticatedRoles: string[], request: HTTPRequest | null, args: T): Promise<T>;
+    bufferWorkflowOutput<R>(workflowUUID: string, output: R): void;
+    /**
+     * Flush the workflow output buffer to the database.
+     */
+    flushWorkflowStatusBuffer(): Promise<string[]>;
+    recordWorkflowError(workflowUUID: string, error: Error): Promise<void>;
+    getPendingWorkflows(executorID: string): Promise<Array<string>>;
+    getWorkflowInputs<T extends any[]>(workflowUUID: string): Promise<T | null>;
+    checkOperationOutput<R>(workflowUUID: string, functionID: number): Promise<DBOSNull | R>;
+    recordOperationOutput<R>(workflowUUID: string, functionID: number, output: R): Promise<void>;
+    recordOperationError(workflowUUID: string, functionID: number, error: Error): Promise<void>;
+    /**
+     *  Guard the operation, throwing an error if a conflicting execution is detected.
+     */
+    recordNotificationOutput<R>(client: PoolClient, workflowUUID: string, functionID: number, output: R): Promise<void>;
+    readonly nullTopic = "__null__topic__";
+    send<T extends NonNullable<any>>(workflowUUID: string, functionID: number, destinationUUID: string, message: T, topic?: string): Promise<void>;
+    recv<T extends NonNullable<any>>(workflowUUID: string, functionID: number, topic?: string, timeoutSeconds?: number): Promise<T | null>;
+    setEvent<T extends NonNullable<any>>(workflowUUID: string, functionID: number, key: string, message: T): Promise<void>;
+    getEvent<T extends NonNullable<any>>(workflowUUID: string, key: string, timeoutSeconds: number, callerUUID?: string, functionID?: number): Promise<T | null>;
+    getWorkflowStatus(workflowUUID: string, callerUUID?: string, functionID?: number): Promise<WorkflowStatus | null>;
+    getWorkflowResult<R>(workflowUUID: string): Promise<R>;
+    /**
+     * A background process that listens for notifications from Postgres then signals the appropriate
+     * workflow listener by resolving its promise.
+     */
+    listenForNotifications(): Promise<void>;
+}
+//# sourceMappingURL=system_database.d.ts.map

package/dist/src/system_database.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"system_database.d.ts","sourceRoot":"","sources":["../../src/system_database.ts"],"names":[],"mappings":"AAGA,OAAO,EAA0B,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAiB,IAAI,EAAE,UAAU,EAAgB,UAAU,EAAU,MAAM,IAAI,CAAC;AAEvF,OAAO,EAAgB,cAAc,EAAE,MAAM,YAAY,CAAC;AAG1D,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,eAAO,MAAM,oBAAoB,qBAAqB,CAAC;AAEvD,MAAM,WAAW,cAAc;IAC7B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACtB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB,mBAAmB,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;IACpE,kBAAkB,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,WAAW,GAAG,IAAI,EAAE,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACxM,oBAAoB,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC;IAC/D,yBAAyB,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACpD,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEvE,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IAChE,iBAAiB,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAE5E,oBAAoB,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC;IACzF,qBAAqB,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7F,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5F,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC;IAClH,iBAAiB,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAEvD,IAAI,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/I,IAAI,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAEvI,QAAQ,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrH,QAAQ,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;CAC9J;AAED,qBAAa,sBAAuB,YAAW,cAAc;IAS/C,QAAQ,CAAC,YAAY,EAAE,UAAU;IAAE,QAAQ,CAAC,kBAAkB,EAAE,MAAM;IAAE,QAAQ,CAAC,MAAM,EAAE,MAAM;IAR3G,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAEpB,mBAAmB,EAAE,UAAU,GAAG,IAAI,CAAQ;IAC9C,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,CAAM;IAC3D,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,CAAM;IAE5D,QAAQ,CAAC,oBAAoB,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAa;gBAEvC,YAAY,EAAE,UAAU,EAAW,kBAAkB,EAAE,MAAM,EAAW,MAAM,EAAE,MAAM;IAMrG,IAAI;IAeJ,OAAO;IAQP,mBAAmB,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IAWnE,kBAAkB,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,WAAW,GAAG,IAAI,EAAE,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAgB7M,oBAAoB,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAIvD;;OAEG;IACG,yBAAyB;IA2BzB,mBAAmB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAStE,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAQ/D,iBAAiB,CAAC,CAAC,SAAS,GAAG,EAAE,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAW3E,oBAAoB,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IAWxF,qBAAqB,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAe5F,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAejG;;OAEG;IACG,wBAAwB,CAAC,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;IAgBzG,QAAQ,CAAC,SAAS,qBAAqB;IAEjC,IAAI,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAoB9I,IAAI,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,cAAc,GAAE,MAAmD,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IA4DlL,QAAQ,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBtH,QAAQ,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAiD5J,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,GAAG,IAAI,CAAC;IA6BjH,iBAAiB,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAkB5D;;;OAGG;IACG,sBAAsB;CAiB7B"}