summaryrefslogtreecommitdiffstats
path: root/remote/webdriver-bidi/modules/WindowGlobalBiDiModule.sys.mjs
blob: 025ce5f4abd1b98c0cf679e5a2262a34562add31 (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
/* 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/. */

import { Module } from "chrome://remote/content/shared/messagehandler/Module.sys.mjs";

const lazy = {};

ChromeUtils.defineESModuleGetters(lazy, {
  deserialize: "chrome://remote/content/webdriver-bidi/RemoteValue.sys.mjs",
  serialize: "chrome://remote/content/webdriver-bidi/RemoteValue.sys.mjs",
});

/**
 * Base class for all WindowGlobal BiDi MessageHandler modules.
 */
export class WindowGlobalBiDiModule extends Module {
  get #nodeCache() {
    return this.#processActor.getNodeCache();
  }

  get #processActor() {
    return ChromeUtils.domProcessChild.getActor("WebDriverProcessData");
  }

  /**
   * Wrapper to deserialize a local / remote value.
   *
   * @param {object} serializedValue
   *     Value of any type to be deserialized.
   * @param {Realm} realm
   *     The Realm in which the value is deserialized.
   * @param {ExtraSerializationOptions=} extraOptions
   *     Extra Remote Value deserialization options.
   *
   * @returns {object}
   *     Deserialized representation of the value.
   */
  deserialize(serializedValue, realm, extraOptions = {}) {
    extraOptions.nodeCache = this.#nodeCache;

    return lazy.deserialize(serializedValue, realm, extraOptions);
  }

  /**
   * Wrapper to serialize a value as a remote value.
   *
   * @param {object} value
   *     Value of any type to be serialized.
   * @param {SerializationOptions} serializationOptions
   *     Options which define how ECMAScript objects should be serialized.
   * @param {OwnershipModel} ownershipType
   *     The ownership model to use for this serialization.
   * @param {Realm} realm
   *     The Realm from which comes the value being serialized.
   * @param {ExtraSerializationOptions} extraOptions
   *     Extra Remote Value serialization options.
   *
   * @returns {object}
   *     Promise that resolves to the serialized representation of the value.
   */
  serialize(
    value,
    serializationOptions,
    ownershipType,
    realm,
    extraOptions = {}
  ) {
    const { nodeCache = this.#nodeCache, seenNodeIds = new Map() } =
      extraOptions;

    const serializedValue = lazy.serialize(
      value,
      serializationOptions,
      ownershipType,
      new Map(),
      realm,
      { nodeCache, seenNodeIds }
    );

    return serializedValue;
  }
}