summaryrefslogtreecommitdiffstats
path: root/remote/cdp/StreamRegistry.sys.mjs
blob: 9474f16a57ea2eb0a0ba2af509c22e4aeda98dd7 (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
/* 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, {
  generateUUID: "chrome://remote/content/shared/UUID.sys.mjs",
  UnsupportedError: "chrome://remote/content/cdp/Error.sys.mjs",
});

export class Stream {
  #path;
  #offset;
  #length;

  constructor(path) {
    this.#path = path;
    this.#offset = 0;
    this.#length = null;
  }

  async destroy() {
    await IOUtils.remove(this.#path);
  }

  async seek(seekTo) {
    // To keep compatibility with Chrome clip invalid offsets
    this.#offset = Math.max(0, Math.min(seekTo, await this.length()));
  }

  async readBytes(count) {
    const bytes = await IOUtils.read(this.#path, {
      offset: this.#offset,
      maxBytes: count,
    });
    this.#offset += bytes.length;
    return bytes;
  }

  async available() {
    const length = await this.length();
    return length - this.#offset;
  }

  async length() {
    if (this.#length === null) {
      const info = await IOUtils.stat(this.#path);
      this.#length = info.size;
    }

    return this.#length;
  }

  get path() {
    return this.#path;
  }
}

export class StreamRegistry {
  constructor() {
    // handle => stream
    this.streams = new Map();

    // Register an async shutdown blocker to ensure all open IO streams are
    // closed, and remaining temporary files removed. Needs to happen before
    // IOUtils has been shutdown.
    IOUtils.profileBeforeChange.addBlocker(
      "Remote Agent: Clean-up of open streams",
      async () => {
        await this.destructor();
      }
    );
  }

  async destructor() {
    for (const stream of this.streams.values()) {
      await stream.destroy();
    }

    this.streams.clear();
  }

  /**
   * Add a new stream to the registry.
   *
   * @param {Stream} stream
   *      The stream to use.
   *
   * @returns {string}
   *     Stream handle (uuid)
   */
  add(stream) {
    if (!(stream instanceof Stream)) {
      // Bug 1602731 - Implement support for blob
      throw new lazy.UnsupportedError(`Unknown stream type for ${stream}`);
    }

    const handle = lazy.generateUUID();

    this.streams.set(handle, stream);
    return handle;
  }

  /**
   * Get a stream from the registry.
   *
   * @param {string} handle
   *      Handle of the stream to retrieve.
   *
   * @returns {Stream}
   *      The requested stream.
   */
  get(handle) {
    const stream = this.streams.get(handle);

    if (!stream) {
      throw new TypeError(`Invalid stream handle`);
    }

    return stream;
  }

  /**
   * Remove a stream from the registry.
   *
   * @param {string} handle
   *      Handle of the stream to remove.
   *
   * @returns {boolean}
   *     true if successfully removed
   */
  async remove(handle) {
    const stream = this.get(handle);
    await stream.destroy();

    return this.streams.delete(handle);
  }
}