unleash-server 4.14.2 → 4.14.3

package/dist/lib/openapi/spec/playground-feature-schema.test.js

@@ -8,12 +8,69 @@ const fast_check_1 = __importDefault(require("fast-check"));
 const arbitraries_test_1 = require("../../../test/arbitraries.test");
 const validate_1 = require("../validate");
 const playground_feature_schema_1 = require("./playground-feature-schema");
+const playground_strategy_schema_1 = require("./playground-strategy-schema");
+const playgroundStrategyConstraint = () => fast_check_1.default
+    .tuple(fast_check_1.default.boolean(), (0, arbitraries_test_1.strategyConstraint)())
+    .map(([result, constraint]) => ({
+    ...constraint,
+    result,
+}));
+const playgroundStrategyConstraints = () => fast_check_1.default.array(playgroundStrategyConstraint());
+const playgroundSegment = () => fast_check_1.default.record({
+    name: fast_check_1.default.string({ minLength: 1 }),
+    id: fast_check_1.default.nat(),
+    result: fast_check_1.default.boolean(),
+    constraints: playgroundStrategyConstraints(),
+});
+const playgroundStrategy = (name, parameters) => fast_check_1.default.record({
+    id: fast_check_1.default.uuid(),
+    name: fast_check_1.default.constant(name),
+    result: fast_check_1.default.oneof(fast_check_1.default.record({
+        evaluationStatus: fast_check_1.default.constant(playground_strategy_schema_1.playgroundStrategyEvaluation.evaluationComplete),
+        enabled: fast_check_1.default.boolean(),
+    }), fast_check_1.default.record({
+        evaluationStatus: fast_check_1.default.constant(playground_strategy_schema_1.playgroundStrategyEvaluation.evaluationIncomplete),
+        enabled: fast_check_1.default.constantFrom(playground_strategy_schema_1.playgroundStrategyEvaluation.unknownResult, false),
+    })),
+    parameters,
+    constraints: playgroundStrategyConstraints(),
+    segments: fast_check_1.default.array(playgroundSegment()),
+});
+const playgroundStrategies = () => fast_check_1.default.array(fast_check_1.default.oneof(playgroundStrategy('default', fast_check_1.default.constant({})), playgroundStrategy('flexibleRollout', fast_check_1.default.record({
+    groupId: fast_check_1.default.lorem({ maxCount: 1 }),
+    rollout: fast_check_1.default.nat({ max: 100 }).map(String),
+    stickiness: fast_check_1.default.constantFrom('default', 'userId', 'sessionId'),
+})), playgroundStrategy('applicationHostname', fast_check_1.default.record({
+    hostNames: fast_check_1.default
+        .uniqueArray(fast_check_1.default.domain())
+        .map((domains) => domains.join(',')),
+})), playgroundStrategy('userWithId', fast_check_1.default.record({
+    userIds: fast_check_1.default
+        .uniqueArray(fast_check_1.default.emailAddress())
+        .map((ids) => ids.join(',')),
+})), playgroundStrategy('remoteAddress', fast_check_1.default.record({
+    IPs: fast_check_1.default.uniqueArray(fast_check_1.default.ipV4()).map((ips) => ips.join(',')),
+}))));
 const generate = () => fast_check_1.default
