@dbos-inc/dbos-sdk 0.7.18-preview

package/dist/src/telemetry/exporters.js

@@ -0,0 +1,186 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PostgresExporter = exports.POSTGRES_EXPORTER = exports.JaegerExporter = exports.JAEGER_EXPORTER = void 0;
+const pg_1 = require("pg");
+const lodash_1 = require("lodash");
+const decorators_1 = require("./../decorators");
+const error_1 = require("./../error");
+const exporter_trace_otlp_http_1 = require("@opentelemetry/exporter-trace-otlp-http");
+const core_1 = require("@opentelemetry/core");
+const traces_1 = require("./traces");
+exports.JAEGER_EXPORTER = "JaegerExporter";
+class JaegerExporter {
+    exporter;
+    constructor(endpoint = "http://localhost:4318/v1/traces") {
+        this.exporter = new exporter_trace_otlp_http_1.OTLPTraceExporter({
+            url: endpoint,
+        });
+    }
+    async export(rawSignals) {
+        // Note: it is not compatible with provenance signal.
+        const signals = rawSignals;
+        return await new Promise((resolve) => {
+            const exportSpans = [];
+            signals.forEach((signal) => {
+                if (signal.traceSpan) {
+                    exportSpans.push(signal.traceSpan);
+                }
+            });
+            this.exporter.export(exportSpans, (results) => {
+                if (results.code !== core_1.ExportResultCode.SUCCESS) {
+                    console.warn(`Jaeger export failed`);
+                }
+            });
+            resolve();
+        });
+    }
+}
+exports.JaegerExporter = JaegerExporter;
+exports.POSTGRES_EXPORTER = "PostgresExporter";
+class PostgresExporter {
+    poolConfig;
+    observabilityDBName;
+    pgClient;
+    constructor(poolConfig, observabilityDBName = "dbos_observability") {
+        this.poolConfig = poolConfig;
+        this.observabilityDBName = observabilityDBName;
+        const pgClientConfig = { ...poolConfig };
+        pgClientConfig.database = this.observabilityDBName;
+        this.pgClient = new pg_1.Client(pgClientConfig);
+    }
+    static getPGDataType(t) {
+        if (t.dataType === "double") {
+            return "double precision"; // aka "float8"
+        }
+        return t.formatAsString();
+    }
+    async init(registeredOperations = []) {
+        const pgSystemClient = new pg_1.Client(this.poolConfig);
+        await pgSystemClient.connect();
+        // First check if the log database exists using pgSystemClient.
+        const dbExists = await pgSystemClient.query(`SELECT FROM pg_database WHERE datname = '${this.observabilityDBName}'`);
+        if (dbExists.rows.length === 0) {
+            // Create the logs backend database
+            await pgSystemClient.query(`CREATE DATABASE ${this.observabilityDBName}`);
+        }
+        await pgSystemClient.end();
+        // Connect the exporter client
+        await this.pgClient.connect();
+        // Configure tables for registered workflows
+        for (const registeredOperation of registeredOperations) {
+            const tableName = `signal_${registeredOperation.name}`;
+            let createSignalTableQuery = `CREATE TABLE IF NOT EXISTS ${tableName} (
+        workflow_uuid TEXT NOT NULL,
+        function_name TEXT NOT NULL,
+        run_as TEXT NOT NULL,
+        timestamp BIGINT NOT NULL,
+        transaction_id TEXT DEFAULT NULL,
+        trace_id TEXT DEFAULT NULL,
+        trace_span JSONB DEFAULT NULL,\n`;
+            for (const arg of registeredOperation.args) {
+                if (arg.logMask === decorators_1.LogMasks.SKIP) {
+                    continue;
+                }
+                else if (arg.logMask === decorators_1.LogMasks.HASH) {
+                    const row = `${arg.name} VARCHAR(64) DEFAULT NULL,\n`;
+                    createSignalTableQuery = createSignalTableQuery.concat(row);
+                }
+                else {
+                    const row = `${arg.name} ${PostgresExporter.getPGDataType(arg.dataType)} DEFAULT NULL,\n`;
+                    createSignalTableQuery = createSignalTableQuery.concat(row);
+                }
+            }
+            // Trim last comma and line feed
+            createSignalTableQuery = createSignalTableQuery.slice(0, -2).concat("\n);");
+            await this.pgClient.query(createSignalTableQuery);
+            // Create a table for provenance logs.
+            // TODO: create a secondary index.
+        }
+        await this.pgClient.query(`CREATE TABLE IF NOT EXISTS provenance_logs (
+      transaction_id TEXT NOT NULL,
+      kind TEXT,
+      schema_name TEXT,
+      table_name TEXT,
+      columnnames TEXT,
+      columntypes TEXT,
+      columnvalues TEXT
+    );`);
+    }
+    async destroy() {
+        await this.pgClient.end();
+    }
+    process(signals) {
+        const groupByFunctionName = new Map(Object.entries((0, lodash_1.groupBy)(signals, ({ operationName }) => operationName)));
+        const queries = [];
+        for (const [operationName, signals] of groupByFunctionName) {
+            const tableName = `signal_${operationName}`;
+            const query = `
+        INSERT INTO ${tableName}
+        SELECT * FROM jsonb_to_recordset($1::jsonb) AS tmp (workflow_uuid text, function_name text, run_as text, timestamp bigint, transaction_id text, trace_id text, trace_span json)
+      `;
+            const values = JSON.stringify(signals.map((signal) => {
+                return {
+                    workflow_uuid: signal.workflowUUID,
+                    function_name: signal.operationName,
+                    run_as: signal.runAs,
+                    timestamp: signal.timestamp,
+                    transaction_id: signal.transactionID,
+                    trace_id: signal.traceID,
+                    trace_span: signal.traceSpan ? (0, traces_1.spanToString)(signal.traceSpan) : null,
+                };
+            }));
+            queries.push({
+                name: `insert-${tableName}`,
+                text: query,
+                values: [values],
+            });
+        }
+        return queries;
+    }
+    processProvenance(signals) {
+        const query = `
+      INSERT INTO provenance_logs
+      SELECT * FROM jsonb_to_recordset($1::jsonb) AS tmp (
+        transaction_id text, kind text, schema_name text, table_name text,
+        columnnames text, columntypes text, columnvalues text);
+    `;
+        const values = JSON.stringify(signals.map((signal) => {
+            return {
+                transaction_id: signal.provTransactionID,
+                kind: signal.kind,
+                schema_name: signal.schema,
+                table_name: signal.table,
+                columnnames: signal.columnnames,
+                columntypes: signal.columntypes,
+                columnvalues: signal.columnvalues
+            };
+        }));
+        return { name: `insert-provenance-log`, text: query, values: [values] };
+    }
+    async export(signals) {
+        const results = [];
+        // Find all telemetry signals and process.
+        const telemetrySignals = signals.filter(obj => obj.workflowUUID !== undefined);
+        if (telemetrySignals.length > 0) {
+            const queries = this.process(telemetrySignals);
+            for (const query of queries) {
+                results.push(this.pgClient.query(query));
+            }
+        }
+        // Find all provenance signals and process.
+        const provenanceSignals = signals.filter((obj) => obj.provTransactionID !== undefined);
+        if (provenanceSignals.length > 0) {
+            const provQuery = this.processProvenance(provenanceSignals);
+            results.push(this.pgClient.query(provQuery));
+        }
+        try {
+            // We do await here so we can catch and format PostgresExporter specific errors
+            return await Promise.all(results);
+        }
+        catch (err) {
+            throw new error_1.DBOSPostgresExporterError(err);
+        }
+    }
+}
+exports.PostgresExporter = PostgresExporter;
+//# sourceMappingURL=exporters.js.map

