feat: adds polling synchronizer support #816

tanderson-ld · 2025-04-02T21:28:13Z

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
This will be done at a later time on the target branch during integration testing.

Related issues

SDK-858 and SDK-851

Describe the solution you've provided

Refactors payload processing to be reusable between polling data sources and streaming data sources.
Adds OneShotInitializers and PollingSynchronizer.
Adds support to contract tests for sdk-test-harness/feat/fdv2 branch.

…dge cases. Added tests.

…hronizer

tanderson-ld · 2025-04-08T17:14:32Z

contract-tests/sdkClientEntity.js

    if (options.wrapper.version) {
      cf.wrapperVersion = options.wrapper.version;
    }
  }


For reviewers: Hooks up configuration for contract tests.

tanderson-ld · 2025-04-08T17:16:12Z

contract-tests/testharness-suppressions.txt

+streaming/fdv2/reconnection state management/replaces previously known state
+streaming/fdv2/reconnection state management/updates previously known state
+streaming/fdv2/ignores model version
+streaming/fdv2/can discard partial events on errors


These suppressions are the fdv2 cases that aren't passing at moment. The state and model ones will be addressed in a future story.

The streaming/fdv2/reconnection state management/initializes from polling initializer one is trickier. The JS configuration does not support the same level of initializer customization that the test harness and Go SDK support, so those cases are not supported.

tanderson-ld · 2025-04-08T17:17:46Z

packages/shared/common/src/internal/fdv2/payloadProcessor.ts

For reviewers: This file change generalizes handling to be agnostic of streaming so that polling and streaming can share the same core logic. It is a rename and then some tweaks.

tanderson-ld · 2025-04-08T17:18:28Z

packages/shared/common/src/internal/fdv2/payloadProcessor.ts

  id: string;
  version: number;
-  state: string;
+  state?: string;


For reviewers: This state is now optional as part of a fix to support the "transfer none" case where the server does not give us a state value.

tanderson-ld · 2025-04-08T17:18:54Z

packages/shared/common/src/internal/fdv2/payloadProcessor.ts

-    this._attachHandler(eventStream, 'delete-object', this._processDeleteObject);
-    this._attachHandler(eventStream, 'payload-transferred', this._processPayloadTransferred);
-    this._attachHandler(eventStream, 'goodbye', this._processGoodbye);
-    this._attachHandler(eventStream, 'error', this._processError);


For reviewers: This logic moved to the streaming specific PayloadStreamReader.

tanderson-ld · 2025-04-08T17:19:08Z

packages/shared/common/src/internal/fdv2/payloadProcessor.ts

-            `Stream received data that was unable to be processed in "${eventName}" message`,
-          );
-          this._logger?.debug(`Data follows: ${event.data}`);
-          this._errorHandler?.(DataSourceErrorKind.InvalidData, 'Malformed data in event stream');


For reviewers: This logic moved to the streaming specific PayloadStreamReader.

tanderson-ld · 2025-04-08T17:19:57Z

packages/shared/common/src/internal/fdv2/payloadProcessor.ts

+
+    this._listeners.forEach((it) => it(payload));
+    this._resetAfterEmission();
+  };


For reviewers: Transfer none wasn't emitting an empty payload, now that is fixed. The empty payload signals to other layers of the SDK that communication has occurred.

tanderson-ld · 2025-04-08T17:20:23Z

packages/shared/common/src/internal/fdv2/payloadProcessor.ts

+  private _resetAll() {
    this._tempId = undefined;
-    this._tempBasis = undefined;
+    this._tempBasis = false;


For reviewers: Various tweaks to support transfer none case and error cases.

tanderson-ld · 2025-04-08T17:21:07Z

packages/shared/common/src/internal/fdv2/payloadStreamReader.ts

For reviewers: This logic existed already, but teased apart the streaming specific concerns from the payload processing concerns.

tanderson-ld · 2025-04-08T17:24:28Z

packages/shared/sdk-server/src/data_sources/StreamingProcessorFDv2.ts

For reviewers: Tweaks to hook into the composite data source since the CompositeDataSource is now being used with Streaming and Polling.

tanderson-ld · 2025-04-08T17:25:41Z

packages/shared/sdk-server/src/diagnostics/createDiagnosticsInitConfig.ts

For reviewers: Noticed some seconds to millis conversions were missing here.

packages/shared/common/src/internal/fdv2/payloadProcessor.ts

packages/shared/sdk-server/src/LDClientImpl.ts

packages/shared/sdk-server/src/data_sources/OneShotInitializer.ts

packages/shared/sdk-server/src/data_sources/PollingProcessorFDv2.ts

packages/shared/common/src/internal/fdv2/payloadStreamReader.ts

tanderson-ld and others added 15 commits February 7, 2025 15:56

feat: adds CompositeDataSource for FDv2

285fc9f

implementing status based scheduled transitions and backoff support

3e9953b

Refactoring backoff and transitioning handling logic to handle more e…

80582bc

…dge cases. Added tests.

removing accidental source include

eeaa3d1

Fixing review comments.

6d0a08b

Addressing review comments

ea9845d

Fixing cancellation token issue

33c873e

Additional changes after working on contract test integration

fa634f5

chore: Adds LDDataSystemOptions for configuring the Data System.

a3d2489

tests and some restructuring/fixes

d241af3

fixing unit test name

bb47dde

Additional changes after contract tests integration

5e6600e

feat: hooks up FDv2 configuration and contract tests to client impl

6904c99

feat: adds polling synchronizer support

a0f5398

wip

9b9abf3

tanderson-ld changed the base branch from ta/sdk-858/hooking-up-config-rebase to ta/fdv2-temporary-holding April 7, 2025 21:30

Todd Anderson added 2 commits April 7, 2025 16:36

Merge branch 'ta/fdv2-temporary-holding' into ta/sdk-851/polling-sync…

2e3a4fd

…hronizer

Self review comments and fixing intent none handling

2a0fdd2

tanderson-ld marked this pull request as ready for review April 8, 2025 17:13

tanderson-ld requested a review from a team as a code owner April 8, 2025 17:13

tanderson-ld commented Apr 8, 2025

View reviewed changes

tanderson-ld requested a review from keelerm84 April 8, 2025 17:27

Removing deprecations that didn't merge corrrectly

893f09f

keelerm84 reviewed Apr 9, 2025

View reviewed changes

kinyoklion reviewed Apr 9, 2025

View reviewed changes

packages/shared/common/src/internal/fdv2/payloadStreamReader.ts Outdated Show resolved Hide resolved

kinyoklion reviewed Apr 9, 2025

View reviewed changes

packages/shared/common/src/internal/fdv2/payloadStreamReader.ts Show resolved Hide resolved

addressing review comments

eebf115

tanderson-ld requested a review from keelerm84 April 10, 2025 20:40

kinyoklion approved these changes Apr 10, 2025

View reviewed changes

Todd Anderson added 2 commits April 10, 2025 17:00

Adding unit tests

87bcec4

Adding one shot initializer tests

80f8d67

tanderson-ld merged commit c1089a5 into ta/fdv2-temporary-holding Apr 11, 2025
3 checks passed

tanderson-ld deleted the ta/sdk-851/polling-synchronizer branch April 11, 2025 17:26

feat: adds polling synchronizer support #816

feat: adds polling synchronizer support #816

Uh oh!

Conversation

tanderson-ld commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tanderson-ld Apr 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tanderson-ld commented Apr 2, 2025 •

edited

Loading

tanderson-ld Apr 8, 2025 •

edited

Loading