@terreno/test 0.22.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bunfig.toml +3 -0
- package/dist/cache/mongoTestCache.d.ts +16 -0
- package/dist/cache/mongoTestCache.js +541 -0
- package/dist/env/setTerrenoTestEnv.d.ts +13 -0
- package/dist/env/setTerrenoTestEnv.js +89 -0
- package/dist/http/authAsUser.d.ts +17 -0
- package/dist/http/authAsUser.js +165 -0
- package/dist/http/authAsUser.test.d.ts +1 -0
- package/dist/http/authAsUser.test.js +93 -0
- package/dist/http/getBaseServer.d.ts +9 -0
- package/dist/http/getBaseServer.js +33 -0
- package/dist/http/getBaseServer.test.d.ts +1 -0
- package/dist/http/getBaseServer.test.js +76 -0
- package/dist/index.d.ts +14 -0
- package/dist/index.js +46 -0
- package/dist/logging/setupEnvironment.d.ts +2 -0
- package/dist/logging/setupEnvironment.js +19 -0
- package/dist/logging/silenceLogs.d.ts +20 -0
- package/dist/logging/silenceLogs.js +168 -0
- package/dist/logging/testLogger.d.ts +7 -0
- package/dist/logging/testLogger.js +22 -0
- package/dist/mocks/sentryBun.d.ts +2 -0
- package/dist/mocks/sentryBun.js +136 -0
- package/dist/mongo/connection.d.ts +16 -0
- package/dist/mongo/connection.js +134 -0
- package/dist/mongo/connection.test.d.ts +1 -0
- package/dist/mongo/connection.test.js +28 -0
- package/dist/mongo/ensureMongoBinary.d.ts +6 -0
- package/dist/mongo/ensureMongoBinary.js +104 -0
- package/dist/mongo/mongoServer.d.ts +26 -0
- package/dist/mongo/mongoServer.js +424 -0
- package/dist/preload/defaultBackendPreload.d.ts +1 -0
- package/dist/preload/defaultBackendPreload.js +8 -0
- package/dist/preload/memoryMongo.d.ts +0 -0
- package/dist/preload/memoryMongo.js +2 -0
- package/dist/preload/registerBackendPreload.d.ts +33 -0
- package/dist/preload/registerBackendPreload.js +302 -0
- package/dist/transaction/testTransaction.d.ts +91 -0
- package/dist/transaction/testTransaction.js +719 -0
- package/dist/utils/ensureAllIndexes.d.ts +2 -0
- package/dist/utils/ensureAllIndexes.js +84 -0
- package/dist/utils/timeout.d.ts +1 -0
- package/dist/utils/timeout.js +45 -0
- package/dist/utils/waitForDocuments.d.ts +13 -0
- package/dist/utils/waitForDocuments.js +127 -0
- package/package.json +65 -0
- package/src/cache/mongoTestCache.ts +311 -0
- package/src/env/setTerrenoTestEnv.ts +50 -0
- package/src/http/authAsUser.test.ts +40 -0
- package/src/http/authAsUser.ts +59 -0
- package/src/http/getBaseServer.test.ts +30 -0
- package/src/http/getBaseServer.ts +34 -0
- package/src/index.ts +53 -0
- package/src/logging/setupEnvironment.ts +15 -0
- package/src/logging/silenceLogs.ts +134 -0
- package/src/logging/testLogger.ts +19 -0
- package/src/mocks/sentryBun.ts +140 -0
- package/src/mongo/connection.test.ts +30 -0
- package/src/mongo/connection.ts +65 -0
- package/src/mongo/ensureMongoBinary.ts +25 -0
- package/src/mongo/mongoServer.ts +214 -0
- package/src/preload/defaultBackendPreload.ts +7 -0
- package/src/preload/memoryMongo.ts +1 -0
- package/src/preload/registerBackendPreload.ts +174 -0
- package/src/transaction/testTransaction.ts +524 -0
- package/src/utils/ensureAllIndexes.ts +11 -0
- package/src/utils/timeout.ts +3 -0
- package/src/utils/waitForDocuments.ts +50 -0
- package/tsconfig.json +31 -0
|
@@ -0,0 +1,302 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __assign = (this && this.__assign) || function () {
|
|
3
|
+
__assign = Object.assign || function(t) {
|
|
4
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
5
|
+
s = arguments[i];
|
|
6
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
7
|
+
t[p] = s[p];
|
|
8
|
+
}
|
|
9
|
+
return t;
|
|
10
|
+
};
|
|
11
|
+
return __assign.apply(this, arguments);
|
|
12
|
+
};
|
|
13
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
14
|
+
if (k2 === undefined) k2 = k;
|
|
15
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
16
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
17
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
18
|
+
}
|
|
19
|
+
Object.defineProperty(o, k2, desc);
|
|
20
|
+
}) : (function(o, m, k, k2) {
|
|
21
|
+
if (k2 === undefined) k2 = k;
|
|
22
|
+
o[k2] = m[k];
|
|
23
|
+
}));
|
|
24
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
25
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
26
|
+
}) : function(o, v) {
|
|
27
|
+
o["default"] = v;
|
|
28
|
+
});
|
|
29
|
+
var __importStar = (this && this.__importStar) || (function () {
|
|
30
|
+
var ownKeys = function(o) {
|
|
31
|
+
ownKeys = Object.getOwnPropertyNames || function (o) {
|
|
32
|
+
var ar = [];
|
|
33
|
+
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
|
|
34
|
+
return ar;
|
|
35
|
+
};
|
|
36
|
+
return ownKeys(o);
|
|
37
|
+
};
|
|
38
|
+
return function (mod) {
|
|
39
|
+
if (mod && mod.__esModule) return mod;
|
|
40
|
+
var result = {};
|
|
41
|
+
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
|
|
42
|
+
__setModuleDefault(result, mod);
|
|
43
|
+
return result;
|
|
44
|
+
};
|
|
45
|
+
})();
|
|
46
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
47
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
48
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
49
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
50
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
51
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
52
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
53
|
+
});
|
|
54
|
+
};
|
|
55
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
56
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
|
|
57
|
+
return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
58
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
59
|
+
function step(op) {
|
|
60
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
61
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
62
|
+
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;
|
|
63
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
64
|
+
switch (op[0]) {
|
|
65
|
+
case 0: case 1: t = op; break;
|
|
66
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
67
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
68
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
69
|
+
default:
|
|
70
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
71
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
72
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
73
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
74
|
+
if (t[2]) _.ops.pop();
|
|
75
|
+
_.trys.pop(); continue;
|
|
76
|
+
}
|
|
77
|
+
op = body.call(thisArg, _);
|
|
78
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
79
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
80
|
+
}
|
|
81
|
+
};
|
|
82
|
+
var __rest = (this && this.__rest) || function (s, e) {
|
|
83
|
+
var t = {};
|
|
84
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
85
|
+
t[p] = s[p];
|
|
86
|
+
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
87
|
+
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
88
|
+
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
89
|
+
t[p[i]] = s[p[i]];
|
|
90
|
+
}
|
|
91
|
+
return t;
|
|
92
|
+
};
|
|
93
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
94
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
95
|
+
};
|
|
96
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
97
|
+
exports.registerSimpleMongoPreload = exports.registerBackendPreload = void 0;
|
|
98
|
+
var bun_test_1 = require("bun:test");
|
|
99
|
+
var mongoose_1 = __importDefault(require("mongoose"));
|
|
100
|
+
var testLogger_1 = require("../logging/testLogger");
|
|
101
|
+
var setTerrenoTestEnv_1 = require("../env/setTerrenoTestEnv");
|
|
102
|
+
var silenceLogs_1 = require("../logging/silenceLogs");
|
|
103
|
+
var sentryBun_1 = require("../mocks/sentryBun");
|
|
104
|
+
var mongoServer_1 = require("../mongo/mongoServer");
|
|
105
|
+
var testTransaction_1 = require("../transaction/testTransaction");
|
|
106
|
+
var shouldDisableDb = function (options) {
|
|
107
|
+
if (options.disableDb) {
|
|
108
|
+
return true;
|
|
109
|
+
}
|
|
110
|
+
return process.env.BUN_TEST_DISABLE_DB === "true";
|
|
111
|
+
};
|
|
112
|
+
var isServerStarted = false;
|
|
113
|
+
/**
|
|
114
|
+
* Registers Bun test lifecycle hooks for Terreno backend packages.
|
|
115
|
+
* Call once from a package preload file (e.g. `api/src/tests/bunSetup.ts`).
|
|
116
|
+
*/
|
|
117
|
+
var registerBackendPreload = function (options) {
|
|
118
|
+
var _a;
|
|
119
|
+
if (options === void 0) { options = {}; }
|
|
120
|
+
var connectMongoInBeforeAll = (_a = options.connectMongoInBeforeAll) !== null && _a !== void 0 ? _a : true;
|
|
121
|
+
if (options.sentryMock !== false) {
|
|
122
|
+
(0, sentryBun_1.registerSentryBunMock)();
|
|
123
|
+
}
|
|
124
|
+
var logSilencer;
|
|
125
|
+
if (options.silenceLogs !== false) {
|
|
126
|
+
var silencerOptions = typeof options.silenceLogs === "object" ? options.silenceLogs : {};
|
|
127
|
+
if (connectMongoInBeforeAll) {
|
|
128
|
+
(0, silenceLogs_1.registerLogSilencing)(silencerOptions);
|
|
129
|
+
}
|
|
130
|
+
else {
|
|
131
|
+
logSilencer = (0, silenceLogs_1.createLogSilencer)(silencerOptions);
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
if (options.useTransactions) {
|
|
135
|
+
(0, testTransaction_1.installTransactionPatches)();
|
|
136
|
+
}
|
|
137
|
+
if (!shouldDisableDb(options)) {
|
|
138
|
+
(0, bun_test_1.beforeAll)(function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
139
|
+
var _a;
|
|
140
|
+
return __generator(this, function (_b) {
|
|
141
|
+
switch (_b.label) {
|
|
142
|
+
case 0:
|
|
143
|
+
if (!connectMongoInBeforeAll) return [3 /*break*/, 8];
|
|
144
|
+
if (!!isServerStarted) return [3 /*break*/, 6];
|
|
145
|
+
(0, setTerrenoTestEnv_1.setTerrenoTestEnv)(options.testEnv);
|
|
146
|
+
return [4 /*yield*/, (0, mongoServer_1.startMongoServer)(options.mongo)];
|
|
147
|
+
case 1:
|
|
148
|
+
_b.sent();
|
|
149
|
+
if (!options.loadModels) return [3 /*break*/, 3];
|
|
150
|
+
return [4 /*yield*/, options.loadModels()];
|
|
151
|
+
case 2:
|
|
152
|
+
_b.sent();
|
|
153
|
+
_b.label = 3;
|
|
154
|
+
case 3:
|
|
155
|
+
if (!options.loadTestDataFromCache) return [3 /*break*/, 5];
|
|
156
|
+
return [4 /*yield*/, options.loadTestDataFromCache()];
|
|
157
|
+
case 4:
|
|
158
|
+
_b.sent();
|
|
159
|
+
_b.label = 5;
|
|
160
|
+
case 5:
|
|
161
|
+
isServerStarted = true;
|
|
162
|
+
return [3 /*break*/, 8];
|
|
163
|
+
case 6: return [4 /*yield*/, (0, mongoServer_1.initializeModels)()];
|
|
164
|
+
case 7:
|
|
165
|
+
_b.sent();
|
|
166
|
+
_b.label = 8;
|
|
167
|
+
case 8: return [4 /*yield*/, ((_a = options.onBeforeAll) === null || _a === void 0 ? void 0 : _a.call(options))];
|
|
168
|
+
case 9:
|
|
169
|
+
_b.sent();
|
|
170
|
+
return [2 /*return*/];
|
|
171
|
+
}
|
|
172
|
+
});
|
|
173
|
+
}); }, 60000);
|
|
174
|
+
if (connectMongoInBeforeAll) {
|
|
175
|
+
(0, bun_test_1.afterAll)(function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
176
|
+
var _a;
|
|
177
|
+
return __generator(this, function (_b) {
|
|
178
|
+
switch (_b.label) {
|
|
179
|
+
case 0: return [4 /*yield*/, ((_a = options.onAfterAll) === null || _a === void 0 ? void 0 : _a.call(options))];
|
|
180
|
+
case 1:
|
|
181
|
+
_b.sent();
|
|
182
|
+
return [4 /*yield*/, (0, mongoServer_1.stopMongoServer)()];
|
|
183
|
+
case 2:
|
|
184
|
+
_b.sent();
|
|
185
|
+
return [2 /*return*/];
|
|
186
|
+
}
|
|
187
|
+
});
|
|
188
|
+
}); });
|
|
189
|
+
}
|
|
190
|
+
else {
|
|
191
|
+
(0, bun_test_1.afterAll)(function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
192
|
+
var _a;
|
|
193
|
+
return __generator(this, function (_b) {
|
|
194
|
+
switch (_b.label) {
|
|
195
|
+
case 0: return [4 /*yield*/, ((_a = options.onAfterAll) === null || _a === void 0 ? void 0 : _a.call(options))];
|
|
196
|
+
case 1:
|
|
197
|
+
_b.sent();
|
|
198
|
+
return [2 /*return*/];
|
|
199
|
+
}
|
|
200
|
+
});
|
|
201
|
+
}); });
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
(0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
205
|
+
var _a;
|
|
206
|
+
return __generator(this, function (_b) {
|
|
207
|
+
switch (_b.label) {
|
|
208
|
+
case 0:
|
|
209
|
+
(0, setTerrenoTestEnv_1.setTerrenoTestEnv)(options.testEnv);
|
|
210
|
+
logSilencer === null || logSilencer === void 0 ? void 0 : logSilencer.reapply();
|
|
211
|
+
logSilencer === null || logSilencer === void 0 ? void 0 : logSilencer.clearLogs();
|
|
212
|
+
if (!options.useTransactions) return [3 /*break*/, 2];
|
|
213
|
+
return [4 /*yield*/, (0, testTransaction_1.startTestTransaction)()];
|
|
214
|
+
case 1:
|
|
215
|
+
_b.sent();
|
|
216
|
+
_b.label = 2;
|
|
217
|
+
case 2: return [4 /*yield*/, ((_a = options.onBeforeEach) === null || _a === void 0 ? void 0 : _a.call(options))];
|
|
218
|
+
case 3:
|
|
219
|
+
_b.sent();
|
|
220
|
+
return [2 /*return*/];
|
|
221
|
+
}
|
|
222
|
+
});
|
|
223
|
+
}); });
|
|
224
|
+
(0, bun_test_1.afterEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
225
|
+
var _a;
|
|
226
|
+
return __generator(this, function (_b) {
|
|
227
|
+
switch (_b.label) {
|
|
228
|
+
case 0:
|
|
229
|
+
if (!options.useTransactions) return [3 /*break*/, 2];
|
|
230
|
+
return [4 /*yield*/, (0, testTransaction_1.abortTestTransaction)()];
|
|
231
|
+
case 1:
|
|
232
|
+
_b.sent();
|
|
233
|
+
_b.label = 2;
|
|
234
|
+
case 2:
|
|
235
|
+
(0, bun_test_1.setSystemTime)();
|
|
236
|
+
bun_test_1.mock.clearAllMocks();
|
|
237
|
+
bun_test_1.jest.restoreAllMocks();
|
|
238
|
+
logSilencer === null || logSilencer === void 0 ? void 0 : logSilencer.clearLogs();
|
|
239
|
+
return [4 /*yield*/, ((_a = options.onAfterEach) === null || _a === void 0 ? void 0 : _a.call(options))];
|
|
240
|
+
case 3:
|
|
241
|
+
_b.sent();
|
|
242
|
+
(0, setTerrenoTestEnv_1.setTerrenoTestEnv)(options.testEnv);
|
|
243
|
+
return [2 /*return*/];
|
|
244
|
+
}
|
|
245
|
+
});
|
|
246
|
+
}); });
|
|
247
|
+
};
|
|
248
|
+
exports.registerBackendPreload = registerBackendPreload;
|
|
249
|
+
var registerSimpleMongoPreload = function (options) {
|
|
250
|
+
if (options === void 0) { options = {}; }
|
|
251
|
+
var memoryMongo;
|
|
252
|
+
var _a = options.defaultLocalMongoUri, defaultLocalMongoUri = _a === void 0 ? "mongodb://127.0.0.1/terreno?&connectTimeoutMS=360000" : _a, preloadOptions = __rest(options, ["defaultLocalMongoUri"]);
|
|
253
|
+
(0, exports.registerBackendPreload)(__assign(__assign({}, preloadOptions), { connectMongoInBeforeAll: false, onAfterAll: function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
254
|
+
var _a;
|
|
255
|
+
return __generator(this, function (_b) {
|
|
256
|
+
switch (_b.label) {
|
|
257
|
+
case 0: return [4 /*yield*/, mongoose_1.default.connection.close()];
|
|
258
|
+
case 1:
|
|
259
|
+
_b.sent();
|
|
260
|
+
if (!memoryMongo) return [3 /*break*/, 3];
|
|
261
|
+
return [4 /*yield*/, memoryMongo.stop()];
|
|
262
|
+
case 2:
|
|
263
|
+
_b.sent();
|
|
264
|
+
_b.label = 3;
|
|
265
|
+
case 3: return [4 /*yield*/, ((_a = preloadOptions.onAfterAll) === null || _a === void 0 ? void 0 : _a.call(preloadOptions))];
|
|
266
|
+
case 4:
|
|
267
|
+
_b.sent();
|
|
268
|
+
return [2 /*return*/];
|
|
269
|
+
}
|
|
270
|
+
});
|
|
271
|
+
}); }, onBeforeAll: function () { return __awaiter(void 0, void 0, void 0, function () {
|
|
272
|
+
var uri, MongoMemoryServer, connectUri;
|
|
273
|
+
var _a, _b;
|
|
274
|
+
return __generator(this, function (_c) {
|
|
275
|
+
switch (_c.label) {
|
|
276
|
+
case 0:
|
|
277
|
+
uri = (_a = process.env.TERRENO_TEST_MONGODB_URI) === null || _a === void 0 ? void 0 : _a.trim();
|
|
278
|
+
if (!(!uri && process.env.TERRENO_TEST_USE_MEMORY_MONGO === "true")) return [3 /*break*/, 3];
|
|
279
|
+
return [4 /*yield*/, Promise.resolve().then(function () { return __importStar(require("mongodb-memory-server")); })];
|
|
280
|
+
case 1:
|
|
281
|
+
MongoMemoryServer = (_c.sent()).MongoMemoryServer;
|
|
282
|
+
return [4 /*yield*/, MongoMemoryServer.create()];
|
|
283
|
+
case 2:
|
|
284
|
+
memoryMongo = _c.sent();
|
|
285
|
+
uri = memoryMongo.getUri();
|
|
286
|
+
_c.label = 3;
|
|
287
|
+
case 3:
|
|
288
|
+
connectUri = uri !== null && uri !== void 0 ? uri : defaultLocalMongoUri;
|
|
289
|
+
if (!(mongoose_1.default.connection.readyState === 0)) return [3 /*break*/, 5];
|
|
290
|
+
return [4 /*yield*/, mongoose_1.default.connect(connectUri).catch(testLogger_1.testLogger.catch)];
|
|
291
|
+
case 4:
|
|
292
|
+
_c.sent();
|
|
293
|
+
_c.label = 5;
|
|
294
|
+
case 5: return [4 /*yield*/, ((_b = preloadOptions.onBeforeAll) === null || _b === void 0 ? void 0 : _b.call(preloadOptions))];
|
|
295
|
+
case 6:
|
|
296
|
+
_c.sent();
|
|
297
|
+
return [2 /*return*/];
|
|
298
|
+
}
|
|
299
|
+
});
|
|
300
|
+
}); }, useTransactions: false }));
|
|
301
|
+
};
|
|
302
|
+
exports.registerSimpleMongoPreload = registerSimpleMongoPreload;
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Transaction-based test isolation for MongoDB.
|
|
3
|
+
*
|
|
4
|
+
* Instead of clearing and reloading all collections before every test,
|
|
5
|
+
* this module wraps each test in a MongoDB transaction that is aborted
|
|
6
|
+
* after the test completes. This rolls back all changes made during the
|
|
7
|
+
* test, leaving the database in its original state for the next test.
|
|
8
|
+
*
|
|
9
|
+
* How it works:
|
|
10
|
+
* 1. Mongoose operations (Query.exec, Model.save, Aggregate.exec, etc.)
|
|
11
|
+
* are monkey-patched to inject the current test session when active.
|
|
12
|
+
* 2. Before each test, a session is started and a transaction is begun.
|
|
13
|
+
* 3. After each test, the transaction is aborted and the session is ended.
|
|
14
|
+
* 4. All DB operations during the test see the pre-test snapshot and any
|
|
15
|
+
* writes made within the transaction, but nothing is persisted.
|
|
16
|
+
*
|
|
17
|
+
* Session reuse: a single MongoDB session is reused across all tests within
|
|
18
|
+
* a worker to avoid transaction number mismatches caused by the MongoDB driver's
|
|
19
|
+
* server session pool. When sessions are ended and reacquired from the pool,
|
|
20
|
+
* in-flight operations from a previous test can arrive with a stale transaction
|
|
21
|
+
* number, causing NoSuchTransaction errors. Reusing one session avoids this.
|
|
22
|
+
*
|
|
23
|
+
* Operation serialization: MongoDB does not support concurrent operations on
|
|
24
|
+
* the same session within a transaction. When app code uses Promise.all() to
|
|
25
|
+
* run DB operations in parallel, concurrent operations on the same session
|
|
26
|
+
* cause TransientTransactionError / NoSuchTransaction. We solve this with a
|
|
27
|
+
* reentrant async mutex:
|
|
28
|
+
* - Top-level operations (the ones fired by Promise.all) are serialized
|
|
29
|
+
* - Nested operations (e.g. pre-save hooks that do queries) detect they're
|
|
30
|
+
* already inside a serialized block and skip the mutex, preventing deadlocks
|
|
31
|
+
* - AsyncLocalStorage tracks the serialization context across the async chain
|
|
32
|
+
*
|
|
33
|
+
* Limitations:
|
|
34
|
+
* - App code that creates its own sessions (e.g. explicit transactions in
|
|
35
|
+
* route handlers) will have those sessions' operations redirected through
|
|
36
|
+
* the test session. The app's own commit/abort calls become no-ops.
|
|
37
|
+
* - Native driver operations (mongoose.connection.db.collection(...)) are
|
|
38
|
+
* NOT patched. Only Mongoose-level operations are covered.
|
|
39
|
+
*/
|
|
40
|
+
import type { ClientSession } from "mongoose";
|
|
41
|
+
/** Returns the current test session, or null if not in a test transaction. */
|
|
42
|
+
export declare const getTestSession: () => ClientSession | null;
|
|
43
|
+
/**
|
|
44
|
+
* Starts a new test transaction. Call in beforeEach.
|
|
45
|
+
*
|
|
46
|
+
* Reuses the existing MongoDB session when possible. A new session is only
|
|
47
|
+
* created on the very first call or after the previous session has been
|
|
48
|
+
* explicitly ended (e.g., due to an error).
|
|
49
|
+
*/
|
|
50
|
+
export declare const startTestTransaction: () => Promise<void>;
|
|
51
|
+
/**
|
|
52
|
+
* Aborts the current test transaction. Call in afterEach.
|
|
53
|
+
*
|
|
54
|
+
* The session is intentionally kept alive (not ended) so it can be reused by
|
|
55
|
+
* the next test. This avoids returning the session to the driver's server
|
|
56
|
+
* session pool, which prevents transaction number mismatches when in-flight
|
|
57
|
+
* operations from a previous test complete after the session has been recycled.
|
|
58
|
+
*/
|
|
59
|
+
export declare const abortTestTransaction: () => Promise<void>;
|
|
60
|
+
/**
|
|
61
|
+
* Drops the cached test session after an out-of-band mongoose reconnect.
|
|
62
|
+
*
|
|
63
|
+
* Reconnects can swap the underlying MongoClient, which invalidates any active
|
|
64
|
+
* ClientSession. Clearing here prevents subsequent tests from reusing a stale
|
|
65
|
+
* or expired session.
|
|
66
|
+
*/
|
|
67
|
+
export declare const resetTestSessionAfterReconnect: () => Promise<void>;
|
|
68
|
+
/**
|
|
69
|
+
* Installs Mongoose monkey-patches that inject the test session into all DB operations.
|
|
70
|
+
*
|
|
71
|
+
* Patches are idempotent — calling this multiple times is safe.
|
|
72
|
+
* The patches only activate when currentTestSession is non-null (i.e., during a test).
|
|
73
|
+
* All operations are serialized through the async mutex to prevent concurrent
|
|
74
|
+
* operations on the same MongoDB session.
|
|
75
|
+
*
|
|
76
|
+
* Patched operations:
|
|
77
|
+
* - Query.prototype.exec — covers find, findOne, updateOne, deleteMany, countDocuments, etc.
|
|
78
|
+
* - Model.prototype.save and $save — covers save() and create() (Model.create calls $save)
|
|
79
|
+
* - Aggregate.prototype.exec — covers aggregation pipelines
|
|
80
|
+
* - Model.bulkWrite — covers bulk write operations
|
|
81
|
+
* - Model.insertMany — covers bulk inserts (uses native driver, not save)
|
|
82
|
+
* - Model.distinct — bypasses Query, calls native driver directly
|
|
83
|
+
* - Model.startSession — returns a no-op wrapper so app-level transactions don't conflict
|
|
84
|
+
* - Collection.prototype (insertOne, updateOne, deleteOne, etc.) — covers native driver
|
|
85
|
+
* operations used by tests that call Model.collection.insertOne() directly
|
|
86
|
+
*
|
|
87
|
+
* When a model or collection uses a different MongoClient than the one that
|
|
88
|
+
* created the test session, patches skip session injection for that operation
|
|
89
|
+
* so the driver does not reject mismatched clients.
|
|
90
|
+
*/
|
|
91
|
+
export declare const installTransactionPatches: () => void;
|