feat: OFREP web provider

.release-please-manifest.json

@@ -9,5 +9,6 @@
   "libs/providers/go-feature-flag-web": "0.2.0",
   "libs/shared/flagd-core": "0.1.11",
   "libs/shared/ofrep-core": "0.0.7-experimental",
-  "libs/providers/flipt": "0.1.0"
+  "libs/providers/flipt": "0.1.0",
+  "libs/providers/ofrep-web": "0.1.0"
 }

libs/providers/ofrep-web/.eslintrc.json

@@ -0,0 +1,25 @@
+{
+  "extends": ["../../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": "error"
+      }
+    }
+  ]
+}

libs/providers/ofrep-web/README.md

@@ -0,0 +1,107 @@
+# Client-Side OFREP Provider
+
+This provider is designed to use the [OpenFeature Remote Evaluation Protocol (OFREP)](https://openfeature.dev/specification/appendix-c).
+
+## Installation
+
+### npm
+
+```sh
+npm install @openfeature/ofrep-web
+```
+
+### yarn
+
+```sh
+yarn add @openfeature/ofrep-web @openfeature/ofrep-core @openfeature/web-sdk
+```
+
+> [!NOTE]
+> yarn requires manual installation of peer dependencies
+
+## Configurations and Usage
+
+The provider needs the base url of the OFREP server for instantiation.
+
+```ts
+import { OFREPWebProvider } from '@openfeature/ofrep-web';
+
+OpenFeature.setProvider(new OFREPWebProvider({ baseUrl: 'https://localhost:8080', pollingInterval: 60000 }));
+```
+
+### HTTP headers
+
+The provider can use headers from either a static header map or a custom header factory.
+
+#### Static Headers
+
+Headers can be given as a list of tuples or as a map of headers.
+
+```ts
+import { OFREPWebProvider } from '@openfeature/ofrep-web';
+
+OpenFeature.setProvider(
+  new OFREPWebProvider({
+    baseUrl: 'https://localhost:8080',
+    headers: [
+      ['Authorization', `my-api-key`],
+      ['X-My-Header', `CustomHeaderValue`],
+    ],
+  }),
+);
+```
+
+```ts
+import { OFREPWebProvider } from '@openfeature/ofrep-web';
+
+OpenFeature.setProvider(
+  new OFREPWebProvider({
+    baseUrl: 'https://localhost:8080',
+    headers: { Authorization: `my-api-key`, 'X-My-Header': `CustomHeaderValue` },
+  }),
+);
+```
+
+#### Header Factory
+
+The header factory is evaluated before every flag evaluation which makes it possible to use dynamic values for the headers.
+
+The following shows an example of loading a token and using it as bearer token.
+
+```ts
+import { OFREPWebProvider } from '@openfeature/ofrep-web';
+
+OpenFeature.setProvider(
+  new OFREPWebProvider({
+    baseUrl: 'https://localhost:8080',
+    headersFactory: () => {
+      const token: string = loadDynamicToken();
+      return [['Authorization', `Bearer ${token}`]];
+    },
+  }),
+);
+```
+
+### Fetch implementation
+
+If needed, a custom fetch implementation can be injected, if e.g. the platform does not have fetch built in.
+
+```ts
+import { OFREPWebProvider } from '@openfeature/ofrep-web';
+import { fetchPolyfill } from 'some-fetch-polyfill';
+
+OpenFeature.setProvider(
+  new OFREPWebProvider({
+    baseUrl: 'https://localhost:8080',
+    fetchImplementation: fetchPolyfill
+  }),
+);
+```
+
+## Building
+
+Run `nx package providers-ofrep-web` to build the library.
+
+## Running unit tests
+
+Run `nx test providers-ofrep-web` to execute the unit tests via [Jest](https://jestjs.io).

libs/providers/ofrep-web/babel.config.json

@@ -0,0 +1,3 @@
+{
+  "presets": [["minify", { "builtIns": false }]]
+}

libs/providers/ofrep-web/jest.config.ts

@@ -0,0 +1,16 @@
+/* eslint-disable */
+export default {
+  displayName: 'providers-ofrep-web',
+  preset: '../../../jest.preset.js',
+  globals: {
+    'ts-jest': {
+      tsconfig: '<rootDir>/tsconfig.spec.json',
+    },
+  },
+  transform: {
+    '^.+\\.[tj]s$': 'ts-jest',
+  },
+  testEnvironment: 'jsdom',
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  setupFiles: ['./jest.polyfills.js'],
+};

libs/providers/ofrep-web/jest.polyfills.js

@@ -0,0 +1,32 @@
+// jest.polyfills.js
+/**
+ * @note The block below contains polyfills for Node.js globals
+ * required for Jest to function when running JSDOM tests.
+ * These HAVE to be require's and HAVE to be in this exact
+ * order, since "undici" depends on the "TextEncoder" global API.
+ *
+ * Consider migrating to a more modern test runner if
+ * you don't want to deal with this.
+ */
+
+const { TextDecoder, TextEncoder } = require('node:util');
+
+// eslint-disable-next-line no-undef
+Object.defineProperties(globalThis, {
+  TextDecoder: { value: TextDecoder },
+  TextEncoder: { value: TextEncoder },
+})
+
+const { Blob, File } = require('node:buffer');
+const { fetch, Headers, FormData, Request, Response } = require('undici');
+
+// eslint-disable-next-line no-undef
+Object.defineProperties(globalThis, {
+  fetch: { value: fetch, writable: true },
+  Blob: { value: Blob },
+  File: { value: File },
+  Headers: { value: Headers },
+  FormData: { value: FormData },
+  Request: { value: Request },
+  Response: { value: Response },
+})

libs/providers/ofrep-web/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@openfeature/ofrep-web-provider",
+  "version": "0.0.1-alpha.0",
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "scripts": {
+    "publish-if-not-exists": "cp $NPM_CONFIG_USERCONFIG .npmrc && if [ \"$(npm show $npm_package_name@$npm_package_version version)\" = \"$(npm run current-version -s)\" ]; then echo 'already published, skipping'; else npm publish --access public; fi",
+    "current-version": "echo $npm_package_version"
+  },
+  "peerDependencies": {
+    "@openfeature/web-sdk": ">=0.4.0",
+    "@openfeature/ofrep-core": "^0.0.6-experimental"
+  }
+}

libs/providers/ofrep-web/project.json

@@ -0,0 +1,76 @@
+{
+  "name": "providers-ofrep-web",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/providers/ofrep-web/src",
+  "projectType": "library",
+  "targets": {
+    "publish": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "npm run publish-if-not-exists",
+        "cwd": "dist/libs/providers/ofrep-web"
+      },
+      "dependsOn": [
+        {
+          "projects": "self",
+          "target": "package"
+        }
+      ]
+    },
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["libs/providers/ofrep-web/**/*.ts", "libs/providers/ofrep-web/package.json"]
+      }
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "libs/providers/ofrep-web/jest.config.ts",
+        "passWithNoTests": true
+      },
+      "configurations": {
+        "ci": {
+          "ci": true,
+          "codeCoverage": true
+        }
+      }
+    },
+    "package": {
+      "executor": "@nx/rollup:rollup",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "project": "libs/providers/ofrep-web/package.json",
+        "outputPath": "dist/libs/providers/ofrep-web",
+        "entryFile": "libs/providers/ofrep-web/src/index.ts",
+        "tsConfig": "libs/providers/ofrep-web/tsconfig.lib.json",
+        "buildableProjectDepsInPackageJsonType": "dependencies",
+        "compiler": "tsc",
+        "generateExportsField": true,
+        "umdName": "ofrep-web",
+        "external": "all",
+        "format": ["cjs", "esm"],
+        "assets": [
+          {
+            "glob": "package.json",
+            "input": "./assets",
+            "output": "./src/"
+          },
+          {
+            "glob": "LICENSE",
+            "input": "./",
+            "output": "./"
+          },
+          {
+            "glob": "README.md",
+            "input": "./libs/providers/ofrep-web",
+            "output": "./"
+          }
+        ]
+      }
+    }
+  },
+  "tags": []
+}

