@featurevisor/core 0.14.1 → 0.16.0

package/lib/traffic.js

@@ -1,111 +1,122 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNewTraffic = void 0;
+exports.getTraffic = exports.detectIfRangesChanged = exports.getRulePercentageDiff = exports.detectIfVariationsChanged = void 0;
 var sdk_1 = require("@featurevisor/sdk");
-function getNewTraffic(
+var allocator_1 = require("./allocator");
+function detectIfVariationsChanged(yamlVariations, // as exists in latest YAML
+existingFeature) {
+    if (!existingFeature) {
+        return false;
+    }
+    return (JSON.stringify(existingFeature.variations.map(function (_a) {
+        var value = _a.value, weight = _a.weight;
+        return ({
+            value: value,
+            weight: weight,
+        });
+    })) !== JSON.stringify(yamlVariations.map(function (_a) {
+        var value = _a.value, weight = _a.weight;
+        return ({ value: value, weight: weight });
+    })));
+}
+exports.detectIfVariationsChanged = detectIfVariationsChanged;
+function getRulePercentageDiff(trafficPercentage, // 0 to 100k
+existingTrafficRule) {
+    if (!existingTrafficRule) {
+        return 0;
+    }
+    var existingPercentage = existingTrafficRule.percentage;
+    return trafficPercentage - existingPercentage;
+}
+exports.getRulePercentageDiff = getRulePercentageDiff;
+function detectIfRangesChanged(availableRanges, // as exists in latest YAML
+existingFeature) {
+    if (!existingFeature) {
+        return false;
+    }
+    if (!existingFeature.ranges) {
+        return false;
+    }
+    return JSON.stringify(existingFeature.ranges) !== JSON.stringify(availableRanges);
+}
+exports.detectIfRangesChanged = detectIfRangesChanged;
+function getTraffic(
 // from current YAML
 variations, parsedRules, 
 // from previous release
-existingFeature) {
+existingFeature, 
+// ranges from group slots
+ranges) {
     var result = [];
-    parsedRules.forEach(function (parsedRollout) {
-        var rolloutPercentage = parsedRollout.percentage;
+    // @TODO: may be pass from builder directly?
+    var availableRanges = ranges && ranges.length > 0 ? ranges : [{ start: 0, end: sdk_1.MAX_BUCKETED_NUMBER }];
+    parsedRules.forEach(function (parsedRule) {
+        var rulePercentage = parsedRule.percentage; // 0 - 100
         var traffic = {
-            key: parsedRollout.key,
-            segments: typeof parsedRollout.segments !== "string"
-                ? JSON.stringify(parsedRollout.segments)
-                : parsedRollout.segments,
-            percentage: rolloutPercentage * (sdk_1.MAX_BUCKETED_NUMBER / 100),
+            key: parsedRule.key,
+            segments: typeof parsedRule.segments !== "string"
+                ? JSON.stringify(parsedRule.segments)
+                : parsedRule.segments,
+            percentage: rulePercentage * (sdk_1.MAX_BUCKETED_NUMBER / 100),
             allocation: [],
         };
-        if (parsedRollout.variables) {
-            traffic.variables = parsedRollout.variables;
+        // overrides
+        if (parsedRule.variables) {
+            traffic.variables = parsedRule.variables;
         }
-        if (parsedRollout.variation) {
-            traffic.variation = parsedRollout.variation;
+        if (parsedRule.variation) {
+            traffic.variation = parsedRule.variation;
         }
-        var existingTrafficRollout = existingFeature === null || existingFeature === void 0 ? void 0 : existingFeature.traffic.find(function (t) { return t.key === parsedRollout.key; });
-        // @TODO: handle if Variations changed (added/removed, or weight changed)
-        //  - new variation added
-        //  - variation removed
-        //  - variation weight changed
-        //
-        // make it better by maintaining as much of the previous bucketing as possible
-        var variationsChanged = existingFeature
-            ? JSON.stringify(existingFeature.variations.map(function (_a) {
-                var value = _a.value, weight = _a.weight;
-                return ({
-                    value: value,
-                    weight: weight,
-                });
-            })) !== JSON.stringify(variations.map(function (_a) {
-                var value = _a.value, weight = _a.weight;
-                return ({ value: value, weight: weight });
-            }))
-            : false;
-        var diffPercentage = 0;
-        if (existingTrafficRollout) {
-            diffPercentage =
-                rolloutPercentage - existingTrafficRollout.percentage / (sdk_1.MAX_BUCKETED_NUMBER / 100);
-            if (diffPercentage > 0 &&
-                !variationsChanged // if variations changed, we need to re-bucket
-            ) {
-                // increase: build on top of existing allocations
-                traffic.allocation = existingTrafficRollout.allocation.map(function (_a) {
-                    var variation = _a.variation, percentage = _a.percentage;
-                    return {
-                        variation: variation,
-                        percentage: percentage,
-                    };
-                });
-            }
+        // detect changes
+        var variationsChanged = detectIfVariationsChanged(variations, existingFeature);
+        var existingTrafficRule = existingFeature === null || existingFeature === void 0 ? void 0 : existingFeature.traffic.find(function (t) { return t.key === parsedRule.key; });
+        var rulePercentageDiff = getRulePercentageDiff(traffic.percentage, existingTrafficRule);
+        var rangesChanged = detectIfRangesChanged(availableRanges, existingFeature);
+        var needsRebucketing = !existingTrafficRule || // new rule
+            variationsChanged || // variations changed
+            rulePercentageDiff <= 0 || // percentage decreased
+            rangesChanged; // belongs to a group, and group ranges changed
+        var updatedAvailableRanges = JSON.parse(JSON.stringify(availableRanges));
+        var lastEnd = 0;
+        if (existingTrafficRule && !needsRebucketing) {
+            // increase: build on top of existing allocations
+            var existingSum_1 = 0;
+            traffic.allocation = existingTrafficRule.allocation.map(function (_a) {
+                var variation = _a.variation, percentage = _a.percentage, // @TODO: remove it in next breaking semver
+                range = _a.range;
+                var result = {
+                    variation: variation,
+                    percentage: percentage,
+                    range: range || {
+                        start: lastEnd,
+                        end: percentage,
+                    },
+                };
+                existingSum_1 += percentage || 0;
+                lastEnd = lastEnd + (percentage || 0);
+                return result;
+            });
+            updatedAvailableRanges = (0, allocator_1.getUpdatedAvailableRangesAfterFilling)(availableRanges, existingSum_1);
         }
         variations.forEach(function (variation) {
-            var newPercentage = parseInt(((variation.weight / 100) *
-                rolloutPercentage *
-                (sdk_1.MAX_BUCKETED_NUMBER / 100)).toFixed(2));
-            if (!existingTrafficRollout || variationsChanged === true) {
-                traffic.allocation.push({
-                    variation: variation.value,
-                    percentage: newPercentage,
-                });
-                return;
-            }
-            // const prevTotalWeightForVariation = existingTrafficRollout.allocation
-            //   .filter((a) => a.variation === variation.value)
-            //   .reduce((acc, curr) => acc + curr.percentage, 0);
-            // const diffWeightForVariation = (variation.weight as number) - prevTotalWeightForVariation / (MAX_BUCKETED_NUMBER / 100));
-            if (diffPercentage === 0) {
-                // no change
-                traffic.allocation.push({
-                    variation: variation.value,
-                    percentage: newPercentage,
-                });
-                return;
-            }
-            if (diffPercentage > 0) {
-                // increase - need to consistently bucket
-                traffic.allocation.push({
-                    variation: variation.value,
-                    percentage: parseInt((variation.weight *
-                        (diffPercentage / 100) *
-                        (sdk_1.MAX_BUCKETED_NUMBER / 100)).toFixed(2)),
-                });
-                return;
-            }
-            if (diffPercentage < 0) {
-                // decrease - need to re-bucket
-                // @TODO: can we maintain as much pre bucketed values as possible? to be close to consistent bucketing?
+            var weight = variation.weight;
+            var percentage = weight * (sdk_1.MAX_BUCKETED_NUMBER / 100);
+            var toFillValue = needsRebucketing
+                ? percentage * (rulePercentage / 100) // whole value
+                : (weight / 100) * rulePercentageDiff; // incrementing
+            var rangesToFill = (0, allocator_1.getAllocation)(updatedAvailableRanges, toFillValue);
+            rangesToFill.forEach(function (range) {
                 traffic.allocation.push({
                     variation: variation.value,
-                    percentage: newPercentage,
+                    percentage: toFillValue,
+                    range: range,
                 });
-                return;
-            }
+            });
+            updatedAvailableRanges = (0, allocator_1.getUpdatedAvailableRangesAfterFilling)(updatedAvailableRanges, toFillValue);
         });
         result.push(traffic);
     });
     return result;
 }
-exports.getNewTraffic = getNewTraffic;
+exports.getTraffic = getTraffic;
 //# sourceMappingURL=traffic.js.map

package/lib/traffic.js.map

@@ -1 +1 @@
-{"version":3,"file":"traffic.js","sourceRoot":"","sources":["../src/traffic.ts"],"names":[],"mappings":";;;AACA,yCAAwD;AAExD,SAAgB,aAAa;AAC3B,oBAAoB;AACpB,UAAuB,EACvB,WAAmB;AAEnB,wBAAwB;AACxB,eAA4C;IAE5C,IAAM,MAAM,GAAc,EAAE,CAAC;IAE7B,WAAW,CAAC,OAAO,CAAC,UAAC,aAAa;QAChC,IAAM,iBAAiB,GAAG,aAAa,CAAC,UAAU,CAAC;QAEnD,IAAM,OAAO,GAAY;YACvB,GAAG,EAAE,aAAa,CAAC,GAAG;YACtB,QAAQ,EACN,OAAO,aAAa,CAAC,QAAQ,KAAK,QAAQ;gBACxC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,QAAQ,CAAC;gBACxC,CAAC,CAAC,aAAa,CAAC,QAAQ;YAC5B,UAAU,EAAE,iBAAiB,GAAG,CAAC,yBAAmB,GAAG,GAAG,CAAC;YAC3D,UAAU,EAAE,EAAE;SACf,CAAC;QAEF,IAAI,aAAa,CAAC,SAAS,EAAE;YAC3B,OAAO,CAAC,SAAS,GAAG,aAAa,CAAC,SAAS,CAAC;SAC7C;QAED,IAAI,aAAa,CAAC,SAAS,EAAE;YAC3B,OAAO,CAAC,SAAS,GAAG,aAAa,CAAC,SAAS,CAAC;SAC7C;QAED,IAAM,sBAAsB,GAAG,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,OAAO,CAAC,IAAI,CAC1D,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,GAAG,KAAK,aAAa,CAAC,GAAG,EAA3B,CAA2B,CACnC,CAAC;QAEF,yEAAyE;QAEzE,yBAAyB;QACzB,uBAAuB;QACvB,8BAA8B;QAC9B,EAAE;QACF,8EAA8E;QAC9E,IAAM,iBAAiB,GAAG,eAAe;YACvC,CAAC,CAAC,IAAI,CAAC,SAAS,CACZ,eAAe,CAAC,UAAU,CAAC,GAAG,CAAC,UAAC,EAAiB;oBAAf,KAAK,WAAA,EAAE,MAAM,YAAA;gBAAO,OAAA,CAAC;oBACrD,KAAK,OAAA;oBACL,MAAM,QAAA;iBACP,CAAC;YAHoD,CAGpD,CAAC,CACJ,KAAK,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,UAAC,EAAiB;oBAAf,KAAK,WAAA,EAAE,MAAM,YAAA;gBAAO,OAAA,CAAC,EAAE,KAAK,OAAA,EAAE,MAAM,QAAA,EAAE,CAAC;YAAnB,CAAmB,CAAC,CAAC;YAClF,CAAC,CAAC,KAAK,CAAC;QAEV,IAAI,cAAc,GAAG,CAAC,CAAC;QAEvB,IAAI,sBAAsB,EAAE;YAC1B,cAAc;gBACZ,iBAAiB,GAAG,sBAAsB,CAAC,UAAU,GAAG,CAAC,yBAAmB,GAAG,GAAG,CAAC,CAAC;YAEtF,IACE,cAAc,GAAG,CAAC;gBAClB,CAAC,iBAAiB,CAAC,8CAA8C;cACjE;gBACA,iDAAiD;gBAEjD,OAAO,CAAC,UAAU,GAAG,sBAAsB,CAAC,UAAU,CAAC,GAAG,CAAC,UAAC,EAAyB;wBAAvB,SAAS,eAAA,EAAE,UAAU,gBAAA;oBACjF,OAAO;wBACL,SAAS,WAAA;wBACT,UAAU,YAAA;qBACX,CAAC;gBACJ,CAAC,CAAC,CAAC;aACJ;SACF;QAED,UAAU,CAAC,OAAO,CAAC,UAAC,SAAS;YAC3B,IAAM,aAAa,GAAG,QAAQ,CAC5B,CACE,CAAE,SAAS,CAAC,MAAiB,GAAG,GAAG,CAAC;gBACpC,iBAAiB;gBACjB,CAAC,yBAAmB,GAAG,GAAG,CAAC,CAC5B,CAAC,OAAO,CAAC,CAAC,CAAC,CACb,CAAC;YAEF,IAAI,CAAC,sBAAsB,IAAI,iBAAiB,KAAK,IAAI,EAAE;gBACzD,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;oBACtB,SAAS,EAAE,SAAS,CAAC,KAAK;oBAC1B,UAAU,EAAE,aAAa;iBAC1B,CAAC,CAAC;gBAEH,OAAO;aACR;YAED,wEAAwE;YACxE,oDAAoD;YACpD,sDAAsD;YAEtD,4HAA4H;YAE5H,IAAI,cAAc,KAAK,CAAC,EAAE;gBACxB,YAAY;gBACZ,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;oBACtB,SAAS,EAAE,SAAS,CAAC,KAAK;oBAC1B,UAAU,EAAE,aAAa;iBAC1B,CAAC,CAAC;gBAEH,OAAO;aACR;YAED,IAAI,cAAc,GAAG,CAAC,EAAE;gBACtB,yCAAyC;gBACzC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;oBACtB,SAAS,EAAE,SAAS,CAAC,KAAK;oBAC1B,UAAU,EAAE,QAAQ,CAClB,CACG,SAAS,CAAC,MAAiB;wBAC5B,CAAC,cAAc,GAAG,GAAG,CAAC;wBACtB,CAAC,yBAAmB,GAAG,GAAG,CAAC,CAC5B,CAAC,OAAO,CAAC,CAAC,CAAC,CACb;iBACF,CAAC,CAAC;gBAEH,OAAO;aACR;YAED,IAAI,cAAc,GAAG,CAAC,EAAE;gBACtB,+BAA+B;gBAE/B,uGAAuG;gBAEvG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;oBACtB,SAAS,EAAE,SAAS,CAAC,KAAK;oBAC1B,UAAU,EAAE,aAAa;iBAC1B,CAAC,CAAC;gBAEH,OAAO;aACR;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AA5ID,sCA4IC"}
+{"version":3,"file":"traffic.js","sourceRoot":"","sources":["../src/traffic.ts"],"names":[],"mappings":";;;AACA,yCAAwD;AAExD,yCAAmF;AAEnF,SAAgB,yBAAyB,CACvC,cAA2B,EAAE,2BAA2B;AACxD,eAAiC;IAEjC,IAAI,CAAC,eAAe,EAAE;QACpB,OAAO,KAAK,CAAC;KACd;IAED,OAAO,CACL,IAAI,CAAC,SAAS,CACZ,eAAe,CAAC,UAAU,CAAC,GAAG,CAAC,UAAC,EAAiB;YAAf,KAAK,WAAA,EAAE,MAAM,YAAA;QAAO,OAAA,CAAC;YACrD,KAAK,OAAA;YACL,MAAM,QAAA;SACP,CAAC;IAHoD,CAGpD,CAAC,CACJ,KAAK,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,GAAG,CAAC,UAAC,EAAiB;YAAf,KAAK,WAAA,EAAE,MAAM,YAAA;QAAO,OAAA,CAAC,EAAE,KAAK,OAAA,EAAE,MAAM,QAAA,EAAE,CAAC;IAAnB,CAAmB,CAAC,CAAC,CACrF,CAAC;AACJ,CAAC;AAhBD,8DAgBC;AAED,SAAgB,qBAAqB,CACnC,iBAA6B,EAAE,YAAY;AAC3C,mBAAmB;IAEnB,IAAI,CAAC,mBAAmB,EAAE;QACxB,OAAO,CAAC,CAAC;KACV;IAED,IAAM,kBAAkB,GAAG,mBAAmB,CAAC,UAAU,CAAC;IAE1D,OAAO,iBAAiB,GAAG,kBAAkB,CAAC;AAChD,CAAC;AAXD,sDAWC;AAED,SAAgB,qBAAqB,CACnC,eAAwB,EAAE,2BAA2B;AACrD,eAAiC;IAEjC,IAAI,CAAC,eAAe,EAAE;QACpB,OAAO,KAAK,CAAC;KACd;IAED,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;QAC3B,OAAO,KAAK,CAAC;KACd;IAED,OAAO,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;AACpF,CAAC;AAbD,sDAaC;AAED,SAAgB,UAAU;AACxB,oBAAoB;AACpB,UAAuB,EACvB,WAAmB;AACnB,wBAAwB;AACxB,eAA4C;AAC5C,0BAA0B;AAC1B,MAAgB;IAEhB,IAAM,MAAM,GAAc,EAAE,CAAC;IAE7B,4CAA4C;IAC5C,IAAM,eAAe,GACnB,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,yBAAmB,EAAE,CAAC,CAAC;IAElF,WAAW,CAAC,OAAO,CAAC,UAAU,UAAU;QACtC,IAAM,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC,UAAU;QAExD,IAAM,OAAO,GAAY;YACvB,GAAG,EAAE,UAAU,CAAC,GAAG;YACnB,QAAQ,EACN,OAAO,UAAU,CAAC,QAAQ,KAAK,QAAQ;gBACrC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,QAAQ,CAAC;gBACrC,CAAC,CAAC,UAAU,CAAC,QAAQ;YACzB,UAAU,EAAE,cAAc,GAAG,CAAC,yBAAmB,GAAG,GAAG,CAAC;YACxD,UAAU,EAAE,EAAE;SACf,CAAC;QAEF,YAAY;QACZ,IAAI,UAAU,CAAC,SAAS,EAAE;YACxB,OAAO,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;SAC1C;QAED,IAAI,UAAU,CAAC,SAAS,EAAE;YACxB,OAAO,CAAC,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;SAC1C;QAED,iBAAiB;QACjB,IAAM,iBAAiB,GAAG,yBAAyB,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;QACjF,IAAM,mBAAmB,GAAG,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,OAAO,CAAC,IAAI,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,GAAG,KAAK,UAAU,CAAC,GAAG,EAAxB,CAAwB,CAAC,CAAC;QAC3F,IAAM,kBAAkB,GAAG,qBAAqB,CAAC,OAAO,CAAC,UAAU,EAAE,mBAAmB,CAAC,CAAC;QAC1F,IAAM,aAAa,GAAG,qBAAqB,CAAC,eAAe,EAAE,eAAe,CAAC,CAAC;QAE9E,IAAM,gBAAgB,GACpB,CAAC,mBAAmB,IAAI,WAAW;YACnC,iBAAiB,IAAI,qBAAqB;YAC1C,kBAAkB,IAAI,CAAC,IAAI,uBAAuB;YAClD,aAAa,CAAC,CAAC,+CAA+C;QAEhE,IAAI,sBAAsB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;QAEzE,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,IAAI,mBAAmB,IAAI,CAAC,gBAAgB,EAAE;YAC5C,iDAAiD;YACjD,IAAI,aAAW,GAAG,CAAC,CAAC;YAEpB,OAAO,CAAC,UAAU,GAAG,mBAAmB,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,EAIjE;oBAHC,SAAS,eAAA,EACT,UAAU,gBAAA,EAAE,2CAA2C;gBACvD,KAAK,WAAA;gBAEL,IAAM,MAAM,GAAG;oBACb,SAAS,WAAA;oBACT,UAAU,YAAA;oBACV,KAAK,EAAE,KAAK,IAAI;wBACd,KAAK,EAAE,OAAO;wBACd,GAAG,EAAE,UAAU;qBAChB;iBACF,CAAC;gBAEF,aAAW,IAAI,UAAU,IAAI,CAAC,CAAC;gBAC/B,OAAO,GAAG,OAAO,GAAG,CAAC,UAAU,IAAI,CAAC,CAAC,CAAC;gBAEtC,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC,CAAC;YAEH,sBAAsB,GAAG,IAAA,iDAAqC,EAAC,eAAe,EAAE,aAAW,CAAC,CAAC;SAC9F;QAED,UAAU,CAAC,OAAO,CAAC,UAAU,SAAS;YACpC,IAAM,MAAM,GAAG,SAAS,CAAC,MAAgB,CAAC;YAC1C,IAAM,UAAU,GAAG,MAAM,GAAG,CAAC,yBAAmB,GAAG,GAAG,CAAC,CAAC;YAExD,IAAI,WAAW,GAAG,gBAAgB;gBAChC,CAAC,CAAC,UAAU,GAAG,CAAC,cAAc,GAAG,GAAG,CAAC,CAAC,cAAc;gBACpD,CAAC,CAAC,CAAC,MAAM,GAAG,GAAG,CAAC,GAAG,kBAAkB,CAAC,CAAC,eAAe;YACxD,IAAM,YAAY,GAAG,IAAA,yBAAa,EAAC,sBAAsB,EAAE,WAAW,CAAC,CAAC;YAExE,YAAY,CAAC,OAAO,CAAC,UAAU,KAAK;gBAClC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC;oBACtB,SAAS,EAAE,SAAS,CAAC,KAAK;oBAC1B,UAAU,EAAE,WAAW;oBACvB,KAAK,OAAA;iBACN,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,sBAAsB,GAAG,IAAA,iDAAqC,EAC5D,sBAAsB,EACtB,WAAW,CACZ,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,OAAO,MAAM,CAAC;AAChB,CAAC;AA1GD,gCA0GC"}