@dbos-inc/typeorm-datasource 3.0.11-preview.gc9233b8190 → 3.0.16-preview

package/dist/index.d.ts

@@ -0,0 +1,37 @@
+import { PoolConfig } from 'pg';
+import { DBOSDataSource, PGTransactionConfig } from '@dbos-inc/dbos-sdk/datasource';
+import { EntityManager } from 'typeorm';
+export interface TypeORMTransactionConfig extends PGTransactionConfig {
+    name?: string;
+}
+export declare class TypeOrmDataSource implements DBOSDataSource<TypeORMTransactionConfig> {
+    #private;
+    readonly name: string;
+    static get entityManager(): EntityManager;
+    get entityManager(): EntityManager;
+    static initializeDBOSSchema(config: PoolConfig): Promise<void>;
+    constructor(name: string, config: PoolConfig, entities: Function[]);
+    /**
+     * Run `func` as a transaction against this DataSource
+     * @param func Function to run within a transactional context
+     * @param funcName Name to record for the transaction
+     * @param config Transaction configuration (isolation, etc)
+     * @returns Return value from `func`
+     */
+    runTransaction<T>(func: () => Promise<T>, config?: TypeORMTransactionConfig): Promise<T>;
+    /**
+     * Register function as DBOS transaction, to be called within the context
+     *  of a transaction on this data source.
+     *
+     * @param func Function to wrap
+     * @param target Name of function
+     * @param config Transaction settings
+     * @returns Wrapped function, to be called instead of `func`
+     */
+    registerTransaction<This, Args extends unknown[], Return>(func: (this: This, ...args: Args) => Promise<Return>, config?: TypeORMTransactionConfig): (this: This, ...args: Args) => Promise<Return>;
+    /**
+     * Decorator establishing function as a transaction
+     */
+    transaction(config?: TypeORMTransactionConfig): <This, Args extends unknown[], Return>(_target: object, propertyKey: PropertyKey, descriptor: TypedPropertyDescriptor<(this: This, ...args: Args) => Promise<Return>>) => TypedPropertyDescriptor<(this: This, ...args: Args) => Promise<Return>>;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,IAAI,CAAC;AAEhC,OAAO,EAQL,cAAc,EAEd,mBAAmB,EACpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAc,aAAa,EAAE,MAAM,SAAS,CAAC;AAIpD,MAAM,WAAW,wBAAyB,SAAQ,mBAAmB;IACnE,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AA8MD,qBAAa,iBAAkB,YAAW,cAAc,CAAC,wBAAwB,CAAC;;IAsC9E,QAAQ,CAAC,IAAI,EAAE,MAAM;IArBvB,MAAM,KAAK,aAAa,kBAEvB;IAED,IAAI,aAAa,kBAEhB;WAEY,oBAAoB,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;gBAazD,IAAI,EAAE,MAAM,EACrB,MAAM,EAAE,UAAU,EAElB,QAAQ,EAAE,QAAQ,EAAE;IAMtB;;;;;;OAMG;IACG,cAAc,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,wBAAwB;IAIjF;;;;;;;;OAQG;IACH,mBAAmB,CAAC,IAAI,EAAE,IAAI,SAAS,OAAO,EAAE,EAAE,MAAM,EACtD,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC,EACpD,MAAM,CAAC,EAAE,wBAAwB,GAChC,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,MAAM,CAAC;IAIjD;;OAEG;IACH,WAAW,CAAC,MAAM,CAAC,EAAE,wBAAwB,mDAIhC,MAAM,eACF,WAAW,cACZ,wBAAwB,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,IAAI,KAAK,QAAQ,MAAM,CAAC,CAAC,oCAAxC,IAAI,WAAW,IAAI,KAAK,QAAQ,MAAM,CAAC;CAcvF"}

package/dist/index.js

@@ -0,0 +1,238 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypeOrmDataSource = void 0;
+const dbos_sdk_1 = require("@dbos-inc/dbos-sdk");
+const datasource_1 = require("@dbos-inc/dbos-sdk/datasource");
+const typeorm_1 = require("typeorm");
+const async_hooks_1 = require("async_hooks");
+const superjson_1 = require("superjson");
+const asyncLocalCtx = new async_hooks_1.AsyncLocalStorage();
+class TypeOrmTransactionHandler {
+    name;
+    config;
+    entities;
+    dsType = 'TypeOrm';
+    #dataSourceField;
+    constructor(name, config, 
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+    entities) {
+        this.name = name;
+        this.config = config;
+        this.entities = entities;
+    }
+    static async createInstance(config, 
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+    entities) {
+        const ds = new typeorm_1.DataSource({
+            type: 'postgres',
+            entities: entities,
+            url: config.connectionString,
+            host: config.host,
+            port: config.port,
+            username: config.user,
+            // password: config.password,
+            database: config.database,
+            // ssl: config.ssl,
+            connectTimeoutMS: config.connectionTimeoutMillis,
+            poolSize: config.max,
+        });
+        await ds.initialize();
+        return ds;
+    }
+    async initialize() {
+        const ds = this.#dataSourceField;
+        this.#dataSourceField = await TypeOrmTransactionHandler.createInstance(this.config, this.entities);
+        await ds?.destroy();
+    }
+    async destroy() {
+        const ds = this.#dataSourceField;
+        this.#dataSourceField = undefined;
+        await ds?.destroy();
+    }
+    get #dataSource() {
+        if (!this.#dataSourceField) {
+            throw new Error(`DataSource ${this.name} is not initialized.`);
+        }
+        return this.#dataSourceField;
+    }
+    async #checkExecution(workflowID, stepID) {
+        const rows = await this.#dataSource.query(`SELECT output, error FROM dbos.transaction_completion
+       WHERE workflow_id=$1 AND function_num=$2;`, [workflowID, stepID]);
+        if (rows.length !== 1) {
+            return undefined;
+        }
+        if (rows[0].output === null) {
+            return undefined;
+        }
+        const { output, error } = rows[0];
+        return error !== null ? { error } : { output };
+    }
+    static async #recordOutput(entityManager, workflowID, stepID, output) {
+        try {
+            await entityManager.query(`INSERT INTO dbos.transaction_completion (workflow_id, function_num, output)
+         VALUES ($1, $2, $3)`, [workflowID, stepID, output]);
+        }
+        catch (error) {
+            if ((0, datasource_1.isPGKeyConflictError)(error)) {
+                throw new dbos_sdk_1.DBOSWorkflowConflictError(workflowID);
+            }
+            else {
+                throw error;
+            }
+        }
+    }
+    async #recordError(workflowID, stepID, error) {
+        try {
+            await this.#dataSource.query(`INSERT INTO dbos.transaction_completion (workflow_id, function_num, error)
+         VALUES ($1, $2, $3)`, [workflowID, stepID, error]);
+        }
+        catch (error) {
+            if ((0, datasource_1.isPGKeyConflictError)(error)) {
+                throw new dbos_sdk_1.DBOSWorkflowConflictError(workflowID);
+            }
+            else {
+                throw error;
+            }
+        }
+    }
+    /* Required by base class */
+    async invokeTransactionFunction(config, target, func, ...args) {
+        const workflowID = dbos_sdk_1.DBOS.workflowID;
+        const stepID = dbos_sdk_1.DBOS.stepID;
+        if (workflowID !== undefined && stepID === undefined) {
+            throw new Error('DBOS.stepID is undefined inside a workflow.');
+        }
+        const isolationLevel = config?.isolationLevel ?? 'READ COMMITTED';
+        const readOnly = config?.readOnly ? true : false;
+        const saveResults = !readOnly && workflowID !== undefined;
+        // Retry loop if appropriate
+        let retryWaitMS = 1;
+        const backoffFactor = 1.5;
+        const maxRetryWaitMS = 2000; // Maximum wait 2 seconds.
+        while (true) {
+            // Check to see if this tx has already been executed
+            const previousResult = saveResults ? await this.#checkExecution(workflowID, stepID) : undefined;
+            if (previousResult) {
+                dbos_sdk_1.DBOS.span?.setAttribute('cached', true);
+                if ('error' in previousResult) {
+                    throw superjson_1.SuperJSON.parse(previousResult.error);
+                }
+                return (previousResult.output ? superjson_1.SuperJSON.parse(previousResult.output) : null);
+            }
+            try {
+                const result = await this.#dataSource.transaction(isolationLevel, async (entityManager) => {
+                    if (readOnly) {
+                        await entityManager.query('SET TRANSACTION READ ONLY');
+                    }
+                    const result = await asyncLocalCtx.run({ entityManager, owner: this }, async () => {
+                        return await func.call(target, ...args);
+                    });
+                    // save the output of read/write transactions
+                    if (saveResults) {
+                        await TypeOrmTransactionHandler.#recordOutput(entityManager, workflowID, stepID, superjson_1.SuperJSON.stringify(result));
+                    }
+                    return result;
+                });
+                return result;
+            }
+            catch (error) {
+                if ((0, datasource_1.isPGRetriableTransactionError)(error)) {
+                    dbos_sdk_1.DBOS.span?.addEvent('TXN SERIALIZATION FAILURE', { retryWaitMillis: retryWaitMS }, performance.now());
+                    // Retry serialization failures.
+                    await new Promise((resolve) => setTimeout(resolve, retryWaitMS));
+                    retryWaitMS = Math.min(retryWaitMS * backoffFactor, maxRetryWaitMS);
+                    continue;
+                }
+                else {
+                    if (saveResults) {
+                        const message = superjson_1.SuperJSON.stringify(error);
+                        await this.#recordError(workflowID, stepID, message);
+                    }
+                    throw error;
+                }
+            }
+        }
+    }
+}
+class TypeOrmDataSource {
+    name;
+    // User calls this... DBOS not directly involved...
+    static #getEntityManager(p) {
+        if (!dbos_sdk_1.DBOS.isInTransaction()) {
+            throw new Error('Invalid use of TypeOrmDataSource.entityManager outside of a DBOS transaction');
+        }
+        const ctx = asyncLocalCtx.getStore();
+        if (!ctx) {
+            throw new Error('Invalid use of TypeOrmDataSource.entityManager outside of a DBOS transaction');
+        }
+        if (p && p !== ctx.owner) {
+            throw new Error('Invalid retrieval of `TypeOrmDataSource.entityManager` from the wrong instance');
+        }
+        return ctx.entityManager;
+    }
+    static get entityManager() {
+        return TypeOrmDataSource.#getEntityManager(undefined);
+    }
+    get entityManager() {
+        return TypeOrmDataSource.#getEntityManager(this.#provider);
+    }
+    static async initializeDBOSSchema(config) {
+        const ds = await TypeOrmTransactionHandler.createInstance(config, []);
+        try {
+            await ds.query(datasource_1.createTransactionCompletionSchemaPG);
+            await ds.query(datasource_1.createTransactionCompletionTablePG);
+        }
+        finally {
+            await ds.destroy();
+        }
+    }
+    #provider;
+    constructor(name, config, 
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+    entities) {
+        this.name = name;
+        this.#provider = new TypeOrmTransactionHandler(name, config, entities);
+        (0, datasource_1.registerDataSource)(this.#provider);
+    }
+    /**
+     * Run `func` as a transaction against this DataSource
+     * @param func Function to run within a transactional context
+     * @param funcName Name to record for the transaction
+     * @param config Transaction configuration (isolation, etc)
+     * @returns Return value from `func`
+     */
+    async runTransaction(func, config) {
+        return await (0, datasource_1.runTransaction)(func, config?.name ?? func.name, { dsName: this.name, config });
+    }
+    /**
+     * Register function as DBOS transaction, to be called within the context
+     *  of a transaction on this data source.
+     *
+     * @param func Function to wrap
+     * @param target Name of function
+     * @param config Transaction settings
+     * @returns Wrapped function, to be called instead of `func`
+     */
+    registerTransaction(func, config) {
+        return (0, datasource_1.registerTransaction)(this.name, func, { name: config?.name ?? func.name }, config);
+    }
+    /**
+     * Decorator establishing function as a transaction
+     */
+    transaction(config) {
+        // eslint-disable-next-line @typescript-eslint/no-this-alias
+        const ds = this;
+        return function decorator(_target, propertyKey, descriptor) {
+            if (!descriptor.value) {
+                throw new Error('Use of decorator when original method is undefined');
+            }
+            descriptor.value = ds.registerTransaction(descriptor.value, {
+                ...config,
+                name: config?.name ?? String(propertyKey),
+            });
+            return descriptor;
+        };
+    }
+}
+exports.TypeOrmDataSource = TypeOrmDataSource;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;AACA,iDAAqE;AACrE,8DAWuC;AACvC,qCAAoD;AACpD,6CAAgD;AAChD,yCAAsC;AAWtC,MAAM,aAAa,GAAG,IAAI,+BAAiB,EAAuB,CAAC;AASnE,MAAM,yBAAyB;IAKlB;IACQ;IAEA;IAPV,MAAM,GAAG,SAAS,CAAC;IAC5B,gBAAgB,CAAyB;IAEzC,YACW,IAAY,EACJ,MAAkB;IACnC,sEAAsE;IACrD,QAAoB;QAH5B,SAAI,GAAJ,IAAI,CAAQ;QACJ,WAAM,GAAN,MAAM,CAAY;QAElB,aAAQ,GAAR,QAAQ,CAAY;IACpC,CAAC;IAEJ,MAAM,CAAC,KAAK,CAAC,cAAc,CACzB,MAAkB;IAClB,sEAAsE;IACtE,QAAoB;QAEpB,MAAM,EAAE,GAAG,IAAI,oBAAU,CAAC;YACxB,IAAI,EAAE,UAAU;YAChB,QAAQ,EAAE,QAAQ;YAClB,GAAG,EAAE,MAAM,CAAC,gBAAgB;YAC5B,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,QAAQ,EAAE,MAAM,CAAC,IAAI;YACrB,6BAA6B;YAC7B,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,mBAAmB;YACnB,gBAAgB,EAAE,MAAM,CAAC,uBAAuB;YAChD,QAAQ,EAAE,MAAM,CAAC,GAAG;SACrB,CAAC,CAAC;QACH,MAAM,EAAE,CAAC,UAAU,EAAE,CAAC;QACtB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,KAAK,CAAC,UAAU;QACd,MAAM,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACjC,IAAI,CAAC,gBAAgB,GAAG,MAAM,yBAAyB,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnG,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,OAAO;QACX,MAAM,EAAE,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACjC,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAC;QAClC,MAAM,EAAE,EAAE,OAAO,EAAE,CAAC;IACtB,CAAC;IAED,IAAI,WAAW;QACb,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,cAAc,IAAI,CAAC,IAAI,sBAAsB,CAAC,CAAC;QACjE,CAAC;QACD,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,UAAkB,EAClB,MAAc;QAGd,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CACvC;iDAC2C,EAC3C,CAAC,UAAU,EAAE,MAAM,CAAC,CACrB,CAAC;QAEF,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YAC5B,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAClC,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC;IACjD,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,aAAa,CACxB,aAA4B,EAC5B,UAAkB,EAClB,MAAc,EACd,MAAc;QAEd,IAAI,CAAC;YACH,MAAM,aAAa,CAAC,KAAK,CACvB;6BACqB,EACrB,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,CAC7B,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,IAAA,iCAAoB,EAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,MAAM,IAAI,oCAAyB,CAAC,UAAU,CAAC,CAAC;YAClD,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IAED,KAAK,CAAC,YAAY,CAAC,UAAkB,EAAE,MAAc,EAAE,KAAa;QAClE,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAC1B;6BACqB,EACrB,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,CAAC,CAC5B,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,IAAA,iCAAoB,EAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,MAAM,IAAI,oCAAyB,CAAC,UAAU,CAAC,CAAC;YAClD,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IAED,4BAA4B;IAC5B,KAAK,CAAC,yBAAyB,CAC7B,MAAuC,EACvC,MAAY,EACZ,IAAoD,EACpD,GAAG,IAAU;QAEb,MAAM,UAAU,GAAG,eAAI,CAAC,UAAU,CAAC;QACnC,MAAM,MAAM,GAAG,eAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,UAAU,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,CAAC;QAED,MAAM,cAAc,GAAG,MAAM,EAAE,cAAc,IAAI,gBAAgB,CAAC;QAClE,MAAM,QAAQ,GAAG,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QACjD,MAAM,WAAW,GAAG,CAAC,QAAQ,IAAI,UAAU,KAAK,SAAS,CAAC;QAE1D,4BAA4B;QAC5B,IAAI,WAAW,GAAG,CAAC,CAAC;QACpB,MAAM,aAAa,GAAG,GAAG,CAAC;QAC1B,MAAM,cAAc,GAAG,IAAI,CAAC,CAAC,0BAA0B;QAEvD,OAAO,IAAI,EAAE,CAAC;YACZ,oDAAoD;YACpD,MAAM,cAAc,GAAG,WAAW,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,MAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACjG,IAAI,cAAc,EAAE,CAAC;gBACnB,eAAI,CAAC,IAAI,EAAE,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;gBAExC,IAAI,OAAO,IAAI,cAAc,EAAE,CAAC;oBAC9B,MAAM,qBAAS,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;gBAC9C,CAAC;gBACD,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,qBAAS,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAW,CAAC;YAC3F,CAAC;YAED,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,cAAc,EAAE,KAAK,EAAE,aAA4B,EAAE,EAAE;oBACvG,IAAI,QAAQ,EAAE,CAAC;wBACb,MAAM,aAAa,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;oBACzD,CAAC;oBAED,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,GAAG,CAAC,EAAE,aAAa,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,IAAI,EAAE;wBAChF,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;oBAC1C,CAAC,CAAC,CAAC;oBAEH,6CAA6C;oBAC7C,IAAI,WAAW,EAAE,CAAC;wBAChB,MAAM,yBAAyB,CAAC,aAAa,CAC3C,aAAa,EACb,UAAU,EACV,MAAO,EACP,qBAAS,CAAC,SAAS,CAAC,MAAM,CAAC,CAC5B,CAAC;oBACJ,CAAC;oBAED,OAAO,MAAM,CAAC;gBAChB,CAAC,CAAC,CAAC;gBAEH,OAAO,MAAM,CAAC;YAChB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,IAAA,0CAA6B,EAAC,KAAK,CAAC,EAAE,CAAC;oBACzC,eAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,2BAA2B,EAAE,EAAE,eAAe,EAAE,WAAW,EAAE,EAAE,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC;oBACtG,gCAAgC;oBAChC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;oBACjE,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,aAAa,EAAE,cAAc,CAAC,CAAC;oBACpE,SAAS;gBACX,CAAC;qBAAM,CAAC;oBACN,IAAI,WAAW,EAAE,CAAC;wBAChB,MAAM,OAAO,GAAG,qBAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;wBAC3C,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,MAAO,EAAE,OAAO,CAAC,CAAC;oBACxD,CAAC;oBAED,MAAM,KAAK,CAAC;gBACd,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;CACF;AAED,MAAa,iBAAiB;IAsCjB;IArCX,mDAAmD;IACnD,MAAM,CAAC,iBAAiB,CAAC,CAA6B;QACpD,IAAI,CAAC,eAAI,CAAC,eAAe,EAAE,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,8EAA8E,CAAC,CAAC;QAClG,CAAC;QACD,MAAM,GAAG,GAAG,aAAa,CAAC,QAAQ,EAAE,CAAC;QACrC,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,MAAM,IAAI,KAAK,CAAC,8EAA8E,CAAC,CAAC;QAClG,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,KAAK,EAAE,CAAC;YACzB,MAAM,IAAI,KAAK,CAAC,gFAAgF,CAAC,CAAC;QACpG,CAAC;QAED,OAAO,GAAG,CAAC,aAAa,CAAC;IAC3B,CAAC;IAED,MAAM,KAAK,aAAa;QACtB,OAAO,iBAAiB,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;IACxD,CAAC;IAED,IAAI,aAAa;QACf,OAAO,iBAAiB,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAC7D,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,MAAkB;QAClD,MAAM,EAAE,GAAG,MAAM,yBAAyB,CAAC,cAAc,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACtE,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,KAAK,CAAC,gDAAmC,CAAC,CAAC;YACpD,MAAM,EAAE,CAAC,KAAK,CAAC,+CAAkC,CAAC,CAAC;QACrD,CAAC;gBAAS,CAAC;YACT,MAAM,EAAE,CAAC,OAAO,EAAE,CAAC;QACrB,CAAC;IACH,CAAC;IAED,SAAS,CAA4B;IAErC,YACW,IAAY,EACrB,MAAkB;IAClB,sEAAsE;IACtE,QAAoB;QAHX,SAAI,GAAJ,IAAI,CAAQ;QAKrB,IAAI,CAAC,SAAS,GAAG,IAAI,yBAAyB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;QACvE,IAAA,+BAAkB,EAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,cAAc,CAAI,IAAsB,EAAE,MAAiC;QAC/E,OAAO,MAAM,IAAA,2BAAc,EAAC,IAAI,EAAE,MAAM,EAAE,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED;;;;;;;;OAQG;IACH,mBAAmB,CACjB,IAAoD,EACpD,MAAiC;QAEjC,OAAO,IAAA,gCAAmB,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE,MAAM,CAAC,CAAC;IAC3F,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,MAAiC;QAC3C,4DAA4D;QAC5D,MAAM,EAAE,GAAG,IAAI,CAAC;QAChB,OAAO,SAAS,SAAS,CACvB,OAAe,EACf,WAAwB,EACxB,UAAmF;YAEnF,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;gBACtB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;YACxE,CAAC;YAED,UAAU,CAAC,KAAK,GAAG,EAAE,CAAC,mBAAmB,CAAC,UAAU,CAAC,KAAK,EAAE;gBAC1D,GAAG,MAAM;gBACT,IAAI,EAAE,MAAM,EAAE,IAAI,IAAI,MAAM,CAAC,WAAW,CAAC;aAC1C,CAAC,CAAC;YAEH,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC;IACJ,CAAC;CACF;AAjGD,8CAiGC"}

package/index.ts

@@ -0,0 +1,324 @@
+import { PoolConfig } from 'pg';
+import { DBOS, DBOSWorkflowConflictError } from '@dbos-inc/dbos-sdk';
+import {
+  type DataSourceTransactionHandler,
+  createTransactionCompletionSchemaPG,
+  createTransactionCompletionTablePG,
+  isPGRetriableTransactionError,
+  isPGKeyConflictError,
+  registerTransaction,
+  runTransaction,
+  DBOSDataSource,
+  registerDataSource,
+  PGTransactionConfig,
+} from '@dbos-inc/dbos-sdk/datasource';
+import { DataSource, EntityManager } from 'typeorm';
+import { AsyncLocalStorage } from 'async_hooks';
+import { SuperJSON } from 'superjson';
+
+export interface TypeORMTransactionConfig extends PGTransactionConfig {
+  name?: string;
+}
+
+interface DBOSTypeOrmLocalCtx {
+  entityManager: EntityManager;
+  owner: TypeOrmTransactionHandler;
+}
+
+const asyncLocalCtx = new AsyncLocalStorage<DBOSTypeOrmLocalCtx>();
+
+interface transaction_completion {
+  workflow_id: string;
+  function_num: number;
+  output: string | null;
+  error: string | null;
+}
+
+class TypeOrmTransactionHandler implements DataSourceTransactionHandler {
+  readonly dsType = 'TypeOrm';
+  #dataSourceField: DataSource | undefined;
+
+  constructor(
+    readonly name: string,
+    private readonly config: PoolConfig,
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+    private readonly entities: Function[],
+  ) {}
+
+  static async createInstance(
+    config: PoolConfig,
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+    entities: Function[],
+  ): Promise<DataSource> {
+    const ds = new DataSource({
+      type: 'postgres',
+      entities: entities,
+      url: config.connectionString,
+      host: config.host,
+      port: config.port,
+      username: config.user,
+      // password: config.password,
+      database: config.database,
+      // ssl: config.ssl,
+      connectTimeoutMS: config.connectionTimeoutMillis,
+      poolSize: config.max,
+    });
+    await ds.initialize();
+    return ds;
+  }
+
+  async initialize(): Promise<void> {
+    const ds = this.#dataSourceField;
+    this.#dataSourceField = await TypeOrmTransactionHandler.createInstance(this.config, this.entities);
+    await ds?.destroy();
+  }
+
+  async destroy(): Promise<void> {
+    const ds = this.#dataSourceField;
+    this.#dataSourceField = undefined;
+    await ds?.destroy();
+  }
+
+  get #dataSource() {
+    if (!this.#dataSourceField) {
+      throw new Error(`DataSource ${this.name} is not initialized.`);
+    }
+    return this.#dataSourceField;
+  }
+
+  async #checkExecution(
+    workflowID: string,
+    stepID: number,
+  ): Promise<{ output: string | null } | { error: string } | undefined> {
+    type TxOutputRow = Pick<transaction_completion, 'output' | 'error'>;
+    const rows = await this.#dataSource.query<TxOutputRow[]>(
+      `SELECT output, error FROM dbos.transaction_completion
+       WHERE workflow_id=$1 AND function_num=$2;`,
+      [workflowID, stepID],
+    );
+
+    if (rows.length !== 1) {
+      return undefined;
+    }
+
+    if (rows[0].output === null) {
+      return undefined;
+    }
+
+    const { output, error } = rows[0];
+    return error !== null ? { error } : { output };
+  }
+
+  static async #recordOutput(
+    entityManager: EntityManager,
+    workflowID: string,
+    stepID: number,
+    output: string,
+  ): Promise<void> {
+    try {
+      await entityManager.query(
+        `INSERT INTO dbos.transaction_completion (workflow_id, function_num, output)
+         VALUES ($1, $2, $3)`,
+        [workflowID, stepID, output],
+      );
+    } catch (error) {
+      if (isPGKeyConflictError(error)) {
+        throw new DBOSWorkflowConflictError(workflowID);
+      } else {
+        throw error;
+      }
+    }
+  }
+
+  async #recordError(workflowID: string, stepID: number, error: string): Promise<void> {
+    try {
+      await this.#dataSource.query(
+        `INSERT INTO dbos.transaction_completion (workflow_id, function_num, error)
+         VALUES ($1, $2, $3)`,
+        [workflowID, stepID, error],
+      );
+    } catch (error) {
+      if (isPGKeyConflictError(error)) {
+        throw new DBOSWorkflowConflictError(workflowID);
+      } else {
+        throw error;
+      }
+    }
+  }
+
+  /* Required by base class */
+  async invokeTransactionFunction<This, Args extends unknown[], Return>(
+    config: PGTransactionConfig | undefined,
+    target: This,
+    func: (this: This, ...args: Args) => Promise<Return>,
+    ...args: Args
+  ): Promise<Return> {
+    const workflowID = DBOS.workflowID;
+    const stepID = DBOS.stepID;
+    if (workflowID !== undefined && stepID === undefined) {
+      throw new Error('DBOS.stepID is undefined inside a workflow.');
+    }
+
+    const isolationLevel = config?.isolationLevel ?? 'READ COMMITTED';
+    const readOnly = config?.readOnly ? true : false;
+    const saveResults = !readOnly && workflowID !== undefined;
+
+    // Retry loop if appropriate
+    let retryWaitMS = 1;
+    const backoffFactor = 1.5;
+    const maxRetryWaitMS = 2000; // Maximum wait 2 seconds.
+
+    while (true) {
+      // Check to see if this tx has already been executed
+      const previousResult = saveResults ? await this.#checkExecution(workflowID, stepID!) : undefined;
+      if (previousResult) {
+        DBOS.span?.setAttribute('cached', true);
+
+        if ('error' in previousResult) {
+          throw SuperJSON.parse(previousResult.error);
+        }
+        return (previousResult.output ? SuperJSON.parse(previousResult.output) : null) as Return;
+      }
+
+      try {
+        const result = await this.#dataSource.transaction(isolationLevel, async (entityManager: EntityManager) => {
+          if (readOnly) {
+            await entityManager.query('SET TRANSACTION READ ONLY');
+          }
+
+          const result = await asyncLocalCtx.run({ entityManager, owner: this }, async () => {
+            return await func.call(target, ...args);
+          });
+
+          // save the output of read/write transactions
+          if (saveResults) {
+            await TypeOrmTransactionHandler.#recordOutput(
+              entityManager,
+              workflowID,
+              stepID!,
+              SuperJSON.stringify(result),
+            );
+          }
+
+          return result;
+        });
+
+        return result;
+      } catch (error) {
+        if (isPGRetriableTransactionError(error)) {
+          DBOS.span?.addEvent('TXN SERIALIZATION FAILURE', { retryWaitMillis: retryWaitMS }, performance.now());
+          // Retry serialization failures.
+          await new Promise((resolve) => setTimeout(resolve, retryWaitMS));
+          retryWaitMS = Math.min(retryWaitMS * backoffFactor, maxRetryWaitMS);
+          continue;
+        } else {
+          if (saveResults) {
+            const message = SuperJSON.stringify(error);
+            await this.#recordError(workflowID, stepID!, message);
+          }
+
+          throw error;
+        }
+      }
+    }
+  }
+}
+
+export class TypeOrmDataSource implements DBOSDataSource<TypeORMTransactionConfig> {
+  // User calls this... DBOS not directly involved...
+  static #getEntityManager(p?: TypeOrmTransactionHandler): EntityManager {
+    if (!DBOS.isInTransaction()) {
+      throw new Error('Invalid use of TypeOrmDataSource.entityManager outside of a DBOS transaction');
+    }
+    const ctx = asyncLocalCtx.getStore();
+    if (!ctx) {
+      throw new Error('Invalid use of TypeOrmDataSource.entityManager outside of a DBOS transaction');
+    }
+    if (p && p !== ctx.owner) {
+      throw new Error('Invalid retrieval of `TypeOrmDataSource.entityManager` from the wrong instance');
+    }
+
+    return ctx.entityManager;
+  }
+
+  static get entityManager() {
+    return TypeOrmDataSource.#getEntityManager(undefined);
+  }
+
+  get entityManager() {
+    return TypeOrmDataSource.#getEntityManager(this.#provider);
+  }
+
+  static async initializeDBOSSchema(config: PoolConfig): Promise<void> {
+    const ds = await TypeOrmTransactionHandler.createInstance(config, []);
+    try {
+      await ds.query(createTransactionCompletionSchemaPG);
+      await ds.query(createTransactionCompletionTablePG);
+    } finally {
+      await ds.destroy();
+    }
+  }
+
+  #provider: TypeOrmTransactionHandler;
+
+  constructor(
+    readonly name: string,
+    config: PoolConfig,
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
+    entities: Function[],
+  ) {
+    this.#provider = new TypeOrmTransactionHandler(name, config, entities);
+    registerDataSource(this.#provider);
+  }
+
+  /**
+   * Run `func` as a transaction against this DataSource
+   * @param func Function to run within a transactional context
+   * @param funcName Name to record for the transaction
+   * @param config Transaction configuration (isolation, etc)
+   * @returns Return value from `func`
+   */
+  async runTransaction<T>(func: () => Promise<T>, config?: TypeORMTransactionConfig) {
+    return await runTransaction(func, config?.name ?? func.name, { dsName: this.name, config });
+  }
+
+  /**
+   * Register function as DBOS transaction, to be called within the context
+   *  of a transaction on this data source.
+   *
+   * @param func Function to wrap
+   * @param target Name of function
+   * @param config Transaction settings
+   * @returns Wrapped function, to be called instead of `func`
+   */
+  registerTransaction<This, Args extends unknown[], Return>(
+    func: (this: This, ...args: Args) => Promise<Return>,
+    config?: TypeORMTransactionConfig,
+  ): (this: This, ...args: Args) => Promise<Return> {
+    return registerTransaction(this.name, func, { name: config?.name ?? func.name }, config);
+  }
+
+  /**
+   * Decorator establishing function as a transaction
+   */
+  transaction(config?: TypeORMTransactionConfig) {
+    // eslint-disable-next-line @typescript-eslint/no-this-alias
+    const ds = this;
+    return function decorator<This, Args extends unknown[], Return>(
+      _target: object,
+      propertyKey: PropertyKey,
+      descriptor: TypedPropertyDescriptor<(this: This, ...args: Args) => Promise<Return>>,
+    ) {
+      if (!descriptor.value) {
+        throw new Error('Use of decorator when original method is undefined');
+      }
+
+      descriptor.value = ds.registerTransaction(descriptor.value, {
+        ...config,
+        name: config?.name ?? String(propertyKey),
+      });
+
+      return descriptor;
+    };
+  }
+}

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@dbos-inc/typeorm-datasource",
-  "version": "3.0.11-preview.gc9233b8190",
-  "main": "dist/src/index.js",
-  "types": "dist/src/index.d.ts",
+  "version": "3.0.16-preview",
+  "description": "DBOS DataSource library for TypeORM with PostgreSQL support",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "homepage": "https://docs.dbos.dev/",
   "repository": {
     "type": "git",
     "url": "https://github.com/dbos-inc/dbos-transact-ts",
@@ -12,10 +15,6 @@
     "build": "tsc --project tsconfig.json",
     "test": "npm run build && jest --detectOpenHandles"
   },
-  "keywords": [],
-  "author": "",
-  "license": "MIT",
-  "description": "",
   "dependencies": {
     "typeorm": "^0.3.24",
     "pg": "^8.11.3",
@@ -31,6 +30,6 @@
     "jest": "^29.7.0",
     "supertest": "^7.0.0",
     "ts-jest": "^29.1.4",
-    "typescript": "^5.3.3"
+    "typescript": "^5.4.5"
   }
 }

package/tests/config.test.ts

@@ -0,0 +1,31 @@
+import { Client } from 'pg';
+import { TypeOrmDataSource } from '../index';
+import { dropDB, ensureDB } from './test-helpers';
+
+describe('TypeOrmDataSource.configure', () => {
+  const config = { user: 'postgres', database: 'typeorm_ds_config_test' };
+
+  beforeAll(async () => {
+    const client = new Client({ ...config, database: 'postgres' });
+    try {
+      await client.connect();
+      await dropDB(client, config.database, true);
+      await ensureDB(client, config.database);
+    } finally {
+      await client.end();
+    }
+  });
+
+  test('configure creates tx outputs table', async () => {
+    await TypeOrmDataSource.initializeDBOSSchema(config);
+
+    const client = new Client(config);
+    try {
+      await client.connect();
+      const result = await client.query('SELECT workflow_id, function_num, output FROM dbos.transaction_completion');
+      expect(result.rows.length).toBe(0);
+    } finally {
+      await client.end();
+    }
+  });
+});