libs/providers/ofrep-web/src/index.ts

@@ -0,0 +1 @@
+export * from './lib/ofrep-web-provider';

libs/providers/ofrep-web/src/lib/model/evaluate-flags-response.ts

@@ -0,0 +1,15 @@
+export enum BulkEvaluationStatus {
+  SUCCESS_NO_CHANGES = 'SUCCESS_NO_CHANGES',
+  SUCCESS_WITH_CHANGES = 'SUCCESS_WITH_CHANGES',
+}
+
+export interface EvaluateFlagsResponse {
+  /**
+   * Status of the bulk evaluation.
+   */
+  status: BulkEvaluationStatus;
+  /**
+   * The List of flags changed when doing the bulk evaluation.
+   */
+  flags: string[];
+}

libs/providers/ofrep-web/src/lib/model/in-memory-cache.ts

@@ -0,0 +1,7 @@
+import { FlagValue, ResolutionDetails } from '@openfeature/web-sdk';
+import { ResolutionError } from './resolution-error';
+
+/**
+ * inMemoryCache is a type representing the internal cache of the flags.
+ */
+export type InMemoryCache = { [key: string]: ResolutionDetails<FlagValue> | ResolutionError };

libs/providers/ofrep-web/src/lib/model/ofrep-web-provider-options.ts

@@ -0,0 +1,12 @@
+import { OFREPProviderBaseOptions } from '@openfeature/ofrep-core';
+
+export type OFREPWebProviderOptions = OFREPProviderBaseOptions & {
+  /**
+   * pollInterval is the time in milliseconds to wait between we call the OFREP
+   * API to get the latest evaluation of your flags.
+   *
+   * If a negative number is provided, the provider will not poll the OFREP API.
+   * Default: 30000
+   */
+  pollInterval?: number; // in milliseconds
+};

libs/providers/ofrep-web/src/lib/model/resolution-error.ts

@@ -0,0 +1,16 @@
+import { ResolutionReason } from '@openfeature/web-sdk';
+import { EvaluationFailureErrorCode } from '@openfeature/ofrep-core';
+
+export type ResolutionError = {
+  reason: ResolutionReason;
+  errorCode: EvaluationFailureErrorCode;
+  errorDetails?: string;
+};
+
+export function isResolutionError(response: unknown): response is ResolutionError {
+  if (!response || typeof response !== 'object') {
+    return false;
+  }
+
+  return 'reason' in response && 'errorCode' in response && !('value' in response);
+}