summaryrefslogtreecommitdiffstats
path: root/devtools/server/actors/resources/websockets.js
blob: 5845357a9ce3ac5573a2edee20b1e2ee2a55c21f (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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
/* 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/. */

"use strict";

const {
  LongStringActor,
} = require("resource://devtools/server/actors/string.js");

const {
  TYPES: { WEBSOCKET },
} = require("resource://devtools/server/actors/resources/index.js");

const webSocketEventService = Cc[
  "@mozilla.org/websocketevent/service;1"
].getService(Ci.nsIWebSocketEventService);

class WebSocketWatcher {
  constructor() {
    this.windowIds = new Set();
    // Maintains a map of all the connection channels per websocket
    // The map item is keyed on the `webSocketSerialID` and stores
    // the `httpChannelId` as value.
    this.connections = new Map();
    this.onWindowReady = this.onWindowReady.bind(this);
    this.onWindowDestroy = this.onWindowDestroy.bind(this);
  }

  static createResource(wsMessageType, eventParams) {
    return {
      resourceType: WEBSOCKET,
      wsMessageType,
      ...eventParams,
    };
  }

  static prepareFramePayload(targetActor, frame) {
    const payload = new LongStringActor(targetActor.conn, frame.payload);
    targetActor.manage(payload);
    return payload.form();
  }

  watch(targetActor, { onAvailable }) {
    this.targetActor = targetActor;
    this.onAvailable = onAvailable;

    for (const window of this.targetActor.windows) {
      const { innerWindowId } = window.windowGlobalChild;
      this.startListening(innerWindowId);
    }

    // On navigate/reload we should re-start listening with the
    // new `innerWindowID`
    this.targetActor.on("window-ready", this.onWindowReady);
    this.targetActor.on("window-destroyed", this.onWindowDestroy);
  }

  onWindowReady({ window }) {
    if (!this.targetActor.followWindowGlobalLifeCycle) {
      const { innerWindowId } = window.windowGlobalChild;
      this.startListening(innerWindowId);
    }
  }

  onWindowDestroy({ id }) {
    this.stopListening(id);
  }

  startListening(innerWindowId) {
    if (!this.windowIds.has(innerWindowId)) {
      this.windowIds.add(innerWindowId);
      webSocketEventService.addListener(innerWindowId, this);
    }
  }

  stopListening(innerWindowId) {
    if (this.windowIds.has(innerWindowId)) {
      this.windowIds.delete(innerWindowId);
      if (!webSocketEventService.hasListenerFor(innerWindowId)) {
        // The listener might have already been cleaned up on `window-destroy`.
        console.warn(
          "Already stopped listening to websocket events for this window."
        );
        return;
      }
      webSocketEventService.removeListener(innerWindowId, this);
    }
  }

  destroy() {
    for (const id of this.windowIds) {
      this.stopListening(id);
    }
    this.targetActor.off("window-ready", this.onWindowReady);
    this.targetActor.off("window-destroyed", this.onWindowDestroy);
  }

  // methods for the nsIWebSocketEventService
  webSocketCreated(webSocketSerialID, uri, protocols) {}

  webSocketOpened(
    webSocketSerialID,
    effectiveURI,
    protocols,
    extensions,
    httpChannelId
  ) {
    this.connections.set(webSocketSerialID, httpChannelId);
    const resource = WebSocketWatcher.createResource("webSocketOpened", {
      httpChannelId,
      effectiveURI,
      protocols,
      extensions,
    });

    this.onAvailable([resource]);
  }

  webSocketMessageAvailable(webSocketSerialID, data, messageType) {}

  webSocketClosed(webSocketSerialID, wasClean, code, reason) {
    const httpChannelId = this.connections.get(webSocketSerialID);
    this.connections.delete(webSocketSerialID);

    const resource = WebSocketWatcher.createResource("webSocketClosed", {
      httpChannelId,
      wasClean,
      code,
      reason,
    });

    this.onAvailable([resource]);
  }

  frameReceived(webSocketSerialID, frame) {
    const httpChannelId = this.connections.get(webSocketSerialID);
    if (!httpChannelId) {
      return;
    }

    const payload = WebSocketWatcher.prepareFramePayload(
      this.targetActor,
      frame
    );
    const resource = WebSocketWatcher.createResource("frameReceived", {
      httpChannelId,
      data: {
        type: "received",
        payload,
        timeStamp: frame.timeStamp,
        finBit: frame.finBit,
        rsvBit1: frame.rsvBit1,
        rsvBit2: frame.rsvBit2,
        rsvBit3: frame.rsvBit3,
        opCode: frame.opCode,
        mask: frame.mask,
        maskBit: frame.maskBit,
      },
    });

    this.onAvailable([resource]);
  }

  frameSent(webSocketSerialID, frame) {
    const httpChannelId = this.connections.get(webSocketSerialID);

    if (!httpChannelId) {
      return;
    }

    const payload = WebSocketWatcher.prepareFramePayload(
      this.targetActor,
      frame
    );
    const resource = WebSocketWatcher.createResource("frameSent", {
      httpChannelId,
      data: {
        type: "sent",
        payload,
        timeStamp: frame.timeStamp,
        finBit: frame.finBit,
        rsvBit1: frame.rsvBit1,
        rsvBit2: frame.rsvBit2,
        rsvBit3: frame.rsvBit3,
        opCode: frame.opCode,
        mask: frame.mask,
        maskBit: frame.maskBit,
      },
    });

    this.onAvailable([resource]);
  }
}

module.exports = WebSocketWatcher;