summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/common/gc.js
blob: ac43a4cfaf7735a08dfd1be177918167f815e800 (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
/**
 * Does a best-effort attempt at invoking garbage collection. Attempts to use
 * the standardized `TestUtils.gc()` function, but falls back to other
 * environment-specific nonstandard functions, with a final result of just
 * creating a lot of garbage (in which case you will get a console warning).
 *
 * This should generally only be used to attempt to trigger bugs and crashes
 * inside tests, i.e. cases where if garbage collection happened, then this
 * should not trigger some misbehavior. You cannot rely on garbage collection
 * successfully trigger, or that any particular unreachable object will be
 * collected.
 *
 * @returns {Promise<undefined>} A promise you should await to ensure garbage
 * collection has had a chance to complete.
 */
self.garbageCollect = async () => {
  // https://testutils.spec.whatwg.org/#the-testutils-namespace
  if (self.TestUtils?.gc) {
    return TestUtils.gc();
  }

  // Use --expose_gc for V8 (and Node.js)
  // to pass this flag at chrome launch use: --js-flags="--expose-gc"
  // Exposed in SpiderMonkey shell as well
  if (self.gc) {
    return self.gc();
  }

  // Present in some WebKit development environments
  if (self.GCController) {
    return GCController.collect();
  }

  console.warn(
    'Tests are running without the ability to do manual garbage collection. ' +
    'They will still work, but coverage will be suboptimal.');

  for (var i = 0; i < 1000; i++) {
    gcRec(10);
  }

  function gcRec(n) {
    if (n < 1) {
      return {};
    }

    let temp = { i: "ab" + i + i / 100000 };
    temp += "foo";

    gcRec(n - 1);
  }
};