Refact: Added builder pattern in decision listener #275
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 |
|---|---|---|
| @@ -0,0 +1,158 @@ | ||
| /**************************************************************************** | ||
| * Copyright 2019, 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. * | ||
| * You may obtain a copy of the License at * | ||
| * * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 * | ||
| * * | ||
| * Unless required by applicable law or agreed to in writing, software * | ||
| * distributed under the License is distributed on an "AS IS" BASIS, * | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * | ||
| * See the License for the specific language governing permissions and * | ||
| * limitations under the License. * | ||
| ***************************************************************************/ | ||
|
|
||
| package com.optimizely.ab.notification; | ||
|
|
||
|
|
||
| import com.optimizely.ab.bucketing.FeatureDecision; | ||
| import com.optimizely.ab.config.FeatureVariable; | ||
|
|
||
| import javax.annotation.Nonnull; | ||
| import javax.annotation.Nullable; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| public class DecisionNotification { | ||
| protected String type; | ||
| protected String userId; | ||
| protected Map<String, ?> attributes; | ||
| protected Map<String, ?> decisionInfo; | ||
|
|
||
| protected DecisionNotification() { | ||
| } | ||
|
|
||
| protected DecisionNotification(@Nonnull String type, | ||
| @Nonnull String userId, | ||
| @Nullable Map<String, ?> attributes, | ||
| @Nonnull Map<String, ?> decisionInfo) { | ||
| this.type = type; | ||
| this.userId = userId; | ||
| if (attributes == null) { | ||
| attributes = new HashMap<>(); | ||
| } | ||
| this.attributes = attributes; | ||
| this.decisionInfo = decisionInfo; | ||
| } | ||
|
|
||
| public String getType() { | ||
| return type; | ||
| } | ||
|
|
||
| public String getUserId() { | ||
| return userId; | ||
| } | ||
|
|
||
| public Map<String, ?> getAttributes() { | ||
| return attributes; | ||
| } | ||
|
|
||
| public Map<String, ?> getDecisionInfo() { | ||
| return decisionInfo; | ||
| } | ||
|
|
||
| public static FeatureVariableDecisionNotificationBuilder newFeatureVariableBuilder() { | ||
| return new FeatureVariableDecisionNotificationBuilder(); | ||
| } | ||
|
|
||
| public static class FeatureVariableDecisionNotificationBuilder { | ||
|
|
||
| public static final String FEATURE_KEY = "feature_key"; | ||
| public static final String FEATURE_ENABLED = "feature_enabled"; | ||
| public static final String SOURCE = "source"; | ||
| public static final String SOURCE_EXPERIMENT_KEY = "source_experiment_key"; | ||
| public static final String SOURCE_VARIATION_KEY = "source_variation_key"; | ||
| public static final String VARIABLE_KEY = "variable_key"; | ||
| public static final String VARIABLE_TYPE = "variable_type"; | ||
| public static final String VARIABLE_VALUE = "variable_value"; | ||
|
|
||
| private String featureKey; | ||
| private Boolean featureEnabled; | ||
| private FeatureDecision featureDecision; | ||
| private String variableKey; | ||
| private FeatureVariable.VariableType variableType; | ||
| private Object variableValue; | ||
| private String userId; | ||
| private Map<String, ?> attributes; | ||
| private Map<String, Object> decisionInfo; | ||
|
|
||
| protected FeatureVariableDecisionNotificationBuilder() { | ||
| } | ||
|
|
||
| public FeatureVariableDecisionNotificationBuilder withUserId(String userId) { | ||
| this.userId = userId; | ||
| return this; | ||
| } | ||
|
|
||
| public FeatureVariableDecisionNotificationBuilder withAttributes(Map<String, ?> attributes) { | ||
| this.attributes = attributes; | ||
| return this; | ||
| } | ||
|
|
||
| public FeatureVariableDecisionNotificationBuilder withFeatureKey(String featureKey) { | ||
| this.featureKey = featureKey; | ||
| return this; | ||
| } | ||
|
|
||
| public FeatureVariableDecisionNotificationBuilder withFeatureEnabled(boolean featureEnabled) { | ||
| this.featureEnabled = featureEnabled; | ||
| return this; | ||
| } | ||
|
|
||
| public FeatureVariableDecisionNotificationBuilder withFeatureDecision(FeatureDecision featureDecision) { | ||
| this.featureDecision = featureDecision; | ||
| return this; | ||
| } | ||
|
|
||
| public FeatureVariableDecisionNotificationBuilder withVariableKey(String variableKey) { | ||
| this.variableKey = variableKey; | ||
| return this; | ||
| } | ||
|
|
||
| public FeatureVariableDecisionNotificationBuilder withVariableType(FeatureVariable.VariableType variableType) { | ||
| this.variableType = variableType; | ||
| return this; | ||
| } | ||
|
|
||
| public FeatureVariableDecisionNotificationBuilder withVariableValue(Object variableValue) { | ||
| this.variableValue = variableValue; | ||
| return this; | ||
| } | ||
|
|
||
| public DecisionNotification build() { | ||
| decisionInfo = new HashMap<>(); | ||
| decisionInfo.put(FEATURE_KEY, featureKey); | ||
| decisionInfo.put(FEATURE_ENABLED, featureEnabled); | ||
| decisionInfo.put(VARIABLE_KEY, variableKey); | ||
| decisionInfo.put(VARIABLE_TYPE, variableType); | ||
| decisionInfo.put(VARIABLE_VALUE, variableValue); | ||
| if (featureDecision != null && featureDecision.decisionSource != null && FeatureDecision.DecisionSource.EXPERIMENT.equals(featureDecision.decisionSource)) { | ||
| decisionInfo.put(SOURCE_EXPERIMENT_KEY, featureDecision.experiment.getKey()); | ||
| decisionInfo.put(SOURCE_VARIATION_KEY, featureDecision.variation.getKey()); | ||
| decisionInfo.put(SOURCE, featureDecision.decisionSource); | ||
| } else { | ||
| decisionInfo.put(SOURCE_EXPERIMENT_KEY, null); | ||
| decisionInfo.put(SOURCE_VARIATION_KEY, null); | ||
| decisionInfo.put(SOURCE, FeatureDecision.DecisionSource.ROLLOUT); | ||
| } | ||
|
|
||
| return new DecisionNotification( | ||
| NotificationCenter.DecisionNotificationType.FEATURE_VARIABLE.toString(), | ||
| userId, | ||
| attributes, | ||
| decisionInfo); | ||
| } | ||
| } | ||
| } | ||
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
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.
Are all of these fields allowed to be null? I see in
BaseDecisionNotificationBuilder, that we defaultattributesto empty map -- that should be moved here (otherwise assert non-null in constructor) to make it consistent, otherwise nulls can slip in.