@openfeature/flagd-provider 0.9.0 → 0.10.0

package/package.json

@@ -1,12 +1,18 @@
 {
   "name": "@openfeature/flagd-provider",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "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"
   },
+  "dependencies": {
+    "@openfeature/flagd-core": ">=0.1.1",
+    "@protobuf-ts/runtime-rpc": "2.9.0",
+    "lru-cache": "10.0.1",
+    "util": "0.12.5"
+  },
   "peerDependencies": {
-    "@grpc/grpc-js": "^1.6.0",
+    "@grpc/grpc-js": "~1.8.0 || ~1.9.0",
     "@openfeature/server-sdk": ">=1.6.0"
   },
   "exports": {
@@ -18,10 +24,5 @@
     }
   },
   "module": "./index.esm.js",
-  "main": "./index.cjs.js",
-  "dependencies": {
-    "@protobuf-ts/runtime-rpc": "2.9.0",
-    "lru-cache": "10.0.1",
-    "util": "0.12.5"
-  }
+  "main": "./index.cjs.js"
 }

package/src/e2e/jest.config.d.ts

@@ -1,9 +1,12 @@
 declare const _default: {
     displayName: string;
     clearMocks: boolean;
-    setupFiles: string[];
     preset: string;
     verbose: boolean;
     silent: boolean;
+    moduleNameMapper: {
+        '@openfeature/flagd-core': string[];
+    };
+    globalTeardown: string;
 };
 export default _default;

package/src/e2e/setup-rpc-provider.d.ts

@@ -0,0 +1 @@
+export {};

package/src/e2e/tear-down.d.ts

@@ -0,0 +1,2 @@
+declare const tearDownTests: () => Promise<void>;
+export default tearDownTests;

package/src/lib/configuration.d.ts

@@ -1,4 +1,5 @@
 export type CacheOption = 'lru' | 'disabled';
