summaryrefslogtreecommitdiffstats
path: root/browser/components/pagedata/PageDataParent.sys.mjs
blob: 25295adeca3841817dd631d1c29e9e9345af046e (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
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

const lazy = {};

ChromeUtils.defineESModuleGetters(lazy, {
  PageDataService: "resource:///modules/pagedata/PageDataService.sys.mjs",
});

/**
 * Receives messages from PageDataChild and passes them to the PageData service.
 */
export class PageDataParent extends JSWindowActorParent {
  #deferredCollection = null;

  /**
   * Starts data collection in the child process. Returns a promise that
   * resolves to the page data or null if the page is closed before data
   * collection completes.
   *
   * @returns {Promise<PageData|null>}
   */
  collectPageData() {
    if (!this.#deferredCollection) {
      this.#deferredCollection = Promise.withResolvers();
      this.sendQuery("PageData:Collect").then(
        this.#deferredCollection.resolve,
        this.#deferredCollection.reject
      );
    }

    return this.#deferredCollection.promise;
  }

  /**
   * Called when the page is destroyed.
   */
  didDestroy() {
    this.#deferredCollection?.resolve(null);
  }

  /**
   * Called when a message is received from the content process.
   *
   * @param {ReceiveMessageArgument} msg
   *   The received message.
   */
  receiveMessage(msg) {
    switch (msg.name) {
      case "PageData:DocumentReady":
        lazy.PageDataService.pageLoaded(this, msg.data.url);
        break;
    }
  }
}