-    .tuple(fast_check_1.default.boolean(), (0, arbitraries_test_1.variants)(), fast_check_1.default.nat(), fast_check_1.default.record({
+    .tuple((0, arbitraries_test_1.variants)(), fast_check_1.default.nat(), fast_check_1.default.record({
+    isEnabledInCurrentEnvironment: fast_check_1.default.boolean(),
     projectId: (0, arbitraries_test_1.urlFriendlyString)(),
     name: (0, arbitraries_test_1.urlFriendlyString)(),
+    strategies: playgroundStrategies(),
 }))
-    .map(([isEnabled, generatedVariants, activeVariantIndex, feature]) => {
+    .map(([generatedVariants, activeVariantIndex, feature]) => {
+    const strategyResult = () => {
+        const { strategies } = feature;
+        if (strategies.some((strategy) => strategy.result.enabled === true)) {
+            return true;
+        }
+        if (strategies.some((strategy) => strategy.result.enabled === 'unknown')) {
+            return 'unknown';
+        }
+        return false;
+    };
+    const isEnabled = feature.isEnabledInCurrentEnvironment &&
+        strategyResult() === true;
     // the active variant is the disabled variant if the feature is
     // disabled or has no variants.
     let activeVariant = { name: 'disabled', enabled: false };
@@ -23,7 +80,7 @@ const generate = () => fast_check_1.default
             ? targetVariant.payload
             : undefined;
         activeVariant = {
-            enabled: isEnabled,
+            enabled: true,
             name: targetVariant.name,
             payload: targetPayload,
         };
@@ -31,6 +88,10 @@ const generate = () => fast_check_1.default
     return {
         ...feature,
         isEnabled,
+        strategies: {
+            result: strategyResult(),
+            data: feature.strategies,
+        },
         variants: generatedVariants,
         variant: activeVariant,
     };

package/dist/lib/openapi/spec/playground-feature-schema.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"playground-feature-schema.test.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/playground-feature-schema.test.ts"],"names":[],"mappings":";;;;;;AAAA,4DAA2C;AAC3C,qEAA6E;AAC7E,0CAA6C;AAC7C,2EAGqC;AAE9B,MAAM,QAAQ,GAAG,GAAuC,EAAE,CAC7D,oBAAE;KACG,KAAK,CACF,oBAAE,CAAC,OAAO,EAAE,EACZ,IAAA,2BAAQ,GAAE,EACV,oBAAE,CAAC,GAAG,EAAE,EACR,oBAAE,CAAC,MAAM,CAAC;IACN,SAAS,EAAE,IAAA,oCAAiB,GAAE;IAC9B,IAAI,EAAE,IAAA,oCAAiB,GAAE;CAC5B,CAAC,CACL;KACA,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,EAAE;IACjE,+DAA+D;IAC/D,+BAA+B;IAC/B,IAAI,aAAa,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAOrD,CAAC;IAEF,IAAI,iBAAiB,CAAC,MAAM,IAAI,SAAS,EAAE;QACvC,MAAM,aAAa,GACf,iBAAiB,CACb,kBAAkB,GAAG,iBAAiB,CAAC,MAAM,CAChD,CAAC;QACN,MAAM,aAAa,GAAG,aAAa,CAAC,OAAO;YACvC,CAAC,CAAE,aAAa,CAAC,OAGb;YACJ,CAAC,CAAC,SAAS,CAAC;QAEhB,aAAa,GAAG;YACZ,OAAO,EAAE,SAAS;YAClB,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,OAAO,EAAE,aAAa;SACzB,CAAC;KACL;IAED,OAAO;QACH,GAAG,OAAO;QACV,SAAS;QACT,QAAQ,EAAE,iBAAiB;QAC3B,OAAO,EAAE,aAAa;KACzB,CAAC;AACN,CAAC,CAAC,CAAC;AAhDE,QAAA,QAAQ,YAgDV;AAEX,IAAI,CAAC,yBAAyB,EAAE,GAAG,EAAE,CACjC,oBAAE,CAAC,MAAM,CACL,oBAAE,CAAC,QAAQ,CACP,IAAA,gBAAQ,GAAE,EACV,oBAAE,CAAC,OAAO,EAAE,EACZ,CAAC,IAA6B,EAAE,GAAG,EAAE,EAAE;IACnC,MAAM,OAAO,GAAG,IAAA,yBAAc,EAC1B,mDAAuB,CAAC,GAAG,EAC3B,IAAI,CACP,CAAC;IACF,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IACjC,OAAO,OAAO,KAAK,SAAS,CAAC;AACjC,CAAC,CACJ,CACJ,CAAC,CAAC"}
+{"version":3,"file":"playground-feature-schema.test.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/playground-feature-schema.test.ts"],"names":[],"mappings":";;;;;;AAAA,4DAA2C;AAC3C,qEAIwC;AACxC,0CAA6C;AAE7C,2EAGqC;AAErC,6EAGsC;AAEtC,MAAM,4BAA4B,GAC9B,GAA0C,EAAE,CACxC,oBAAE;KACG,KAAK,CAAC,oBAAE,CAAC,OAAO,EAAE,EAAE,IAAA,qCAAkB,GAAE,CAAC;KACzC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC;IAC5B,GAAG,UAAU;IACb,MAAM;CACT,CAAC,CAAC,CAAC;AAEhB,MAAM,6BAA6B,GAAG,GAEpC,EAAE,CAAC,oBAAE,CAAC,KAAK,CAAC,4BAA4B,EAAE,CAAC,CAAC;AAE9C,MAAM,iBAAiB,GAAG,GAAuC,EAAE,CAC/D,oBAAE,CAAC,MAAM,CAAC;IACN,IAAI,EAAE,oBAAE,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;IACjC,EAAE,EAAE,oBAAE,CAAC,GAAG,EAAE;IACZ,MAAM,EAAE,oBAAE,CAAC,OAAO,EAAE;IACpB,WAAW,EAAE,6BAA6B,EAAE;CAC/C,CAAC,CAAC;AAEP,MAAM,kBAAkB,GAAG,CACvB,IAAY,EACZ,UAA6C,EACV,EAAE,CACrC,oBAAE,CAAC,MAAM,CAAC;IACN,EAAE,EAAE,oBAAE,CAAC,IAAI,EAAE;IACb,IAAI,EAAE,oBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;IACvB,MAAM,EAAE,oBAAE,CAAC,KAAK,CACZ,oBAAE,CAAC,MAAM,CAAC;QACN,gBAAgB,EAAE,oBAAE,CAAC,QAAQ,CACzB,yDAA4B,CAAC,kBAAkB,CAClD;QACD,OAAO,EAAE,oBAAE,CAAC,OAAO,EAAE;KACxB,CAAC,EACF,oBAAE,CAAC,MAAM,CAAC;QACN,gBAAgB,EAAE,oBAAE,CAAC,QAAQ,CACzB,yDAA4B,CAAC,oBAAoB,CACpD;QACD,OAAO,EAAE,oBAAE,CAAC,YAAY,CACpB,yDAA4B,CAAC,aAAa,EAC1C,KAAc,CACjB;KACJ,CAAC,CACL;IACD,UAAU;IACV,WAAW,EAAE,6BAA6B,EAAE;IAC5C,QAAQ,EAAE,oBAAE,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC;CAC1C,CAAC,CAAC;AAEP,MAAM,oBAAoB,GAAG,GAA0C,EAAE,CACrE,oBAAE,CAAC,KAAK,CACJ,oBAAE,CAAC,KAAK,CACJ,kBAAkB,CAAC,SAAS,EAAE,oBAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAC9C,kBAAkB,CACd,iBAAiB,EACjB,oBAAE,CAAC,MAAM,CAAC;IACN,OAAO,EAAE,oBAAE,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IAClC,OAAO,EAAE,oBAAE,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;IACzC,UAAU,EAAE,oBAAE,CAAC,YAAY,CACvB,SAAS,EACT,QAAQ,EACR,WAAW,CACd;CACJ,CAAC,CACL,EACD,kBAAkB,CACd,qBAAqB,EACrB,oBAAE,CAAC,MAAM,CAAC;IACN,SAAS,EAAE,oBAAE;SACR,WAAW,CAAC,oBAAE,CAAC,MAAM,EAAE,CAAC;SACxB,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;CAC3C,CAAC,CACL,EAED,kBAAkB,CACd,YAAY,EACZ,oBAAE,CAAC,MAAM,CAAC;IACN,OAAO,EAAE,oBAAE;SACN,WAAW,CAAC,oBAAE,CAAC,YAAY,EAAE,CAAC;SAC9B,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;CACnC,CAAC,CACL,EACD,kBAAkB,CACd,eAAe,EACf,oBAAE,CAAC,MAAM,CAAC;IACN,GAAG,EAAE,oBAAE,CAAC,WAAW,CAAC,oBAAE,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;CAC7D,CAAC,CACL,CACJ,CACJ,CAAC;AAEC,MAAM,QAAQ,GAAG,GAAuC,EAAE,CAC7D,oBAAE;KACG,KAAK,CACF,IAAA,2BAAQ,GAAE,EACV,oBAAE,CAAC,GAAG,EAAE,EACR,oBAAE,CAAC,MAAM,CAAC;IACN,6BAA6B,EAAE,oBAAE,CAAC,OAAO,EAAE;IAC3C,SAAS,EAAE,IAAA,oCAAiB,GAAE;IAC9B,IAAI,EAAE,IAAA,oCAAiB,GAAE;IACzB,UAAU,EAAE,oBAAoB,EAAE;CACrC,CAAC,CACL;KACA,GAAG,CAAC,CAAC,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,EAAE;IACtD,MAAM,cAAc,GAAG,GAAG,EAAE;QACxB,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;QAE/B,IACI,UAAU,CAAC,IAAI,CACX,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,KAAK,IAAI,CACjD,EACH;YACE,OAAO,IAAI,CAAC;SACf;QACD,IACI,UAAU,CAAC,IAAI,CACX,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,KAAK,SAAS,CACtD,EACH;YACE,OAAO,SAAS,CAAC;SACpB;QACD,OAAO,KAAK,CAAC;IACjB,CAAC,CAAC;IAEF,MAAM,SAAS,GACX,OAAO,CAAC,6BAA6B;QACrC,cAAc,EAAE,KAAK,IAAI,CAAC;IAE9B,+DAA+D;IAC/D,+BAA+B;IAC/B,IAAI,aAAa,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAOrD,CAAC;IAEF,IAAI,iBAAiB,CAAC,MAAM,IAAI,SAAS,EAAE;QACvC,MAAM,aAAa,GACf,iBAAiB,CACb,kBAAkB,GAAG,iBAAiB,CAAC,MAAM,CAChD,CAAC;QACN,MAAM,aAAa,GAAG,aAAa,CAAC,OAAO;YACvC,CAAC,CAAE,aAAa,CAAC,OAGb;YACJ,CAAC,CAAC,SAAS,CAAC;QAEhB,aAAa,GAAG;YACZ,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,OAAO,EAAE,aAAa;SACzB,CAAC;KACL;IAED,OAAO;QACH,GAAG,OAAO;QACV,SAAS;QACT,UAAU,EAAE;YACR,MAAM,EAAE,cAAc,EAAE;YACxB,IAAI,EAAE,OAAO,CAAC,UAAU;SAC3B;QACD,QAAQ,EAAE,iBAAiB;QAC3B,OAAO,EAAE,aAAa;KACzB,CAAC;AACN,CAAC,CAAC,CAAC;AA7EE,QAAA,QAAQ,YA6EV;AAEX,IAAI,CAAC,yBAAyB,EAAE,GAAG,EAAE,CACjC,oBAAE,CAAC,MAAM,CACL,oBAAE,CAAC,QAAQ,CACP,IAAA,gBAAQ,GAAE,EACV,oBAAE,CAAC,OAAO,EAAE,EACZ,CAAC,IAA6B,EAAE,GAAG,EAAE,EAAE;IACnC,MAAM,OAAO,GAAG,IAAA,yBAAc,EAC1B,mDAAuB,CAAC,GAAG,EAC3B,IAAI,CACP,CAAC;IACF,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IACjC,OAAO,OAAO,KAAK,SAAS,CAAC;AACjC,CAAC,CACJ,CACJ,CAAC,CAAC"}

package/dist/lib/openapi/spec/playground-request-schema.d.ts

@@ -8,6 +8,7 @@ export declare const playgroundRequestSchema: {
         readonly environment: {
             readonly type: "string";
             readonly example: "development";
+            readonly description: "The environment to evaluate toggles in.";
         };
         readonly projects: {
             readonly oneOf: readonly [{
@@ -24,6 +25,7 @@ export declare const playgroundRequestSchema: {
             }];
         };
         readonly context: {
+            readonly description: "The context to use when evaluating toggles";
             readonly $ref: "#/components/schemas/sdkContextSchema";
         };
     };

package/dist/lib/openapi/spec/playground-request-schema.js

@@ -9,7 +9,11 @@ exports.playgroundRequestSchema = {
     type: 'object',
     required: ['environment', 'context'],
     properties: {
-        environment: { type: 'string', example: 'development' },
+        environment: {
+            type: 'string',
+            example: 'development',
+            description: 'The environment to evaluate toggles in.',
+        },
         projects: {
             oneOf: [
                 {
@@ -26,6 +30,7 @@ exports.playgroundRequestSchema = {
             ],
         },
         context: {
+            description: 'The context to use when evaluating toggles',
             $ref: sdk_context_schema_1.sdkContextSchema.$id,
         },
     },

package/dist/lib/openapi/spec/playground-request-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"playground-request-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/playground-request-schema.ts"],"names":[],"mappings":";;;AACA,4DAAmD;AACnD,6DAAwD;AAE3C,QAAA,uBAAuB,GAAG;IACnC,GAAG,EAAE,8CAA8C;IACnD,WAAW,EAAE,iDAAiD;IAC9D,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,aAAa,EAAE,SAAS,CAAC;IACpC,UAAU,EAAE;QACR,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE;QACvD,QAAQ,EAAE;YACN,KAAK,EAAE;gBACH;oBACI,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACzB,OAAO,EAAE,CAAC,YAAY,CAAC;oBACvB,WAAW,EAAE,6CAA6C;iBAC7D;gBACD;oBACI,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,eAAG,CAAC;oBACX,WAAW,EAAE,gCAAgC;iBAChD;aACJ;SACJ;QACD,OAAO,EAAE;YACL,IAAI,EAAE,qCAAgB,CAAC,GAAG;SAC7B;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,qCAAgB;SACnB;KACJ;CACK,CAAC"}
+{"version":3,"file":"playground-request-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/playground-request-schema.ts"],"names":[],"mappings":";;;AACA,4DAAmD;AACnD,6DAAwD;AAE3C,QAAA,uBAAuB,GAAG;IACnC,GAAG,EAAE,8CAA8C;IACnD,WAAW,EAAE,iDAAiD;IAC9D,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,aAAa,EAAE,SAAS,CAAC;IACpC,UAAU,EAAE;QACR,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;YACtB,WAAW,EAAE,yCAAyC;SACzD;QACD,QAAQ,EAAE;YACN,KAAK,EAAE;gBACH;oBACI,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACzB,OAAO,EAAE,CAAC,YAAY,CAAC;oBACvB,WAAW,EAAE,6CAA6C;iBAC7D;gBACD;oBACI,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,eAAG,CAAC;oBACX,WAAW,EAAE,gCAAgC;iBAChD;aACJ;SACJ;QACD,OAAO,EAAE;YACL,WAAW,EAAE,4CAA4C;YACzD,IAAI,EAAE,qCAAgB,CAAC,GAAG;SAC7B;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,qCAAgB;SACnB;KACJ;CACK,CAAC"}