feat: adds ping stream support #624

tanderson-ld · 2024-10-11T16:12:32Z

Requirements

I have added test coverage for new or changed functionality
I have followed the repository's pull request submission guidelines
I have validated my changes against all supported platform versions
-I have tested this against browser and mobile.

Related issues

SDK-198

Describe the solution you've provided

Added ping pathing
Passing Requestor into StreamingProcessor that now uses it when a ping event is received.
Commonized requestor creation logic and using that helper function in various data managers.

…port

tanderson-ld · 2024-10-11T20:56:03Z

packages/sdk/browser/__tests__/BrowserDataManager.test.ts

For reviewers: Updating paths to avoid confusing future developers about usage of /msdk

packages/sdk/browser/src/BrowserClient.ts

tanderson-ld · 2024-10-11T20:57:29Z

packages/sdk/browser/src/BrowserDataManager.ts

-    this.updateProcessor!.start();
-  }
-
-  private _getRequestor(plainContextString: string): Requestor {


For reviewers: _getRequestor got commonized to be a helper method in the Requestor file, the generated diff is confusing.

tanderson-ld · 2024-10-11T20:59:15Z

packages/shared/sdk-client/src/datasource/Requestor.ts

@@ -47,3 +56,41 @@ export default class Requestor {
    throw new LDRequestError(`Unexpected status code: ${status}`, status);
  }
 }
+


For reviewers: This is the combination of the handful of requestor making implementations.

tanderson-ld · 2024-10-11T20:59:41Z

packages/shared/sdk-client/src/polling/PollingProcessor.ts

@@ -115,7 +80,7 @@ export default class PollingProcessor implements subsystem.LDStreamProcessor {
    }

    const elapsed = Date.now() - startTime;
-    const sleepFor = Math.max(this._pollInterval * 1000 - elapsed, 0);
+    const sleepFor = Math.max(this._pollIntervalSeconds * 1000 - elapsed, 0);


For reviewers: Just a rename for clarity.

tanderson-ld · 2024-10-11T21:06:11Z

packages/shared/sdk-client/src/DataManager.ts

@@ -133,6 +124,7 @@ export abstract class BaseDataManager implements DataManager {
        this._dataSourceEventHandler.handlePollingError(err);
        identifyReject?.(err);
      },
+      this.logger,


For reviewers: Please verify this logger was not intentionally being omitted up to this point.

packages/sdk/browser/src/BrowserDataManager.ts

packages/sdk/react-native/__tests__/MobileDataManager.test.ts

kinyoklion · 2024-10-14T16:06:54Z

packages/shared/sdk-client/src/streaming/StreamingProcessor.ts

@@ -178,6 +178,41 @@ class StreamingProcessor implements subsystem.LDStreamProcessor {
        }
      });
    });
