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
|
/* Any copyright is dedicated to the Public Domain.
http://creativecommons.org/publicdomain/zero/1.0/ */
"use strict";
add_setup(function test_setup() {
// Give FOG a temp profile to init within.
do_get_profile();
// We need to initialize it once, otherwise operations will be stuck in
// the pre-init queue.
Services.fog.initializeFOG();
});
add_task(function test_fog_metrics_disabled_remotely() {
// Set a cheesy string in the test metric. This should record because the
// metric has `disabled: false` by default.
const str1 = "a cheesy string!";
Glean.testOnly.cheesyString.set(str1);
Assert.equal(str1, Glean.testOnly.cheesyString.testGetValue("test-ping"));
// Create and set a feature configuration that disables the test metric.
const feature_config = {
"test_only.cheesy_string": false,
};
Services.fog.setMetricsFeatureConfig(JSON.stringify(feature_config));
// Attempt to set another cheesy string in the test metric. This should not
// record because of the override to the metric's default value in the
// feature configuration.
const str2 = "another cheesy string!";
Glean.testOnly.cheesyString.set(str2);
Assert.equal(str1, Glean.testOnly.cheesyString.testGetValue("test-ping"));
// Clear the configuration so it doesn't interfere with other tests.
Services.fog.setMetricsFeatureConfig("{}");
});
add_task(function test_fog_multiple_metrics_disabled_remotely() {
// Set some test metrics. This should record because the metrics are
// `disabled: false` by default.
const str1 = "yet another a cheesy string!";
Glean.testOnly.cheesyString.set(str1);
Assert.equal(str1, Glean.testOnly.cheesyString.testGetValue("test-ping"));
const qty1 = 42;
Glean.testOnly.meaningOfLife.set(qty1);
Assert.equal(qty1, Glean.testOnly.meaningOfLife.testGetValue("test-ping"));
// Create and set a feature configuration that disables multiple test
// metrics.
var feature_config = {
"test_only.cheesy_string": false,
"test_only.meaning_of_life": false,
};
Services.fog.setMetricsFeatureConfig(JSON.stringify(feature_config));
// Attempt to set the metrics again. This should not record because of the
// override to the metrics' default value in the feature configuration.
const str2 = "another cheesy string v2!";
Glean.testOnly.cheesyString.set(str2);
Assert.equal(str1, Glean.testOnly.cheesyString.testGetValue("test-ping"));
const qty2 = 52;
Glean.testOnly.meaningOfLife.set(qty2);
Assert.equal(qty1, Glean.testOnly.meaningOfLife.testGetValue("test-ping"));
// Change the feature configuration to re-enable the `cheesy_string` metric.
feature_config = {
"test_only.cheesy_string": true,
"test_only.meaning_of_life": false,
};
Services.fog.setMetricsFeatureConfig(JSON.stringify(feature_config));
// Attempt to set the metrics again. This should only record `cheesy_string`
// because of the most recent feature configuration.
const str3 = "another cheesy string v3!";
Glean.testOnly.cheesyString.set(str3);
Assert.equal(str3, Glean.testOnly.cheesyString.testGetValue("test-ping"));
const qty3 = 62;
Glean.testOnly.meaningOfLife.set(qty3);
Assert.equal(qty1, Glean.testOnly.meaningOfLife.testGetValue("test-ping"));
// Clear the configuration so it doesn't interfere with other tests. This
// is done by passing in an empty dictionary.
Services.fog.setMetricsFeatureConfig("{}");
// Set some final metrics. This should record in both metrics because they
// are both `disabled: false` by default.
const str4 = "another a cheesy string v4";
Glean.testOnly.cheesyString.set(str4);
Assert.equal(str4, Glean.testOnly.cheesyString.testGetValue("test-ping"));
const qty4 = 72;
Glean.testOnly.meaningOfLife.set(qty4);
Assert.equal(qty4, Glean.testOnly.meaningOfLife.testGetValue("test-ping"));
});
add_task(function test_fog_metrics_feature_config_api_handles_null_values() {
// Set a cheesy string in the test metric. This should record because the
// metric has `disabled: false` by default.
const str1 = "a cheesy string!";
Glean.testOnly.cheesyString.set(str1);
Assert.equal(str1, Glean.testOnly.cheesyString.testGetValue("test-ping"));
// Create and set a feature configuration that disables the test metric.
const feature_config = {
"test_only.cheesy_string": false,
};
Services.fog.setMetricsFeatureConfig(JSON.stringify(feature_config));
// Attempt to set another cheesy string in the test metric. This should not
// record because of the override to the metric's default value in the
// feature configuration.
const str2 = "another cheesy string v2";
Glean.testOnly.cheesyString.set(str2);
Assert.equal(str1, Glean.testOnly.cheesyString.testGetValue("test-ping"));
// Set the configuration to `null`.
Services.fog.setMetricsFeatureConfig(null);
// Attempt to set another cheesy string in the test metric. This should now
// record because `null` should clear the configuration.
Glean.testOnly.cheesyString.set(str2);
Assert.equal(str2, Glean.testOnly.cheesyString.testGetValue("test-ping"));
// Reset back to the feature configuration that disables the test metric.
Services.fog.setMetricsFeatureConfig(JSON.stringify(feature_config));
// Attempt to set another cheesy string in the test metric. This should not
// record because of the override to the metric's default value in the
// feature configuration.
Glean.testOnly.cheesyString.set(str1);
Assert.equal(str2, Glean.testOnly.cheesyString.testGetValue("test-ping"));
// Set the configuration to `""` to replicate getting an empty string from
// Nimbus.
Services.fog.setMetricsFeatureConfig("");
// Attempt to set another cheesy string in the test metric. This should now
// record again because `""` should be clear the configuration.
const str3 = "another cheesy string v3";
Glean.testOnly.cheesyString.set(str3);
Assert.equal(str3, Glean.testOnly.cheesyString.testGetValue("test-ping"));
});
add_task(function test_fog_metrics_disabled_reset_fog_behavior() {
// Set a cheesy string in the test metric. This should record because the
// metric has `disabled: false` by default.
const str1 = "a cheesy string!";
Glean.testOnly.cheesyString.set(str1);
Assert.equal(str1, Glean.testOnly.cheesyString.testGetValue("test-ping"));
// Create and set a feature configuration that disables the test metric.
const feature_config = {
"test_only.cheesy_string": false,
};
Services.fog.setMetricsFeatureConfig(JSON.stringify(feature_config));
// Attempt to set another cheesy string in the test metric. This should not
// record because of the override to the metric's default value in the
// feature configuration.
const str2 = "another cheesy string!";
Glean.testOnly.cheesyString.set(str2);
Assert.equal(str1, Glean.testOnly.cheesyString.testGetValue("test-ping"));
// Now reset FOG to ensure that the feature configuration is also reset.
Services.fog.testResetFOG();
// Attempt to set the string again in the test metric. This should now
// record normally because we reset FOG.
Glean.testOnly.cheesyString.set(str2);
Assert.equal(str2, Glean.testOnly.cheesyString.testGetValue("test-ping"));
// Clear the configuration so it doesn't interfere with other tests.
Services.fog.setMetricsFeatureConfig("{}");
});
|
