@proteinjs/db 1.28.1 → 1.29.1

package/dist/test/reusable/PreloadReferencesTests.js

@@ -0,0 +1,241 @@
+"use strict";
+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 });
+exports.preloadReferencesTests = void 0;
+var db_1 = require("@proteinjs/db");
+var DbTestEnvironment_1 = require("../util/DbTestEnvironment");
+var dynamicReferenceColumnTestTables_1 = require("../util/tables/dynamicReferenceColumnTestTables");
+var cascadeDeleteTestTables_1 = require("../util/tables/cascadeDeleteTestTables");
+/**
+ * Preload behavior tests: `preloadReferences` must hydrate every reference in the result set
+ * with ONE query per referenced table — batching is the point of the option (a 30-row window
+ * preloaded per-row is 30 serialized point reads). The assertions count driver round trips,
+ * the outcome that keeps preload cheap, and then verify hydration is complete (no further
+ * round trips to read every referenced object).
+ */
+var preloadReferencesTests = function (driver, dropTable) {
+    return function () {
+        // Counting proxy: every runQuery through the driver increments `queryCount`. Db reads
+        // nothing else off the driver during query execution that matters here; everything not
+        // overridden delegates to the real driver via the prototype chain.
+        var queryCount = 0;
+        var countingDriver = Object.create(driver, {
+            runQuery: {
+                value: function () {
+                    var args = [];
+                    for (var _i = 0; _i < arguments.length; _i++) {
+                        args[_i] = arguments[_i];
+                    }
+                    queryCount++;
+                    return driver.runQuery.apply(driver, args);
+                },
+            },
+        });
+        var db = new db_1.Db(countingDriver);
+        var testEnv = new DbTestEnvironment_1.DbTestEnvironment(driver, dropTable);
+        beforeAll(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, testEnv.beforeAll()];
+                case 1: return [2 /*return*/, _a.sent()];
+            }
+        }); }); }, 30000);
+        afterAll(function () { return __awaiter(void 0, void 0, void 0, function () { return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, testEnv.afterAll()];
+                case 1: return [2 /*return*/, _a.sent()];
+            }
+        }); }); }, 30000);
+        test('preload hydrates dynamic references with one query per referenced table', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var engineerA, engineerB, designer, employees, employeeTables, i, qb, assignments, queriesDuringPreload, names;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, db.insert(dynamicReferenceColumnTestTables_1.dynamicReferenceTestTables.Engineer, {
+                            name: 'preload-batch engineer A',
+                            yearsOfExperience: 3,
+                        })];
+                    case 1:
+                        engineerA = _a.sent();
+                        return [4 /*yield*/, db.insert(dynamicReferenceColumnTestTables_1.dynamicReferenceTestTables.Engineer, {
+                                name: 'preload-batch engineer B',
+                                yearsOfExperience: 7,
+                            })];
+                    case 2:
+                        engineerB = _a.sent();
+                        return [4 /*yield*/, db.insert(dynamicReferenceColumnTestTables_1.dynamicReferenceTestTables.Designer, {
+                                name: 'preload-batch designer',
+                                specialization: 'Motion',
+                            })];
+                    case 3:
+                        designer = _a.sent();
+                        employees = [engineerA, engineerB, designer];
+                        employeeTables = [
+                            dynamicReferenceColumnTestTables_1.dynamicReferenceTestTables.Engineer.name,
+                            dynamicReferenceColumnTestTables_1.dynamicReferenceTestTables.Engineer.name,
+                            dynamicReferenceColumnTestTables_1.dynamicReferenceTestTables.Designer.name,
+                        ];
+                        i = 0;
+                        _a.label = 4;
+                    case 4:
+                        if (!(i < employees.length)) return [3 /*break*/, 7];
+                        return [4 /*yield*/, db.insert(dynamicReferenceColumnTestTables_1.dynamicReferenceTestTables.ProjectAssignment, {
+                                projectName: "preload-batch project ".concat(i),
+                                employeeRef: new db_1.Reference(employeeTables[i], employees[i].id),
+                                startDate: '2026-01-01',
+                            })];
+                    case 5:
+                        _a.sent();
+                        _a.label = 6;
+                    case 6:
+                        i++;
+                        return [3 /*break*/, 4];
+                    case 7:
+                        qb = new db_1.QueryBuilderFactory()
+                            .getQueryBuilder(dynamicReferenceColumnTestTables_1.dynamicReferenceTestTables.ProjectAssignment)
+                            .condition({ field: 'projectName', operator: 'LIKE', value: 'preload-batch project %' });
+                        queryCount = 0;
+                        return [4 /*yield*/, db.query(dynamicReferenceColumnTestTables_1.dynamicReferenceTestTables.ProjectAssignment, qb, {
+                                preloadReferences: { enabled: true, includeColumns: ['employeeRef'] },
+                            })];
+                    case 8:
+                        assignments = _a.sent();
+                        queriesDuringPreload = queryCount;
+                        expect(assignments.length).toBe(3);
+                        // Hydration must be complete: every referenced object readable with ZERO further round trips.
+                        queryCount = 0;
+                        return [4 /*yield*/, Promise.all(assignments.map(function (assignment) { return assignment.employeeRef.get(); }))];
+                    case 9:
+                        names = (_a.sent())
+                            .map(function (employee) { return employee.name; })
+                            .sort();
+                        expect(names).toEqual(['preload-batch designer', 'preload-batch engineer A', 'preload-batch engineer B']);
+                        expect(queryCount).toBe(0);
+                        // One round trip for the assignments window, then one per referenced table
+                        // (engineers, designers) — never one per row.
+                        expect(queriesDuringPreload).toBe(3);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+        test('preload hydrates reference arrays with one query per referenced table', function () { return __awaiter(void 0, void 0, void 0, function () {
+            var memberIds, g, ids, m, member, g, qb, groups, queriesDuringPreload, g, members;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        memberIds = [];
+                        g = 0;
+                        _a.label = 1;
+                    case 1:
+                        if (!(g < 2)) return [3 /*break*/, 7];
+                        ids = [];
+                        m = 0;
+                        _a.label = 2;
+                    case 2:
+                        if (!(m < 2)) return [3 /*break*/, 5];
+                        return [4 /*yield*/, db.insert(cascadeDeleteTestTables_1.cascadeDeleteTestTables.MemberArr, {
+                                name: "preload-arr member ".concat(g, ".").concat(m),
+                            })];
+                    case 3:
+                        member = _a.sent();
+                        ids.push(member.id);
+                        _a.label = 4;
+                    case 4:
+                        m++;
+                        return [3 /*break*/, 2];
+                    case 5:
+                        memberIds.push(ids);
+                        _a.label = 6;
+                    case 6:
+                        g++;
+                        return [3 /*break*/, 1];
+                    case 7:
+                        g = 0;
+                        _a.label = 8;
+                    case 8:
+                        if (!(g < 2)) return [3 /*break*/, 11];
+                        return [4 /*yield*/, db.insert(cascadeDeleteTestTables_1.cascadeDeleteTestTables.GroupArr, {
+                                groupName: "preload-arr group ".concat(g),
+                                memberRefs: new db_1.ReferenceArray(cascadeDeleteTestTables_1.cascadeDeleteTestTables.MemberArr.name, memberIds[g]),
+                            })];
+                    case 9:
+                        _a.sent();
+                        _a.label = 10;
+                    case 10:
+                        g++;
+                        return [3 /*break*/, 8];
+                    case 11:
+                        qb = new db_1.QueryBuilderFactory()
+                            .getQueryBuilder(cascadeDeleteTestTables_1.cascadeDeleteTestTables.GroupArr)
+                            .condition({ field: 'groupName', operator: 'LIKE', value: 'preload-arr group %' })
+                            .sort([{ field: 'groupName', desc: false }]);
+                        queryCount = 0;
+                        return [4 /*yield*/, db.query(cascadeDeleteTestTables_1.cascadeDeleteTestTables.GroupArr, qb, {
+                                preloadReferences: { enabled: true },
+                            })];
+                    case 12:
+                        groups = _a.sent();
+                        queriesDuringPreload = queryCount;
+                        expect(groups.length).toBe(2);
+                        // Hydration must be complete AND ordered per each array's _ids, with zero further round trips.
+                        queryCount = 0;
+                        g = 0;
+                        _a.label = 13;
+                    case 13:
+                        if (!(g < 2)) return [3 /*break*/, 16];
+                        return [4 /*yield*/, groups[g].memberRefs.get()];
+                    case 14:
+                        members = _a.sent();
+                        expect(members.map(function (member) { return member.name; })).toEqual([
+                            "preload-arr member ".concat(g, ".0"),
+                            "preload-arr member ".concat(g, ".1"),
+                        ]);
+                        _a.label = 15;
+                    case 15:
+                        g++;
+                        return [3 /*break*/, 13];
+                    case 16:
+                        expect(queryCount).toBe(0);
+                        // One round trip for the groups, one for ALL members across both arrays.
+                        expect(queriesDuringPreload).toBe(2);
+                        return [2 /*return*/];
+                }
+            });
+        }); });
+    };
+};
+exports.preloadReferencesTests = preloadReferencesTests;
+//# sourceMappingURL=PreloadReferencesTests.js.map

