@terreno/feature-flags 0.21.0 → 0.22.2

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.
Files changed (19) hide show
  1. package/bunfig.toml +1 -1
  2. package/package.json +3 -2
  3. package/src/tests/bunSetup.ts +6 -33
  4. package/src/tests/featureFlagsApp.liveUpdates.test.ts +1 -1
  5. package/src/tests/featureFlagsApp.test.ts +1 -1
  6. package/src/tests/openFeatureProvider.test.ts +1 -1
  7. package/tsconfig.json +1 -1
  8. package/dist/tests/bunSetup.d.ts +0 -1
  9. package/dist/tests/bunSetup.js +0 -35
  10. package/dist/tests/evaluate.test.d.ts +0 -1
  11. package/dist/tests/evaluate.test.js +0 -594
  12. package/dist/tests/featureFlagModel.test.d.ts +0 -1
  13. package/dist/tests/featureFlagModel.test.js +0 -428
  14. package/dist/tests/featureFlagsApp.liveUpdates.test.d.ts +0 -1
  15. package/dist/tests/featureFlagsApp.liveUpdates.test.js +0 -203
  16. package/dist/tests/featureFlagsApp.test.d.ts +0 -1
  17. package/dist/tests/featureFlagsApp.test.js +0 -540
  18. package/dist/tests/openFeatureProvider.test.d.ts +0 -1
  19. package/dist/tests/openFeatureProvider.test.js +0 -395
