Skip to content
Open
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 @@ -19,7 +19,7 @@ public final class PayloadTransferred {
* Constructs a new PayloadTransferred.
*
* @param state the unique string representing the payload state
* @param version the version of the payload that was transferred to the client
* @param version the payload version; deprecated and without meaning (see {@link #getVersion()})
*/
public PayloadTransferred(String state, int version) {
this.state = Objects.requireNonNull(state, "state");
Expand All @@ -36,9 +36,12 @@ public String getState() {
}

/**
* Returns the version of the payload that was transferred.
* Returns the payload's {@code version} field, or 0 if it was absent or not an integer.
* <p>
* The field is deprecated and has no meaning: SDKs must not use it, and must treat it as absent
* (FDV2PL 3.4). LaunchDarkly sends 0 only for older SDKs that require it.
*
* @return the version
* @return the version, or 0
*/
public int getVersion() {
return version;
Expand All @@ -53,7 +56,7 @@ public int getVersion() {
*/
public static PayloadTransferred parse(JsonReader reader) throws SerializationException {
String state = null;
Integer version = null;
int version = 0; // optional and deprecated: absent means 0

try {
if (reader.peek() != JsonToken.BEGIN_OBJECT) {
Expand All @@ -68,7 +71,7 @@ public static PayloadTransferred parse(JsonReader reader) throws SerializationEx
state = reader.nextString();
break;
case "version":
version = reader.nextInt();
version = readOptionalInt(reader);
break;
default:
reader.skipValue();
Expand All @@ -80,14 +83,20 @@ public static PayloadTransferred parse(JsonReader reader) throws SerializationEx
if (state == null) {
throw new SerializationException("payload-transferred missing required property 'state'");
}
if (version == null) {
throw new SerializationException("payload-transferred missing required property 'version'");
}

return new PayloadTransferred(state, version);
} catch (IOException | RuntimeException e) {
throw new SerializationException(e);
}
}
}

/** Reads a whole number that fits in an int; any other value is skipped and read as 0. */
private static int readOptionalInt(JsonReader reader) throws IOException {
if (reader.peek() != JsonToken.NUMBER) {
reader.skipValue();
return 0;
}
double d = reader.nextDouble();
return d == Math.rint(d) && d >= Integer.MIN_VALUE && d <= Integer.MAX_VALUE ? (int) d : 0;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -596,12 +596,35 @@ public void payloadTransferred_ThrowsWhenStateFieldMissing() throws Exception {
PayloadTransferred.parse(new JsonReader(new StringReader(json)));
}

@Test(expected = SerializationException.class)
public void payloadTransferred_ThrowsWhenVersionFieldMissing() throws Exception {
@Test
public void payloadTransferred_TreatsMissingVersionAsZero() throws Exception {
// version is optional and deprecated (FDV2PL 3.4)
String json = "{\n" +
" \"state\": \"(p:ABC123:42)\"\n" +
"}";
PayloadTransferred.parse(new JsonReader(new StringReader(json)));
PayloadTransferred payloadTransferred = PayloadTransferred.parse(new JsonReader(new StringReader(json)));
assertEquals("(p:ABC123:42)", payloadTransferred.getState());
assertEquals(0, payloadTransferred.getVersion());
}

@Test
public void payloadTransferred_TreatsNonIntegerVersionAsZero() throws Exception {
String[] versions = {"null", "\"42\"", "1.5", "1e20", "{}", "[1]", "true"};
for (String version : versions) {
String json = "{\"state\": \"s\", \"version\": " + version + ", \"after\": 1}";
PayloadTransferred payloadTransferred = PayloadTransferred.parse(new JsonReader(new StringReader(json)));
assertEquals(version, "s", payloadTransferred.getState());
assertEquals(version, 0, payloadTransferred.getVersion());
}
}

@Test
public void payloadTransferred_KeepsAnIntegerVersion() throws Exception {
for (String version : new String[] {"0", "42", "-1", "2147483647", "7.0"}) {
String json = "{\"version\": " + version + ", \"state\": \"s\"}";
PayloadTransferred payloadTransferred = PayloadTransferred.parse(new JsonReader(new StringReader(json)));
assertEquals(version, (int) Double.parseDouble(version), payloadTransferred.getVersion());
}
}

@Test(expected = SerializationException.class)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -695,6 +695,27 @@ public void payloadTransferred_PopulatesSelector() {
assertEquals(42, changeset.getSelector().getVersion());
}

/**
* Tests that a payload-transferred event without the deprecated version field completes the
* transfer (FDV2PL 3.4).
*/
@Test
public void payloadTransferred_WithoutVersionCompletesTheTransfer() {
FDv2ProtocolHandler handler = new FDv2ProtocolHandler();

handler.handleEvent(createServerIntentEvent(IntentCode.TRANSFER_FULL, "test-payload-id", 42, "missing"));
handler.handleEvent(createPutObjectEvent("flag", "f1", 1));
JsonElement data = gsonInstance().fromJson("{\"state\":\"(p:test-payload-id:42)\"}", JsonElement.class);
FDv2ProtocolHandler.IFDv2ProtocolAction action =
handler.handleEvent(new FDv2Event(FDv2EventTypes.PAYLOAD_TRANSFERRED, data));

assertEquals(FDv2ProtocolHandler.FDv2ProtocolActionType.CHANGESET, action.getAction());
FDv2ChangeSet changeset = ((FDv2ProtocolHandler.FDv2ActionChangeset) action).getChangeset();
assertEquals(FDv2ChangeSet.FDv2ChangeSetType.FULL, changeset.getType());
assertEquals(1, changeset.getChanges().size());
assertEquals("(p:test-payload-id:42)", changeset.getSelector().getState());
}

@Test
public void selectorlessFullTransfer_EmitsEmptySelector() {
for (boolean withObject : new boolean[] {false, true}) {
Expand Down
Loading