package/dist/src/telemetry/exporters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exporters.js","sourceRoot":"","sources":["../../../src/telemetry/exporters.ts"],"names":[],"mappings":";;;AAAA,2BAAuE;AACvE,mCAAiC;AACjC,gDAAiF;AACjF,sCAAuD;AAEvD,sFAA4E;AAE5E,8CAAqE;AACrE,qCAAwC;AAS3B,QAAA,eAAe,GAAG,gBAAgB,CAAC;AAChD,MAAa,cAAc;IACR,QAAQ,CAAoB;IAC7C,YAAY,WAAmB,iCAAiC;QAC9D,IAAI,CAAC,QAAQ,GAAG,IAAI,4CAAiB,CAAC;YACpC,GAAG,EAAE,QAAQ;SACd,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,UAAwB;QACnC,qDAAqD;QACrD,MAAM,OAAO,GAAG,UAA+B,CAAC;QAChD,OAAO,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACzC,MAAM,WAAW,GAAmB,EAAE,CAAC;YACvC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;gBACzB,IAAI,MAAM,CAAC,SAAS,EAAE;oBACpB,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;iBACpC;YACH,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,OAAqB,EAAE,EAAE;gBAC1D,IAAI,OAAO,CAAC,IAAI,KAAK,uBAAgB,CAAC,OAAO,EAAE;oBAC7C,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;iBACtC;YACH,CAAC,CAAC,CAAC;YACH,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA1BD,wCA0BC;AAEY,QAAA,iBAAiB,GAAG,kBAAkB,CAAC;AACpD,MAAa,gBAAgB;IAGE;IAAiC;IAFrD,QAAQ,CAAS;IAE1B,YAA6B,UAAsB,EAAW,sBAA8B,oBAAoB;QAAnF,eAAU,GAAV,UAAU,CAAY;QAAW,wBAAmB,GAAnB,mBAAmB,CAA+B;QAC9G,MAAM,cAAc,GAAG,EAAE,GAAG,UAAU,EAAE,CAAC;QACzC,cAAc,CAAC,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC;QACnD,IAAI,CAAC,QAAQ,GAAG,IAAI,WAAM,CAAC,cAAc,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,CAAe;QAClC,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ,EAAE;YAC3B,OAAO,kBAAkB,CAAC,CAAC,eAAe;SAC3C;QACD,OAAO,CAAC,CAAC,cAAc,EAAE,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,uBAA8D,EAAE;QACzE,MAAM,cAAc,GAAW,IAAI,WAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3D,MAAM,cAAc,CAAC,OAAO,EAAE,CAAC;QAC/B,+DAA+D;QAC/D,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,KAAK,CAAC,4CAA4C,IAAI,CAAC,mBAAmB,GAAG,CAAC,CAAC;QACrH,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE;YAC9B,mCAAmC;YACnC,MAAM,cAAc,CAAC,KAAK,CAAC,mBAAmB,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;SAC3E;QACD,MAAM,cAAc,CAAC,GAAG,EAAE,CAAC;QAE3B,8BAA8B;QAC9B,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;QAE9B,4CAA4C;QAC5C,KAAK,MAAM,mBAAmB,IAAI,oBAAoB,EAAE;YACtD,MAAM,SAAS,GAAG,UAAU,mBAAmB,CAAC,IAAI,EAAE,CAAC;YACvD,IAAI,sBAAsB,GAAG,8BAA8B,SAAS;;;;;;;yCAOjC,CAAC;YAEpC,KAAK,MAAM,GAAG,IAAI,mBAAmB,CAAC,IAAI,EAAE;gBAC1C,IAAI,GAAG,CAAC,OAAO,KAAK,qBAAQ,CAAC,IAAI,EAAE;oBACjC,SAAS;iBACV;qBAAM,IAAI,GAAG,CAAC,OAAO,KAAK,qBAAQ,CAAC,IAAI,EAAE;oBACxC,MAAM,GAAG,GAAG,GAAG,GAAG,CAAC,IAAI,8BAA8B,CAAC;oBACtD,sBAAsB,GAAG,sBAAsB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;iBAC7D;qBAAM;oBACL,MAAM,GAAG,GAAG,GAAG,GAAG,CAAC,IAAI,IAAI,gBAAgB,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,kBAAkB,CAAC;oBAC1F,sBAAsB,GAAG,sBAAsB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;iBAC7D;aACF;YACD,gCAAgC;YAChC,sBAAsB,GAAG,sBAAsB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAC5E,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;YAElD,sCAAsC;YACtC,kCAAkC;SACnC;QACD,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;;;;;;;;OAQvB,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;IAC5B,CAAC;IAED,OAAO,CAAC,OAA0B;QAChC,MAAM,mBAAmB,GAAmC,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,IAAA,gBAAO,EAAC,OAAO,EAAE,CAAC,EAAE,aAAa,EAAE,EAAE,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QAC5I,MAAM,OAAO,GAAkB,EAAE,CAAC;QAElC,KAAK,MAAM,CAAC,aAAa,EAAE,OAAO,CAAC,IAAI,mBAAmB,EAAE;YAC1D,MAAM,SAAS,GAAW,UAAU,aAAa,EAAE,CAAC;YACpD,MAAM,KAAK,GAAG;sBACE,SAAS;;OAExB,CAAC;YAEF,MAAM,MAAM,GAAW,IAAI,CAAC,SAAS,CACnC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;gBACrB,OAAO;oBACL,aAAa,EAAE,MAAM,CAAC,YAAY;oBAClC,aAAa,EAAE,MAAM,CAAC,aAAa;oBACnC,MAAM,EAAE,MAAM,CAAC,KAAK;oBACpB,SAAS,EAAE,MAAM,CAAC,SAAS;oBAC3B,cAAc,EAAE,MAAM,CAAC,aAAa;oBACpC,QAAQ,EAAE,MAAM,CAAC,OAAO;oBACxB,UAAU,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,qBAAY,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI;iBACrE,CAAC;YACJ,CAAC,CAAC,CACH,CAAC;YAEF,OAAO,CAAC,IAAI,CAAC;gBACX,IAAI,EAAE,UAAU,SAAS,EAAE;gBAC3B,IAAI,EAAE,KAAK;gBACX,MAAM,EAAE,CAAC,MAAM,CAAC;aACjB,CAAC,CAAC;SACJ;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,iBAAiB,CAAC,OAA2B;QAC3C,MAAM,KAAK,GAAG;;;;;KAKb,CAAC;QAEF,MAAM,MAAM,GAAW,IAAI,CAAC,SAAS,CACnC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACrB,OAAO;gBACL,cAAc,EAAE,MAAM,CAAC,iBAAiB;gBACxC,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,WAAW,EAAE,MAAM,CAAC,MAAM;gBAC1B,UAAU,EAAE,MAAM,CAAC,KAAK;gBACxB,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,WAAW,EAAE,MAAM,CAAC,WAAW;gBAC/B,YAAY,EAAE,MAAM,CAAC,YAAY;aAClC,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QACF,OAAO,EAAE,IAAI,EAAE,uBAAuB,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;IAC1E,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,OAAqB;QAChC,MAAM,OAAO,GAAgC,EAAE,CAAC;QAChD,0CAA0C;QAC1C,MAAM,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAE,GAAuB,CAAC,YAAY,KAAK,SAAS,CAAsB,CAAC;QACzH,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE;YAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;YAC/C,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;gBAC3B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;aAC1C;SACF;QAED,2CAA2C;QAC3C,MAAM,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAE,GAAwB,CAAC,iBAAiB,KAAK,SAAS,CAAuB,CAAC;QACnI,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE;YAChC,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;YAC5D,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;SAC9C;QACD,IAAI;YACF,+EAA+E;YAC/E,OAAO,MAAM,OAAO,CAAC,GAAG,CAAmB,OAAO,CAAC,CAAC;SACrD;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,iCAAyB,CAAC,GAAY,CAAC,CAAC;SACnD;IACH,CAAC;CACF;AA7JD,4CA6JC"}

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

