bluera-knowledge 0.9.21

package/tests/fixtures/corpus/oss-repos/hono/src/middleware/timing/timing.ts

@@ -0,0 +1,225 @@
+/**
+ * @module
+ * Server-Timing Middleware for Hono.
+ */
+
+import type { Context } from '../../context'
+import type { MiddlewareHandler } from '../../types'
+import '../../context'
+
+export type TimingVariables = {
+  metric?: {
+    headers: string[]
+    timers: Map<string, Timer>
+  }
+}
+
+interface Timer {
+  description?: string
+  start: number
+}
+
+interface TimingOptions {
+  total?: boolean
+  enabled?: boolean | ((c: Context) => boolean)
+  totalDescription?: string
+  autoEnd?: boolean
+  crossOrigin?: boolean | string | ((c: Context) => boolean | string)
+}
+
+const getTime = (): number => {
+  try {
+    return performance.now()
+  } catch {}
+  return Date.now()
+}
+
+/**
+ * Server-Timing Middleware for Hono.
+ *
+ * @see {@link https://hono.dev/docs/middleware/builtin/timing}
+ *
+ * @param {TimingOptions} [config] - The options for the timing middleware.
+ * @param {boolean} [config.total=true] - Show the total response time.
+ * @param {boolean | ((c: Context) => boolean)} [config.enabled=true] - Whether timings should be added to the headers or not.
+ * @param {string} [config.totalDescription=Total Response Time] - Description for the total response time.
+ * @param {boolean} [config.autoEnd=true] - If `startTime()` should end automatically at the end of the request.
+ * @param {boolean | string | ((c: Context) => boolean | string)} [config.crossOrigin=false] - The origin this timings header should be readable.
+ * @returns {MiddlewareHandler} The middleware handler function.
+ *
+ * @example
+ * ```ts
+ * const app = new Hono()
+ *
+ * // add the middleware to your router
+ * app.use(timing());
+ *
+ * app.get('/', async (c) => {
+ *   // add custom metrics
+ *   setMetric(c, 'region', 'europe-west3')
+ *
+ *   // add custom metrics with timing, must be in milliseconds
+ *   setMetric(c, 'custom', 23.8, 'My custom Metric')
+ *
+ *   // start a new timer
+ *   startTime(c, 'db');
+ *
+ *   const data = await db.findMany(...);
+ *
+ *   // end the timer
+ *   endTime(c, 'db');
+ *
+ *   return c.json({ response: data });
+ * });
+ * ```
+ */
+export const timing = (config?: TimingOptions): MiddlewareHandler => {
+  const options: TimingOptions = {
+    ...{
+      total: true,
+      enabled: true,
+      totalDescription: 'Total Response Time',
+      autoEnd: true,
+      crossOrigin: false,
+    },
+    ...config,
+  }
+  return async function timing(c, next) {
+    const headers: string[] = []
+    const timers = new Map<string, Timer>()
+
+    if (c.get('metric')) {
+      return await next()
+    }
+
+    c.set('metric', { headers, timers })
+
+    if (options.total) {
+      startTime(c, 'total', options.totalDescription)
+    }
+    await next()
+
+    if (options.total) {
+      endTime(c, 'total')
+    }
+
+    if (options.autoEnd) {
+      timers.forEach((_, key) => endTime(c, key))
+    }
+
+    const enabled = typeof options.enabled === 'function' ? options.enabled(c) : options.enabled
+
+    if (enabled) {
+      c.res.headers.append('Server-Timing', headers.join(','))
+
+      const crossOrigin =
+        typeof options.crossOrigin === 'function' ? options.crossOrigin(c) : options.crossOrigin
+
+      if (crossOrigin) {
+        c.res.headers.append(
+          'Timing-Allow-Origin',
+          typeof crossOrigin === 'string' ? crossOrigin : '*'
+        )
+      }
+    }
+  }
+}
+
+interface SetMetric {
+  (c: Context, name: string, value: number, description?: string, precision?: number): void
+
+  (c: Context, name: string, description?: string): void
+}
+
+/**
+ * Set a metric for the timing middleware.
+ *
+ * @param {Context} c - The context of the request.
+ * @param {string} name - The name of the metric.
+ * @param {number | string} [valueDescription] - The value or description of the metric.
+ * @param {string} [description] - The description of the metric.
+ * @param {number} [precision] - The precision of the metric value.
+ *
+ * @example
+ * ```ts
+ * setMetric(c, 'region', 'europe-west3')
+ * setMetric(c, 'custom', 23.8, 'My custom Metric')
+ * ```
+ */
+export const setMetric: SetMetric = (
+  c: Context,
+  name: string,
+  valueDescription: number | string | undefined,
+  description?: string,
+  precision?: number
+) => {
+  const metrics = c.get('metric')
+  if (!metrics) {
+    console.warn('Metrics not initialized! Please add the `timing()` middleware to this route!')
+    return
+  }
+  if (typeof valueDescription === 'number') {
+    const dur = valueDescription.toFixed(precision || 1)
+
+    const metric = description ? `${name};dur=${dur};desc="${description}"` : `${name};dur=${dur}`
+
+    metrics.headers.push(metric)
+  } else {
+    // Value-less metric
+    const metric = valueDescription ? `${name};desc="${valueDescription}"` : `${name}`
+
+    metrics.headers.push(metric)
+  }
+}
+
+/**
+ * Start a timer for the timing middleware.
+ *
+ * @param {Context} c - The context of the request.
+ * @param {string} name - The name of the timer.
+ * @param {string} [description] - The description of the timer.
+ *
+ * @example
+ * ```ts
+ * startTime(c, 'db')
+ * ```
+ */
+export const startTime = (c: Context, name: string, description?: string) => {
+  const metrics = c.get('metric')
+  if (!metrics) {
+    console.warn('Metrics not initialized! Please add the `timing()` middleware to this route!')
+    return
+  }
+  metrics.timers.set(name, { description, start: getTime() })
+}
+
+/**
+ * End a timer for the timing middleware.
+ *
+ * @param {Context} c - The context of the request.
+ * @param {string} name - The name of the timer.
+ * @param {number} [precision] - The precision of the timer value.
+ *
+ * @example
+ * ```ts
+ * endTime(c, 'db')
+ * ```
+ */
+export const endTime = (c: Context, name: string, precision?: number) => {
+  const metrics = c.get('metric')
+  if (!metrics) {
+    console.warn('Metrics not initialized! Please add the `timing()` middleware to this route!')
+    return
+  }
+  const timer = metrics.timers.get(name)
+  if (!timer) {
+    console.warn(`Timer "${name}" does not exist!`)
+    return
+  }
+  const { description, start } = timer
+
+  const duration = getTime() - start
+
+  setMetric(c, name, duration, description, precision)
+  metrics.timers.delete(name)
+}

package/tests/fixtures/corpus/oss-repos/hono/src/middleware/trailing-slash/index.ts

@@ -0,0 +1,71 @@
+/**
+ * @module
+ * Trailing Slash Middleware for Hono.
+ */
+
+import type { MiddlewareHandler } from '../../types'
+
+/**
+ * Trailing Slash Middleware for Hono.
+ *
+ * @see {@link https://hono.dev/docs/middleware/builtin/trailing-slash}
+ *
+ * @returns {MiddlewareHandler} The middleware handler function.
+ *
+ * @example
+ * ```ts
+ * const app = new Hono()
+ *
+ * app.use(trimTrailingSlash())
+ * app.get('/about/me/', (c) => c.text('With Trailing Slash'))
+ * ```
+ */
+export const trimTrailingSlash = (): MiddlewareHandler => {
+  return async function trimTrailingSlash(c, next) {
+    await next()
+
+    if (
+      c.res.status === 404 &&
+      c.req.method === 'GET' &&
+      c.req.path !== '/' &&
+      c.req.path[c.req.path.length - 1] === '/'
+    ) {
+      const url = new URL(c.req.url)
+      url.pathname = url.pathname.substring(0, url.pathname.length - 1)
+
+      c.res = c.redirect(url.toString(), 301)
+    }
+  }
+}
+
+/**
+ * Append trailing slash middleware for Hono.
+ * Append a trailing slash to the URL if it doesn't have one. For example, `/path/to/page` will be redirected to `/path/to/page/`.
+ *
+ * @see {@link https://hono.dev/docs/middleware/builtin/trailing-slash}
+ *
+ * @returns {MiddlewareHandler} The middleware handler function.
+ *
+ * @example
+ * ```ts
+ * const app = new Hono()
+ *
+ * app.use(appendTrailingSlash())
+ * ```
+ */
+export const appendTrailingSlash = (): MiddlewareHandler => {
+  return async function appendTrailingSlash(c, next) {
+    await next()
+
+    if (
+      c.res.status === 404 &&
+      c.req.method === 'GET' &&
+      c.req.path[c.req.path.length - 1] !== '/'
+    ) {
+      const url = new URL(c.req.url)
+      url.pathname += '/'
+
+      c.res = c.redirect(url.toString(), 301)
+    }
+  }
+}

package/tests/fixtures/corpus/oss-repos/hono/src/preset/quick.ts

@@ -0,0 +1,24 @@
+/**
+ * @module
+ * The preset that uses `LinearRouter`.
+ */
+
+import { HonoBase } from '../hono-base'
+import type { HonoOptions } from '../hono-base'
+import { LinearRouter } from '../router/linear-router'
+import { SmartRouter } from '../router/smart-router'
+import { TrieRouter } from '../router/trie-router'
+import type { BlankEnv, BlankSchema, Env, Schema } from '../types'
+
+export class Hono<
+  E extends Env = BlankEnv,
+  S extends Schema = BlankSchema,
+  BasePath extends string = '/'
+> extends HonoBase<E, S, BasePath> {
+  constructor(options: HonoOptions<E> = {}) {
+    super(options)
+    this.router = new SmartRouter({
+      routers: [new LinearRouter(), new TrieRouter()],
+    })
+  }
+}

package/tests/fixtures/corpus/oss-repos/hono/src/preset/tiny.ts

@@ -0,0 +1,20 @@
+/**
+ * @module
+ * The preset that uses `PatternRouter`.
+ */
+
+import { HonoBase } from '../hono-base'
+import type { HonoOptions } from '../hono-base'
+import { PatternRouter } from '../router/pattern-router'
+import type { BlankEnv, BlankSchema, Env, Schema } from '../types'
+
+export class Hono<
+  E extends Env = BlankEnv,
+  S extends Schema = BlankSchema,
+  BasePath extends string = '/'
+> extends HonoBase<E, S, BasePath> {
+  constructor(options: HonoOptions<E> = {}) {
+    super(options)
+    this.router = new PatternRouter()
+  }
+}