changed provider logging to debug. Tidied up README

Signed-off-by: jarebudev <[email protected]>

Author: jarebudev

libs/providers/unleash-web/README.md

@@ -27,24 +27,75 @@ $ npm install @openfeature/unleash-web-provider @openfeature/web-sdk
 
 ## Usage
 
-To initialize the OpenFeature client with Unleash, you can use the following code snippet:
+To initialize the OpenFeature client with Unleash, you can use the following code snippets:
+
+### Initialization - without context
+
+```ts
+import { UnleashWebProvider } from '@openfeature/unleash-web-provider';
+
+const provider = new UnleashWebProvider({
+    url: 'http://your.upstream.unleash.instance',
+    clientKey: 'theclientkey',
+    appName: 'your app',
+});
+  
+await OpenFeature.setProviderAndWait(provider);
+```
+
+### Initialization - with context
+
+The [Unleash context](https://docs.getunleash.io/reference/unleash-context) can be set during creation of the provider.
 
 ```ts
 import { UnleashWebProvider } from '@openfeature/unleash-web-provider';
 
+const context = {
+    userId: '123',
+    sessionId: '456',
+    remoteAddress: 'address',
+    properties: {
+        property1: 'property1',
+        property2: 'property2',
+    },
+};
+
 const provider = new UnleashWebProvider({
-      url: 'http://your.upstream.unleash.instance',
-      clientKey: 'theclientkey',
-      appName: 'your app',
-  });
+    url: 'http://your.upstream.unleash.instance',
+    clientKey: 'theclientkey',
+    appName: 'your app',
+    context: context,
+});
 
 await OpenFeature.setProviderAndWait(provider);
 ```
 
+
+### Available Constructor Configuration Options
+
+Unleash has a variety of configuration options that can be provided to the `UnleashWebProvider` constructor.
+
+Please refer to the options described in the official [Unleash Proxy Client for the browser Client Side SDK](https://docs.getunleash.io/reference/sdks/javascript-browser#available-options).
+
+
+
+
+### After initialization
+
 After the provider gets initialized, you can start evaluations of feature flags like so:
 
 ```ts
-// Note - this can also be set within the contructor
+
+// Get the client 
+const client = await OpenFeature.getClient();
+
+// You can now use the client to evaluate your flags
+const details = client.getBooleanValue('my-feature', false);
+```
+
+The static evaluation context can be changed if needed
+
+```ts
 const evaluationCtx: EvaluationContext = {
   usedId: 'theuser',
   currentTime: 'time',
@@ -56,20 +107,10 @@ const evaluationCtx: EvaluationContext = {
   anotherCustomProperty: 'somethingForIt',
 };
 
-// Set the static context for OpenFeature
+// changes the static evaluation context for OpenFeature
 await OpenFeature.setContext(evaluationCtx);
 
-// Get the client 
-const client = await OpenFeature.getClient();
-
-// You can now use the client to evaluate your flags
-const details = client.getBooleanValue('my-feature', false);
 ```
-### Available Options
-
-Unleash has a variety of configuration options that can be provided to the the `UnleashWebProvider` constructor.
-
-Please refer to the options described in the official [Unleash Proxy Client for the browser Client Side SDK](https://docs.getunleash.io/reference/sdks/javascript-browser#available-options).
 
 ## Contribute
 

libs/providers/unleash-web/src/lib/unleash-web-provider.spec.ts

@@ -17,7 +17,19 @@ describe('UnleashWebProvider', () => {
 
   it('should be an instance of UnleashWebProvider', async () => {
     fetchMock.mockResponseOnce(JSON.stringify({ toggles: [] }));
-    provider = new UnleashWebProvider({ url: endpoint, clientKey: 'clientsecret', appName: 'test' }, logger);
+    const context = {
+      userId: '123',
+      sessionId: '456',
+      remoteAddress: 'address',
+      properties: {
+        property1: 'property1',
+        property2: 'property2',
+      },
+    };
+    provider = new UnleashWebProvider(
+      { url: endpoint, clientKey: 'clientsecret', appName: 'test', context: context },
+      logger,
+    );
     await provider.initialize();
     expect(provider).toBeInstanceOf(UnleashWebProvider);
   });

libs/providers/unleash-web/src/lib/unleash-web-provider.ts

@@ -43,7 +43,7 @@ export class UnleashWebProvider implements Provider {
 
   async initialize(): Promise<void> {
     await this.initializeClient();
-    this._logger?.info('UnleashWebProvider initialized');
+    this._logger?.debug('UnleashWebProvider initialized');
   }
 
   private async initializeClient() {
@@ -57,25 +57,25 @@ export class UnleashWebProvider implements Provider {
 
   private registerEventListeners() {
     this._client?.on('ready', () => {
-      this._logger?.info('Unleash ready event received');
+      this._logger?.debug('Unleash ready event received');
       this.events.emit(ProviderEvents.Ready, {
         message: 'Ready',
       });
     });
     this._client?.on('update', () => {
-      this._logger?.info('Unleash update event received');
+      this._logger?.debug('Unleash update event received');
       this.events.emit(ProviderEvents.ConfigurationChanged, {
         message: 'Flags changed',
       });
     });
     this._client?.on('error', () => {
-      this._logger?.info('Unleash error event received');
+      this._logger?.debug('Unleash error event received');
       this.events.emit(ProviderEvents.Error, {
         message: 'Error',
       });
     });
     this._client?.on('recovered', () => {
-      this._logger?.info('Unleash recovered event received');
+      this._logger?.debug('Unleash recovered event received');
       this.events.emit(ProviderEvents.Ready, {
         message: 'Recovered',
       });
@@ -104,11 +104,11 @@ export class UnleashWebProvider implements Provider {
       unleashContext.set('properties', Object.fromEntries(properties));
     }
     await this._client?.updateContext(Object.fromEntries(unleashContext));
-    this._logger?.info('Unleash context updated');
+    this._logger?.debug('Unleash context updated');
   }
 
   async onClose() {
-    this._logger?.info('closing Unleash client');
+    this._logger?.debug('closing Unleash client');
     this._client?.stop();
   }