@openfeature/web-sdk 0.4.0 → 0.4.2

package/dist/cjs/index.js

@@ -450,7 +450,6 @@ __export(src_exports, {
   InvalidContextError: () => InvalidContextError,
   LOG_LEVELS: () => LOG_LEVELS,
   NOOP_PROVIDER: () => NOOP_PROVIDER,
-  NOOP_TRANSACTION_CONTEXT_PROPAGATOR: () => NOOP_TRANSACTION_CONTEXT_PROPAGATOR,
   OpenFeature: () => OpenFeature,
   OpenFeatureAPI: () => OpenFeatureAPI,
   OpenFeatureClient: () => OpenFeatureClient,
@@ -467,6 +466,7 @@ __export(src_exports, {
   isObject: () => isObject,
   isString: () => isString,
   objectOrUndefined: () => objectOrUndefined,
+  statusMatchesEvent: () => statusMatchesEvent,
   stringOrUndefined: () => stringOrUndefined
 });
 module.exports = __toCommonJS(src_exports);
@@ -588,6 +588,15 @@ var InvalidContextError = class extends OpenFeatureError {
   }
 };
 
+// ../shared/src/provider/provider.ts
+var ProviderStatus = /* @__PURE__ */ ((ProviderStatus2) => {
+  ProviderStatus2["NOT_READY"] = "NOT_READY";
+  ProviderStatus2["READY"] = "READY";
+  ProviderStatus2["ERROR"] = "ERROR";
+  ProviderStatus2["STALE"] = "STALE";
+  return ProviderStatus2;
+})(ProviderStatus || {});
+
 // ../shared/src/events/events.ts
 var ProviderEvents = /* @__PURE__ */ ((ProviderEvents2) => {
   ProviderEvents2["Ready"] = "PROVIDER_READY";
@@ -597,6 +606,20 @@ var ProviderEvents = /* @__PURE__ */ ((ProviderEvents2) => {
   return ProviderEvents2;
 })(ProviderEvents || {});
 
+// ../shared/src/events/event-utils.ts
+var eventStatusMap = {
+  ["READY" /* READY */]: "PROVIDER_READY" /* Ready */,
+  ["ERROR" /* ERROR */]: "PROVIDER_ERROR" /* Error */,
+  ["STALE" /* STALE */]: "PROVIDER_STALE" /* Stale */,
+  ["NOT_READY" /* NOT_READY */]: void 0
+};
+var statusMatchesEvent = (event, status) => {
+  return !status && event === "PROVIDER_READY" /* Ready */ || eventStatusMap[status] === event;
+};
+
+// ../shared/src/events/open-feature-event-emitter.ts
+var import_events2 = __toESM(require_events());
+
 // ../shared/src/logger/default-logger.ts
 var DefaultLogger = class {
   error(...args) {
@@ -651,13 +674,12 @@ var SafeLogger = class {
 };
 
 // ../shared/src/events/open-feature-event-emitter.ts
-var import_events = __toESM(require_events());
 var GenericEventEmitter = class {
   constructor(globalLogger) {
     this.globalLogger = globalLogger;
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     this._handlers = /* @__PURE__ */ new WeakMap();
-    this.eventEmitter = new import_events.default({ captureRejections: true });
+    this.eventEmitter = new import_events2.default({ captureRejections: true });
     this.eventEmitter.on("error", (err) => {
       var _a;
       (_a = this._logger) == null ? void 0 : _a.error("Error running event handler:", err);
@@ -667,8 +689,8 @@ var GenericEventEmitter = class {
     this.eventEmitter.emit(eventType, context);
   }
   addHandler(eventType, handler) {
-    const asyncHandler = (context) => __async(this, null, function* () {
-      yield handler(context);
+    const asyncHandler = (details) => __async(this, null, function* () {
+      yield handler(details);
     });
     this._handlers.set(handler, asyncHandler);
     this.eventEmitter.on(eventType, asyncHandler);
@@ -704,25 +726,6 @@ var OpenFeatureEventEmitter = class extends GenericEventEmitter {
 var InternalEventEmitter = class extends GenericEventEmitter {
 };
 
-// ../shared/src/provider/provider.ts
-var ProviderStatus = /* @__PURE__ */ ((ProviderStatus2) => {
-  ProviderStatus2["NOT_READY"] = "NOT_READY";
-  ProviderStatus2["READY"] = "READY";
-  ProviderStatus2["ERROR"] = "ERROR";
-  return ProviderStatus2;
-})(ProviderStatus || {});
-
-// ../shared/src/transaction-context/no-op-transaction-context-propagator.ts
-var NoopTransactionContextPropagator = class {
-  getTransactionContext() {
-    return {};
-  }
-  setTransactionContext(_, callback) {
-    callback();
-  }
-};
-var NOOP_TRANSACTION_CONTEXT_PROPAGATOR = new NoopTransactionContextPropagator();
-
 // ../shared/src/type-guards.ts
 function isString(value) {
   return typeof value === "string";
@@ -744,15 +747,15 @@ function isDefined(input) {
 
 // ../shared/src/open-feature.ts
 var OpenFeatureCommonAPI = class {
-  constructor() {
+  constructor(category) {
     this._hooks = [];
-    this._transactionContextPropagator = NOOP_TRANSACTION_CONTEXT_PROPAGATOR;
     this._context = {};
     this._logger = new DefaultLogger();
     this._events = new InternalEventEmitter(() => this._logger);
     this._clientEventHandlers = /* @__PURE__ */ new Map();
     this._clientProviders = /* @__PURE__ */ new Map();
     this._clientEvents = /* @__PURE__ */ new Map();
+    this._runsOn = category;
   }
   addHooks(...hooks) {
     this._hooks = [...this._hooks, ...hooks];
@@ -779,11 +782,24 @@ var OpenFeatureCommonAPI = class {
   /**
    * Adds a handler for the given provider event type.
    * The handlers are called in the order they have been added.
-   * When changing the provider, the currently attached handlers will listen to the events of the new provider.
+   * API (global) events run for all providers.
    * @param {ProviderEvents} eventType The provider event type to listen to
    * @param {EventHandler} handler The handler to run on occurrence of the event type
    */
   addHandler(eventType, handler) {
+    [.../* @__PURE__ */ new Map([[void 0, this._defaultProvider]]), ...this._clientProviders].forEach((keyProviderTuple) => {
+      var _a;
+      const clientName = keyProviderTuple[0];
+      const provider = keyProviderTuple[1];
+      const shouldRunNow = statusMatchesEvent(eventType, keyProviderTuple[1].status);
+      if (shouldRunNow) {
+        try {
+          handler({ clientName, providerName: provider.metadata.name });
+        } catch (err) {
+          (_a = this._logger) == null ? void 0 : _a.error("Error running event handler:", err);
+        }
+      }
+    });
     this._events.addHandler(eventType, handler);
   }
   /**
@@ -802,43 +818,66 @@ var OpenFeatureCommonAPI = class {
   getHandlers(eventType) {
     return this._events.getHandlers(eventType);
   }
+  setProviderAndWait(clientOrProvider, providerOrUndefined) {
+    return __async(this, null, function* () {
+      yield this.setAwaitableProvider(clientOrProvider, providerOrUndefined);
+    });
+  }
   setProvider(clientOrProvider, providerOrUndefined) {
-    var _a, _b, _c, _d, _e, _f, _g;
+    const maybePromise = this.setAwaitableProvider(clientOrProvider, providerOrUndefined);
+    if (maybePromise) {
+      maybePromise.catch(() => {
+      });
+    }
+    return this;
+  }
+  setAwaitableProvider(clientOrProvider, providerOrUndefined) {
+    var _a, _b, _c, _d, _e, _f;
     const clientName = stringOrUndefined(clientOrProvider);
     const provider = (_a = objectOrUndefined(clientOrProvider)) != null ? _a : objectOrUndefined(providerOrUndefined);
     if (!provider) {
-      return this;
+      this._logger.debug("No provider defined, ignoring setProvider call");
+      return;
     }
     const oldProvider = this.getProviderForClient(clientName);
+    const providerName = provider.metadata.name;
     if (oldProvider === provider) {
-      return this;
+      this._logger.debug("Provider is already set, ignoring setProvider call");
+      return;
+    }
+    if (!provider.runsOn) {
+      this._logger.debug(`Provider '${provider.metadata.name}' has not defined its intended use.`);
+    } else if (provider.runsOn !== this._runsOn) {
+      throw new GeneralError(`Provider '${provider.metadata.name}' is intended for use on the ${provider.runsOn}.`);
     }
     const emitters = this.getAssociatedEventEmitters(clientName);
     if (typeof provider.initialize === "function" && provider.status === void 0) {
       const activeLogger = this._logger || console;
       activeLogger.warn(
-        `Provider ${(_b = provider == null ? void 0 : provider.metadata) == null ? void 0 : _b.name} implements 'initialize' but not 'status'. Please implement 'status'.`
+        `Provider ${providerName} implements 'initialize' but not 'status'. Please implement 'status'.`
       );
     }
+    let initializationPromise = void 0;
     if ((provider == null ? void 0 : provider.status) === "NOT_READY" /* NOT_READY */ && typeof provider.initialize === "function") {
-      (_e = (_d = (_c = provider.initialize) == null ? void 0 : _c.call(provider, this._context)) == null ? void 0 : _d.then(() => {
+      initializationPromise = (_d = (_c = (_b = provider.initialize) == null ? void 0 : _b.call(provider, this._context)) == null ? void 0 : _c.then(() => {
         var _a2;
         this.getAssociatedEventEmitters(clientName).forEach((emitter) => {
-          emitter == null ? void 0 : emitter.emit("PROVIDER_READY" /* Ready */, { clientName });
+          emitter == null ? void 0 : emitter.emit("PROVIDER_READY" /* Ready */, { clientName, providerName });
         });
-        (_a2 = this._events) == null ? void 0 : _a2.emit("PROVIDER_READY" /* Ready */, { clientName });
-      })) == null ? void 0 : _e.catch((error) => {
+        (_a2 = this._events) == null ? void 0 : _a2.emit("PROVIDER_READY" /* Ready */, { clientName, providerName });
+      })) == null ? void 0 : _d.catch((error) => {
         var _a2;
         this.getAssociatedEventEmitters(clientName).forEach((emitter) => {
-          emitter == null ? void 0 : emitter.emit("PROVIDER_ERROR" /* Error */, { clientName, message: error.message });
+          emitter == null ? void 0 : emitter.emit("PROVIDER_ERROR" /* Error */, { clientName, providerName, message: error.message });
         });
-        (_a2 = this._events) == null ? void 0 : _a2.emit("PROVIDER_ERROR" /* Error */, { clientName, message: error.message });
+        (_a2 = this._events) == null ? void 0 : _a2.emit("PROVIDER_ERROR" /* Error */, { clientName, providerName, message: error.message });
+        throw error;
       });
     } else {
       emitters.forEach((emitter) => {
-        emitter == null ? void 0 : emitter.emit("PROVIDER_READY" /* Ready */, { clientName });
+        emitter == null ? void 0 : emitter.emit("PROVIDER_READY" /* Ready */, { clientName, providerName });
       });
-      (_f = this._events) == null ? void 0 : _f.emit("PROVIDER_READY" /* Ready */, { clientName });
+      (_e = this._events) == null ? void 0 : _e.emit("PROVIDER_READY" /* Ready */, { clientName, providerName });
     }
     if (clientName) {
       this._clientProviders.set(clientName, provider);
@@ -847,9 +886,9 @@ var OpenFeatureCommonAPI = class {
     }
     this.transferListeners(oldProvider, provider, clientName, emitters);
     if (![...this._clientProviders.values(), this._defaultProvider].includes(oldProvider)) {
-      (_g = oldProvider == null ? void 0 : oldProvider.onClose) == null ? void 0 : _g.call(oldProvider);
+      (_f = oldProvider == null ? void 0 : oldProvider.onClose) == null ? void 0 : _f.call(oldProvider);
     }
-    return this;
+    return initializationPromise;
   }
   getProviderForClient(name) {
     var _a;
@@ -870,7 +909,7 @@ var OpenFeatureCommonAPI = class {
       (eventType) => {
         var _a;
         return (_a = clientProvider.events) == null ? void 0 : _a.addHandler(eventType, (details) => __async(this, null, function* () {
-          newEmitter.emit(eventType, __spreadProps(__spreadValues({}, details), { clientName: name }));
+          newEmitter.emit(eventType, __spreadProps(__spreadValues({}, details), { clientName: name, providerName: clientProvider.metadata.name }));
         }));
       }
     );
@@ -899,9 +938,9 @@ var OpenFeatureCommonAPI = class {
     const newClientHandlers = Object.values(ProviderEvents).map((eventType) => {
       const handler = (details) => __async(this, null, function* () {
         emitters.forEach((emitter) => {
-          emitter == null ? void 0 : emitter.emit(eventType, __spreadProps(__spreadValues({}, details), { clientName }));
+          emitter == null ? void 0 : emitter.emit(eventType, __spreadProps(__spreadValues({}, details), { clientName, providerName: newProvider.metadata.name }));
         });
-        this._events.emit(eventType, __spreadProps(__spreadValues({}, details), { clientName }));
+        this._events.emit(eventType, __spreadProps(__spreadValues({}, details), { clientName, providerName: newProvider.metadata.name }));
       });
       return [eventType, handler];
     });
@@ -926,40 +965,28 @@ var OpenFeatureCommonAPI = class {
           try {
             yield (_a2 = provider.onClose) == null ? void 0 : _a2.call(provider);
           } catch (err) {
-            this.handleShutdownError(this._defaultProvider, err);
+            this.handleShutdownError(provider, err);
           }
         }))
       );
     });
   }
+  clearProvidersAndSetDefault(defaultProvider) {
+    return __async(this, null, function* () {
+      try {
+        yield this.close();
+      } catch (err) {
+        this._logger.error("Unable to cleanly close providers. Resetting to the default configuration.");
+      } finally {
+        this._clientProviders.clear();
+        this._defaultProvider = defaultProvider;
+      }
+    });
+  }
   handleShutdownError(provider, err) {
     this._logger.error(`Error during shutdown of provider ${provider.metadata.name}: ${err}`);
     this._logger.error(err == null ? void 0 : err.stack);
   }
-  setTransactionContextPropagator(transactionContextPropagator) {
-    const baseMessage = "Invalid TransactionContextPropagator, will not be set: ";
-    if (typeof (transactionContextPropagator == null ? void 0 : transactionContextPropagator.getTransactionContext) !== "function") {
-      this._logger.error(`${baseMessage}: getTransactionContext is not a function.`);
-    } else if (typeof (transactionContextPropagator == null ? void 0 : transactionContextPropagator.setTransactionContext) !== "function") {
-      this._logger.error(`${baseMessage}: setTransactionContext is not a function.`);
-    } else {
-      this._transactionContextPropagator = transactionContextPropagator;
-    }
-    return this;
-  }
-  setTransactionContext(transactionContext, callback, ...args) {
-    this._transactionContextPropagator.setTransactionContext(transactionContext, callback, ...args);
-  }
-  getTransactionContext() {
-    try {
-      return this._transactionContextPropagator.getTransactionContext();
-    } catch (err) {
-      const error = err;
-      this._logger.error(`Error getting transaction context: ${error == null ? void 0 : error.message}, returning empty context.`);
-      this._logger.error(error == null ? void 0 : error.stack);
-      return {};
-    }
-  }
 };
 
 // src/provider/no-op-provider.ts
@@ -1000,7 +1027,7 @@ var _globalThis = globalThis;
 var OpenFeatureAPI = class extends OpenFeatureCommonAPI {
   // eslint-disable-next-line @typescript-eslint/no-empty-function
   constructor() {
-    super();
+    super("client");
     this._defaultProvider = NOOP_PROVIDER;
   }
   /**
@@ -1058,6 +1085,13 @@ var OpenFeatureAPI = class extends OpenFeatureCommonAPI {
       { name, version }
     );
   }
+  /**
+   * Clears all registered providers and resets the default provider.
+   * @returns {Promise<void>}
+   */
+  clearProviders() {
+    return super.clearProvidersAndSetDefault(NOOP_PROVIDER);
+  }
 };
 var OpenFeature = OpenFeatureAPI.getInstance();
 
@@ -1083,7 +1117,7 @@ var OpenFeatureClient = class {
     const providerReady = !this._provider.status || this._provider.status === "READY" /* READY */;
     if (eventType === "PROVIDER_READY" /* Ready */ && providerReady) {
       try {
-        handler({ clientName: this.metadata.name });
+        handler({ clientName: this.metadata.name, providerName: this._provider.metadata.name });
       } catch (err) {
         (_a = this._logger) == null ? void 0 : _a.error("Error running event handler:", err);
       }