statsig-node-vercel 0.5.0 → 0.6.0

package/EdgeConfigDataAdapter.ts

@@ -1,28 +1,55 @@
-import { AdapterResponse, IDataAdapter } from 'statsig-node';
-import { createClient, EdgeConfigClient } from '@vercel/edge-config';
+import { AdapterResponse, IDataAdapter } from "statsig-node";
+import type { EdgeConfigClient } from "@vercel/edge-config";
 
 export class EdgeConfigDataAdapter implements IDataAdapter {
-  private configSpecsKey: string;
+  /**
+   * The key under which Statisg specs are stored in Edge Config
+   */
+  private edgeConfigItemKey: string;
+  /**
+   * A fully configured Edge Config client
+   */
   private edgeConfigClient: EdgeConfigClient;
   private supportConfigSpecPolling: boolean = false;
 
-  public constructor(key: string, connectionString: string = process.env.EDGE_CONFIG!) {
-    this.configSpecsKey = key; 
-    this.edgeConfigClient = createClient(connectionString);
+  public constructor(options: {
+    /**
+     * The key under which Statsig specs are stored in Edge Config
+     */
+    edgeConfigItemKey: string;
+    /**
+     * A fully configured Edge Config client.
+     *
+     * @example <caption>Creating an Edge Config client</caption>
+     *
+     * ```js
+     * import { createClient } from "@vercel/edge-config";
+     *
+     * createClient(process.env.EDGE_CONFIG)
+     * ```
+     */
+    edgeConfigClient: EdgeConfigClient;
+  }) {
+    this.edgeConfigItemKey = options.edgeConfigItemKey;
+    this.edgeConfigClient = options.edgeConfigClient;
   }
 
   // eslint-disable-next-line @typescript-eslint/require-await
   public async get(key: string): Promise<AdapterResponse> {
-    if (key !== "statsig.cache") {
-      return { error: new Error(`Edge Config Adapter Only Supports Config Specs`) };
+    if (!this.isConfgSpecKey(key)) {
+      return {
+        error: new Error(`Edge Config Adapter Only Supports Config Specs`),
+      };
     }
 
-    const data = await this.edgeConfigClient.get(this.configSpecsKey);
+    const data = await this.edgeConfigClient.get(this.edgeConfigItemKey);
     if (data == null) {
       return { error: new Error(`key (${key}) does not exist`) };
     }
     if (typeof data !== "object") {
-      return { error: new Error(`Edge Config value expected to be an object or array`) };
+      return {
+        error: new Error(`Edge Config value expected to be an object or array`),
+      };
     }
     return { result: data };
   }
@@ -31,13 +58,13 @@ export class EdgeConfigDataAdapter implements IDataAdapter {
   public async set(
     key: string,
     value: string,
-    time?: number | undefined,
+    time?: number | undefined
   ): Promise<void> {
     // no-op. Statsig's Edge Config integration keeps config specs synced through Statsig's service
   }
 
   public async initialize(): Promise<void> {
-    const data = await this.edgeConfigClient.get(this.configSpecsKey);
+    const data = await this.edgeConfigClient.get(this.edgeConfigItemKey);
 
     if (data) {
       this.supportConfigSpecPolling = true;
@@ -45,14 +72,17 @@ export class EdgeConfigDataAdapter implements IDataAdapter {
   }
 
   // eslint-disable-next-line @typescript-eslint/require-await
-  public async shutdown(): Promise<void> {
-    
-  }
+  public async shutdown(): Promise<void> {}
 
   public supportsPollingUpdatesFor(key: string): boolean {
-    if (key === "statsig.cache") {
+    if (this.isConfgSpecKey(key)) {
       return this.supportConfigSpecPolling;
     }
     return false;
   }
+
+  private isConfgSpecKey(key: string): boolean {
+    const v2CacheKeyPattern = /^statsig\|\/v[12]\/download_config_specs\|.+\|.+/;
+    return key === "statsig.cache" || v2CacheKeyPattern.test(key);
+  }
 }

package/README.md

@@ -1,30 +1,43 @@
 # Statsig Node Server SDK - Edge Config Adapter
-[![npm version](https://badge.fury.io/js/statsig-node-vercel.svg)](https://badge.fury.io/js/statsig-node-vercel) 
+
+[![npm version](https://badge.fury.io/js/statsig-node-vercel.svg)](https://badge.fury.io/js/statsig-node-vercel)
 
 A first party Edge Config integration with the [Statsig server-side Node.js SDK](https://github.com/statsig-io/node-js-server-sdk).
 
 ## Quick Setup
+
 1. Install the Statsig Node SDK
-```
+
+```sh
 npm install statsig-node@5.3.0
 ```
-2. Install this package
-```
-npm install statsig-node-vercel
+
+2. Install this package and the Edge Config SDK
+
+```sh
+npm install statsig-node-vercel @vercel/edge-config
 ```
+
 3. Install the [Statsig Vercel Integration](https://vercel.com/integrations/statsig)
-4. Import the package
-```
-import { EdgeConfigDataAdapter } from 'statsig-node-vercel'
+4. Import the packages
+
+```js
+import { EdgeConfigDataAdapter } from "statsig-node-vercel";
+import { createClient } from "@vercel/edge-config";
 ```
+
 5. Create an instance of the `EdgeConfigDataAdapter`
+
+```js
+const edgeConfigClient = createClient(process.env.EDGE_CONFIG);
+const dataAdapter = new EdgeConfigDataAdapter({
+  edgeConfigClient: edgeConfigClient,
+  edgeConfigItemKey: "ITEM_KEY_FROM_INSTALLATION", // something like "statsig-5FSfBpWM9kUPqeKRlZPkod"
+})
 ```
-const dataAdapter = new EdgeConfigDataAdapter('KEY_FROM_INSTALLATION');
-```
-6. When initializing the `statsig` sdk, add the adapter to options
-```
-await statsig.initialize(
-    'server-secret-key',
-    { dataAdapter: dataAdapter },
-);
+
+6. When initializing the `statsig` sdk, add the adapter to options, along with the initStrategyForIDLists and disableIdListsSync options to avoid a blocking network call for ID Lists. However, if you are using Statsig ID lists for evaluation, you'll need to omit those options and incur a network request to grab ID lists. 
+
+```js
+await statsig.initialize("server-secret-key", { dataAdapter: dataAdapter, initStrategyForIDLists: 'none', disableIdListsSync: true });
 ```

package/__tests__/EdgeConfigDataAdapter.test.ts

@@ -1,26 +1,36 @@
-import { EdgeConfigDataAdapter } from '../EdgeConfigDataAdapter';
-import fetchMock from "jest-fetch-mock"
+import { EdgeConfigDataAdapter } from "../EdgeConfigDataAdapter";
+import { createClient } from "@vercel/edge-config";
+import fetchMock from "jest-fetch-mock";
 
-describe('Validate edge config adapter functionality', () => {
-  const dataAdapter = new EdgeConfigDataAdapter(
-    'statsig-companyid'
-  );
+describe("Validate edge config adapter functionality", () => {
+  const edgeConfigClient = createClient(process.env.EDGE_CONFIG);
+  const dataAdapter = new EdgeConfigDataAdapter({
+    edgeConfigItemKey: "statsig-companyid",
+    edgeConfigClient,
+  });
 
   beforeEach(async () => {
-    fetchMock.enableMocks()
-    fetchMock.mockResponse('"test123"');
+    fetchMock.enableMocks();
+    fetchMock.mockResponse('{"a":1}');
     await dataAdapter.initialize();
-  }); 
+  });
 
   afterEach(async () => {
     await dataAdapter.shutdown();
   });
 
-  test('Simple get', async () => {
+  test("Simple get", async () => {
     const { result: gates } = await dataAdapter.get("statsig.cache");
-    if (gates == null) {
-      return;
-    }
-    expect(gates).toEqual('"test123"');
+    expect(gates).toEqual({a: 1});
+  });
+  
+  test('Simple get v2 key', async () => {
+    const { result: gates }  = await dataAdapter.get("statsig|/v1/download_config_specs|plain_text|1234");
+    expect(gates).toEqual({a: 1});
+  });
+
+  test('Simple get v2 key with dcs v2', async () => {
+    const { result: gates }  = await dataAdapter.get("statsig|/v2/download_config_specs|plain_text|1234");
+    expect(gates).toEqual({a: 1});
   });
-})
+});

package/dist/EdgeConfigDataAdapter.d.ts

@@ -1,12 +1,37 @@
-import { AdapterResponse, IDataAdapter } from 'statsig-node';
+import { AdapterResponse, IDataAdapter } from "statsig-node";
+import type { EdgeConfigClient } from "@vercel/edge-config";
 export declare class EdgeConfigDataAdapter implements IDataAdapter {
-    private configSpecsKey;
+    /**
+     * The key under which Statisg specs are stored in Edge Config
+     */
+    private edgeConfigItemKey;
+    /**
+     * A fully configured Edge Config client
+     */
     private edgeConfigClient;
     private supportConfigSpecPolling;
-    constructor(key: string, connectionString?: string);
+    constructor(options: {
+        /**
+         * The key under which Statsig specs are stored in Edge Config
+         */
+        edgeConfigItemKey: string;
+        /**
+         * A fully configured Edge Config client.
+         *
+         * @example <caption>Creating an Edge Config client</caption>
+         *
+         * ```js
+         * import { createClient } from "@vercel/edge-config";
+         *
+         * createClient(process.env.EDGE_CONFIG)
+         * ```
+         */
+        edgeConfigClient: EdgeConfigClient;
+    });
     get(key: string): Promise<AdapterResponse>;
     set(key: string, value: string, time?: number | undefined): Promise<void>;
     initialize(): Promise<void>;
     shutdown(): Promise<void>;
     supportsPollingUpdatesFor(key: string): boolean;
+    private isConfgSpecKey;
 }

package/dist/EdgeConfigDataAdapter.js

@@ -10,25 +10,28 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EdgeConfigDataAdapter = void 0;
-const edge_config_1 = require("@vercel/edge-config");
 class EdgeConfigDataAdapter {
-    constructor(key, connectionString = process.env.EDGE_CONFIG) {
+    constructor(options) {
         this.supportConfigSpecPolling = false;
-        this.configSpecsKey = key;
-        this.edgeConfigClient = (0, edge_config_1.createClient)(connectionString);
+        this.edgeConfigItemKey = options.edgeConfigItemKey;
+        this.edgeConfigClient = options.edgeConfigClient;
     }
     // eslint-disable-next-line @typescript-eslint/require-await
     get(key) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (key !== "statsig.cache") {
-                return { error: new Error(`Edge Config Adapter Only Supports Config Specs`) };
+            if (!this.isConfgSpecKey(key)) {
+                return {
+                    error: new Error(`Edge Config Adapter Only Supports Config Specs`),
+                };
             }
-            const data = yield this.edgeConfigClient.get(this.configSpecsKey);
+            const data = yield this.edgeConfigClient.get(this.edgeConfigItemKey);
             if (data == null) {
                 return { error: new Error(`key (${key}) does not exist`) };
             }
             if (typeof data !== "object") {
-                return { error: new Error(`Edge Config value expected to be an object or array`) };
+                return {
+                    error: new Error(`Edge Config value expected to be an object or array`),
+                };
             }
             return { result: data };
         });
@@ -41,7 +44,7 @@ class EdgeConfigDataAdapter {
     }
     initialize() {
         return __awaiter(this, void 0, void 0, function* () {
-            const data = yield this.edgeConfigClient.get(this.configSpecsKey);
+            const data = yield this.edgeConfigClient.get(this.edgeConfigItemKey);
             if (data) {
                 this.supportConfigSpecPolling = true;
             }
@@ -49,14 +52,17 @@ class EdgeConfigDataAdapter {
     }
     // eslint-disable-next-line @typescript-eslint/require-await
     shutdown() {
-        return __awaiter(this, void 0, void 0, function* () {
-        });
+        return __awaiter(this, void 0, void 0, function* () { });
     }
     supportsPollingUpdatesFor(key) {
-        if (key === "statsig.cache") {
+        if (this.isConfgSpecKey(key)) {
             return this.supportConfigSpecPolling;
         }
         return false;
     }
+    isConfgSpecKey(key) {
+        const v2CacheKeyPattern = /^statsig\|\/v[12]\/download_config_specs\|.+\|.+/;
+        return key === "statsig.cache" || v2CacheKeyPattern.test(key);
+    }
 }
 exports.EdgeConfigDataAdapter = EdgeConfigDataAdapter;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "statsig-node-vercel",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "",
   "main": "dist/index.js",
   "scripts": {