@@ -0,0 +1,7 @@
+import { LoggerConfig } from "./logs";
+import { TracerConfig } from "./traces";
+export interface TelemetryConfig {
+    logs?: LoggerConfig;
+    traces?: TracerConfig;
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/telemetry/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAExC,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,YAAY,CAAC;IACpB,MAAM,CAAC,EAAE,YAAY,CAAC;CACvB"}

package/dist/src/telemetry/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/src/telemetry/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/telemetry/index.ts"],"names":[],"mappings":""}

package/dist/src/telemetry/logs.d.ts

@@ -0,0 +1,25 @@
+import { Logger as IWinstonLogger } from "winston";
+import { DBOSContext } from "../context";
+export interface LoggerConfig {
+    logLevel?: string;
+    silent?: boolean;
+    addContextMetadata?: boolean;
+}
+export interface WinstonLogger extends IWinstonLogger {
+    addContextMetadata: boolean;
+}
+export declare class Logger {
+    private readonly globalLogger;
+    private readonly ctx;
+    readonly metadata: object;
+    constructor(globalLogger: WinstonLogger, ctx: DBOSContext);
+    info(message: string): void;
+    debug(message: string): void;
+    warn(message: string): void;
+    emerg(message: string): void;
+    alert(message: string): void;
+    crit(message: string): void;
+    error(inputError: any): void;
+}
+export declare function createGlobalLogger(config?: LoggerConfig): WinstonLogger;
+//# sourceMappingURL=logs.d.ts.map

package/dist/src/telemetry/logs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logs.d.ts","sourceRoot":"","sources":["../../../src/telemetry/logs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoC,MAAM,IAAI,cAAc,EAAE,MAAM,SAAS,CAAC;AAErF,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAGD,MAAM,WAAW,aAAc,SAAQ,cAAc;IACnD,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAKD,qBAAa,MAAM;IAGL,OAAO,CAAC,QAAQ,CAAC,YAAY;IAAiB,OAAO,CAAC,QAAQ,CAAC,GAAG;IAD9E,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAM;gBACF,YAAY,EAAE,aAAa,EAAmB,GAAG,EAAE,WAAW;IAW3F,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI3B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI5B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI3B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI5B,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAI5B,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAM3B,KAAK,CAAC,UAAU,EAAE,GAAG,GAAG,IAAI;CAY7B;AAED,wBAAgB,kBAAkB,CAAC,MAAM,CAAC,EAAE,YAAY,GAAG,aAAa,CAYvE"}

package/dist/src/telemetry/logs.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createGlobalLogger = exports.Logger = void 0;
+const winston_1 = require("winston");
+const applicationVersion_1 = require("../dbos-runtime/applicationVersion");
+/* This is a wrapper around a global Winston logger. It holds a reference to the global logger.
+ * This class is expected to be instantiated by new DBOSContext such that they can share context information.
+ **/
+class Logger {
+    globalLogger;
+    ctx;
+    // Eventually this object will implement one of our TelemetrySignal interface
+    metadata = {};
+    constructor(globalLogger, ctx) {
+        this.globalLogger = globalLogger;
+        this.ctx = ctx;
+        if (this.globalLogger.addContextMetadata) {
+            this.metadata = {
+                workflowUUID: this.ctx.workflowUUID,
+                authenticatedUser: this.ctx.authenticatedUser,
+                traceId: this.ctx.span.spanContext().traceId,
+                spanId: this.ctx.span.spanContext().spanId,
+            };
+        }
+    }
+    info(message) {
+        this.globalLogger.info(message, this.metadata);
+    }
+    debug(message) {
+        this.globalLogger.debug(message, this.metadata);
+    }
+    warn(message) {
+        this.globalLogger.warn(message, this.metadata);
+    }
+    emerg(message) {
+        this.globalLogger.emerg(message, this.metadata);
+    }
+    alert(message) {
+        this.globalLogger.alert(message, this.metadata);
+    }
+    crit(message) {
+        this.globalLogger.crit(message, this.metadata);
+    }
+    // We give users the same interface (message: string argument) but create an error to get a stack trace
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    error(inputError) {
+        if (inputError instanceof Error) {
+            this.globalLogger.error(inputError.message, { ...this.metadata, stack: inputError.stack, cause: inputError.cause });
+        }
+        else if (typeof inputError === "string") {
+            const e = new Error();
+            this.globalLogger.error(inputError, { ...this.metadata, stack: e.stack });
+        }
+        else {
+            // If this is neither a string nor an error, we just log it as is an ommit the context
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
+            this.globalLogger.error(inputError.toString());
+        }
+    }
+}
+exports.Logger = Logger;
+function createGlobalLogger(config) {
+    const logger = (0, winston_1.createLogger)({
+        format: consoleFormat,
+        transports: [
+            new winston_1.transports.Console({
+                level: config?.logLevel || "info",
+            }),
+        ],
+        silent: config?.silent || false,
+    });
+    logger.addContextMetadata = config?.addContextMetadata || false;
+    return logger;
+}
+exports.createGlobalLogger = createGlobalLogger;
+const consoleFormat = winston_1.format.combine(winston_1.format.errors({ stack: true }), winston_1.format.timestamp(), winston_1.format.colorize(), 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+winston_1.format.printf((info) => {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    const { timestamp, level, message, stack, ...args } = info;
+    const applicationVersion = (0, applicationVersion_1.getApplicationVersion)();
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-assignment
+    const ts = timestamp.slice(0, 19).replace("T", " ");
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-assignment
+    const formattedStack = stack?.split("\n").slice(1).join("\n");
+    const messageString = typeof message === "string" ? message : JSON.stringify(message);
+    const versionString = applicationVersion ? ` [version ${applicationVersion}]` : "";
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+    return `${ts}${versionString} [${level}]: ${messageString} ${Object.keys(args).length ? "\n" + JSON.stringify(args, null, 2) : ""} ${stack ? "\n" + formattedStack : ""}`;
+}));
+//# sourceMappingURL=logs.js.map

package/dist/src/telemetry/logs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logs.js","sourceRoot":"","sources":["../../../src/telemetry/logs.ts"],"names":[],"mappings":";;;AAAA,qCAAqF;AACrF,2EAA2E;AAc3E;;IAEI;AACJ,MAAa,MAAM;IAGY;IAA8C;IAF3E,6EAA6E;IACpE,QAAQ,GAAW,EAAE,CAAC;IAC/B,YAA6B,YAA2B,EAAmB,GAAgB;QAA9D,iBAAY,GAAZ,YAAY,CAAe;QAAmB,QAAG,GAAH,GAAG,CAAa;QACzF,IAAI,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE;YACxC,IAAI,CAAC,QAAQ,GAAG;gBACd,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,YAAY;gBACnC,iBAAiB,EAAE,IAAI,CAAC,GAAG,CAAC,iBAAiB;gBAC7C,OAAO,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO;gBAC5C,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM;aAC3C,CAAC;SACH;IACH,CAAC;IAED,IAAI,CAAC,OAAe;QAClB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED,KAAK,CAAC,OAAe;QACnB,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,OAAe;QAClB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED,KAAK,CAAC,OAAe;QACnB,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,OAAe;QACnB,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,CAAC,OAAe;QAClB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;IAED,uGAAuG;IACvG,8DAA8D;IAC9D,KAAK,CAAC,UAAe;QACnB,IAAI,UAAU,YAAY,KAAK,EAAE;YAC/B,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,CAAC,CAAC;SACrH;aAAM,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YACzC,MAAM,CAAC,GAAG,IAAI,KAAK,EAAE,CAAC;YACtB,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;SAC3E;aAAM;YACL,sFAAsF;YACtF,yGAAyG;YACzG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC;SAChD;IACH,CAAC;CACF;AApDD,wBAoDC;AAED,SAAgB,kBAAkB,CAAC,MAAqB;IACtD,MAAM,MAAM,GAAkB,IAAA,sBAAY,EAAC;QACzC,MAAM,EAAE,aAAa;QACrB,UAAU,EAAE;YACV,IAAI,oBAAU,CAAC,OAAO,CAAC;gBACrB,KAAK,EAAE,MAAM,EAAE,QAAQ,IAAI,MAAM;aAClC,CAAC;SACH;QACD,MAAM,EAAE,MAAM,EAAE,MAAM,IAAI,KAAK;KAChC,CAAkB,CAAC;IACpB,MAAM,CAAC,kBAAkB,GAAG,MAAM,EAAE,kBAAkB,IAAI,KAAK,CAAC;IAChE,OAAO,MAAM,CAAC;AAChB,CAAC;AAZD,gDAYC;AAED,MAAM,aAAa,GAAG,gBAAM,CAAC,OAAO,CAClC,gBAAM,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,EAC9B,gBAAM,CAAC,SAAS,EAAE,EAClB,gBAAM,CAAC,QAAQ,EAAE;AACjB,8DAA8D;AAC9D,gBAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;IACrB,mEAAmE;IACnE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC;IAC3D,MAAM,kBAAkB,GAAG,IAAA,0CAAqB,GAAE,CAAC;IACnD,kJAAkJ;IAClJ,MAAM,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IACpD,kJAAkJ;IAClJ,MAAM,cAAc,GAAG,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9D,MAAM,aAAa,GAAW,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAC9F,MAAM,aAAa,GAAG,kBAAkB,CAAC,CAAC,CAAC,aAAa,kBAAkB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACnF,iEAAiE;IACjE,OAAO,GAAG,EAAE,GAAG,aAAa,KAAK,KAAK,MAAM,aAAa,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,CAAC,CAAC,CAAC,IAAI,GAAG,cAAc,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AAC5K,CAAC,CAAC,CACH,CAAC"}

package/dist/src/telemetry/signals.d.ts

@@ -0,0 +1,30 @@
+import { ReadableSpan } from "@opentelemetry/sdk-trace-base";
+import { ValuesOf } from "../utils";
+export type DBOSSignal = TelemetrySignal | ProvenanceSignal;
+export declare const LogSeverity: {
+    readonly Debug: "DEBUG";
+    readonly Info: "INFO";
+    readonly Warn: "WARN";
+    readonly Error: "ERROR";
+    readonly Log: "LOG";
+};
+export type LogSeverity = ValuesOf<typeof LogSeverity>;
+export interface TelemetrySignal {
+    workflowUUID: string;
+    operationName: string;
+    runAs: string;
+    timestamp: number;
+    transactionID?: string;
+    traceID?: string;
+    traceSpan?: ReadableSpan;
+}
+export interface ProvenanceSignal {
+    provTransactionID: string;
+    kind: string;
+    schema: string;
+    table: string;
+    columnnames: string[];
+    columntypes: string[];
+    columnvalues: string[];
+}
+//# sourceMappingURL=signals.d.ts.map

package/dist/src/telemetry/signals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signals.d.ts","sourceRoot":"","sources":["../../../src/telemetry/signals.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC,MAAM,MAAM,UAAU,GAAG,eAAe,GAAG,gBAAgB,CAAC;AAE5D,eAAO,MAAM,WAAW;;;;;;CAMd,CAAC;AACX,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,WAAW,CAAC,CAAC;AAEvD,MAAM,WAAW,eAAe;IAC9B,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,YAAY,CAAC;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB"}

package/dist/src/telemetry/signals.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogSeverity = void 0;
+exports.LogSeverity = {
+    Debug: "DEBUG",
+    Info: "INFO",
+    Warn: "WARN",
+    Error: "ERROR",
+    Log: "LOG",
+};
+//# sourceMappingURL=signals.js.map

package/dist/src/telemetry/signals.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signals.js","sourceRoot":"","sources":["../../../src/telemetry/signals.ts"],"names":[],"mappings":";;;AAKa,QAAA,WAAW,GAAG;IACzB,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,KAAK;CACF,CAAC"}

package/dist/src/telemetry/traces.d.ts

@@ -0,0 +1,17 @@
+import { ReadableSpan, Span } from "@opentelemetry/sdk-trace-base";
+import { Attributes, SpanContext } from "@opentelemetry/api";
+import { TelemetryCollector } from "./collector";
+export interface TracerConfig {
+    enabled?: boolean;
+    endpoint?: string;
+}
+export declare function spanToString(span: ReadableSpan): string;
+export declare class Tracer {
+    private readonly telemetryCollector;
+    private readonly tracer;
+    constructor(telemetryCollector: TelemetryCollector);
+    startSpanWithContext(spanContext: SpanContext, name: string, attributes?: Attributes): Span;
+    startSpan(name: string, attributes?: Attributes, parentSpan?: Span): Span;
+    endSpan(span: Span): void;
+}
+//# sourceMappingURL=traces.d.ts.map

package/dist/src/telemetry/traces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"traces.d.ts","sourceRoot":"","sources":["../../../src/telemetry/traces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,YAAY,EAAE,IAAI,EAAE,MAAM,+BAA+B,CAAC;AAExF,OAAsB,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAG5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAGjD,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,CAevD;AAED,qBAAa,MAAM;IAEL,OAAO,CAAC,QAAQ,CAAC,kBAAkB;IAD/C,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAsB;gBAChB,kBAAkB,EAAE,kBAAkB;IASnE,oBAAoB,CAAC,WAAW,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,IAAI;IAM3F,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI;IAUzE,OAAO,CAAC,IAAI,EAAE,IAAI;CAoBnB"}

package/dist/src/telemetry/traces.js

@@ -0,0 +1,76 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tracer = exports.spanToString = void 0;
+const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
+const resources_1 = require("@opentelemetry/resources");
+const api_1 = __importDefault(require("@opentelemetry/api"));
+const core_1 = require("@opentelemetry/core");
+const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
+function spanToString(span) {
+    return JSON.stringify({
+        name: span.name,
+        kind: span.kind,
+        traceId: span.spanContext().traceId,
+        spanId: span.spanContext().spanId,
+        traceFlags: span.spanContext().traceFlags,
+        traceState: span.spanContext().traceState?.serialize(),
+        parentSpanId: span.parentSpanId,
+        start: (0, core_1.hrTimeToMicroseconds)(span.startTime),
+        duration: (0, core_1.hrTimeToMicroseconds)(span.duration),
+        attributes: span.attributes,
+        status: span.status,
+        events: span.events,
+    });
+}
+exports.spanToString = spanToString;
+class Tracer {
+    telemetryCollector;
+    tracer;
+    constructor(telemetryCollector) {
+        this.telemetryCollector = telemetryCollector;
+        this.tracer = new sdk_trace_base_1.BasicTracerProvider({
+            resource: new resources_1.Resource({
+                [semantic_conventions_1.SemanticResourceAttributes.SERVICE_NAME]: "dbos",
+            }),
+        });
+        this.tracer.register();
+    }
+    startSpanWithContext(spanContext, name, attributes) {
+        const tracer = api_1.default.trace.getTracer("dbos-tracer");
+        const ctx = api_1.default.trace.setSpanContext(api_1.default.context.active(), spanContext);
+        return tracer.startSpan(name, { startTime: Date.now(), attributes: attributes }, ctx);
+    }
+    startSpan(name, attributes, parentSpan) {
+        const tracer = api_1.default.trace.getTracer("dbos-tracer");
+        if (parentSpan) {
+            const ctx = api_1.default.trace.setSpan(api_1.default.context.active(), parentSpan);
+            return tracer.startSpan(name, { startTime: Date.now(), attributes: attributes }, ctx);
+        }
+        else {
+            return tracer.startSpan(name, { attributes: attributes });
+        }
+    }
+    endSpan(span) {
+        span.end(Date.now());
+        const workflowUUID = span.attributes.workflowUUID;
+        const operationName = span.attributes.operationName;
+        const runAs = span.attributes.runAs;
+        const transactionID = span.attributes.transaction_id;
+        const traceID = span.spanContext().traceId;
+        const signal = {
+            workflowUUID,
+            operationName,
+            runAs,
+            timestamp: Date.now(),
+            traceID,
+            transactionID: transactionID,
+            traceSpan: span,
+        };
+        this.telemetryCollector.push(signal);
+    }
+}
+exports.Tracer = Tracer;
+//# sourceMappingURL=traces.js.map

package/dist/src/telemetry/traces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"traces.js","sourceRoot":"","sources":["../../../src/telemetry/traces.ts"],"names":[],"mappings":";;;;;;AAAA,kEAAwF;AACxF,wDAAoD;AACpD,6DAA4E;AAC5E,8CAA2D;AAC3D,8EAAiF;AASjF,SAAgB,YAAY,CAAC,IAAkB;IAC7C,OAAO,IAAI,CAAC,SAAS,CAAC;QACpB,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,OAAO,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO;QACnC,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM;QACjC,UAAU,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU;QACzC,UAAU,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE;QACtD,YAAY,EAAE,IAAI,CAAC,YAAY;QAC/B,KAAK,EAAE,IAAA,2BAAoB,EAAC,IAAI,CAAC,SAAS,CAAC;QAC3C,QAAQ,EAAE,IAAA,2BAAoB,EAAC,IAAI,CAAC,QAAQ,CAAC;QAC7C,UAAU,EAAE,IAAI,CAAC,UAAU;QAC3B,MAAM,EAAE,IAAI,CAAC,MAAM;QACnB,MAAM,EAAE,IAAI,CAAC,MAAM;KACpB,CAAC,CAAC;AACL,CAAC;AAfD,oCAeC;AAED,MAAa,MAAM;IAEY;IADZ,MAAM,CAAsB;IAC7C,YAA6B,kBAAsC;QAAtC,uBAAkB,GAAlB,kBAAkB,CAAoB;QACjE,IAAI,CAAC,MAAM,GAAG,IAAI,oCAAmB,CAAC;YACpC,QAAQ,EAAE,IAAI,oBAAQ,CAAC;gBACrB,CAAC,iDAA0B,CAAC,YAAY,CAAC,EAAE,MAAM;aAClD,CAAC;SACH,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;IACzB,CAAC;IAED,oBAAoB,CAAC,WAAwB,EAAE,IAAY,EAAE,UAAuB;QAClF,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAC5D,MAAM,GAAG,GAAG,aAAa,CAAC,KAAK,CAAC,cAAc,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,WAAW,CAAC,CAAC;QAC5F,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,GAAG,CAAS,CAAC;IAChG,CAAC;IAED,SAAS,CAAC,IAAY,EAAE,UAAuB,EAAE,UAAiB;QAChE,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAC5D,IAAI,UAAU,EAAE;YACd,MAAM,GAAG,GAAG,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,UAAU,CAAC,CAAC;YACpF,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,GAAG,CAAS,CAAC;SAC/F;aAAM;YACL,OAAO,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,CAAS,CAAC;SACnE;IACH,CAAC;IAED,OAAO,CAAC,IAAU;QAChB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QACrB,MAAM,YAAY,GAAG,IAAI,CAAC,UAAU,CAAC,YAAsB,CAAC;QAC5D,MAAM,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,aAAuB,CAAC;QAC9D,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,KAAe,CAAC;QAC9C,MAAM,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,cAAwB,CAAC;QAC/D,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC;QAE3C,MAAM,MAAM,GAAoB;YAC9B,YAAY;YACZ,aAAa;YACb,KAAK;YACL,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;YACrB,OAAO;YACP,aAAa,EAAE,aAAa;YAC5B,SAAS,EAAE,IAAoB;SAChC,CAAC;QAEF,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;CACF;AA/CD,wBA+CC"}

