Skip to content

fix: ODP - getQualifiedSegments should return null when fetch fails #496

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 3 commits into from
Jan 6, 2023
Merged

fix: ODP - getQualifiedSegments should return null when fetch fails #496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c966034
return null when fetch fails
zashraf1985 Dec 21, 2022
7f87456
Added a function to create a copy of userContext, this will avoid sen…
NomanShoaib Dec 29, 2022
b1845f9
Updated headers
NomanShoaib Jan 5, 2023
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
18 changes: 13 additions & 5 deletions core-api/src/main/java/com/optimizely/ab/Optimizely.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/****************************************************************************
* Copyright 2016-2022, Optimizely, Inc. and contributors *
* Copyright 2016-2023, Optimizely, Inc. and contributors *
* *
* Licensed under the Apache License, Version 2.0 (the "License"); *
* you may not use this file except in compliance with the License. *
Expand Down Expand Up @@ -436,7 +436,7 @@ private Boolean isFeatureEnabled(@Nonnull ProjectConfig projectConfig,

Map<String, ?> copiedAttributes = copyAttributes(attributes);
FeatureDecision.DecisionSource decisionSource = FeatureDecision.DecisionSource.ROLLOUT;
FeatureDecision featureDecision = decisionService.getVariationForFeature(featureFlag, createUserContext(userId, copiedAttributes), projectConfig).getResult();
FeatureDecision featureDecision = decisionService.getVariationForFeature(featureFlag, createUserContextCopy(userId, copiedAttributes), projectConfig).getResult();
Boolean featureEnabled = false;
SourceInfo sourceInfo = new RolloutSourceInfo();
if (featureDecision.decisionSource != null) {
Expand Down Expand Up @@ -745,7 +745,7 @@ <T> T getFeatureVariableValueForType(@Nonnull String featureKey,

String variableValue = variable.getDefaultValue();
Map<String, ?> copiedAttributes = copyAttributes(attributes);
FeatureDecision featureDecision = decisionService.getVariationForFeature(featureFlag, createUserContext(userId, copiedAttributes), projectConfig).getResult();
FeatureDecision featureDecision = decisionService.getVariationForFeature(featureFlag, createUserContextCopy(userId, copiedAttributes), projectConfig).getResult();
Boolean featureEnabled = false;
if (featureDecision.variation != null) {
if (featureDecision.variation.getFeatureEnabled()) {
Expand Down Expand Up @@ -880,7 +880,7 @@ public OptimizelyJSON getAllFeatureVariables(@Nonnull String featureKey,
}

Map<String, ?> copiedAttributes = copyAttributes(attributes);
FeatureDecision featureDecision = decisionService.getVariationForFeature(featureFlag, createUserContext(userId, copiedAttributes), projectConfig, Collections.emptyList()).getResult();
FeatureDecision featureDecision = decisionService.getVariationForFeature(featureFlag, createUserContextCopy(userId, copiedAttributes), projectConfig, Collections.emptyList()).getResult();
Boolean featureEnabled = false;
Variation variation = featureDecision.variation;

Expand Down Expand Up @@ -982,7 +982,7 @@ private Variation getVariation(@Nonnull ProjectConfig projectConfig,
@Nonnull String userId,
@Nonnull Map<String, ?> attributes) throws UnknownExperimentException {
Map<String, ?> copiedAttributes = copyAttributes(attributes);
Variation variation = decisionService.getVariation(experiment, createUserContext(userId, copiedAttributes), projectConfig).getResult();
Variation variation = decisionService.getVariation(experiment, createUserContextCopy(userId, copiedAttributes), projectConfig).getResult();
String notificationType = NotificationCenter.DecisionNotificationType.AB_TEST.toString();

if (projectConfig.getExperimentFeatureKeyMapping().get(experiment.getId()) != null) {
Expand Down Expand Up @@ -1172,6 +1172,14 @@ public OptimizelyUserContext createUserContext(@Nonnull String userId) {
return new OptimizelyUserContext(this, userId);
}

private OptimizelyUserContext createUserContextCopy(@Nonnull String userId, @Nonnull Map<String, ?> attributes) {
if (userId == null) {
logger.warn("The userId parameter must be nonnull.");
return null;
}
return new OptimizelyUserContext(this, userId, attributes, Collections.EMPTY_MAP, null, false);
}

OptimizelyDecision decide(@Nonnull OptimizelyUserContext user,
@Nonnull String key,
@Nonnull List<OptimizelyDecideOption> options) {
Expand Down
28 changes: 18 additions & 10 deletions core-api/src/main/java/com/optimizely/ab/OptimizelyUserContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
*
* Copyright 2020-2022, Optimizely and contributors
* Copyright 2020-2023, Optimizely and contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -76,7 +76,9 @@ public OptimizelyUserContext(@Nonnull Optimizely optimizely,
this.forcedDecisionsMap = new ConcurrentHashMap<>(forcedDecisionsMap);
}

this.qualifiedSegments = Collections.synchronizedList( qualifiedSegments == null ? new LinkedList<>(): qualifiedSegments);
if (qualifiedSegments != null) {
this.qualifiedSegments = Collections.synchronizedList(new LinkedList<>(qualifiedSegments));
}

if (shouldIdentifyUser == null || shouldIdentifyUser) {
optimizely.identifyUser(userId);
Expand Down Expand Up @@ -109,6 +111,10 @@ public OptimizelyUserContext copy() {
* @return boolean Is user qualified for a segment.
*/
public boolean isQualifiedFor(@Nonnull String segment) {
if (qualifiedSegments == null) {
return false;
}

return qualifiedSegments.contains(segment);
}

