feat(decide): add decide API #407
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,11 +18,9 @@ | |
|
|
||
| import com.optimizely.ab.annotations.VisibleForTesting; | ||
| import com.optimizely.ab.bucketing.internal.MurmurHash3; | ||
| import com.optimizely.ab.config.*; | ||
| import com.optimizely.ab.optimizelyusercontext.DecisionReasons; | ||
| import com.optimizely.ab.optimizelyusercontext.OptimizelyDecideOption; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
|
|
@@ -71,7 +69,9 @@ private String bucketToEntity(int bucketValue, List<TrafficAllocation> trafficAl | |
|
|
||
| private Experiment bucketToExperiment(@Nonnull Group group, | ||
| @Nonnull String bucketingId, | ||
| @Nonnull ProjectConfig projectConfig, | ||
| @Nullable List<OptimizelyDecideOption> options, | ||
|
There was a problem hiding this comment. 👍 |
||
| @Nullable DecisionReasons reasons) { | ||
| // "salt" the bucket id using the group id | ||
| String bucketKey = bucketingId + group.getId(); | ||
|
|
||
|
|
@@ -91,7 +91,9 @@ private Experiment bucketToExperiment(@Nonnull Group group, | |
| } | ||
|
|
||
| private Variation bucketToVariation(@Nonnull Experiment experiment, | ||
| @Nonnull String bucketingId, | ||
| @Nullable List<OptimizelyDecideOption> options, | ||
| @Nullable DecisionReasons reasons) { | ||
| // "salt" the bucket id using the experiment id | ||
| String experimentId = experiment.getId(); | ||
| String experimentKey = experiment.getKey(); | ||
|
|
@@ -107,14 +109,14 @@ private Variation bucketToVariation(@Nonnull Experiment experiment, | |
| if (bucketedVariationId != null) { | ||
| Variation bucketedVariation = experiment.getVariationIdToVariationMap().get(bucketedVariationId); | ||
| String variationKey = bucketedVariation.getKey(); | ||
| DecisionService.logInfo(logger, reasons, "User with bucketingId \"%s\" is in variation \"%s\" of experiment \"%s\".", bucketingId, variationKey, | ||
| experimentKey); | ||
|
|
||
| return bucketedVariation; | ||
| } | ||
|
|
||
| // user was not bucketed to a variation | ||
| DecisionService.logInfo(logger, reasons, "User with bucketingId \"%s\" is not in any variation of experiment \"%s\".", bucketingId, experimentKey); | ||
| return null; | ||
| } | ||
|
|
||
|
|
@@ -123,43 +125,77 @@ private Variation bucketToVariation(@Nonnull Experiment experiment, | |
| * | ||
| * @param experiment The Experiment in which the user is to be bucketed. | ||
| * @param bucketingId string A customer-assigned value used to create the key for the murmur hash. | ||
| * @param projectConfig The current projectConfig | ||
| * @param options An array of decision options | ||
| * @param reasons Decision log messages | ||
| * @return Variation the user is bucketed into or null. | ||
| */ | ||
| @Nullable | ||
| public Variation bucket(@Nonnull Experiment experiment, | ||
| @Nonnull String bucketingId, | ||
| @Nonnull ProjectConfig projectConfig, | ||
| @Nullable List<OptimizelyDecideOption> options, | ||
| @Nullable DecisionReasons reasons) { | ||
|
|
||
| // support existing custom Bucketers | ||
| if (isMethodOverriden("bucket", Experiment.class, String.class, ProjectConfig.class)) { | ||
| return bucket(experiment, bucketingId, projectConfig); | ||
| } | ||
|
|
||
| return bucketCore(experiment, bucketingId, projectConfig, options, reasons); | ||
| } | ||
|
|
||
| /** | ||
| * Assign a {@link Variation} of an {@link Experiment} to a user based on hashed value from murmurhash3. | ||
| * | ||
| * @param experiment The Experiment in which the user is to be bucketed. | ||
| * @param bucketingId string A customer-assigned value used to create the key for the murmur hash. | ||
| * @param projectConfig The current projectConfig | ||
| * @return Variation the user is bucketed into or null. | ||
| */ | ||
| @Nullable | ||
| public Variation bucket(@Nonnull Experiment experiment, | ||
| @Nonnull String bucketingId, | ||
| @Nonnull ProjectConfig projectConfig) { | ||
| return bucketCore(experiment, bucketingId, projectConfig, null, null); | ||
| } | ||
|
|
||
| @Nullable | ||
| public Variation bucketCore(@Nonnull Experiment experiment, | ||
| @Nonnull String bucketingId, | ||
| @Nonnull ProjectConfig projectConfig, | ||
| @Nullable List<OptimizelyDecideOption> options, | ||
| @Nullable DecisionReasons reasons) { | ||
| // ---------- Bucket User ---------- | ||
| String groupId = experiment.getGroupId(); | ||
| // check whether the experiment belongs to a group | ||
| if (!groupId.isEmpty()) { | ||
| Group experimentGroup = projectConfig.getGroupIdMapping().get(groupId); | ||
| // bucket to an experiment only if group entities are to be mutually exclusive | ||
| if (experimentGroup.getPolicy().equals(Group.RANDOM_POLICY)) { | ||
| Experiment bucketedExperiment = bucketToExperiment(experimentGroup, bucketingId, projectConfig, options, reasons); | ||
| if (bucketedExperiment == null) { | ||
| DecisionService.logInfo(logger, reasons, "User with bucketingId \"%s\" is not in any experiment of group %s.", bucketingId, experimentGroup.getId()); | ||
|
There was a problem hiding this comment. The use of these static // Add and return formatted message
public String addInfof(String format, Object... args) {
String message = String.format(format, args);
addInfo(message);
return message;
}So this one liner becomes two, but its very transparent what is happening, eg: String reason = reasons.addInfof("User with bucketingId \"{}\" is not in any experiment of group {}.", bucketingId, experimentGroup.getId());
logger.info(reason);You can even log directly within |
||
| return null; | ||
| } else { | ||
|
|
||
| } | ||
| // if the experiment a user is bucketed in within a group isn't the same as the experiment provided, | ||
| // don't perform further bucketing within the experiment | ||
| if (!bucketedExperiment.getId().equals(experiment.getId())) { | ||
| DecisionService.logInfo(logger, reasons, "User with bucketingId \"%s\" is not in experiment \"%s\" of group %s.", bucketingId, experiment.getKey(), | ||
| experimentGroup.getId()); | ||
| return null; | ||
| } | ||
|
|
||
| DecisionService.logInfo(logger, reasons, "User with bucketingId \"%s\" is in experiment \"%s\" of group %s.", bucketingId, experiment.getKey(), | ||
| experimentGroup.getId()); | ||
| } | ||
| } | ||
|
|
||
| return bucketToVariation(experiment, bucketingId, options, reasons); | ||
| } | ||
|
|
||
| //======== Helper methods ========// | ||
|
|
||
| /** | ||
|
|
@@ -175,5 +211,12 @@ int generateBucketValue(int hashCode) { | |
| return (int) Math.floor(MAX_TRAFFIC_VALUE * ratio); | ||
| } | ||
|
|
||
| Boolean isMethodOverriden(String methodName, Class<?>... params) { | ||
|
There was a problem hiding this comment. I don't think we need to worry about custom overrides such as this. Let me know if there's a specific concern or a hypothetical one. |
||
| try { | ||
| return getClass() != Bucketer.class && getClass().getDeclaredMethod(methodName, params) != null; | ||
| } catch (NoSuchMethodException e) { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we move
OptimizelyUserContextinto the rootcom.optimizely.abpackage then we don't have to open this up so widely, but instead can be makepackage private