statsig-node-vercel 0.0.1-beta.0 → 0.0.1-beta.2

package/EdgeConfigDataAdapter.ts

@@ -1,7 +1,7 @@
-import { AdapterResponse, IDataAdapter, DataAdapterKey } from 'statsig-node';
+import { AdapterResponse, IDataAdapter } from 'statsig-node';
 import { get } from '@vercel/edge-config';
 
-interface Data {
+type Data = {
   dynamic_configs: Record<string, unknown>[];
   feature_gates: Record<string, unknown>[];
   has_updates: boolean;
@@ -12,24 +12,24 @@ interface Data {
 }
 
 export class EdgeConfigDataAdapter implements IDataAdapter {
-  private key: string;
-  private cache: Map<string, string>;
-  private timeCache: Map<string, number>;
+  private configSpecsKey: string;
+  private supportConfigSpecPolling: boolean = false;
 
   public constructor(key: string) {
-    this.key = key;
-    this.cache = new Map<string, string>();
-    this.timeCache = new Map<string, number>();
+    this.configSpecsKey = key; 
   }
 
   // eslint-disable-next-line @typescript-eslint/require-await
   public async get(key: string): Promise<AdapterResponse> {
-    const value = this.cache.get(key);
-    if (value === undefined) {
+    if (key !== "statsig.cache") {
+      return { error: new Error(`Edge Config Adapter Only Supports Config Specs`) };
+    }
+
+    const data = await get<Data>(this.configSpecsKey);
+    if (data === undefined) {
       return { error: new Error(`key (${key}) does not exist`) };
     }
-    const time = this.timeCache.get(key);
-    return { result: value, time };
+    return { result: JSON.stringify(data), };
   }
 
   // eslint-disable-next-line @typescript-eslint/require-await
@@ -42,22 +42,21 @@ export class EdgeConfigDataAdapter implements IDataAdapter {
   }
 
   public async initialize(): Promise<void> {
-    const data = await get<Data>(this.key);
+    const data = await get<Data>(this.configSpecsKey);
 
     if (data) {
-      this.cache.set('statsig.cache', JSON.stringify(data));
-      this.timeCache.set('statsig.cache', data.time);
+      this.supportConfigSpecPolling = true;
     }
   }
 
   // eslint-disable-next-line @typescript-eslint/require-await
   public async shutdown(): Promise<void> {
-    this.cache.clear();
+    
   }
 
-  public supportsPollingUpdatesFor(key: DataAdapterKey): boolean {
-    if (key === DataAdapterKey.Rulesets) {
-      return true;
+  public supportsPollingUpdatesFor(key: string): boolean {
+    if (key === "statsig.cache") {
+      return this.supportConfigSpecPolling;
     }
     return false;
   }

package/README.md

@@ -1,50 +1,30 @@
-# Statsig Node Server SDK - Redis Integration
-[![npm version](https://badge.fury.io/js/statsig-node-redis.svg)](https://badge.fury.io/js/statsig-node-redis) 
+# 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) 
 
-A first party Redis integration with the [Statsig server-side Node.js SDK](https://github.com/statsig-io/node-js-server-sdk).
+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 *NOTE: (For now, you will need the latest beta version 4.18.0-beta.7)*
+1. Install the Statsig Node SDK *NOTE: (For now, you will need the latest beta version v5.1.0-beta.1)*
 ```
-npm install statsig-node@4.18.0-beta.7
+npm install statsig-node@5.1.0-beta.1
 ```
 2. Install this package
 ```
-npm install statsig-node-redis
+npm install statsig-node-vercel
 ```
-3. Import the package
+3. Install the [Statsig Vercel App](https://vercel.com/integrations/statsig)
+4. Import the package
 ```
-import { RedisDataAdapter } from 'statsig-node-redis'
+import { EdgeConfigDataAdapter } from 'statsig-node-vercel'
 ```
-4. Create an instance of the `RedisDataAdapter`
+5. Create an instance of the `EdgeConfigDataAdapter`
 ```
-const dataAdapter = new RedisDataAdapter();
+const dataAdapter = new EdgeConfigDataAdapter('KEY_FROM_INSTALLATION');
 ```
-5. When initializing the `statsig` sdk, add the adapter to options
+6. When initializing the `statsig` sdk, add the adapter to options
 ```
 await statsig.initialize(
     'server-secret-key',
     { dataAdapter: dataAdapter },
 );
 ```
-
-## Customizing the adapter
-When initializing `RedisDataAdapter`, you can specify the following options:
-```
-const dataAdapter = new RedisDataAdapter(
-  hostname,
-  port,
-  password,
-  db,
-);
-```
-
-| param | default | description |
-| --- | --- | --- |
-| hostname  | 'localhost' | Redis server hostname |
-| port  | 6379 | Redis server port |
-| password  | | ACL password or the old "--requirepass" password |
-| db | 0 | Redis database number (supports 16 databases) |
-
-## Links
-[Node Redis](https://github.com/redis/node-redis)

package/__tests__/EdgeConfigDataAdapter.test.ts

@@ -1,37 +1,26 @@
 import { EdgeConfigDataAdapter } from '../EdgeConfigDataAdapter';
-import * as statsigsdk from 'statsig-node';
-// @ts-ignore
-const statsig = statsigsdk.default;
+import fetchMock from "jest-fetch-mock"
 
 describe('Validate edge config adapter functionality', () => {
   const dataAdapter = new EdgeConfigDataAdapter(
-    'statsig-3Xl7zBzgVt7La7nzjE0m9V'
+    'statsig-companyid'
   );
-  const statsigOptions = {
-    dataAdapter: dataAdapter,
-    environment: { tier: 'staging' },
-  };
-  const user = {
-    userID: '12345',
-    email: 'kenny@nfl.com',
-    custom: { level: 9 },
-  };
 
   beforeEach(async () => {
-    statsig._instance = null;
+    fetchMock.enableMocks()
+    fetchMock.mockResponse('"test123"');
     await dataAdapter.initialize();
-  })
+  }); 
 
   afterEach(async () => {
     await dataAdapter.shutdown();
   });
 
-  test('Simple get/set', async () => {
-    dataAdapter.set('gates', 'test123');
-    const { result: gates } = await dataAdapter.get('gates');
+  test('Simple get', async () => {
+    const { result: gates } = await dataAdapter.get("statsig.cache");
     if (gates == null) {
       return;
     }
-    expect(gates).toEqual('test123');
+    expect(gates).toEqual('"test123"');
   });
 })

package/jest.setup.js

@@ -0,0 +1,12 @@
+// @ts-nocheck
+global.console = {
+    log: console.log, // console.log are kept in tests for debugging
+
+    // Mock other console functions so they don't pollute the console when running test
+    error: jest.fn(),
+    warn: jest.fn(),
+    info: jest.fn(),
+    debug: jest.fn(),
+};
+
+jest.setTimeout(20000);

package/package.json

@@ -1,18 +1,19 @@
 {
   "name": "statsig-node-vercel",
-  "version": "0.0.1-beta.0",
+  "version": "0.0.1-beta.2",
   "description": "",
   "main": "index.js",
   "scripts": {
     "prepare": "rm -rf dist/ && tsc",
-    "test": "npm run prepare && pnpm jest"
+    "test": "npm run prepare && EDGE_CONFIG=\"https://edge-config.vercel.com/ecfg_123?token=123\" pnpm jest"
   },
   "types": "./index.d.ts",
   "keywords": [],
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@vercel/edge-config": "^0.1.0-canary.15"
+    "@vercel/edge-config": "^0.1.0-canary.15",
+    "statsig-node": "5.1.0-beta.5"
   },
   "devDependencies": {
     "@babel/core": "^7.18.13",
@@ -20,6 +21,6 @@
     "@babel/preset-typescript": "^7.18.6",
     "@types/jest": "^28.1.8",
     "jest": "^29.0.0",
-    "statsig-node": "5.1.0-beta.1"
+    "jest-fetch-mock": "^3.0.3"
   }
 }