@featurevisor/sdk 0.15.0 → 0.17.0

package/src/feature.ts

@@ -13,24 +13,56 @@ import { allConditionsAreMatched } from "./conditions";
 import { VariableSchema } from "@featurevisor/types/src";
 import { Logger } from "./logger";
 
-export function getMatchedTraffic(
+/**
+ * Traffic
+ */
+export function getMatchedAllocation(
+  traffic: Traffic,
+  bucketValue: number,
+): Allocation | undefined {
+  let total = 0; // @TODO: remove it in next breaking semver
+  const usePercentage =
+    traffic.allocation.length > 0 && typeof traffic.allocation[0].range === "undefined"; // @TODO: remove it in next breaking semver
+
+  for (const allocation of traffic.allocation) {
+    if (
+      allocation.range &&
+      allocation.range.start <= bucketValue &&
+      allocation.range.end >= bucketValue
+    ) {
+      return allocation;
+    }
+
+    // @TODO: remove it in next breaking semver
+    if (usePercentage) {
+      total += allocation.percentage || 0;
+      if (bucketValue <= total) {
+        return allocation;
+      }
+    }
+  }
+
+  return undefined;
+}
+
+export interface MatchedTrafficAndAllocation {
+  matchedTraffic: Traffic | undefined;
+  matchedAllocation: Allocation | undefined;
+}
+
+export function getMatchedTrafficAndAllocation(
   traffic: Traffic[],
   attributes: Attributes,
   bucketValue: number,
   datafileReader: DatafileReader,
   logger: Logger,
-): Traffic | undefined {
-  return traffic.find((traffic) => {
-    if (bucketValue > traffic.percentage) {
-      // out of bucket range
-      return false;
-    }
+): MatchedTrafficAndAllocation {
+  let matchedAllocation: Allocation | undefined;
 
+  const matchedTraffic = traffic.find((t) => {
     if (
       !allGroupSegmentsAreMatched(
-        typeof traffic.segments === "string" && traffic.segments !== "*"
-          ? JSON.parse(traffic.segments)
-          : traffic.segments,
+        typeof t.segments === "string" && t.segments !== "*" ? JSON.parse(t.segments) : t.segments,
         attributes,
         datafileReader,
       )
@@ -38,32 +70,24 @@ export function getMatchedTraffic(
       return false;
     }
 
-    logger.debug("matched rule", {
-      ruleKey: traffic.key,
-    });
-
-    return true;
-  });
-}
-
-// @TODO: make this function better with tests
-export function getMatchedAllocation(
-  matchedTraffic: Traffic,
-  bucketValue: number,
-): Allocation | undefined {
-  let total = 0;
-
-  for (const allocation of matchedTraffic.allocation) {
-    total += allocation.percentage;
+    matchedAllocation = getMatchedAllocation(t, bucketValue);
 
-    if (bucketValue <= total) {
-      return allocation;
+    if (matchedAllocation) {
+      return true;
     }
-  }
 
-  return undefined;
+    return false;
+  });
+
+  return {
+    matchedTraffic,
+    matchedAllocation,
+  };
 }
 
+/**
+ * Variations and variables
+ */
 function findForceFromFeature(
   feature: Feature,
   attributes: Attributes,
@@ -107,7 +131,7 @@ export function getBucketedVariation(
   datafileReader: DatafileReader,
   logger: Logger,
 ): Variation | undefined {
-  const matchedTraffic = getMatchedTraffic(
+  const { matchedTraffic, matchedAllocation } = getMatchedTrafficAndAllocation(
     feature.traffic,
     attributes,
     bucketValue,
@@ -140,9 +164,7 @@ export function getBucketedVariation(
     }
   }
 
-  const allocation = getMatchedAllocation(matchedTraffic, bucketValue);
-
-  if (!allocation) {
+  if (!matchedAllocation) {
     logger.debug("no matched allocation found", {
       featureKey: feature.key,
       bucketValue,
@@ -151,7 +173,7 @@ export function getBucketedVariation(
     return undefined;
   }
 
-  const variationValue = allocation.variation;
+  const variationValue = matchedAllocation.variation;
 
   const variation = feature.variations.find((v) => {
     return v.value === variationValue;
@@ -207,7 +229,7 @@ export function getBucketedVariableValue(
   logger: Logger,
 ): VariableValue | undefined {
   // get traffic
-  const matchedTraffic = getMatchedTraffic(
+  const { matchedTraffic, matchedAllocation } = getMatchedTrafficAndAllocation(
     feature.traffic,
     attributes,
     bucketValue,
@@ -238,9 +260,7 @@ export function getBucketedVariableValue(
     return matchedTraffic.variables[variableKey];
   }
 
-  const allocation = getMatchedAllocation(matchedTraffic, bucketValue);
-
-  if (!allocation) {
+  if (!matchedAllocation) {
     logger.debug("no matched allocation found", {
       featureKey: feature.key,
       variableKey,
@@ -250,7 +270,7 @@ export function getBucketedVariableValue(
     return undefined;
   }
 
-  const variationValue = allocation.variation;
+  const variationValue = matchedAllocation.variation;
 
   const variation = feature.variations.find((v) => {
     return v.value === variationValue;