@growthbook/proxy-eval 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 GrowthBook, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+export declare function evaluateFeatures({ payload, attributes, forcedVariations, forcedFeatures, url, ctx, }: {
+    payload: any;
+    attributes: Record<string, any>;
+    forcedVariations?: Record<string, number>;
+    forcedFeatures?: Map<string, any>;
+    url?: string;
+    ctx?: any;
+}): any;

package/dist/index.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.evaluateFeatures = void 0;
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const growthbook_1 = require("@growthbook/growthbook");
+function evaluateFeatures({ payload, attributes, forcedVariations, forcedFeatures, url, ctx, }) {
+    var _a;
+    const evaluatedFeatures = {};
+    const evaluatedExperiments = [];
+    const features = payload === null || payload === void 0 ? void 0 : payload.features;
+    const experiments = payload === null || payload === void 0 ? void 0 : payload.experiments;
+    const context = { attributes };
+    if (features) {
+        context.features = features;
+    }
+    if (experiments) {
+        context.experiments = experiments;
+    }
+    if (forcedVariations) {
+        context.forcedVariations = forcedVariations;
+    }
+    if (url !== undefined) {
+        context.url = url;
+    }
+    if (features || experiments) {
+        const gb = new growthbook_1.GrowthBook(context);
+        if (forcedFeatures) {
+            gb.setForcedFeatures(forcedFeatures);
+        }
+        if (ctx === null || ctx === void 0 ? void 0 : ctx.verboseDebugging) {
+            gb.debug = true;
+        }
+        const gbFeatures = gb.getFeatures();
+        for (const key in gbFeatures) {
+            const result = gb.evalFeature(key);
+            if (result.on || result.experiment) {
+                // reduced feature definition
+                evaluatedFeatures[key] = {
+                    defaultValue: result.value,
+                };
+                if (result.source === "experiment") {
+                    // reduced experiment definition for tracking
+                    const scrubbedResultExperiment = ((_a = result === null || result === void 0 ? void 0 : result.experimentResult) === null || _a === void 0 ? void 0 : _a.variationId) !== undefined
+                        ? scrubExperiment(result.experiment, result.experimentResult.variationId)
+                        : result.experiment;
+                    evaluatedFeatures[key].rules = [
+                        {
+                            force: result.value,
+                            tracks: [{ experiment: scrubbedResultExperiment, result }],
+                        },
+                    ];
+                }
+            }
+        }
+        const gbExperiments = gb.getExperiments();
+        for (const experiment of gbExperiments) {
+            const result = gb.run(experiment);
+            if (result.inExperiment) {
+                // reduced experiment definition
+                const evaluatedExperiment = scrubExperiment(experiment, result.variationId);
+                evaluatedExperiments.push(evaluatedExperiment);
+            }
+        }
+    }
+    return Object.assign(Object.assign({}, payload), { features: evaluatedFeatures, experiments: evaluatedExperiments });
+}
+exports.evaluateFeatures = evaluateFeatures;
+function scrubExperiment(experiment, allowedVariation) {
+    const scrubbedExperiment = Object.assign(Object.assign({}, experiment), { variations: experiment.variations.map((v, i) => allowedVariation === i ? v : {}) });
+    delete scrubbedExperiment.condition;
+    return scrubbedExperiment;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AACvD,uDAA0E;AAE1E,SAAgB,gBAAgB,CAAC,EAC/B,OAAO,EACP,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,GAAG,EACH,GAAG,GAQJ;;IACC,MAAM,iBAAiB,GAAwB,EAAE,CAAC;IAClD,MAAM,oBAAoB,GAAU,EAAE,CAAC;IAEvC,MAAM,QAAQ,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ,CAAC;IACnC,MAAM,WAAW,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,CAAC;IACzC,MAAM,OAAO,GAAc,EAAE,UAAU,EAAE,CAAC;IAC1C,IAAI,QAAQ,EAAE;QACZ,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;KAC7B;IACD,IAAI,WAAW,EAAE;QACf,OAAO,CAAC,WAAW,GAAG,WAAW,CAAC;KACnC;IACD,IAAI,gBAAgB,EAAE;QACpB,OAAO,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;KAC7C;IACD,IAAI,GAAG,KAAK,SAAS,EAAE;QACrB,OAAO,CAAC,GAAG,GAAG,GAAG,CAAC;KACnB;IAED,IAAI,QAAQ,IAAI,WAAW,EAAE;QAC3B,MAAM,EAAE,GAAG,IAAI,uBAAU,CAAC,OAAO,CAAC,CAAC;QACnC,IAAI,cAAc,EAAE;YAClB,EAAE,CAAC,iBAAiB,CAAC,cAAc,CAAC,CAAC;SACtC;QACD,IAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,gBAAgB,EAAE;YACzB,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC;SACjB;QAED,MAAM,UAAU,GAAG,EAAE,CAAC,WAAW,EAAE,CAAC;QACpC,KAAK,MAAM,GAAG,IAAI,UAAU,EAAE;YAC5B,MAAM,MAAM,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACnC,IAAI,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,UAAU,EAAE;gBAClC,6BAA6B;gBAC7B,iBAAiB,CAAC,GAAG,CAAC,GAAG;oBACvB,YAAY,EAAE,MAAM,CAAC,KAAK;iBAC3B,CAAC;gBACF,IAAI,MAAM,CAAC,MAAM,KAAK,YAAY,EAAE;oBAClC,6CAA6C;oBAC7C,MAAM,wBAAwB,GAC5B,CAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,gBAAgB,0CAAE,WAAW,MAAK,SAAS;wBACjD,CAAC,CAAC,eAAe,CACb,MAAM,CAAC,UAAU,EACjB,MAAM,CAAC,gBAAgB,CAAC,WAAW,CACpC;wBACH,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC;oBACxB,iBAAiB,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG;wBAC7B;4BACE,KAAK,EAAE,MAAM,CAAC,KAAK;4BACnB,MAAM,EAAE,CAAC,EAAE,UAAU,EAAE,wBAAwB,EAAE,MAAM,EAAE,CAAC;yBAC3D;qBACF,CAAC;iBACH;aACF;SACF;QAED,MAAM,aAAa,GAAG,EAAE,CAAC,cAAc,EAAE,CAAC;QAC1C,KAAK,MAAM,UAAU,IAAI,aAAa,EAAE;YACtC,MAAM,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAClC,IAAI,MAAM,CAAC,YAAY,EAAE;gBACvB,gCAAgC;gBAChC,MAAM,mBAAmB,GAAG,eAAe,CACzC,UAAU,EACV,MAAM,CAAC,WAAW,CACnB,CAAC;gBACF,oBAAoB,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;aAChD;SACF;KACF;IAED,uCACK,OAAO,KACV,QAAQ,EAAE,iBAAiB,EAC3B,WAAW,EAAE,oBAAoB,IACjC;AACJ,CAAC;AAzFD,4CAyFC;AAED,SAAS,eAAe,CAAC,UAAe,EAAE,gBAAwB;IAChE,MAAM,kBAAkB,mCACnB,UAAU,KACb,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAM,EAAE,CAAS,EAAE,EAAE,CAC1D,gBAAgB,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAChC,GACF,CAAC;IACF,OAAO,kBAAkB,CAAC,SAAS,CAAC;IACpC,OAAO,kBAAkB,CAAC;AAC5B,CAAC"}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@growthbook/proxy-eval",
+  "description": "Remote evaluation service for proxies, edge workers, or backend APIs",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/growthbook/growthbook-proxy.git",
+    "directory": "packages/shared/eval"
+  },
+  "author": "Bryce Fitzsimons",
+  "scripts": {
+    "build:clean": "rimraf -rf dist",
+    "build:typescript": "tsc",
+    "build": "yarn build:clean && yarn build:typescript",
+    "type-check": "tsc --pretty --noEmit",
+    "dev": "tsc --watch"
+  },
+  "dependencies": {
+    "@growthbook/growthbook": "^0.29.0"
+  },
+  "devDependencies": {
+    "rimraf": "^5.0.5",
+    "typescript": "5.2.2"
+  }
+}

