Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -246,15 +246,19 @@ final class FDv2ProtocolHandler {
);
}

if (data.state.isEmpty || data.version == null) {
final state = data.state;
final version = data.version;
if (state == null || version == null) {
_logger.warn('Ignoring payload-transferred with missing fields: '
'state=${data.state}, version=${data.version}');
reset();
return _actionNone;
}

final result = ActionPayload(Payload(
selector: Selector(state: data.state, version: data.version!),
selector: state.isEmpty
? Selector.empty
: Selector(state: state, version: version),
type: _tempType,
updates: _tempUpdates,
));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,8 @@ final class DeleteObjectEvent {

/// A payload-transferred event marking the end of a transfer batch.
final class PayloadTransferredEvent {
final String state;
/// Null if the field was missing from the JSON. An empty string is valid.
final String? state;

/// Null if the field was missing from the JSON.
final int? version;
Expand All @@ -138,7 +139,7 @@ final class PayloadTransferredEvent {

factory PayloadTransferredEvent.fromJson(Map<String, dynamic> json) {
return PayloadTransferredEvent(
state: json['state'] as String? ?? '',
state: json['state'] as String?,
version: (json['version'] as num?)?.toInt(),
);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@ import 'package:launchdarkly_common_client/src/data_sources/data_source.dart';
import 'package:launchdarkly_common_client/src/data_sources/data_source_status.dart';
import 'package:launchdarkly_common_client/src/data_sources/data_source_status_manager.dart';
import 'package:launchdarkly_common_client/src/data_sources/fdv2/entry_factories.dart';
import 'package:launchdarkly_common_client/src/data_sources/fdv2/flag_eval_mapper.dart';
import 'package:launchdarkly_common_client/src/data_sources/fdv2/orchestrator.dart';
import 'package:launchdarkly_common_client/src/data_sources/fdv2/payload.dart';
import 'package:launchdarkly_common_client/src/data_sources/fdv2/protocol_handler.dart';
import 'package:launchdarkly_common_client/src/data_sources/fdv2/protocol_types.dart';
import 'package:launchdarkly_common_client/src/data_sources/fdv2/selector.dart';
import 'package:launchdarkly_common_client/src/data_sources/fdv2/source.dart';
import 'package:launchdarkly_common_client/src/data_sources/fdv2/source_manager.dart';
Expand Down Expand Up @@ -123,7 +126,93 @@ final class Harness {
}
}

ChangeSetResult wireFullPayload(String key, {String state = ''}) {
final handler = FDv2ProtocolHandler(
objProcessors: {'flag-eval': processFlagEval},
logger: LDLogger(level: LDLogLevel.none),
);
final version = state.isEmpty ? 0 : 1;
handler.processEvent(FDv2Event(event: FDv2EventTypes.serverIntent, data: {
'payloads': [
{
'id': state,
'target': version,
'intentCode': 'xfer-full',
'reason': 'test'
}
]
}));
handler.processEvent(FDv2Event(event: FDv2EventTypes.putObject, data: {
'kind': 'flag-eval',
'key': key,
'version': 1,
'object': {'value': true, 'variation': 0, 'flagVersion': 1},
}));
final action = handler.processEvent(FDv2Event(
event: FDv2EventTypes.payloadTransferred,
data: {'state': state, 'version': version}));
return ChangeSetResult(
changeSet: translatePayload((action as ActionPayload).payload),
persist: true);
}

void main() {
test('wire selectorless initializers continue and initialize at exhaustion',
() async {
final synchronizers = <FakeSynchronizer>[];
final secondCreated = <FakeInitializer>[];
final harness = Harness(initializerFactories: [
initializerFactory(wireFullPayload('first')),
initializerFactory(wireFullPayload('second'), created: secondCreated),
], synchronizerSlots: [
synchronizerSlot(synchronizers)
]);

harness.orchestrator.start();
await harness.pump();

expect(secondCreated.single.runCount, 1);
final payloads = harness.events.whereType<PayloadEvent>().toList();
expect(payloads, hasLength(2));
expect(payloads[0].changeSet.updates, contains('first'));
expect(payloads[1].changeSet.updates, contains('second'));
expect(harness.events[2], isA<InitializedEvent>());
expect(harness.events.whereType<InitializedEvent>(), hasLength(1));
expect(harness.selector.isEmpty, isTrue);

harness.orchestrator.stop();
});

test(
'wire selectorless synchronizer full initializes and clears held selector',
() async {
final synchronizers = <FakeSynchronizer>[];
final harness = Harness(
initializerFactories: [],
synchronizerSlots: [synchronizerSlot(synchronizers)]);
harness.orchestrator.start();
await harness.pump();
expect(harness.events.whereType<InitializedEvent>(), isEmpty);

synchronizers.single.controller.add(wireFullPayload('first'));
await harness.pump();
expect(harness.events.whereType<InitializedEvent>(), hasLength(1));
expect(harness.selector.isEmpty, isTrue);

synchronizers.single.controller
.add(wireFullPayload('basis', state: 'initial'));
await harness.pump();
expect(harness.selector.state, 'initial');
synchronizers.single.controller.add(wireFullPayload('replacement'));
await harness.pump();
expect(harness.selector.isEmpty, isTrue);
expect(harness.events.whereType<PayloadEvent>().last.changeSet.updates,
contains('replacement'));
expect(harness.events.whereType<InitializedEvent>(), hasLength(1));

harness.orchestrator.stop();
});

test('runs initializers in order until one returns data with a selector',
() async {
final firstCreated = <FakeInitializer>[];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -377,17 +377,52 @@ void main() {
equals(ProtocolErrorKind.protocolError));
});

test('ignored with empty state', () {
test('emits selectorless full payload with empty id and zero target', () {
final handler = makeHandler();
handler.processEvent(serverIntent('xfer-full', id: '', target: 0));
handler.processEvent(putObject('flag-1'));
final action =
handler.processEvent(payloadTransferred(state: '', version: 0));
expect(action, isA<ActionPayload>());
final payload = (action as ActionPayload).payload;
expect(payload.type, PayloadType.full);
expect(payload.selector.isEmpty, isTrue);
expect(payload.selector.state, isNull);
expect(payload.updates.single.key, 'flag-1');
expect(handler.state, ProtocolState.changes);
});

test('emits an empty selectorless full payload', () {
final handler = makeHandler();
handler.processEvent(serverIntent('xfer-full', id: '', target: 0));
final action =
handler.processEvent(payloadTransferred(state: '', version: 0));
expect(action, isA<ActionPayload>());
final payload = (action as ActionPayload).payload;
expect(payload.type, PayloadType.full);
expect(payload.selector.isEmpty, isTrue);
expect(payload.updates, isEmpty);
});

test('ignored with missing state', () {
final handler = makeHandler();
handler.processEvent(serverIntent('xfer-full'));
final action = handler.processEvent(FDv2Event(
event: FDv2EventTypes.payloadTransferred,
data: {'state': '', 'version': 1}));
event: FDv2EventTypes.payloadTransferred, data: {'version': 0}));
expect(action, isA<ActionNone>());
// Should have reset to inactive
expect(handler.state, equals(ProtocolState.inactive));
});

test('ignored with null state', () {
final handler = makeHandler();
handler.processEvent(serverIntent('xfer-full'));
final action = handler.processEvent(FDv2Event(
event: FDv2EventTypes.payloadTransferred,
data: {'state': null, 'version': 0}));
expect(action, isA<ActionNone>());
expect(handler.state, ProtocolState.inactive);
});

test('ignored with missing version', () {
final handler = makeHandler();
handler.processEvent(serverIntent('xfer-full'));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,15 @@ void main() {
});

group('PayloadTransferredEvent', () {
test('fromJson distinguishes empty state from missing state', () {
final empty =
PayloadTransferredEvent.fromJson({'state': '', 'version': 0});
final missing = PayloadTransferredEvent.fromJson({'version': 0});
expect(empty.state, '');
expect(empty.version, 0);
expect(missing.state, isNull);
});

test('fromJson preserves null for missing version', () {
final event = PayloadTransferredEvent.fromJson({
'state': 'sel-1',
Expand Down
Loading