@pikku/queue-pg-boss 0.11.1 → 0.11.2
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 +14 -0
- package/dist/pg-boss-queue-worker.d.ts +2 -2
- package/dist/pg-boss-queue-worker.js +36 -22
- package/dist/pg-boss-service-factory.d.ts +6 -2
- package/dist/pg-boss-service-factory.js +6 -0
- package/package.json +2 -2
- package/src/pg-boss-queue-worker.ts +42 -33
- package/src/pg-boss-service-factory.ts +9 -10
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
## 0.11.0
|
|
2
2
|
|
|
3
|
+
## 0.11.2
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- db9c7bf: Simplify CreateWireServices type signature for custom Config compatibility
|
|
8
|
+
- Updated dependencies [db9c7bf]
|
|
9
|
+
- @pikku/core@0.11.2
|
|
10
|
+
|
|
11
|
+
## 0.11.2
|
|
12
|
+
|
|
13
|
+
### Fixes
|
|
14
|
+
|
|
15
|
+
- ddd87eaf: Simplify CreateWireServices type signature for custom Config compatibility
|
|
16
|
+
|
|
3
17
|
## 0.11.1
|
|
4
18
|
|
|
5
19
|
### Patch Changes
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { PgBoss, type WorkOptions } from 'pg-boss';
|
|
2
2
|
import type { QueueWorkers, PikkuWorkerConfig, QueueConfigMapping, ConfigValidationResult } from '@pikku/core/queue';
|
|
3
|
-
import {
|
|
3
|
+
import { CoreSingletonServices, CreateWireServices } from '@pikku/core';
|
|
4
4
|
export declare const mapPikkuWorkerToPgBoss: (workerConfig?: PikkuWorkerConfig) => WorkOptions;
|
|
5
5
|
/**
|
|
6
6
|
* pg-boss/PostgreSQL queue worker implementation
|
|
@@ -18,7 +18,7 @@ export declare class PgBossQueueWorkers implements QueueWorkers {
|
|
|
18
18
|
readonly configMappings: QueueConfigMapping;
|
|
19
19
|
private pgBoss;
|
|
20
20
|
private activeWorkers;
|
|
21
|
-
constructor(pgBoss: PgBoss, singletonServices: CoreSingletonServices, createWireServices?: CreateWireServices
|
|
21
|
+
constructor(pgBoss: PgBoss, singletonServices: CoreSingletonServices, createWireServices?: CreateWireServices | undefined);
|
|
22
22
|
/**
|
|
23
23
|
* Scan state and register all compatible processors
|
|
24
24
|
*/
|
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
import { runQueueJob, registerQueueWorkers, QueueJobFailedError, QueueJobDiscardedError, } from '@pikku/core/queue';
|
|
2
2
|
import { mapPgBossJobToQueueJob } from './utils.js';
|
|
3
3
|
export const mapPikkuWorkerToPgBoss = (workerConfig) => {
|
|
4
|
-
const workerOptions = {
|
|
4
|
+
const workerOptions = {
|
|
5
|
+
batchSize: 10,
|
|
6
|
+
};
|
|
5
7
|
if (workerConfig?.batchSize !== undefined) {
|
|
6
8
|
workerOptions.batchSize = workerConfig.batchSize;
|
|
7
9
|
}
|
|
@@ -28,7 +30,7 @@ export class PgBossQueueWorkers {
|
|
|
28
30
|
supported: {
|
|
29
31
|
batchSize: {
|
|
30
32
|
queueProperty: 'batchSize',
|
|
31
|
-
description: 'Number of jobs to process in
|
|
33
|
+
description: 'Number of jobs to fetch and process concurrently in parallel',
|
|
32
34
|
},
|
|
33
35
|
pollInterval: {
|
|
34
36
|
queueProperty: 'pollingIntervalSeconds',
|
|
@@ -97,33 +99,45 @@ export class PgBossQueueWorkers {
|
|
|
97
99
|
const workerId = await this.pgBoss.work(processor.queueName, {
|
|
98
100
|
...mapPikkuWorkerToPgBoss(processor.config),
|
|
99
101
|
includeMetadata: true,
|
|
100
|
-
}, async (
|
|
102
|
+
}, async (jobs) => {
|
|
101
103
|
if (!this.singletonServices) {
|
|
102
104
|
throw new Error('Singleton services not available');
|
|
103
105
|
}
|
|
104
|
-
if (!
|
|
105
|
-
this.singletonServices.logger.warn(`No
|
|
106
|
+
if (!jobs || jobs.length === 0) {
|
|
107
|
+
this.singletonServices.logger.warn(`No jobs received for queue ${queueName}`);
|
|
106
108
|
return;
|
|
107
109
|
}
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
if (error instanceof QueueJobFailedError) {
|
|
117
|
-
// Let pg-boss handle this as a failed job
|
|
118
|
-
throw new Error(error.message);
|
|
110
|
+
// Process all jobs in parallel
|
|
111
|
+
await Promise.all(jobs.map(async (job) => {
|
|
112
|
+
try {
|
|
113
|
+
await runQueueJob({
|
|
114
|
+
singletonServices: this.singletonServices,
|
|
115
|
+
createWireServices: this.createWireServices,
|
|
116
|
+
job: mapPgBossJobToQueueJob(job, this.pgBoss),
|
|
117
|
+
});
|
|
119
118
|
}
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
119
|
+
catch (error) {
|
|
120
|
+
if (error instanceof QueueJobFailedError) {
|
|
121
|
+
// Mark this specific job as failed
|
|
122
|
+
await this.pgBoss.fail(queueName, job.id, {
|
|
123
|
+
message: error.message,
|
|
124
|
+
});
|
|
125
|
+
}
|
|
126
|
+
else if (error instanceof QueueJobDiscardedError) {
|
|
127
|
+
// For pg-boss, complete the job successfully to discard it
|
|
128
|
+
this.singletonServices.logger.info(`PgBoss job ${job.id} discarded: ${error.message}`);
|
|
129
|
+
await this.pgBoss.complete(queueName, job.id);
|
|
130
|
+
}
|
|
131
|
+
else {
|
|
132
|
+
// For other errors, fail the job
|
|
133
|
+
await this.pgBoss.fail(queueName, job.id, {
|
|
134
|
+
message: error instanceof Error
|
|
135
|
+
? error.message
|
|
136
|
+
: 'Unknown error',
|
|
137
|
+
});
|
|
138
|
+
}
|
|
124
139
|
}
|
|
125
|
-
|
|
126
|
-
}
|
|
140
|
+
}));
|
|
127
141
|
});
|
|
128
142
|
this.activeWorkers.set(queueName, workerId);
|
|
129
143
|
});
|
|
@@ -2,7 +2,7 @@ import { PgBoss, type ConstructorOptions } from 'pg-boss';
|
|
|
2
2
|
import { PgBossQueueService } from './pg-boss-queue-service.js';
|
|
3
3
|
import { PgBossQueueWorkers } from './pg-boss-queue-worker.js';
|
|
4
4
|
import { PgBossSchedulerService } from './pg-boss-scheduler-service.js';
|
|
5
|
-
import type {
|
|
5
|
+
import type { CoreSingletonServices, CreateWireServices } from '@pikku/core';
|
|
6
6
|
/**
|
|
7
7
|
* Factory class for pg-boss services
|
|
8
8
|
* Manages a single PgBoss instance shared across queue, worker, and scheduler services
|
|
@@ -25,7 +25,7 @@ export declare class PgBossServiceFactory {
|
|
|
25
25
|
/**
|
|
26
26
|
* Get the queue workers for processing jobs
|
|
27
27
|
*/
|
|
28
|
-
getQueueWorkers(singletonServices: CoreSingletonServices, createWireServices?: CreateWireServices
|
|
28
|
+
getQueueWorkers(singletonServices: CoreSingletonServices, createWireServices?: CreateWireServices): PgBossQueueWorkers;
|
|
29
29
|
/**
|
|
30
30
|
* Get the scheduler service for managing recurring tasks
|
|
31
31
|
*/
|
|
@@ -34,4 +34,8 @@ export declare class PgBossServiceFactory {
|
|
|
34
34
|
* Close all services and the pg-boss connection
|
|
35
35
|
*/
|
|
36
36
|
close(): Promise<void>;
|
|
37
|
+
/**
|
|
38
|
+
* Alias for close() - used by stopSingletonServices
|
|
39
|
+
*/
|
|
40
|
+
stop(): Promise<void>;
|
|
37
41
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@pikku/queue-pg-boss",
|
|
3
|
-
"version": "0.11.
|
|
3
|
+
"version": "0.11.2",
|
|
4
4
|
"author": "yasser.fadl@gmail.com",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"module": "dist/index.js",
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
"release": "npm run build && npm test"
|
|
14
14
|
},
|
|
15
15
|
"peerDependencies": {
|
|
16
|
-
"@pikku/core": "^0.11.
|
|
16
|
+
"@pikku/core": "^0.11.2"
|
|
17
17
|
},
|
|
18
18
|
"dependencies": {
|
|
19
19
|
"pg-boss": "^12.2.0"
|
|
@@ -11,17 +11,15 @@ import {
|
|
|
11
11
|
QueueJobFailedError,
|
|
12
12
|
QueueJobDiscardedError,
|
|
13
13
|
} from '@pikku/core/queue'
|
|
14
|
-
import {
|
|
15
|
-
CoreServices,
|
|
16
|
-
CoreSingletonServices,
|
|
17
|
-
CreateWireServices,
|
|
18
|
-
} from '@pikku/core'
|
|
14
|
+
import { CoreSingletonServices, CreateWireServices } from '@pikku/core'
|
|
19
15
|
import { mapPgBossJobToQueueJob } from './utils.js'
|
|
20
16
|
|
|
21
17
|
export const mapPikkuWorkerToPgBoss = (
|
|
22
18
|
workerConfig?: PikkuWorkerConfig
|
|
23
19
|
): WorkOptions => {
|
|
24
|
-
const workerOptions: WorkOptions = {
|
|
20
|
+
const workerOptions: WorkOptions = {
|
|
21
|
+
batchSize: 10,
|
|
22
|
+
}
|
|
25
23
|
|
|
26
24
|
if (workerConfig?.batchSize !== undefined) {
|
|
27
25
|
workerOptions.batchSize = workerConfig.batchSize
|
|
@@ -53,7 +51,8 @@ export class PgBossQueueWorkers implements QueueWorkers {
|
|
|
53
51
|
supported: {
|
|
54
52
|
batchSize: {
|
|
55
53
|
queueProperty: 'batchSize',
|
|
56
|
-
description:
|
|
54
|
+
description:
|
|
55
|
+
'Number of jobs to fetch and process concurrently in parallel',
|
|
57
56
|
},
|
|
58
57
|
pollInterval: {
|
|
59
58
|
queueProperty: 'pollingIntervalSeconds',
|
|
@@ -125,11 +124,7 @@ export class PgBossQueueWorkers implements QueueWorkers {
|
|
|
125
124
|
constructor(
|
|
126
125
|
pgBoss: PgBoss,
|
|
127
126
|
private singletonServices: CoreSingletonServices,
|
|
128
|
-
private createWireServices?: CreateWireServices
|
|
129
|
-
CoreSingletonServices,
|
|
130
|
-
CoreServices,
|
|
131
|
-
any
|
|
132
|
-
>
|
|
127
|
+
private createWireServices?: CreateWireServices
|
|
133
128
|
) {
|
|
134
129
|
this.pgBoss = pgBoss
|
|
135
130
|
}
|
|
@@ -149,35 +144,49 @@ export class PgBossQueueWorkers implements QueueWorkers {
|
|
|
149
144
|
...mapPikkuWorkerToPgBoss(processor.config),
|
|
150
145
|
includeMetadata: true,
|
|
151
146
|
},
|
|
152
|
-
async (
|
|
147
|
+
async (jobs) => {
|
|
153
148
|
if (!this.singletonServices) {
|
|
154
149
|
throw new Error('Singleton services not available')
|
|
155
150
|
}
|
|
156
|
-
if (!
|
|
151
|
+
if (!jobs || jobs.length === 0) {
|
|
157
152
|
this.singletonServices.logger.warn(
|
|
158
|
-
`No
|
|
153
|
+
`No jobs received for queue ${queueName}`
|
|
159
154
|
)
|
|
160
155
|
return
|
|
161
156
|
}
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
157
|
+
// Process all jobs in parallel
|
|
158
|
+
await Promise.all(
|
|
159
|
+
jobs.map(async (job) => {
|
|
160
|
+
try {
|
|
161
|
+
await runQueueJob({
|
|
162
|
+
singletonServices: this.singletonServices,
|
|
163
|
+
createWireServices: this.createWireServices,
|
|
164
|
+
job: mapPgBossJobToQueueJob(job, this.pgBoss),
|
|
165
|
+
})
|
|
166
|
+
} catch (error: unknown) {
|
|
167
|
+
if (error instanceof QueueJobFailedError) {
|
|
168
|
+
// Mark this specific job as failed
|
|
169
|
+
await this.pgBoss.fail(queueName, job.id, {
|
|
170
|
+
message: error.message,
|
|
171
|
+
})
|
|
172
|
+
} else if (error instanceof QueueJobDiscardedError) {
|
|
173
|
+
// For pg-boss, complete the job successfully to discard it
|
|
174
|
+
this.singletonServices.logger.info(
|
|
175
|
+
`PgBoss job ${job.id} discarded: ${error.message}`
|
|
176
|
+
)
|
|
177
|
+
await this.pgBoss.complete(queueName, job.id)
|
|
178
|
+
} else {
|
|
179
|
+
// For other errors, fail the job
|
|
180
|
+
await this.pgBoss.fail(queueName, job.id, {
|
|
181
|
+
message:
|
|
182
|
+
error instanceof Error
|
|
183
|
+
? error.message
|
|
184
|
+
: 'Unknown error',
|
|
185
|
+
})
|
|
186
|
+
}
|
|
187
|
+
}
|
|
167
188
|
})
|
|
168
|
-
|
|
169
|
-
if (error instanceof QueueJobFailedError) {
|
|
170
|
-
// Let pg-boss handle this as a failed job
|
|
171
|
-
throw new Error(error.message)
|
|
172
|
-
} else if (error instanceof QueueJobDiscardedError) {
|
|
173
|
-
// For pg-boss, complete the job successfully to discard it
|
|
174
|
-
this.singletonServices.logger.info(
|
|
175
|
-
`PgBoss job ${job.id} discarded: ${error.message}`
|
|
176
|
-
)
|
|
177
|
-
return // Successfully "completed" by discarding
|
|
178
|
-
}
|
|
179
|
-
throw error
|
|
180
|
-
}
|
|
189
|
+
)
|
|
181
190
|
}
|
|
182
191
|
)
|
|
183
192
|
this.activeWorkers.set(queueName, workerId)
|
|
@@ -2,11 +2,7 @@ import { PgBoss, type ConstructorOptions } from 'pg-boss'
|
|
|
2
2
|
import { PgBossQueueService } from './pg-boss-queue-service.js'
|
|
3
3
|
import { PgBossQueueWorkers } from './pg-boss-queue-worker.js'
|
|
4
4
|
import { PgBossSchedulerService } from './pg-boss-scheduler-service.js'
|
|
5
|
-
import type {
|
|
6
|
-
CoreServices,
|
|
7
|
-
CoreSingletonServices,
|
|
8
|
-
CreateWireServices,
|
|
9
|
-
} from '@pikku/core'
|
|
5
|
+
import type { CoreSingletonServices, CreateWireServices } from '@pikku/core'
|
|
10
6
|
|
|
11
7
|
/**
|
|
12
8
|
* Factory class for pg-boss services
|
|
@@ -56,11 +52,7 @@ export class PgBossServiceFactory {
|
|
|
56
52
|
*/
|
|
57
53
|
getQueueWorkers(
|
|
58
54
|
singletonServices: CoreSingletonServices,
|
|
59
|
-
createWireServices?: CreateWireServices
|
|
60
|
-
CoreSingletonServices,
|
|
61
|
-
CoreServices,
|
|
62
|
-
any
|
|
63
|
-
>
|
|
55
|
+
createWireServices?: CreateWireServices
|
|
64
56
|
): PgBossQueueWorkers {
|
|
65
57
|
if (!this.queueWorkers) {
|
|
66
58
|
this.queueWorkers = new PgBossQueueWorkers(
|
|
@@ -91,4 +83,11 @@ export class PgBossServiceFactory {
|
|
|
91
83
|
this.initialized = false
|
|
92
84
|
}
|
|
93
85
|
}
|
|
86
|
+
|
|
87
|
+
/**
|
|
88
|
+
* Alias for close() - used by stopSingletonServices
|
|
89
|
+
*/
|
|
90
|
+
async stop(): Promise<void> {
|
|
91
|
+
await this.close()
|
|
92
|
+
}
|
|
94
93
|
}
|