package/dist/src/testing/testing_runtime.d.ts

@@ -0,0 +1,76 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { IncomingMessage } from "http";
+import { HTTPRequest } from "../context";
+import { InvokeFuncs } from "../httpServer/handler";
+import { DBOSExecutor, DBOSConfig } from "../dbos-executor";
+import { WorkflowHandle } from "../workflow";
+import { Http2ServerRequest, Http2ServerResponse } from "http2";
+import { ServerResponse } from "http";
+import { SystemDatabase } from "../system_database";
+/**
+ * Create a testing runtime. Warn: this function will drop the existing system DB and create a clean new one. Don't run tests against your production database!
+ */
+export declare function createTestingRuntime(userClasses: object[], configFilePath?: string): Promise<TestingRuntime>;
+export interface WorkflowInvokeParams {
+    readonly authenticatedUser?: string;
+    readonly authenticatedRoles?: string[];
+    readonly request?: HTTPRequest;
+}
+export interface TestingRuntime {
+    invoke<T extends object>(targetClass: T, workflowUUID?: string, params?: WorkflowInvokeParams): InvokeFuncs<T>;
+    retrieveWorkflow<R>(workflowUUID: string): WorkflowHandle<R>;
+    send<T extends NonNullable<any>>(destinationUUID: string, message: T, topic?: string, idempotencyKey?: string): Promise<void>;
+    getEvent<T extends NonNullable<any>>(workflowUUID: string, key: string, timeoutSeconds?: number): Promise<T | null>;
+    getHandlersCallback(): (req: IncomingMessage | Http2ServerRequest, res: ServerResponse | Http2ServerResponse) => Promise<void>;
+    getConfig<T>(key: string): T | undefined;
+    getConfig<T>(key: string, defaultValue: T): T;
+    queryUserDB<R>(sql: string, ...params: any[]): Promise<R[]>;
+    createUserSchema(): Promise<void>;
+    dropUserSchema(): Promise<void>;
+    destroy(): Promise<void>;
+}
+/**
+ * For internal unit tests which allows us to provide different system DB and control its behavior.
+ */
+export declare function createInternalTestRuntime(userClasses: object[], testConfig: DBOSConfig, systemDB?: SystemDatabase): Promise<TestingRuntime>;
+/**
+ * This class provides a runtime to test Opeorn functions in unit tests.
+ */
+export declare class TestingRuntimeImpl implements TestingRuntime {
+    #private;
+    /**
+     * Initialize the testing runtime by loading user functions specified in classes and using the specified config.
+     * This should be the first function call before any subsequent calls.
+     */
+    init(userClasses: object[], testConfig?: DBOSConfig, systemDB?: SystemDatabase): Promise<void>;
+    /**
+     * Release resources after tests.
+     */
+    destroy(): Promise<void>;
+    /**
+     * Get Application Configuration.
+    */
+    getConfig<T>(key: string): T | undefined;
+    getConfig<T>(key: string, defaultValue: T): T;
+    /**
+     * Generate a proxy object for the provided class that wraps direct calls (i.e. OpClass.someMethod(param))
+     * to invoke workflows, transactions, and communicators;
+     */
+    invoke<T extends object>(object: T, workflowUUID?: string, params?: WorkflowInvokeParams): InvokeFuncs<T>;
+    /**
+     * Return a request handler callback for node's native http/http2 server, which includes all registered HTTP endpoints.
+     */
+    getHandlersCallback(): (req: IncomingMessage | Http2ServerRequest, res: Http2ServerResponse | ServerResponse<IncomingMessage>) => Promise<void>;
+    send<T extends NonNullable<any>>(destinationUUID: string, message: T, topic?: string, idempotencyKey?: string): Promise<void>;
+    getEvent<T extends NonNullable<any>>(workflowUUID: string, key: string, timeoutSeconds?: number): Promise<T | null>;
+    retrieveWorkflow<R>(workflowUUID: string): WorkflowHandle<R>;
+    queryUserDB<R>(sql: string, ...params: any[]): Promise<R[]>;
+    createUserSchema(): Promise<void>;
+    dropUserSchema(): Promise<void>;
+    /**
+     * For internal tests use only -- return the workflow executor object.
+     */
+    getDBOSExec(): DBOSExecutor;
+}
+//# sourceMappingURL=testing_runtime.d.ts.map

