summaryrefslogtreecommitdiffstats
path: root/toolkit/components/extensions/test/xpcshell/test_ext_runtime_ports_gc.js
blob: ca63e683be14e6f647597563aedfc0625a75a1db (plain)
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
"use strict";

let gcExperimentAPIs = {
  gcHelper: {
    schema: "schema.json",
    child: {
      scopes: ["addon_child"],
      script: "child.js",
      paths: [["gcHelper"]],
    },
  },
};

let gcExperimentFiles = {
  "schema.json": JSON.stringify([
    {
      namespace: "gcHelper",
      functions: [
        {
          name: "forceGarbageCollect",
          type: "function",
          parameters: [],
          async: true,
        },
        {
          name: "registerWitness",
          type: "function",
          parameters: [
            {
              name: "obj",
              // Expected type is "object", but using "any" here to ensure that
              // the parameter is untouched (not normalized).
              type: "any",
            },
          ],
          returns: { type: "number" },
        },
        {
          name: "isGarbageCollected",
          type: "function",
          parameters: [
            {
              name: "witnessId",
              description: "return value of registerWitness",
              type: "number",
            },
          ],
          returns: { type: "boolean" },
        },
      ],
    },
  ]),
  "child.js": () => {
    let { setTimeout } = ChromeUtils.importESModule(
      "resource://gre/modules/Timer.sys.mjs"
    );
    /* globals ExtensionAPI */
    this.gcHelper = class extends ExtensionAPI {
      getAPI() {
        let witnesses = new Map();
        return {
          gcHelper: {
            async forceGarbageCollect() {
              // Logic copied from test_ext_contexts_gc.js
              for (let i = 0; i < 3; ++i) {
                Cu.forceShrinkingGC();
                Cu.forceCC();
                Cu.forceGC();
                await new Promise(resolve => setTimeout(resolve, 0));
              }
            },
            registerWitness(obj) {
              let witnessId = witnesses.size;
              witnesses.set(witnessId, Cu.getWeakReference(obj));
              return witnessId;
            },
            isGarbageCollected(witnessId) {
              return witnesses.get(witnessId).get() === null;
            },
          },
        };
      }
    };
  },
};

// Verify that the experiment is working as intended before using it in tests.
add_task(async function test_gc_experiment() {
  let extension = ExtensionTestUtils.loadExtension({
    isPrivileged: true,
    manifest: {
      experiment_apis: gcExperimentAPIs,
    },
    files: gcExperimentFiles,
    async background() {
      let obj1 = {};
      let obj2 = {};
      let witness1 = browser.gcHelper.registerWitness(obj1);
      let witness2 = browser.gcHelper.registerWitness(obj2);
      obj1 = null;
      await browser.gcHelper.forceGarbageCollect();
      browser.test.assertTrue(
        browser.gcHelper.isGarbageCollected(witness1),
        "obj1 should have been garbage-collected"
      );
      browser.test.assertFalse(
        browser.gcHelper.isGarbageCollected(witness2),
        "obj2 should not have been garbage-collected"
      );

      browser.test.sendMessage("done");
    },
  });

  await extension.startup();
  await extension.awaitMessage("done");
  await extension.unload();
});

add_task(async function test_port_gc() {
  let extension = ExtensionTestUtils.loadExtension({
    isPrivileged: true,
    manifest: {
      experiment_apis: gcExperimentAPIs,
    },
    files: gcExperimentFiles,
    async background() {
      let witnessPortSender;
      let witnessPortReceiver;

      browser.runtime.onConnect.addListener(port => {
        browser.test.assertEq("daName", port.name, "expected port");
        witnessPortReceiver = browser.gcHelper.registerWitness(port);
        port.disconnect();
      });

      // runtime.connect() only triggers onConnect for different contexts,
      // so create a frame to have a different context.
      // A blank frame in a moz-extension:-document will have access to the
      // extension APIs.
      let frameWindow = await new Promise(resolve => {
        let f = document.createElement("iframe");
        f.onload = () => resolve(f.contentWindow);
        document.body.append(f);
      });
      await new Promise(resolve => {
        let port = frameWindow.browser.runtime.connect({ name: "daName" });
        witnessPortSender = browser.gcHelper.registerWitness(port);
        port.onDisconnect.addListener(() => resolve());
      });

      await browser.gcHelper.forceGarbageCollect();

      browser.test.assertTrue(
        browser.gcHelper.isGarbageCollected(witnessPortSender),
        "runtime.connect() port should have been garbage-collected"
      );
      browser.test.assertTrue(
        browser.gcHelper.isGarbageCollected(witnessPortReceiver),
        "runtime.onConnect port should have been garbage-collected"
      );

      browser.test.sendMessage("done");
    },
  });

  await extension.startup();
  await extension.awaitMessage("done");
  await extension.unload();
});