package/src/index.ts

@@ -0,0 +1,104 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { GrowthBook, Context as GBContext } from "@growthbook/growthbook";
+
+export function evaluateFeatures({
+  payload,
+  attributes,
+  forcedVariations,
+  forcedFeatures,
+  url,
+  ctx,
+}: {
+  payload: any;
+  attributes: Record<string, any>;
+  forcedVariations?: Record<string, number>;
+  forcedFeatures?: Map<string, any>;
+  url?: string;
+  ctx?: any;
+}) {
+  const evaluatedFeatures: Record<string, any> = {};
+  const evaluatedExperiments: any[] = [];
+
+  const features = payload?.features;
+  const experiments = payload?.experiments;
+  const context: GBContext = { attributes };
+  if (features) {
+    context.features = features;
+  }
+  if (experiments) {
+    context.experiments = experiments;
+  }
+  if (forcedVariations) {
+    context.forcedVariations = forcedVariations;
+  }
+  if (url !== undefined) {
+    context.url = url;
+  }
+
+  if (features || experiments) {
+    const gb = new GrowthBook(context);
+    if (forcedFeatures) {
+      gb.setForcedFeatures(forcedFeatures);
+    }
+    if (ctx?.verboseDebugging) {
+      gb.debug = true;
+    }
+
+    const gbFeatures = gb.getFeatures();
+    for (const key in gbFeatures) {
+      const result = gb.evalFeature(key);
+      if (result.on || result.experiment) {
+        // reduced feature definition
+        evaluatedFeatures[key] = {
+          defaultValue: result.value,
+        };
+        if (result.source === "experiment") {
+          // reduced experiment definition for tracking
+          const scrubbedResultExperiment =
+            result?.experimentResult?.variationId !== undefined
+              ? scrubExperiment(
+                  result.experiment,
+                  result.experimentResult.variationId,
+                )
+              : result.experiment;
+          evaluatedFeatures[key].rules = [
+            {
+              force: result.value,
+              tracks: [{ experiment: scrubbedResultExperiment, result }],
+            },
+          ];
+        }
+      }
+    }
+
+    const gbExperiments = gb.getExperiments();
+    for (const experiment of gbExperiments) {
+      const result = gb.run(experiment);
+      if (result.inExperiment) {
+        // reduced experiment definition
+        const evaluatedExperiment = scrubExperiment(
+          experiment,
+          result.variationId,
+        );
+        evaluatedExperiments.push(evaluatedExperiment);
+      }
+    }
+  }
+
+  return {
+    ...payload,
+    features: evaluatedFeatures,
+    experiments: evaluatedExperiments,
+  };
+}
+
+function scrubExperiment(experiment: any, allowedVariation: number) {
+  const scrubbedExperiment = {
+    ...experiment,
+    variations: experiment.variations.map((v: any, i: number) =>
+      allowedVariation === i ? v : {},
+    ),
+  };
+  delete scrubbedExperiment.condition;
+  return scrubbedExperiment;
+}

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "strict": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "es6",
+    "noImplicitAny": true,
+    "moduleResolution": "node",
+    "sourceMap": true,
+    "outDir": "dist",
+    "declaration": true,
+    "typeRoots": ["node_modules/@types", "./typings"],
+    "strictNullChecks": true,
+    "strictBindCallApply": true,
+    "strictPropertyInitialization": true,
+    "incremental": true
+  },
+  "include": [
+    "src/**/*"
+  ]
+}