feat: Adds support for REPORT. (#575)

**Requirements**

- [x] I have added test coverage for new or changed functionality
- [x] I have followed the repository's [pull request submission
guidelines](../blob/main/CONTRIBUTING.md#submitting-pull-requests)
- [x] I have validated my changes against all supported platform
versions

**Related issues**

251674

**Describe the solution you've provided**

- Added useReport to LDOptions.
- Piped through client to `StreamingProcessor` constructor.
- Cloned `StreamingProcessor` and associated tests from common-internal
to sdk-client. Refactored it to support taking in a
`StreamingDataSourceConfig` to narrow provided dependencies instead of
ClientContext which contained many concerns. `StreamingProcessor` now
uses a paths provider to form URI and internally decides where to put
the serialized context (url vs body).
- Refactored LDClientImpl tests to not use MockStreamingProcessor to
reduce global mock usage.
- fix: polling did not include the context in the body.

**Describe alternatives you've considered**

Initially tried making changes in common-internal, but the existence of
the client context in the URL or body for client situations made that
not ideal.

---------

Co-authored-by: Ryan Lamb <[email protected]>

Author: tanderson-ld

packages/sdk/browser/src/BrowserClient.ts

@@ -2,6 +2,8 @@ import {
   AutoEnvAttributes,
   base64UrlEncode,
   LDClient as CommonClient,
+  DataSourcePaths,
+  Encoding,
   LDClientImpl,
   LDContext,
   LDOptions,
@@ -33,11 +35,27 @@ export class BrowserClient extends LDClientImpl {
     return base64UrlEncode(JSON.stringify(context), this.platform.encoding!);
   }
 
-  override createStreamUriPath(context: LDContext) {
-    return `/eval/${this.clientSideId}/${this.encodeContext(context)}`;
+  override getStreamingPaths(): DataSourcePaths {
+    const parentThis = this;
+    return {
+      pathGet(encoding: Encoding, _plainContextString: string): string {
+        return `/eval/${parentThis.clientSideId}/${base64UrlEncode(_plainContextString, encoding)}`;
+      },
+      pathReport(_encoding: Encoding, _plainContextString: string): string {
+        return `/eval/${parentThis.clientSideId}`;
+      },
+    };
   }
 
-  override createPollUriPath(context: LDContext): string {
-    return `/sdk/evalx/${this.clientSideId}/contexts/${this.encodeContext(context)}`;
+  override getPollingPaths(): DataSourcePaths {
+    const parentThis = this;
+    return {
+      pathGet(encoding: Encoding, _plainContextString: string): string {
+        return `/sdk/evalx/${parentThis.clientSideId}/contexts/${base64UrlEncode(_plainContextString, encoding)}`;
+      },
+      pathReport(_encoding: Encoding, _plainContextString: string): string {
+        return `/sdk/evalx/${parentThis.clientSideId}/context`;
+      },
+    };
   }
 }

packages/sdk/react-native/package.json

@@ -34,9 +34,7 @@
     "prettier": "prettier --write '**/*.@(js|ts|tsx|json|css)' --ignore-path ../../../.prettierignore",
     "test": "jest",
     "coverage": "yarn test --coverage",
-    "check": "yarn prettier && yarn lint && yarn build && yarn test",
-    "android": "yarn && yarn ./example && yarn build && (cd example/ && yarn android-release)",
-    "ios": "yarn && yarn ./example && yarn build && (cd example/ && yarn ios-go)"
+    "check": "yarn prettier && yarn lint && yarn build && yarn test"
   },
   "peerDependencies": {
     "react": "*",

packages/sdk/react-native/src/ReactNativeLDClient.ts

@@ -4,6 +4,8 @@ import {
   base64UrlEncode,
   BasicLogger,
   ConnectionMode,
+  DataSourcePaths,
+  Encoding,
   internal,
   LDClientImpl,
   type LDContext,
@@ -103,12 +105,26 @@ export default class ReactNativeLDClient extends LDClientImpl {
     return base64UrlEncode(JSON.stringify(context), this.platform.encoding!);
   }
 
-  override createStreamUriPath(context: LDContext) {
-    return `/meval/${this.encodeContext(context)}`;
+  override getStreamingPaths(): DataSourcePaths {
+    return {
+      pathGet(encoding: Encoding, _plainContextString: string): string {
+        return `/meval/${base64UrlEncode(_plainContextString, encoding)}`;
+      },
+      pathReport(_encoding: Encoding, _plainContextString: string): string {
+        return `/meval`;
+      },
+    };
   }
 
-  override createPollUriPath(context: LDContext): string {
-    return `/msdk/evalx/contexts/${this.encodeContext(context)}`;
+  override getPollingPaths(): DataSourcePaths {
+    return {
+      pathGet(encoding: Encoding, _plainContextString: string): string {
+        return `/msdk/evalx/contexts/${base64UrlEncode(_plainContextString, encoding)}`;
+      },
+      pathReport(_encoding: Encoding, _plainContextString: string): string {
+        return `/msdk/evalx/context`;
+      },
+    };
   }
 
   override async setConnectionMode(mode: ConnectionMode): Promise<void> {

packages/sdk/react-native/src/platform/PlatformRequests.ts

@@ -16,7 +16,9 @@ export default class PlatformRequests implements Requests {
 
   createEventSource(url: string, eventSourceInitDict: EventSourceInitDict): EventSource {
     return new RNEventSource<EventName>(url, {
+      method: eventSourceInitDict.method ?? 'GET',
       headers: eventSourceInitDict.headers,
+      body: eventSourceInitDict.body,
       retryAndHandleError: eventSourceInitDict.errorFilter,
       logger: this.logger,
     });

packages/shared/common/src/api/platform/EventSource.ts

@@ -18,8 +18,10 @@ export interface EventSource {
 }
 
 export interface EventSourceInitDict {
-  errorFilter: (err: HttpErrorResponse) => boolean;
+  method?: string;
   headers: { [key: string]: string | string[] };
+  body?: string;
+  errorFilter: (err: HttpErrorResponse) => boolean;
   initialRetryDelayMillis: number;
   readTimeoutMillis: number;
   retryResetIntervalMillis: number;

packages/shared/common/src/internal/stream/StreamingProcessor.ts

@@ -25,6 +25,7 @@ const reportJsonError = (
   errorHandler?.(new LDStreamingError('Malformed JSON data in event stream'));
 };
 
+// TODO: SDK-156 - Move to Server SDK specific location
 class StreamingProcessor implements LDStreamProcessor {
   private readonly headers: { [key: string]: string | string[] };
   private readonly streamUri: string;

packages/shared/sdk-client/__tests__/LDClientImpl.events.test.ts

@@ -2,6 +2,7 @@ import {
   AutoEnvAttributes,
   ClientContext,
   clone,
+  Encoding,
   internal,
   LDContext,
   subsystem,
@@ -10,12 +11,12 @@ import {
   createBasicPlatform,
   createLogger,
   MockEventProcessor,
-  setupMockStreamingProcessor,
 } from '@launchdarkly/private-js-mocks';
 
 import LDClientImpl from '../src/LDClientImpl';
 import { Flags } from '../src/types';
 import * as mockResponseJson from './evaluation/mockResponse.json';
+import { MockEventSource } from './streaming/LDClientImpl.mocks';
 
 type InputCustomEvent = internal.InputCustomEvent;
 type InputIdentifyEvent = internal.InputIdentifyEvent;
@@ -36,7 +37,6 @@ jest.mock('@launchdarkly/js-sdk-common', () => {
     ...{
       internal: {
         ...actual.internal,
-        StreamingProcessor: m.MockStreamingProcessor,
         EventProcessor: m.MockEventProcessor,
       },
     },
@@ -45,6 +45,7 @@ jest.mock('@launchdarkly/js-sdk-common', () => {
 
 const testSdkKey = 'test-sdk-key';
 let ldc: LDClientImpl;
+let mockEventSource: MockEventSource;
 let defaultPutResponse: Flags;
 const carContext: LDContext = { kind: 'car', key: 'test-car' };
 
@@ -66,15 +67,31 @@ describe('sdk-client object', () => {
         sendEvent: mockedSendEvent,
       }),
     );
-    setupMockStreamingProcessor(false, defaultPutResponse);
+
+    const simulatedEvents = [{ data: JSON.stringify(defaultPutResponse) }];
+    mockPlatform.storage.get.mockImplementation(() => undefined);
+    mockPlatform.requests.createEventSource.mockImplementation(
+      (streamUri: string = '', options: any = {}) => {
+        mockEventSource = new MockEventSource(streamUri, options);
+        mockEventSource.simulateEvents('put', simulatedEvents);
+        return mockEventSource;
+      },
+    );
+
     mockPlatform.crypto.randomUUID.mockReturnValue('random1');
 
     ldc = new LDClientImpl(testSdkKey, AutoEnvAttributes.Enabled, mockPlatform, {
       logger,
     });
-    jest
-      .spyOn(LDClientImpl.prototype as any, 'createStreamUriPath')
-      .mockReturnValue('/stream/path');
+
+    jest.spyOn(LDClientImpl.prototype as any, 'getStreamingPaths').mockReturnValue({
+      pathGet(_encoding: Encoding, _plainContextString: string): string {
+        return '/stream/path';
+      },
+      pathReport(_encoding: Encoding, _plainContextString: string): string {
+        return '/stream/path';
+      },
+    });
   });
 
   afterEach(() => {