Expand Down Expand Up @@ -293,8 +299,14 @@ public List<String> getQualifiedSegments() {
}

public void setQualifiedSegments(List<String> qualifiedSegments) {
this.qualifiedSegments.clear();
this.qualifiedSegments.addAll(qualifiedSegments);
if (qualifiedSegments == null) {
this.qualifiedSegments = null;
} else if (this.qualifiedSegments == null) {
this.qualifiedSegments = Collections.synchronizedList(new LinkedList<>(qualifiedSegments));
} else {
this.qualifiedSegments.clear();
this.qualifiedSegments.addAll(qualifiedSegments);
}
}

/**
Expand All @@ -315,9 +327,7 @@ public Boolean fetchQualifiedSegments() {
*/
public Boolean fetchQualifiedSegments(@Nonnull List<ODPSegmentOption> segmentOptions) {
List<String> segments = optimizely.fetchQualifiedSegments(userId, segmentOptions);
if (segments != null) {
setQualifiedSegments(segments);
}
setQualifiedSegments(segments);
return segments != null;
}

Expand All @@ -332,9 +342,7 @@ public Boolean fetchQualifiedSegments(@Nonnull List<ODPSegmentOption> segmentOpt
*/
public void fetchQualifiedSegments(ODPSegmentCallback callback, List<ODPSegmentOption> segmentOptions) {
optimizely.fetchQualifiedSegments(userId, segments -> {
if (segments != null) {
setQualifiedSegments(segments);
}
setQualifiedSegments(segments);
callback.onCompleted(segments != null);
}, segmentOptions);
}
Expand Down
4 changes: 2 additions & 2 deletions core-api/src/test/java/com/optimizely/ab/OptimizelyUserContextTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
*
* Copyright 2021-2022, Optimizely and contributors
* Copyright 2021-2023, Optimizely and contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -1709,7 +1709,7 @@ public void fetchQualifiedSegmentsAsyncError() throws InterruptedException {
});

countDownLatch.await();
assertEquals(Collections.emptyList(), userContext.getQualifiedSegments());
assertEquals(null, userContext.getQualifiedSegments());
logbackVerifier.expectMessage(Level.ERROR, "Audience segments fetch failed (ODP is not enabled).");
}

Expand Down