Skip to content

Fix tracking callback invocation #135

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix tracking callback invocation #135

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
fbe3a31
add ExperimentHelper to Options for having ability to distinguish exp…
Apr 3, 2025
1cfcc44
Merge branch 'main' into fix-tracking-callback-invocation
Apr 4, 2025
a25b3a8
isExperimentTracked function is in utils class now, add ExperimentTra…
Apr 22, 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
23 changes: 2 additions & 21 deletions lib/src/main/java/growthbook/sdk/java/evaluators/ExperimentEvaluator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,6 @@
public class ExperimentEvaluator implements IExperimentEvaluator {

private final ConditionEvaluator conditionEvaluator = new ConditionEvaluator();
private final GrowthBookJsonUtils jsonUtils = GrowthBookJsonUtils.getInstance();
private final ExperimentTracker experimentTracker = new ExperimentTracker();


/**
* Takes Context, Experiment and returns Experiment Result
Expand Down Expand Up @@ -311,7 +308,8 @@ public <ValueType> ExperimentResult<ValueType> evaluateExperiment(Experiment<Val

// Fire context.trackingClosure if set and the combination of hashAttribute,
// hashValue, experiment.key, and variationId has not been tracked before
if (!isExperimentTracked(experiment, result)) {
ExperimentTracker experimentTracker = context.getGlobal().getExperimentTracker();
if (!GrowthBookUtils.isExperimentTracked(experimentTracker, experiment, result)) {
TrackingCallbackWithUser trackingCallBackWithUser = context.getOptions().getTrackingCallBackWithUser();

if (trackingCallBackWithUser != null) {
Expand Down Expand Up @@ -394,23 +392,6 @@ private <ValueType> ExperimentResult<ValueType> getExperimentResult(
.build();
}

// Track experiments to trigger callbacks.
private <ValueType> boolean isExperimentTracked(Experiment<ValueType> experiment, ExperimentResult<ValueType> result) {
String experimentKey = experiment.getKey();

String key = (
result.getHashAttribute() != null ? result.getHashAttribute() : "")
+ (result.getHashValue() != null ? result.getHashValue() : "")
+ (experimentKey + result.getVariationId());

// Add the experiment to the tracker if it doesn't exist.
if (!experimentTracker.isExperimentTracked(key)) {
experimentTracker.trackExperiment(key);
Copy link
Contributor

Choose a reason for hiding this comment

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

We use an Experiment Tracker to keep track of the most recent experiments set with a bounded max val of 30(which can be changed). Changing this implementation to a unbounded hashSet will grow significantly when there are multiple instances of GrowthBookClient is created.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We’ve restored your implementation of the Experiment Tracker as suggested.

}

return false;
}

private <ValueType> boolean isStickyBucketingEnabledForExperiment(EvaluationContext context,
Experiment<ValueType> experiment) {
return context.getOptions().getStickyBucketService() != null
Expand Down
18 changes: 11 additions & 7 deletions lib/src/main/java/growthbook/sdk/java/evaluators/FeatureEvaluator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
package growthbook.sdk.java.evaluators;

import com.google.gson.JsonObject;
import growthbook.sdk.java.multiusermode.ExperimentTracker;
import growthbook.sdk.java.multiusermode.configurations.UserContext;
import growthbook.sdk.java.util.GrowthBookJsonUtils;
import growthbook.sdk.java.util.GrowthBookUtils;
import growthbook.sdk.java.model.ParentCondition;
Expand Down Expand Up @@ -280,13 +282,15 @@ public <ValueType> FeatureResult<ValueType> evaluateFeature(

// If this was a remotely evaluated experiment, fire the tracking callbacks
if (trackData != null && trackingCallBackWithUser != null) {
trackData.forEach(t ->
trackingCallBackWithUser.onTrack(
t.getExperiment(),
t.getResult().getExperimentResult(),
context.getUser()
)
);
trackData.forEach(t -> {
ExperimentResult<ValueType> trackedExpResult = t.getResult().getExperimentResult();
Experiment<ValueType> trackedExperiment = t.getExperiment();
ExperimentTracker experimentTracker = context.getGlobal().getExperimentTracker();
UserContext userContext = context.getUser();

if (!GrowthBookUtils.isExperimentTracked(experimentTracker, trackedExperiment, trackedExpResult)) {
trackingCallBackWithUser.onTrack(trackedExperiment, trackedExpResult, userContext);
}});
}

if (rule.getRange() == null) {
Expand Down
4 changes: 4 additions & 0 deletions lib/src/main/java/growthbook/sdk/java/multiusermode/configurations/GlobalContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
import com.google.gson.JsonObject;
import growthbook.sdk.java.model.Experiment;
import growthbook.sdk.java.model.Feature;
import growthbook.sdk.java.multiusermode.ExperimentTracker;
import lombok.Builder;
import lombok.Data;
import lombok.Getter;
Expand Down Expand Up @@ -48,4 +49,7 @@ public class GlobalContext {
@Getter
@Nullable
private Map<String, Object> forcedFeatureValues;

@Getter
private final ExperimentTracker experimentTracker = new ExperimentTracker();
}
1 change: 0 additions & 1 deletion lib/src/main/java/growthbook/sdk/java/multiusermode/configurations/Options.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
import growthbook.sdk.java.repository.FeatureRefreshStrategy;
import growthbook.sdk.java.stickyBucketing.InMemoryStickyBucketServiceImpl;
import growthbook.sdk.java.stickyBucketing.StickyBucketService;
import growthbook.sdk.java.util.ExperimentHelper;
import lombok.Builder;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
Expand Down
11 changes: 6 additions & 5 deletions lib/src/main/java/growthbook/sdk/java/util/ExperimentHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,20 @@
import growthbook.sdk.java.model.Experiment;
import growthbook.sdk.java.model.ExperimentResult;

import javax.annotation.Nullable;
import java.util.HashSet;
import java.util.Set;

public class ExperimentHelper {
private final Set<String> trackedExperiments = new HashSet<>();

public <ValueType> boolean isTracked(Experiment<ValueType> experiment, ExperimentResult<ValueType> result) {
public <ValueType> boolean isTracked(Experiment<ValueType> experiment, @Nullable ExperimentResult<ValueType> result) {
String experimentKey = experiment.getKey();
String hashAttribute = (result != null && result.getHashAttribute() != null) ? result.getHashAttribute() : "";
String hashValue = (result != null && result.getHashValue() != null) ? result.getHashValue() : "";
String variationId = (result != null) ? String.valueOf(result.getVariationId()) : "";

String key = (
result.getHashAttribute() != null ? result.getHashAttribute() : "")
+ (result.getHashValue() != null ? result.getHashValue() : "")
+ (experimentKey + result.getVariationId());
String key = hashAttribute + hashValue + experimentKey + variationId;

if (trackedExperiments.contains(key)) {
return true;
Expand Down
27 changes: 27 additions & 0 deletions lib/src/main/java/growthbook/sdk/java/util/GrowthBookUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonPrimitive;
import growthbook.sdk.java.model.Experiment;
import growthbook.sdk.java.model.ExperimentResult;
import growthbook.sdk.java.model.GeneratedStickyBucketAssignmentDocModel;
import growthbook.sdk.java.model.BucketRange;
import growthbook.sdk.java.model.Feature;
Expand All @@ -14,6 +16,7 @@
import growthbook.sdk.java.model.Namespace;
import growthbook.sdk.java.model.StickyBucketVariation;
import growthbook.sdk.java.model.VariationMeta;
import growthbook.sdk.java.multiusermode.ExperimentTracker;
import growthbook.sdk.java.multiusermode.configurations.EvaluationContext;
import growthbook.sdk.java.model.StickyAssignmentsDocument;
import growthbook.sdk.java.multiusermode.util.TransformationUtil;
Expand Down Expand Up @@ -889,4 +892,28 @@ public static <K, V> Map<K, V> mergeMaps(List<Map<K, V>> maps) {
);

}

// Track experiments to trigger callbacks.
public static <ValueType> boolean isExperimentTracked(ExperimentTracker experimentTracker,
Experiment<ValueType> experiment,
@Nullable ExperimentResult<ValueType> result) {
if (result == null) {
return false;
}
String experimentKey = experiment.getKey();

String key = (
result.getHashAttribute() != null ? result.getHashAttribute() : "")
+ (result.getHashValue() != null ? result.getHashValue() : "")
+ (experimentKey + result.getVariationId());

boolean alreadyTracked = experimentTracker.isExperimentTracked(key);

// Add the experiment to the tracker if it doesn't exist.
if (!alreadyTracked) {
experimentTracker.trackExperiment(key);
}

return alreadyTracked;
}
}
Loading