package/dist/src/testing/testing_runtime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"testing_runtime.d.ts","sourceRoot":"","sources":["../../../src/testing/testing_runtime.ts"],"names":[],"mappings":";;AACA,OAAO,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AAEvC,OAAO,EAAE,WAAW,EAAmB,MAAM,YAAY,CAAC;AAG1D,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG5D,OAAO,EAAY,cAAc,EAAkB,MAAM,aAAa,CAAC;AACvE,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAC;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AACtC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAIpD;;GAEG;AACH,wBAAsB,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,cAAc,GAAE,MAA2B,GAAG,OAAO,CAAC,cAAc,CAAC,CAiBtI;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACpC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IACvC,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC;CAChC;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,CAAC,CAAC,SAAS,MAAM,EAAE,WAAW,EAAE,CAAC,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,oBAAoB,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;IAC/G,gBAAgB,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;IAC7D,IAAI,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9H,QAAQ,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAEpH,mBAAmB,IAAI,CAAC,GAAG,EAAE,eAAe,GAAG,kBAAkB,EAAE,GAAG,EAAE,cAAc,GAAG,mBAAmB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/H,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS,CAAC;IACzC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC,CAAC;IAG9C,WAAW,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IAC5D,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAClC,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1B;AAED;;GAEG;AACH,wBAAsB,yBAAyB,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAIjJ;AAED;;GAEG;AACH,qBAAa,kBAAmB,YAAW,cAAc;;IAIvD;;;OAGG;IACG,IAAI,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,UAAU,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,EAAE,cAAc;IAQpF;;OAEG;IACG,OAAO;IAIb;;MAEE;IACF,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,SAAS;IACxC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,GAAG,CAAC;IAiB7C;;;OAGG;IACH,MAAM,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,oBAAoB,GAAG,WAAW,CAAC,CAAC,CAAC;IA8BzG;;OAEG;IACH,mBAAmB;IAOb,IAAI,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,eAAe,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7H,QAAQ,CAAC,CAAC,SAAS,WAAW,CAAC,GAAG,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,cAAc,GAAE,MAAmD,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAIrK,gBAAgB,CAAC,CAAC,EAAE,YAAY,EAAE,MAAM,GAAG,cAAc,CAAC,CAAC,CAAC;IAItD,WAAW,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;IAK3D,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAIvC,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B;;OAEG;IACH,WAAW,IAAI,YAAY;CAM5B"}