File: test_preferencesBindings_async_setting.html

package info (click to toggle)
firefox 147.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,683,320 kB
  • sloc: cpp: 7,607,359; javascript: 6,533,295; ansic: 3,775,223; python: 1,415,500; xml: 634,561; asm: 438,949; java: 186,241; sh: 62,752; makefile: 18,079; objc: 13,092; perl: 12,808; yacc: 4,583; cs: 3,846; pascal: 3,448; lex: 1,720; ruby: 1,003; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10; exp: 6
file content (239 lines) | stat: -rw-r--r-- 7,382 bytes parent folder | download | duplicates (3)
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
<!doctype html>
<html>
  <head>
    <meta charset="utf-8" />
    <title>PreferencesBindings AsyncSetting Tests</title>
    <script src="chrome://mochikit/content/tests/SimpleTest/SimpleTest.js"></script>
    <link
      rel="stylesheet"
      href="chrome://mochikit/content/tests/SimpleTest/test.css"
    />
    <script
      type="application/javascript"
      src="chrome://global/content/preferencesBindings.js"
    ></script>
    <script>
      /* import-globals-from /toolkit/content/preferencesBindings.js */
      function waitForSettingChange(setting) {
        return new Promise(resolve => {
          setting.on("change", function handler() {
            setting.off("change", handler);
            resolve();
          });
        });
      }

      add_task(async function testAsyncSetting() {
        const SETTING_ID = "testAsyncSetting";

        let delayPromise;
        let resolve;
        let triggerUpdate;

        function prepareDelay() {
          delayPromise = new Promise(r => (resolve = r));
        }

        let callCounts = {
          get: 0,
          set: 0,
          disabled: 0,
          visible: 0,
          getControlConfig: 0,
        };

        let nextValue;
        let nextDisabled;
        let nextVisible;
        let nextGetControlConfig;

        Preferences.addSetting(
          class extends Preferences.AsyncSetting {
            static id = SETTING_ID;

            async get() {
              callCounts.get++;
              await delayPromise;
              return nextValue;
            }

            async set(val) {
              callCounts.set++;
              await delayPromise;
              nextValue = val.value;
              nextDisabled = val.disabled;
              nextVisible = val.visible;
              nextGetControlConfig = val.getControlConfig;
              this.emitChange();
            }

            async disabled() {
              callCounts.disabled++;
              await delayPromise;
              return nextDisabled;
            }

            async visible() {
              callCounts.visible++;
              await delayPromise;
              return nextVisible;
            }

            async getControlConfig() {
              callCounts.getControlConfig++;
              await delayPromise;
              return nextGetControlConfig;
            }

            setup() {
              triggerUpdate = () => this.emitChange();
            }
          }
        );

        let setting = Preferences.getSetting(SETTING_ID);
        ok(setting, "Got a setting object");

        prepareDelay();

        function assertCallCounts(gettersCount, setterCount) {
          for (let prop of ["get", "disabled", "visible", "getControlConfig"]) {
            // Getters have been called but haven't resolved yet.
            is(
              callCounts[prop],
              gettersCount,
              `Getter count is expected (${prop})`
            );
          }
          is(callCounts.set, setterCount, "Set count is expected");
        }

        function assertInitialSettingValues(message) {
          info(`assertInitialSettingValues ${message}`);
          is(setting.value, "", "Setting value is empty string");
          ok(!setting.disabled, "Setting is not disabled");
          ok(setting.visible, "Setting is visible");
          ok(
            setting.getControlConfig({ l10nId: "mystring" }),
            "Setting getControlConfig is empty object"
          );
        }

        assertInitialSettingValues("First check");

        nextValue = 5;
        nextDisabled = true;
        nextVisible = false;
        nextGetControlConfig = { l10nId: "whatever" };

        // Nothing should have changed yet, cached values returned.
        assertInitialSettingValues("Second get");
        assertCallCounts(1, 0);

        // Verify that the values are cached.
        assertInitialSettingValues("Ensure cached");
        assertCallCounts(1, 0);

        // Verify that starting the update doesn't change the settings.
        triggerUpdate();

        // Verify that the values are cached, but an update has started.
        assertCallCounts(2, 0);
        assertInitialSettingValues("After AsyncSetting change");
        assertCallCounts(2, 0);

        let settingChanged = waitForSettingChange(setting);
        resolve();
        await settingChanged;

        function assertSecondValues(message) {
          info(`assertSecondValues ${message}`);
          is(setting.value, 5, "Setting value changed");
          ok(setting.disabled, "Setting disabled changed");
          ok(!setting.visible, "Setting visible changed");
          is(
            setting.getControlConfig({ l10nId: "mystring" }).l10nId,
            "whatever",
            "Setting getControlConfig changed"
          );
        }
        assertSecondValues("After Setting change");
        assertCallCounts(2, 0);

        let testValues = {
          value: Symbol("value"),
          disabled: Symbol("disabled"),
          visible: Symbol("visible"),
          getControlConfig: {
            l10nId: Symbol("getControlConfig"),
            newThing: true,
          },
        };

        prepareDelay();

        settingChanged = waitForSettingChange(setting);
        setting.value = testValues;
        assertCallCounts(2, 1);

        // Grab the current resolver, but create a new one to delay the getters.
        let setResolve = resolve;
        prepareDelay();
        setResolve();

        // Still getting the second set of values, but they're being refreshed.
        assertSecondValues("After setting a value");

        assertCallCounts(2, 1);
        resolve();
        info("Waiting for set to emit change");
        await settingChanged;
        assertCallCounts(3, 1);

        info("Setting has changed");
        is(setting.value, testValues.value, "Setting value changed");
        is(setting.disabled, testValues.disabled, "Setting disabled changed");
        is(setting.visible, testValues.visible, "Setting visible changed");
        let controlConfig = setting.getControlConfig({ l10nId: "otherstring" });
        is(
          controlConfig.l10nId,
          testValues.getControlConfig.l10nId,
          "Setting getControlConfig changed"
        );
        is(controlConfig.newThing, true, "Setting getControlConfig changed");
      });

      add_task(async function testAsyncSettingDefaults() {
        const SETTING_ID = "testAsyncSettingDefaults";

        Preferences.addSetting(
          class extends Preferences.AsyncSetting {
            static id = SETTING_ID;

            defaultValue = 10;
            defaultDisabled = true;
            defaultVisible = false;
            defaultGetControlConfig = { l10nId: "overridden" };
          }
        );

        let setting = Preferences.getSetting(SETTING_ID);
        ok(setting, "Got a setting object");

        is(setting.value, 10, "Default value was set");
        ok(setting.disabled, "Default disabled was set");
        ok(!setting.visible, "Default visible was set");
        is(
          setting.getControlConfig({ l10nId: "mystring" }).l10nId,
          "overridden",
          "Default getControlConfig was set"
        );
      });
    </script>
  </head>
  <body>
    <p id="display"></p>
    <div id="content" style="display: none"></div>
    <pre id="test"></pre>
  </body>
</html>