@spotify-confidence/openfeature-server-provider-local 0.5.1 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## [0.7.0](https://github.com/spotify/confidence-resolver/compare/openfeature-provider-js-v0.6.0...openfeature-provider-js-v0.7.0) (2026-01-22)
+
+
+### Features
+
+* inlined WASM for improved portability ([#243](https://github.com/spotify/confidence-resolver/issues/243)) ([8d86283](https://github.com/spotify/confidence-resolver/commit/8d862837244ffd9099bfeb56b42e203212e73a96))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * rust-guest bumped from 0.1.12 to 0.1.13
+
+## [0.6.0](https://github.com/spotify/confidence-resolver/compare/openfeature-provider-js-v0.5.1...openfeature-provider-js-v0.6.0) (2026-01-15)
+
+
+### Features
+
+* **js:** add stateUpdateInterval option for configurable state polling ([#224](https://github.com/spotify/confidence-resolver/issues/224)) ([5687847](https://github.com/spotify/confidence-resolver/commit/56878478d3d508870ac0f3172f897c8728e8a85d))
+
+
+### Bug Fixes
+
+* prevent split bundle ([#212](https://github.com/spotify/confidence-resolver/issues/212)) ([80cfd0d](https://github.com/spotify/confidence-resolver/commit/80cfd0d0128af4c65b1ae50539f2b1d0d959c02e))
+
 ## [0.5.1](https://github.com/spotify/confidence-resolver/compare/openfeature-provider-js-v0.5.0...openfeature-provider-js-v0.5.1) (2026-01-12)
 
 

package/README.md

@@ -3,12 +3,14 @@
 OpenFeature provider for the Spotify Confidence resolver (local mode, powered by WebAssembly). It periodically fetches resolver state, evaluates flags locally, and flushes evaluation logs to the Confidence backend.
 
 ## Features
+
 - Local flag evaluation via WASM (no per-eval network calls)
 - Automatic state refresh and batched flag log flushing
 - Pluggable `fetch` with retries, timeouts and routing
 - Optional logging using `debug`
 
 ## Requirements
+
 - Node.js 18+ (built-in `fetch`) or provide a compatible `fetch`
 - WebAssembly support (Node 18+/modern browsers)
 
@@ -24,6 +26,7 @@ yarn add debug
 ```
 
 Notes:
+
 - `debug` is an optional peer. Install it if you want logs. Without it, logging is a no-op.
 - Types and bundling are ESM-first; Node is supported, and a browser build is provided for modern bundlers.
 
@@ -34,6 +37,7 @@ Notes:
 You'll need a **client secret** from Confidence to use this provider.
 
 **📖 See the [Integration Guide: Getting Your Credentials](../INTEGRATION_GUIDE.md#getting-your-credentials)** for step-by-step instructions on:
+
 - How to navigate the Confidence dashboard
 - Creating a Backend integration
 - Creating a test flag for verification
@@ -50,6 +54,7 @@ import { createConfidenceServerProvider } from '@spotify-confidence/openfeature-
 const provider = createConfidenceServerProvider({
   flagClientSecret: process.env.CONFIDENCE_FLAG_CLIENT_SECRET!,
   // initializeTimeout?: number
+  // stateUpdateInterval?: number
   // flushInterval?: number
   // fetch?: typeof fetch (Node <18 or custom transport)
 });
@@ -103,6 +108,7 @@ const context = {
 The provider uses a **default value fallback** pattern - when evaluation fails, it returns your specified default value instead of throwing an error.
 
 **📖 See the [Integration Guide: Error Handling](../INTEGRATION_GUIDE.md#error-handling)** for:
+
 - Common failure scenarios
 - Error codes and meanings
 - Production best practices
@@ -118,8 +124,8 @@ const enabled = await client.getBooleanValue('my-flag.enabled', false, context);
 // For detailed error information, use getBooleanDetails()
 const details = await client.getBooleanDetails('my-flag.enabled', false, context);
 if (details.errorCode) {
-    console.error('Flag evaluation error:', details.errorMessage);
-    console.log('Reason:', details.reason);
+  console.error('Flag evaluation error:', details.errorMessage);
+  console.log('Reason:', details.reason);
 }
 ```
 
@@ -129,12 +135,73 @@ if (details.errorCode) {
 
 - `flagClientSecret` (string, required): The flag client secret used during evaluation and authentication.
 - `initializeTimeout` (number, optional): Max ms to wait for initial state fetch. Defaults to 30_000.
+- `stateUpdateInterval` (number, optional): Interval in ms between state polling updates. Defaults to 30_000.
 - `flushInterval` (number, optional): Interval in ms for sending evaluation logs. Defaults to 10_000.
 - `fetch` (optional): Custom `fetch` implementation. Required for Node < 18; for Node 18+ you can omit.
 
 The provider periodically:
-- Refreshes resolver state (default every 30s)
-- Flushes flag evaluation logs to the backend
+
+- Refreshes resolver state (configurable via `stateUpdateInterval`, default every 30s)
+- Flushes flag evaluation logs to the backend (configurable via `flushInterval`, default every 10s)
+
+---
+
+## Exports and WASM Loading
+
+The package provides multiple exports for different environments:
+
+### Default export (recommended)
+
+```ts
+import { createConfidenceServerProvider } from '@spotify-confidence/openfeature-server-provider-local';
+```
+
+The WASM is **inlined as a data URL** — this is the most portable option and should work across virtually all environments. The tradeoff is a larger bundle (~700kB), but this isn't a problem for the intended server-side usage.
+
+No configuration needed.
+
+### `./node` — Traditional Node.js
+
+```ts
+import { createConfidenceServerProvider } from '@spotify-confidence/openfeature-server-provider-local/node';
+```
+
+Uses `fs.readFile()` to load WASM from the installed package. Works well in a regular Node.js environment with node_modules.
+
+You can customize the WASM path if needed:
+
+```ts
+const provider = createConfidenceServerProvider({
+  flagClientSecret: '...',
+  wasmPath: '/custom/path/to/confidence_resolver.wasm',
+});
+```
+
+### `./fetch` — Modern and standards compliant environments
+
+```ts
+import { createConfidenceServerProvider } from '@spotify-confidence/openfeature-server-provider-local/fetch';
+```
+
+Uses `fetch()` with `import.meta.url` to load WASM. Works in Deno, Bun, and browsers with bundlers that properly handle asset URLs (Vite, Rollup, etc.).
+
+You can customize the WASM URL if needed:
+
+```ts
+const provider = createConfidenceServerProvider({
+  flagClientSecret: '...',
+  wasmUrl: '/assets/confidence_resolver.wasm',
+});
+```
+
+### A note on browser usage
+
+While browsers are mentioned in this doc, this package is intended for server-side use only. Two concerns for browser usage:
+
+- Size: The WASM+JS is currently ~270kb gzipped, too large for typical client bundles.
+- Security: In a browser, all flag rules and variants are exposed to users.
+
+That said, the package does work in browsers, and there may be specialized use cases where these tradeoffs are acceptable.
 
 ---
 
@@ -162,11 +229,13 @@ const provider = createConfidenceServerProvider({
 ```
 
 **When to use**:
+
 - You need sticky assignments or materialized segments but don't want to manage storage infrastructure
 - Quick prototyping or getting started
 - Lower-volume applications where network latency is acceptable
 
 **Trade-offs**:
+
 - Additional network calls during flag resolution (adds latency)
 - Lower performance compared to local storage implementations (Redis, DynamoDB, etc.)
 
@@ -198,6 +267,7 @@ For read-only stores (e.g., pre-populated materialized segments without sticky a
 ### When to Use Materialization Stores
 
 Consider implementing a materialization store if:
+
 - You need to support sticky variant assignments for experiments
 - You use materialized segments for custom targeting
 - You want to minimize network latency during flag resolution
@@ -212,10 +282,12 @@ If you don't use sticky assignments or materialized segments, the default behavi
 Logging uses the `debug` library if present; otherwise, all log calls are no-ops.
 
 Namespaces:
+
 - Core: `cnfd:*`
 - Fetch/middleware: `cnfd:fetch:*` (e.g. retries, auth renewals, request summaries)
 
 Log levels are hierarchical:
+
 - `cnfd:debug` enables debug, info, warn, and error
 - `cnfd:info` enables info, warn, and error
 - `cnfd:warn` enables warn and error
@@ -224,6 +296,7 @@ Log levels are hierarchical:
 Enable logs:
 
 - Node:
+
 ```bash
 DEBUG=cnfd:* node app.js
 # or narrower
@@ -231,6 +304,7 @@ DEBUG=cnfd:info,cnfd:fetch:* node app.js
 ```
 
 - Browser (in DevTools console):
+
 ```js
 localStorage.debug = 'cnfd:*';
 ```
@@ -243,19 +317,6 @@ yarn add debug
 
 ---
 
-## WebAssembly asset notes
-
-- Node: the WASM (`confidence_resolver.wasm`) is resolved from the installed package automatically; no extra config needed.
-- Browser: the ESM build resolves the WASM via `new URL('confidence_resolver.wasm', import.meta.url)` so modern bundlers (Vite/Rollup/Webpack 5 asset modules) will include it. If your bundler does not, configure it to treat the `.wasm` file as a static asset.
-
----
-
-## Using in browsers
-
-The package exports a browser ESM build that compiles the WASM via streaming and uses the global `fetch`. Integrate it with your OpenFeature SDK variant for the web similarly to Node, then register the provider before evaluation. Credentials must be available to the runtime (e.g. through your app’s configuration layer).
-
----
-
 ## Testing
 
 - You can inject a custom `fetch` via the `fetch` option to stub network behavior in tests.