@proteinjs/db 1.56.0 → 1.58.0

package/dist/test/DbIsSystem.test.js

@@ -0,0 +1,280 @@
+"use strict";
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var reflection_1 = require("@proteinjs/reflection");
+var Db_1 = require("../src/Db");
+var Table_1 = require("../src/Table");
+var Record_1 = require("../src/Record");
+var Columns_1 = require("../src/Columns");
+var TableWatcherRunner_1 = require("../src/TableWatcherRunner");
+var DocTable = /** @class */ (function (_super) {
+    __extends(DocTable, _super);
+    function DocTable() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.name = 'is_system_doc';
+        /** Every door open to everyone: a session Db reaches the write with no user to resolve. */
+        _this.auth = { db: { all: 'public' } };
+        _this.columns = (0, Record_1.withRecordColumns)({
+            title: new Columns_1.StringColumn('title'),
+        });
+        return _this;
+    }
+    return DocTable;
+}(Table_1.Table));
+var docTable = new DocTable();
+/** What each hook was handed: the mode of its trailing Db. */
+var handed = [];
+var ModeRecordingWatcher = /** @class */ (function () {
+    function ModeRecordingWatcher() {
+    }
+    ModeRecordingWatcher.prototype.name = function () {
+        return 'ModeRecordingWatcher';
+    };
+    ModeRecordingWatcher.prototype.table = function () {
+        return docTable;
+    };
+    ModeRecordingWatcher.prototype.beforeInsert = function (record, db) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                handed.push({ phase: 'beforeInsert', mode: db === null || db === void 0 ? void 0 : db.isSystem() });
+                return [2 /*return*/, record];
+            });
+        });
+    };
+    ModeRecordingWatcher.prototype.afterInsert = function (_record, db) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                handed.push({ phase: 'afterInsert', mode: db === null || db === void 0 ? void 0 : db.isSystem() });
+                return [2 /*return*/];
+            });
+        });
+    };
+    return ModeRecordingWatcher;
+}());
+var TestTransactionContextFactory = /** @class */ (function () {
+    function TestTransactionContextFactory() {
+        this.context = {};
+    }
+    TestTransactionContextFactory.prototype.getTransactionContext = function () {
+        return this.context;
+    };
+    TestTransactionContextFactory.prototype.runInContext = function (context, fn) {
+        return __awaiter(this, void 0, void 0, function () {
+            var previous;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        previous = this.context;
+                        this.context = context;
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, , 3, 4]);
+                        return [4 /*yield*/, fn()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                    case 3:
+                        this.context = previous;
+                        return [7 /*endfinally*/];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return TestTransactionContextFactory;
+}());
+/** Accepts every statement; no database behind it. */
+var AcceptingDriver = /** @class */ (function () {
+    function AcceptingDriver() {
+    }
+    AcceptingDriver.prototype.getDbName = function () {
+        return 'test';
+    };
+    AcceptingDriver.prototype.createDbIfNotExists = function () {
+        return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/];
+        }); });
+    };
+    AcceptingDriver.prototype.createDb = function () {
+        return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/];
+        }); });
+    };
+    AcceptingDriver.prototype.dropDb = function () {
+        return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/];
+        }); });
+    };
+    AcceptingDriver.prototype.getTableManager = function () {
+        throw new Error('not used by these tests');
+    };
+    AcceptingDriver.prototype.runQuery = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, []];
+            });
+        });
+    };
+    AcceptingDriver.prototype.runDml = function (generateStatement) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                generateStatement({
+                    useParams: true,
+                    useNamedParams: true,
+                    prefixTablesWithDb: false,
+                    getDriverColumnType: function () { return 'STRING(MAX)'; },
+                });
+                return [2 /*return*/, 1];
+            });
+        });
+    };
+    AcceptingDriver.prototype.runTransaction = function (fn) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, fn({ id: 'transaction' })];
+                    case 1: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    AcceptingDriver.prototype.getOperationDeadlineMs = function () {
+        return 1000;
+    };
+    return AcceptingDriver;
+}());
+var objectCache = function () { return reflection_1.SourceRepository.get().objectCache; };
+var DEFAULT_DRIVER_GLOBAL = '__proteinjs_db_defaultDbDriver';
+var driver = new AcceptingDriver();
+var transactions = new TestTransactionContextFactory();
+var modesHandedBy = function (db) { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                handed.length = 0;
+                return [4 /*yield*/, db.insert(docTable, { title: 'row' })];
+            case 1:
+                _a.sent();
+                expect(handed.map(function (_a) {
+                    var phase = _a.phase;
+                    return phase;
+                })).toEqual(['beforeInsert', 'afterInsert']);
+                return [2 /*return*/, handed.map(function (_a) {
+                        var mode = _a.mode;
+                        return mode;
+                    })];
+        }
+    });
+}); };
+describe('Db.isSystem', function () {
+    var originalWatchers;
+    var originalFactories;
+    var originalTransactionFactories;
+    beforeAll(function () {
+        originalWatchers = objectCache()['@proteinjs/db/TableWatcher'];
+        originalFactories = objectCache()['@proteinjs/db/DefaultDbDriverFactory'];
+        originalTransactionFactories = objectCache()['@proteinjs/db/DefaultTransactionContextFactory'];
+        objectCache()['@proteinjs/db/TableWatcher'] = [new ModeRecordingWatcher()];
+        // The public factories resolve their driver and transaction context through reflection.
+        objectCache()['@proteinjs/db/DefaultDbDriverFactory'] = [{ getDbDriver: function () { return driver; } }];
+        objectCache()['@proteinjs/db/DefaultTransactionContextFactory'] = [transactions];
+        delete globalThis[DEFAULT_DRIVER_GLOBAL];
+        TableWatcherRunner_1.TableWatcherRunner.tableWatcherMap = undefined;
+    });
+    afterAll(function () {
+        var restore = function (name, original) {
+            if (original) {
+                objectCache()[name] = original;
+            }
+            else {
+                delete objectCache()[name];
+            }
+        };
+        restore('@proteinjs/db/TableWatcher', originalWatchers);
+        restore('@proteinjs/db/DefaultDbDriverFactory', originalFactories);
+        restore('@proteinjs/db/DefaultTransactionContextFactory', originalTransactionFactories);
+        delete globalThis[DEFAULT_DRIVER_GLOBAL];
+        TableWatcherRunner_1.TableWatcherRunner.tableWatcherMap = undefined;
+    });
+    test('a system Db answers true, a session Db false — on the public factories and on the constructor', function () {
+        expect((0, Db_1.getDbAsSystem)().isSystem()).toBe(true);
+        expect((0, Db_1.getDb)().isSystem()).toBe(false);
+        expect(new Db_1.Db(driver, function () { return docTable; }, transactions, true).isSystem()).toBe(true);
+        expect(new Db_1.Db(driver, function () { return docTable; }, transactions).isSystem()).toBe(false);
+    });
+    test("the Db a write hands its watchers answers for THAT write: a system write's hooks read true", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    _a = expect;
+                    return [4 /*yield*/, modesHandedBy((0, Db_1.getDbAsSystem)())];
+                case 1:
+                    _a.apply(void 0, [_b.sent()]).toEqual([true, true]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    test("the Db a write hands its watchers answers for THAT write: a session write's hooks read false", function () { return __awaiter(void 0, void 0, void 0, function () {
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    _a = expect;
+                    return [4 /*yield*/, modesHandedBy((0, Db_1.getDb)())];
+                case 1:
+                    _a.apply(void 0, [_b.sent()]).toEqual([false, false]);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+//# sourceMappingURL=DbIsSystem.test.js.map

package/dist/test/DbIsSystem.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DbIsSystem.test.js","sourceRoot":"","sources":["../../test/DbIsSystem.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAyD;AAEzD,gCAA2F;AAC3F,sCAAqC;AACrC,wCAA0D;AAC1D,0CAA8C;AAE9C,gEAA+D;AAe/D;IAAuB,4BAAU;IAAjC;QAAA,qEAOC;QANQ,UAAI,GAAG,eAAe,CAAC;QAC9B,2FAA2F;QACpF,UAAI,GAAuB,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC;QACrD,aAAO,GAAG,IAAA,0BAAiB,EAAM;YACtC,KAAK,EAAE,IAAI,sBAAY,CAAC,OAAO,CAAC;SACjC,CAAC,CAAC;;IACL,CAAC;IAAD,eAAC;AAAD,CAAC,AAPD,CAAuB,aAAK,GAO3B;AAED,IAAM,QAAQ,GAAG,IAAI,QAAQ,EAAgB,CAAC;AAE9C,8DAA8D;AAC9D,IAAM,MAAM,GAAmD,EAAE,CAAC;AAElE;IAAA;IAiBA,CAAC;IAhBC,mCAAI,GAAJ;QACE,OAAO,sBAAsB,CAAC;IAChC,CAAC;IAED,oCAAK,GAAL;QACE,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEK,2CAAY,GAAlB,UAAkC,MAA0B,EAAE,EAAO;;;gBACnE,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;gBAC7D,sBAAO,MAAM,EAAC;;;KACf;IAEK,0CAAW,GAAjB,UAAiC,OAAU,EAAE,EAAO;;;gBAClD,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;;;;KAC7D;IACH,2BAAC;AAAD,CAAC,AAjBD,IAiBC;AAED;IAAA;QACU,YAAO,GAA2B,EAAE,CAAC;IAe/C,CAAC;IAbC,6DAAqB,GAArB;QACE,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAEK,oDAAY,GAAlB,UAAsB,OAA+B,EAAE,EAAoB;;;;;;wBACnE,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC;wBAC9B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;;;;wBAEd,qBAAM,EAAE,EAAE,EAAA;4BAAjB,sBAAO,SAAU,EAAC;;wBAElB,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC;;;;;;KAE3B;IACH,oCAAC;AAAD,CAAC,AAhBD,IAgBC;AAED,sDAAsD;AACtD;IAAA;IAoCA,CAAC;IAnCC,mCAAS,GAAT;QACE,OAAO,MAAM,CAAC;IAChB,CAAC;IAEK,6CAAmB,GAAzB;;;;KAA6C;IAEvC,kCAAQ,GAAd;;;;KAAkC;IAE5B,gCAAM,GAAZ;;;;KAAgC;IAEhC,yCAAe,GAAf;QACE,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;IAEK,kCAAQ,GAAd;;;gBACE,sBAAO,EAAE,EAAC;;;KACX;IAEK,gCAAM,GAAZ,UAAa,iBAAoE;;;gBAC/E,iBAAiB,CAAC;oBAChB,SAAS,EAAE,IAAI;oBACf,cAAc,EAAE,IAAI;oBACpB,kBAAkB,EAAE,KAAK;oBACzB,mBAAmB,EAAE,cAAM,OAAA,aAAa,EAAb,CAAa;iBACzC,CAAC,CAAC;gBACH,sBAAO,CAAC,EAAC;;;KACV;IAEK,wCAAc,GAApB,UAAwB,EAAwC;;;;4BACvD,qBAAM,EAAE,CAAC,EAAE,EAAE,EAAE,aAAa,EAAE,CAAC,EAAA;4BAAtC,sBAAO,SAA+B,EAAC;;;;KACxC;IAED,gDAAsB,GAAtB;QACE,OAAO,IAAI,CAAC;IACd,CAAC;IACH,sBAAC;AAAD,CAAC,AApCD,IAoCC;AAID,IAAM,WAAW,GAAG,cAAM,OAAC,6BAAgB,CAAC,GAAG,EAA2C,CAAC,WAAW,EAA5E,CAA4E,CAAC;AACvG,IAAM,qBAAqB,GAAG,gCAAgC,CAAC;AAE/D,IAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;AACrC,IAAM,YAAY,GAAG,IAAI,6BAA6B,EAAE,CAAC;AACzD,IAAM,aAAa,GAAG,UAAO,EAAW;;;;gBACtC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;gBAClB,qBAAM,EAAE,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAA;;gBAA3C,SAA2C,CAAC;gBAC5C,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,UAAC,EAAS;wBAAP,KAAK,WAAA;oBAAO,OAAA,KAAK;gBAAL,CAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,aAAa,CAAC,CAAC,CAAC;gBAClF,sBAAO,MAAM,CAAC,GAAG,CAAC,UAAC,EAAQ;4BAAN,IAAI,UAAA;wBAAO,OAAA,IAAI;oBAAJ,CAAI,CAAC,EAAC;;;KACvC,CAAC;AAEF,QAAQ,CAAC,aAAa,EAAE;IACtB,IAAI,gBAAuC,CAAC;IAC5C,IAAI,iBAAwC,CAAC;IAC7C,IAAI,4BAAmD,CAAC;IAExD,SAAS,CAAC;QACR,gBAAgB,GAAG,WAAW,EAAE,CAAC,4BAA4B,CAAC,CAAC;QAC/D,iBAAiB,GAAG,WAAW,EAAE,CAAC,sCAAsC,CAAC,CAAC;QAC1E,4BAA4B,GAAG,WAAW,EAAE,CAAC,gDAAgD,CAAC,CAAC;QAC/F,WAAW,EAAE,CAAC,4BAA4B,CAAC,GAAG,CAAC,IAAI,oBAAoB,EAAE,CAAC,CAAC;QAC3E,wFAAwF;QACxF,WAAW,EAAE,CAAC,sCAAsC,CAAC,GAAG,CAAC,EAAE,WAAW,EAAE,cAAM,OAAA,MAAM,EAAN,CAAM,EAAE,CAAC,CAAC;QACxF,WAAW,EAAE,CAAC,gDAAgD,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACjF,OAAQ,UAAyC,CAAC,qBAAqB,CAAC,CAAC;QACxE,uCAA2D,CAAC,eAAe,GAAG,SAAS,CAAC;IAC3F,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC;QACP,IAAM,OAAO,GAAG,UAAC,IAAY,EAAE,QAA+B;YAC5D,IAAI,QAAQ,EAAE;gBACZ,WAAW,EAAE,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC;aAChC;iBAAM;gBACL,OAAO,WAAW,EAAE,CAAC,IAAI,CAAC,CAAC;aAC5B;QACH,CAAC,CAAC;QACF,OAAO,CAAC,4BAA4B,EAAE,gBAAgB,CAAC,CAAC;QACxD,OAAO,CAAC,sCAAsC,EAAE,iBAAiB,CAAC,CAAC;QACnE,OAAO,CAAC,gDAAgD,EAAE,4BAA4B,CAAC,CAAC;QACxF,OAAQ,UAAyC,CAAC,qBAAqB,CAAC,CAAC;QACxE,uCAA2D,CAAC,eAAe,GAAG,SAAS,CAAC;IAC3F,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+FAA+F,EAAE;QACpG,MAAM,CAAC,IAAA,kBAAa,GAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,MAAM,CAAC,IAAA,UAAK,GAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvC,MAAM,CAAC,IAAI,OAAE,CAAM,MAAM,EAAE,cAAM,OAAA,QAAQ,EAAR,CAAQ,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtF,MAAM,CAAC,IAAI,OAAE,CAAM,MAAM,EAAE,cAAM,OAAA,QAAQ,EAAR,CAAQ,EAAE,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACnF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,4FAA4F,EAAE;;;;;oBACjG,KAAA,MAAM,CAAA;oBAAC,qBAAM,aAAa,CAAC,IAAA,kBAAa,GAAO,CAAC,EAAA;;oBAAhD,kBAAO,SAAyC,EAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;;;;SACzE,CAAC,CAAC;IAEH,IAAI,CAAC,8FAA8F,EAAE;;;;;oBACnG,KAAA,MAAM,CAAA;oBAAC,qBAAM,aAAa,CAAC,IAAA,UAAK,GAAO,CAAC,EAAA;;oBAAxC,kBAAO,SAAiC,EAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;;;;SACnE,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}