Initial circleci additions. Updates to jest configuration and README for supported node versions. (#2)

Author: kinyoklion

.circleci/config.yml

@@ -0,0 +1,65 @@
+version: 2.1
+
+orbs:
+   win: circleci/[email protected]
+
+workflows:
+  build-and-test-all:
+    jobs:
+      # CircleCI's current generation of Node images, cimg/node, allow you to leave the
+      # patch version unpinned, but require you to specify the minor version. The one
+      # exception is cimg/node:current, which will always give us the latest release in
+      # the latest major version-- and the latest major version is where it's most likely
+      # that there would be a new minor version, anyway.
+      - build-test-linux:
+          name: latest Node version
+          docker-image: cimg/node:current
+          run-lint: true
+      - build-test-linux:
+          name: Node 16.14
+          docker-image: cimg/node:16.14
+      - build-test-linux:
+          name: Node 14.19
+          docker-image: cimg/node:14.19
+      - build-test-windows:
+          name: Windows
+
+jobs:
+  build-test-linux:
+    parameters:
+      run-lint:
+        type: boolean
+        default: false
+      docker-image:
+        type: string
+      run-contract-tests:
+        type: boolean
+        default: true
+    docker:
+      - image: <<parameters.docker-image>>
+    steps:
+      - checkout
+      - run: echo "Node version:" `node --version`
+      - run: npm install
+      - run:
+          command: npm test
+          environment:
+            JEST_JUNIT_OUTPUT_FILE: "reports/junit/js-test-results.xml"
+      - when:
+          condition: <<parameters.run-lint>>
+          steps:
+            - run: npm run lint
+      - store_test_results:
+          path: reports/junit
+      - store_artifacts:
+          path: reports/junit
+
+  build-test-windows:
+    executor:
+      name: win/default
+      shell: powershell.exe
+    steps:
+      - checkout
+      - run: node --version
+      - run: npm install
+      - run: npm test

.gitignore

@@ -2,3 +2,4 @@ package-lock.json
 dist/
 node_modules/
 coverage/
+reports/

README.md

@@ -1,6 +1,6 @@
 # LaunchDarkly OpenFeature provider for the Server-Side SDK for Node.js
 
-This provider allows for using LaunchDarkly with the OpenFeature Node SDK.
+This provider allows for using LaunchDarkly with the OpenFeature JS SDK.
 
 This provider is designed primarily for use in multi-user systems such as web servers and applications. It follows the server-side LaunchDarkly model for multi-user contexts. It is not intended for use in desktop and embedded systems applications.
 
@@ -12,21 +12,21 @@ This provider is designed primarily for use in multi-user systems such as web se
 
 ## Supported Node versions
 
-This version of the LaunchDarkly OpenFeature provider is compatible with Node.js versions 16 and above.
+This version of the LaunchDarkly OpenFeature provider is compatible with Node.js versions 14 and above.
 
 ## Getting started
 
 ### Installation
 
 ```
-npm install @openfeature/nodejs-sdk
+npm install @openfeature/js-sdk
 npm install launchdarkly-node-server-sdk
 npm install @launchdarkly/open-feature-node
 ```
 
 ### Usage
 ```
-import { OpenFeature } from '@openfeature/nodejs-sdk';
+import { OpenFeature } from '@openfeature/js-sdk';
 import { init } from 'launchdarkly-node-server-sdk';
 import { LaunchDarklyProvider } from 'open-feature-node';
 

__tests__/LaunchDarklyProvider.test.ts

@@ -1,4 +1,4 @@
-import { OpenFeature, Client } from '@openfeature/nodejs-sdk';
+import { OpenFeature, Client } from '@openfeature/js-sdk';
 import { LDClient } from 'launchdarkly-node-server-sdk';
 import { LaunchDarklyProvider } from '../src';
 import translateContext from '../src/translateContext';

jest.config.js

@@ -1,9 +1,13 @@
 module.exports = {
-  transform: {'^.+\\.ts?$': 'ts-jest'},
+  transform: { '^.+\\.ts?$': 'ts-jest' },
   testMatch: ["**/__tests__/**/*test.ts?(x)"],
   testEnvironment: 'node',
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
   collectCoverageFrom: [
     "src/**/*.ts",
+  ],
+  reporters: [
+    "default",
+    ["jest-junit", { suiteName: "jest tests", outputFile: "reports/junit/js-test-results.xml" }]
   ]
 };

package.json

@@ -19,19 +19,22 @@
   ],
   "license": "Apache-2.0",
   "peerDependencies": {
-    "@openfeature/nodejs-sdk": "^0.3.2",
+    "@openfeature/js-sdk": "0.4.0",
     "launchdarkly-node-server-sdk": "6.x"
   },
   "devDependencies": {
-    "typescript": "^4.7.4",
+    "@openfeature/js-sdk": "0.4.0",
+    "@types/jest": "^27.4.1",
     "@typescript-eslint/eslint-plugin": "^5.22.0",
     "@typescript-eslint/parser": "^5.22.0",
     "eslint": "^8.14.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-airbnb-typescript": "^17.0.0",
     "eslint-plugin-import": "^2.26.0",
-    "@types/jest": "^27.4.1",
     "jest": "^27.5.1",
-    "ts-jest": "^27.1.4"
+    "jest-junit": "^14.0.1",
+    "launchdarkly-node-server-sdk": "6.x",
+    "ts-jest": "^27.1.4",
+    "typescript": "^4.7.4"
   }
 }

src/LaunchDarklyProvider.ts

@@ -1,7 +1,8 @@
 import {
   EvaluationContext, FlagValue, Hook,
+  JsonValue,
   Provider, ProviderMetadata, ResolutionDetails,
-} from '@openfeature/nodejs-sdk';
+} from '@openfeature/js-sdk';
 import { LDClient } from 'launchdarkly-node-server-sdk';
 import translateContext from './translateContext';
 import translateResult from './translateResult';
@@ -121,7 +122,7 @@ export default class LaunchDarklyProvider implements Provider {
    *   register this context with LaunchDarkly if the context does not already exist.
    * @returns A promise which will resolve to an {@link EvaluationDetails}.
    */
-  async resolveObjectEvaluation<U extends object>(
+  async resolveObjectEvaluation<U extends JsonValue>(
     flagKey: string,
     defaultValue: U,
     context: EvaluationContext,

src/translateContext.ts

@@ -1,4 +1,4 @@
-import { EvaluationContext } from '@openfeature/nodejs-sdk';
+import { EvaluationContext } from '@openfeature/js-sdk';
 import { LDUser } from 'launchdarkly-node-server-sdk';
 
 const LDUserBuiltIns = {

src/translateResult.ts

@@ -1,4 +1,4 @@
-import { ResolutionDetails } from '@openfeature/nodejs-sdk';
+import { ResolutionDetails } from '@openfeature/js-sdk';
 import { LDEvaluationDetail } from 'launchdarkly-node-server-sdk';
 
 /**