acrylblends 0.3.0 → 0.4.0

package/plugins/acryl-node-server/tests/adapter/early-hints.test.ts

@@ -0,0 +1,457 @@
+import type { Context, MiddlewareHandler } from '../../../acryl-router/src/index.ts'
+import { App } from '../../../acryl-router/src/index.ts'
+import { describe, it, expect, expectTypeOf, vi } from 'vitest'
+import http, { createServer } from 'node:http'
+import http2 from 'node:http2'
+import type { AddressInfo } from 'node:net'
+import { earlyHints } from '../../src/adapter/early-hints.ts'
+import { getRequestListener } from '../../src/adapter/listener.ts'
+
+describe('HTTP/1.1 Early Hints Middleware', () => {
+  it('should send a 103 early hints response before the final response using a string link', async () => {
+    const app = new App()
+    app.use(
+      '*',
+      earlyHints({
+        link: '</style.css>; rel=preload; as=style',
+      })
+    )
+    app.get('/', (c) => c.text('Hello Early Hints'))
+
+    const server = createServer(getRequestListener(app.fetch))
+
+    await new Promise<void>((resolve, reject) => {
+      server.listen(0, () => {
+        const address = server.address() as AddressInfo
+        const port = address.port
+
+        const req = http.request(
+          {
+            port,
+            path: '/',
+          },
+          (res) => {
+            let body = ''
+            res.on('data', (chunk) => (body += chunk))
+            res.on('end', () => {
+              try {
+                expect(res.statusCode).toBe(200)
+                expect(body).toBe('Hello Early Hints')
+                expect(earlyHintReceived).toBe(true)
+                server.close((err) => (err ? reject(err) : resolve()))
+              } catch (err) {
+                server.close()
+                reject(err)
+              }
+            })
+            res.on('error', (err) => {
+              server.close()
+              reject(err)
+            })
+          }
+        )
+
+        let earlyHintReceived = false
+        req.on('information', (info) => {
+          try {
+            expect(info.statusCode).toBe(103)
+            expect(info.headers.link).toBe('</style.css>; rel=preload; as=style')
+            earlyHintReceived = true
+          } catch (err) {
+            server.close()
+            reject(err)
+          }
+        })
+
+        req.on('error', (err) => {
+          server.close()
+          reject(err)
+        })
+        req.end()
+      })
+    })
+  })
+
+  it('should send early hints with an array of link headers', async () => {
+    const app = new App()
+    app.use(
+      '*',
+      earlyHints({
+        link: ['</style.css>; rel=preload; as=style', '</script.js>; rel=preload; as=script'],
+      })
+    )
+    app.get('/', (c) => c.text('Hello Middleware'))
+
+    const server = createServer(getRequestListener(app.fetch))
+
+    await new Promise<void>((resolve, reject) => {
+      server.listen(0, () => {
+        const address = server.address() as AddressInfo
+        const port = address.port
+
+        const req = http.request(
+          {
+            port,
+            path: '/',
+          },
+          (res) => {
+            let body = ''
+            res.on('data', (chunk) => (body += chunk))
+            res.on('end', () => {
+              try {
+                expect(res.statusCode).toBe(200)
+                expect(body).toBe('Hello Middleware')
+                expect(earlyHintReceived).toBe(true)
+                server.close((err) => (err ? reject(err) : resolve()))
+              } catch (err) {
+                server.close()
+                reject(err)
+              }
+            })
+            res.on('error', (err) => {
+              server.close()
+              reject(err)
+            })
+          }
+        )
+
+        let earlyHintReceived = false
+        req.on('information', (info) => {
+          try {
+            expect(info.statusCode).toBe(103)
+            expect(info.headers.link).toBe(
+              '</style.css>; rel=preload; as=style, </script.js>; rel=preload; as=script'
+            )
+            earlyHintReceived = true
+          } catch (err) {
+            server.close()
+            reject(err)
+          }
+        })
+
+        req.on('error', (err) => {
+          server.close()
+          reject(err)
+        })
+        req.end()
+      })
+    })
+  })
+
+  it('should evaluate dynamic link function with Context', async () => {
+    const app = new App()
+    app.use(
+      '*',
+      earlyHints({
+        link: (c) =>
+          c.req.query('theme') === 'dark'
+            ? '</dark.css>; rel=preload; as=style'
+            : '</light.css>; rel=preload; as=style',
+      })
+    )
+    app.get('/', (c) => c.text('Hello Dynamic'))
+
+    const server = createServer(getRequestListener(app.fetch))
+
+    await new Promise<void>((resolve, reject) => {
+      server.listen(0, () => {
+        const address = server.address() as AddressInfo
+        const port = address.port
+
+        const req = http.request(
+          {
+            port,
+            path: '/?theme=dark',
+          },
+          (res) => {
+            let body = ''
+            res.on('data', (chunk) => (body += chunk))
+            res.on('end', () => {
+              try {
+                expect(res.statusCode).toBe(200)
+                expect(body).toBe('Hello Dynamic')
+                expect(earlyHintReceived).toBe(true)
+                server.close((err) => (err ? reject(err) : resolve()))
+              } catch (err) {
+                server.close()
+                reject(err)
+              }
+            })
+            res.on('error', (err) => {
+              server.close()
+              reject(err)
+            })
+          }
+        )
+
+        let earlyHintReceived = false
+        req.on('information', (info) => {
+          try {
+            expect(info.statusCode).toBe(103)
+            expect(info.headers.link).toBe('</dark.css>; rel=preload; as=style')
+            earlyHintReceived = true
+          } catch (err) {
+            server.close()
+            reject(err)
+          }
+        })
+
+        req.on('error', (err) => {
+          server.close()
+          reject(err)
+        })
+        req.end()
+      })
+    })
+  })
+})
+
+describe('HTTP/2 Early Hints Middleware', () => {
+  it('should send a 103 early hints response over HTTP/2', async () => {
+    const app = new App()
+    app.use(
+      '*',
+      earlyHints({
+        link: '</style.css>; rel=preload; as=style',
+      })
+    )
+    app.get('/', (c) => c.text('Hello HTTP2 Early Hints'))
+
+    const server = http2.createServer(getRequestListener(app.fetch))
+
+    await new Promise<void>((resolve, reject) => {
+      server.listen(0, () => {
+        const address = server.address() as AddressInfo
+        const port = address.port
+
+        const client = http2.connect(`http://localhost:${port}`)
+        const req = client.request({ ':path': '/' })
+
+        let earlyHintReceived = false
+        req.on('headers', (headers) => {
+          try {
+            if (headers[':status'] === 103) {
+              expect(headers.link).toBe('</style.css>; rel=preload; as=style')
+              earlyHintReceived = true
+            }
+          } catch (err) {
+            client.close()
+            server.close()
+            reject(err)
+          }
+        })
+
+        let finalResponseReceived = false
+        req.on('response', (headers) => {
+          try {
+            expect(headers[':status']).toBe(200)
+            finalResponseReceived = true
+          } catch (err) {
+            client.close()
+            server.close()
+            reject(err)
+          }
+        })
+
+        let body = ''
+        req.on('data', (chunk) => (body += chunk))
+
+        req.on('end', () => {
+          try {
+            expect(earlyHintReceived).toBe(true)
+            expect(finalResponseReceived).toBe(true)
+            expect(body).toBe('Hello HTTP2 Early Hints')
+            client.close()
+            server.close((err) => (err ? reject(err) : resolve()))
+          } catch (err) {
+            client.close()
+            server.close()
+            reject(err)
+          }
+        })
+
+        req.on('error', (err) => {
+          client.close()
+          server.close()
+          reject(err)
+        })
+      })
+    })
+  })
+})
+
+describe('Early Hints Middleware Fetch Metadata Filtering', () => {
+  const createContext = (mode?: string, dest?: string) => {
+    const writeEarlyHints = vi.fn()
+    const context = {
+      req: {
+        header: (name: string) => {
+          if (name === 'Sec-Fetch-Mode') {
+            return mode
+          }
+          if (name === 'Sec-Fetch-Dest') {
+            return dest
+          }
+        },
+      },
+      env: {
+        outgoing: {
+          writeEarlyHints,
+          headersSent: false,
+        },
+      },
+    } as unknown as Context
+
+    return { context, writeEarlyHints }
+  }
+
+  it.each([
+    ['both headers are missing', undefined, undefined],
+    ['both headers match', 'navigate', 'document'],
+    ['only the mode header matches', 'navigate', undefined],
+    ['only the destination header matches', undefined, 'document'],
+  ])('should send hints when %s', async (_description, mode, dest) => {
+    const { context, writeEarlyHints } = createContext(mode, dest)
+    const next = vi.fn().mockResolvedValue(undefined)
+    const middleware = earlyHints({
+      link: '</style.css>; rel=preload; as=style',
+    })
+
+    await middleware(context, next)
+
+    expect(writeEarlyHints).toHaveBeenCalledWith({
+      link: '</style.css>; rel=preload; as=style',
+    })
+    expect(next).toHaveBeenCalledTimes(1)
+  })
+
+  it.each([
+    ['the mode is cors', 'cors', undefined],
+    ['the destination is empty', undefined, 'empty'],
+    ['the destination is an iframe', 'navigate', 'iframe'],
+    ['the mode is no-cors', 'no-cors', 'document'],
+  ])('should skip hints when %s', async (_description, mode, dest) => {
+    const { context, writeEarlyHints } = createContext(mode, dest)
+    const next = vi.fn().mockResolvedValue(undefined)
+    const middleware = earlyHints({
+      link: '</style.css>; rel=preload; as=style',
+    })
+
+    await middleware(context, next)
+
+    expect(writeEarlyHints).not.toHaveBeenCalled()
+    expect(next).toHaveBeenCalledTimes(1)
+  })
+})
+
+describe('Early Hints Middleware Unit & Edge Cases', () => {
+  it('should preserve the application Env type', () => {
+    type TestEnv = {
+      Bindings: {
+        theme: string
+      }
+      Variables: {
+        userId: string
+      }
+    }
+
+    const middleware = earlyHints<TestEnv>({
+      link: (c) => {
+        expectTypeOf(c.env.theme).toEqualTypeOf<string>()
+        expectTypeOf(c.get('userId')).toEqualTypeOf<string>()
+        return undefined
+      },
+    })
+
+    expectTypeOf(middleware).toEqualTypeOf<MiddlewareHandler<TestEnv>>()
+  })
+
+  it('should warn once per middleware instance when writeEarlyHints is unavailable', async () => {
+    const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
+
+    const mockCtx = {
+      req: {
+        header: () => undefined,
+      },
+      env: {
+        outgoing: {
+          headersSent: false,
+        },
+      },
+    } as unknown as Context
+
+    const nextFn = vi.fn().mockResolvedValue(undefined)
+
+    const mw1 = earlyHints({ link: '/style.css' })
+    await mw1(mockCtx, nextFn)
+    await mw1(mockCtx, nextFn)
+
+    expect(consoleSpy).toHaveBeenCalledTimes(1)
+    expect(consoleSpy).toHaveBeenCalledWith(
+      'Early Hints Middleware is not supported because writeEarlyHints is not defined.'
+    )
+    expect(nextFn).toHaveBeenCalledTimes(2)
+
+    const mw2 = earlyHints({ link: '/style.css' })
+    await mw2(mockCtx, nextFn)
+
+    expect(consoleSpy).toHaveBeenCalledTimes(2)
+    expect(nextFn).toHaveBeenCalledTimes(3)
+
+    consoleSpy.mockRestore()
+  })
+
+  it('should no-op safely when headersSent is true', async () => {
+    const writeEarlyHintsMock = vi.fn()
+    const mockCtx = {
+      req: {
+        header: () => undefined,
+      },
+      env: {
+        outgoing: {
+          writeEarlyHints: writeEarlyHintsMock,
+          headersSent: true,
+        },
+      },
+    } as unknown as Context
+
+    const nextFn = vi.fn().mockResolvedValue(undefined)
+    const mw = earlyHints({ link: '/style.css' })
+
+    await mw(mockCtx, nextFn)
+
+    expect(writeEarlyHintsMock).not.toHaveBeenCalled()
+    expect(nextFn).toHaveBeenCalledTimes(1)
+  })
+
+  it('should skip sending hints when dynamic link function returns undefined or empty array', async () => {
+    const writeEarlyHintsMock = vi.fn()
+    const mockCtx = {
+      req: {
+        header: () => undefined,
+      },
+      env: {
+        outgoing: {
+          writeEarlyHints: writeEarlyHintsMock,
+          headersSent: false,
+        },
+      },
+    } as unknown as Context
+
+    const nextFn = vi.fn().mockResolvedValue(undefined)
+
+    // Undefined return
+    const mwUndefined = earlyHints({ link: () => undefined })
+    await mwUndefined(mockCtx, nextFn)
+
+    expect(writeEarlyHintsMock).not.toHaveBeenCalled()
+    expect(nextFn).toHaveBeenCalledTimes(1)
+
+    // Empty array return
+    const mwEmptyArray = earlyHints({ link: () => [] })
+    await mwEmptyArray(mockCtx, nextFn)
+
+    expect(writeEarlyHintsMock).not.toHaveBeenCalled()
+    expect(nextFn).toHaveBeenCalledTimes(2)
+  })
+})

package/plugins/acryl-node-server/tests/adapter/fixtures/keys/agent1-cert.pem

@@ -0,0 +1,23 @@
+-----BEGIN CERTIFICATE-----
+MIID6DCCAtCgAwIBAgIUFH02wcL3Qgben6tfIibXitsApCYwDQYJKoZIhvcNAQEL
+BQAwejELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMQswCQYDVQQHDAJTRjEPMA0G
+A1UECgwGSm95ZW50MRAwDgYDVQQLDAdOb2RlLmpzMQwwCgYDVQQDDANjYTExIDAe
+BgkqhkiG9w0BCQEWEXJ5QHRpbnljbG91ZHMub3JnMCAXDTIyMDkwMzIxNDAzN1oY
+DzIyOTYwNjE3MjE0MDM3WjB9MQswCQYDVQQGEwJVUzELMAkGA1UECAwCQ0ExCzAJ
+BgNVBAcMAlNGMQ8wDQYDVQQKDAZKb3llbnQxEDAOBgNVBAsMB05vZGUuanMxDzAN
+BgNVBAMMBmFnZW50MTEgMB4GCSqGSIb3DQEJARYRcnlAdGlueWNsb3Vkcy5vcmcw
+ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDUVjIK+yDTgnCT3CxChO0E
+37q9VuHdrlKeKLeQzUJW2yczSfNzX/0zfHpjY+zKWie39z3HCJqWxtiG2wxiOI8c
+3WqWOvzVmdWADlh6EfkIlg+E7VC6JaKDA+zabmhPvnuu3JzogBMnsWl68lCXzuPx
+deQAmEwNtqjrh74DtM+Ud0ulb//Ixjxo1q3rYKu+aaexSramuee6qJta2rjrB4l8
+B/bU+j1mDf9XQQfSjo9jRnp4hiTFdBl2k+lZzqE2L/rhu6EMjA2IhAq/7xA2MbLo
+9cObVUin6lfoo5+JKRgT9Fp2xEgDOit+2EA/S6oUfPNeLSVUqmXOSWlXlwlb9Nxr
+AgMBAAGjYTBfMF0GCCsGAQUFBwEBBFEwTzAjBggrBgEFBQcwAYYXaHR0cDovL29j
+c3Aubm9kZWpzLm9yZy8wKAYIKwYBBQUHMAKGHGh0dHA6Ly9jYS5ub2RlanMub3Jn
+L2NhLmNlcnQwDQYJKoZIhvcNAQELBQADggEBAMM0mBBjLMt9pYXePtUeNO0VTw9y
+FWCM8nAcAO2kRNwkJwcsispNpkcsHZ5o8Xf5mpCotdvziEWG1hyxwU6nAWyNOLcN
+G0a0KUfbMO3B6ZYe1GwPDjXaQnv75SkAdxgX5zOzca3xnhITcjUUGjQ0fbDfwFV5
+ix8mnzvfXjDONdEznVa7PFcN6QliFUMwR/h8pCRHtE5+a10OSPeJSrGG+FtrGnRW
+G1IJUv6oiGF/MvWCr84REVgc1j78xomGANJIu2hN7bnD1nEMON6em8IfnDOUtynV
+9wfWTqiQYD5Zifj6WcGa0aAHMuetyFG4lIfMAHmd3gaKpks7j9l26LwRPvI=
+-----END CERTIFICATE-----

package/plugins/acryl-node-server/tests/adapter/fixtures/keys/agent1-key.pem

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEpAIBAAKCAQEA1FYyCvsg04Jwk9wsQoTtBN+6vVbh3a5Snii3kM1CVtsnM0nz
+c1/9M3x6Y2Psylont/c9xwialsbYhtsMYjiPHN1qljr81ZnVgA5YehH5CJYPhO1Q
+uiWigwPs2m5oT757rtyc6IATJ7FpevJQl87j8XXkAJhMDbao64e+A7TPlHdLpW//
+yMY8aNat62CrvmmnsUq2prnnuqibWtq46weJfAf21Po9Zg3/V0EH0o6PY0Z6eIYk
+xXQZdpPpWc6hNi/64buhDIwNiIQKv+8QNjGy6PXDm1VIp+pX6KOfiSkYE/RadsRI
+AzorfthAP0uqFHzzXi0lVKplzklpV5cJW/TcawIDAQABAoIBAAvbtHfAhpjJVBgt
+15rvaX04MWmZjIugzKRgib/gdq/7FTlcC+iJl85kSUF7tyGl30n62MxgwqFhAX6m
+hQ6HMhbelrFFIhGbwbyhEHfgwROlrcAysKt0pprCgVvBhrnNXYLqdyjU3jz9P3LK
+TY3s0/YMK2uNFdI+PTjKH+Z9Foqn9NZUnUonEDepGyuRO7fLeccWJPv2L4CR4a/5
+ku4VbDgVpvVSVRG3PSVzbmxobnpdpl52og+T7tPx1cLnIknPtVljXPWtZdfekh2E
+eAp2KxCCHOKzzG3ItBKsVu0woeqEpy8JcoO6LbgmEoVnZpgmtQClbBgef8+i+oGE
+BgW9nmECgYEA8gA63QQuZOUC56N1QXURexN2PogF4wChPaCTFbQSJXvSBkQmbqfL
+qRSD8P0t7GOioPrQK6pDwFf4BJB01AvkDf8Z6DxxOJ7cqIC7LOwDupXocWX7Q0Qk
+O6cwclBVsrDZK00v60uRRpl/a39GW2dx7IiQDkKQndLh3/0TbMIWHNcCgYEA4J6r
+yinZbLpKw2+ezhi4B4GT1bMLoKboJwpZVyNZZCzYR6ZHv+lS7HR/02rcYMZGoYbf
+n7OHwF4SrnUS7vPhG4g2ZsOhKQnMvFSQqpGmK1ZTuoKGAevyvtouhK/DgtLWzGvX
+9fSahiq/UvfXs/z4M11q9Rv9ztPCmG1cwSEHlo0CgYEAogQNZJK8DMhVnYcNpXke
+7uskqtCeQE/Xo06xqkIYNAgloBRYNpUYAGa/vsOBz1UVN/kzDUi8ezVp0oRz8tLT
+J5u2WIi+tE2HJTiqF3UbOfvK1sCT64DfUSCpip7GAQ/tFNRkVH8PD9kMOYfILsGe
+v+DdsO5Xq5HXrwHb02BNNZkCgYBsl8lt33WiPx5OBfS8pu6xkk+qjPkeHhM2bKZs
+nkZlS9j0KsudWGwirN/vkkYg8zrKdK5AQ0dqFRDrDuasZ3N5IA1M+V88u+QjWK7o
+B6pSYVXxYZDv9OZSpqC+vUrEQLJf+fNakXrzSk9dCT1bYv2Lt6ox/epix7XYg2bI
+Z/OHMQKBgQC2FUGhlndGeugTJaoJ8nhT/0VfRUX/h6sCgSerk5qFr/hNCBV4T022
+x0NDR2yLG6MXyqApJpG6rh3QIDElQoQCNlI3/KJ6JfEfmqrLLN2OigTvA5sE4fGU
+Dp/ha8OQAx95EwXuaG7LgARduvOIK3x8qi8KsZoUGJcg2ywurUbkWA==
+-----END RSA PRIVATE KEY-----