Merge pull request #2 from beeme1mr/main

Automatically generate types and bump OpenFeature to v0.5.0

Author: Josh Sirota

.gitignore

@@ -102,3 +102,8 @@ dist
 
 # TernJS port file
 .tern-port
+
+# Build output
+es/
+lib/
+types/

README.md

@@ -10,13 +10,27 @@ This Provider is designed to allow the use of OpenFeature with Split, the platfo
 ## Getting started
 Below is a simple example that describes the instantiation of the Split Provider. Please see the [OpenFeature Documentation](https://docs.openfeature.dev/docs/reference/concepts/evaluation-api) for details on how to use the OpenFeature SDK.
 
+### Add the Split provider
+
+```sh
+npm install @splitsoftware/openfeature-js-split-provider
+```
+
+### Confirm peer dependencies are installed
+```sh
+npm install @splitsoftware/splitio
+npm install @openfeature/js-sdk
+```
+
+### Register the Split provider with OpenFeature
 ```js
 const OpenFeature = require('@openfeature/js-sdk').OpenFeature;
 const SplitFactory = require('@splitsoftware/splitio').SplitFactory;
 const OpenFeatureSplitProvider = require('@splitsoftware/openfeature-js-split-provider').OpenFeatureSplitProvider;
 
-splitClient = SplitFactory({core: {authorizationKey: 'localhost'}}).client();
-provider = new OpenFeatureSplitProvider({splitClient});
+const authorizationKey = 'your auth key'
+const splitClient = SplitFactory({core: {authorizationKey}}).client();
+const provider = new OpenFeatureSplitProvider({splitClient});
 openFeature.setProvider(provider);
 ```
 

package.json

@@ -17,20 +17,21 @@
   "bugs": "https://github.com/splitio/openfeature-split-provider-js/issues",
   "license": "Apache-2.0",
   "author": "Josh Sirota <josh.sirota@split.io>",
-  "contributors": [
-  ],
   "main": "lib/index.js",
   "module": "es/index.js",
   "types": "types",
   "engines": {
     "npm": ">=3",
     "node": ">=6"
   },
-  "dependencies": {
-    "@openfeature/js-sdk": "^0.4.0",
+  "dependencies": {},
+  "peerDependencies": {
+    "@openfeature/js-sdk": "^0.5.0",
     "@splitsoftware/splitio": "^10.21.1"
   },
   "devDependencies": {
+    "@openfeature/js-sdk": "^0.5.0",
+    "@splitsoftware/splitio": "^10.21.1",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
     "replace": "^1.2.1",
@@ -63,4 +64,4 @@
       "karma-webpack"
     ]
   }
-}
+}

src/__tests__/nodeSuites/client.spec.js

