statsig-node-vercel 0.0.1-beta.0

package/EdgeConfigDataAdapter.ts

@@ -0,0 +1,64 @@
+import { AdapterResponse, IDataAdapter, DataAdapterKey } from 'statsig-node';
+import { get } from '@vercel/edge-config';
+
+interface Data {
+  dynamic_configs: Record<string, unknown>[];
+  feature_gates: Record<string, unknown>[];
+  has_updates: boolean;
+  id_lists: unknown;
+  layer_configs: unknown[];
+  layers: unknown;
+  time: number;
+}
+
+export class EdgeConfigDataAdapter implements IDataAdapter {
+  private key: string;
+  private cache: Map<string, string>;
+  private timeCache: Map<string, number>;
+
+  public constructor(key: string) {
+    this.key = key;
+    this.cache = new Map<string, string>();
+    this.timeCache = new Map<string, number>();
+  }
+
+  // eslint-disable-next-line @typescript-eslint/require-await
+  public async get(key: string): Promise<AdapterResponse> {
+    const value = this.cache.get(key);
+    if (value === undefined) {
+      return { error: new Error(`key (${key}) does not exist`) };
+    }
+    const time = this.timeCache.get(key);
+    return { result: value, time };
+  }
+
+  // eslint-disable-next-line @typescript-eslint/require-await
+  public async set(
+    key: string,
+    value: string,
+    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 get<Data>(this.key);
+
+    if (data) {
+      this.cache.set('statsig.cache', JSON.stringify(data));
+      this.timeCache.set('statsig.cache', data.time);
+    }
+  }
+
+  // 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;
+    }
+    return false;
+  }
+}

package/LICENSE

@@ -0,0 +1,14 @@
+ISC License (ISC)
+Copyright (c) 2022, Statsig, Inc.
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.

package/README.md

@@ -0,0 +1,50 @@
+# 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) 
+
+A first party Redis 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)*
+```
+npm install statsig-node@4.18.0-beta.7
+```
+2. Install this package
+```
+npm install statsig-node-redis
+```
+3. Import the package
+```
+import { RedisDataAdapter } from 'statsig-node-redis'
+```
+4. Create an instance of the `RedisDataAdapter`
+```
+const dataAdapter = new RedisDataAdapter();
+```
+5. 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

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

package/babel.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  presets: [
+    ['@babel/preset-env', { targets: { node: 'current' } }],
+    '@babel/preset-typescript',
+  ],
+};

package/index.ts

@@ -0,0 +1,7 @@
+import * as EdgeConfigDataAdapter from './EdgeConfigDataAdapter';
+import * as Statsig from 'statsig-node';
+
+module.exports = {
+  EdgeConfigDataAdapter,
+  Statsig
+}

package/jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  roots: ['./'],
+  testMatch: ['**/__tests__/**/*.test.(j|t)s', '**/?(*.)+test.(j|t)s'],
+  testPathIgnorePatterns: [
+    '<rootDir>/node_modules/',
+    '<rootDir>/dist/',
+  ],
+};

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "statsig-node-vercel",
+  "version": "0.0.1-beta.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "prepare": "rm -rf dist/ && tsc",
+    "test": "npm run prepare && pnpm jest"
+  },
+  "types": "./index.d.ts",
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@vercel/edge-config": "^0.1.0-canary.15"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.18.13",
+    "@babel/preset-env": "^7.18.10",
+    "@babel/preset-typescript": "^7.18.6",
+    "@types/jest": "^28.1.8",
+    "jest": "^29.0.0",
+    "statsig-node": "5.1.0-beta.1"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,36 @@
+{
+  "exclude": [
+    "node_modules",
+    "__tests__/*",
+    "dist",
+    "dist/**/*",
+    "tsconfig.json",
+  ],
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+    /* Language and Environment */
+    "target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    "lib": [
+      "ES2020.Promise"
+    ], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    /* Modules */
+    "module": "commonjs", /* Specify what module code is generated. */
+    "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
+    "typeRoots": [
+      "node_modules/@types"
+    ], /* Specify multiple folders that act like './node_modules/@types'. */
+    "resolveJsonModule": true, /* Enable importing .json files. */
+    /* JavaScript Support */
+    "allowJs": false, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    /* Emit */
+    "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    "outDir": "dist", /* Specify an output folder for all emitted files. */
+    /* Interop Constraints */
+    "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
+    /* Type Checking */
+    "strict": true, /* Enable all strict type-checking options. */
+    /* Completeness */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}