12812169016

Committed 16 Jan 2025 03:29PM UTC coverage: 77.287% (-0.7%) from 78.025%

Build # 12812169016

Build Type

Pull #606

github

Committed by

web-flow

Commit Message

Merge 30bf14150 into c8d9fd8ba

Pull Request Pull Request #606: feat: reconcile orphan objects from admin endpoint

Coverage Stats

1278 of 1809 branches covered (70.65%)

Branch coverage included in aggregate %.

894 of 1319 new or added lines in 26 files covered. (67.78%)

1 existing line in 1 file now uncovered.

15151 of 19448 relevant lines covered (77.91%)

159.71 hits per line

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

46.5

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

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

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' },
    },
  },
} 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' },
    },
  },
  optional: ['deleteDbKeys', 'deleteS3Keys'],
} as const

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

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

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,
    },
    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: before,
      })

      reply.header('Content-Type', 'application/json; 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',
              })
            )
          }
        }
      } catch (e) {
        throw e
      } finally {
        respPing.clear()
        reply.raw.end()
      }
    }
  )

  fastify.delete<SyncOrphanObjectsRequest>(
    '/:tenantId/buckets/:bucketId/orphan-objects',
    {
      schema: syncOrphanedObjects,
    },
    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)
      }

      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,
        })

        for await (const deleted of result) {
          respPing.update()
          reply.raw.write(
            JSON.stringify({
              ...deleted,
              event: 'data',
            })
          )
        }
      } catch (e) {
        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',
        })
      )
    }
  }, 1000 * 10)

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

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

supabase / storage / 12812169016

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