Skip to content

fix: prevent flag change listener from being invoked with null flag key #307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 21, 2025
Merged

fix: prevent flag change listener from being invoked with null flag key #307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f69ea33
fix: prevent flag change listener from being invoked with null flag key
tanderson-ld Jul 21, 2025
f686f18
Merge branch 'main' into ta/sdk-1040/flag-change-listener-tweak
tanderson-ld Jul 21, 2025
72497dc
fixing flaky test
tanderson-ld Jul 21, 2025
131483e
fixing flaky test
tanderson-ld Jul 21, 2025
62d14ef
Merge branch 'main' into ta/sdk-1040/flag-change-listener-tweak
tanderson-ld Jul 21, 2025
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
25 changes: 15 additions & 10 deletions ...oid-client-sdk/src/androidTest/java/com/launchdarkly/sdk/android/LDClientPluginsTest.java
View file
Open in desktop
Copy link
Contributor Author

@tanderson-ld tanderson-ld Jul 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For reviewers: Fixing flaky test due to hash map iteration order not being deterministic across runs.

Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package com.launchdarkly.sdk.android;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;

import android.app.Application;

Expand Down Expand Up @@ -88,7 +89,7 @@ public void pluginRegisterCalledForEachClientEnvironment() throws Exception {
.logAdapter(logging.logAdapter);
LDConfig config = builder.build();

try (LDClient ldClient = LDClient.init(application, config, ldContext, 1)) {
try (LDClient ldClient = LDClient.init(application, config, ldContext, 10)) {
ldClient.boolVariation("test-flag", false);
assertEquals(2, testPlugin.getHooksCalls.size());
assertEquals(2, testPlugin.registerCalls.size());
Expand All @@ -99,15 +100,19 @@ public void pluginRegisterCalledForEachClientEnvironment() throws Exception {
assertEquals(2, testHook.beforeEvaluationCalls.size());
assertEquals(2, testHook.afterEvaluationCalls.size());

EnvironmentMetadata environmentMetadata1 = (EnvironmentMetadata) testPlugin.getHooksCalls.get(1).get("environmentMetadata");
assertEquals(mobileKey, environmentMetadata1.getCredential());
assertEquals(environmentMetadata1, testPlugin.getHooksCalls.get(1).get("environmentMetadata"));
assertEquals("AndroidClient", environmentMetadata1.getSdkMetadata().getName());

assertEquals(LDClient.getForMobileKey("secondaryEnvironment"), testPlugin.registerCalls.get(0).get("client"));
EnvironmentMetadata environmentMetadata2 = (EnvironmentMetadata) testPlugin.registerCalls.get(0).get("environmentMetadata");
assertEquals(secondaryMobileKey, environmentMetadata2.getCredential());
assertEquals("AndroidClient", environmentMetadata2.getSdkMetadata().getName());
for (Map<String, Object> hookCall: testPlugin.registerCalls) {
LDClient instance = (LDClient) hookCall.get("client");

if (instance.equals(LDClient.get())) {
EnvironmentMetadata environmentMetadata = (EnvironmentMetadata) hookCall.get("environmentMetadata");
assertEquals(environmentMetadata.getCredential(), mobileKey);
} else if (instance.equals(LDClient.getForMobileKey("secondaryEnvironment"))) {
EnvironmentMetadata environmentMetadata = (EnvironmentMetadata) hookCall.get("environmentMetadata");
assertEquals(environmentMetadata.getCredential(), secondaryMobileKey);
} else {
fail("Client instance was unexpected.");
}
}

logging.assertNoWarningsLogged();
logging.assertNoErrorsLogged();
Expand Down
7 changes: 7 additions & 0 deletions ...kly-android-client-sdk/src/main/java/com/launchdarkly/sdk/android/ContextDataManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,13 @@ private void notifyFlagListeners(Collection<String> updatedFlagKeys) {
}
final Map<String, Set<FeatureFlagChangeListener>> listenersToCall = new HashMap<>();
for (String flagKey: updatedFlagKeys) {

// TODO: SDK-1040. This conditional is a short term mitigation for a rare issue where a
// null flag key is encountered.
if (flagKey == null) {
continue;
}

Set<FeatureFlagChangeListener> flagListeners = listeners.get(flagKey);
if (flagListeners != null && !flagListeners.isEmpty()) {
listenersToCall.put(flagKey, flagListeners);
Expand Down