acrylblends 0.6.3 → 0.7.0

package/plugins/acryl-router/src/core/middleware/timing/index.test.ts

@@ -1,310 +0,0 @@
-import { endTime, setMetric, startTime, timing, wrapTime } from './index.ts'
-import { Acryl } from '../../app.ts'
-
-describe('Server-Timing API', () => {
-  const app = new Acryl()
-
-  const totalDescription = 'my total DescRipTion!'
-  const name = 'sleep'
-  const region = 'region'
-  const regionDesc = 'europe-west3'
-
-  app.use(
-    '*',
-    timing({
-      totalDescription,
-    })
-  )
-  app.get('/', (c) => c.text('/'))
-  app.get('/api', async (c) => {
-    startTime(c, name)
-    await new Promise((r) => setTimeout(r, 30))
-    endTime(c, name)
-
-    return c.text('api!')
-  })
-  app.get('/api-wrap', async (c) => {
-    await wrapTime(c, name, new Promise((r) => setTimeout(r, 30)))
-
-    return c.text('api!')
-  })
-  app.get('/api-wrap-throw', async (c) => {
-    try {
-      await wrapTime(c, name, new Promise((_, r) => setTimeout(r, 30)))
-    } catch (e) {
-      return c.text(`error :( ${e}`, 500)
-    }
-
-    return c.text('api!')
-  })
-  app.get('/cache', async (c) => {
-    setMetric(c, region, regionDesc)
-
-    return c.text('cache!')
-  })
-
-  const sub = new Acryl()
-
-  sub.use(timing())
-  sub.get('/', (c) => c.text('sub'))
-  app.route('/sub', sub)
-
-  it('Should contain total duration', async () => {
-    const res = await app.request('http://localhost/')
-    expect(res).not.toBeNull()
-    expect(res.headers.has('server-timing')).toBeTruthy()
-    expect(res.headers.get('server-timing')?.includes('total;dur=')).toBeTruthy()
-    expect(res.headers.get('server-timing')?.includes(totalDescription)).toBeTruthy()
-  })
-
-  it('Should contain value metrics', async () => {
-    const res = await app.request('http://localhost/api')
-    expect(res).not.toBeNull()
-    expect(res.headers.has('server-timing')).toBeTruthy()
-    expect(res.headers.get('server-timing')?.includes(`${name};dur=`)).toBeTruthy()
-    expect(res.headers.get('server-timing')?.includes(name)).toBeTruthy()
-  })
-
-  it('Should contain value metrics, wrapped', async () => {
-    const res = await app.request('http://localhost/api-wrap')
-    expect(res).not.toBeNull()
-    expect(res.headers.has('server-timing')).toBeTruthy()
-    expect(res.headers.get('server-timing')?.includes(`${name};dur=`)).toBeTruthy()
-    expect(res.headers.get('server-timing')?.includes(name)).toBeTruthy()
-  })
-
-  it('Should contain value metrics, wrapped throw', async () => {
-    const res = await app.request('http://localhost/api-wrap-throw')
-    expect(res).not.toBeNull()
-    expect(res.headers.has('server-timing')).toBeTruthy()
-    expect(res.status).toBeGreaterThanOrEqual(500)
-    expect(res.headers.get('server-timing')?.includes(`${name};dur=`)).toBeTruthy()
-    expect(res.headers.get('server-timing')?.includes(name)).toBeTruthy()
-  })
-
-  it('Should contain value-less metrics', async () => {
-    const res = await app.request('http://localhost/cache')
-    expect(res).not.toBeNull()
-    expect(res.headers.has('server-timing')).toBeTruthy()
-    expect(
-      res.headers.get('server-timing')?.includes(`${region};desc="${regionDesc}"`)
-    ).toBeTruthy()
-    expect(res.headers.get('server-timing')?.includes(region)).toBeTruthy()
-    expect(res.headers.get('server-timing')?.includes(regionDesc)).toBeTruthy()
-  })
-
-  it('Should not be enabled if the main app has the timing middleware', async () => {
-    const consoleWarnSpy = vi.spyOn(console, 'warn')
-    const res = await app.request('/sub')
-    expect(res.status).toBe(200)
-    expect(res.headers.has('server-timing')).toBeTruthy()
-    expect(res.headers.get('server-timing')?.includes(totalDescription)).toBeTruthy()
-    expect(consoleWarnSpy).not.toHaveBeenCalled()
-    consoleWarnSpy.mockRestore()
-  })
-
-  describe('Should handle timing options', async () => {
-    it('Should handle autoEnd option', async () => {
-      const autoEndApp = new Acryl()
-
-      autoEndApp.use('*', timing())
-      autoEndApp.get('/', (c) => {
-        startTime(c, 'test')
-        return c.text('/')
-      })
-
-      const res = await autoEndApp.request('/')
-
-      expect(res.status).toBe(200)
-      expect(res.headers.get('server-timing')).toContain('test;dur=')
-
-      const disabledAutoEndApp = new Acryl()
-
-      disabledAutoEndApp.use('*', timing({ autoEnd: false }))
-      disabledAutoEndApp.get('/', (c) => {
-        startTime(c, 'test')
-        return c.text('/')
-      })
-
-      const disabledRes = await disabledAutoEndApp.request('/')
-
-      expect(disabledRes.status).toBe(200)
-      expect(disabledRes.headers.get('server-timing')).not.toContain('test;dur=')
-    })
-
-    it('Should use enabled function return value', async () => {
-      const enabledApp = new Acryl()
-      const enabled = vi.fn(() => false)
-
-      enabledApp.use('*', timing({ enabled }))
-      enabledApp.get('/', (c) => c.text('/'))
-
-      const res = await enabledApp.request('/')
-
-      expect(res.status).toBe(200)
-      expect(enabled).toHaveBeenCalled()
-      expect(res.headers.has('server-timing')).toBeFalsy()
-    })
-
-    it('Should handle total false and value-less metrics without description', async () => {
-      const metricApp = new Acryl()
-
-      metricApp.use('*', timing({ total: false }))
-      metricApp.get('/', (c) => {
-        setMetric(c, 'test')
-        return c.text('/')
-      })
-
-      const res = await metricApp.request('/')
-
-      expect(res.status).toBe(200)
-      expect(res.headers.get('server-timing')).toBe('test')
-    })
-  })
-
-  describe('Should handle crossOrigin setting', async () => {
-    it('Should do nothing when crossOrigin is falsy', async () => {
-      const crossOriginApp = new Acryl()
-
-      crossOriginApp.use(
-        '*',
-        timing({
-          crossOrigin: false,
-        })
-      )
-
-      crossOriginApp.get('/', (c) => c.text('/'))
-
-      const res = await crossOriginApp.request('http://localhost/')
-
-      expect(res).not.toBeNull()
-      expect(res.headers.has('server-timing')).toBeTruthy()
-      expect(res.headers.has('timing-allow-origin')).toBeFalsy()
-    })
-
-    it('Should set Timing-Allow-Origin to * when crossOrigin is true', async () => {
-      const crossOriginApp = new Acryl()
-
-      crossOriginApp.use(
-        '*',
-        timing({
-          crossOrigin: true,
-        })
-      )
-
-      crossOriginApp.get('/', (c) => c.text('/'))
-
-      const res = await crossOriginApp.request('http://localhost/')
-
-      expect(res).not.toBeNull()
-      expect(res.headers.has('server-timing')).toBeTruthy()
-      expect(res.headers.has('timing-allow-origin')).toBeTruthy()
-      expect(res.headers.get('timing-allow-origin')).toBe('*')
-    })
-
-    it('Should set Timing-Allow-Origin to the value of crossOrigin when it is a string', async () => {
-      const crossOriginApp = new Acryl()
-
-      crossOriginApp.use(
-        '*',
-        timing({
-          crossOrigin: 'https://example.com',
-        })
-      )
-
-      crossOriginApp.get('/', (c) => c.text('/'))
-
-      const res = await crossOriginApp.request('http://localhost/')
-
-      expect(res).not.toBeNull()
-      expect(res.headers.has('server-timing')).toBeTruthy()
-      expect(res.headers.has('timing-allow-origin')).toBeTruthy()
-      expect(res.headers.get('timing-allow-origin')).toBe('https://example.com')
-    })
-
-    it('Should set Timing-Allow-Origin to the return value of crossOrigin when it is a function', async () => {
-      const crossOriginApp = new Acryl()
-
-      crossOriginApp.use(
-        '*',
-        timing({
-          crossOrigin: (c) => c.req.header('origin') ?? '*',
-        })
-      )
-
-      crossOriginApp.get('/', (c) => c.text('/'))
-
-      const res = await crossOriginApp.request('http://localhost/', {
-        headers: {
-          origin: 'https://example.com',
-        },
-      })
-
-      expect(res).not.toBeNull()
-      expect(res.headers.has('server-timing')).toBeTruthy()
-      expect(res.headers.has('timing-allow-origin')).toBeTruthy()
-      expect(res.headers.get('timing-allow-origin')).toBe('https://example.com')
-    })
-
-    it("Should use Date.now as backup if performance API isn't available", async () => {
-      const originalPerformance = globalThis.performance
-      // @ts-expect-error disable performance API for testing
-      delete globalThis.performance
-      const DateNowSpy = vi.spyOn(Date, 'now').mockReturnValue(123456789)
-
-      const app = new Acryl().use(timing()).get('/', (c) => {
-        startTime(c, 'test')
-        endTime(c, 'test')
-        return c.text('hello')
-      })
-
-      const res = await app.request('/')
-      expect(res.status).toBe(200)
-
-      expect(DateNowSpy).toHaveBeenCalled()
-
-      DateNowSpy.mockRestore()
-      globalThis.performance = originalPerformance
-    })
-  })
-
-  describe('Configuration validation', async () => {
-    it('Should silently warn when no timing metrics are available', async () => {
-      const consoleWarnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
-
-      const app = new Acryl().get('/', (c) => {
-        setMetric(c, 'test', 123)
-        startTime(c, 'test')
-        endTime(c, 'test')
-        return c.text('hello')
-      })
-
-      const res = await app.request('/')
-      expect(res.status).toBe(200)
-
-      expect(consoleWarnSpy).toHaveBeenNthCalledWith(
-        2,
-        'Metrics not initialized! Please add the `timing()` middleware to this route!'
-      )
-
-      consoleWarnSpy.mockRestore()
-    })
-
-    it('Should silently warn when trying to end a non-existent timer', async () => {
-      const consoleWarnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
-
-      const app = new Acryl().use(timing()).get('/', (c) => {
-        setMetric(c, 'region', 'europe-west3')
-        endTime(c, 'nonExistentTimer')
-        return c.text('hello')
-      })
-
-      const res = await app.request('/')
-      expect(res.status).toBe(200)
-
-      expect(consoleWarnSpy).toHaveBeenCalledWith('Timer "nonExistentTimer" does not exist!')
-
-      consoleWarnSpy.mockRestore()
-    })
-  })
-})

package/plugins/acryl-router/src/core/middleware/trailing-slash/index.test.ts

@@ -1,381 +0,0 @@
-import { appendTrailingSlash, trimTrailingSlash } from './index.ts'
-import { Acryl } from '../../app.ts'
-
-describe('Resolve trailing slash', () => {
-  describe('trimTrailingSlash middleware', () => {
-    const app = new Acryl({ strict: true })
-    app.use('*', trimTrailingSlash())
-
-    app.get('/', async (c) => {
-      return c.text('ok')
-    })
-    app.get('/the/example/endpoint/without/trailing/slash', async (c) => {
-      return c.text('ok')
-    })
-
-    it('should handle GET request for root path correctly', async () => {
-      const resp = await app.request('/')
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(200)
-    })
-
-    it('should handle GET request for path without trailing slash correctly', async () => {
-      const resp = await app.request('/the/example/endpoint/without/trailing/slash')
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(200)
-    })
-
-    it('should handle GET request for path with trailing slash correctly', async () => {
-      const resp = await app.request('/the/example/endpoint/without/trailing/slash/')
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/the/example/endpoint/without/trailing/slash')
-    })
-
-    it('should preserve query parameters when redirecting', async () => {
-      const resp = await app.request('/the/example/endpoint/without/trailing/slash/?exampleParam=1')
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/the/example/endpoint/without/trailing/slash')
-      expect(loc.searchParams.get('exampleParam')).toBe('1')
-    })
-
-    it('should handle HEAD request for root path correctly', async () => {
-      const resp = await app.request('/', { method: 'HEAD' })
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(200)
-    })
-
-    it('should handle HEAD request for path without trailing slash correctly', async () => {
-      const resp = await app.request('/the/example/endpoint/without/trailing/slash', {
-        method: 'HEAD',
-      })
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(200)
-    })
-
-    it('should handle HEAD request for path with trailing slash correctly', async () => {
-      const resp = await app.request('/the/example/endpoint/without/trailing/slash/', {
-        method: 'HEAD',
-      })
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/the/example/endpoint/without/trailing/slash')
-    })
-
-    it('should preserve query parameters when redirecting HEAD requests', async () => {
-      const resp = await app.request(
-        '/the/example/endpoint/without/trailing/slash/?exampleParam=1',
-        { method: 'HEAD' }
-      )
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/the/example/endpoint/without/trailing/slash')
-      expect(loc.searchParams.get('exampleParam')).toBe('1')
-    })
-  })
-
-  describe('trimTrailingSlash middleware with alwaysRedirect option', () => {
-    const app = new Acryl()
-    app.use('*', trimTrailingSlash({ alwaysRedirect: true }))
-
-    app.get('/', async (c) => {
-      return c.text('ok')
-    })
-    app.get('/my-path/*', async (c) => {
-      return c.text('wildcard')
-    })
-    app.get('/exact-path', async (c) => {
-      return c.text('exact')
-    })
-
-    it('should handle GET request for root path correctly', async () => {
-      const resp = await app.request('/')
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(200)
-    })
-
-    it('should redirect wildcard route with trailing slash', async () => {
-      const resp = await app.request('/my-path/something/else/')
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/my-path/something/else')
-    })
-
-    it('should not redirect wildcard route without trailing slash', async () => {
-      const resp = await app.request('/my-path/something/else')
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(200)
-      expect(await resp.text()).toBe('wildcard')
-    })
-
-    it('should redirect exact route with trailing slash', async () => {
-      const resp = await app.request('/exact-path/')
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/exact-path')
-    })
-
-    it('should preserve query parameters when redirecting', async () => {
-      const resp = await app.request('/my-path/something/?param=1')
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/my-path/something')
-      expect(loc.searchParams.get('param')).toBe('1')
-    })
-
-    it('should handle HEAD request for wildcard route with trailing slash', async () => {
-      const resp = await app.request('/my-path/something/', { method: 'HEAD' })
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/my-path/something')
-    })
-  })
-
-  describe('appendTrailingSlash middleware', () => {
-    const app = new Acryl({ strict: true })
-    app.use('*', appendTrailingSlash())
-
-    app.get('/', async (c) => {
-      return c.text('ok')
-    })
-    app.get('/the/example/endpoint/with/trailing/slash/', async (c) => {
-      return c.text('ok')
-    })
-    app.get('/the/example/simulate/a.file', async (c) => {
-      return c.text('ok')
-    })
-
-    it('should handle GET request for root path correctly', async () => {
-      const resp = await app.request('/')
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(200)
-    })
-
-    it('should handle GET request for file-like paths correctly', async () => {
-      const resp = await app.request('/the/example/simulate/a.file')
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(200)
-    })
-
-    it('should handle GET request for path with trailing slash correctly', async () => {
-      const resp = await app.request('/the/example/endpoint/with/trailing/slash/')
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(200)
-    })
-
-    it('should redirect path without trailing slash to one with it', async () => {
-      const resp = await app.request('/the/example/endpoint/with/trailing/slash')
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/the/example/endpoint/with/trailing/slash/')
-    })
-
-    it('should preserve query parameters when redirecting', async () => {
-      const resp = await app.request('/the/example/endpoint/with/trailing/slash?exampleParam=1')
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/the/example/endpoint/with/trailing/slash/')
-      expect(loc.searchParams.get('exampleParam')).toBe('1')
-    })
-
-    it('should handle HEAD request for root path correctly', async () => {
-      const resp = await app.request('/', { method: 'HEAD' })
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(200)
-    })
-
-    it('should handle HEAD request for file-like paths correctly', async () => {
-      const resp = await app.request('/the/example/simulate/a.file', { method: 'HEAD' })
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(200)
-    })
-
-    it('should handle HEAD request for path with trailing slash correctly', async () => {
-      const resp = await app.request('/the/example/endpoint/with/trailing/slash/', {
-        method: 'HEAD',
-      })
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(200)
-    })
-
-    it('should redirect HEAD request for path without trailing slash to one with it', async () => {
-      const resp = await app.request('/the/example/endpoint/with/trailing/slash', {
-        method: 'HEAD',
-      })
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/the/example/endpoint/with/trailing/slash/')
-    })
-
-    it('should preserve query parameters when redirecting HEAD requests', async () => {
-      const resp = await app.request('/the/example/endpoint/with/trailing/slash?exampleParam=1', {
-        method: 'HEAD',
-      })
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/the/example/endpoint/with/trailing/slash/')
-      expect(loc.searchParams.get('exampleParam')).toBe('1')
-    })
-  })
-
-  describe('appendTrailingSlash middleware with skip option', () => {
-    const hasExtension = (path: string): boolean => /\.\w+$/.test(path.split('/').at(-1) ?? '')
-    const app = new Acryl({ strict: true })
-    app.use('*', appendTrailingSlash({ skip: hasExtension }))
-
-    app.get('/page/', (c) => c.text('ok'))
-
-    it('should not redirect paths with file extensions', async () => {
-      const resp = await app.request('/foo.html')
-
-      expect(resp.status).toBe(404)
-    })
-
-    it('should redirect paths without file extensions', async () => {
-      const resp = await app.request('/page')
-
-      expect(resp.status).toBe(301)
-      const loc = new URL(resp.headers.get('location')!)
-      expect(loc.pathname).toBe('/page/')
-    })
-  })
-
-  describe('appendTrailingSlash middleware with alwaysRedirect and skip options', () => {
-    const hasExtension = (path: string): boolean => /\.\w+$/.test(path.split('/').at(-1) ?? '')
-    const app = new Acryl()
-    app.use('*', appendTrailingSlash({ alwaysRedirect: true, skip: hasExtension }))
-
-    app.get('/', (c) => c.text('ok'))
-    app.get('/my-path/*', (c) => c.text('wildcard'))
-
-    it('should redirect paths without extensions', async () => {
-      const resp = await app.request('/my-path/something')
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/my-path/something/')
-    })
-
-    it('should not redirect paths with file extensions', async () => {
-      const resp = await app.request('/my-path/style.css')
-
-      expect(resp.status).toBe(200)
-    })
-
-    it('should not redirect paths with extensions like .html', async () => {
-      const resp = await app.request('/my-path/page.html')
-
-      expect(resp.status).toBe(200)
-    })
-
-    it('should handle HEAD request for paths with extensions', async () => {
-      const resp = await app.request('/my-path/script.js', { method: 'HEAD' })
-
-      expect(resp.status).toBe(200)
-    })
-  })
-
-  describe('appendTrailingSlash middleware with alwaysRedirect option', () => {
-    const app = new Acryl()
-    app.use('*', appendTrailingSlash({ alwaysRedirect: true }))
-
-    app.get('/', async (c) => {
-      return c.text('ok')
-    })
-    app.get('/my-path/*', async (c) => {
-      return c.text('wildcard')
-    })
-    app.get('/exact-path/', async (c) => {
-      return c.text('exact')
-    })
-
-    it('should handle GET request for root path correctly', async () => {
-      const resp = await app.request('/')
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(200)
-    })
-
-    it('should redirect wildcard route without trailing slash', async () => {
-      const resp = await app.request('/my-path/something/else')
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/my-path/something/else/')
-    })
-
-    it('should not redirect wildcard route with trailing slash', async () => {
-      const resp = await app.request('/my-path/something/else/')
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(200)
-      expect(await resp.text()).toBe('wildcard')
-    })
-
-    it('should redirect exact route without trailing slash', async () => {
-      const resp = await app.request('/exact-path')
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/exact-path/')
-    })
-
-    it('should preserve query parameters when redirecting', async () => {
-      const resp = await app.request('/my-path/something?param=1')
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/my-path/something/')
-      expect(loc.searchParams.get('param')).toBe('1')
-    })
-
-    it('should handle HEAD request for wildcard route without trailing slash', async () => {
-      const resp = await app.request('/my-path/something', { method: 'HEAD' })
-      const loc = new URL(resp.headers.get('location')!)
-
-      expect(resp).not.toBeNull()
-      expect(resp.status).toBe(301)
-      expect(loc.pathname).toBe('/my-path/something/')
-    })
-  })
-})