• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

supabase / storage / 23244827301

18 Mar 2026 12:32PM UTC coverage: 76.573% (+0.002%) from 76.571%
23244827301

Pull #917

github

web-flow
Merge b87ce702f into d9fb9c058
Pull Request #917: feat: support for watt process runner

4067 of 5777 branches covered (70.4%)

Branch coverage included in aggregate %.

5 of 6 new or added lines in 4 files covered. (83.33%)

2 existing lines in 1 file now uncovered.

26910 of 34677 relevant lines covered (77.6%)

186.29 hits per line

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

10.12
/src/internal/queue/queue.ts
1
import { ERRORS } from '@internal/errors'
2✔
2
import { QueueDB } from '@internal/queue/database'
2✔
3
import { Semaphore } from '@shopify/semaphore'
2✔
4
import PgBoss, { Db, Job, JobWithMetadata } from 'pg-boss'
2✔
5
import { getConfig } from '../../config'
2✔
6
import { logger, logSchema } from '../monitoring'
2✔
7
import { queueJobCompleted, queueJobError, queueJobRetryFailed } from '../monitoring/metrics'
2✔
8
import { Event } from './event'
2✔
9

2✔
10
type SubclassOfBaseClass = (new (
2✔
11
  payload: any
2✔
12
) => Event<any>) & {
2✔
13
  [K in keyof typeof Event]: (typeof Event)[K]
2✔
14
}
2✔
15

