|
| 1 | +import { describe, it, expect } from 'vitest' |
| 2 | +import fs from 'fs' |
| 3 | +import path from 'path' |
| 4 | +import parser from 'socket.io-parser' |
| 5 | +import { hasBinary } from 'socket.io-parser/dist/is-binary' |
| 6 | +// @ts-expect-error |
| 7 | +import pkg from '../package.json' |
| 8 | +import lib from '../index' |
| 9 | +import * as browserLib from '../lib/browser' |
| 10 | +import resolvePkg from 'resolve-pkg' |
| 11 | + |
| 12 | +const { PacketType } = parser |
| 13 | + |
| 14 | +describe('Socket', function () { |
| 15 | + it('exports server', function () { |
| 16 | + expect(lib.server).toBeDefined() |
| 17 | + }) |
| 18 | + |
| 19 | + it('exports client from lib/browser', function () { |
| 20 | + expect(browserLib.client).toBeDefined() |
| 21 | + }) |
| 22 | + |
| 23 | + it('exports createWebSocket from lib/browser', function () { |
| 24 | + expect(browserLib.createWebsocket).toBeDefined() |
| 25 | + }) |
| 26 | + |
| 27 | + it('creates a websocket for non chromium and non webkit browsers', function () { |
| 28 | + const socket = browserLib.createWebsocket({ path: '/path', browserFamily: 'firefox' }) |
| 29 | + |
| 30 | + // @ts-expect-error |
| 31 | + expect(socket.io.opts.path).toEqual('/path') |
| 32 | + // @ts-expect-error |
| 33 | + expect(socket.io.opts.transports[0]).toEqual('websocket') |
| 34 | + }) |
| 35 | + |
| 36 | + it('creates a websocket for chromium browsers', function () { |
| 37 | + // @ts-expect-error |
| 38 | + global.window = {} |
| 39 | + const socket = browserLib.createWebsocket({ path: '/path', browserFamily: 'chromium' }) |
| 40 | + |
| 41 | + // @ts-expect-error |
| 42 | + expect(socket._namespace).toEqual('/path/default') |
| 43 | + }) |
| 44 | + |
| 45 | + it('creates a websocket for webkit browsers', function () { |
| 46 | + const socket = browserLib.createWebsocket({ path: '/path', browserFamily: 'webkit' }) |
| 47 | + |
| 48 | + // @ts-expect-error |
| 49 | + expect(socket.io.opts.path).toEqual('/path') |
| 50 | + // @ts-expect-error |
| 51 | + expect(socket.io.opts.transports[0]).toEqual('polling') |
| 52 | + }) |
| 53 | + |
| 54 | + describe('.getPathToClientSource', function () { |
| 55 | + it('returns path to socket.io.js', function () { |
| 56 | + const clientPath = path.join(resolvePkg('socket.io-client'), 'dist', 'socket.io.js') |
| 57 | + |
| 58 | + expect(lib.getPathToClientSource()).toEqual(clientPath) |
| 59 | + }) |
| 60 | + |
| 61 | + it('makes sure socket.io.js actually exists', function () { |
| 62 | + return new Promise((resolve, reject) => { |
| 63 | + fs.stat(lib.getPathToClientSource(), (err, stats) => { |
| 64 | + if (err) { |
| 65 | + reject(err) |
| 66 | + } else { |
| 67 | + resolve(stats) |
| 68 | + } |
| 69 | + }) |
| 70 | + }) |
| 71 | + }) |
| 72 | + }) |
| 73 | + |
| 74 | + describe('.getClientVersion', function () { |
| 75 | + it('returns client version', function () { |
| 76 | + expect(lib.getClientVersion()).toEqual(pkg.dependencies['socket.io-client']) |
| 77 | + }) |
| 78 | + }) |
| 79 | + |
| 80 | + describe('blob encoding + decoding', () => { |
| 81 | + it('correctly encodes and decodes binary blob data', () => { |
| 82 | + const encoder = new parser.Encoder() |
| 83 | + |
| 84 | + const obj = { |
| 85 | + type: PacketType.EVENT, |
| 86 | + data: ['a', Buffer.from('abc', 'utf8')], |
| 87 | + // data: ['a', { foo: 'bar' }], |
| 88 | + id: 23, |
| 89 | + nsp: '/cool', |
| 90 | + } |
| 91 | + |
| 92 | + const originalData = obj.data |
| 93 | + |
| 94 | + const encodedPackets = encoder.encode(obj) |
| 95 | + |
| 96 | + const decoder = new parser.Decoder() |
| 97 | + |
| 98 | + return new Promise<void>((resolve) => { |
| 99 | + decoder.on('decoded', (packet) => { |
| 100 | + obj.data = originalData |
| 101 | + // @ts-expect-error |
| 102 | + obj.attachments = undefined |
| 103 | + expect(packet).toEqual(obj) |
| 104 | + resolve() |
| 105 | + }) |
| 106 | + |
| 107 | + for (let i = 0; i < encodedPackets.length; i++) { |
| 108 | + decoder.add(encodedPackets[i]) |
| 109 | + } |
| 110 | + }) |
| 111 | + }) |
| 112 | + |
| 113 | + it('correctly encodes and decodes circular data', () => { |
| 114 | + const encoder = new parser.Encoder() |
| 115 | + |
| 116 | + const circularObj = { |
| 117 | + foo: {}, |
| 118 | + } |
| 119 | + |
| 120 | + // @ts-expect-error |
| 121 | + circularObj.foo.circularObj = circularObj |
| 122 | + |
| 123 | + const obj = { |
| 124 | + type: PacketType.EVENT, |
| 125 | + data: ['a', circularObj], |
| 126 | + id: 23, |
| 127 | + nsp: '/cool', |
| 128 | + } |
| 129 | + |
| 130 | + const originalData = obj.data |
| 131 | + |
| 132 | + const encodedPackets = encoder.encode(obj) |
| 133 | + |
| 134 | + const decoder = new parser.Decoder() |
| 135 | + |
| 136 | + return new Promise<void>((resolve) => { |
| 137 | + decoder.on('decoded', (packet) => { |
| 138 | + obj.data = originalData |
| 139 | + expect(packet.data[1] === packet.data[1].foo.circularObj).toBe(true) |
| 140 | + expect(packet).toEqual(obj) |
| 141 | + resolve() |
| 142 | + }) |
| 143 | + |
| 144 | + for (let i = 0; i < encodedPackets.length; i++) { |
| 145 | + decoder.add(encodedPackets[i]) |
| 146 | + } |
| 147 | + }) |
| 148 | + }) |
| 149 | + |
| 150 | + it('correctly encodes and decodes circular data in array', () => { |
| 151 | + const encoder = new parser.Encoder() |
| 152 | + |
| 153 | + const circularObj = { |
| 154 | + foo: {}, |
| 155 | + } |
| 156 | + |
| 157 | + // @ts-expect-error |
| 158 | + circularObj.foo.circularArray = [circularObj, circularObj] |
| 159 | + |
| 160 | + const obj = { |
| 161 | + type: PacketType.EVENT, |
| 162 | + data: ['a', circularObj], |
| 163 | + id: 23, |
| 164 | + nsp: '/cool', |
| 165 | + } |
| 166 | + |
| 167 | + const originalData = obj.data |
| 168 | + |
| 169 | + const encodedPackets = encoder.encode(obj) |
| 170 | + |
| 171 | + const decoder = new parser.Decoder() |
| 172 | + |
| 173 | + return new Promise<void>((resolve) => { |
| 174 | + decoder.on('decoded', (packet) => { |
| 175 | + obj.data = originalData |
| 176 | + expect(packet.data[1] === packet.data[1].foo.circularArray[0]).toBe(true) |
| 177 | + expect(packet.data[1] === packet.data[1].foo.circularArray[1]).toBe(true) |
| 178 | + expect(packet).toEqual(obj) |
| 179 | + resolve() |
| 180 | + }) |
| 181 | + |
| 182 | + for (let i = 0; i < encodedPackets.length; i++) { |
| 183 | + decoder.add(encodedPackets[i]) |
| 184 | + } |
| 185 | + }) |
| 186 | + }) |
| 187 | + |
| 188 | + it('correctly encodes and decodes circular data containing binary', () => { |
| 189 | + const encoder = new parser.Encoder() |
| 190 | + |
| 191 | + const circularObj = { |
| 192 | + foo: {}, |
| 193 | + bin: Buffer.from('abc', 'utf8'), |
| 194 | + } |
| 195 | + |
| 196 | + // @ts-expect-error |
| 197 | + circularObj.foo.circularObj = circularObj |
| 198 | + |
| 199 | + const obj = { |
| 200 | + type: PacketType.EVENT, |
| 201 | + data: ['a', circularObj], |
| 202 | + id: 23, |
| 203 | + nsp: '/cool', |
| 204 | + } |
| 205 | + |
| 206 | + const originalData = obj.data |
| 207 | + |
| 208 | + const encodedPackets = encoder.encode(obj) |
| 209 | + |
| 210 | + const decoder = new parser.Decoder() |
| 211 | + |
| 212 | + return new Promise<void>((resolve) => { |
| 213 | + decoder.on('decoded', (packet) => { |
| 214 | + obj.data = originalData |
| 215 | + // @ts-expect-error |
| 216 | + obj.attachments = undefined |
| 217 | + expect(packet.data[1] === packet.data[1].foo.circularObj).toBe(true) |
| 218 | + expect(packet).toEqual(obj) |
| 219 | + resolve() |
| 220 | + }) |
| 221 | + |
| 222 | + for (let i = 0; i < encodedPackets.length; i++) { |
| 223 | + decoder.add(encodedPackets[i]) |
| 224 | + } |
| 225 | + }) |
| 226 | + }) |
| 227 | + |
| 228 | + it('correctly encodes and decodes binary data with objs with no prototype', () => { |
| 229 | + const encoder = new parser.Encoder() |
| 230 | + |
| 231 | + const noProtoObj = Object.create(null) |
| 232 | + |
| 233 | + noProtoObj.foo = 'foo' |
| 234 | + |
| 235 | + const obj = { |
| 236 | + type: PacketType.EVENT, |
| 237 | + data: ['a', noProtoObj, Buffer.from('123', 'utf8')], |
| 238 | + id: 23, |
| 239 | + nsp: '/cool', |
| 240 | + } |
| 241 | + |
| 242 | + const originalData = obj.data |
| 243 | + |
| 244 | + const encodedPackets = encoder.encode(obj) |
| 245 | + |
| 246 | + const decoder = new parser.Decoder() |
| 247 | + |
| 248 | + return new Promise<void>((resolve) => { |
| 249 | + decoder.on('decoded', (packet) => { |
| 250 | + obj.data = originalData |
| 251 | + // @ts-expect-error |
| 252 | + obj.attachments = undefined |
| 253 | + expect(packet).toEqual(obj) |
| 254 | + resolve() |
| 255 | + }) |
| 256 | + |
| 257 | + for (let i = 0; i < encodedPackets.length; i++) { |
| 258 | + decoder.add(encodedPackets[i]) |
| 259 | + } |
| 260 | + }) |
| 261 | + }) |
| 262 | + }) |
| 263 | + |
| 264 | + describe('hasBinary', () => { |
| 265 | + it('hasBinary handles binary data in toJSON()', () => { |
| 266 | + const x = { |
| 267 | + toJSON () { |
| 268 | + return Buffer.from('123', 'utf8') |
| 269 | + }, |
| 270 | + } |
| 271 | + |
| 272 | + const data = ['a', x] |
| 273 | + |
| 274 | + expect(hasBinary(data)).toBe(true) |
| 275 | + }) |
| 276 | + }) |
| 277 | +}) |
0 commit comments