+
+    // here we set up a listener that will poll when ping is received
+    eventSource.addEventListener('ping', async () => {


It seems a little strange that this handler is here instead of with the other listeners.

This is one of the main parts that I struggled with finding a nice spot for this handling. I initially had it in the DataManager with the others, but that created what felt like asymmetry wrt data types, json parsing/error handling, and identifyResolve/Reject. Currently the DataManager receives data as Flags, PatchFlag, or DeleteFlag. Having it know about requests and JSON errors felt like it would make it harder for the DataManager to get more flexible in the future. It felt ok for the StreamingProcessor to hold this "request turnaround" routine.

🤖 I have created a release *beep* *boop* --- <details><summary>akamai-edgeworker-sdk-common: 1.3.0</summary> ## [1.3.0](akamai-edgeworker-sdk-common-v1.2.1...akamai-edgeworker-sdk-common-v1.3.0) (2024-10-17) ### Features * Apply private property naming standard. Mangle browser private properties. ([#620](#620)) ([3e6d404](3e6d404)) ### Dependencies * The following workspace dependencies were updated * dependencies * @launchdarkly/js-server-sdk-common bumped from ^2.8.0 to ^2.9.0 </details> <details><summary>akamai-server-base-sdk: 2.1.18</summary> ## [2.1.18](akamai-server-base-sdk-v2.1.17...akamai-server-base-sdk-v2.1.18) (2024-10-17) ### Dependencies * The following workspace dependencies were updated * dependencies * @launchdarkly/akamai-edgeworker-sdk-common bumped from ^1.2.1 to ^1.3.0 * @launchdarkly/js-server-sdk-common bumped from ^2.8.0 to ^2.9.0 </details> <details><summary>akamai-server-edgekv-sdk: 1.2.0</summary> ## [1.2.0](akamai-server-edgekv-sdk-v1.1.17...akamai-server-edgekv-sdk-v1.2.0) (2024-10-17) ### Features * Apply private property naming standard. Mangle browser private properties. ([#620](#620)) ([3e6d404](3e6d404)) ### Dependencies * The following workspace dependencies were updated * dependencies * @launchdarkly/akamai-edgeworker-sdk-common bumped from ^1.2.1 to ^1.3.0 * @launchdarkly/js-server-sdk-common bumped from ^2.8.0 to ^2.9.0 </details> <details><summary>cloudflare-server-sdk: 2.6.0</summary> ## [2.6.0](cloudflare-server-sdk-v2.5.15...cloudflare-server-sdk-v2.6.0) (2024-10-17) ### Features * Apply private property naming standard. Mangle browser private properties. ([#620](#620)) ([3e6d404](3e6d404)) ### Dependencies * The following workspace dependencies were updated * devDependencies * @launchdarkly/js-server-sdk-common-edge bumped from 2.4.1 to 2.5.0 </details> <details><summary>js-client-sdk: 0.1.0</summary> ## [0.1.0](js-client-sdk-v0.0.1...js-client-sdk-v0.1.0) (2024-10-17) ### Features * Add prerequisite information to server-side allFlagsState. ([8c84e01](8c84e01)) * Add support for client-side prerequisite events. ([8c84e01](8c84e01)) * Add support for inspectors. ([#625](#625)) ([a986478](a986478)) * Add support for prerequisite details to evaluation detail. ([8c84e01](8c84e01)) * adds ping stream support ([#624](#624)) ([dee53af](dee53af)) * Apply private property naming standard. Mangle browser private properties. ([#620](#620)) ([3e6d404](3e6d404)) ### Bug Fixes * Do not mangle _meta. ([#622](#622)) ([f6fc40b](f6fc40b)) ### Dependencies * The following workspace dependencies were updated * dependencies * @launchdarkly/js-client-sdk-common bumped from 1.9.0 to 1.10.0 </details> <details><summary>js-client-sdk-common: 1.10.0</summary> ## [1.10.0](js-client-sdk-common-v1.9.0...js-client-sdk-common-v1.10.0) (2024-10-17) ### Features * Add prerequisite information to server-side allFlagsState. ([8c84e01](8c84e01)) * Add support for client-side prerequisite events. ([8c84e01](8c84e01)) * Add support for inspectors. ([#625](#625)) ([a986478](a986478)) * Add support for prerequisite details to evaluation detail. ([8c84e01](8c84e01)) * adds ping stream support ([#624](#624)) ([dee53af](dee53af)) * Apply private property naming standard. Mangle browser private properties. ([#620](#620)) ([3e6d404](3e6d404)) ### Bug Fixes * Prerequisites should not trigger hooks. ([#628](#628)) ([70cf3c3](70cf3c3)) * Update sdk-client rollup configuration to match common ([#630](#630)) ([e061811](e061811)) ### Dependencies * The following workspace dependencies were updated * dependencies * @launchdarkly/js-sdk-common bumped from 2.10.0 to 2.11.0 </details> <details><summary>js-sdk-common: 2.11.0</summary> ## [2.11.0](js-sdk-common-v2.10.0...js-sdk-common-v2.11.0) (2024-10-17) ### Features * Apply private property naming standard. Mangle browser private properties. ([#620](#620)) ([3e6d404](3e6d404)) ### Bug Fixes * Update sdk-client rollup configuration to match common ([#630](#630)) ([e061811](e061811)) </details> <details><summary>js-server-sdk-common: 2.9.0</summary> ## [2.9.0](js-server-sdk-common-v2.8.0...js-server-sdk-common-v2.9.0) (2024-10-17) ### Features * Add prerequisite information to server-side allFlagsState. ([8c84e01](8c84e01)) * Add support for client-side prerequisite events. ([8c84e01](8c84e01)) * Add support for prerequisite details to evaluation detail. ([8c84e01](8c84e01)) * Apply private property naming standard. Mangle browser private properties. ([#620](#620)) ([3e6d404](3e6d404)) ### Dependencies * The following workspace dependencies were updated * dependencies * @launchdarkly/js-sdk-common bumped from 2.10.0 to 2.11.0 </details> <details><summary>js-server-sdk-common-edge: 2.5.0</summary> ## [2.5.0](js-server-sdk-common-edge-v2.4.1...js-server-sdk-common-edge-v2.5.0) (2024-10-17) ### Features * Apply private property naming standard. Mangle browser private properties. ([#620](#620)) ([3e6d404](3e6d404)) ### Dependencies * The following workspace dependencies were updated * dependencies * @launchdarkly/js-server-sdk-common bumped from 2.8.0 to 2.9.0 </details> <details><summary>node-server-sdk: 9.7.0</summary> ## [9.7.0](node-server-sdk-v9.6.1...node-server-sdk-v9.7.0) (2024-10-17) ### Features * Apply private property naming standard. Mangle browser private properties. ([#620](#620)) ([3e6d404](3e6d404)) ### Dependencies * The following workspace dependencies were updated * dependencies * @launchdarkly/js-server-sdk-common bumped from 2.8.0 to 2.9.0 </details> <details><summary>node-server-sdk-dynamodb: 6.2.0</summary> ## [6.2.0](node-server-sdk-dynamodb-v6.1.23...node-server-sdk-dynamodb-v6.2.0) (2024-10-17) ### Features * Apply private property naming standard. Mangle browser private properties. ([#620](#620)) ([3e6d404](3e6d404)) ### Dependencies * The following workspace dependencies were updated * devDependencies * @launchdarkly/node-server-sdk bumped from 9.6.1 to 9.7.0 * peerDependencies * @launchdarkly/node-server-sdk bumped from >=9.4.3 to >=9.7.0 </details> <details><summary>node-server-sdk-otel: 1.1.0</summary> ## [1.1.0](node-server-sdk-otel-v1.0.15...node-server-sdk-otel-v1.1.0) (2024-10-17) ### Features * Apply private property naming standard. Mangle browser private properties. ([#620](#620)) ([3e6d404](3e6d404)) ### Dependencies * The following workspace dependencies were updated * devDependencies * @launchdarkly/node-server-sdk bumped from 9.6.1 to 9.7.0 * peerDependencies * @launchdarkly/node-server-sdk bumped from >=9.4.3 to >=9.7.0 </details> <details><summary>node-server-sdk-redis: 4.2.0</summary> ## [4.2.0](node-server-sdk-redis-v4.1.23...node-server-sdk-redis-v4.2.0) (2024-10-17) ### Features * Apply private property naming standard. Mangle browser private properties. ([#620](#620)) ([3e6d404](3e6d404)) ### Dependencies * The following workspace dependencies were updated * devDependencies * @launchdarkly/node-server-sdk bumped from 9.6.1 to 9.7.0 * peerDependencies * @launchdarkly/node-server-sdk bumped from >=9.4.3 to >=9.7.0 </details> <details><summary>react-native-client-sdk: 10.9.0</summary> ## [10.9.0](react-native-client-sdk-v10.8.0...react-native-client-sdk-v10.9.0) (2024-10-17) ### Features * Add support for inspectors. ([#625](#625)) ([a986478](a986478)) * adds ping stream support ([#624](#624)) ([dee53af](dee53af)) * Apply private property naming standard. Mangle browser private properties. ([#620](#620)) ([3e6d404](3e6d404)) ### Dependencies * The following workspace dependencies were updated * dependencies * @launchdarkly/js-client-sdk-common bumped from 1.9.0 to 1.10.0 </details> <details><summary>vercel-server-sdk: 1.3.19</summary> ## [1.3.19](vercel-server-sdk-v1.3.18...vercel-server-sdk-v1.3.19) (2024-10-17) ### Dependencies * The following workspace dependencies were updated * dependencies * @launchdarkly/js-server-sdk-common-edge bumped from 2.4.1 to 2.5.0 </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

tanderson-ld added 3 commits October 11, 2024 11:06

feat: adds ping stream support

824e1c7

Merge remote-tracking branch 'origin' into ta/sdk-198/ping-stream-sup…

46c972e

…port

fixing issues discovered during bench testing

d1e962a

tanderson-ld marked this pull request as ready for review October 11, 2024 20:55

tanderson-ld requested a review from a team as a code owner October 11, 2024 20:55

tanderson-ld commented Oct 11, 2024

View reviewed changes

packages/sdk/browser/src/BrowserClient.ts Show resolved Hide resolved

tanderson-ld commented Oct 11, 2024

View reviewed changes

tanderson-ld added 2 commits October 11, 2024 16:12

fixing test that broke due to fixing missing logger parameter.

d463667

added additional comment for Ping for Polling Unsupported case

a16aa37

kinyoklion reviewed Oct 14, 2024

View reviewed changes

packages/sdk/browser/src/BrowserDataManager.ts Outdated Show resolved Hide resolved

kinyoklion reviewed Oct 14, 2024

View reviewed changes

packages/sdk/react-native/__tests__/MobileDataManager.test.ts Show resolved Hide resolved

kinyoklion reviewed Oct 14, 2024

View reviewed changes

fixing comments

c22fd0e

kinyoklion approved these changes Oct 15, 2024

View reviewed changes

Merge branch 'main' into ta/sdk-198/ping-stream-support

9126060

tanderson-ld merged commit dee53af into main Oct 15, 2024
21 checks passed

tanderson-ld deleted the ta/sdk-198/ping-stream-support branch October 15, 2024 20:22

github-actions bot mentioned this pull request Oct 15, 2024

chore: release main #621

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: adds ping stream support #624

feat: adds ping stream support #624

tanderson-ld commented Oct 11, 2024 •

edited

Loading

tanderson-ld Oct 11, 2024

tanderson-ld Oct 11, 2024

tanderson-ld Oct 11, 2024

tanderson-ld Oct 11, 2024

tanderson-ld Oct 11, 2024 •

edited

Loading

kinyoklion Oct 14, 2024

tanderson-ld Oct 15, 2024 •

edited

Loading

feat: adds ping stream support #624

feat: adds ping stream support #624

Conversation

tanderson-ld commented Oct 11, 2024 • edited Loading

tanderson-ld Oct 11, 2024

Choose a reason for hiding this comment

tanderson-ld Oct 11, 2024

Choose a reason for hiding this comment

tanderson-ld Oct 11, 2024

Choose a reason for hiding this comment

tanderson-ld Oct 11, 2024

Choose a reason for hiding this comment

tanderson-ld Oct 11, 2024 • edited Loading

Choose a reason for hiding this comment

kinyoklion Oct 14, 2024

Choose a reason for hiding this comment

tanderson-ld Oct 15, 2024 • edited Loading

Choose a reason for hiding this comment

tanderson-ld commented Oct 11, 2024 •

edited

Loading

tanderson-ld Oct 11, 2024 •

edited

Loading

tanderson-ld Oct 15, 2024 •

edited

Loading