outplan/test.js at master · cloud9ide/outplan · GitHub

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
var outplanFull = require("./dist/outplan_full");
var outplan = require("./dist/outplan");
var assert = require("assert");

function testBoth(test) {
    test(outplanFull);
    test(outplan);
}

describe("outplan", function() {
    this.timeout(15000);

    beforeEach(function() {
        testBoth(function(outplan) {
            outplan.configure({
                logFunction: function() {},
                experiments: [],
                compatibleHash: false,
            });
        });
    });

    it("can create simple experiments", function() {
        testBoth(function(outplan) {
            outplan.create("foo", ["A", "B"]);
            assert.equal(Object.keys(outplan.getExperiments()).length, 1);
        });
    });

    it("can create simple experiments with a custom distribution operator", function() {
        testBoth(function(outplan) {
            outplan.create("foo", ["A", "B"], {
                operator: outplan.WeightedChoice,
                weights: [0.5, 0.5],
            });
            assert.equal(Object.keys(outplan.getExperiments()).length, 1);
        });
    });

    it("can create multiple experiments", function() {
        testBoth(function(outplan) {
            outplan.create("foo", ["A", "B"]);
            outplan.create("bar", ["C", "D"]);
            assert.equal(Object.keys(outplan.getExperiments()).length, 2);
        });
    });

    it("can get values for experiments", function() {
        testBoth(function(outplan) {
            outplan.create("foo", ["A", "B"]);
            var value = outplan.expose("foo", 1);
            assert(value === "A" || value === "B", value);
        });
    });

    it("deterministically gets values in outplan_full", function() {
        outplanFull.create("foo", ["A", "B"]);
        assert.equal(outplanFull.expose("foo", 1), "B");
        assert.equal(outplanFull.expose("foo", 2), "B");
        assert.equal(outplanFull.expose("foo", 3), "A");
        assert.equal(outplanFull.expose("foo", 4), "B");
        assert.equal(outplanFull.expose("foo", "1"), "B");
        assert.equal(outplanFull.expose("foo", "2"), "B");
        assert.equal(outplanFull.expose("foo", "3"), "A");
        assert.equal(outplanFull.expose("foo", "4"), "B");
        assert.equal(outplanFull.expose("foo", "5"), "B");
        assert.equal(outplanFull.expose("foo", "6"), "A");
        assert.equal(outplanFull.expose("foo", "7"), "A");
        assert.equal(outplanFull.expose("foo", "8"), "B");
        assert.equal(outplanFull.expose("foo", "9"), "A");
    });

    it("deterministically gets values in lite version", function() {
        outplan.create("foo", ["A", "B"]);
        assert.equal(outplan.expose("foo", 1), "A");
        assert.equal(outplan.expose("foo", 2), "B");
        assert.equal(outplan.expose("foo", 3), "A");
        assert.equal(outplan.expose("foo", 4), "B");
        assert.equal(outplan.expose("foo", "1"), "A");
        assert.equal(outplan.expose("foo", "2"), "B");
        assert.equal(outplan.expose("foo", "3"), "A");
        assert.equal(outplan.expose("foo", "4"), "B");
        assert.equal(outplan.expose("foo", "5"), "A");
        assert.equal(outplan.expose("foo", "6"), "A");
        assert.equal(outplan.expose("foo", "7"), "B");
        assert.equal(outplan.expose("foo", "8"), "B");
        assert.equal(outplan.expose("foo", "9"), "B");
    });

    it("supports complex choice objects", function() {
        var outplan = outplanFull;
        outplan.create("foo", [{ name: "A", color: "#AAA" }, { name: "B", color: "#BBB" }]);
        var value = outplan.expose("foo", 1);
        assert.equal(value.color, "#BBB");
    });

    it("can run some example code", function() {
        outplan.create("nice-colors", [
            { name: "A", button_color: "#AAA", button_text: "I voted" },
            { name: "B", button_color: "#BBB", button_text: "I am voter" }
        ]);
        var variation = outplan.expose("nice-colors", 42);
        var color = variation.button_color;
        var text = variation.button_text;

        assert.equal(color, "#AAA");
        assert.equal(text, "I voted");
    });

    it("supports logging", function() {
        var logged;
        outplanFull.configure({
            logFunction: function(e) {
                logged = e;
            }
        });
        outplanFull.create("foo", ["A", "B"]);
        outplanFull.expose("foo", 42);
        assert(logged, "Needs to log exposures");
        assert.equal(logged.name, "foo");
        assert.equal(logged.inputs.userId, 42);
        assert.equal(logged.params.name, "B");
        assert.equal(logged.params.value, "B");
        assert.equal(logged.event, "exposure");
        assert.equal(logged.salt, "salt");
        assert(logged.time);
    });

    it("doesn't log when using { log: false }", function() {
        testBoth(function(outplan) {
            var logged;
            outplan.configure({
                logFunction: function(e) {
                    logged = e;
                }
            });
            outplan.create("foo", ["A", "B"]);
            outplan.expose("foo", 42, { log: false });
            assert(!logged);
            outplan.expose("foo", 42, { log: true });
            assert(logged);
        });
    });

    it("supports compatibleHash in outplan_full", function() {
        outplanFull.create("foo", ["A", "B"]);
        assert.equal(outplanFull.expose("foo", 99), "A");
        outplanFull.configure({ compatibleHash: true });
        assert.equal(outplanFull.expose("foo", 99), "B");
    });

    it("doesn't support compatibleHash with regular outplan", function() {
        try {
            outplan.configure({ compatibleHash: true });
        } catch (e) {
            return;
        }
        assert(false, "Exception expected");
    });

    it("supports a falsy userId", function() {
        testBoth(function(outplan) {
            outplan.create("foo", ["A", "B"]);
            assert.equal(outplan.expose("foo", 0), "B");
        });
    });

    it("supports a string userId", function() {
        outplanFull.create("foo", ["A", "B"]);
        assert.equal(outplanFull.expose("foo", "usertje"), "A");
    });

    it("supports uses the experiment name for determinism", function() {
        outplanFull.create("foo", ["A", "B"]);
        outplanFull.create("bar", ["A", "B"]);
        assert.equal(outplanFull.expose("foo", 42), "B");
        assert.equal(outplanFull.expose("bar", 42), "A");
    });

    it("using create multiple times doesn't affect determinism", function() {
        outplanFull.create("foo", ["A", "B"]);
        outplanFull.create("bar", ["A", "B"]);
        outplanFull.create("foo", ["A", "B"]);
        outplanFull.create("bar", ["A", "B"]);
        assert.equal(outplanFull.expose("foo", 42), "B");
        assert.equal(outplanFull.expose("bar", 42), "A");

        outplan.create("foo", ["A", "B"]);
        outplan.create("bar", ["A", "B"]);
        outplan.create("foo", ["A", "B"]);
        outplan.create("bar", ["A", "B"]);
        assert.equal(outplan.expose("foo", 42), "A");
        assert.equal(outplan.expose("bar", 42), "A");

    });

    it("supports chaining API", function() {
        var variation = outplan
            .create("foo", ["A", "B"])
            .expose(42);
        assert.equal(variation, "A");
    });
});