/
Experiment.java
363 lines (293 loc) · 10.9 KB
/
Experiment.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
package com.wixpress.petri.experiments.domain;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.google.common.base.Function;
import com.google.common.collect.ImmutableList;
import com.wixpress.petri.laboratory.ConductionContext;
import com.wixpress.petri.laboratory.ConductionStrategy;
import com.wixpress.petri.laboratory.UserInfo;
import org.apache.commons.lang3.StringUtils;
import org.joda.time.DateTime;
import org.joda.time.Interval;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import static com.google.common.base.Predicates.instanceOf;
import static com.google.common.collect.Iterables.transform;
import static com.google.common.collect.Iterables.tryFind;
import static com.google.common.collect.Lists.newArrayList;
/**
* @author alex
* @since 8/17/11 12:54 PM
*/
@JsonDeserialize(builder = ExperimentBuilder.class)
public class Experiment {
public static final int NO_ID = 0;
private final int id;
private final DateTime lastUpdated;
private final ExperimentSnapshot experimentSnapshot;
private Map<Integer, TestGroup> groupsMap = new HashMap<Integer, TestGroup>();
private final Filter theFilter;
Experiment(int id, DateTime lastUpdated, ExperimentSnapshot snapshot) {
this.id = id;
this.lastUpdated = lastUpdated;
this.experimentSnapshot = snapshot;
this.setGroupsMap(experimentSnapshot.groups());
this.theFilter = new AggregateFilter(getFilters());
}
private void setGroupsMap(List<TestGroup> groups) {
for (TestGroup group : groups)
addGroup(group);
}
private void addGroup(TestGroup g) {
groupsMap.put(g.getId(), g);
}
public int getId() {
return id;
}
public DateTime getLastUpdated() {
return lastUpdated;
}
public ExperimentSnapshot getExperimentSnapshot() {
return experimentSnapshot;
}
@JsonIgnore
public int getOriginalId() {
return experimentSnapshot.originalId() != NO_ID ? experimentSnapshot.originalId() : getId();
}
@JsonIgnore
public int getSeed() {
return experimentSnapshot.linkedId() != NO_ID ? experimentSnapshot.linkedId() : getOriginalId();
}
@JsonIgnore
public String getKey() {
return experimentSnapshot.key();
}
@JsonIgnore
public Boolean isFromSpec() {
return experimentSnapshot.isFromSpec();
}
@JsonIgnore
public DateTime getCreationDate() {
return experimentSnapshot.creationDate();
}
@JsonIgnore
public String getDescription() {
return experimentSnapshot.description();
}
@JsonIgnore
public String getName() {
return experimentSnapshot.name();
}
@JsonIgnore
public DateTime getStartDate() {
return experimentSnapshot.startDate();
}
@JsonIgnore
public DateTime getEndDate() {
return experimentSnapshot.endDate();
}
@JsonIgnore
public List<TestGroup> getGroups() {
return experimentSnapshot.groups();
}
@JsonIgnore
public List<Filter> getFilters() {
return experimentSnapshot.filters();
}
@JsonIgnore
public String getScope() {
if(experimentSnapshot.scopes().size() > 0 )
return StringUtils.join(experimentSnapshot.scopes(),",");
return experimentSnapshot.scope();
}
@JsonIgnore
public List<String> getScopes() {
if(experimentSnapshot.scopes().size() > 0 )
return experimentSnapshot.scopes();
return ImmutableList.of(experimentSnapshot.scope());
}
@JsonIgnore
public boolean isPaused() {
return experimentSnapshot.isPaused();
}
@JsonIgnore
public String getCreator() {
return experimentSnapshot.creator();
}
@JsonIgnore
public boolean isToggle() {
return experimentSnapshot.isFeatureToggle();
}
@JsonIgnore
public boolean isPersistent() {
return experimentSnapshot.isPersistent();
}
@JsonIgnore
public boolean isAllowedForBots() {
return experimentSnapshot.isAllowedForBots();
}
@JsonIgnore
public boolean isOnlyForLoggedInUsers() {
return experimentSnapshot.isOnlyForLoggedInUsers();
}
@JsonIgnore
public String getComment() {
return experimentSnapshot.comment();
}
@JsonIgnore
public String getUpdater() {
return experimentSnapshot.updater();
}
private boolean isValid() {
return experimentSnapshot.isValid();
}
public TestGroup getTestGroupByChunk(int chunk) {
TestGroup currentGrp = null;
int accumulatedChunk = 0;
for (TestGroup testGroup : getGroups()) {
accumulatedChunk += testGroup.getChunk();
currentGrp = testGroup;
if (accumulatedChunk > chunk)
break;
}
return currentGrp;
}
public TestGroup getTestGroupById(int id) {
return groupsMap.get(id);
}
//TODO - can make this private now (and move its test to the FilterTest)
public boolean isEligible(EligibilityCriteria eligibilityCriteria) {
if (!isValid()) {
throw new InvalidExperiment(this);
}
return theFilter.isEligible(eligibilityCriteria);
}
// TODO: This can be moved to an ActivationPeriod object with all related members and constants
public boolean isActiveAt(DateTime now) {
Interval interval = new Interval(getStartDate(), getEndDate());
return interval.contains(now);
}
@JsonIgnore
public boolean isTerminated() {
return (getEndDate().isEqual(getStartDate())) || getEndDate().isBeforeNow();
}
@JsonIgnore
public boolean hasSameKey(String otherKey) {
return getKey().equalsIgnoreCase(otherKey);
}
public boolean containsValue(String value) {
for (TestGroup testGroup : getGroups()) {
if (testGroup.getValue().equals(value)) {
return true;
}
}
return false;
}
public Experiment terminateAsOf(DateTime instant, Trigger trigger) {
DateTime terminateTime = getStartDate().isBefore(instant) ? instant : getStartDate();
return ExperimentBuilder.aCopyOf(this).
withExperimentSnapshot(ExperimentSnapshotBuilder.aCopyOf(getExperimentSnapshot()).
withEndDate(terminateTime).
withTrigger(trigger).
build()).
build();
}
public Experiment pause(Trigger trigger) {
return ExperimentBuilder.aCopyOf(this).
withExperimentSnapshot(ExperimentSnapshotBuilder.aCopyOf(getExperimentSnapshot()).
withPaused(true).
withTrigger(trigger).
build()
).build();
}
public Experiment resume(Trigger trigger) {
return ExperimentBuilder.aCopyOf(this).
withExperimentSnapshot(ExperimentSnapshotBuilder.aCopyOf(getExperimentSnapshot()).
withPaused(false).
withTrigger(trigger).
build()
).build();
}
public Experiment openToAllAlwaysReturning(String value) {
return ExperimentBuilder.aCopyOf(this).
withExperimentSnapshot(ExperimentSnapshotBuilder.aCopyOf(getExperimentSnapshot()).
withFeatureToggle(true).
withGroups(copyGroupsButWithWinningValue(value)).
withFilters(new ArrayList<Filter>()).
build()
).build();
}
private List<TestGroup> copyGroupsButWithWinningValue(final String winningGroup) {
return newArrayList(transform(getGroups(), new Function<TestGroup, TestGroup>() {
@Override
public TestGroup apply(TestGroup input) {
return new TestGroup(input.getId(), input.getValue().equals(winningGroup) ? 100 : 0, input.getValue());
}
}));
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
Experiment that = (Experiment) o;
if (id != that.id) return false;
if (!lastUpdated.equals(that.lastUpdated)) return false;
if (!experimentSnapshot.equals(that.experimentSnapshot)) return false;
return true;
}
@Override
public int hashCode() {
int result = id;
result = 31 * result + lastUpdated.hashCode();
result = 31 * result + experimentSnapshot.hashCode();
return result;
}
@Override
public String toString() {
return "Experiment{" +
"id=" + id +
", lastUpdated=" + lastUpdated +
", experimentSnapshot=" + experimentSnapshot +
'}';
}
public Experiment pauseOrTerminateAsOf(DateTime instant, List<Filter> newFilters, Trigger trigger) {
if (canRelyOnPreviouslyConductedUid(newFilters) || !isPersistent()) {
return terminateAsOf(instant, trigger);
}
return pause(trigger);
}
public boolean canRelyOnPreviouslyConductedUid(List<Filter> newFilters) {
return isOnlyForLoggedInUsers() && noNewUsersFilter(newFilters);
}
private boolean noNewUsersFilter(List<Filter> newFilters) {
return !(tryFind(newFilters, instanceOf(NewUsersFilter.class)).isPresent());
}
public Assignment conduct(ConductionContext context, UserInfo userInfo, ExternalDataFetchers externalDataFetchers) {
long startTime = System.currentTimeMillis();
TestGroup winning = null;
ConductionStrategy conductionStrategy = context.conductionStrategyOrFallback(userInfo);
EligibilityCriteria eligibilityCriteria = new EligibilityCriteria(
userInfo, conductionStrategy, context.additionalEligibilityCriteria(), getStartDate(), externalDataFetchers);
if (!isPaused() && isEligible(eligibilityCriteria)) {
if (isToggle()) {
winning = getTestGroupByChunk(0);
} else {
winning = conductionStrategy.drawTestGroup(this);
}
}
return new Assignment(userInfo, conductionStrategy, context.biAdditions(), winning, this, calculateExecutionTime(startTime));
}
private long calculateExecutionTime(long startTime) {
return System.currentTimeMillis() - startTime;
}
public boolean shouldBePersisted() {
return !isToggle() && isPersistent();
}
public static class InvalidExperiment extends RuntimeException {
public InvalidExperiment(Experiment experiment) {
super("cannot conduct invalid experiment, is your client too old? " + experiment.getFilters());
}
}
}