23890434792

Committed 02 Apr 2026 08:00AM UTC coverage: 80.377% (-0.01%) from 80.387%

Build # 23890434792

Build Type

Pull #961

github

Committed by

web-flow

Commit Message

Merge bfc9c735f into 18d938683

Pull Request Pull Request #961: fix: use object limit on orphan object scanner to avoid error

Coverage Stats

3090 of 4024 branches covered (76.79%)

Branch coverage included in aggregate %.

37 of 65 new or added lines in 2 files covered. (56.92%)

7 existing lines in 2 files now uncovered.

29802 of 36898 relevant lines covered (80.77%)

309.86 hits per line

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

44.39

/src/http/routes/admin/objects.ts

import { StorageBackendError } from '@internal/errors'
import { ObjectScanner } from '@storage/scanner/scanner'
import { FastifyInstance, RequestGenericInterface } from 'fastify'
import { FastifyReply } from 'fastify/types/reply'
import { dbSuperUser, storage } from '../../plugins'
import apiKey from '../../plugins/apikey'

const listOrphanedObjects = {
  description: 'List Orphaned Objects',
  params: {
    type: 'object',
    properties: {
      tenantId: { type: 'string' },
      bucketId: { type: 'string' },
    },
    required: ['tenantId', 'bucketId'],
  },
  query: {
    type: 'object',
    properties: {
      before: { type: 'string' },
      keepTmpTable: { type: 'boolean' },
    },
  },
} as const

const syncOrphanedObjects = {
  description: 'Sync Orphaned Objects',
  params: {
    type: 'object',
    properties: {
      tenantId: { type: 'string' },
      bucketId: { type: 'string' },
    },
    required: ['tenantId', 'bucketId'],
  },
  body: {
    type: 'object',
    properties: {
      deleteDbKeys: { type: 'boolean' },
      deleteS3Keys: { type: 'boolean' },
      tmpTable: { type: 'string' },
    },
  },
  optional: ['deleteDbKeys', 'deleteS3Keys'],
} as const

interface ListOrphanObjectsRequest extends RequestGenericInterface {
  Params: {
    tenantId: string
    bucketId: string
  }
  Querystring: {
    before?: string
    keepTmpTable?: boolean
  }
}

interface SyncOrphanObjectsRequest extends RequestGenericInterface {
  Params: {
    tenantId: string
    bucketId: string
  }
  Body: {
    deleteDbKeys?: boolean
    deleteS3Keys?: boolean
    before?: string
    tmpTable?: string
    keepTmpTable?: boolean
  }
}

export default async function routes(fastify: FastifyInstance) {
  fastify.register(apiKey)
  fastify.register(dbSuperUser, {
    disableHostCheck: true,
    maxConnections: 5,
  })
  fastify.register(storage)

  fastify.get<ListOrphanObjectsRequest>(
    '/:tenantId/buckets/:bucketId/orphan-objects',
    {
      schema: { ...listOrphanedObjects, tags: ['object'] },
    },
    async (req, reply) => {
      const bucket = req.params.bucketId
      let before = req.query.before ? new Date(req.query.before as string) : undefined

      if (before && isNaN(before.getTime())) {
        return reply.status(400).send({
          error: 'Invalid date format',
        })
      }
      if (!before) {
        before = new Date()
        before.setHours(before.getHours() - 1)
      }

      const scanner = new ObjectScanner(req.storage)
      const orphanObjects = scanner.listOrphaned(bucket, {
        signal: req.signals.disconnect.signal,
        before,
        keepTmpTable: Boolean(req.query.keepTmpTable),
      })

      reply.header('Content-Type', 'application/x-ndjson; charset=utf-8')

      // Do not let the connection time out, periodically send
      // a ping message to keep the connection alive
      const respPing = ping(reply)

      try {
        for await (const result of orphanObjects) {
          if (result.value.length > 0) {
            respPing.update()
            reply.raw.write(
              JSON.stringify({
                ...result,
                event: 'data',
              }) + '\n'
            )
          }
        }
      } catch (e) {
        reply.raw.write(
          JSON.stringify({
            event: 'error',
            error: StorageBackendError.fromError(e),
          }) + '\n'
        )
        throw e
      } finally {
        respPing.clear()
        reply.raw.end()
      }
    }
  )

  fastify.delete<SyncOrphanObjectsRequest>(
    '/:tenantId/buckets/:bucketId/orphan-objects',
    {
      schema: { ...syncOrphanedObjects, tags: ['object'] },
    },
    async (req, reply) => {
      if (!req.body.deleteDbKeys && !req.body.deleteS3Keys) {
        return reply.status(400).send({
          error: 'At least one of deleteDbKeys or deleteS3Keys must be set to true',
        })
      }

      const bucket = `${req.params.bucketId}`
      let before = req.body.before ? new Date(req.body.before as string) : undefined

      if (!before) {
        before = new Date()
        before.setHours(before.getHours() - 1)
      }

      reply.header('Content-Type', 'application/x-ndjson; charset=utf-8')

      const respPing = ping(reply)

      try {
        const scanner = new ObjectScanner(req.storage)
        const result = scanner.deleteOrphans(bucket, {
          deleteDbKeys: req.body.deleteDbKeys,
          deleteS3Keys: req.body.deleteS3Keys,
          signal: req.signals.disconnect.signal,
          before,
          tmpTable: req.body.tmpTable,
        })

        for await (const deleted of result) {
          respPing.update()
          reply.raw.write(
            JSON.stringify({
              ...deleted,
              event: 'data',
            }) + '\n'
          )
        }
      } catch (e) {
        reply.raw.write(
          JSON.stringify({
            event: 'error',
            error: StorageBackendError.fromError(e),
          }) + '\n'
        )
        throw e
      } finally {
        respPing.clear()
        reply.raw.end()
      }
    }
  )
}