@@ -37,8 +37,8 @@ export default async function(assert) {
   const getControlVariantNonExistentSplit = async (client) => {
     let details = await client.getBooleanDetails('non-existent-feature', false);
     assert.equals(details.value, false);
-    assert.equals(details.variant, 'control');
-    assert.equals(details.reason, 'FLAG_NOT_FOUND');
+    assert.equals(details.errorCode, 'FLAG_NOT_FOUND');
+    assert.equals(details.reason, 'ERROR');
   };
 
   const getBooleanSplitTest = async (client) => {

src/lib/js-split-provider.ts

@@ -1,5 +1,14 @@
-import { EvaluationContext, Provider, ResolutionDetails, ParseError, FlagNotFoundError, JsonValue, OpenFeatureError, StandardResolutionReasons } from '@openfeature/js-sdk';
-import SplitIO from '@splitsoftware/splitio/types/splitio';
+import {
+  EvaluationContext,
+  Provider,
+  ResolutionDetails,
+  ParseError,
+  FlagNotFoundError,
+  JsonValue,
+  TargetingKeyMissingError,
+  StandardResolutionReasons,
+} from "@openfeature/js-sdk";
+import type SplitIO from "@splitsoftware/splitio/types/splitio";
 
 export interface SplitProviderOptions {
   splitClient: SplitIO.IClient;
@@ -10,9 +19,11 @@ type Consumer = {
   attributes: SplitIO.Attributes;
 };
 
+const CONTROL_VALUE_ERROR_MESSAGE = "Received the 'control' value from Split.";
+
 export class OpenFeatureSplitProvider implements Provider {
   metadata = {
-    name: 'split',
+    name: "split",
   };
   private initialized: Promise<void>;
   private client: SplitIO.IClient;
@@ -29,23 +40,26 @@ export class OpenFeatureSplitProvider implements Provider {
 
   async resolveBooleanEvaluation(
     flagKey: string,
-    defaultValue: boolean,
+    _: boolean,
     context: EvaluationContext
   ): Promise<ResolutionDetails<boolean>> {
-    const details = await this.evaluateTreatment(flagKey, this.transformContext(context));
+    const details = await this.evaluateTreatment(
+      flagKey,
+      this.transformContext(context)
+    );
 
     let value: boolean;
     switch (details.value as unknown) {
-      case 'on':
+      case "on":
         value = true;
         break;
-      case 'off':
+      case "off":
         value = false;
         break;
-      case 'true':
+      case "true":
         value = true;
         break;
-      case 'false':
+      case "false":
         value = false;
         break;
       case true:
@@ -54,10 +68,8 @@ export class OpenFeatureSplitProvider implements Provider {
       case false:
         value = false;
         break;
-      case 'control':
-        value = defaultValue;
-        details.reason = 'FLAG_NOT_FOUND';
-        break;
+      case "control":
+        throw new FlagNotFoundError(CONTROL_VALUE_ERROR_MESSAGE);
       default:
         throw new ParseError(`Invalid boolean value for ${details.value}`);
     }
@@ -69,9 +81,12 @@ export class OpenFeatureSplitProvider implements Provider {
     _: string,
     context: EvaluationContext
   ): Promise<ResolutionDetails<string>> {
-    const details = await this.evaluateTreatment(flagKey, this.transformContext(context));
-    if (details.value == 'control') {
-      throw new FlagNotFoundError(`Got error for split ${flagKey}`);
+    const details = await this.evaluateTreatment(
+      flagKey,
+      this.transformContext(context)
+    );
+    if (details.value === "control") {
+      throw new FlagNotFoundError(CONTROL_VALUE_ERROR_MESSAGE);
     }
     return details;
   }
@@ -81,7 +96,10 @@ export class OpenFeatureSplitProvider implements Provider {
     _: number,
     context: EvaluationContext
   ): Promise<ResolutionDetails<number>> {
-    const details = await this.evaluateTreatment(flagKey, this.transformContext(context));
+    const details = await this.evaluateTreatment(
+      flagKey,
+      this.transformContext(context)
+    );
     return { ...details, value: this.parseValidNumber(details.value) };
   }
 
@@ -90,26 +108,32 @@ export class OpenFeatureSplitProvider implements Provider {
     _: U,
     context: EvaluationContext
   ): Promise<ResolutionDetails<U>> {
-    const details = await this.evaluateTreatment(flagKey, this.transformContext(context));
+    const details = await this.evaluateTreatment(
+      flagKey,
+      this.transformContext(context)
+    );
     return { ...details, value: this.parseValidJsonObject(details.value) };
   }
 
-  private async evaluateTreatment(flagKey: string, consumer: Consumer): Promise<ResolutionDetails<string>> {
+  private async evaluateTreatment(
+    flagKey: string,
+    consumer: Consumer
+  ): Promise<ResolutionDetails<string>> {
     if (!consumer.key) {
-      const details: ResolutionDetails<string> = {
-        value: 'control',
-        variant: 'control',
-        reason: StandardResolutionReasons.ERROR,
-        errorCode: 'TARGETING_KEY_MISSING'
-      }
-      return details;
+      throw new TargetingKeyMissingError(
+        "The Split provider requires a targeting key."
+      );
     } else {
       await this.initialized;
-      const value = this.client.getTreatment(consumer.key, flagKey, consumer.attributes);
+      const value = this.client.getTreatment(
+        consumer.key,
+        flagKey,
+        consumer.attributes
+      );
       const details: ResolutionDetails<string> = {
         value: value,
         variant: value,
-        reason: StandardResolutionReasons.TARGETING_MATCH
+        reason: StandardResolutionReasons.TARGETING_MATCH,
       };
       return details;
     }
@@ -136,14 +160,16 @@ export class OpenFeatureSplitProvider implements Provider {
     return result;
   }
 
-  private parseValidJsonObject<T extends JsonValue>(stringValue: string | undefined): T {
+  private parseValidJsonObject<T extends JsonValue>(
+    stringValue: string | undefined
+  ): T {
     if (stringValue === undefined) {
       throw new ParseError(`Invalid 'undefined' JSON value.`);
     }
     // we may want to allow the parsing to be customized.
     try {
       const value = JSON.parse(stringValue);
-      if (typeof value !== 'object') {
+      if (typeof value !== "object") {
         throw new ParseError(
           `Flag value ${stringValue} had unexpected type ${typeof value}, expected "object"`
         );

tsconfig.json

@@ -8,7 +8,8 @@
     "allowJs": true,                       /* Allow javascript files to be compiled. */
     // "checkJs": true,                       /* Report errors in .js files. */
     // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    "declaration": false,                      /* Generates corresponding '.d.ts' file. */
+    "declaration": true,                      /* Generates corresponding '.d.ts' file. */
+    "declarationDir": "types",           /* Specify the output directory for generated declaration files. */
     // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
     // "sourceMap": true,                     /* Generates corresponding '.map' file. */
     // "outFile": "./",                       /* Concatenate and emit output to single file. */