fix: vercel serialization bug

packages/sdk/cloudflare/example/package.json

@@ -5,7 +5,7 @@
   "module": "./dist/index.mjs",
   "packageManager": "yarn@3.4.1",
   "dependencies": {
-    "@launchdarkly/cloudflare-server-sdk": "0.0.1"
+    "@launchdarkly/cloudflare-server-sdk": "2.0.1"
   },
   "devDependencies": {
     "@cloudflare/workers-types": "^4.20230321.0",

packages/sdk/cloudflare/example/src/index.ts

@@ -4,7 +4,7 @@ export default {
   async fetch(request: Request, env: Bindings): Promise<Response> {
     const sdkKey = 'test-sdk-key';
     const flagKey = 'testFlag1';
-    const context = { kind: 'user', key: 'test-user-key-1' };
+    const context = { kind: 'user', key: 'test-user-key-1', email: 'test@gmail.com' };
 
     // start using ld
     const client = initLD(sdkKey, env.LD_KV);
@@ -13,9 +13,10 @@ export default {
     const flagDetail = await client.variationDetail(flagKey, context, false);
     const allFlags = await client.allFlagsState(context);
 
-    const resp = `${flagKey}: ${flagValue}, detail: ${JSON.stringify(
-      flagDetail
-    )}, allFlags: ${JSON.stringify(allFlags)}`;
+    const resp = `
+    ${flagKey}: ${flagValue}
+    detail: ${JSON.stringify(flagDetail)}
+    allFlags: ${JSON.stringify(allFlags)}`;
 
     // eslint-disable-next-line
     console.log(`------------- ${resp}`);

packages/sdk/cloudflare/example/src/testData.json

@@ -5,7 +5,26 @@
       "on": true,
       "prerequisites": [],
       "targets": [],
-      "rules": [],
+      "rules": [
+        {
+          "variation": 1,
+          "id": "rule1",
+          "clauses": [
+            {
+              "contextKind": "user",
+              "attribute": "/email",
+              "op": "contains",
+              "values": ["gmail"],
+              "negate": false
+            }
+          ],
+          "trackEvents": false,
+          "rollout": {
+            "bucketBy": "bucket",
+            "variations": [{ "variation": 1, "weight": 100 }]
+          }
+        }
+      ],
       "fallthrough": {
         "variation": 0
       },
@@ -25,10 +44,52 @@
     },
     "testFlag2": {
       "key": "testFlag2",
-      "on": false,
+      "on": true,
       "prerequisites": [],
       "targets": [],
       "rules": [],
+      "fallthrough": {
+        "variation": 0,
+        "rollout": {
+          "bucketBy": "bucket",
+          "variations": [{ "variation": 1, "weight": 100 }],
+          "contextKind:": "user",
+          "attribute": "/email"
+        }
+      },
+      "offVariation": 1,
+      "variations": [true, false],
+      "clientSideAvailability": {
+        "usingMobileKey": true,
+        "usingEnvironmentId": true
+      },
+      "clientSide": true,
+      "salt": "aef830243d6640d0a973be89988e008d",
+      "trackEvents": false,
+      "trackEventsFallthrough": false,
+      "debugEventsUntilDate": null,
+      "version": 2,
+      "deleted": false
+    },
+    "testFlag3": {
+      "key": "testFlag3",
+      "on": true,
+      "prerequisites": [],
+      "targets": [],
+      "rules": [
+        {
+          "variation": 1,
+          "id": "rule1",
+          "clauses": [
+            {
+              "op": "segmentMatch",
+              "values": ["testSegment1"],
+              "negate": false
+            }
+          ],
+          "trackEvents": false
+        }
+      ],
       "fallthrough": {
         "variation": 0
       },
@@ -65,7 +126,19 @@
         },
         "site": { "href": "/default/test/segments/beta-users-1", "type": "text/html" }
       },
-      "rules": [],
+      "rules": [
+        {
+          "id": "rule-country",
+          "clauses": [
+            {
+              "attribute": "country",
+              "op": "in",
+              "values": ["australia"],
+              "negate": false
+            }
+          ]
+        }
+      ],
       "version": 1,
       "deleted": false,
       "_access": { "denied": [], "allowed": [] },

packages/sdk/cloudflare/package.json

@@ -33,7 +33,7 @@
     "start": "rimraf dist && yarn tsw",
     "lint": "eslint . --ext .ts",
     "prettier": "prettier --write '**/*.@(js|ts|tsx|json|css)' --ignore-path ../../../.prettierignore",
-    "test": "NODE_OPTIONS=\"--experimental-vm-modules --no-warnings\" jest --ci --runInBand --coverage",
+    "test": "NODE_OPTIONS=\"--experimental-vm-modules --no-warnings\" jest --ci --runInBand",
     "check": "yarn prettier && yarn lint && yarn build && yarn test && yarn doc"
   },
   "dependencies": {

packages/sdk/cloudflare/src/createFeatureStore.test.ts

@@ -7,6 +7,16 @@ import * as testData from './utils/testData.json';
 describe('createFeatureStore', () => {
   const sdkKey = 'sdkKey';
   const kvKey = `LD-Env-${sdkKey}`;
+  const {
+    testFlag1: { debugEventsUntilDate: d1, ...testFlag1Subset },
+    testFlag2: { debugEventsUntilDate: d2, ...testFlag2Subset },
+    testFlag3: { debugEventsUntilDate: d3, ...testFlag3Subset },
+  } = testData.flags;
+  const testDataFlagsSubset = {
+    testFlag1: testFlag1Subset,
+    testFlag2: testFlag2Subset,
+    testFlag3: testFlag3Subset,
+  };
   const mockLogger = {
     error: jest.fn(),
     warn: jest.fn(),
@@ -18,7 +28,7 @@ describe('createFeatureStore', () => {
   let asyncFeatureStore: AsyncStoreFacade;
 
   beforeEach(() => {
-    mockGet.mockImplementation(() => Promise.resolve(testData));
+    mockGet.mockImplementation(() => Promise.resolve(JSON.stringify(testData)));
     featureStore = createFeatureStore(mockKV, sdkKey, mockLogger);
     asyncFeatureStore = new AsyncStoreFacade(featureStore);
   });
@@ -31,8 +41,8 @@ describe('createFeatureStore', () => {
     test('get flag', async () => {
       const flag = await asyncFeatureStore.get({ namespace: 'features' }, 'testFlag1');
 
-      expect(mockGet).toHaveBeenCalledWith(kvKey, { type: 'json' });
-      expect(flag).toEqual(testData.flags.testFlag1);
+      expect(mockGet).toHaveBeenCalledWith(kvKey);
+      expect(flag).toMatchObject(testFlag1Subset);
     });
 
     test('invalid flag key', async () => {
@@ -44,8 +54,8 @@ describe('createFeatureStore', () => {
     test('get segment', async () => {
       const segment = await asyncFeatureStore.get({ namespace: 'segments' }, 'testSegment1');
 
-      expect(mockGet).toHaveBeenCalledWith(kvKey, { type: 'json' });
-      expect(segment).toEqual(testData.segments.testSegment1);
+      expect(mockGet).toHaveBeenCalledWith(kvKey);
+      expect(segment).toMatchObject(testData.segments.testSegment1);
     });
 
     test('invalid segment key', async () => {
@@ -66,15 +76,15 @@ describe('createFeatureStore', () => {
     test('all flags', async () => {
       const flag = await asyncFeatureStore.all({ namespace: 'features' });
 
-      expect(mockGet).toHaveBeenCalledWith(kvKey, { type: 'json' });
-      expect(flag).toEqual(testData.flags);
+      expect(mockGet).toHaveBeenCalledWith(kvKey);
+      expect(flag).toMatchObject(testDataFlagsSubset);
     });
 
     test('all segments', async () => {
       const segment = await asyncFeatureStore.all({ namespace: 'segments' });
 
-      expect(mockGet).toHaveBeenCalledWith(kvKey, { type: 'json' });
-      expect(segment).toEqual(testData.segments);
+      expect(mockGet).toHaveBeenCalledWith(kvKey);
+      expect(segment).toMatchObject(testData.segments);
     });
 
     test('invalid DataKind', async () => {

packages/sdk/cloudflare/src/createFeatureStore.ts

@@ -7,6 +7,7 @@ import {
   LDFeatureStoreItem,
   LDFeatureStoreKindData,
   noop,
+  deserializePoll,
 } from '@launchdarkly/js-server-sdk-common-edge';
 
 const createFeatureStore = (kvNamespace: KVNamespace, sdkKey: string, logger: LDLogger) => {
@@ -17,15 +18,20 @@ const createFeatureStore = (kvNamespace: KVNamespace, sdkKey: string, logger: LD
       flagKey: string,
       callback: (res: LDFeatureStoreItem | null) => void = noop
     ): void {
-      logger.debug(`Requesting ${flagKey} from ${key}`);
+      const kindKey = kind.namespace === 'features' ? 'flags' : kind.namespace;
+      logger.debug(`Requesting ${flagKey} from ${key}:${kindKey}`);
+
       kvNamespace
-        .get(key, { type: 'json' })
+        .get(key)
         .then((i) => {
           if (i === null) {
-            logger.error('Feature data not found in KV.');
+            throw new Error(`The ${kindKey} key: ${key} is not found in KV.`);
+          }
+
+          const item = deserializePoll(i);
+          if (!item) {
+            throw new Error(`Error deserializing ${kindKey}`);
           }
-          const kindKey = kind.namespace === 'features' ? 'flags' : kind.namespace;
-          const item = i as LDFeatureStoreItem;
           callback(item[kindKey][flagKey]);
         })
         .catch((err) => {
@@ -35,14 +41,19 @@ const createFeatureStore = (kvNamespace: KVNamespace, sdkKey: string, logger: LD
     },
     all(kind: DataKind, callback: (res: LDFeatureStoreKindData) => void = noop): void {
       const kindKey = kind.namespace === 'features' ? 'flags' : kind.namespace;
-      logger.debug(`Requesting all ${kindKey} data from KV.`);
+      logger.debug(`Requesting all from ${key}:${kindKey}`);
       kvNamespace
-        .get(key, { type: 'json' })
+        .get(key)
         .then((i) => {
           if (i === null) {
-            logger.error('Feature data not found in KV.');
+            throw new Error(`The ${kindKey} key: ${key} is not found in KV.`);
           }
-          const item = i as LDFeatureStoreItem;
+
+          const item = deserializePoll(i);
+          if (!item) {
+            throw new Error(`Error deserializing ${kindKey}`);
+          }
+
           callback(item[kindKey]);
         })
         .catch((err) => {

packages/sdk/cloudflare/src/createPlatformInfo.test.ts

@@ -0,0 +1,22 @@
+import createPlatformInfo from './createPlatformInfo';
+
+import { name, version } from '../package.json';
+
+describe('Cloudflare Platform Info', () => {
+  it('platformData shows correct information', () => {
+    const platformData = createPlatformInfo();
+
+    expect(platformData.platformData()).toEqual({
+      name: 'Cloudflare',
+    });
+  });
+
+  it('sdkData shows correct information', () => {
+    const platformData = createPlatformInfo();
+
+    expect(platformData.sdkData()).toEqual({
+      name,
+      version,
+    });
+  });
+});

packages/sdk/cloudflare/src/createPlatformInfo.ts

@@ -5,7 +5,7 @@ import { name, version } from '../package.json';
 class CloudflarePlatformInfo implements Info {
   platformData(): PlatformData {
     return {
-      name: 'Cloudflare worker',
+      name: 'Cloudflare',
     };
   }