24026346286

Committed 06 Apr 2026 09:20AM UTC coverage: 80.544% (+0.008%) from 80.536%

Build # 24026346286

Build Type

Pull #973

github

Committed by

web-flow

Commit Message

Merge e10f5df35 into cd8ad47ff

Pull Request Pull Request #973: fix: allocate less in interim

Coverage Stats

3152 of 4090 branches covered (77.07%)

Branch coverage included in aggregate %.

83 of 91 new or added lines in 4 files covered. (91.21%)

8 existing lines in 1 file now uncovered.

30095 of 37188 relevant lines covered (80.93%)

315.16 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.47

/src/http/plugins/log-request.ts

import { logger, logSchema, redactQueryParamFromRequest } from '@internal/monitoring'
import { FastifyReply } from 'fastify/types/reply'
import { FastifyRequest } from 'fastify/types/request'
import fastifyPlugin from 'fastify-plugin'

interface RequestLoggerOptions {
  excludeUrls?: string[]
}

declare module 'fastify' {
  interface FastifyRequest {
    executionError?: Error
    operation?: { type: string }
    resources?: string[]
    startTime: number
    executionTime?: number
  }

  interface FastifyContextConfig {
    operation?: { type: string }
    resources?: (req: FastifyRequest<any>) => string[]
    logMetadata?: (req: FastifyRequest<any>) => Record<string, unknown>
  }
}

/**
 * Request logger plugin
 * @param options
 */
export const logRequest = (options: RequestLoggerOptions) =>
  fastifyPlugin(
    async (fastify) => {
      fastify.addHook('onRequest', async (req, res) => {
        req.startTime = Date.now()

        res.raw.once('close', () => {
          if (req.raw.aborted) {
            doRequestLog(req, {
              excludeUrls: options.excludeUrls,
              statusCode: 'ABORTED REQ',
              responseTime: (Date.now() - req.startTime) / 1000,
            })
            return
          }

          if (!res.raw.writableFinished) {
            doRequestLog(req, {
              excludeUrls: options.excludeUrls,
              statusCode: 'ABORTED RES',
              responseTime: (Date.now() - req.startTime) / 1000,
            })
          }
        })
      })

      /**
       * Adds req.resources and req.operation to the request object
       */
      fastify.addHook('preHandler', async (req) => {
        let resources = req.resources

        if (resources === undefined) {
          resources = req.routeOptions.config.resources?.(req)
        }

        if (resources === undefined) {
          resources = (req.raw as any).resources
        }

        if (resources === undefined) {
          const params = req.params as Record<string, unknown> | undefined
          let resourceFromParams = ''

          if (params) {
            let first = true
            for (const key in params) {
              if (!Object.prototype.hasOwnProperty.call(params, key)) {
                continue
              }

              if (!first) {
                resourceFromParams += '/'
              }

              const value = params[key]
              resourceFromParams += value == null ? '' : String(value)
              first = false
            }
          }

          resources = resourceFromParams ? [resourceFromParams] : []
        }

        if (resources && resources.length > 0) {
          for (let index = 0; index < resources.length; index++) {
            const resource = resources[index]
            if (!resource.startsWith('/')) {
              resources[index] = `/${resource}`
            }
          }
        }

        req.resources = resources
        req.operation = req.routeOptions.config.operation

        if (req.operation && typeof req.opentelemetry === 'function') {
          req.opentelemetry()?.span?.setAttribute('http.operation', req.operation.type)
        }
      })

      fastify.addHook('onSend', async (req, _, payload) => {
        req.executionTime = Date.now() - req.startTime
        return payload
      })

      fastify.addHook('onResponse', async (req, reply) => {
        doRequestLog(req, {
          reply,
          excludeUrls: options.excludeUrls,
          statusCode: reply.statusCode,
          responseTime: reply.elapsedTime,
          executionTime: req.executionTime,
        })
      })
    },
    { name: 'log-request' }
  )

interface LogRequestOptions {
  reply?: FastifyReply
  excludeUrls?: string[]
  statusCode: number | 'ABORTED REQ' | 'ABORTED RES'
  responseTime: number
  executionTime?: number
}