+export type ResolverType = 'rpc' | 'in-process';
 export interface Config {
     /**
      * The domain name or IP address of flagd.
@@ -24,6 +25,21 @@ export interface Config {
      * @example "/tmp/flagd.socks"
      */
     socketPath?: string;
+    /**
+     * Resolver type to use by the provider.
+     *
+     * Options include rpc & in-process.
+     *
+     * rpc - flag resolving happens remotely over gRPC
+     * in-process - flag resolving happens in-process, fetching flag definitions using the {@link https://github.com/open-feature/flagd-schemas/blob/main/protobuf/sync/v1/sync_service.proto|sync.proto}
+     *
+     * @default 'rpc'
+     */
+    resolverType?: ResolverType;
+    /**
+     * Selector to be used with flag sync gRPC contract.
+     */
+    selector?: string;
     /**
      * Cache implementation to use (or disabled).
      *
@@ -36,12 +52,6 @@ export interface Config {
      * @default 1000
      */
     maxCacheSize?: number;
-    /**
-     * Amount of times to attempt to reconnect to the event stream.
-     *
-     * @default 5
-     */
-    maxEventStreamRetries?: number;
 }
 export type FlagdProviderOptions = Partial<Config>;
 export declare function getConfig(options?: FlagdProviderOptions): {
@@ -49,7 +59,8 @@ export declare function getConfig(options?: FlagdProviderOptions): {
     port: number;
     tls: boolean;
     socketPath?: string | undefined;
+    resolverType?: ResolverType | undefined;
+    selector?: string | undefined;
     cache?: CacheOption | undefined;
     maxCacheSize?: number | undefined;
-    maxEventStreamRetries?: number | undefined;
 };

package/src/lib/constants.d.ts

@@ -1,5 +1,5 @@
 export declare const BASE_EVENT_STREAM_RETRY_BACKOFF_MS = 1000;
-export declare const DEFAULT_MAX_EVENT_STREAM_RETRIES = 5;
+export declare const DEFAULT_MAX_EVENT_STREAM_RETRIES: number;
 export declare const EVENT_CONFIGURATION_CHANGE = "configuration_change";
 export declare const EVENT_PROVIDER_READY = "provider_ready";
 export declare const DEFAULT_MAX_CACHE_SIZE = 1000;

package/src/lib/flagd-provider.d.ts

@@ -22,12 +22,12 @@ export declare class FlagdProvider implements Provider {
     constructor(options?: FlagdProviderOptions, logger?: Logger | undefined, service?: Service);
     initialize(): Promise<void>;
     onClose(): Promise<void>;
-    resolveBooleanEvaluation(flagKey: string, _: boolean, transformedContext: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
-    resolveStringEvaluation(flagKey: string, _: string, transformedContext: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
-    resolveNumberEvaluation(flagKey: string, _: number, transformedContext: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
-    resolveObjectEvaluation<T extends JsonValue>(flagKey: string, _: T, transformedContext: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
+    resolveBooleanEvaluation(flagKey: string, defaultValue: boolean, transformedContext: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
+    resolveStringEvaluation(flagKey: string, defaultValue: string, transformedContext: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
+    resolveNumberEvaluation(flagKey: string, defaultValue: number, transformedContext: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
+    resolveObjectEvaluation<T extends JsonValue>(flagKey: string, defaultValue: T, transformedContext: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
     logRejected: (err: Error, flagKey: string, logger: Logger) => never;
-    private setReady;
-    private setError;
-    private emitChanged;
+    private handleReconnect;
+    private handleError;
+    private handleChanged;
 }

package/src/lib/service/grpc/grpc-service.d.ts

@@ -23,24 +23,19 @@ export declare class GRPCService implements Service {
     private _client;
     private _cache;
     private _cacheEnabled;
-    private _streamAlive;
-    private _streamConnectAttempt;
-    private _stream;
-    private _streamConnectBackoff;
-    private _maxEventStreamRetries;
+    private _eventStream;
     private get _cacheActive();
     constructor(config: Config, client?: ServiceClient, logger?: Logger | undefined);
-    connect(connectCallback: () => void, changedCallback: (flagsChanged: string[]) => void, disconnectCallback: () => void): Promise<void>;
+    connect(reconnectCallback: () => void, changedCallback: (flagsChanged: string[]) => void, disconnectCallback: () => void): Promise<void>;
     disconnect(): Promise<void>;
-    resolveBoolean(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
-    resolveString(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
-    resolveNumber(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
-    resolveObject<T extends JsonValue>(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
-    private connectStream;
-    private handleProviderReady;
+    resolveBoolean(flagKey: string, _: boolean, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
+    resolveString(flagKey: string, _: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
+    resolveNumber(flagKey: string, _: number, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
+    resolveObject<T extends JsonValue>(flagKey: string, _: T, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
+    private listen;
     private handleFlagsChanged;
+    private reconnect;
     private handleError;
-    private handleClose;
     private resolve;
     private onRejected;
 }

package/src/lib/service/in-process/data-fetch.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Contract of in-process resolver's data fetcher
+ */
+export interface DataFetch {
+    connect(dataFillCallback: (flags: string) => void, reconnectCallback: () => void, changedCallback: (flagsChanged: string[]) => void, disconnectCallback: () => void): Promise<void>;
+    disconnect(): void;
+}

package/src/lib/service/in-process/grpc/grpc-fetch.d.ts

@@ -0,0 +1,18 @@
+import { Logger } from '@openfeature/core';
+import { FlagSyncServiceClient } from '../../../../proto/ts/sync/v1/sync_service';
+import { Config } from '../../../configuration';
+import { DataFetch } from '../data-fetch';
+/**
+ * Implements the gRPC sync contract to fetch flag data.
+ */
+export declare class GrpcFetch implements DataFetch {
+    private _syncClient;
+    private _syncStream;
+    private readonly _request;
+    private _logger;
+    constructor(config: Config, syncServiceClient?: FlagSyncServiceClient, logger?: Logger);
+    connect(dataFillCallback: (flags: string) => void, reconnectCallback: () => void, changedCallback: (flagsChanged: string[]) => void, disconnectCallback: () => void): Promise<void>;
+    disconnect(): void;
+    private listen;
+    private reconnect;
+}

package/src/lib/service/in-process/in-process-service.d.ts

@@ -0,0 +1,16 @@
+import { Service } from '../service';
+import { EvaluationContext, JsonValue, Logger, ResolutionDetails } from '@openfeature/core';
+import { Config } from '../../configuration';
+import { DataFetch } from './data-fetch';
+export declare class InProcessService implements Service {
+    private _flagdCore;
+    private _dataFetcher;
+    constructor(config: Config, dataFetcher?: DataFetch, logger?: Logger);
+    connect(reconnectCallback: () => void, changedCallback: (flagsChanged: string[]) => void, disconnectCallback: () => void): Promise<void>;
+    disconnect(): Promise<void>;
+    resolveBoolean(flagKey: string, defaultValue: boolean, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
+    resolveNumber(flagKey: string, defaultValue: number, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
+    resolveString(flagKey: string, defaultValue: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
+    resolveObject<T extends JsonValue>(flagKey: string, defaultValue: T, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
+    private fill;
+}

package/src/lib/service/service.d.ts

@@ -2,8 +2,8 @@ import { EvaluationContext, JsonValue, Logger, ResolutionDetails } from '@openfe
 export interface Service {
     connect(reconnectCallback: () => void, changedCallback: (flagsChanged: string[]) => void, disconnectCallback: () => void): Promise<void>;
     disconnect(): Promise<void>;
-    resolveBoolean(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
-    resolveString(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
-    resolveNumber(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
-    resolveObject<T extends JsonValue>(flagKey: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
+    resolveBoolean(flagKey: string, defaultValue: boolean, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
+    resolveString(flagKey: string, defaultValue: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
+    resolveNumber(flagKey: string, defaultValue: number, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
+    resolveObject<T extends JsonValue>(flagKey: string, defaultValue: T, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
 }