// Occasionally write a ping message to the response stream
function ping(reply: FastifyReply) {
  let lastSend = undefined as Date | undefined
  const clearPing = setInterval(() => {
    const fiveSecondsEarly = new Date()
    fiveSecondsEarly.setSeconds(fiveSecondsEarly.getSeconds() - 5)

    if (!lastSend || (lastSend && lastSend < fiveSecondsEarly)) {
      lastSend = new Date()
      reply.raw.write(
        JSON.stringify({
          event: 'ping',
        }) + '\n'
      )
    }
  }, 1000 * 10)

  return {
    clear: () => clearInterval(clearPing),
    update: () => {
      lastSend = new Date()
    },
  }
}

1	import { StorageBackendError } from '@internal/errors'	1✔
2	import { ObjectScanner } from '@storage/scanner/scanner'	1✔
3	import { FastifyInstance, RequestGenericInterface } from 'fastify'	1✔
4	import { FastifyReply } from 'fastify/types/reply'	1✔
5	import { dbSuperUser, storage } from '../../plugins'	1✔
6	import apiKey from '../../plugins/apikey'	1✔
7		1✔
8	const listOrphanedObjects = {	1✔
9	description: 'List Orphaned Objects',	1✔
10	params: {	1✔
11	type: 'object',	1✔
12	properties: {	1✔
13	tenantId: { type: 'string' },	1✔
14	bucketId: { type: 'string' },	1✔
15	},	1✔
16	required: ['tenantId', 'bucketId'],	1✔
17	},	1✔
18	query: {	1✔
19	type: 'object',	1✔
20	properties: {	1✔
21	before: { type: 'string' },	1✔
22	keepTmpTable: { type: 'boolean' },	1✔
23	},	1✔
24	},	1✔
25	} as const	1✔
26		1✔
27	const syncOrphanedObjects = {	1✔
28	description: 'Sync Orphaned Objects',	1✔
29	params: {	1✔
30	type: 'object',	1✔
31	properties: {	1✔
32	tenantId: { type: 'string' },	1✔
33	bucketId: { type: 'string' },	1✔
34	},	1✔
35	required: ['tenantId', 'bucketId'],	1✔
36	},	1✔
37	body: {	1✔
38	type: 'object',	1✔
39	properties: {	1✔
40	deleteDbKeys: { type: 'boolean' },	1✔
41	deleteS3Keys: { type: 'boolean' },	1✔
42	tmpTable: { type: 'string' },	1✔
43	},	1✔
44	},	1✔
45	optional: ['deleteDbKeys', 'deleteS3Keys'],	1✔
46	} as const	1✔
47		1✔
48	interface ListOrphanObjectsRequest extends RequestGenericInterface {	1✔
49	Params: {	1✔
50	tenantId: string	1✔
51	bucketId: string	1✔
52	}	1✔
53	Querystring: {	1✔
54	before?: string	1✔
55	keepTmpTable?: boolean	1✔
56	}	1✔
57	}	1✔
58		1✔
59	interface SyncOrphanObjectsRequest extends RequestGenericInterface {	1✔
60	Params: {	1✔
61	tenantId: string	1✔
62	bucketId: string	1✔
63	}	1✔
64	Body: {	1✔
65	deleteDbKeys?: boolean	1✔
66	deleteS3Keys?: boolean	1✔
67	before?: string	1✔
68	tmpTable?: string	1✔
69	keepTmpTable?: boolean	1✔
70	}	1✔
71	}	1✔
72		1✔
73	export default async function routes(fastify: FastifyInstance) {	1✔
74	fastify.register(apiKey)	8✔
75	fastify.register(dbSuperUser, {	8✔
76	disableHostCheck: true,	8✔
77	maxConnections: 5,	8✔
78	})	8✔
79	fastify.register(storage)	8✔
80		8✔
81	fastify.get<ListOrphanObjectsRequest>(	8✔
82	'/:tenantId/buckets/:bucketId/orphan-objects',	8✔
83	{	8✔
84	schema: { ...listOrphanedObjects, tags: ['object'] },	8✔
85	},	8✔
86	async (req, reply) => {	8✔
87	const bucket = req.params.bucketId	×
88	let before = req.query.before ? new Date(req.query.before as string) : undefined	×
89		×
90	if (before && isNaN(before.getTime())) {	×
91	return reply.status(400).send({	×
92	error: 'Invalid date format',	×
93	})	×
94	}	×
95	if (!before) {	×
96	before = new Date()	×
97	before.setHours(before.getHours() - 1)	×
98	}	×
99		×
100	const scanner = new ObjectScanner(req.storage)	×
101	const orphanObjects = scanner.listOrphaned(bucket, {	×
102	signal: req.signals.disconnect.signal,	×
103	before,	×
104	keepTmpTable: Boolean(req.query.keepTmpTable),	×
105	})	×
106		×
107	reply.header('Content-Type', 'application/x-ndjson; charset=utf-8')	×
108		×
109	// Do not let the connection time out, periodically send	×
110	// a ping message to keep the connection alive	×
111	const respPing = ping(reply)	×
112		×
113	try {	×
114	for await (const result of orphanObjects) {	×
115	if (result.value.length > 0) {	×
116	respPing.update()	×
117	reply.raw.write(	×
118	JSON.stringify({	×
119	...result,	×
120	event: 'data',	×
121	}) + '\n'	×
122	)	×
123	}	×
124	}	×
125	} catch (e) {	×
NEW 126	reply.raw.write(	×
NEW 127	JSON.stringify({	×
NEW 128	event: 'error',	×
NEW 129	error: StorageBackendError.fromError(e),	×
NEW 130	}) + '\n'	×
NEW 131	)	×
132	throw e	×
133	} finally {	×
134	respPing.clear()	×
135	reply.raw.end()	×
136	}	×
137	}	×
138	)	8✔
139		8✔
140	fastify.delete<SyncOrphanObjectsRequest>(	8✔
141	'/:tenantId/buckets/:bucketId/orphan-objects',	8✔
142	{	8✔
143	schema: { ...syncOrphanedObjects, tags: ['object'] },	8✔
144	},	8✔
145	async (req, reply) => {	8✔
146	if (!req.body.deleteDbKeys && !req.body.deleteS3Keys) {	×
147	return reply.status(400).send({	×
148	error: 'At least one of deleteDbKeys or deleteS3Keys must be set to true',	×
149	})	×
150	}	×
151		×
152	const bucket = `${req.params.bucketId}`	×
153	let before = req.body.before ? new Date(req.body.before as string) : undefined	×
154		×
155	if (!before) {	×
156	before = new Date()	×
157	before.setHours(before.getHours() - 1)	×
158	}	×
159		×
160	reply.header('Content-Type', 'application/x-ndjson; charset=utf-8')	×
161		×
162	const respPing = ping(reply)	×
163		×
164	try {	×
165	const scanner = new ObjectScanner(req.storage)	×
166	const result = scanner.deleteOrphans(bucket, {	×
167	deleteDbKeys: req.body.deleteDbKeys,	×
168	deleteS3Keys: req.body.deleteS3Keys,	×
169	signal: req.signals.disconnect.signal,	×
170	before,	×
171	tmpTable: req.body.tmpTable,	×
172	})	×
173		×
174	for await (const deleted of result) {	×
175	respPing.update()	×
176	reply.raw.write(	×
177	JSON.stringify({	×
178	...deleted,	×
179	event: 'data',	×
180	}) + '\n'	×
181	)	×
182	}	×
183	} catch (e) {	×
NEW 184	reply.raw.write(	×
NEW 185	JSON.stringify({	×
NEW 186	event: 'error',	×
NEW 187	error: StorageBackendError.fromError(e),	×
NEW 188	}) + '\n'	×
NEW 189	)	×
190	throw e	×
191	} finally {	×
192	respPing.clear()	×
193	reply.raw.end()	×
194	}	×
195	}	×
196	)	8✔
197	}	8✔
198		1✔
199	// Occasionally write a ping message to the response stream	1✔
200	function ping(reply: FastifyReply) {	×
201	let lastSend = undefined as Date \| undefined	×
202	const clearPing = setInterval(() => {	×
203	const fiveSecondsEarly = new Date()	×
204	fiveSecondsEarly.setSeconds(fiveSecondsEarly.getSeconds() - 5)	×
205		×
206	if (!lastSend \|\| (lastSend && lastSend < fiveSecondsEarly)) {	×
207	lastSend = new Date()	×
208	reply.raw.write(	×
209	JSON.stringify({	×
210	event: 'ping',	×
211	}) + '\n'	×
212	)	×
213	}	×
214	}, 1000 * 10)	×
215		×
216	return {	×
217	clear: () => clearInterval(clearPing),	×
218	update: () => {	×
219	lastSend = new Date()	×
220	},	×
221	}	×
222	}	×

supabase / storage / 23890434792

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