package/dist/test/reusable/PreloadReferencesTests.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PreloadReferencesTests.js","sourceRoot":"","sources":["../../../test/reusable/PreloadReferencesTests.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oCAAoG;AACpG,+DAA8D;AAC9D,oGAA6F;AAC7F,kFAAiF;AAEjF;;;;;;GAMG;AACI,IAAM,sBAAsB,GAAG,UAAC,MAAgB,EAAE,SAA+C;IACtG,OAAO;QACL,sFAAsF;QACtF,uFAAuF;QACvF,mEAAmE;QACnE,IAAI,UAAU,GAAG,CAAC,CAAC;QACnB,IAAM,cAAc,GAAa,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE;YACrD,QAAQ,EAAE;gBACR,KAAK,EAAE;oBAAC,cAAkB;yBAAlB,UAAkB,EAAlB,qBAAkB,EAAlB,IAAkB;wBAAlB,yBAAkB;;oBACxB,UAAU,EAAE,CAAC;oBACb,OAAQ,MAAM,CAAC,QAAkD,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBACxF,CAAC;aACF;SACF,CAAC,CAAC;QACH,IAAM,EAAE,GAAG,IAAI,OAAE,CAAC,cAAc,CAAC,CAAC;QAClC,IAAM,OAAO,GAAG,IAAI,qCAAiB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAEzD,SAAS,CAAC;;wBAAY,qBAAM,OAAO,CAAC,SAAS,EAAE,EAAA;wBAAzB,sBAAA,SAAyB,EAAA;;iBAAA,EAAE,KAAK,CAAC,CAAC;QACxD,QAAQ,CAAC;;wBAAY,qBAAM,OAAO,CAAC,QAAQ,EAAE,EAAA;wBAAxB,sBAAA,SAAwB,EAAA;;iBAAA,EAAE,KAAK,CAAC,CAAC;QAEtD,IAAI,CAAC,yEAAyE,EAAE;;;;4BAC5D,qBAAM,EAAE,CAAC,MAAM,CAAC,6DAA0B,CAAC,QAAQ,EAAE;4BACrE,IAAI,EAAE,0BAA0B;4BAChC,iBAAiB,EAAE,CAAC;yBACrB,CAAC,EAAA;;wBAHI,SAAS,GAAG,SAGhB;wBACgB,qBAAM,EAAE,CAAC,MAAM,CAAC,6DAA0B,CAAC,QAAQ,EAAE;gCACrE,IAAI,EAAE,0BAA0B;gCAChC,iBAAiB,EAAE,CAAC;6BACrB,CAAC,EAAA;;wBAHI,SAAS,GAAG,SAGhB;wBACe,qBAAM,EAAE,CAAC,MAAM,CAAC,6DAA0B,CAAC,QAAQ,EAAE;gCACpE,IAAI,EAAE,wBAAwB;gCAC9B,cAAc,EAAE,QAAQ;6BACzB,CAAC,EAAA;;wBAHI,QAAQ,GAAG,SAGf;wBACI,SAAS,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,QAAQ,CAAC,CAAC;wBAC7C,cAAc,GAAG;4BACrB,6DAA0B,CAAC,QAAQ,CAAC,IAAI;4BACxC,6DAA0B,CAAC,QAAQ,CAAC,IAAI;4BACxC,6DAA0B,CAAC,QAAQ,CAAC,IAAI;yBACzC,CAAC;wBACO,CAAC,GAAG,CAAC;;;6BAAE,CAAA,CAAC,GAAG,SAAS,CAAC,MAAM,CAAA;wBAClC,qBAAM,EAAE,CAAC,MAAM,CAAC,6DAA0B,CAAC,iBAAiB,EAAE;gCAC5D,WAAW,EAAE,gCAAyB,CAAC,CAAE;gCACzC,WAAW,EAAE,IAAI,cAAS,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gCAC9D,SAAS,EAAE,YAAY;6BACxB,CAAC,EAAA;;wBAJF,SAIE,CAAC;;;wBALiC,CAAC,EAAE,CAAA;;;wBAQnC,EAAE,GAAG,IAAI,wBAAmB,EAAE;6BACjC,eAAe,CAAC,6DAA0B,CAAC,iBAAiB,CAAC;6BAC7D,SAAS,CAAC,EAAE,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,yBAAyB,EAAE,CAAC,CAAC;wBAC3F,UAAU,GAAG,CAAC,CAAC;wBACK,qBAAM,EAAE,CAAC,KAAK,CAAC,6DAA0B,CAAC,iBAAiB,EAAE,EAAE,EAAE;gCACnF,iBAAiB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,CAAC,aAAa,CAAC,EAAE;6BACtE,CAAC,EAAA;;wBAFI,WAAW,GAAG,SAElB;wBACI,oBAAoB,GAAG,UAAU,CAAC;wBAExC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;wBACnC,8FAA8F;wBAC9F,UAAU,GAAG,CAAC,CAAC;wBACA,qBAAM,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,UAAC,UAAU,IAAK,OAAA,UAAU,CAAC,WAAY,CAAC,GAAG,EAAE,EAA7B,CAA6B,CAAC,CAAC,EAAA;;wBAA1F,KAAK,GAAG,CAAC,SAAiF,CAAC;6BAC9F,GAAG,CAAC,UAAC,QAAQ,IAAK,OAAA,QAAS,CAAC,IAAI,EAAd,CAAc,CAAC;6BACjC,IAAI,EAAE;wBACT,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,wBAAwB,EAAE,0BAA0B,EAAE,0BAA0B,CAAC,CAAC,CAAC;wBAC1G,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;wBAC3B,2EAA2E;wBAC3E,8CAA8C;wBAC9C,MAAM,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;;;;aACtC,CAAC,CAAC;QAEH,IAAI,CAAC,uEAAuE,EAAE;;;;;wBACtE,SAAS,GAAe,EAAE,CAAC;wBACxB,CAAC,GAAG,CAAC;;;6BAAE,CAAA,CAAC,GAAG,CAAC,CAAA;wBACb,GAAG,GAAa,EAAE,CAAC;wBAChB,CAAC,GAAG,CAAC;;;6BAAE,CAAA,CAAC,GAAG,CAAC,CAAA;wBACJ,qBAAM,EAAE,CAAC,MAAM,CAAC,iDAAuB,CAAC,SAAS,EAAE;gCAChE,IAAI,EAAE,6BAAsB,CAAC,cAAI,CAAC,CAAE;6BACrC,CAAC,EAAA;;wBAFI,MAAM,GAAG,SAEb;wBACF,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;;;wBAJC,CAAC,EAAE,CAAA;;;wBAM1B,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;;;wBARC,CAAC,EAAE,CAAA;;;wBAUjB,CAAC,GAAG,CAAC;;;6BAAE,CAAA,CAAC,GAAG,CAAC,CAAA;wBACnB,qBAAM,EAAE,CAAC,MAAM,CAAC,iDAAuB,CAAC,QAAQ,EAAE;gCAChD,SAAS,EAAE,4BAAqB,CAAC,CAAE;gCACnC,UAAU,EAAE,IAAI,mBAAc,CAAC,iDAAuB,CAAC,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;6BACrF,CAAC,EAAA;;wBAHF,SAGE,CAAC;;;wBAJkB,CAAC,EAAE,CAAA;;;wBAOpB,EAAE,GAAG,IAAI,wBAAmB,EAAE;6BACjC,eAAe,CAAC,iDAAuB,CAAC,QAAQ,CAAC;6BACjD,SAAS,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,qBAAqB,EAAE,CAAC;6BACjF,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;wBAC/C,UAAU,GAAG,CAAC,CAAC;wBACA,qBAAM,EAAE,CAAC,KAAK,CAAC,iDAAuB,CAAC,QAAQ,EAAE,EAAE,EAAE;gCAClE,iBAAiB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE;6BACrC,CAAC,EAAA;;wBAFI,MAAM,GAAG,SAEb;wBACI,oBAAoB,GAAG,UAAU,CAAC;wBAExC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;wBAC9B,+FAA+F;wBAC/F,UAAU,GAAG,CAAC,CAAC;wBACN,CAAC,GAAG,CAAC;;;6BAAE,CAAA,CAAC,GAAG,CAAC,CAAA;wBACH,qBAAM,MAAM,CAAC,CAAC,CAAC,CAAC,UAAW,CAAC,GAAG,EAAE,EAAA;;wBAA3C,OAAO,GAAG,SAAiC;wBACjD,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,UAAC,MAAM,IAAK,OAAA,MAAM,CAAC,IAAI,EAAX,CAAW,CAAC,CAAC,CAAC,OAAO,CAAC;4BACnD,6BAAsB,CAAC,OAAI;4BAC3B,6BAAsB,CAAC,OAAI;yBAC5B,CAAC,CAAC;;;wBALkB,CAAC,EAAE,CAAA;;;wBAO1B,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;wBAC3B,yEAAyE;wBACzE,MAAM,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;;;;aACtC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC,CAAC;AAjHW,QAAA,sBAAsB,0BAiHjC"}