@vida-global/core 2.0.9 → 2.0.10

package/lib/activeRecord/baseRecord.js

@@ -18,6 +18,11 @@ class BaseRecord extends Model {
     static get col() { return this.connection._sequelize.col }
 
 
+    static sqlLiteral(sql) {
+        return this.sequelize.literal(sql);
+    }
+
+
     constructor() {
         if (new.target == BaseRecord) throw new Error("Cannot create an instance of BaseRecord");
         super(...arguments);
@@ -142,6 +147,23 @@ class BaseRecord extends Model {
     /***********************************************************************************************
     * DB CONNECTION
     ***********************************************************************************************/
+    static async withStatementTimeout(milliseconds, callback) {
+        return await this.sequelize.transaction(
+            {readOnly: true},
+            async(transaction) => {
+                await this.sequelize.query(
+                    'SELECT set_config(\'statement_timeout\', :timeout, true)',
+                    {
+                        replacements: {timeout: String(milliseconds)},
+                        transaction,
+                    }
+                );
+                return await callback(transaction);
+            }
+        );
+    }
+
+
     static get connectionClass() {
         return Connection;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vida-global/core",
-    "version": "2.0.9",
+    "version": "2.0.10",
     "description": "Core libraries for supporting Vida development",
     "author": "",
     "license": "ISC",

package/test/activeRecord/baseRecord.test.js

@@ -80,6 +80,58 @@ describe('BaseRecord', () => {
     });
 
 
+    describe('BaseRecord.withStatementTimeout', () => {
+        it ('runs the callback in a read-only transaction with a local statement timeout', async () => {
+            const callback    = jest.fn().mockResolvedValue('result');
+            const transaction = {};
+            const query       = jest.fn().mockResolvedValue(undefined);
+            const transact    = jest.fn(
+                async (_options, transactionCallback) => {
+                    return await transactionCallback(transaction);
+                }
+            );
+            class User extends BaseRecord {}
+            User.sequelize = {query, transaction: transact};
+
+            await expect(
+                User.withStatementTimeout(15000, callback)
+            ).resolves.toEqual('result');
+
+            expect(transact).toHaveBeenCalledTimes(1);
+            expect(transact).toHaveBeenCalledWith(
+                {readOnly: true},
+                expect.any(Function)
+            );
+            expect(query).toHaveBeenCalledTimes(1);
+            expect(query).toHaveBeenCalledWith(
+                'SELECT set_config(\'statement_timeout\', :timeout, true)',
+                {
+                    replacements: {timeout: '15000'},
+                    transaction,
+                }
+            );
+            expect(callback).toHaveBeenCalledTimes(1);
+            expect(callback).toHaveBeenCalledWith(transaction);
+        });
+    });
+
+
+    describe('BaseRecord.sqlLiteral', () => {
+        it ('returns the SQL literal built by the model sequelize connection', () => {
+            const sql            = TestHelpers.Faker.Text.randomString();
+            const literal        = {};
+            const literalBuilder = jest.fn().mockReturnValue(literal);
+            class User extends BaseRecord {}
+            User.sequelize = {literal: literalBuilder};
+
+            expect(User.sqlLiteral(sql)).toBe(literal);
+
+            expect(literalBuilder).toHaveBeenCalledTimes(1);
+            expect(literalBuilder).toHaveBeenCalledWith(sql);
+        });
+    });
+
+
     describe('BaseRecord.initialize', () => {
         it ('calls `getBaseRecordSchema` and passes the response to init', () => {
             class User extends BaseRecord {}