package/dist/tests/openFeatureProvider.test.js DELETED
@@ -1,395 +0,0 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- var __generator = (this && this.__generator) || function (thisArg, body) {
12
- 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);
13
- return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
14
- function verb(n) { return function (v) { return step([n, v]); }; }
15
- function step(op) {
16
- if (f) throw new TypeError("Generator is already executing.");
17
- while (g && (g = 0, op[0] && (_ = 0)), _) try {
18
- 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;
19
- if (y = 0, t) op = [op[0] & 2, t.value];
20
- switch (op[0]) {
21
- case 0: case 1: t = op; break;
22
- case 4: _.label++; return { value: op[1], done: false };
23
- case 5: _.label++; y = op[1]; op = [0]; continue;
24
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
25
- default:
26
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
27
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
28
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
29
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
30
- if (t[2]) _.ops.pop();
31
- _.trys.pop(); continue;
32
- }
33
- op = body.call(thisArg, _);
34
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
35
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
36
- }
37
- };
38
- Object.defineProperty(exports, "__esModule", { value: true });
39
- var bun_test_1 = require("bun:test");
40
- var server_sdk_1 = require("@openfeature/server-sdk");
41
- var tests_1 = require("@terreno/api/src/tests");
42
- var featureFlagModel_1 = require("../featureFlagModel");
43
- var openFeatureProvider_1 = require("../openFeatureProvider");
44
- var noopLogger = {
45
- debug: function () { },
46
- error: function () { },
47
- info: function () { },
48
- warn: function () { },
49
- };
50
- (0, bun_test_1.describe)("MongoFeatureFlagProvider", function () {
51
- var provider;
52
- (0, bun_test_1.beforeEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
53
- return __generator(this, function (_a) {
54
- switch (_a.label) {
55
- case 0: return [4 /*yield*/, (0, tests_1.setupDb)()];
56
- case 1:
57
- _a.sent();
58
- return [4 /*yield*/, featureFlagModel_1.FeatureFlag.deleteMany({})];
59
- case 2:
60
- _a.sent();
61
- provider = new openFeatureProvider_1.MongoFeatureFlagProvider({ flagModel: featureFlagModel_1.FeatureFlag, segments: {} });
62
- return [4 /*yield*/, server_sdk_1.OpenFeature.clearProviders()];
63
- case 3:
64
- _a.sent();
65
- return [2 /*return*/];
66
- }
67
- });
68
- }); });
69
- (0, bun_test_1.afterEach)(function () { return __awaiter(void 0, void 0, void 0, function () {
70
- return __generator(this, function (_a) {
71
- switch (_a.label) {
72
- case 0: return [4 /*yield*/, featureFlagModel_1.FeatureFlag.deleteMany({})];
73
- case 1:
74
- _a.sent();
75
- return [4 /*yield*/, server_sdk_1.OpenFeature.clearProviders()];
76
- case 2:
77
- _a.sent();
78
- return [2 /*return*/];
79
- }
80
- });
81
- }); });
82
- (0, bun_test_1.it)("returns FLAG_NOT_FOUND for a missing flag", function () { return __awaiter(void 0, void 0, void 0, function () {
83
- var res;
84
- return __generator(this, function (_a) {
85
- switch (_a.label) {
86
- case 0: return [4 /*yield*/, provider.resolveBooleanEvaluation("nope", false, { targetingKey: "u1" }, noopLogger)];
87
- case 1:
88
- res = _a.sent();
89
- (0, bun_test_1.expect)(res.errorCode).toBe(server_sdk_1.ErrorCode.FLAG_NOT_FOUND);
90
- (0, bun_test_1.expect)(res.reason).toBe(server_sdk_1.StandardResolutionReasons.ERROR);
91
- (0, bun_test_1.expect)(res.value).toBe(false);
92
- return [2 /*return*/];
93
- }
94
- });
95
- }); });
96
- (0, bun_test_1.it)("returns TYPE_MISMATCH when resolveStringEvaluation targets a boolean flag", function () { return __awaiter(void 0, void 0, void 0, function () {
97
- var res;
98
- return __generator(this, function (_a) {
99
- switch (_a.label) {
100
- case 0: return [4 /*yield*/, featureFlagModel_1.FeatureFlag.create({
101
- enabled: true,
102
- key: "bool-only",
103
- name: "Bool",
104
- rolloutPercentage: 100,
105
- type: "boolean",
106
- })];
107
- case 1:
108
- _a.sent();
109
- return [4 /*yield*/, provider.resolveStringEvaluation("bool-only", "x", { targetingKey: "u1" }, noopLogger)];
110
- case 2:
111
- res = _a.sent();
112
- (0, bun_test_1.expect)(res.errorCode).toBe(server_sdk_1.ErrorCode.TYPE_MISMATCH);
113
- (0, bun_test_1.expect)(res.value).toBe("x");
114
- return [2 /*return*/];
115
- }
116
- });
117
- }); });
118
- (0, bun_test_1.it)("returns TYPE_MISMATCH when resolveBooleanEvaluation targets a variant flag", function () { return __awaiter(void 0, void 0, void 0, function () {
119
- var res;
120
- return __generator(this, function (_a) {
121
- switch (_a.label) {
122
- case 0: return [4 /*yield*/, featureFlagModel_1.FeatureFlag.create({
123
- enabled: true,
124
- key: "var-only",
125
- name: "Var",
126
- rules: [],
127
- type: "variant",
128
- variants: [
129
- { key: "a", weight: 50 },
130
- { key: "b", weight: 50 },
131
- ],
132
- })];
133
- case 1:
134
- _a.sent();
135
- return [4 /*yield*/, provider.resolveBooleanEvaluation("var-only", false, { targetingKey: "u1" }, noopLogger)];
136
- case 2:
137
- res = _a.sent();
138
- (0, bun_test_1.expect)(res.errorCode).toBe(server_sdk_1.ErrorCode.TYPE_MISMATCH);
139
- return [2 /*return*/];
140
- }
141
- });
142
- }); });
143
- (0, bun_test_1.it)("returns DISABLED with defaultValue for a disabled boolean flag", function () { return __awaiter(void 0, void 0, void 0, function () {
144
- var res;
145
- return __generator(this, function (_a) {
146
- switch (_a.label) {
147
- case 0: return [4 /*yield*/, featureFlagModel_1.FeatureFlag.create({
148
- defaultVariant: "on",
149
- enabled: false,
150
- key: "disabled-bool",
151
- name: "Off",
152
- rolloutPercentage: 100,
153
- type: "boolean",
154
- })];
155
- case 1:
156
- _a.sent();
157
- return [4 /*yield*/, provider.resolveBooleanEvaluation("disabled-bool", false, { targetingKey: "u1" }, noopLogger)];
158
- case 2:
159
- res = _a.sent();
160
- (0, bun_test_1.expect)(res.reason).toBe(server_sdk_1.StandardResolutionReasons.DISABLED);
161
- (0, bun_test_1.expect)(res.value).toBe(false);
162
- (0, bun_test_1.expect)(res.variant).toBe("on");
163
- return [2 /*return*/];
164
- }
165
- });
166
- }); });
167
- (0, bun_test_1.it)("resolves boolean rollout via deterministic hash when no rules match", function () { return __awaiter(void 0, void 0, void 0, function () {
168
- var res;
169
- return __generator(this, function (_a) {
170
- switch (_a.label) {
171
- case 0: return [4 /*yield*/, featureFlagModel_1.FeatureFlag.create({
172
- enabled: true,
173
- key: "rollout",
174
- name: "Rollout",
175
- rolloutPercentage: 100,
176
- rules: [],
177
- type: "boolean",
178
- })];
179
- case 1:
180
- _a.sent();
181
- return [4 /*yield*/, provider.resolveBooleanEvaluation("rollout", false, { targetingKey: "user-abc" }, noopLogger)];
182
- case 2:
183
- res = _a.sent();
184
- (0, bun_test_1.expect)(res.reason).toBe(server_sdk_1.StandardResolutionReasons.TARGETING_MATCH);
185
- (0, bun_test_1.expect)(res.value).toBe(true);
186
- (0, bun_test_1.expect)(res.variant).toBe("on");
187
- return [2 /*return*/];
188
- }
189
- });
190
- }); });
191
- (0, bun_test_1.it)("matches a field rule on a boolean flag", function () { return __awaiter(void 0, void 0, void 0, function () {
192
- var adminRes, userRes;
193
- return __generator(this, function (_a) {
194
- switch (_a.label) {
195
- case 0: return [4 /*yield*/, featureFlagModel_1.FeatureFlag.create({
196
- enabled: true,
197
- key: "rule-bool",
198
- name: "Rule",
199
- rolloutPercentage: 0,
200
- rules: [{ enabled: true, field: "admin", operator: "eq", value: true }],
201
- type: "boolean",
202
- })];
203
- case 1:
204
- _a.sent();
205
- return [4 /*yield*/, provider.resolveBooleanEvaluation("rule-bool", false, { targetingKey: "id1", user: { admin: true } }, noopLogger)];
206
- case 2:
207
- adminRes = _a.sent();
208
- (0, bun_test_1.expect)(adminRes.value).toBe(true);
209
- return [4 /*yield*/, provider.resolveBooleanEvaluation("rule-bool", false, { targetingKey: "id2", user: { admin: false } }, noopLogger)];
210
- case 3:
211
- userRes = _a.sent();
212
- (0, bun_test_1.expect)(userRes.value).toBe(false);
213
- return [2 /*return*/];
214
- }
215
- });
216
- }); });
217
- (0, bun_test_1.it)("matches a segment rule when segments are registered", function () { return __awaiter(void 0, void 0, void 0, function () {
218
- var segments, p, yes, no;
219
- return __generator(this, function (_a) {
220
- switch (_a.label) {
221
- case 0:
222
- segments = {
223
- "vip-users": function (u) { return u.vip === true; },
224
- };
225
- p = new openFeatureProvider_1.MongoFeatureFlagProvider({ flagModel: featureFlagModel_1.FeatureFlag, segments: segments });
226
- return [4 /*yield*/, featureFlagModel_1.FeatureFlag.create({
227
- enabled: true,
228
- key: "seg-flag",
229
- name: "Seg",
230
- rolloutPercentage: 0,
231
- rules: [{ enabled: true, segment: "vip-users" }],
232
- type: "boolean",
233
- })];
234
- case 1:
235
- _a.sent();
236
- return [4 /*yield*/, p.resolveBooleanEvaluation("seg-flag", false, { targetingKey: "x", user: { vip: true } }, noopLogger)];
237
- case 2:
238
- yes = _a.sent();
239
- (0, bun_test_1.expect)(yes.value).toBe(true);
240
- return [4 /*yield*/, p.resolveBooleanEvaluation("seg-flag", false, { targetingKey: "y", user: { vip: false } }, noopLogger)];
241
- case 3:
242
- no = _a.sent();
243
- (0, bun_test_1.expect)(no.value).toBe(false);
244
- return [2 /*return*/];
245
- }
246
- });
247
- }); });
248
- (0, bun_test_1.it)("treats missing targetingKey as empty string for hashing", function () { return __awaiter(void 0, void 0, void 0, function () {
249
- var res;
250
- return __generator(this, function (_a) {
251
- switch (_a.label) {
252
- case 0: return [4 /*yield*/, featureFlagModel_1.FeatureFlag.create({
253
- enabled: true,
254
- key: "hash-key",
255
- name: "Hash",
256
- rolloutPercentage: 100,
257
- rules: [],
258
- type: "boolean",
259
- })];
260
- case 1:
261
- _a.sent();
262
- return [4 /*yield*/, provider.resolveBooleanEvaluation("hash-key", false, {}, noopLogger)];
263
- case 2:
264
- res = _a.sent();
265
- (0, bun_test_1.expect)(res.reason).toBe(server_sdk_1.StandardResolutionReasons.TARGETING_MATCH);
266
- (0, bun_test_1.expect)(typeof res.value).toBe("boolean");
267
- return [2 /*return*/];
268
- }
269
- });
270
- }); });
271
- (0, bun_test_1.it)("uses flat context as user when user field is absent", function () { return __awaiter(void 0, void 0, void 0, function () {
272
- var res;
273
- return __generator(this, function (_a) {
274
- switch (_a.label) {
275
- case 0: return [4 /*yield*/, featureFlagModel_1.FeatureFlag.create({
276
- enabled: true,
277
- key: "flat-ctx",
278
- name: "Flat",
279
- rolloutPercentage: 0,
280
- rules: [{ enabled: true, field: "admin", operator: "eq", value: true }],
281
- type: "boolean",
282
- })];
283
- case 1:
284
- _a.sent();
285
- return [4 /*yield*/, provider.resolveBooleanEvaluation("flat-ctx", false, { admin: true, targetingKey: "t1" }, noopLogger)];
286
- case 2:
287
- res = _a.sent();
288
- (0, bun_test_1.expect)(res.value).toBe(true);
289
- return [2 /*return*/];
290
- }
291
- });
292
- }); });
293
- (0, bun_test_1.it)("resolves variant assignment and returns TARGETING_MATCH", function () { return __awaiter(void 0, void 0, void 0, function () {
294
- var res;
295
- return __generator(this, function (_a) {
296
- switch (_a.label) {
297
- case 0: return [4 /*yield*/, featureFlagModel_1.FeatureFlag.create({
298
- enabled: true,
299
- key: "layout",
300
- name: "Layout",
301
- rules: [],
302
- type: "variant",
303
- variants: [
304
- { key: "compact", weight: 50 },
305
- { key: "detailed", weight: 50 },
306
- ],
307
- })];
308
- case 1:
309
- _a.sent();
310
- return [4 /*yield*/, provider.resolveStringEvaluation("layout", "fallback", { targetingKey: "user-z" }, noopLogger)];
311
- case 2:
312
- res = _a.sent();
313
- (0, bun_test_1.expect)(res.reason).toBe(server_sdk_1.StandardResolutionReasons.TARGETING_MATCH);
314
- (0, bun_test_1.expect)(["compact", "detailed"].includes(res.value)).toBe(true);
315
- return [2 /*return*/];
316
- }
317
- });
318
- }); });
319
- (0, bun_test_1.it)("returns DISABLED for variant flag when evaluateFlag yields null", function () { return __awaiter(void 0, void 0, void 0, function () {
320
- var res;
321
- return __generator(this, function (_a) {
322
- switch (_a.label) {
323
- case 0: return [4 /*yield*/, featureFlagModel_1.FeatureFlag.create({
324
- defaultVariant: "compact",
325
- enabled: false,
326
- key: "var-off",
327
- name: "Var off",
328
- rules: [],
329
- type: "variant",
330
- variants: [
331
- { key: "compact", weight: 50 },
332
- { key: "detailed", weight: 50 },
333
- ],
334
- })];
335
- case 1:
336
- _a.sent();
337
- return [4 /*yield*/, provider.resolveStringEvaluation("var-off", "fallback", { targetingKey: "u1" }, noopLogger)];
338
- case 2:
339
- res = _a.sent();
340
- (0, bun_test_1.expect)(res.reason).toBe(server_sdk_1.StandardResolutionReasons.DISABLED);
341
- (0, bun_test_1.expect)(res.value).toBe("fallback");
342
- (0, bun_test_1.expect)(res.variant).toBe("compact");
343
- return [2 /*return*/];
344
- }
345
- });
346
- }); });
347
- (0, bun_test_1.it)("resolveNumberEvaluation returns FLAG_NOT_FOUND with default", function () { return __awaiter(void 0, void 0, void 0, function () {
348
- var res;
349
- return __generator(this, function (_a) {
350
- switch (_a.label) {
351
- case 0: return [4 /*yield*/, provider.resolveNumberEvaluation("any", 42, { targetingKey: "u" }, noopLogger)];
352
- case 1:
353
- res = _a.sent();
354
- (0, bun_test_1.expect)(res.errorCode).toBe(server_sdk_1.ErrorCode.FLAG_NOT_FOUND);
355
- (0, bun_test_1.expect)(res.value).toBe(42);
356
- return [2 /*return*/];
357
- }
358
- });
359
- }); });
360
- (0, bun_test_1.it)("resolveObjectEvaluation returns FLAG_NOT_FOUND with default", function () { return __awaiter(void 0, void 0, void 0, function () {
361
- var res;
362
- return __generator(this, function (_a) {
363
- switch (_a.label) {
364
- case 0: return [4 /*yield*/, provider.resolveObjectEvaluation("any", { a: 1 }, { targetingKey: "u" }, noopLogger)];
365
- case 1:
366
- res = _a.sent();
367
- (0, bun_test_1.expect)(res.errorCode).toBe(server_sdk_1.ErrorCode.FLAG_NOT_FOUND);
368
- (0, bun_test_1.expect)(res.value).toEqual({ a: 1 });
369
- return [2 /*return*/];
370
- }
371
- });
372
- }); });
373
- (0, bun_test_1.it)("does not resolve archived flags", function () { return __awaiter(void 0, void 0, void 0, function () {
374
- var res;
375
- return __generator(this, function (_a) {
376
- switch (_a.label) {
377
- case 0: return [4 /*yield*/, featureFlagModel_1.FeatureFlag.create({
378
- archived: true,
379
- enabled: true,
380
- key: "gone",
381
- name: "Gone",
382
- rolloutPercentage: 100,
383
- type: "boolean",
384
- })];
385
- case 1:
386
- _a.sent();
387
- return [4 /*yield*/, provider.resolveBooleanEvaluation("gone", false, { targetingKey: "u1" }, noopLogger)];
388
- case 2:
389
- res = _a.sent();
390
- (0, bun_test_1.expect)(res.errorCode).toBe(server_sdk_1.ErrorCode.FLAG_NOT_FOUND);
391
- return [2 /*return*/];
392
- }
393
- });
394
- }); });
395
- });