|
3 | 3 | * SPDX-License-Identifier: Apache-2.0 |
4 | 4 | */ |
5 | 5 | import { globalScope } from '../constants/runtime' |
6 | | -import { now } from '../timing/now' |
7 | | -import { checkState } from '../window/load' |
| 6 | +import { handle } from '../event-emitter/handle' |
8 | 7 | import { generateRandomHexString } from '../ids/unique-id' |
| 8 | +import { now } from '../timing/now' |
9 | 9 | import { gosNREUMOriginals } from '../window/nreum' |
10 | 10 |
|
11 | | -export const WEBSOCKET_TAG = 'websocket-' |
12 | | -export const ADD_EVENT_LISTENER_TAG = 'addEventListener' |
13 | | - |
14 | 11 | const wrapped = {} |
| 12 | +const subscribedFeatures = [] |
15 | 13 |
|
16 | | -export function wrapWebSocket (sharedEE) { |
17 | | - if (wrapped[sharedEE.debugId]++) return sharedEE |
| 14 | +export function wrapWebSocket (sharedEE, callerFeature) { |
18 | 15 | const originals = gosNREUMOriginals().o |
19 | 16 | if (!originals.WS) return sharedEE |
20 | 17 |
|
21 | | - function reporter (socketId) { |
22 | | - const createdAt = now() |
23 | | - return function (message, ...data) { |
24 | | - const timestamp = data[0]?.timeStamp || now() |
25 | | - const isLoaded = checkState() |
26 | | - sharedEE.emit(WEBSOCKET_TAG + message, [timestamp, timestamp - createdAt, isLoaded, socketId, ...data]) |
27 | | - } |
28 | | - } |
| 18 | + if (callerFeature) subscribedFeatures.push(callerFeature) // regardless if WS is already wrapped or not, set feat up for future event from this wrapping |
| 19 | + const wsEE = sharedEE.get('websockets') |
| 20 | + if (wrapped[wsEE.debugId]++) return wsEE |
| 21 | + wrapped[wsEE.debugId] = 1 // otherwise, first feature to wrap events |
29 | 22 |
|
30 | 23 | class WrappedWebSocket extends WebSocket { |
31 | 24 | static name = 'WebSocket' |
| 25 | + static toString () { // fake native WebSocket when static class is stringified |
| 26 | + return 'function WebSocket() { [native code] }' |
| 27 | + } |
| 28 | + |
| 29 | + toString () { // fake [object WebSocket] when instance is stringified |
| 30 | + return '[object WebSocket]' |
| 31 | + } |
| 32 | + |
| 33 | + get [Symbol.toStringTag] () { // fake [object WebSocket] when Object.prototype.toString.call is used on instance |
| 34 | + return WrappedWebSocket.name |
| 35 | + } |
| 36 | + |
| 37 | + // Private method to tag send, close, and event listener errors with WebSocket ID for JSErrors feature |
| 38 | + #tagError (error) { |
| 39 | + ;(error.__newrelic ??= {}).socketId = this.nrData.socketId |
| 40 | + this.nrData.hasErrors ??= true |
| 41 | + } |
32 | 42 |
|
33 | 43 | constructor (...args) { |
34 | 44 | super(...args) |
35 | | - const socketId = generateRandomHexString(6) |
36 | | - this.report = reporter(socketId) |
37 | | - this.report('new') |
38 | | - |
39 | | - const events = ['message', 'error', 'open', 'close'] |
40 | | - /** add event listeners */ |
41 | | - events.forEach(evt => { |
42 | | - this.addEventListener(evt, function (e) { |
43 | | - this.report(ADD_EVENT_LISTENER_TAG, { eventType: evt, event: e }) |
| 45 | + this.nrData = { |
| 46 | + timestamp: now(), // this will be time corrected later when timeKeeper is avail |
| 47 | + currentUrl: window.location.href, |
| 48 | + socketId: generateRandomHexString(8), |
| 49 | + requestedUrl: args[0], |
| 50 | + requestedProtocols: Array.isArray(args[1]) ? args[1].join(',') : (args[1] || '') |
| 51 | + // pageUrl will be set by addEvent later; unlike timestamp and currentUrl, it's not sensitive to *when* it is set |
| 52 | + } |
| 53 | + |
| 54 | + this.addEventListener('open', () => { |
| 55 | + this.nrData.openedAt = now() |
| 56 | + ;['protocol', 'extensions', 'binaryType'].forEach(prop => { |
| 57 | + this.nrData[prop] = this[prop] |
44 | 58 | }) |
45 | 59 | }) |
| 60 | + |
| 61 | + this.addEventListener('message', (event) => { |
| 62 | + const { type, size } = getDataInfo(event.data) |
| 63 | + this.nrData.messageOrigin ??= event.origin // the origin of messages thru WS lifetime cannot be changed, so set once is sufficient |
| 64 | + this.nrData.messageCount = (this.nrData.messageCount ?? 0) + 1 |
| 65 | + this.nrData.messageBytes = (this.nrData.messageBytes ?? 0) + size |
| 66 | + this.nrData.messageBytesMin = Math.min(this.nrData.messageBytesMin ?? Infinity, size) |
| 67 | + this.nrData.messageBytesMax = Math.max(this.nrData.messageBytesMax ?? 0, size) |
| 68 | + if (!(this.nrData.messageTypes ?? '').includes(type)) { |
| 69 | + this.nrData.messageTypes = this.nrData.messageTypes ? `${this.nrData.messageTypes},${type}` : type |
| 70 | + } |
| 71 | + }) |
| 72 | + |
| 73 | + this.addEventListener('close', (event) => { |
| 74 | + this.nrData.closedAt = now() |
| 75 | + this.nrData.closeCode = event.code |
| 76 | + this.nrData.closeReason = event.reason |
| 77 | + this.nrData.closeWasClean = event.wasClean |
| 78 | + this.nrData.connectedDuration = this.nrData.closedAt - this.nrData.openedAt |
| 79 | + |
| 80 | + subscribedFeatures.forEach(featureName => handle('ws-complete', [this.nrData], this, featureName, wsEE)) |
| 81 | + }) |
| 82 | + } |
| 83 | + |
| 84 | + addEventListener (type, listener, ...rest) { |
| 85 | + const wsInstance = this |
| 86 | + const wrappedListener = typeof listener === 'function' |
| 87 | + ? function (...args) { |
| 88 | + try { |
| 89 | + return listener.apply(this, args) |
| 90 | + } catch (error) { |
| 91 | + wsInstance.#tagError(error) |
| 92 | + throw error |
| 93 | + } |
| 94 | + } |
| 95 | + : listener?.handleEvent |
| 96 | + ? { // case for listener === object with handleEvent |
| 97 | + handleEvent: function (...args) { |
| 98 | + try { |
| 99 | + return listener.handleEvent.apply(listener, args) |
| 100 | + } catch (error) { |
| 101 | + wsInstance.#tagError(error) |
| 102 | + throw error |
| 103 | + } |
| 104 | + } |
| 105 | + } |
| 106 | + : listener // case for listener === null |
| 107 | + return super.addEventListener(type, wrappedListener, ...rest) |
46 | 108 | } |
47 | 109 |
|
48 | | - send (...args) { |
49 | | - this.report('send', ...args) |
| 110 | + send (data) { |
| 111 | + // Only track metrics if the connection is OPEN; data sent in CONNECTING state throws, and data sent in CLOSING/CLOSED states is silently discarded |
| 112 | + if (this.readyState === WebSocket.OPEN) { |
| 113 | + const { type, size } = getDataInfo(data) |
| 114 | + this.nrData.sendCount = (this.nrData.sendCount ?? 0) + 1 |
| 115 | + this.nrData.sendBytes = (this.nrData.sendBytes ?? 0) + size |
| 116 | + this.nrData.sendBytesMin = Math.min(this.nrData.sendBytesMin ?? Infinity, size) |
| 117 | + this.nrData.sendBytesMax = Math.max(this.nrData.sendBytesMax ?? 0, size) |
| 118 | + if (!(this.nrData.sendTypes ?? '').includes(type)) { |
| 119 | + this.nrData.sendTypes = this.nrData.sendTypes ? `${this.nrData.sendTypes},${type}` : type |
| 120 | + } |
| 121 | + } |
50 | 122 | try { |
51 | | - return super.send(...args) |
52 | | - } catch (err) { |
53 | | - this.report('send-err', ...args) |
54 | | - throw err |
| 123 | + return super.send(data) |
| 124 | + } catch (error) { |
| 125 | + this.#tagError(error) |
| 126 | + throw error |
| 127 | + } |
| 128 | + } |
| 129 | + |
| 130 | + close (...args) { |
| 131 | + try { |
| 132 | + super.close(...args) |
| 133 | + } catch (error) { |
| 134 | + this.#tagError(error) |
| 135 | + throw error |
55 | 136 | } |
56 | 137 | } |
57 | 138 | } |
58 | 139 |
|
59 | 140 | globalScope.WebSocket = WrappedWebSocket |
60 | | - return sharedEE |
| 141 | + return wsEE |
| 142 | +} |
| 143 | + |
| 144 | +/** |
| 145 | + * Returns the data type and size of the WebSocket send data |
| 146 | + * @param {*} data - The data being sent |
| 147 | + * @returns {{ type: string, size: number }} - The type name and size in bytes |
| 148 | + */ |
| 149 | +function getDataInfo (data) { |
| 150 | + if (typeof data === 'string') { |
| 151 | + return { |
| 152 | + type: 'string', |
| 153 | + size: new TextEncoder().encode(data).length // efficient way to calculate the # of UTF-8 bytes that WS sends (cannot use string length) |
| 154 | + } |
| 155 | + } |
| 156 | + if (data instanceof ArrayBuffer) { |
| 157 | + return { type: 'ArrayBuffer', size: data.byteLength } |
| 158 | + } |
| 159 | + if (data instanceof Blob) { |
| 160 | + return { type: 'Blob', size: data.size } |
| 161 | + } |
| 162 | + if (data instanceof DataView) { |
| 163 | + return { type: 'DataView', size: data.byteLength } |
| 164 | + } |
| 165 | + if (ArrayBuffer.isView(data)) { |
| 166 | + return { type: 'TypedArray', size: data.byteLength } |
| 167 | + } |
| 168 | + return { type: 'unknown', size: 0 } |
61 | 169 | } |
0 commit comments