@statsig/js-local-overrides 0.0.1-beta.10

package/.eslintrc.json

@@ -0,0 +1,25 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": "error"
+      }
+    }
+  ]
+}

package/jest.config.ts

@@ -0,0 +1,10 @@
+/* eslint-disable */
+export default {
+  displayName: 'js-local-overrides',
+  preset: '../../jest.preset.js',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', { tsconfig: '<rootDir>/tsconfig.spec.json' }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '../../coverage/packages/js-local-overrides',
+};

package/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@statsig/js-local-overrides",
+  "version": "0.0.1-beta.10",
+  "dependencies": {
+    "@statsig/client-core": "0.0.1-beta.10"
+  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts"
+}

package/project.json

@@ -0,0 +1,33 @@
+{
+  "name": "js-local-overrides",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "packages/js-local-overrides/src",
+  "projectType": "library",
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/packages/js-local-overrides",
+        "main": "packages/js-local-overrides/src/index.ts",
+        "tsConfig": "packages/js-local-overrides/tsconfig.lib.json",
+        "assets": []
+      }
+    },
+    "publish": {
+      "command": "node tools/scripts/publish.mjs js-local-overrides {args.ver} {args.tag}",
+      "dependsOn": ["build"]
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint"
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "packages/js-local-overrides/jest.config.ts"
+      }
+    }
+  },
+  "tags": []
+}

package/src/LocalOverrideAdapter.ts

@@ -0,0 +1,101 @@
+import {
+  DynamicConfig,
+  Experiment,
+  FeatureGate,
+  Layer,
+  OverrideAdapter,
+  StatsigUser,
+} from '@statsig/client-core';
+
+const LOCAL_OVERRIDE_REASON = 'LocalOverride';
+
+type OverrideStore = {
+  gate: Record<string, boolean>;
+  dynamicConfig: Record<string, Record<string, unknown>>;
+  experiment: OverrideStore['dynamicConfig'];
+  layer: OverrideStore['dynamicConfig'];
+};
+
+export class LocalOverrideAdapter implements OverrideAdapter {
+  private readonly _overrides: OverrideStore = {
+    gate: {},
+    dynamicConfig: {},
+    experiment: {},
+    layer: {},
+  };
+
+  overrideGate(name: string, value: boolean): void {
+    this._overrides.gate[name] = value;
+  }
+
+  getGateOverride(
+    current: FeatureGate,
+    _user: StatsigUser,
+  ): FeatureGate | null {
+    const overridden = this._overrides.gate[current.name];
+    if (overridden == null) {
+      return null;
+    }
+
+    return {
+      ...current,
+      value: overridden,
+      details: { ...current.details, reason: LOCAL_OVERRIDE_REASON },
+    };
+  }
+
+  overrideDynamicConfig(name: string, value: Record<string, unknown>): void {
+    this._overrides.dynamicConfig[name] = value;
+  }
+
+  getDynamicConfigOverride(
+    current: DynamicConfig,
+    _user: StatsigUser,
+  ): DynamicConfig | null {
+    return this._getConfigOverride(current, this._overrides.dynamicConfig);
+  }
+
+  overrideExperiment(name: string, value: Record<string, unknown>): void {
+    this._overrides.experiment[name] = value;
+  }
+
+  getExperimentOverride(
+    current: Experiment,
+    _user: StatsigUser,
+  ): Experiment | null {
+    return this._getConfigOverride(current, this._overrides.experiment);
+  }
+
+  overrideLayer(name: string, value: Record<string, unknown>): void {
+    this._overrides.layer[name] = value;
+  }
+
+  getLayerOverride(current: Layer, _user: StatsigUser): Layer | null {
+    const overridden = this._overrides.layer[current.name];
+    if (overridden == null) {
+      return null;
+    }
+
+    return {
+      ...current,
+      _value: overridden,
+      details: { ...current.details, reason: LOCAL_OVERRIDE_REASON },
+    };
+  }
+
+  private _getConfigOverride<T extends Experiment | DynamicConfig>(
+    current: T,
+    lookup: Record<string, Record<string, unknown>>,
+  ): T | null {
+    const overridden = lookup[current.name];
+    if (overridden == null) {
+      return null;
+    }
+
+    return {
+      ...current,
+      value: overridden,
+      details: { ...current.details, reason: LOCAL_OVERRIDE_REASON },
+    };
+  }
+}

package/src/__tests__/LocalOverrides.test.ts

@@ -0,0 +1,45 @@
+import {
+  makeDynamicConfig,
+  makeFeatureGate,
+  makeLayer,
+} from '@statsig/client-core';
+
+import { LocalOverrideAdapter } from '../LocalOverrideAdapter';
+
+describe('Local Overrides', () => {
+  const user = { userID: 'a-user' };
+  const gate = makeFeatureGate('a_gate', { reason: '' }, null);
+  const dynamicConfig = makeDynamicConfig('a_config', { reason: '' }, null);
+  const experiment = makeDynamicConfig('an_experiment', { reason: '' }, null);
+  const layer = makeLayer('a_layer', { reason: '' }, null);
+
+  let provider: LocalOverrideAdapter;
+
+  beforeAll(() => {
+    provider = new LocalOverrideAdapter();
+  });
+
+  it('returns overidden gates', () => {
+    provider.overrideGate(gate.name, true);
+    const overridden = provider.getGateOverride(gate, user);
+    expect(overridden?.value).toBe(true);
+  });
+
+  it('returns overidden dynamic configs', () => {
+    provider.overrideDynamicConfig(dynamicConfig.name, { dc: 'value' });
+    const overridden = provider.getDynamicConfigOverride(dynamicConfig, user);
+    expect(overridden?.value).toEqual({ dc: 'value' });
+  });
+
+  it('returns overidden experiment', () => {
+    provider.overrideExperiment(experiment.name, { exp: 'value' });
+    const overridden = provider.getExperimentOverride(experiment, user);
+    expect(overridden?.value).toEqual({ exp: 'value' });
+  });
+
+  it('returns overidden layer', () => {
+    provider.overrideLayer(layer.name, { layer_key: 'value' });
+    const overridden = provider.getLayerOverride(layer, user);
+    expect(overridden?._value).toEqual({ layer_key: 'value' });
+  });
+});

package/src/index.ts

@@ -0,0 +1 @@
+export * from './LocalOverrideAdapter';

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {},
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

package/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,17 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"],
+    "resolveJsonModule": true,
+    "esModuleInterop": true,
+    "sourceMap": true
+  },
+  "include": [
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.d.ts"
+  ]
+}