@shivaedev/jobs 0.29.2 → 0.31.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +39 -0
- package/README.md +74 -22
- package/dist/display.d.ts +14 -0
- package/dist/display.d.ts.map +1 -0
- package/dist/display.js +2 -0
- package/dist/display.js.map +1 -0
- package/dist/server/ClientDatabase.d.ts +21 -0
- package/dist/server/ClientDatabase.d.ts.map +1 -0
- package/dist/server/ClientDatabase.js +2 -0
- package/dist/server/ClientDatabase.js.map +1 -0
- package/dist/server/PgBoss.d.ts +2 -2
- package/dist/server/PgBoss.d.ts.map +1 -1
- package/dist/server/adapters/batchClockOffset.d.ts +2 -2
- package/dist/server/adapters/batchClockOffset.d.ts.map +1 -1
- package/dist/server/adapters/batchClockOffset.js +5 -4
- package/dist/server/adapters/batchClockOffset.js.map +1 -1
- package/dist/server/adapters/batchHandler.d.ts +5 -0
- package/dist/server/adapters/batchHandler.d.ts.map +1 -0
- package/dist/server/{internal → adapters}/batchHandler.js +6 -6
- package/dist/server/adapters/batchHandler.js.map +1 -0
- package/dist/server/adapters/clientCache.d.ts +10 -0
- package/dist/server/adapters/clientCache.d.ts.map +1 -0
- package/dist/server/{internal → adapters}/clientCache.js +5 -19
- package/dist/server/adapters/clientCache.js.map +1 -0
- package/dist/server/adapters/clientErrorLogger.js +1 -1
- package/dist/server/adapters/clientErrorLogger.js.map +1 -1
- package/dist/server/adapters/defaultClientFactory.d.ts +4 -0
- package/dist/server/adapters/defaultClientFactory.d.ts.map +1 -0
- package/dist/server/adapters/defaultClientFactory.js.map +1 -0
- package/dist/server/adapters/deferralCount.d.ts +3 -3
- package/dist/server/adapters/deferralCount.d.ts.map +1 -1
- package/dist/server/adapters/deferralCount.js +2 -2
- package/dist/server/adapters/deferralCount.js.map +1 -1
- package/dist/server/adapters/expireAttempt.d.ts +4 -0
- package/dist/server/adapters/expireAttempt.d.ts.map +1 -0
- package/dist/server/{internal → adapters}/expireAttempt.js +1 -1
- package/dist/server/{internal → adapters}/expireAttempt.js.map +1 -1
- package/dist/server/adapters/installSchema.d.ts +1 -1
- package/dist/server/adapters/installSchema.d.ts.map +1 -1
- package/dist/server/adapters/installSchema.js +1 -1
- package/dist/server/adapters/installSchema.js.map +1 -1
- package/dist/server/adapters/jobEngine.d.ts +5 -0
- package/dist/server/adapters/jobEngine.d.ts.map +1 -0
- package/dist/server/adapters/jobEngine.js +50 -0
- package/dist/server/adapters/jobEngine.js.map +1 -0
- package/dist/server/adapters/lifecycle.d.ts +11 -0
- package/dist/server/adapters/lifecycle.d.ts.map +1 -0
- package/dist/server/adapters/lifecycle.js +48 -0
- package/dist/server/adapters/lifecycle.js.map +1 -0
- package/dist/server/adapters/listJobs.d.ts +5 -0
- package/dist/server/adapters/listJobs.d.ts.map +1 -0
- package/dist/server/adapters/listJobs.js +37 -0
- package/dist/server/adapters/listJobs.js.map +1 -0
- package/dist/server/adapters/observeTestingSettlements.d.ts +6 -0
- package/dist/server/adapters/observeTestingSettlements.d.ts.map +1 -0
- package/dist/server/adapters/observeTestingSettlements.js.map +1 -0
- package/dist/server/adapters/queueAdministration.d.ts +4 -0
- package/dist/server/adapters/queueAdministration.d.ts.map +1 -0
- package/dist/server/adapters/queueAdministration.js +42 -0
- package/dist/server/adapters/queueAdministration.js.map +1 -0
- package/dist/server/adapters/registerWorker.d.ts +5 -3
- package/dist/server/adapters/registerWorker.d.ts.map +1 -1
- package/dist/server/adapters/registerWorker.js +16 -7
- package/dist/server/adapters/registerWorker.js.map +1 -1
- package/dist/server/adapters/retireJobs.d.ts +3 -3
- package/dist/server/adapters/retireJobs.d.ts.map +1 -1
- package/dist/server/adapters/retireJobs.js +3 -3
- package/dist/server/adapters/retireJobs.js.map +1 -1
- package/dist/server/adapters/schemaIndexBuilds.d.ts +2 -2
- package/dist/server/adapters/schemaIndexBuilds.d.ts.map +1 -1
- package/dist/server/adapters/schemaIndexBuilds.js.map +1 -1
- package/dist/server/adapters/settleDeferral.d.ts +7 -0
- package/dist/server/adapters/settleDeferral.d.ts.map +1 -0
- package/dist/server/{internal → adapters}/settleDeferral.js +2 -2
- package/dist/server/adapters/settleDeferral.js.map +1 -0
- package/dist/server/adapters/testingClient.d.ts +14 -0
- package/dist/server/adapters/testingClient.d.ts.map +1 -0
- package/dist/server/{internal → adapters}/testingClient.js +15 -11
- package/dist/server/adapters/testingClient.js.map +1 -0
- package/dist/server/adapters/testingController.d.ts +34 -0
- package/dist/server/adapters/testingController.d.ts.map +1 -0
- package/dist/server/adapters/testingController.js +98 -0
- package/dist/server/adapters/testingController.js.map +1 -0
- package/dist/server/adapters/testingDueNow.d.ts +3 -3
- package/dist/server/adapters/testingDueNow.d.ts.map +1 -1
- package/dist/server/adapters/testingDueNow.js +2 -2
- package/dist/server/adapters/testingDueNow.js.map +1 -1
- package/dist/server/adapters/testingEngine.d.ts +5 -0
- package/dist/server/adapters/testingEngine.d.ts.map +1 -0
- package/dist/server/adapters/testingEngine.js +23 -0
- package/dist/server/adapters/testingEngine.js.map +1 -0
- package/dist/server/adapters/testingExpirations.d.ts +6 -4
- package/dist/server/adapters/testingExpirations.d.ts.map +1 -1
- package/dist/server/adapters/testingExpirations.js.map +1 -1
- package/dist/server/adapters/transactionDb.d.ts +2 -2
- package/dist/server/adapters/transactionDb.d.ts.map +1 -1
- package/dist/server/adapters/transactionDb.js.map +1 -1
- package/dist/server/client.d.ts +92 -18
- package/dist/server/client.d.ts.map +1 -1
- package/dist/server/clientOptions.d.ts +75 -0
- package/dist/server/clientOptions.d.ts.map +1 -0
- package/dist/server/clientOptions.js +2 -0
- package/dist/server/clientOptions.js.map +1 -0
- package/dist/server/defineSchedule.d.ts +1 -1
- package/dist/server/defineSchedule.d.ts.map +1 -1
- package/dist/server/defineSchedule.js +2 -1
- package/dist/server/defineSchedule.js.map +1 -1
- package/dist/server/definition.d.ts +20 -18
- package/dist/server/definition.d.ts.map +1 -1
- package/dist/server/definition.js +3 -1
- package/dist/server/definition.js.map +1 -1
- package/dist/server/engineClient.d.ts +26 -0
- package/dist/server/engineClient.d.ts.map +1 -0
- package/dist/server/engineClient.js +2 -0
- package/dist/server/engineClient.js.map +1 -0
- package/dist/server/enqueueOptions.d.ts +22 -0
- package/dist/server/enqueueOptions.d.ts.map +1 -0
- package/dist/server/enqueueOptions.js +2 -0
- package/dist/server/enqueueOptions.js.map +1 -0
- package/dist/server/error.d.ts +11 -1
- package/dist/server/error.d.ts.map +1 -1
- package/dist/server/error.js +8 -1
- package/dist/server/error.js.map +1 -1
- package/dist/server/health.d.ts +2 -2
- package/dist/server/health.d.ts.map +1 -1
- package/dist/server/internal/acquireClient.d.ts +11 -0
- package/dist/server/internal/acquireClient.d.ts.map +1 -0
- package/dist/server/internal/acquireClient.js +21 -0
- package/dist/server/internal/acquireClient.js.map +1 -0
- package/dist/server/internal/adapters/testingFetches.d.ts +2 -2
- package/dist/server/internal/adapters/testingFetches.d.ts.map +1 -1
- package/dist/server/internal/adapters/testingFetches.js.map +1 -1
- package/dist/server/internal/clientErrors.d.ts +1 -1
- package/dist/server/internal/clientErrors.d.ts.map +1 -1
- package/dist/server/internal/countsFor.d.ts +3 -3
- package/dist/server/internal/countsFor.d.ts.map +1 -1
- package/dist/server/internal/countsFor.js +2 -2
- package/dist/server/internal/countsFor.js.map +1 -1
- package/dist/server/internal/deadLetterResolutionPlan.js +1 -1
- package/dist/server/internal/deadLetterResolutionPlan.js.map +1 -1
- package/dist/server/internal/deadlineOf.d.ts +2 -2
- package/dist/server/internal/deadlineOf.d.ts.map +1 -1
- package/dist/server/internal/deadlineOf.js.map +1 -1
- package/dist/server/internal/deferrableAttempt.d.ts +4 -5
- package/dist/server/internal/deferrableAttempt.d.ts.map +1 -1
- package/dist/server/internal/deferrableAttempt.js +5 -14
- package/dist/server/internal/deferrableAttempt.js.map +1 -1
- package/dist/server/internal/deferral.d.ts +3 -3
- package/dist/server/internal/deferral.d.ts.map +1 -1
- package/dist/server/internal/deferral.js.map +1 -1
- package/dist/server/internal/deferralStorePlan.js +2 -2
- package/dist/server/internal/deferralStorePlan.js.map +1 -1
- package/dist/server/internal/definitionOptions.d.ts +7 -7
- package/dist/server/internal/definitionOptions.d.ts.map +1 -1
- package/dist/server/internal/engine.d.ts +30 -0
- package/dist/server/internal/engine.d.ts.map +1 -0
- package/dist/server/internal/engine.js +6 -0
- package/dist/server/internal/engine.js.map +1 -0
- package/dist/server/internal/enqueueFor.d.ts +2 -2
- package/dist/server/internal/enqueueFor.d.ts.map +1 -1
- package/dist/server/internal/enqueueFor.js +3 -3
- package/dist/server/internal/enqueueFor.js.map +1 -1
- package/dist/server/internal/ensureQueue.d.ts +2 -3
- package/dist/server/internal/ensureQueue.d.ts.map +1 -1
- package/dist/server/internal/ensureQueue.js +2 -2
- package/dist/server/internal/ensureQueue.js.map +1 -1
- package/dist/server/internal/healthFor.d.ts +3 -3
- package/dist/server/internal/healthFor.d.ts.map +1 -1
- package/dist/server/internal/healthFor.js +2 -2
- package/dist/server/internal/healthFor.js.map +1 -1
- package/dist/server/internal/jobControl.d.ts +9 -4
- package/dist/server/internal/jobControl.d.ts.map +1 -1
- package/dist/server/internal/jobControl.js +13 -40
- package/dist/server/internal/jobControl.js.map +1 -1
- package/dist/server/internal/jobListings.d.ts +16 -0
- package/dist/server/internal/jobListings.d.ts.map +1 -0
- package/dist/server/internal/jobListings.js +52 -0
- package/dist/server/internal/jobListings.js.map +1 -0
- package/dist/server/internal/jobStorePlans.js +2 -2
- package/dist/server/internal/jobStorePlans.js.map +1 -1
- package/dist/server/internal/lifecycle.d.ts +11 -7
- package/dist/server/internal/lifecycle.d.ts.map +1 -1
- package/dist/server/internal/lifecycle.js +2 -49
- package/dist/server/internal/lifecycle.js.map +1 -1
- package/dist/server/internal/makeService.d.ts +5 -3
- package/dist/server/internal/makeService.d.ts.map +1 -1
- package/dist/server/internal/makeService.js +15 -11
- package/dist/server/internal/makeService.js.map +1 -1
- package/dist/server/internal/register.d.ts +5 -5
- package/dist/server/internal/register.d.ts.map +1 -1
- package/dist/server/internal/register.js +17 -29
- package/dist/server/internal/register.js.map +1 -1
- package/dist/server/internal/registerReleasedJobs.d.ts +4 -4
- package/dist/server/internal/registerReleasedJobs.d.ts.map +1 -1
- package/dist/server/internal/registerReleasedJobs.js +2 -2
- package/dist/server/internal/registerReleasedJobs.js.map +1 -1
- package/dist/server/internal/retryWake.d.ts +1 -1
- package/dist/server/internal/retryWake.d.ts.map +1 -1
- package/dist/server/internal/retryWake.js +2 -2
- package/dist/server/internal/retryWake.js.map +1 -1
- package/dist/server/internal/runQueueWorker.d.ts +6 -4
- package/dist/server/internal/runQueueWorker.d.ts.map +1 -1
- package/dist/server/internal/runQueueWorker.js +5 -5
- package/dist/server/internal/runQueueWorker.js.map +1 -1
- package/dist/server/internal/storedRows.d.ts +2 -2
- package/dist/server/internal/storedRows.d.ts.map +1 -1
- package/dist/server/internal/storedRows.js +2 -2
- package/dist/server/internal/storedRows.js.map +1 -1
- package/dist/server/internal/testingDeferrals.d.ts +3 -3
- package/dist/server/internal/testingDeferrals.d.ts.map +1 -1
- package/dist/server/internal/testingDeferrals.js +2 -2
- package/dist/server/internal/testingDeferrals.js.map +1 -1
- package/dist/server/internal/testingIdle.d.ts +3 -3
- package/dist/server/internal/testingIdle.d.ts.map +1 -1
- package/dist/server/internal/testingIdle.js +11 -5
- package/dist/server/internal/testingIdle.js.map +1 -1
- package/dist/server/internal/testingReadout.d.ts +7 -41
- package/dist/server/internal/testingReadout.d.ts.map +1 -1
- package/dist/server/internal/testingReadout.js +2 -2
- package/dist/server/internal/testingReadout.js.map +1 -1
- package/dist/server/internal/testingRegistrations.d.ts +4 -0
- package/dist/server/internal/testingRegistrations.d.ts.map +1 -0
- package/dist/server/internal/testingRegistrations.js +8 -0
- package/dist/server/internal/testingRegistrations.js.map +1 -0
- package/dist/server/internal/testingSchedules.d.ts +3 -3
- package/dist/server/internal/testingSchedules.d.ts.map +1 -1
- package/dist/server/internal/testingSchedules.js +1 -1
- package/dist/server/internal/testingSchedules.js.map +1 -1
- package/dist/server/internal/testingSnapshot.d.ts +4 -4
- package/dist/server/internal/testingSnapshot.d.ts.map +1 -1
- package/dist/server/internal/testingSnapshot.js +7 -4
- package/dist/server/internal/testingSnapshot.js.map +1 -1
- package/dist/server/internal/testingWaits.d.ts +8 -7
- package/dist/server/internal/testingWaits.d.ts.map +1 -1
- package/dist/server/internal/testingWaits.js +3 -3
- package/dist/server/internal/testingWaits.js.map +1 -1
- package/dist/server/internal/tracing.d.ts +2 -2
- package/dist/server/internal/tracing.d.ts.map +1 -1
- package/dist/server/internal/tracing.js.map +1 -1
- package/dist/server/internal/validateQueueNames.d.ts +2 -2
- package/dist/server/internal/validateQueueNames.d.ts.map +1 -1
- package/dist/server/internal/validateQueueNames.js +1 -1
- package/dist/server/internal/validateQueueNames.js.map +1 -1
- package/dist/server/internal/waitForBatchExpiry.d.ts +4 -4
- package/dist/server/internal/waitForBatchExpiry.d.ts.map +1 -1
- package/dist/server/internal/waitForBatchExpiry.js +1 -1
- package/dist/server/internal/waitForBatchExpiry.js.map +1 -1
- package/dist/server/job.d.ts +42 -0
- package/dist/server/job.d.ts.map +1 -0
- package/dist/server/job.js +2 -0
- package/dist/server/job.js.map +1 -0
- package/dist/server/jobModule.d.ts +9 -0
- package/dist/server/jobModule.d.ts.map +1 -0
- package/dist/server/jobModule.js +15 -0
- package/dist/server/jobModule.js.map +1 -0
- package/dist/server/queueOptions.d.ts +19 -0
- package/dist/server/queueOptions.d.ts.map +1 -0
- package/dist/server/queueOptions.js +2 -0
- package/dist/server/queueOptions.js.map +1 -0
- package/dist/server/readJobFailure.d.ts +5 -0
- package/dist/server/readJobFailure.d.ts.map +1 -0
- package/dist/server/readJobFailure.js +8 -0
- package/dist/server/readJobFailure.js.map +1 -0
- package/dist/server/schema.d.ts +1 -1
- package/dist/server/schema.d.ts.map +1 -1
- package/dist/server/schema.js +18 -7
- package/dist/server/schema.js.map +1 -1
- package/dist/server/service.d.ts +15 -10
- package/dist/server/service.d.ts.map +1 -1
- package/dist/server/service.js +26 -33
- package/dist/server/service.js.map +1 -1
- package/dist/server/testing.d.ts +32 -70
- package/dist/server/testing.d.ts.map +1 -1
- package/dist/server/testing.js +9 -96
- package/dist/server/testing.js.map +1 -1
- package/dist/server/workerOptions.d.ts +25 -0
- package/dist/server/workerOptions.d.ts.map +1 -0
- package/dist/server/workerOptions.js +2 -0
- package/dist/server/workerOptions.js.map +1 -0
- package/package.json +11 -16
- package/src/display.ts +12 -0
- package/src/server/ClientDatabase.ts +7 -0
- package/src/server/PgBoss.ts +2 -2
- package/src/server/adapters/batchClockOffset.ts +8 -5
- package/src/server/{internal → adapters}/batchHandler.ts +13 -13
- package/src/server/{internal → adapters}/clientCache.ts +10 -22
- package/src/server/adapters/clientErrorLogger.ts +1 -1
- package/src/server/{defaultClientFactory.ts → adapters/defaultClientFactory.ts} +4 -2
- package/src/server/adapters/deferralCount.ts +5 -5
- package/src/server/{internal → adapters}/expireAttempt.ts +4 -3
- package/src/server/adapters/installSchema.ts +2 -2
- package/src/server/adapters/jobEngine.ts +59 -0
- package/src/server/adapters/lifecycle.ts +67 -0
- package/src/server/adapters/listJobs.ts +43 -0
- package/src/server/{internal → adapters}/observeTestingSettlements.ts +2 -2
- package/src/server/adapters/queueAdministration.ts +47 -0
- package/src/server/adapters/registerWorker.ts +24 -13
- package/src/server/adapters/retireJobs.ts +5 -5
- package/src/server/adapters/schemaIndexBuilds.ts +2 -2
- package/src/server/{internal → adapters}/settleDeferral.ts +5 -5
- package/src/server/{internal → adapters}/testingClient.ts +34 -26
- package/src/server/adapters/testingController.ts +109 -0
- package/src/server/adapters/testingDueNow.ts +5 -5
- package/src/server/adapters/testingEngine.ts +28 -0
- package/src/server/adapters/testingExpirations.ts +6 -4
- package/src/server/adapters/transactionDb.ts +2 -2
- package/src/server/client.ts +83 -30
- package/src/server/clientOptions.ts +81 -0
- package/src/server/defineSchedule.ts +3 -2
- package/src/server/definition.ts +24 -20
- package/src/server/engineClient.ts +24 -0
- package/src/server/enqueueOptions.ts +20 -0
- package/src/server/error.ts +17 -2
- package/src/server/health.ts +2 -2
- package/src/server/internal/acquireClient.ts +26 -0
- package/src/server/internal/adapters/testingFetches.ts +2 -2
- package/src/server/internal/clientErrors.ts +1 -1
- package/src/server/internal/countsFor.ts +5 -5
- package/src/server/internal/deadLetterResolutionPlan.ts +1 -1
- package/src/server/internal/deadlineOf.ts +2 -2
- package/src/server/internal/deferrableAttempt.ts +5 -22
- package/src/server/internal/deferral.ts +3 -3
- package/src/server/internal/deferralStorePlan.ts +2 -2
- package/src/server/internal/definitionOptions.ts +1 -1
- package/src/server/internal/engine.ts +41 -0
- package/src/server/internal/enqueueFor.ts +5 -5
- package/src/server/internal/ensureQueue.ts +5 -6
- package/src/server/internal/healthFor.ts +4 -4
- package/src/server/internal/jobControl.ts +15 -50
- package/src/server/internal/jobListings.ts +85 -0
- package/src/server/internal/jobStorePlans.ts +2 -2
- package/src/server/internal/lifecycle.ts +14 -55
- package/src/server/internal/makeService.ts +21 -13
- package/src/server/internal/register.ts +27 -45
- package/src/server/internal/registerReleasedJobs.ts +6 -6
- package/src/server/internal/retryWake.ts +3 -3
- package/src/server/internal/runQueueWorker.ts +14 -8
- package/src/server/internal/storedRows.ts +3 -3
- package/src/server/internal/testingDeferrals.ts +5 -5
- package/src/server/internal/testingIdle.ts +13 -8
- package/src/server/internal/testingReadout.ts +12 -6
- package/src/server/internal/testingRegistrations.ts +10 -0
- package/src/server/internal/testingSchedules.ts +4 -4
- package/src/server/internal/testingSnapshot.ts +11 -8
- package/src/server/internal/testingWaits.ts +11 -10
- package/src/server/internal/tracing.ts +2 -2
- package/src/server/internal/validateQueueNames.ts +2 -2
- package/src/server/internal/waitForBatchExpiry.ts +4 -4
- package/src/server/job.ts +42 -0
- package/src/server/jobModule.ts +30 -0
- package/src/server/queueOptions.ts +20 -0
- package/src/server/readJobFailure.ts +12 -0
- package/src/server/schema.ts +18 -7
- package/src/server/service.ts +63 -59
- package/src/server/testing.ts +17 -108
- package/src/server/workerOptions.ts +28 -0
- package/dist/server/defaultClientFactory.d.ts +0 -3
- package/dist/server/defaultClientFactory.d.ts.map +0 -1
- package/dist/server/defaultClientFactory.js.map +0 -1
- package/dist/server/internal/batchHandler.d.ts +0 -5
- package/dist/server/internal/batchHandler.d.ts.map +0 -1
- package/dist/server/internal/batchHandler.js.map +0 -1
- package/dist/server/internal/clientCache.d.ts +0 -8
- package/dist/server/internal/clientCache.d.ts.map +0 -1
- package/dist/server/internal/clientCache.js.map +0 -1
- package/dist/server/internal/expireAttempt.d.ts +0 -3
- package/dist/server/internal/expireAttempt.d.ts.map +0 -1
- package/dist/server/internal/listJobs.d.ts +0 -5
- package/dist/server/internal/listJobs.d.ts.map +0 -1
- package/dist/server/internal/listJobs.js +0 -75
- package/dist/server/internal/listJobs.js.map +0 -1
- package/dist/server/internal/observeTestingSettlements.d.ts +0 -6
- package/dist/server/internal/observeTestingSettlements.d.ts.map +0 -1
- package/dist/server/internal/observeTestingSettlements.js.map +0 -1
- package/dist/server/internal/settleDeferral.d.ts +0 -7
- package/dist/server/internal/settleDeferral.d.ts.map +0 -1
- package/dist/server/internal/settleDeferral.js.map +0 -1
- package/dist/server/internal/testingClient.d.ts +0 -13
- package/dist/server/internal/testingClient.d.ts.map +0 -1
- package/dist/server/internal/testingClient.js.map +0 -1
- package/src/server/internal/listJobs.ts +0 -116
- /package/dist/server/{defaultClientFactory.js → adapters/defaultClientFactory.js} +0 -0
- /package/dist/server/{internal → adapters}/observeTestingSettlements.js +0 -0
package/src/server/client.ts
CHANGED
|
@@ -1,39 +1,92 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
1
|
+
import type { ClientDatabase } from "#server/ClientDatabase.ts";
|
|
2
|
+
import type { ClientOptions, StopOptions } from "#server/clientOptions.ts";
|
|
3
|
+
import type { EnqueueOptions, ScheduleOptions } from "#server/enqueueOptions.ts";
|
|
4
|
+
import type { Job, WorkerJob } from "#server/job.ts";
|
|
5
|
+
import type { QueueOptions } from "#server/queueOptions.ts";
|
|
6
|
+
import type { WorkerOptions } from "#server/workerOptions.ts";
|
|
7
|
+
|
|
8
|
+
export interface JobReadOptions {
|
|
9
|
+
readonly after?: string;
|
|
10
|
+
readonly data?: object;
|
|
11
|
+
readonly db?: ClientDatabase;
|
|
12
|
+
readonly id?: string;
|
|
13
|
+
readonly key?: string;
|
|
14
|
+
readonly limit?: number;
|
|
15
|
+
readonly queued?: boolean;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
export interface ClientQueueOptions extends Omit<QueueOptions, "maxDeferrals" | "policy"> {
|
|
19
|
+
readonly deadLetter?: string;
|
|
20
|
+
readonly policy?: string;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
export interface ClientQueue extends ClientQueueOptions {
|
|
24
|
+
readonly activeCount: number;
|
|
25
|
+
readonly blockedCount: number;
|
|
26
|
+
readonly deferredCount: number;
|
|
27
|
+
readonly failedCount: number;
|
|
28
|
+
readonly name: string;
|
|
29
|
+
readonly queuedCount: number;
|
|
30
|
+
readonly readyCount: number;
|
|
31
|
+
readonly totalCount: number;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
export type JobTarget = string | string[] | { id: string; retryCount: number } | { id: string; retryCount: number }[];
|
|
35
|
+
export interface ClientConnectionOptions {
|
|
36
|
+
readonly db?: ClientDatabase;
|
|
37
|
+
}
|
|
38
|
+
export interface ClientUpdateOptions extends Omit<EnqueueOptions, "singletonSeconds" | "singletonNextSlot"> {
|
|
39
|
+
readonly match?: "newest" | "oldest" | "all";
|
|
40
|
+
}
|
|
41
|
+
export interface ClientUpdateRequest {
|
|
42
|
+
data?: object | null;
|
|
43
|
+
name: string;
|
|
44
|
+
options?: ClientUpdateOptions;
|
|
45
|
+
}
|
|
46
|
+
export interface ClientUpdateResult {
|
|
47
|
+
jobs: string[];
|
|
48
|
+
updated: number;
|
|
49
|
+
}
|
|
14
50
|
|
|
15
51
|
export interface PgBossClient {
|
|
16
|
-
readonly complete?:
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
readonly
|
|
23
|
-
readonly
|
|
24
|
-
readonly
|
|
52
|
+
readonly complete?: (
|
|
53
|
+
name: string,
|
|
54
|
+
id: JobTarget,
|
|
55
|
+
data?: object | null,
|
|
56
|
+
options?: ClientConnectionOptions & { includeQueued?: boolean },
|
|
57
|
+
) => Promise<object>;
|
|
58
|
+
readonly createQueue: (name: string, options?: ClientQueueOptions) => Promise<void>;
|
|
59
|
+
readonly deleteQueue?: (name: string) => Promise<void>;
|
|
60
|
+
readonly fail?: (name: string, id: JobTarget, data?: object | null, options?: ClientConnectionOptions) => Promise<object>;
|
|
61
|
+
readonly findJobs?: (name: string, options?: JobReadOptions) => Promise<readonly Job<unknown>[]>;
|
|
62
|
+
readonly getDb?: () => ClientDatabase;
|
|
63
|
+
readonly getQueue: (name: string) => Promise<ClientQueue | null>;
|
|
64
|
+
readonly getSchedule?: (name: string, key?: string) => Promise<{ readonly name: string; readonly key: string } | null>;
|
|
65
|
+
readonly getWipData?: (options?: { includeInternal?: boolean }) => { id: string; workId: string; name: string; count: number }[];
|
|
66
|
+
readonly notifyWorker?: (workerId: string) => void;
|
|
25
67
|
readonly off: (event: "error", listener: (error: Error) => void) => unknown;
|
|
26
|
-
readonly offWork:
|
|
68
|
+
readonly offWork: (name: string, options?: { id?: string; wait?: boolean }) => Promise<void>;
|
|
27
69
|
readonly on: (event: "error", listener: (error: Error) => void) => unknown;
|
|
28
|
-
readonly retry?:
|
|
70
|
+
readonly retry?: (name: string, id: string | string[], options?: ClientConnectionOptions) => Promise<object>;
|
|
29
71
|
readonly schedule: (name: string, cron: string, data?: object | null, options?: ScheduleOptions) => Promise<void>;
|
|
30
|
-
readonly send: (name: string, data?: object | null, options?:
|
|
72
|
+
readonly send: (name: string, data?: object | null, options?: EnqueueOptions) => Promise<string | null>;
|
|
31
73
|
readonly start: () => Promise<unknown>;
|
|
32
74
|
readonly stop: (options?: StopOptions) => Promise<void>;
|
|
33
|
-
readonly
|
|
34
|
-
readonly
|
|
35
|
-
readonly
|
|
36
|
-
|
|
75
|
+
readonly supervise?: (name?: string) => Promise<void>;
|
|
76
|
+
readonly unschedule?: (name: string, key?: string, options?: ClientConnectionOptions) => Promise<void>;
|
|
77
|
+
readonly update?: {
|
|
78
|
+
(request: ClientUpdateRequest): Promise<ClientUpdateResult>;
|
|
79
|
+
(name: string, data: object | null | undefined, options?: ClientUpdateOptions): Promise<ClientUpdateResult>;
|
|
80
|
+
};
|
|
81
|
+
readonly updateQueue?: (
|
|
82
|
+
name: string,
|
|
83
|
+
options: Omit<QueueOptions, "policy" | "partition" | "maxDeferrals" | "heartbeatSeconds" | "retryDelayMax"> & {
|
|
84
|
+
deadLetter?: string | null;
|
|
85
|
+
heartbeatSeconds?: number | null;
|
|
86
|
+
retryDelayMax?: number | null;
|
|
87
|
+
},
|
|
88
|
+
) => Promise<void>;
|
|
89
|
+
readonly work: (name: string, options: WorkerOptions, handler: (jobs: readonly WorkerJob<unknown>[]) => Promise<unknown>) => Promise<string>;
|
|
37
90
|
}
|
|
38
91
|
|
|
39
|
-
export type PgBossClientFactory = (options:
|
|
92
|
+
export type PgBossClientFactory = (options: ClientOptions) => PgBossClient;
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
import type { ClientDatabase } from "#server/ClientDatabase.ts";
|
|
2
|
+
|
|
3
|
+
export interface ClientOptions {
|
|
4
|
+
"__test__enableSpies"?: boolean;
|
|
5
|
+
allowSchemaCaseVariant?: boolean;
|
|
6
|
+
"application_name"?: string;
|
|
7
|
+
|
|
8
|
+
backend?: "postgres" | "cockroachdb" | "yugabytedb" | "citus" | "pglite";
|
|
9
|
+
bamIntervalSeconds?: number;
|
|
10
|
+
|
|
11
|
+
clock?: Clock;
|
|
12
|
+
clockMonitorIntervalSeconds?: number;
|
|
13
|
+
connectionString?: string;
|
|
14
|
+
connectionTimeoutMillis?: number;
|
|
15
|
+
createSchema?: boolean;
|
|
16
|
+
cronMonitorIntervalSeconds?: number;
|
|
17
|
+
cronWorkerIntervalSeconds?: number;
|
|
18
|
+
database?: string;
|
|
19
|
+
db?: ClientDatabase;
|
|
20
|
+
flowIntervalSeconds?: number;
|
|
21
|
+
host?: string;
|
|
22
|
+
instanceHeartbeatSeconds?: number;
|
|
23
|
+
instanceName?: string;
|
|
24
|
+
maintenanceIntervalSeconds?: number;
|
|
25
|
+
max?: number;
|
|
26
|
+
migrate?: boolean;
|
|
27
|
+
monitorIntervalSeconds?: number;
|
|
28
|
+
monitorVacuum?: boolean;
|
|
29
|
+
notifyHeartbeatIntervalMs?: number;
|
|
30
|
+
notifyHeartbeatTimeoutMs?: number;
|
|
31
|
+
notifyKeepAliveInitialDelayMs?: number;
|
|
32
|
+
openTelemetry?: { enabled?: boolean; propagateContext?: boolean };
|
|
33
|
+
options?: string;
|
|
34
|
+
password?: string | (() => string | Promise<string>);
|
|
35
|
+
persistQueueStats?: boolean;
|
|
36
|
+
persistWarnings?: boolean;
|
|
37
|
+
port?: number;
|
|
38
|
+
queueCacheIntervalSeconds?: number;
|
|
39
|
+
queueStatRetentionDays?: number;
|
|
40
|
+
|
|
41
|
+
registerInstance?: boolean;
|
|
42
|
+
reindex?: boolean | ReindexOptions;
|
|
43
|
+
reindexIntervalSeconds?: number;
|
|
44
|
+
|
|
45
|
+
schedule?: boolean;
|
|
46
|
+
schema?: string;
|
|
47
|
+
ssl?: boolean | import("node:tls").ConnectionOptions;
|
|
48
|
+
|
|
49
|
+
supervise?: boolean;
|
|
50
|
+
superviseIntervalSeconds?: number;
|
|
51
|
+
useListenNotify?: boolean;
|
|
52
|
+
user?: string;
|
|
53
|
+
warningQueueSize?: number;
|
|
54
|
+
warningRetentionDays?: number;
|
|
55
|
+
warningSlowQuerySeconds?: number;
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
export interface ReindexOptions extends IndexBloatOptions {
|
|
59
|
+
force?: boolean;
|
|
60
|
+
maxIndexBytes?: number;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
export interface IndexBloatOptions {
|
|
64
|
+
maxEntriesPerPage?: number;
|
|
65
|
+
minPages?: number;
|
|
66
|
+
minSizeRatio?: number;
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export interface Clock {
|
|
70
|
+
clearInterval: (handle: unknown) => void;
|
|
71
|
+
clearTimeout: (handle: unknown) => void;
|
|
72
|
+
now: () => number;
|
|
73
|
+
setInterval: (fn: () => void, ms: number) => unknown;
|
|
74
|
+
setTimeout: (fn: () => void, ms: number) => unknown;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
export interface StopOptions {
|
|
78
|
+
close?: boolean;
|
|
79
|
+
graceful?: boolean;
|
|
80
|
+
timeout?: number;
|
|
81
|
+
}
|
|
@@ -1,9 +1,10 @@
|
|
|
1
|
-
import type { DefineScheduleOptions, ScheduleDefinition } from "#definition.ts";
|
|
2
|
-
import { maxDeferrals, nativeQueueOptions } from "#internal/definitionOptions.ts";
|
|
1
|
+
import type { DefineScheduleOptions, ScheduleDefinition } from "#server/definition.ts";
|
|
2
|
+
import { maxDeferrals, nativeQueueOptions } from "#server/internal/definitionOptions.ts";
|
|
3
3
|
|
|
4
4
|
export function defineSchedule<const TName extends string>(options: DefineScheduleOptions<TName>): ScheduleDefinition<TName> {
|
|
5
5
|
const definition: ScheduleDefinition<TName> = {
|
|
6
6
|
_tag: "ScheduleDefinition",
|
|
7
|
+
...(options.label === undefined ? {} : { label: options.label }),
|
|
7
8
|
cron: options.cron,
|
|
8
9
|
maxDeferrals: maxDeferrals(options.queue),
|
|
9
10
|
name: options.name,
|
package/src/server/definition.ts
CHANGED
|
@@ -1,18 +1,16 @@
|
|
|
1
1
|
import { Clock, Duration, Effect, Schema } from "effect";
|
|
2
|
-
import type {
|
|
3
|
-
import {
|
|
2
|
+
import type { QueueDisplay, SubjectColumn } from "#display.ts";
|
|
3
|
+
import type { ScheduleOptions } from "#server/enqueueOptions.ts";
|
|
4
|
+
import { maxDeferrals, nativeQueueOptions } from "#server/internal/definitionOptions.ts";
|
|
5
|
+
import type { WorkerJob } from "#server/job.ts";
|
|
6
|
+
import type { QueueOptions, QueuePolicy } from "#server/queueOptions.ts";
|
|
7
|
+
import type { WorkerOptions } from "#server/workerOptions.ts";
|
|
4
8
|
|
|
5
9
|
export class RetryAt extends Schema.TaggedError<RetryAt>()("RetryAt", {
|
|
6
10
|
at: Schema.DateTimeUtc,
|
|
7
11
|
reason: Schema.String,
|
|
8
12
|
}) {}
|
|
9
13
|
|
|
10
|
-
export type QueuePolicy = (typeof policies)[keyof typeof policies];
|
|
11
|
-
export type QueueOptions = Omit<Queue, "name" | "deadLetter" | "policy"> & {
|
|
12
|
-
readonly maxDeferrals?: number;
|
|
13
|
-
readonly policy?: QueuePolicy;
|
|
14
|
-
};
|
|
15
|
-
|
|
16
14
|
export interface JobPayloadSchema extends Schema.Top {
|
|
17
15
|
readonly Encoded: object;
|
|
18
16
|
readonly Type: object;
|
|
@@ -29,7 +27,7 @@ export interface JobContext {
|
|
|
29
27
|
readonly signal: AbortSignal;
|
|
30
28
|
}
|
|
31
29
|
|
|
32
|
-
export interface QueueDefinition<TName extends string = string, TPayload extends JobPayloadSchema = JobPayloadSchema> {
|
|
30
|
+
export interface QueueDefinition<TName extends string = string, TPayload extends JobPayloadSchema = JobPayloadSchema> extends QueueDisplay {
|
|
33
31
|
readonly _tag: "QueueDefinition";
|
|
34
32
|
readonly handle: <E, R>(
|
|
35
33
|
handler: (payload: Schema.Schema.Type<TPayload>, job: JobContext) => Effect.Effect<unknown, E, R>,
|
|
@@ -37,9 +35,9 @@ export interface QueueDefinition<TName extends string = string, TPayload extends
|
|
|
37
35
|
readonly key?: ((payload: Schema.Schema.Type<TPayload>) => string) | undefined;
|
|
38
36
|
readonly maxDeferrals: number;
|
|
39
37
|
readonly name: TName;
|
|
40
|
-
readonly queueOptions: Omit<
|
|
38
|
+
readonly queueOptions: Omit<QueueOptions, "maxDeferrals">;
|
|
41
39
|
readonly schema: TPayload;
|
|
42
|
-
readonly workerOptions:
|
|
40
|
+
readonly workerOptions: WorkerOptions;
|
|
43
41
|
}
|
|
44
42
|
|
|
45
43
|
export interface QueueWorker<TPayload extends JobPayloadSchema = JobPayloadSchema, TRequirements = unknown> {
|
|
@@ -48,19 +46,20 @@ export interface QueueWorker<TPayload extends JobPayloadSchema = JobPayloadSchem
|
|
|
48
46
|
readonly queue: QueueDefinition<string, TPayload>;
|
|
49
47
|
}
|
|
50
48
|
|
|
51
|
-
export
|
|
52
|
-
|
|
53
|
-
}
|
|
49
|
+
export type JobRegistration<TRequirements = unknown> =
|
|
50
|
+
| QueueDefinition
|
|
51
|
+
| QueueWorker<JobPayloadSchema & { readonly DecodingServices: TRequirements }, TRequirements>
|
|
52
|
+
| ScheduledWorker<TRequirements>;
|
|
54
53
|
|
|
55
|
-
export interface ScheduleDefinition<TName extends string = string> {
|
|
54
|
+
export interface ScheduleDefinition<TName extends string = string> extends QueueDisplay {
|
|
56
55
|
readonly _tag: "ScheduleDefinition";
|
|
57
56
|
readonly cron: string;
|
|
58
57
|
readonly maxDeferrals: number;
|
|
59
58
|
readonly name: TName;
|
|
60
|
-
readonly queueOptions: Omit<
|
|
59
|
+
readonly queueOptions: Omit<QueueOptions, "maxDeferrals">;
|
|
61
60
|
readonly run: <E, R>(effect: Effect.Effect<unknown, E, R>) => ScheduledWorker<R>;
|
|
62
61
|
readonly scheduleOptions: ScheduleOptions;
|
|
63
|
-
readonly workerOptions:
|
|
62
|
+
readonly workerOptions: WorkerOptions;
|
|
64
63
|
}
|
|
65
64
|
|
|
66
65
|
export interface ScheduledWorker<TRequirements = unknown> {
|
|
@@ -78,9 +77,11 @@ export type RegistrationRequirements<TRegistrations extends readonly JobRegistra
|
|
|
78
77
|
: never;
|
|
79
78
|
|
|
80
79
|
export type DefineQueueOptions<TName extends string, TPayload extends JobPayloadSchema> = {
|
|
80
|
+
readonly label?: string;
|
|
81
81
|
readonly name: TName;
|
|
82
82
|
readonly schema: TPayload;
|
|
83
|
-
readonly
|
|
83
|
+
readonly subject?: readonly SubjectColumn<NoInfer<TPayload>>[];
|
|
84
|
+
readonly worker?: WorkerOptions;
|
|
84
85
|
} & (
|
|
85
86
|
| { readonly key: (payload: Schema.Schema.Type<TPayload>) => string; readonly queue: QueueOptions & { readonly policy: "singleton" } }
|
|
86
87
|
| { readonly key?: never; readonly queue?: QueueOptions & { readonly policy?: Exclude<QueuePolicy, "singleton"> } }
|
|
@@ -101,6 +102,8 @@ export function defineQueue<const TName extends string, const TPayload extends J
|
|
|
101
102
|
const definition: QueueDefinition<TName, TPayload> = {
|
|
102
103
|
_tag: "QueueDefinition",
|
|
103
104
|
...(options.key === undefined ? {} : { key: options.key }),
|
|
105
|
+
...(options.label === undefined ? {} : { label: options.label }),
|
|
106
|
+
...(options.subject === undefined ? {} : { subject: Object.freeze(options.subject.map((column) => Object.freeze({ ...column }))) }),
|
|
104
107
|
handle: (handler) =>
|
|
105
108
|
Object.freeze({
|
|
106
109
|
_tag: "QueueWorker" as const,
|
|
@@ -118,13 +121,14 @@ export function defineQueue<const TName extends string, const TPayload extends J
|
|
|
118
121
|
|
|
119
122
|
export interface DefineScheduleOptions<TName extends string> {
|
|
120
123
|
readonly cron: string;
|
|
124
|
+
readonly label?: string;
|
|
121
125
|
readonly name: TName;
|
|
122
126
|
readonly queue?: QueueOptions;
|
|
123
127
|
readonly schedule?: ScheduleOptions;
|
|
124
|
-
readonly worker?:
|
|
128
|
+
readonly worker?: WorkerOptions;
|
|
125
129
|
}
|
|
126
130
|
|
|
127
|
-
export function jobContext(job:
|
|
131
|
+
export function jobContext(job: WorkerJob<unknown>, deadline: number, deferralCount = 0): JobContext {
|
|
128
132
|
return {
|
|
129
133
|
deferralCount,
|
|
130
134
|
expireInSeconds: job.expireInSeconds,
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import type { ClientDatabase } from "#server/ClientDatabase.ts";
|
|
2
|
+
import type { JobReadOptions, PgBossClient } from "#server/client.ts";
|
|
3
|
+
import type { ScheduleOptions } from "#server/enqueueOptions.ts";
|
|
4
|
+
import type { Job } from "#server/job.ts";
|
|
5
|
+
|
|
6
|
+
export interface EngineSchedule {
|
|
7
|
+
cron: string;
|
|
8
|
+
data?: object;
|
|
9
|
+
key: string;
|
|
10
|
+
name: string;
|
|
11
|
+
options?: ScheduleOptions;
|
|
12
|
+
timezone: string;
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
export interface EngineClient extends Required<PgBossClient> {
|
|
16
|
+
readonly emit: (event: "error", error: Error) => boolean;
|
|
17
|
+
readonly findJobs: <T = unknown>(name: string, options?: JobReadOptions) => Promise<Job<T>[]>;
|
|
18
|
+
readonly getDb: () => ClientDatabase;
|
|
19
|
+
readonly getJobById: <T = unknown>(name: string, id: string) => Promise<Job<T> | null>;
|
|
20
|
+
readonly getSchedules: (name?: string, key?: string) => Promise<EngineSchedule[]>;
|
|
21
|
+
readonly getSpy: (name: string) => { clear: () => void; waitForJob: (selector: () => boolean, state: "completed" | "failed") => Promise<unknown> };
|
|
22
|
+
readonly schemaVersion: () => Promise<number | null>;
|
|
23
|
+
readonly supervise: (name?: string) => Promise<void>;
|
|
24
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import type { ClientDatabase } from "#server/ClientDatabase.ts";
|
|
2
|
+
import type { RetryOptions } from "#server/queueOptions.ts";
|
|
3
|
+
|
|
4
|
+
export interface EnqueueOptions extends RetryOptions {
|
|
5
|
+
readonly db?: ClientDatabase;
|
|
6
|
+
readonly deadLetter?: string;
|
|
7
|
+
readonly group?: { readonly id: string; readonly tier?: string };
|
|
8
|
+
readonly id?: string;
|
|
9
|
+
readonly priority?: number;
|
|
10
|
+
readonly singletonKey?: string;
|
|
11
|
+
readonly singletonNextSlot?: boolean;
|
|
12
|
+
readonly singletonSeconds?: number;
|
|
13
|
+
readonly startAfter?: number | string | Date;
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
export interface ScheduleOptions extends EnqueueOptions {
|
|
17
|
+
readonly key?: string;
|
|
18
|
+
readonly missed?: "skip" | "once";
|
|
19
|
+
readonly tz?: string;
|
|
20
|
+
}
|
package/src/server/error.ts
CHANGED
|
@@ -1,19 +1,34 @@
|
|
|
1
1
|
import { Cause, Data, Duration, Redacted } from "effect";
|
|
2
|
-
import { failureOutput } from "#internal/failureOutput.ts";
|
|
2
|
+
import { failureOutput } from "#server/internal/failureOutput.ts";
|
|
3
3
|
|
|
4
4
|
export type PgBossOperation =
|
|
5
5
|
| "counts"
|
|
6
6
|
| "deadLetteredJobs"
|
|
7
|
+
| "deleteQueue"
|
|
7
8
|
| "enqueue"
|
|
8
9
|
| "failedJobs"
|
|
9
10
|
| "getJob"
|
|
10
11
|
| "health"
|
|
11
12
|
| "install"
|
|
12
13
|
| "register"
|
|
14
|
+
| "refreshQueueStats"
|
|
13
15
|
| "retry"
|
|
14
16
|
| "settle"
|
|
15
17
|
| "start"
|
|
16
|
-
| "stop"
|
|
18
|
+
| "stop"
|
|
19
|
+
| "unschedule";
|
|
20
|
+
|
|
21
|
+
export class PgBossNotFoundError extends Data.TaggedError("PgBossNotFoundError")<{
|
|
22
|
+
readonly operation: "deleteQueue" | "unschedule";
|
|
23
|
+
readonly queue: string;
|
|
24
|
+
readonly key?: string;
|
|
25
|
+
}> {
|
|
26
|
+
override get message(): string {
|
|
27
|
+
return this.operation === "deleteQueue"
|
|
28
|
+
? `Queue ${this.queue} does not exist`
|
|
29
|
+
: `Schedule ${this.queue} with key ${JSON.stringify(this.key ?? "")} does not exist`;
|
|
30
|
+
}
|
|
31
|
+
}
|
|
17
32
|
|
|
18
33
|
export class PgBossError extends Data.TaggedError("PgBossError")<{
|
|
19
34
|
readonly operation: PgBossOperation;
|
package/src/server/health.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { DateTime, Option } from "effect";
|
|
2
|
-
import type { JobWithMetadata } from "pg-boss";
|
|
3
2
|
import type { JobFailure } from "#JobFailure.ts";
|
|
3
|
+
import type { JobState } from "#server/job.ts";
|
|
4
4
|
|
|
5
5
|
export interface QueueCounts {
|
|
6
6
|
readonly activeCount: number;
|
|
@@ -42,7 +42,7 @@ export interface ListedJob<TData> {
|
|
|
42
42
|
readonly retryCount: number;
|
|
43
43
|
readonly retryLimit: number;
|
|
44
44
|
readonly startedOn: Option.Option<DateTime.Utc>;
|
|
45
|
-
readonly state:
|
|
45
|
+
readonly state: JobState;
|
|
46
46
|
}
|
|
47
47
|
|
|
48
48
|
export interface DeadLetteredJob<TData> extends ListedJob<TData> {
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { Effect, Redacted } from "effect";
|
|
2
|
+
import { clientErrorLogger } from "#server/adapters/clientErrorLogger.ts";
|
|
3
|
+
import type { PgBossOptions } from "#server/service.ts";
|
|
4
|
+
import { ClientEngine } from "./lifecycle.ts";
|
|
5
|
+
|
|
6
|
+
export const acquireClient = Effect.fnUntraced(function* (options: PgBossOptions) {
|
|
7
|
+
const { connectionString, clientFactory, clientCacheKey, stop, ...settings } = options;
|
|
8
|
+
const constructorOptions = {
|
|
9
|
+
...settings,
|
|
10
|
+
idleTimeoutMillis: settings.idleTimeoutMillis ?? 60_000,
|
|
11
|
+
maxLifetimeSeconds: settings.maxLifetimeSeconds ?? 600,
|
|
12
|
+
...(connectionString === undefined ? {} : { connectionString: Redacted.value(connectionString) }),
|
|
13
|
+
};
|
|
14
|
+
const report = yield* clientErrorLogger();
|
|
15
|
+
const engine = yield* ClientEngine;
|
|
16
|
+
const acquired = yield* engine.acquire(
|
|
17
|
+
{
|
|
18
|
+
clientCacheKey,
|
|
19
|
+
clientFactory,
|
|
20
|
+
constructor: constructorOptions,
|
|
21
|
+
},
|
|
22
|
+
report,
|
|
23
|
+
stop,
|
|
24
|
+
);
|
|
25
|
+
return { ...acquired, schema: settings.schema, stop };
|
|
26
|
+
});
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { EngineClient } from "#server/engineClient.ts";
|
|
2
2
|
|
|
3
3
|
// pg-boss offers no hook for a worker fetch that finds nothing, so the controller recognizes its claim statement on the client's database.
|
|
4
4
|
const claim = /UPDATE\s+\S+\s+j\s+SET\s+state\s*=\s*'active'/u;
|
|
@@ -9,7 +9,7 @@ export interface TestingFetches {
|
|
|
9
9
|
readonly passedSince: (queue: string, begun: number) => number;
|
|
10
10
|
}
|
|
11
11
|
|
|
12
|
-
export function testingFetches(db: ReturnType<
|
|
12
|
+
export function testingFetches(db: ReturnType<EngineClient["getDb"]>, changed: () => void): TestingFetches {
|
|
13
13
|
const begun = new Map<string, number>();
|
|
14
14
|
const passed = new Map<string, number[]>();
|
|
15
15
|
const executeSql = db.executeSql.bind(db);
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { Effect, Schema } from "effect";
|
|
2
|
-
import type { PgBossClient } from "#client.ts";
|
|
3
|
-
import { toPgBossError } from "#error.ts";
|
|
4
|
-
import type { QueueCounts } from "#health.ts";
|
|
5
|
-
import { quotedSchema } from "#internal/storedRows.ts";
|
|
2
|
+
import type { PgBossClient } from "#server/client.ts";
|
|
3
|
+
import { toPgBossError } from "#server/error.ts";
|
|
4
|
+
import type { QueueCounts } from "#server/health.ts";
|
|
5
|
+
import { quotedSchema } from "#server/internal/storedRows.ts";
|
|
6
6
|
|
|
7
7
|
const Counts = Schema.Struct({
|
|
8
8
|
activeCount: Schema.Number,
|
|
@@ -11,7 +11,7 @@ const Counts = Schema.Struct({
|
|
|
11
11
|
totalCount: Schema.Number,
|
|
12
12
|
});
|
|
13
13
|
|
|
14
|
-
export function countsFor(client: PgBossClient, schema: string, name: string): Effect.Effect<QueueCounts, import("#error.ts").PgBossError> {
|
|
14
|
+
export function countsFor(client: PgBossClient, schema: string, name: string): Effect.Effect<QueueCounts, import("#server/error.ts").PgBossError> {
|
|
15
15
|
return Effect.tryPromise({
|
|
16
16
|
catch: (error) => toPgBossError("counts", error, name),
|
|
17
17
|
try: async () => {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import type {
|
|
1
|
+
import type { WorkerJob } from "#server/job.ts";
|
|
2
2
|
|
|
3
|
-
export function deadlineOf(job:
|
|
3
|
+
export function deadlineOf(job: WorkerJob<unknown>): number {
|
|
4
4
|
if (!("startedOn" in job && job.startedOn instanceof Date && Number.isFinite(job.startedOn.getTime()))) {
|
|
5
5
|
throw new TypeError("Worker jobs must include pg-boss startedOn metadata");
|
|
6
6
|
}
|
|
@@ -1,42 +1,25 @@
|
|
|
1
1
|
import { Clock, DateTime, Effect, Schema } from "effect";
|
|
2
|
-
import
|
|
3
|
-
import
|
|
4
|
-
import {
|
|
5
|
-
import { toPgBossError } from "#error.ts";
|
|
6
|
-
import { deferralObservers, deferredAttempt } from "#internal/deferral.ts";
|
|
7
|
-
import { settleDeferral } from "#internal/settleDeferral.ts";
|
|
2
|
+
import { RetryAt } from "#server/definition.ts";
|
|
3
|
+
import { deferredAttempt } from "#server/internal/deferral.ts";
|
|
4
|
+
import { type JobAttempt, JobEngine } from "#server/internal/engine.ts";
|
|
8
5
|
|
|
9
6
|
const recordDeferral = Effect.fnUntraced(function* (at: string, reason: string) {
|
|
10
7
|
const span = yield* Effect.currentSpan.pipe(Effect.orDie);
|
|
11
8
|
span.event("job.deferred", yield* Clock.currentTimeNanos, { at, reason });
|
|
12
9
|
});
|
|
13
10
|
|
|
14
|
-
export function deferrableAttempt<A, E, R>(
|
|
15
|
-
effect: Effect.Effect<A, E, R>,
|
|
16
|
-
client: PgBossClient,
|
|
17
|
-
schema: string,
|
|
18
|
-
job: Job<unknown>,
|
|
19
|
-
maxDeferrals: number,
|
|
20
|
-
) {
|
|
11
|
+
export function deferrableAttempt<A, E, R>(effect: Effect.Effect<A, E, R>, job: JobAttempt, maxDeferrals: number) {
|
|
21
12
|
return effect.pipe(
|
|
22
13
|
Effect.catchIf(Schema.is(RetryAt), (error) => {
|
|
23
14
|
if (maxDeferrals === 0) {
|
|
24
15
|
return Effect.fail(error);
|
|
25
16
|
}
|
|
26
17
|
const at = DateTime.formatIso(error.at);
|
|
27
|
-
return Effect.
|
|
28
|
-
catch: (failure) => toPgBossError("settle", failure, job.name),
|
|
29
|
-
try: () => settleDeferral(client, schema, job, at, error.reason, maxDeferrals),
|
|
30
|
-
}).pipe(
|
|
18
|
+
return Effect.flatMap(JobEngine, (engine) => engine.settleDeferral(job, at, error.reason, maxDeferrals)).pipe(
|
|
31
19
|
Effect.flatMap((settled) => {
|
|
32
20
|
if (settled.claimed && !settled.deferred) {
|
|
33
21
|
return Effect.fail(error);
|
|
34
22
|
}
|
|
35
|
-
// Native batch settlement must not match a sibling's new claim at the unchanged retry count.
|
|
36
|
-
job.retryCount = Number.MAX_SAFE_INTEGER;
|
|
37
|
-
if (settled.deferred) {
|
|
38
|
-
deferralObservers.get(client)?.();
|
|
39
|
-
}
|
|
40
23
|
return (settled.deferred ? recordDeferral(at, error.reason) : Effect.void).pipe(Effect.as(deferredAttempt));
|
|
41
24
|
}),
|
|
42
25
|
);
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Schema } from "effect";
|
|
2
|
-
import type {
|
|
3
|
-
import type {
|
|
2
|
+
import type { PgBossClient } from "#server/client.ts";
|
|
3
|
+
import type { WorkerJob } from "#server/job.ts";
|
|
4
4
|
|
|
5
5
|
export const deferredAttempt = Symbol("deferredAttempt");
|
|
6
6
|
export const deferralObservers = new WeakMap<PgBossClient, () => void>();
|
|
@@ -13,7 +13,7 @@ export const Deferral = Schema.Struct({
|
|
|
13
13
|
|
|
14
14
|
const Output = Schema.Struct({ jobDeferral: Deferral });
|
|
15
15
|
|
|
16
|
-
export function deferralOf(job:
|
|
16
|
+
export function deferralOf(job: WorkerJob<unknown>) {
|
|
17
17
|
const output: unknown = Reflect.get(job, "output");
|
|
18
18
|
return Schema.is(Output)(output) ? output.jobDeferral : undefined;
|
|
19
19
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { STATELY_DEFERRAL_POLICY } from "#internal/deferral.ts";
|
|
2
|
-
import { quotedSchema } from "#internal/storedRows.ts";
|
|
1
|
+
import { STATELY_DEFERRAL_POLICY } from "#server/internal/deferral.ts";
|
|
2
|
+
import { quotedSchema } from "#server/internal/storedRows.ts";
|
|
3
3
|
|
|
4
4
|
export function deferralStorePlan(schema: string): string {
|
|
5
5
|
const quoted = quotedSchema(schema);
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { Context, type Effect } from "effect";
|
|
2
|
+
import type { PgBossClient } from "#server/client.ts";
|
|
3
|
+
import type { PgBossError, PgBossTestingError } from "#server/error.ts";
|
|
4
|
+
import type { PgBossService } from "#server/service.ts";
|
|
5
|
+
|
|
6
|
+
export type StoredJob = Awaited<ReturnType<NonNullable<PgBossClient["findJobs"]>>>[number];
|
|
7
|
+
export type JobAttempt = Pick<StoredJob, "name" | "id" | "retryCount">;
|
|
8
|
+
export type Listing = "deadLetteredJobs" | "failedJobs";
|
|
9
|
+
|
|
10
|
+
export class JobEngine extends Context.Service<
|
|
11
|
+
JobEngine,
|
|
12
|
+
Pick<PgBossService, "deleteQueue" | "refreshQueueStats" | "unschedule"> & {
|
|
13
|
+
readonly getJob: (queue: string, id: string) => Effect.Effect<StoredJob | undefined, PgBossError>;
|
|
14
|
+
readonly retry: (queue: string, id: string) => Effect.Effect<void, PgBossError>;
|
|
15
|
+
readonly listJobs: (
|
|
16
|
+
listing: Listing,
|
|
17
|
+
queue: string,
|
|
18
|
+
after: readonly [string, string] | undefined,
|
|
19
|
+
limit: number,
|
|
20
|
+
) => Effect.Effect<readonly unknown[], PgBossError>;
|
|
21
|
+
readonly settleDeferral: (
|
|
22
|
+
job: JobAttempt,
|
|
23
|
+
at: string,
|
|
24
|
+
reason: string,
|
|
25
|
+
maxDeferrals: number,
|
|
26
|
+
) => Effect.Effect<{ readonly claimed: boolean; readonly deferred: boolean }, PgBossError>;
|
|
27
|
+
}
|
|
28
|
+
>()("@shivaedev/jobs/JobEngine") {}
|
|
29
|
+
|
|
30
|
+
export interface TestingSettlements {
|
|
31
|
+
readonly close: Effect.Effect<void>;
|
|
32
|
+
readonly watch: (name: string) => Effect.Effect<void, PgBossTestingError>;
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
export class TestingEngine extends Context.Service<
|
|
36
|
+
TestingEngine,
|
|
37
|
+
{
|
|
38
|
+
readonly expireAttempt: (job: JobAttempt, cause?: "expiry" | "heartbeat") => Effect.Effect<void, PgBossTestingError>;
|
|
39
|
+
readonly observeSettlements: (settled: (name: string) => void) => Effect.Effect<TestingSettlements>;
|
|
40
|
+
}
|
|
41
|
+
>()("@shivaedev/jobs/TestingEngine") {}
|