function doRequestLog(req: FastifyRequest, options: LogRequestOptions) {
  if (options.excludeUrls?.includes(req.url)) {
    return
  }

  const rMeth = req.method
  const rUrl = redactQueryParamFromRequest(req, [
    'token',
    'X-Amz-Credential',
    'X-Amz-Signature',
    'X-Amz-Security-Token',
  ])
  const uAgent = req.headers['user-agent']
  const rId = req.id
  const cIP = req.ip
  const statusCode = options.statusCode
  const error = (req.raw as any).executionError || req.executionError
  const tenantId = req.tenantId

  let reqMetadata: Record<string, unknown> = {}

  if (req.routeOptions.config.logMetadata) {
    try {
      reqMetadata = req.routeOptions.config.logMetadata(req)

      if (reqMetadata) {
        try {
          if (typeof req.opentelemetry === 'function') {
            req.opentelemetry()?.span?.setAttribute('http.metadata', JSON.stringify(reqMetadata))
          }
        } catch (e) {
          // do nothing
          logSchema.warning(logger, 'Failed to serialize log metadata', {
            type: 'otel',
            error: e,
          })
        }
      }
    } catch (e) {
      logSchema.error(logger, 'Failed to get log metadata', {
        type: 'request',
        error: e,
      })
    }
  }

  const buildLogMessage = `${tenantId} | ${rMeth} | ${statusCode} | ${cIP} | ${rId} | ${rUrl} | ${uAgent}`

  logSchema.request(req.log, buildLogMessage, {
    type: 'request',
    req,
    reqMetadata,
    res: options.reply,
    responseTime: options.responseTime,
    executionTime: options.executionTime,
    error,
    owner: req.owner,
    role: req.jwtPayload?.role,
    resources: req.resources,
    operation: req.operation?.type ?? req.routeOptions.config.operation?.type,
    serverTimes: req.serverTimings,
  })
}

1	import { logger, logSchema, redactQueryParamFromRequest } from '@internal/monitoring'	1✔
2	import { FastifyReply } from 'fastify/types/reply'	1✔
3	import { FastifyRequest } from 'fastify/types/request'	1✔
4	import fastifyPlugin from 'fastify-plugin'	1✔
5		1✔
6	interface RequestLoggerOptions {	1✔
7	excludeUrls?: string[]	1✔
8	}	1✔
9		1✔
10	declare module 'fastify' {	1✔
11	interface FastifyRequest {	1✔
12	executionError?: Error	1✔
13	operation?: { type: string }	1✔
14	resources?: string[]	1✔
15	startTime: number	1✔
16	executionTime?: number	1✔
17	}	1✔
18		1✔
19	interface FastifyContextConfig {	1✔
20	operation?: { type: string }	1✔
21	resources?: (req: FastifyRequest<any>) => string[]	1✔
22	logMetadata?: (req: FastifyRequest<any>) => Record<string, unknown>	1✔
23	}	1✔
24	}	1✔
25		1✔
26	/**	1✔
27	* Request logger plugin	1✔
28	* @param options	1✔
29	*/	1✔
30	export const logRequest = (options: RequestLoggerOptions) =>	1✔
31	fastifyPlugin(	268✔
32	async (fastify) => {	268✔
33	fastify.addHook('onRequest', async (req, res) => {	260✔
34	req.startTime = Date.now()	1,478✔
35		1,478✔
36	res.raw.once('close', () => {	1,478✔
37	if (req.raw.aborted) {	1,478!
38	doRequestLog(req, {	×
39	excludeUrls: options.excludeUrls,	×
40	statusCode: 'ABORTED REQ',	×
41	responseTime: (Date.now() - req.startTime) / 1000,	×
42	})	×
43	return	×
44	}	×
45		1,478✔
46	if (!res.raw.writableFinished) {	1,478✔
47	doRequestLog(req, {	1,135✔
48	excludeUrls: options.excludeUrls,	1,135✔
49	statusCode: 'ABORTED RES',	1,135✔
50	responseTime: (Date.now() - req.startTime) / 1000,	1,135✔
51	})	1,135✔
52	}	1,135✔
53	})	1,478✔
54	})	260✔
55		260✔
56	/**	260✔
57	* Adds req.resources and req.operation to the request object	260✔
58	*/	260✔
59	fastify.addHook('preHandler', async (req) => {	260✔
60	let resources = req.resources	1,405✔
61		1,405✔
62	if (resources === undefined) {	1,405✔
63	resources = req.routeOptions.config.resources?.(req)	1,405✔
64	}	1,405✔
65		1,405✔
66	if (resources === undefined) {	1,405✔
67	resources = (req.raw as any).resources	1,343✔
68	}	1,343✔
69		1,405✔
70	if (resources === undefined) {	1,405✔
71	const params = req.params as Record<string, unknown> \| undefined	1,343✔
72	let resourceFromParams = ''	1,343✔
73		1,343✔
74	if (params) {	1,343✔
75	let first = true	1,343✔
76	for (const key in params) {	1,343✔
77	if (!Object.prototype.hasOwnProperty.call(params, key)) {	1,643!
NEW 78	continue	×
NEW 79	}	×
80		1,643✔
81	if (!first) {	1,643✔
82	resourceFromParams += '/'	476✔
83	}	476✔
84		1,643✔
85	const value = params[key]	1,643✔
86	resourceFromParams += value == null ? '' : String(value)	1,643!
87	first = false	1,643✔
88	}	1,643✔
89	}	1,343✔
90		1,343✔
91	resources = resourceFromParams ? [resourceFromParams] : []	1,343✔
92	}	1,343✔
93		1,405✔
94	if (resources && resources.length > 0) {	1,405✔
95	for (let index = 0; index < resources.length; index++) {	1,229✔
96	const resource = resources[index]	41,264✔
97	if (!resource.startsWith('/')) {	41,264✔
98	resources[index] = `/${resource}`	41,263✔
99	}	41,263✔
100	}	41,264✔
101	}	1,229✔
102		1,405✔
103	req.resources = resources	1,405✔
104	req.operation = req.routeOptions.config.operation	1,405✔
105		1,405✔
106	if (req.operation && typeof req.opentelemetry === 'function') {	1,405!
107	req.opentelemetry()?.span?.setAttribute('http.operation', req.operation.type)	×
108	}	×
109	})	260✔
110		260✔
111	fastify.addHook('onSend', async (req, _, payload) => {	260✔
112	req.executionTime = Date.now() - req.startTime	1,458✔
113	return payload	1,458✔
114	})	260✔
115		260✔
116	fastify.addHook('onResponse', async (req, reply) => {	260✔
117	doRequestLog(req, {	1,478✔
118	reply,	1,478✔
119	excludeUrls: options.excludeUrls,	1,478✔
120	statusCode: reply.statusCode,	1,478✔
121	responseTime: reply.elapsedTime,	1,478✔
122	executionTime: req.executionTime,	1,478✔
123	})	1,478✔
124	})	260✔
125	},	260✔
126	{ name: 'log-request' }	268✔
127	)	1✔
128		1✔
129	interface LogRequestOptions {	1✔
130	reply?: FastifyReply	1✔
131	excludeUrls?: string[]	1✔
132	statusCode: number \| 'ABORTED REQ' \| 'ABORTED RES'	1✔
133	responseTime: number	1✔
134	executionTime?: number	1✔
135	}	1✔
136		1✔
137	function doRequestLog(req: FastifyRequest, options: LogRequestOptions) {	2,613✔
138	if (options.excludeUrls?.includes(req.url)) {	2,613!
139	return	×
140	}	×
141		2,613✔
142	const rMeth = req.method	2,613✔
143	const rUrl = redactQueryParamFromRequest(req, [	2,613✔
144	'token',	2,613✔
145	'X-Amz-Credential',	2,613✔
146	'X-Amz-Signature',	2,613✔
147	'X-Amz-Security-Token',	2,613✔
148	])	2,613✔
149	const uAgent = req.headers['user-agent']	2,613✔
150	const rId = req.id	2,613✔
151	const cIP = req.ip	2,613✔
152	const statusCode = options.statusCode	2,613✔
153	const error = (req.raw as any).executionError \|\| req.executionError	2,613✔
154	const tenantId = req.tenantId	2,613✔
155		2,613✔
156	let reqMetadata: Record<string, unknown> = {}	2,613✔
157		2,613✔
158	if (req.routeOptions.config.logMetadata) {	2,613✔
159	try {	380✔
160	reqMetadata = req.routeOptions.config.logMetadata(req)	380✔
161		380✔
162	if (reqMetadata) {	380✔
163	try {	380✔
164	if (typeof req.opentelemetry === 'function') {	380!
165	req.opentelemetry()?.span?.setAttribute('http.metadata', JSON.stringify(reqMetadata))	×
166	}	×
167	} catch (e) {	380!
168	// do nothing	×
169	logSchema.warning(logger, 'Failed to serialize log metadata', {	×
170	type: 'otel',	×
171	error: e,	×
172	})	×
173	}	×
174	}	380✔
175	} catch (e) {	380!
176	logSchema.error(logger, 'Failed to get log metadata', {	×
177	type: 'request',	×
178	error: e,	×
179	})	×
180	}	×
181	}	380✔
182		2,613✔
183	const buildLogMessage = `${tenantId} \| ${rMeth} \| ${statusCode} \| ${cIP} \| ${rId} \| ${rUrl} \| ${uAgent}`	2,613✔
184		2,613✔
185	logSchema.request(req.log, buildLogMessage, {	2,613✔
186	type: 'request',	2,613✔
187	req,	2,613✔
188	reqMetadata,	2,613✔
189	res: options.reply,	2,613✔
190	responseTime: options.responseTime,	2,613✔
191	executionTime: options.executionTime,	2,613✔
192	error,	2,613✔
193	owner: req.owner,	2,613✔
194	role: req.jwtPayload?.role,	2,613✔
195	resources: req.resources,	2,613✔
196	operation: req.operation?.type ?? req.routeOptions.config.operation?.type,	2,613✔
197	serverTimes: req.serverTimings,	2,613✔
198	})	2,613✔
199	}	2,613✔

supabase / storage / 24026346286

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous