feat: vercel edge sdk

.github/workflows/manual-publish-docs.yml

@@ -12,6 +12,7 @@ on:
           - packages/shared/sdk-server-edge
           - packages/sdk/cloudflare
           - packages/sdk/server-node
+          - packages/sdk/vercel
 name: Publish Documentation
 jobs:
   build-publish:

.github/workflows/manual-publish.yml

@@ -13,6 +13,7 @@ on:
           - packages/shared/sdk-server-edge
           - packages/sdk/cloudflare
           - packages/sdk/server-node
+          - packages/sdk/vercel
       prerelease:
         description: 'Is this a prerelease. If so, then the latest tag will not be updated in npm.'
         type: boolean

.github/workflows/release-please.yml

@@ -13,6 +13,7 @@ jobs:
       package-sdk-server-edge-released: ${{ steps.release.outputs['packages/shared/sdk-server-edge--release_created'] }}
       package-cloudflare-released: ${{ steps.release.outputs['packages/sdk/cloudflare--release_created'] }}
       package-server-node-released: ${{ steps.release.outputs['packages/sdk/server-node--release_created'] }}
+      package-vercel-released: ${{ steps.release.outputs['packages/sdk/vercel--release_created'] }}
     steps:
       - uses: google-github-actions/release-please-action@v3
         id: release
@@ -120,3 +121,23 @@ jobs:
         with:
           workspace_path: packages/sdk/server-node
           aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
+
+    release-vercel:
+      runs-on: ubuntu-latest
+      needs: ['release-please']
+      permissions:
+        id-token: write
+        contents: write
+      if: ${{ needs.release-please.outputs.package-vercel-released }}
+      steps:
+        - uses: actions/checkout@v3
+        - uses: actions/setup-node@v3
+          with:
+            node-version: 16.x
+            registry-url: 'https://registry.npmjs.org'
+        - id: release-common
+          name: Full release of packages/sdk/vercel
+          uses: ./actions/full-release
+          with:
+            workspace_path: packages/sdk/vercel
+            aws_assume_role: ${{ vars.AWS_ROLE_ARN }}

.github/workflows/vercel.yml

@@ -0,0 +1,24 @@
+name: sdk/vercel
+
+on:
+  push:
+    branches: [main]
+    paths-ignore:
+      - '**.md' #Do not need to run CI for markdown changes.
+  pull_request:
+    branches: [main]
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  build-test-vercel:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+      - id: shared
+        name: Shared CI Steps
+        uses: ./actions/ci
+        with:
+          workspace_name: '@launchdarkly/vercel-server-sdk'
+          workspace_path: packages/sdk/vercel

package.json

@@ -6,7 +6,8 @@
     "packages/shared/sdk-server-edge",
     "packages/sdk/server-node",
     "packages/sdk/cloudflare",
-    "packages/sdk/cloudflare/example"
+    "packages/sdk/cloudflare/example",
+    "packages/sdk/vercel"
   ],
   "private": true,
   "scripts": {

packages/sdk/vercel/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+All notable changes to the LaunchDarkly SDK for Vercel Edge Config will be documented in this file. This project adheres to [Semantic Versioning](https://semver.org).

packages/sdk/vercel/README.md

@@ -0,0 +1,62 @@
+# LaunchDarkly Vercel Edge SDK
+
+This library supports using Vercel [Edge Config](https://vercel.com/docs/concepts/edge-network/edge-config) to replace the default in-memory feature store of the [LaunchDarkly Node.js SDK](https://github.com/launchdarkly/vercel-server-sdk).
+
+For more information, see the [SDK features guide](https://docs.launchdarkly.com/sdk/features/storing-data).
+
+## Install
+
+```shell
+npm i @launchdarkly/vercel-server-sdk
+```
+
+or yarn:
+
+```shell
+yarn add -D @launchdarkly/vercel-server-sdk
+```
+
+## Quickstart
+
+Initialize the ldClient with the [Vercel Edge SDK](https://vercel.com/docs/concepts/edge-network/edge-config/edge-config-sdk) and your LaunchDarkly client side sdk key:
+
+```typescript
+import init from '@launchdarkly/vercel-server-sdk'
+import { createClient } from '@vercel/edge-config'
+
+const edgeClient = createClient(process.env.EDGE_CONFIG)
+const ldClient = init('YOUR CLIENT-SIDE SDK KEY', edgeClient);
+
+await ldClient.waitForInitialization()
+const ldContext = { 
+  kind: 'org',
+  key: 'my-org-key',
+  someAttribute: 'my-attribute-value'
+}
+const flagValue = await ldClient.variation('my-flag', ldContext, true);
+```
+
+To learn more, head straight to the [complete reference guide for this SDK](https://docs.launchdarkly.com/sdk/server-side/vercel).
+
+## Developing this SDK
+
+```shell
+# at js-core repo root
+yarn && yarn build && cd packages/sdk/vercel
+# run tests
+yarn test
+```
+
+## About LaunchDarkly
+
+- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
+  - Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
+  - Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
+  - Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
+  - Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
+- LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read [our documentation](https://docs.launchdarkly.com/sdk) for a complete list.
+- Explore LaunchDarkly
+  - [launchdarkly.com](https://www.launchdarkly.com/ 'LaunchDarkly Main Website') for more information
+  - [docs.launchdarkly.com](https://docs.launchdarkly.com/ 'LaunchDarkly Documentation') for our documentation and SDK reference guides
+  - [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation
+  - [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates

packages/sdk/vercel/jest.config.json

@@ -0,0 +1,9 @@
+{
+  "transform": { "^.+\\.ts?$": "ts-jest" },
+  "testMatch": ["**/*.test.ts?(x)"],
+  "testPathIgnorePatterns": ["node_modules", "example", "dist"],
+  "modulePathIgnorePatterns": ["dist"],
+  "testEnvironment": "node",
+  "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"],
+  "collectCoverageFrom": ["src/**/*.ts"]
+}

packages/sdk/vercel/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@launchdarkly/vercel-server-sdk",
+  "version": "0.1.0",
+  "description": "LaunchDarkly Server-Side SDK for Vercel Edge",
+  "packageManager": "[email protected]",
+  "keywords": [
+    "launchdarkly",
+    "vercel",
+    "edge"
+  ],
+  "type": "module",
+  "exports": {
+    "require": "./dist/cjs/src/index.js",
+    "import": "./dist/esm/src/index.js",
+    "types": "./dist/esm/src/index.d.ts"
+  },
+  "main": "./dist/cjs/src/index.js",
+  "types": "./dist/cjs/src/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "doc": "../../../scripts/build-doc.sh .",
+    "build": "../../../scripts/build-package.sh",
+    "tsw": "yarn tsc --watch",
+    "start": "yarn tsw",
+    "lint": "eslint . --ext .ts",
+    "prettier": "prettier --write '**/*.@(js|ts|tsx|json|css)'",
+    "test": "jest --ci --runInBand",
+    "check": "yarn prettier && yarn lint && yarn build && yarn test && yarn doc"
+  },
+  "dependencies": {
+    "@launchdarkly/js-server-sdk-common": "^0.2.0",
+    "@launchdarkly/js-server-sdk-common-edge": "0.0.2",
+    "crypto-js": "^4.1.1",
+    "uuid": "^9.0.0"
+  },
+  "devDependencies": {
+    "@types/crypto-js": "^4.1.1",
+    "@types/jest": "^29.5.0",
+    "@types/uuid": "^9.0.1",
+    "@typescript-eslint/eslint-plugin": "^5.57.0",
+    "@typescript-eslint/parser": "^5.57.0",
+    "@vercel/edge-config": "^0.1.7",
+    "eslint": "^8.37.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-airbnb-typescript": "^17.0.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.5.0",
+    "launchdarkly-js-test-helpers": "^2.2.0",
+    "prettier": "^2.8.7",
+    "ts-jest": "^29.1.0",
+    "typedoc": "0.23.26",
+    "typescript": "^5.0.3"
+  }
+}

packages/sdk/vercel/src/createPlatformInfo.ts

@@ -0,0 +1,22 @@
+import type { Info, PlatformData, SdkData } from '@launchdarkly/js-server-sdk-common-edge';
+
+import packageJson from '../package.json';
+
+class VercelPlatformInfo implements Info {
+  platformData(): PlatformData {
+    return {
+      name: 'Vercel Edge',
+    };
+  }
+
+  sdkData(): SdkData {
+    return {
+      name: packageJson.name,
+      version: packageJson.version,
+    };
+  }
+}
+
+const createPlatformInfo = () => new VercelPlatformInfo();
+
+export default createPlatformInfo;

packages/sdk/vercel/src/index.ts

@@ -0,0 +1,53 @@
+/**
+ * This is the API reference for the Vercel LaunchDarkly SDK.
+ *
+ * In typical usage, you will call {@link init} once at startup time to obtain an instance of
+ * {@link LDClient}, which provides access to all of the SDK's functionality.
+ *
+ * For more information, see the SDK reference guide.
+ *
+ * @packageDocumentation
+ */
+import type { EdgeConfigClient } from '@vercel/edge-config';
+import {
+  BasicLogger,
+  init as initEdge,
+  LDClient,
+  LDOptions,
+} from '@launchdarkly/js-server-sdk-common-edge';
+import VercelFeatureStore from './vercelFeatureStore';
+import createPlatformInfo from './createPlatformInfo';
+
+export * from '@launchdarkly/js-server-sdk-common-edge';
+
+export type { LDClient };
+
+/**
+ * Creates an instance of the Vercel LaunchDarkly client.
+ *
+ * Applications should instantiate a single instance for the lifetime of the worker.
+ * The client will begin attempting to connect to the configured Vercel Edge Config as
+ * soon as it is created. To determine when it is ready to use, call {@link LDClient.waitForInitialization}.
+ *
+ * **Important:** Do **not** try to instantiate `LDClient` with its constructor
+ * (`new LDClient()/new LDClientImpl()/new LDClient()`); the SDK does not currently support
+ * this.
+ *
+ * @param edgeConfig
+ *  The Vercel Edge Config client configured for LaunchDarkly.
+ * @param sdkKey
+ *  The client side SDK key. This is only used to query the edgeConfig above,
+ *  not to connect with LaunchDarkly servers.
+ * @param options
+ *  Optional configuration settings. The only supported option is logger.
+ * @return
+ *  The new {@link LDClient} instance.
+ */
+export const init = (sdkKey: string, edgeConfig: EdgeConfigClient, options: LDOptions = {}) => {
+  const logger = options.logger ?? BasicLogger.get();
+  return initEdge(sdkKey, createPlatformInfo(), {
+    featureStore: new VercelFeatureStore(edgeConfig, sdkKey, logger),
+    logger,
+    ...options,
+  });
+};

packages/sdk/vercel/src/utils/mockEdge.ts

@@ -0,0 +1,10 @@
+import { EdgeConfigClient } from '@vercel/edge-config';
+
+const mockEdge: EdgeConfigClient = {
+  get: jest.fn(),
+  getAll: jest.fn(),
+  digest: jest.fn(),
+  has: jest.fn(),
+};
+
+export default mockEdge;

packages/sdk/vercel/src/utils/testData.json

@@ -0,0 +1,50 @@
+{
+  "flags": {
+    "testFlag1": {
+      "key": "testFlag1",
+      "on": false,
+      "prerequisites": [],
+      "targets": [],
+      "rules": [],
+      "fallthrough": {
+        "variation": 0
+      },
+      "offVariation": 1,
+      "variations": [true, false],
+      "clientSideAvailability": {
+        "usingMobileKey": true,
+        "usingEnvironmentId": true
+      },
+      "clientSide": true,
+      "salt": "aef830243d6640d0a973be89988e008d",
+      "trackEvents": false,
+      "trackEventsFallthrough": false,
+      "debugEventsUntilDate": null,
+      "version": 2,
+      "deleted": false
+    },
+    "testFlag2": {
+      "key": "testFlag2",
+      "on": false,
+      "prerequisites": [],
+      "targets": [],
+      "rules": [],
+      "fallthrough": {
+        "variation": 0
+      },
+      "offVariation": 1,
+      "variations": [true, false],
+      "clientSideAvailability": {
+        "usingMobileKey": true,
+        "usingEnvironmentId": true
+      },
+      "clientSide": true,
+      "salt": "aef830243d6640d0a973be89988e008d",
+      "trackEvents": false,
+      "trackEventsFallthrough": false,
+      "debugEventsUntilDate": null,
+      "version": 2,
+      "deleted": false
+    }
+  }
+}