Add tests and cleanup

Author: ldhenry

packages/sdk/fastly/README.md

@@ -1 +1,62 @@
-# fastly
+# LaunchDarkly SDK for Fastly
+
+The LaunchDarkly SDK for Fastly is designed primarily for use in [Fastly Compute Platform](https://www.fastly.com/documentation/guides/compute/). It follows the server-side LaunchDarkly model for multi-user contexts. It is not intended for use in desktop and embedded systems applications.
+
+# ⛔️⛔️⛔️⛔️
+
+> [!CAUTION]
+> This library is an alpha version and should not be considered ready for production use while this message is visible.
+
+# ☝️☝️☝️☝️☝️☝️
+
+## Install
+
+```shell
+# npm
+npm i @launchdarkly/fastly-server-sdk
+
+# yarn
+yarn add @launchdarkly/fastly-server-sdk
+```
+
+## Quickstart
+
+See the full [example app](https://github.com/launchdarkly/js-core/tree/main/packages/sdk/fastly/example).
+
+## Developing this SDK
+
+```shell
+# at js-core repo root
+yarn && yarn build && cd packages/sdk/fastly
+
+# run tests
+yarn test
+```
+
+## Verifying SDK build provenance with the SLSA framework
+
+LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply-chain Levels for Software Artifacts) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md).
+
+## 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
+
+[sdk-fastly-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/fastly.yml/badge.svg
+[sdk-fastly-ci]: https://github.com/launchdarkly/js-core/actions/workflows/fastly.yml
+[sdk-fastly-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/fastly-server-sdk.svg?style=flat-square
+[sdk-fastly-npm-link]: https://www.npmjs.com/package/@launchdarkly/fastly-server-sdk
+[sdk-fastly-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
+[sdk-fastly-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/fastly/docs/
+[sdk-fastly-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/fastly-server-sdk.svg?style=flat-square
+[sdk-fastly-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/fastly-server-sdk.svg?style=flat-square

packages/sdk/fastly/__mocks__/fastly:kv-store.ts

@@ -0,0 +1,8 @@
+export const KVStore = jest.fn().mockImplementation(() => ({
+  get: jest.fn(),
+  put: jest.fn(),
+  delete: jest.fn(),
+  getMulti: jest.fn(),
+  putMulti: jest.fn(),
+  deleteMulti: jest.fn(),
+}));

packages/sdk/fastly/__tests__/api/EdgeFeatureStore.test.ts

@@ -0,0 +1,125 @@
+import { AsyncStoreFacade, LDFeatureStore } from '@launchdarkly/js-server-sdk-common';
+
+import { EdgeFeatureStore } from '../../src/api/EdgeFeatureStore';
+import mockEdgeProvider from '../../src/utils/mockEdgeProvider';
+import * as testData from './testData.json';
+
+describe('EdgeFeatureStore', () => {
+  const sdkKey = 'sdkKey';
+  const kvKey = `LD-Env-${sdkKey}`;
+  const mockLogger = {
+    error: jest.fn(),
+    warn: jest.fn(),
+    info: jest.fn(),
+    debug: jest.fn(),
+  };
+  const mockGet = mockEdgeProvider.get as jest.Mock;
+  let featureStore: LDFeatureStore;
+  let asyncFeatureStore: AsyncStoreFacade;
+
+  beforeEach(() => {
+    mockGet.mockImplementation(() => Promise.resolve(JSON.stringify(testData)));
+    featureStore = new EdgeFeatureStore(mockEdgeProvider, sdkKey, 'MockEdgeProvider', mockLogger);
+    asyncFeatureStore = new AsyncStoreFacade(featureStore);
+  });
+
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  describe('get', () => {
+    test('get flag', async () => {
+      const flag = await asyncFeatureStore.get({ namespace: 'features' }, 'testFlag1');
+
+      expect(mockGet).toHaveBeenCalledWith(kvKey);
+      expect(flag).toMatchObject(testData.flags.testFlag1);
+    });
+
+    test('invalid flag key', async () => {
+      const flag = await asyncFeatureStore.get({ namespace: 'features' }, 'invalid');
+
+      expect(flag).toBeUndefined();
+    });
+
+    test('get segment', async () => {
+      const segment = await asyncFeatureStore.get({ namespace: 'segments' }, 'testSegment1');
+
+      expect(mockGet).toHaveBeenCalledWith(kvKey);
+      expect(segment).toMatchObject(testData.segments.testSegment1);
+    });
+
+    test('invalid segment key', async () => {
+      const segment = await asyncFeatureStore.get({ namespace: 'segments' }, 'invalid');
+
+      expect(segment).toBeUndefined();
+    });
+
+    test('invalid kv key', async () => {
+      mockGet.mockImplementation(() => Promise.resolve(null));
+      const flag = await asyncFeatureStore.get({ namespace: 'features' }, 'testFlag1');
+
+      expect(flag).toBeNull();
+    });
+  });
+
+  describe('all', () => {
+    test('all flags', async () => {
+      const flags = await asyncFeatureStore.all({ namespace: 'features' });
+
+      expect(mockGet).toHaveBeenCalledWith(kvKey);
+      expect(flags).toMatchObject(testData.flags);
+    });
+
+    test('all segments', async () => {
+      const segment = await asyncFeatureStore.all({ namespace: 'segments' });
+
+      expect(mockGet).toHaveBeenCalledWith(kvKey);
+      expect(segment).toMatchObject(testData.segments);
+    });
+
+    test('invalid DataKind', async () => {
+      const flag = await asyncFeatureStore.all({ namespace: 'InvalidDataKind' });
+
+      expect(flag).toEqual({});
+    });
+
+    test('invalid kv key', async () => {
+      mockGet.mockImplementation(() => Promise.resolve(null));
+      const segment = await asyncFeatureStore.all({ namespace: 'segments' });
+
+      expect(segment).toEqual({});
+    });
+  });
+
+  describe('initialized', () => {
+    test('is initialized', async () => {
+      const isInitialized = await asyncFeatureStore.initialized();
+
+      expect(mockGet).toHaveBeenCalledWith(kvKey);
+      expect(isInitialized).toBeTruthy();
+    });
+
+    test('not initialized', async () => {
+      mockGet.mockImplementation(() => Promise.resolve(null));
+      const isInitialized = await asyncFeatureStore.initialized();
+
+      expect(mockGet).toHaveBeenCalledWith(kvKey);
+      expect(isInitialized).toBeFalsy();
+    });
+  });
+
+  describe('init & getDescription', () => {
+    test('init', (done) => {
+      const cb = jest.fn(() => {
+        done();
+      });
+      featureStore.init(testData, cb);
+    });
+
+    test('getDescription', async () => {
+      const description = featureStore.getDescription?.();
+
+      expect(description).toEqual('MockEdgeProvider');
+    });
+  });
+});

packages/sdk/fastly/__tests__/api/LDClient.test.ts

@@ -0,0 +1,41 @@
+import { internal } from '@launchdarkly/js-server-sdk-common';
+
+import LDClient from '../../src/api/LDClient';
+import { createBasicPlatform } from '../createBasicPlatform';
+
+jest.mock('@launchdarkly/js-sdk-common', () => {
+  const actual = jest.requireActual('@launchdarkly/js-sdk-common');
+  return {
+    ...actual,
+    ...{
+      internal: {
+        ...actual.internal,
+        DiagnosticsManager: jest.fn(),
+        EventProcessor: jest.fn(),
+      },
+    },
+  };
+});
+
+const mockEventProcessor = internal.EventProcessor as jest.Mock;
+describe('Edge LDClient', () => {
+  it('uses clientSideID endpoints', async () => {
+    const client = new LDClient('client-side-id', createBasicPlatform().info, {
+      sendEvents: true,
+    });
+    await client.waitForInitialization({ timeout: 10 });
+    const passedConfig = mockEventProcessor.mock.calls[0][0];
+
+    expect(passedConfig).toMatchObject({
+      sendEvents: true,
+      serviceEndpoints: {
+        includeAuthorizationHeader: false,
+        analyticsEventPath: '/events/bulk/client-side-id',
+        diagnosticEventPath: '/events/diagnostic/client-side-id',
+        events: 'https://events.launchdarkly.com',
+        polling: 'https://sdk.launchdarkly.com',
+        streaming: 'https://stream.launchdarkly.com',
+      },
+    });
+  });
+});

packages/sdk/fastly/__tests__/api/createOptions.test.ts

@@ -0,0 +1,17 @@
+import { BasicLogger } from '@launchdarkly/js-server-sdk-common';
+
+import createOptions, { defaultOptions } from '../../src/api/createOptions';
+
+describe('createOptions', () => {
+  test('default options', () => {
+    expect(createOptions({})).toEqual(defaultOptions);
+  });
+
+  test('override logger', () => {
+    const logger = new BasicLogger({ name: 'test' });
+    expect(createOptions({ logger })).toEqual({
+      ...defaultOptions,
+      logger,
+    });
+  });
+});