odac 1.4.15 → 1.4.17

package/test/View/Image/serve.test.js

@@ -1,21 +1,26 @@
 const fs = require('fs')
 const fsPromises = fs.promises
+const os = require('os')
 const path = require('path')
 const Image = require('../../../src/View/Image')
 
-const IMG_CACHE_DIR = './storage/.cache/img'
-
 describe('Image.serve()', () => {
   const testFilename = 'testserve1234567.webp'
-  const testFilePath = path.join(IMG_CACHE_DIR, testFilename)
+  let tmpDir, IMG_CACHE_DIR, testFilePath
 
   beforeAll(async () => {
+    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'odac-image-serve-'))
+    global.__dir = tmpDir
+    IMG_CACHE_DIR = path.join(tmpDir, 'storage/.cache/img')
+    testFilePath = path.join(IMG_CACHE_DIR, testFilename)
+
     await fsPromises.mkdir(IMG_CACHE_DIR, {recursive: true})
     await fsPromises.writeFile(testFilePath, Buffer.from('fake-image-data'))
   })
 
   afterAll(async () => {
-    await fsPromises.unlink(testFilePath).catch(() => {})
+    delete global.__dir
+    await fsPromises.rm(tmpDir, {recursive: true, force: true})
   })
 
   test('should return stream, type, and size for a cached file', async () => {

package/test/View/Image/url.test.js

@@ -1,20 +1,26 @@
 const fs = require('fs')
 const fsPromises = fs.promises
+const os = require('os')
 const path = require('path')
 const Image = require('../../../src/View/Image')
 
 describe('Image.url()', () => {
-  const publicDir = path.join(process.cwd(), 'public')
-  const testImageDir = path.join(publicDir, 'images')
-  const testImagePath = path.join(testImageDir, 'url-test.jpg')
+  let tmpDir, testImagePath
 
   beforeAll(async () => {
+    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'odac-image-url-'))
+    global.__dir = tmpDir
+
+    const testImageDir = path.join(tmpDir, 'public', 'images')
+    testImagePath = path.join(testImageDir, 'url-test.jpg')
+
     await fsPromises.mkdir(testImageDir, {recursive: true})
     await fsPromises.writeFile(testImagePath, Buffer.from('fake-jpg-data'))
   })
 
   afterAll(async () => {
-    await fsPromises.unlink(testImagePath).catch(() => {})
+    delete global.__dir
+    await fsPromises.rm(tmpDir, {recursive: true, force: true})
   })
 
   test('should return empty string for empty src', async () => {

package/test/View/addNavigateAttribute.test.js

@@ -1,13 +1,20 @@
 const fs = require('fs').promises
+const fsSync = require('fs')
+const os = require('os')
 const path = require('path')
 const View = require('../../src/View')
 
 describe('View.#addNavigateAttribute()', () => {
   let view
   let mockOdac
+  let tmpDir
+  let originalCwd
 
   beforeEach(() => {
-    global.__dir = path.resolve(__dirname, '../../')
+    tmpDir = fsSync.mkdtempSync(path.join(os.tmpdir(), 'odac-view-navattr-'))
+    global.__dir = tmpDir
+    originalCwd = process.cwd()
+    process.chdir(tmpDir)
     mockOdac = {
       Config: {view: {earlyHints: {enabled: false}}},
       View: {},
@@ -28,6 +35,8 @@ describe('View.#addNavigateAttribute()', () => {
   afterEach(() => {
     jest.restoreAllMocks()
     delete global.__dir
+    process.chdir(originalCwd)
+    fsSync.rmSync(tmpDir, {recursive: true, force: true})
   })
 
   it('should not wrap placeholder in display:contents if it is the first child of an element', async () => {

package/test/View/print.test.js

@@ -1,13 +1,20 @@
 const fs = require('fs').promises
+const fsSync = require('fs')
+const os = require('os')
 const path = require('path')
 const View = require('../../src/View')
 
 describe('View.print()', () => {
   let view
   let mockOdac
+  let tmpDir
+  let originalCwd
 
   beforeEach(() => {
-    global.__dir = path.resolve(__dirname, '../../')
+    tmpDir = fsSync.mkdtempSync(path.join(os.tmpdir(), 'odac-view-print-'))
+    global.__dir = tmpDir
+    originalCwd = process.cwd()
+    process.chdir(tmpDir)
     mockOdac = {
       Config: {view: {earlyHints: {enabled: false}}},
       View: {},
@@ -28,6 +35,8 @@ describe('View.print()', () => {
   afterEach(() => {
     jest.restoreAllMocks()
     delete global.__dir
+    process.chdir(originalCwd)
+    fsSync.rmSync(tmpDir, {recursive: true, force: true})
   })
 
   it('should be a function', () => {

package/test/WebSocket/Client/fragmentation.test.js

@@ -31,6 +31,25 @@ function createMockSocket() {
   }
 }
 
+const openClients = []
+
+/**
+ * Creates a client and registers it for teardown.
+ *
+ * The constructor starts a rate-limit interval that is only cleared on close(),
+ * so a client left open keeps Jest's event loop alive after the run finishes.
+ */
+function createClient(...args) {
+  const client = new WebSocketClient(...args)
+  openClients.push(client)
+  return client
+}
+
+afterEach(() => {
+  for (const client of openClients) client.close()
+  openClients.length = 0
+})
+
 describe('WebSocketClient Fragmentation', () => {
   let server
 
@@ -40,7 +59,7 @@ describe('WebSocketClient Fragmentation', () => {
 
   it('should reassemble fragmented text messages', () => {
     const socket = createMockSocket()
-    const client = new WebSocketClient(socket, server, 'frag-1')
+    const client = createClient(socket, server, 'frag-1')
     client.resume()
 
     const messages = []
@@ -60,7 +79,7 @@ describe('WebSocketClient Fragmentation', () => {
 
   it('should reassemble fragmented binary messages', () => {
     const socket = createMockSocket()
-    const client = new WebSocketClient(socket, server, 'frag-2')
+    const client = createClient(socket, server, 'frag-2')
     client.resume()
 
     const messages = []
@@ -83,7 +102,7 @@ describe('WebSocketClient Fragmentation', () => {
 
   it('should close with 1002 on unexpected continuation frame', () => {
     const socket = createMockSocket()
-    const client = new WebSocketClient(socket, server, 'frag-3')
+    const client = createClient(socket, server, 'frag-3')
     client.resume()
 
     const dataHandler = socket.on.mock.calls.find(c => c[0] === 'data')[1]
@@ -96,7 +115,7 @@ describe('WebSocketClient Fragmentation', () => {
 
   it('should handle single unfragmented message normally', () => {
     const socket = createMockSocket()
-    const client = new WebSocketClient(socket, server, 'frag-4')
+    const client = createClient(socket, server, 'frag-4')
     client.resume()
 
     const messages = []
@@ -112,7 +131,7 @@ describe('WebSocketClient Fragmentation', () => {
 
   it('should discard fragment buffer on close', () => {
     const socket = createMockSocket()
-    const client = new WebSocketClient(socket, server, 'frag-5')
+    const client = createClient(socket, server, 'frag-5')
     client.resume()
 
     const messages = []

package/test/WebSocket/Client/limits.test.js

@@ -1,5 +1,24 @@
 const {WebSocketServer, WebSocketClient} = require('../../../src/WebSocket.js')
 
+const openClients = []
+
+/**
+ * Creates a client and registers it for teardown.
+ *
+ * The constructor starts a rate-limit interval that is only cleared on close(),
+ * so a client left open keeps Jest's event loop alive after the run finishes.
+ */
+function createClient(...args) {
+  const client = new WebSocketClient(...args)
+  openClients.push(client)
+  return client
+}
+
+afterEach(() => {
+  for (const client of openClients) client.close()
+  openClients.length = 0
+})
+
 describe('WebSocketClient Limits', () => {
   let server
 
@@ -18,7 +37,7 @@ describe('WebSocketClient Limits', () => {
         removeAllListeners: jest.fn(),
         writable: true
       }
-      const client = new WebSocketClient(socket, server, 'test-id', {maxPayload: 10})
+      const client = createClient(socket, server, 'test-id', {maxPayload: 10})
       client.resume()
 
       const buffer = Buffer.alloc(100)
@@ -42,7 +61,7 @@ describe('WebSocketClient Limits', () => {
         removeAllListeners: jest.fn(),
         writable: true
       }
-      const client = new WebSocketClient(socket, server, 'test-id', {rateLimit: {max: 2, window: 1000}})
+      const client = createClient(socket, server, 'test-id', {rateLimit: {max: 2, window: 1000}})
       client.resume()
 
       const buffer = Buffer.alloc(7)

package/test/WebSocket/Client/readyState.test.js

@@ -16,6 +16,25 @@ function createMockSocket() {
   }
 }
 
+const openClients = []
+
+/**
+ * Creates a client and registers it for teardown.
+ *
+ * The constructor starts a rate-limit interval that is only cleared on close(),
+ * so a client left open keeps Jest's event loop alive after the run finishes.
+ */
+function createClient(...args) {
+  const client = new WebSocketClient(...args)
+  openClients.push(client)
+  return client
+}
+
+afterEach(() => {
+  for (const client of openClients) client.close()
+  openClients.length = 0
+})
+
 describe('WebSocketClient readyState', () => {
   let server
 
@@ -41,13 +60,13 @@ describe('WebSocketClient readyState', () => {
 
   it('should start in CONNECTING state', () => {
     const socket = createMockSocket()
-    const client = new WebSocketClient(socket, server, 'rs-1')
+    const client = createClient(socket, server, 'rs-1')
     expect(client.readyState).toBe(READY_STATE.CONNECTING)
   })
 
   it('should transition to OPEN on resume()', () => {
     const socket = createMockSocket()
-    const client = new WebSocketClient(socket, server, 'rs-2')
+    const client = createClient(socket, server, 'rs-2')
 
     client.resume()
 
@@ -57,7 +76,7 @@ describe('WebSocketClient readyState', () => {
 
   it('should transition to CLOSED after close()', () => {
     const socket = createMockSocket()
-    const client = new WebSocketClient(socket, server, 'rs-3')
+    const client = createClient(socket, server, 'rs-3')
     client.resume()
 
     client.close()
@@ -68,7 +87,7 @@ describe('WebSocketClient readyState', () => {
 
   it('should be idempotent — second close() is a no-op', () => {
     const socket = createMockSocket()
-    const client = new WebSocketClient(socket, server, 'rs-4')
+    const client = createClient(socket, server, 'rs-4')
     client.resume()
 
     client.close()
@@ -79,7 +98,7 @@ describe('WebSocketClient readyState', () => {
 
   it('should not send data when in CONNECTING state', () => {
     const socket = createMockSocket()
-    const client = new WebSocketClient(socket, server, 'rs-5')
+    const client = createClient(socket, server, 'rs-5')
 
     client.send('hello')
 
@@ -88,7 +107,7 @@ describe('WebSocketClient readyState', () => {
 
   it('should not send data when in CLOSED state', () => {
     const socket = createMockSocket()
-    const client = new WebSocketClient(socket, server, 'rs-6')
+    const client = createClient(socket, server, 'rs-6')
     client.resume()
     client.close()
 
@@ -103,7 +122,7 @@ describe('WebSocketClient readyState', () => {
 
   it('should not send ping when not OPEN', () => {
     const socket = createMockSocket()
-    const client = new WebSocketClient(socket, server, 'rs-7')
+    const client = createClient(socket, server, 'rs-7')
 
     client.ping()
 
@@ -113,7 +132,7 @@ describe('WebSocketClient readyState', () => {
   it('should not write when socket is not writable', () => {
     const socket = createMockSocket()
     socket.writable = false
-    const client = new WebSocketClient(socket, server, 'rs-8')
+    const client = createClient(socket, server, 'rs-8')
     client.resume()
 
     client.send('hello')
@@ -123,7 +142,7 @@ describe('WebSocketClient readyState', () => {
 
   it('should transition to CLOSED when socket fires close event', () => {
     const socket = createMockSocket()
-    const client = new WebSocketClient(socket, server, 'rs-9')
+    const client = createClient(socket, server, 'rs-9')
     server.clients.set('rs-9', client)
     client.resume()
 
@@ -136,7 +155,7 @@ describe('WebSocketClient readyState', () => {
 
   it('should emit close event only once on double cleanup', () => {
     const socket = createMockSocket()
-    const client = new WebSocketClient(socket, server, 'rs-10')
+    const client = createClient(socket, server, 'rs-10')
     server.clients.set('rs-10', client)
     client.resume()
 

package/test/WebSocket/Client/send.test.js

@@ -0,0 +1,148 @@
+const {WebSocketServer, WebSocketClient} = require('../../../src/WebSocket.js')
+
+function createMockSocket() {
+  return {
+    pause: jest.fn(),
+    resume: jest.fn(),
+    on: jest.fn(),
+    write: jest.fn(),
+    end: jest.fn(),
+    removeAllListeners: jest.fn(),
+    writable: true
+  }
+}
+
+/**
+ * Splits the frame handed to socket.write() back into opcode and payload.
+ * Server-sent frames are never masked, so the payload starts right after
+ * the (possibly extended) length field.
+ */
+function readFrame(socket) {
+  const frame = socket.write.mock.calls[0][0]
+  const opcode = frame[0] & 0x0f
+  const length = frame[1] & 0x7f
+
+  let offset = 2
+  if (length === 126) offset = 4
+  else if (length === 127) offset = 10
+
+  return {opcode, payload: frame.subarray(offset)}
+}
+
+const openClients = []
+
+/**
+ * Creates a client and registers it for teardown.
+ *
+ * The constructor starts a rate-limit interval that is only cleared on close(),
+ * so a client left open keeps Jest's event loop alive after the run finishes.
+ */
+function createClient(...args) {
+  const client = new WebSocketClient(...args)
+  openClients.push(client)
+  return client
+}
+
+afterEach(() => {
+  for (const client of openClients) client.close()
+  openClients.length = 0
+})
+
+describe('WebSocketClient send', () => {
+  let server
+  let client
+  let socket
+
+  beforeEach(() => {
+    server = new WebSocketServer()
+    socket = createMockSocket()
+    client = createClient(socket, server, 'send-1')
+    client.resume()
+  })
+
+  it('should send strings as TEXT frames', () => {
+    client.send('hello')
+
+    const {opcode, payload} = readFrame(socket)
+
+    expect(opcode).toBe(0x1)
+    expect(payload.toString('utf8')).toBe('hello')
+  })
+
+  it('should send plain objects as JSON TEXT frames', () => {
+    client.send({type: 'ping', n: 1})
+
+    const {opcode, payload} = readFrame(socket)
+
+    expect(opcode).toBe(0x1)
+    expect(JSON.parse(payload.toString('utf8'))).toEqual({type: 'ping', n: 1})
+  })
+
+  it('should send a Buffer as a BINARY frame instead of JSON', () => {
+    client.send(Buffer.from([0xde, 0xad, 0xbe, 0xef]))
+
+    const {opcode, payload} = readFrame(socket)
+
+    expect(opcode).toBe(0x2)
+    expect([...payload]).toEqual([0xde, 0xad, 0xbe, 0xef])
+  })
+
+  it('should send a TypedArray as a BINARY frame', () => {
+    client.send(new Uint8Array([1, 2, 3]))
+
+    const {opcode, payload} = readFrame(socket)
+
+    expect(opcode).toBe(0x2)
+    expect([...payload]).toEqual([1, 2, 3])
+  })
+
+  it('should send an ArrayBuffer as a BINARY frame', () => {
+    const view = new Uint8Array([9, 8, 7])
+    client.send(view.buffer)
+
+    const {opcode, payload} = readFrame(socket)
+
+    expect(opcode).toBe(0x2)
+    expect([...payload]).toEqual([9, 8, 7])
+  })
+
+  it('should preserve the bytes of multi-byte TypedArrays', () => {
+    // Buffer.from(view) would read each element as a number and truncate it
+    // to one byte, silently corrupting anything wider than a Uint8Array.
+    client.send(new Uint16Array([0x0100, 0x0200]))
+
+    const {opcode, payload} = readFrame(socket)
+
+    expect(opcode).toBe(0x2)
+    expect(payload.length).toBe(4)
+    expect([...payload]).toEqual([0x00, 0x01, 0x00, 0x02])
+  })
+
+  it('should honour the byteOffset of a view over a larger buffer', () => {
+    const backing = new Uint8Array([1, 2, 3, 4, 5, 6])
+    const view = backing.subarray(2, 5)
+
+    client.send(view)
+
+    const {payload} = readFrame(socket)
+
+    expect([...payload]).toEqual([3, 4, 5])
+  })
+
+  it('should send binary through sendBinary without corrupting wide views', () => {
+    client.sendBinary(new Uint16Array([0x0100]))
+
+    const {opcode, payload} = readFrame(socket)
+
+    expect(opcode).toBe(0x2)
+    expect([...payload]).toEqual([0x00, 0x01])
+  })
+
+  it('should not send when the connection is not open', () => {
+    const closed = createClient(createMockSocket(), server, 'send-2')
+
+    closed.send('hello')
+
+    expect(closed.readyState).toBe(WebSocketClient.CONNECTING)
+  })
+})