2✔
16
export abstract class Queue {
2✔
17
  protected static events: SubclassOfBaseClass[] = []
2✔
18
  private static pgBoss?: PgBoss
2✔
19
  private static pgBossDb?: PgBoss.Db
2✔
20

2✔
21
  static createPgBoss(opts: { db: Db; enableWorkers: boolean }) {
2✔
22
    const {
×
23
      isMultitenant,
×
24
      databaseURL,
×
25
      multitenantDatabasePoolUrl,
×
26
      multitenantDatabaseUrl,
×
27
      pgQueueConnectionURL,
×
28
      pgQueueArchiveCompletedAfterSeconds,
×
29
      pgQueueDeleteAfterDays,
×
30
      pgQueueDeleteAfterHours,
×
31
      pgQueueRetentionDays,
×
32
    } = getConfig()
×
33

×
34
    let url = pgQueueConnectionURL ?? databaseURL
×
35
    let migrate = true
×
36

×
37
    if (isMultitenant && !pgQueueConnectionURL) {
×
38
      if (!multitenantDatabaseUrl) {
×
39
        throw new Error(
×
40
          'running storage in multi-tenant but DB_MULTITENANT_DATABASE_URL is not set'
×
41
        )
×
42
      }
×
43
      url = multitenantDatabasePoolUrl || multitenantDatabaseUrl
×
44

×
45
      if (multitenantDatabasePoolUrl) {
×
46
        migrate = false
×
47
      }
×
48
    }
×
49

×
50
    return new PgBoss({
×
51
      connectionString: url,
×
52
      migrate,
×
53
      db: opts.db,
×
54
      schema: 'pgboss_v10',
×
55
      ...(pgQueueDeleteAfterHours
×
56
        ? { deleteAfterHours: pgQueueDeleteAfterHours }
×
57
        : { deleteAfterDays: pgQueueDeleteAfterDays }),
×
58
      archiveCompletedAfterSeconds: pgQueueArchiveCompletedAfterSeconds,
×
59
      retentionDays: pgQueueRetentionDays,
×
60
      retryBackoff: true,
×
61
      retryLimit: 20,
×
62
      expireInHours: 23,
×
63
      maintenanceIntervalSeconds: 60 * 5,
×
64
      schedule: opts.enableWorkers,
×
65
      supervise: opts.enableWorkers,
×
66
    })
×
67
  }
×
68

2✔
69
  static async start(opts: {
2✔
70
    signal?: AbortSignal
×
71
    onMessage?: (job: Job) => void
×
72
    registerWorkers?: () => void
×
73
  }) {
×
74
    if (Queue.pgBoss) {
×
75
      return Queue.pgBoss
×
76
    }
×
77

×
78
    if (opts.signal?.aborted) {
×
79
      throw ERRORS.Aborted('Cannot start queue with aborted signal')
×
80
    }
×
81

×
82
    const {
×
83
      isMultitenant,
×
84
      databaseURL,
×
85
      multitenantDatabaseUrl,
×
86
      multitenantDatabasePoolUrl,
×
87
      pgQueueConnectionURL,
×
88
      pgQueueEnableWorkers,
×
89
      pgQueueReadWriteTimeout,
×
90
      pgQueueConcurrentTasksPerQueue,
×
91
      pgQueueMaxConnections,
×
92
    } = getConfig()
×
93

×
94
    let url = pgQueueConnectionURL || databaseURL
×
95

×
96
    if (isMultitenant && !pgQueueConnectionURL) {
×
97
      if (!multitenantDatabaseUrl && !multitenantDatabasePoolUrl) {
×
98
        throw new Error(
×
99
          'running storage in multi-tenant but DB_MULTITENANT_DATABASE_URL is not set'
×
100
        )
×
101
      }
×
102
      url = (multitenantDatabasePoolUrl || multitenantDatabaseUrl) as string
×
103
    }
×
104

×
105
    Queue.pgBossDb = new QueueDB({
×
106
      min: 0,
×
107
      max: pgQueueMaxConnections,
×
108
      connectionString: url,
×
109
      statement_timeout: pgQueueReadWriteTimeout > 0 ? pgQueueReadWriteTimeout : undefined,
×
110
    })
×
111

×
112
    Queue.pgBoss = this.createPgBoss({
×
113
      db: Queue.pgBossDb,
×
114
      enableWorkers: pgQueueEnableWorkers !== false,
×
115
    })
×
116

×
117
    Queue.pgBoss.on('error', (error) => {
×
118
      logSchema.error(logger, '[Queue] error', {
×
119
        type: 'queue',
×
120
        error,
×
121
      })
×
122
    })
×
123

×
124
    await Queue.pgBoss.start()
×
125

×
126
    if (opts.registerWorkers && pgQueueEnableWorkers) {
×
127
      opts.registerWorkers()
×
128
    }
×
129

×
130
    await Queue.callStart()
×
131
    await Queue.startWorkers({
×
132
      maxConcurrentTasks: pgQueueConcurrentTasksPerQueue,
×
133
      onMessage: opts.onMessage,
×
134
      signal: opts.signal,
×
135
    })
×
136

×
137
    if (opts.signal) {
×
138
      opts.signal.addEventListener(
×
139
        'abort',
×
140
        async () => {
×
141
          logSchema.info(logger, '[Queue] Stopping', {
×
142
            type: 'queue',
×
143
          })
×
144
          return Queue.stop()
×
145
            .then(async () => {
×
146
              logSchema.info(logger, '[Queue] Exited', {
×
147
                type: 'queue',
×
148
              })
×
149
            })
×
150
            .catch((e) => {
×
151
              logSchema.error(logger, '[Queue] Error while stopping queue', {
×
152
                error: e,
×
153
                type: 'queue',
×
154
              })
×
155
            })
×
156
            .finally(async () => {
×
157
              await Queue.callClose().catch(() => {
×
158
                // no-op
×
159
              })
×
160
            })
×
161
        },
×
162
        { once: true }
×
163
      )
×
164
    }
×
165

×
166
    return Queue.pgBoss
×
167
  }
×
168

2✔
169
  static getInstance() {
2✔
170
    if (!this.pgBoss) {
×
171
      throw new Error('pg boss not initialised')
×
172
    }
×
173

×
174
    return this.pgBoss
×
175
  }
×
176

2✔
177
  static getDb() {
2✔
178
    if (!this.pgBossDb) {
×
179
      throw new Error('pg boss not initialised')
×
180
    }
×
181

×
182
    return this.pgBossDb
×
183
  }
×
184

2✔
185
  static register<T extends SubclassOfBaseClass>(event: T) {
2✔
186
    Queue.events.push(event)
×
187
  }
×
188

2✔
189
  static async stop() {
2✔
190
    if (!this.pgBoss) {
×
191
      return
×
192
    }
×
193

×
194
    const boss = this.pgBoss
×
195
    const { isProduction } = getConfig()
×
196

×
197
    await boss.stop({
×
198
      timeout: 20 * 1000,
×
199
      graceful: isProduction,
×
200
      wait: true,
×
201
    })
×
202

×
NEW
203
    await this.callClose()
×
204

×
205
    Queue.pgBoss = undefined
×
206
  }
×
207

2✔
208
  protected static async startWorkers(opts: {
2✔
209
    maxConcurrentTasks: number
×
210
    signal?: AbortSignal
×
211
    onMessage?: (job: Job) => void
×
212
  }) {
×
213
    for (const event of Queue.events) {
×
214
      await Queue.registerTask(event, opts.maxConcurrentTasks, opts.onMessage, opts.signal)
×
215
    }
×
216
  }
×
217

2✔
218
  protected static callStart() {
2✔
219
    const events = Queue.events.map((event) => {
×
220
      return event.onStart()
×
221
    })
×
222

×
223
    return Promise.all(events)
×
224
  }
×
225

2✔
226
  protected static callClose() {
2✔
227
    const events = Queue.events.map((event) => {
×
228
      return event.onClose()
×
229
    })
×
230

×
231
    return Promise.all(events)
×
232
  }
×
233

2✔
234
  protected static async registerTask(
2✔
235
    event: SubclassOfBaseClass,
×
236
    maxConcurrentTasks: number,
×
237
    onMessage?: (job: Job) => void,
×
238
    signal?: AbortSignal
×
239
  ) {
×
240
    const queueName = event.getQueueName()
×
241
    const deadLetterName = event.deadLetterQueueName()
×
242

×
243
    const concurrentTaskCount = event.getWorkerOptions().concurrentTaskCount || maxConcurrentTasks
×
244
    try {
×
245
      // Create dead-letter queue and the normal queue
×
246
      const queueOptions = {
×
247
        policy: 'standard',
×
248
        ...event.getQueueOptions(),
×
249
      } as const
×
250

×
251
      // dead-letter
×
252
      await this.pgBoss?.createQueue(deadLetterName, {
×
253
        ...queueOptions,
×
254
        name: deadLetterName,
×
255
        retentionDays: 30,
×
256
        retryBackoff: true,
×
257
      })
×
258

×
259
      // // normal queue
×
260
      await this.pgBoss?.createQueue(queueName, {
×
261
        ...queueOptions,
×
262
        name: queueName,
×
263
        deadLetter: deadLetterName,
×
264
      })
×
265
    } catch {
×
266
      // no-op
×
267
    }
×
268

×
269
    return this.pollQueue(event, {
×
270
      concurrentTaskCount,
×
271
      onMessage,
×
272
      signal,
×
273
    })
×
274
  }
×
275

2✔
276
  protected static pollQueue(
2✔
277
    event: SubclassOfBaseClass,
×
278
    queueOpts: {
×
279
      concurrentTaskCount: number
×
280
      onMessage?: (job: Job) => void
×
281
      signal?: AbortSignal
×
282
    }
×
283
  ) {
×
284
    const semaphore = new Semaphore(queueOpts.concurrentTaskCount)
×
285
    const pollingInterval = (event.getWorkerOptions().pollingIntervalSeconds || 5) * 1000
×
286
    const batchSize =
×
287
      event.getWorkerOptions().batchSize ||
×
288
      queueOpts.concurrentTaskCount + Math.max(1, Math.floor(queueOpts.concurrentTaskCount * 1.2))
×
289

×
290
    logSchema.info(logger, `[Queue] Polling queue ${event.getQueueName()}`, {
×
291
      type: 'queue',
×
292
      metadata: JSON.stringify({
×
293
        queueName: event.getQueueName(),
×
294
        batchSize,
×
295
        pollingInterval,
×
296
      }),
×
297
    })
×
298

×
299
    let started = false
×
300
    let jobFetched = 0
×
301

×
302
    const interval = setInterval(async () => {
×
303
      if (started) {
×
304
        return
×
305
      }
×
306

×
307
      try {
×
308
        started = true
×
309
        const defaultFetch = {
×
310
          includeMetadata: true,
×
311
          batchSize,
×
312
        }
×
313

×
314
        const currentBatch = defaultFetch.batchSize - jobFetched
×
315

×
316
        if (currentBatch <= 0) {
×
317
          return
×
318
        }
×
319

×
320
        const jobs = await this.pgBoss?.fetch(event.getQueueName(), {
×
321
          ...event.getWorkerOptions(),
×
322
          ...defaultFetch,
×
323
          batchSize: currentBatch,
×
324
        })
×
325

×
326
        jobFetched += jobs?.length || 0
×
327

×
328
        if (jobFetched < defaultFetch.batchSize) {
×
329
          started = false
×
330
        }
×
331

×
332
        if (queueOpts.signal?.aborted) {
×
333
          started = false
×
334
          return
×
335
        }
×
336

×
337
        if (!jobs || (jobs && jobs.length === 0)) {
×
338
          started = false
×
339
          return
×
340
        }
×
341

×
342
        await Promise.allSettled(
×
343
          jobs.map(async (job) => {
×
344
            const lock = await semaphore.acquire()
×
345
            try {
×
346
              queueOpts.onMessage?.(job as Job)
×
347

×
348
              await event.handle(job, { signal: queueOpts.signal })
×
349

×
350
              await this.pgBoss?.complete(event.getQueueName(), job.id)
×
351
              queueJobCompleted.add(1, {
×
352
                name: event.getQueueName(),
×
353
              })
×
354
            } catch (e) {
×
355
              queueJobRetryFailed.add(1, {
×
356
                name: event.getQueueName(),
×
357
              })
×
358

×
359
              await this.pgBoss?.fail(event.getQueueName(), job.id)
×
360

×
361
              try {
×
362
                const dbJob: JobWithMetadata | null =
×
363
                  (job as JobWithMetadata).priority !== undefined
×
364
                    ? (job as JobWithMetadata)
×
365
                    : await Queue.getInstance().getJobById(event.getQueueName(), job.id)
×
366

×
367
                if (!dbJob) {
×
368
                  return
×
369
                }
×
370
                if (dbJob.retryCount >= dbJob.retryLimit) {
×
371
                  queueJobError.add(1, {
×
372
                    name: event.getQueueName(),
×
373
                  })
×
374
                }
×
375
              } catch (e) {
×
376
                logSchema.error(logger, `[Queue Handler] fetching job ${event.name}`, {
×
377
                  type: 'queue-task',
×
378
                  error: e,
×
379
                  metadata: JSON.stringify(job),
×
380
                })
×
381
              }
×
382

×
383
              logSchema.error(logger, `[Queue Handler] Error while processing job ${event.name}`, {
×
384
                type: 'queue-task',
×
385
                error: e,
×
386
                metadata: JSON.stringify(job),
×
387
              })
×
388

×
389
              throw e
×
390
            } finally {
×
391
              jobFetched = Math.max(0, jobFetched - 1)
×
392
              await lock.release()
×
393
            }
×
394
          })
×
395
        )
×
396
      } catch (e) {
×
397
        logSchema.error(logger, `[Queue] Error while polling queue ${event.name}`, {
×
398
          type: 'queue',
×
399
          error: e,
×
400
          metadata: JSON.stringify({
×
401
            queueName: event.getQueueName(),
×
402
            batchSize,
×
403
            pollingInterval,
×
404
          }),
×
405
        })
×
406
      } finally {
×
407
        started = false
×
408
      }
×
409
    }, pollingInterval)
×
410

×
411
    queueOpts.signal?.addEventListener('abort', () => {
×
412
      clearInterval(interval)
×
413
    })
×
414
  }
×
415
}
2✔
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc