@proteinjs/db 1.54.0 → 1.54.2

package/dist/test/HydrationBenchmark.test.js

@@ -0,0 +1,299 @@
+"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 async_hooks_1 = require("async_hooks");
+var reflection_1 = require("@proteinjs/reflection");
+var Db_1 = require("../src/Db");
+var TableWatcherRunner_1 = require("../src/TableWatcherRunner");
+var Table_1 = require("../src/Table");
+var Record_1 = require("../src/Record");
+var Columns_1 = require("../src/Columns");
+var WideTable = /** @class */ (function (_super) {
+    __extends(WideTable, _super);
+    function WideTable() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.name = 'hydration_wide';
+        _this.columns = (0, Record_1.withRecordColumns)({
+            title: new Columns_1.StringColumn('title'),
+            body: new Columns_1.StringColumn('body', undefined, 'MAX'),
+            count: new Columns_1.IntegerColumn('count'),
+            payload: new Columns_1.ObjectColumn('payload'),
+            t0: new Columns_1.DateTimeColumn('t0'),
+            t1: new Columns_1.DateTimeColumn('t1'),
+            t2: new Columns_1.DateTimeColumn('t2'),
+            t3: new Columns_1.DateTimeColumn('t3'),
+            t4: new Columns_1.DateTimeColumn('t4'),
+            t5: new Columns_1.DateTimeColumn('t5'),
+            t6: new Columns_1.DateTimeColumn('t6'),
+            t7: new Columns_1.DateTimeColumn('t7'),
+            t8: new Columns_1.DateTimeColumn('t8'),
+            t9: new Columns_1.DateTimeColumn('t9'),
+        });
+        return _this;
+    }
+    return WideTable;
+}(Table_1.Table));
+var wideTable = new WideTable();
+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;
+}());
+var RowsDriver = /** @class */ (function () {
+    function RowsDriver(rows) {
+        this.rows = rows;
+    }
+    RowsDriver.prototype.getDbName = function () {
+        return 'test';
+    };
+    RowsDriver.prototype.createDbIfNotExists = function () {
+        return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/];
+        }); });
+    };
+    RowsDriver.prototype.createDb = function () {
+        return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/];
+        }); });
+    };
+    RowsDriver.prototype.dropDb = function () {
+        return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/];
+        }); });
+    };
+    RowsDriver.prototype.getTableManager = function () {
+        throw new Error('not used by this measure');
+    };
+    RowsDriver.prototype.runQuery = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.rows];
+            });
+        });
+    };
+    RowsDriver.prototype.runDml = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, 0];
+            });
+        });
+    };
+    RowsDriver.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()];
+                }
+            });
+        });
+    };
+    RowsDriver.prototype.getOperationDeadlineMs = function () {
+        return 1000;
+    };
+    return RowsDriver;
+}());
+var objectCache = function () { return reflection_1.SourceRepository.get().objectCache; };
+var originalWatchers;
+// No reflection graph in a unit test: the watcher registry is empty by declaration.
+beforeAll(function () {
+    originalWatchers = objectCache()['@proteinjs/db/TableWatcher'];
+    objectCache()['@proteinjs/db/TableWatcher'] = [];
+    TableWatcherRunner_1.TableWatcherRunner.tableWatcherMap = undefined;
+});
+afterAll(function () {
+    if (originalWatchers) {
+        objectCache()['@proteinjs/db/TableWatcher'] = originalWatchers;
+    }
+    else {
+        delete objectCache()['@proteinjs/db/TableWatcher'];
+    }
+    TableWatcherRunner_1.TableWatcherRunner.tableWatcherMap = undefined;
+});
+var storedRows = function (count) {
+    return Array.from({ length: count }, function (_, row) {
+        var stored = {
+            id: "row-".concat(row),
+            created: new Date(1600000000000 + row),
+            updated: new Date(1600000000000 + row),
+            title: "title ".concat(row),
+            body: 'x'.repeat(400),
+            count: row,
+            payload: JSON.stringify({ tags: ['a', 'b', 'c'], n: row }),
+        };
+        for (var i = 0; i < 10; i++) {
+            stored["t".concat(i)] = new Date(1700000000000 + row * 100 + i);
+        }
+        return stored;
+    });
+};
+/** Wall time, promises created and microtask rounds while `act` runs. */
+var measure = function (act) { return __awaiter(void 0, void 0, void 0, function () {
+    var promises, hook, microtaskRounds, running, round, started, ms;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                promises = 0;
+                hook = (0, async_hooks_1.createHook)({
+                    init: function (_asyncId, type) {
+                        if (type === 'PROMISE') {
+                            promises++;
+                        }
+                    },
+                });
+                microtaskRounds = 0;
+                running = true;
+                round = function () {
+                    if (!running) {
+                        return;
+                    }
+                    microtaskRounds++;
+                    queueMicrotask(round);
+                };
+                hook.enable();
+                started = process.hrtime.bigint();
+                queueMicrotask(round);
+                return [4 /*yield*/, act()];
+            case 1:
+                _a.sent();
+                running = false;
+                ms = Number(process.hrtime.bigint() - started) / 1000000;
+                hook.disable();
+                return [2 /*return*/, { ms: Math.round(ms * 10) / 10, promises: promises, microtaskRounds: microtaskRounds }];
+        }
+    });
+}); };
+describe('hydration measure', function () {
+    it('reports 1,000 rows with ten DateTime columns through Db.query (wall ms, promises, microtask rounds)', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var rows, db, passes, records, i, _a, _b, readAll;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0:
+                    rows = storedRows(1000);
+                    db = new Db_1.Db(new RowsDriver(rows), function () { return wideTable; }, new TestTransactionContextFactory(), true);
+                    // one warm-up pass, then the measured passes
+                    return [4 /*yield*/, db.query(wideTable, {})];
+                case 1:
+                    // one warm-up pass, then the measured passes
+                    _c.sent();
+                    passes = [];
+                    records = [];
+                    i = 0;
+                    _c.label = 2;
+                case 2:
+                    if (!(i < 5)) return [3 /*break*/, 5];
+                    _b = (_a = passes).push;
+                    return [4 /*yield*/, measure(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+                            switch (_a.label) {
+                                case 0: return [4 /*yield*/, db.query(wideTable, {})];
+                                case 1: return [2 /*return*/, (records = _a.sent())];
+                            }
+                        }); }); })];
+                case 3:
+                    _b.apply(_a, [_c.sent()]);
+                    _c.label = 4;
+                case 4:
+                    i++;
+                    return [3 /*break*/, 2];
+                case 5: return [4 /*yield*/, measure(function () { return __awaiter(void 0, void 0, void 0, function () {
+                        var _i, records_1, record;
+                        return __generator(this, function (_a) {
+                            for (_i = 0, records_1 = records; _i < records_1.length; _i++) {
+                                record = records_1[_i];
+                                record.t0.valueOf();
+                                record.created.valueOf();
+                            }
+                            return [2 /*return*/];
+                        });
+                    }); })];
+                case 6:
+                    readAll = _c.sent();
+                    process.stdout.write("hydration measure \u2014 1,000 rows \u00D7 (10 DateTime + created/updated + 4 plain columns), Db.query, 5 passes:\n" +
+                        passes
+                            .map(function (pass, i) {
+                            return "  pass ".concat(i + 1, ": ").concat(pass.ms, " ms \u00B7 ").concat(pass.promises, " promises \u00B7 ").concat(pass.microtaskRounds, " microtask rounds");
+                        })
+                            .join('\n') +
+                        "\n  then reading t0 + created on every record: ".concat(readAll.ms, " ms \u00B7 ").concat(readAll.promises, " promises\n"));
+                    expect(records).toHaveLength(1000);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+//# sourceMappingURL=HydrationBenchmark.test.js.map

package/dist/test/HydrationBenchmark.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HydrationBenchmark.test.js","sourceRoot":"","sources":["../../test/HydrationBenchmark.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAAyC;AACzC,oDAAyD;AACzD,gCAAyC;AACzC,gEAA+D;AAC/D,sCAAqC;AACrC,wCAA4E;AAC5E,0CAA2F;AA4B3F;IAAwB,6BAAW;IAAnC;QAAA,qEAkBC;QAjBQ,UAAI,GAAG,gBAAgB,CAAC;QACxB,aAAO,GAAG,IAAA,0BAAiB,EAAO;YACvC,KAAK,EAAE,IAAI,sBAAY,CAAC,OAAO,CAAC;YAChC,IAAI,EAAE,IAAI,sBAAY,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,CAAC;YAChD,KAAK,EAAE,IAAI,uBAAa,CAAC,OAAO,CAAC;YACjC,OAAO,EAAE,IAAI,sBAAY,CAAC,SAAS,CAAC;YACpC,EAAE,EAAE,IAAI,wBAAc,CAAC,IAAI,CAAC;YAC5B,EAAE,EAAE,IAAI,wBAAc,CAAC,IAAI,CAAC;YAC5B,EAAE,EAAE,IAAI,wBAAc,CAAC,IAAI,CAAC;YAC5B,EAAE,EAAE,IAAI,wBAAc,CAAC,IAAI,CAAC;YAC5B,EAAE,EAAE,IAAI,wBAAc,CAAC,IAAI,CAAC;YAC5B,EAAE,EAAE,IAAI,wBAAc,CAAC,IAAI,CAAC;YAC5B,EAAE,EAAE,IAAI,wBAAc,CAAC,IAAI,CAAC;YAC5B,EAAE,EAAE,IAAI,wBAAc,CAAC,IAAI,CAAC;YAC5B,EAAE,EAAE,IAAI,wBAAc,CAAC,IAAI,CAAC;YAC5B,EAAE,EAAE,IAAI,wBAAc,CAAC,IAAI,CAAC;SAC7B,CAAC,CAAC;;IACL,CAAC;IAAD,gBAAC;AAAD,CAAC,AAlBD,CAAwB,aAAK,GAkB5B;AAED,IAAM,SAAS,GAAG,IAAI,SAAS,EAAiB,CAAC;AAEjD;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;IACE,oBAA6B,IAAwB;QAAxB,SAAI,GAAJ,IAAI,CAAoB;IAAG,CAAC;IAEzD,8BAAS,GAAT;QACE,OAAO,MAAM,CAAC;IAChB,CAAC;IAEK,wCAAmB,GAAzB;;;;KAA6C;IAEvC,6BAAQ,GAAd;;;;KAAkC;IAE5B,2BAAM,GAAZ;;;;KAAgC;IAEhC,oCAAe,GAAf;QACE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC9C,CAAC;IAEK,6BAAQ,GAAd;;;gBACE,sBAAO,IAAI,CAAC,IAAI,EAAC;;;KAClB;IAEK,2BAAM,GAAZ;;;gBACE,sBAAO,CAAC,EAAC;;;KACV;IAEK,mCAAc,GAApB,UAAwB,EAAwC;;;;4BACvD,qBAAM,EAAE,CAAC,EAAE,EAAE,EAAE,aAAa,EAAE,CAAC,EAAA;4BAAtC,sBAAO,SAA+B,EAAC;;;;KACxC;IAED,2CAAsB,GAAtB;QACE,OAAO,IAAI,CAAC;IACd,CAAC;IACH,iBAAC;AAAD,CAAC,AAhCD,IAgCC;AAID,IAAM,WAAW,GAAG,cAAM,OAAC,6BAAgB,CAAC,GAAG,EAA2C,CAAC,WAAW,EAA5E,CAA4E,CAAC;AACvG,IAAI,gBAAuC,CAAC;AAE5C,oFAAoF;AACpF,SAAS,CAAC;IACR,gBAAgB,GAAG,WAAW,EAAE,CAAC,4BAA4B,CAAC,CAAC;IAC/D,WAAW,EAAE,CAAC,4BAA4B,CAAC,GAAG,EAAE,CAAC;IAChD,uCAA2D,CAAC,eAAe,GAAG,SAAS,CAAC;AAC3F,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC;IACP,IAAI,gBAAgB,EAAE;QACpB,WAAW,EAAE,CAAC,4BAA4B,CAAC,GAAG,gBAAgB,CAAC;KAChE;SAAM;QACL,OAAO,WAAW,EAAE,CAAC,4BAA4B,CAAC,CAAC;KACpD;IACA,uCAA2D,CAAC,eAAe,GAAG,SAAS,CAAC;AAC3F,CAAC,CAAC,CAAC;AAEH,IAAM,UAAU,GAAG,UAAC,KAAa;IAC/B,OAAA,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,UAAC,CAAC,EAAE,GAAG;QACnC,IAAM,MAAM,GAAqB;YAC/B,EAAE,EAAE,cAAO,GAAG,CAAE;YAChB,OAAO,EAAE,IAAI,IAAI,CAAC,aAAiB,GAAG,GAAG,CAAC;YAC1C,OAAO,EAAE,IAAI,IAAI,CAAC,aAAiB,GAAG,GAAG,CAAC;YAC1C,KAAK,EAAE,gBAAS,GAAG,CAAE;YACrB,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC;YACrB,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC;SAC3D,CAAC;QACF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;YAC3B,MAAM,CAAC,WAAI,CAAC,CAAE,CAAC,GAAG,IAAI,IAAI,CAAC,aAAiB,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC;SAC/D;QACD,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AAdF,CAcE,CAAC;AAIL,yEAAyE;AACzE,IAAM,OAAO,GAAG,UAAO,GAA2B;;;;;gBAC5C,QAAQ,GAAG,CAAC,CAAC;gBACX,IAAI,GAAG,IAAA,wBAAU,EAAC;oBACtB,IAAI,YAAC,QAAQ,EAAE,IAAI;wBACjB,IAAI,IAAI,KAAK,SAAS,EAAE;4BACtB,QAAQ,EAAE,CAAC;yBACZ;oBACH,CAAC;iBACF,CAAC,CAAC;gBACC,eAAe,GAAG,CAAC,CAAC;gBACpB,OAAO,GAAG,IAAI,CAAC;gBACb,KAAK,GAAG;oBACZ,IAAI,CAAC,OAAO,EAAE;wBACZ,OAAO;qBACR;oBACD,eAAe,EAAE,CAAC;oBAClB,cAAc,CAAC,KAAK,CAAC,CAAC;gBACxB,CAAC,CAAC;gBACF,IAAI,CAAC,MAAM,EAAE,CAAC;gBACR,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;gBACxC,cAAc,CAAC,KAAK,CAAC,CAAC;gBACtB,qBAAM,GAAG,EAAE,EAAA;;gBAAX,SAAW,CAAC;gBACZ,OAAO,GAAG,KAAK,CAAC;gBACV,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,OAAS,CAAC;gBACjE,IAAI,CAAC,OAAO,EAAE,CAAC;gBACf,sBAAO,EAAE,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE,QAAQ,UAAA,EAAE,eAAe,iBAAA,EAAE,EAAC;;;KACpE,CAAC;AAEF,QAAQ,CAAC,mBAAmB,EAAE;IAC5B,EAAE,CAAC,qGAAqG,EAAE;;;;;oBAClG,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;oBACxB,EAAE,GAAG,IAAI,OAAE,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,cAAM,OAAA,SAAS,EAAT,CAAS,EAAE,IAAI,6BAA6B,EAAE,EAAE,IAAI,CAAC,CAAC;oBACpG,6CAA6C;oBAC7C,qBAAM,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,CAAC,EAAA;;oBAD7B,6CAA6C;oBAC7C,SAA6B,CAAC;oBAExB,MAAM,GAAc,EAAE,CAAC;oBACzB,OAAO,GAAW,EAAE,CAAC;oBAChB,CAAC,GAAG,CAAC;;;yBAAE,CAAA,CAAC,GAAG,CAAC,CAAA;oBACnB,KAAA,CAAA,KAAA,MAAM,CAAA,CAAC,IAAI,CAAA;oBAAC,qBAAM,OAAO,CAAC;;wCAAuB,qBAAM,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,CAAC,EAAA;wCAAxC,sBAAA,CAAC,OAAO,GAAG,SAA6B,CAAC,EAAA;;iCAAA,CAAC,EAAA;;oBAAhF,cAAY,SAAoE,EAAC,CAAC;;;oBAD7D,CAAC,EAAE,CAAA;;wBAGV,qBAAM,OAAO,CAAC;;;4BAC5B,WAA4B,EAAP,mBAAO,EAAP,qBAAO,EAAP,IAAO,EAAE;gCAAnB,MAAM;gCACf,MAAM,CAAC,EAAG,CAAC,OAAO,EAAE,CAAC;gCACrB,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;6BAC1B;;;yBACF,CAAC,EAAA;;oBALI,OAAO,GAAG,SAKd;oBAEF,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,qHAA2G;wBACzG,MAAM;6BACH,GAAG,CACF,UAAC,IAAI,EAAE,CAAC;4BACN,OAAA,iBAAU,CAAC,GAAG,CAAC,eAAK,IAAI,CAAC,EAAE,wBAAS,IAAI,CAAC,QAAQ,8BAAe,IAAI,CAAC,eAAe,sBAAmB;wBAAvG,CAAuG,CAC1G;6BACA,IAAI,CAAC,IAAI,CAAC;wBACb,yDAAkD,OAAO,CAAC,EAAE,wBAAS,OAAO,CAAC,QAAQ,gBAAa,CACrG,CAAC;oBACF,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;;;;SACpC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/test/SyncRowHydration.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=SyncRowHydration.test.d.ts.map

package/dist/test/SyncRowHydration.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SyncRowHydration.test.d.ts","sourceRoot":"","sources":["../../test/SyncRowHydration.test.ts"],"names":[],"mappings":""}

package/dist/test/SyncRowHydration.test.js

@@ -0,0 +1,344 @@
+"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 crypto_1 = require("crypto");
+var reflection_1 = require("@proteinjs/reflection");
+var Db_1 = require("../src/Db");
+var TableWatcherRunner_1 = require("../src/TableWatcherRunner");
+var Table_1 = require("../src/Table");
+var Record_1 = require("../src/Record");
+var Columns_1 = require("../src/Columns");
+var DataKeyStore_1 = require("../src/encryption/DataKeyStore");
+var EncryptionEnvelope_1 = require("../src/encryption/EncryptionEnvelope");
+/** Where the loop stood when each cell was read: the row, and whether the sentinel had fired by then. */
+var cellsRead = [];
+var sentinelFired = false;
+/**
+ * A column that notes, at each read, whether a microtask armed by the FIRST cell read has fired yet:
+ * a hydration that yields the loop between rows lets it fire mid-way; a synchronous one never does.
+ */
+var ObservingColumn = /** @class */ (function () {
+    function ObservingColumn(name) {
+        this.name = name;
+    }
+    ObservingColumn.prototype.deserialize = function (storedValue) {
+        if (cellsRead.length === 0) {
+            queueMicrotask(function () {
+                sentinelFired = true;
+            });
+        }
+        cellsRead.push({ column: this.name, row: storedValue, sentinelFired: sentinelFired });
+        return storedValue;
+    };
+    return ObservingColumn;
+}());
+var DocTable = /** @class */ (function (_super) {
+    __extends(DocTable, _super);
+    function DocTable() {
+        var _this = _super !== null && _super.apply(this, arguments) || this;
+        _this.name = 'hydration_doc';
+        _this.columns = (0, Record_1.withRecordColumns)({
+            title: new Columns_1.StringColumn('title'),
+            first: new ObservingColumn('first'),
+            second: new ObservingColumn('second'),
+        });
+        return _this;
+    }
+    return DocTable;
+}(Table_1.Table));
+var docTable = new DocTable();
+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;
+}());
+/** A driver that answers every query with the rows it was handed. */
+var RowsDriver = /** @class */ (function () {
+    function RowsDriver(rows) {
+        this.rows = rows;
+    }
+    RowsDriver.prototype.getDbName = function () {
+        return 'test';
+    };
+    RowsDriver.prototype.createDbIfNotExists = function () {
+        return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/];
+        }); });
+    };
+    RowsDriver.prototype.createDb = function () {
+        return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/];
+        }); });
+    };
+    RowsDriver.prototype.dropDb = function () {
+        return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
+            return [2 /*return*/];
+        }); });
+    };
+    RowsDriver.prototype.getTableManager = function () {
+        throw new Error('not used by these tests');
+    };
+    RowsDriver.prototype.runQuery = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, this.rows];
+            });
+        });
+    };
+    RowsDriver.prototype.runDml = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, 0];
+            });
+        });
+    };
+    RowsDriver.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()];
+                }
+            });
+        });
+    };
+    RowsDriver.prototype.getOperationDeadlineMs = function () {
+        return 1000;
+    };
+    return RowsDriver;
+}());
+var dbOver = function (rows) {
+    return new Db_1.Db(new RowsDriver(rows), function () { return docTable; }, new TestTransactionContextFactory(), true);
+};
+var storedRows = function (count) {
+    return Array.from({ length: count }, function (_, i) { return ({
+        id: "row-".concat(i),
+        created: new Date(1700000000000 + i),
+        updated: new Date(1700000000000 + i),
+        title: "title ".concat(i),
+        first: i,
+        second: i,
+    }); });
+};
+var objectCache = function () { return reflection_1.SourceRepository.get().objectCache; };
+var originalWatchers;
+// No reflection graph in a unit test: the watcher registry is empty by declaration.
+beforeAll(function () {
+    originalWatchers = objectCache()['@proteinjs/db/TableWatcher'];
+    objectCache()['@proteinjs/db/TableWatcher'] = [];
+    TableWatcherRunner_1.TableWatcherRunner.tableWatcherMap = undefined;
+});
+afterAll(function () {
+    if (originalWatchers) {
+        objectCache()['@proteinjs/db/TableWatcher'] = originalWatchers;
+    }
+    else {
+        delete objectCache()['@proteinjs/db/TableWatcher'];
+    }
+    TableWatcherRunner_1.TableWatcherRunner.tableWatcherMap = undefined;
+});
+var keyFor = function (owner, version) { return ({
+    owner: owner,
+    version: version,
+    cipherKey: (0, crypto_1.randomBytes)(32),
+    indexKey: (0, crypto_1.randomBytes)(32),
+}); };
+describe('a result set hydrates in one synchronous pass when no row needs an await', function () {
+    beforeEach(function () {
+        cellsRead.length = 0;
+        sentinelFired = false;
+    });
+    it('a query over plain rows never yields the event loop between rows', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var rows, records;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    rows = storedRows(200);
+                    return [4 /*yield*/, dbOver(rows).query(docTable, {})];
+                case 1:
+                    records = _a.sent();
+                    expect(records).toHaveLength(200);
+                    expect(records[199]).toMatchObject({ id: 'row-199', title: 'title 199', first: 199, second: 199 });
+                    // Every cell of every row was read before the microtask armed by the first cell could fire.
+                    expect(cellsRead).toHaveLength(400);
+                    expect(cellsRead.filter(function (cell) { return cell.sentinelFired; }).map(function (cell) { return "".concat(cell.column, ":").concat(cell.row); })).toEqual([]);
+                    expect(sentinelFired).toBe(true);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('the serializer answers a plain result set with the array itself, not a promise', function () {
+        var rows = storedRows(3);
+        var records = new Record_1.RecordSerializer(docTable).deserializeAll(rows);
+        expect(Array.isArray(records)).toBe(true);
+        expect(records.map(function (record) { return record.title; })).toEqual(['title 0', 'title 1', 'title 2']);
+    });
+    it('a column whose deserialize answers with a promise still settles, in column order', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var LaterColumn, LaterTable, laterTable, rows, settling, records;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    LaterColumn = /** @class */ (function () {
+                        function LaterColumn(name) {
+                            this.name = name;
+                        }
+                        LaterColumn.prototype.deserialize = function (storedValue) {
+                            return Promise.resolve(storedValue === null ? null : storedValue * 2);
+                        };
+                        return LaterColumn;
+                    }());
+                    LaterTable = /** @class */ (function (_super) {
+                        __extends(LaterTable, _super);
+                        function LaterTable() {
+                            var _this = _super !== null && _super.apply(this, arguments) || this;
+                            _this.name = 'hydration_later';
+                            _this.columns = (0, Record_1.withRecordColumns)({
+                                title: new Columns_1.StringColumn('title'),
+                                later: new LaterColumn('later'),
+                                after: new Columns_1.StringColumn('after'),
+                            });
+                            return _this;
+                        }
+                        return LaterTable;
+                    }(Table_1.Table));
+                    laterTable = new LaterTable();
+                    rows = [
+                        { id: 'a', created: new Date(), updated: new Date(), title: 'one', later: 21, after: 'x' },
+                        { id: 'b', created: new Date(), updated: new Date(), title: 'two', later: null, after: 'y' },
+                    ];
+                    settling = new Record_1.RecordSerializer(laterTable).deserializeAll(rows);
+                    expect(Array.isArray(settling)).toBe(false);
+                    return [4 /*yield*/, settling];
+                case 1:
+                    records = _a.sent();
+                    expect(records.map(function (record) { return record.later; })).toEqual([42, null]);
+                    expect(Object.keys(records[0])).toEqual(['id', 'created', 'updated', 'title', 'later', 'after']);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+    it('a row holding a ciphertext envelope takes the async road and decrypts; its plain neighbors ride along', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var key, envelope, keyRead, rows, settling, records;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    key = keyFor('owner-1', 4);
+                    envelope = new EncryptionEnvelope_1.EncryptionEnvelope();
+                    keyRead = jest.spyOn(DataKeyStore_1.DataKeyStore.prototype, 'getKeyByVersion').mockResolvedValue(key);
+                    _a.label = 1;
+                case 1:
+                    _a.trys.push([1, , 3, 4]);
+                    rows = storedRows(3);
+                    rows[1].title = envelope.encrypt('the plaintext', key);
+                    settling = new Record_1.RecordSerializer(docTable).deserializeAll(rows);
+                    expect(Array.isArray(settling)).toBe(false);
+                    return [4 /*yield*/, settling];
+                case 2:
+                    records = _a.sent();
+                    expect(records.map(function (record) { return record.title; })).toEqual(['title 0', 'the plaintext', 'title 2']);
+                    expect(keyRead).toHaveBeenCalledTimes(1);
+                    expect(keyRead).toHaveBeenCalledWith('owner-1', 4);
+                    // The plain rows were hydrated in the one pass; the envelope row landed when its key read settled.
+                    expect(cellsRead.map(function (cell) { return cell.row; })).toEqual([0, 0, 2, 2, 1, 1]);
+                    return [3 /*break*/, 4];
+                case 3:
+                    keyRead.mockRestore();
+                    return [7 /*endfinally*/];
+                case 4: return [2 /*return*/];
+            }
+        });
+    }); });
+    it('a stored column the table no longer declares is omitted; a column without deserialize passes its value through', function () { return __awaiter(void 0, void 0, void 0, function () {
+        var rows, record;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    rows = [
+                        { id: 'a', created: new Date(), updated: new Date(), title: 'one', first: 1, second: 1, retired: 'gone' },
+                    ];
+                    return [4 /*yield*/, new Record_1.RecordSerializer(docTable).deserializeAll(rows)];
+                case 1:
+                    record = (_a.sent())[0];
+                    expect(record).toMatchObject({ id: 'a', title: 'one', first: 1, second: 1 });
+                    expect('retired' in record).toBe(false);
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+});
+//# sourceMappingURL=SyncRowHydration.test.js.map