Skip to content

Commit 00446c3

Browse files
RomainLanzRomainLanz
committed
refactor!: rename jobName to name in Schedule types and database
1 parent ef3e218 commit 00446c3

File tree

10 files changed

+55
-55
lines changed

10 files changed

+55
-55
lines changed

‎src/drivers/knex_adapter.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ export class KnexAdapter implements Adapter {
101101
await this.#connection.schema.createTable(this.#schedulesTable, (table) => {
102102
table.string('id', 255).primary()
103103
table.string('status', 50).notNullable().defaultTo('active')
104-
table.string('job_name', 255).notNullable()
104+
table.string('name', 255).notNullable()
105105
table.text('payload').notNullable()
106106
table.string('cron_expression', 255).nullable()
107107
table.bigint('every_ms').unsigned().nullable()
@@ -399,7 +399,7 @@ export class KnexAdapter implements Adapter {
399399

400400
const data = {
401401
id,
402-
job_name: config.jobName,
402+
name: config.name,
403403
payload: JSON.stringify(config.payload),
404404
cron_expression: config.cronExpression ?? null,
405405
every_ms: config.everyMs ?? null,
@@ -419,7 +419,7 @@ export class KnexAdapter implements Adapter {
419419
})
420420
.onConflict('id')
421421
.merge({
422-
job_name: data.job_name,
422+
name: data.name,
423423
payload: data.payload,
424424
cron_expression: data.cron_expression,
425425
every_ms: data.every_ms,
@@ -547,7 +547,7 @@ export class KnexAdapter implements Adapter {
547547
#rowToScheduleData(row: any): ScheduleData {
548548
return {
549549
id: row.id,
550-
jobName: row.job_name,
550+
name: row.name,
551551
payload: typeof row.payload === 'string' ? JSON.parse(row.payload) : row.payload,
552552
cronExpression: row.cron_expression ?? null,
553553
everyMs: row.every_ms ? Number(row.every_ms) : null,

‎src/drivers/redis_adapter.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ export class RedisAdapter implements Adapter {
428428

429429
const scheduleData: Record<string, string> = {
430430
id,
431-
job_name: config.jobName,
431+
name: config.name,
432432
payload: JSON.stringify(config.payload),
433433
timezone: config.timezone,
434434
status: 'active',
@@ -566,7 +566,7 @@ export class RedisAdapter implements Adapter {
566566
#hashToScheduleData(data: Record<string, string>): ScheduleData {
567567
return {
568568
id: data.id,
569-
jobName: data.job_name,
569+
name: data.name,
570570
payload: JSON.parse(data.payload || '{}'),
571571
cronExpression: data.cron_expression || null,
572572
everyMs: data.every_ms ? Number.parseInt(data.every_ms, 10) : null,

‎src/schedule.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ export class Schedule {
3232
return this.#data.id
3333
}
3434

35-
get jobName(): string {
36-
return this.#data.jobName
35+
get name(): string {
36+
return this.#data.name
3737
}
3838

3939
get payload(): any {
@@ -155,7 +155,7 @@ export class Schedule {
155155
const adapter = QueueManager.use()
156156

157157
// Dispatch the job
158-
const dispatcher = new JobDispatcher(this.#data.jobName, this.#data.payload)
158+
const dispatcher = new JobDispatcher(this.#data.name, this.#data.payload)
159159
await dispatcher.run()
160160

161161
// Update run metadata

‎src/schedule_builder.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import * as errors from './exceptions.js'
2323
* ```
2424
*/
2525
export class ScheduleBuilder implements PromiseLike<ScheduleResult> {
26-
#jobName: string
26+
#name: string
2727
#payload: any
2828
#id?: string
2929
#cronExpression?: string
@@ -33,8 +33,8 @@ export class ScheduleBuilder implements PromiseLike<ScheduleResult> {
3333
#to?: Date
3434
#limit?: number
3535

36-
constructor(jobName: string, payload: any) {
37-
this.#jobName = jobName
36+
constructor(name: string, payload: any) {
37+
this.#name = name
3838
this.#payload = payload
3939
}
4040

@@ -136,8 +136,8 @@ export class ScheduleBuilder implements PromiseLike<ScheduleResult> {
136136
}
137137

138138
const config: ScheduleConfig = {
139-
id: this.#id ?? this.#jobName,
140-
jobName: this.#jobName,
139+
id: this.#id ?? this.#name,
140+
name: this.#name,
141141
payload: this.#payload,
142142
cronExpression: this.#cronExpression,
143143
everyMs: this.#everyMs,

‎src/types/main.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ export interface ScheduleConfig {
324324
id?: string
325325

326326
/** Job class name */
327-
jobName: string
327+
name: string
328328

329329
/** Job payload */
330330
payload: any
@@ -357,7 +357,7 @@ export interface ScheduleData {
357357
id: string
358358

359359
/** Job class name */
360-
jobName: string
360+
name: string
361361

362362
/** Job payload */
363363
payload: any

‎src/worker.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -522,19 +522,19 @@ export class Worker {
522522
debug(
523523
'worker %s: dispatching scheduled job %s (schedule: %s, runCount: %d)',
524524
this.#id,
525-
schedule.jobName,
525+
schedule.name,
526526
schedule.id,
527527
schedule.runCount + 1
528528
)
529529

530530
// Get the job class to determine the target queue
531-
const JobClass = Locator.get(schedule.jobName)
531+
const JobClass = Locator.get(schedule.name)
532532
const queue = JobClass?.options?.queue ?? 'default'
533533

534534
// Dispatch the job to the queue
535535
await this.#adapter.pushOn(queue, {
536536
id: randomUUID(),
537-
name: schedule.jobName,
537+
name: schedule.name,
538538
payload: schedule.payload,
539539
attempts: 0,
540540
priority: JobClass?.options?.priority,

‎tests/_mocks/memory_adapter.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ export class MemoryAdapter implements Adapter {
169169

170170
const schedule: ScheduleData = {
171171
id,
172-
jobName: config.jobName,
172+
name: config.name,
173173
payload: config.payload,
174174
cronExpression: config.cronExpression ?? null,
175175
everyMs: config.everyMs ?? null,

‎tests/_utils/register_driver_test_suite.ts‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
410410
const adapter = await options.createAdapter()
411411

412412
const id = await adapter.createSchedule({
413-
jobName: 'TestJob',
413+
name: 'TestJob',
414414
payload: { foo: 'bar' },
415415
everyMs: 5000,
416416
timezone: 'UTC',
@@ -420,7 +420,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
420420

421421
const schedule = await adapter.getSchedule(id)
422422
assert.isNotNull(schedule)
423-
assert.equal(schedule!.jobName, 'TestJob')
423+
assert.equal(schedule!.name, 'TestJob')
424424
assert.deepEqual(schedule!.payload, { foo: 'bar' })
425425
assert.equal(schedule!.everyMs, 5000)
426426
assert.equal(schedule!.status, 'active')
@@ -431,7 +431,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
431431

432432
const id = await adapter.createSchedule({
433433
id: 'my-custom-id',
434-
jobName: 'TestJob',
434+
name: 'TestJob',
435435
payload: {},
436436
cronExpression: '0 0 * * *',
437437
timezone: 'UTC',
@@ -450,7 +450,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
450450
// Create initial schedule
451451
await adapter.createSchedule({
452452
id: 'upsert-test',
453-
jobName: 'TestJob',
453+
name: 'TestJob',
454454
payload: { version: 1 },
455455
everyMs: 5000,
456456
timezone: 'UTC',
@@ -459,7 +459,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
459459
// Upsert with new values
460460
await adapter.createSchedule({
461461
id: 'upsert-test',
462-
jobName: 'TestJob',
462+
name: 'TestJob',
463463
payload: { version: 2 },
464464
everyMs: 10000,
465465
timezone: 'Europe/Paris',
@@ -483,14 +483,14 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
483483

484484
await adapter.createSchedule({
485485
id: 'list-test-1',
486-
jobName: 'Job1',
486+
name: 'Job1',
487487
payload: {},
488488
everyMs: 5000,
489489
timezone: 'UTC',
490490
})
491491
await adapter.createSchedule({
492492
id: 'list-test-2',
493-
jobName: 'Job2',
493+
name: 'Job2',
494494
payload: {},
495495
everyMs: 10000,
496496
timezone: 'UTC',
@@ -508,14 +508,14 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
508508

509509
await adapter.createSchedule({
510510
id: 'filter-active',
511-
jobName: 'Job1',
511+
name: 'Job1',
512512
payload: {},
513513
everyMs: 5000,
514514
timezone: 'UTC',
515515
})
516516
await adapter.createSchedule({
517517
id: 'filter-paused',
518-
jobName: 'Job2',
518+
name: 'Job2',
519519
payload: {},
520520
everyMs: 10000,
521521
timezone: 'UTC',
@@ -537,7 +537,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
537537

538538
await adapter.createSchedule({
539539
id: 'update-status-test',
540-
jobName: 'TestJob',
540+
name: 'TestJob',
541541
payload: {},
542542
everyMs: 5000,
543543
timezone: 'UTC',
@@ -554,7 +554,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
554554

555555
await adapter.createSchedule({
556556
id: 'update-meta-test',
557-
jobName: 'TestJob',
557+
name: 'TestJob',
558558
payload: {},
559559
everyMs: 5000,
560560
timezone: 'UTC',
@@ -580,7 +580,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
580580

581581
await adapter.createSchedule({
582582
id: 'delete-test',
583-
jobName: 'TestJob',
583+
name: 'TestJob',
584584
payload: {},
585585
everyMs: 5000,
586586
timezone: 'UTC',
@@ -598,7 +598,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
598598
// Create schedule with nextRunAt in the future
599599
await adapter.createSchedule({
600600
id: 'future-schedule',
601-
jobName: 'TestJob',
601+
name: 'TestJob',
602602
payload: {},
603603
everyMs: 60000,
604604
timezone: 'UTC',
@@ -617,7 +617,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
617617

618618
await adapter.createSchedule({
619619
id: 'due-schedule',
620-
jobName: 'DueJob',
620+
name: 'DueJob',
621621
payload: { key: 'value' },
622622
everyMs: 5000,
623623
timezone: 'UTC',
@@ -632,7 +632,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
632632

633633
assert.isNotNull(claimed)
634634
assert.equal(claimed!.id, 'due-schedule')
635-
assert.equal(claimed!.jobName, 'DueJob')
635+
assert.equal(claimed!.name, 'DueJob')
636636
assert.deepEqual(claimed!.payload, { key: 'value' })
637637
})
638638

@@ -641,7 +641,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
641641

642642
await adapter.createSchedule({
643643
id: 'claim-update-test',
644-
jobName: 'TestJob',
644+
name: 'TestJob',
645645
payload: {},
646646
everyMs: 10000,
647647
timezone: 'UTC',
@@ -662,7 +662,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
662662

663663
await adapter.createSchedule({
664664
id: 'runcount-test',
665-
jobName: 'TestJob',
665+
name: 'TestJob',
666666
payload: {},
667667
everyMs: 5000,
668668
timezone: 'UTC',
@@ -686,7 +686,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
686686

687687
await adapter.createSchedule({
688688
id: 'paused-claim-test',
689-
jobName: 'TestJob',
689+
name: 'TestJob',
690690
payload: {},
691691
everyMs: 5000,
692692
timezone: 'UTC',
@@ -706,7 +706,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
706706

707707
await adapter.createSchedule({
708708
id: 'limit-claim-test',
709-
jobName: 'TestJob',
709+
name: 'TestJob',
710710
payload: {},
711711
everyMs: 5000,
712712
timezone: 'UTC',
@@ -731,7 +731,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
731731
// Create a single due schedule
732732
await adapter1.createSchedule({
733733
id: 'concurrent-claim-test',
734-
jobName: 'TestJob',
734+
name: 'TestJob',
735735
payload: {},
736736
everyMs: 60000,
737737
timezone: 'UTC',
@@ -758,7 +758,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
758758
// Create a single due schedule
759759
await adapters[0].createSchedule({
760760
id: 'stress-test-schedule',
761-
jobName: 'StressJob',
761+
name: 'StressJob',
762762
payload: { test: true },
763763
everyMs: 60000,
764764
timezone: 'UTC',
@@ -778,7 +778,7 @@ export function registerDriverTestSuite(options: DriverTestSuiteOptions) {
778778
// The claimed schedule should have the correct data
779779
const claimed = claimedSchedules[0]!
780780
assert.equal(claimed.id, 'stress-test-schedule')
781-
assert.equal(claimed.jobName, 'StressJob')
781+
assert.equal(claimed.name, 'StressJob')
782782
assert.deepEqual(claimed.payload, { test: true })
783783
})
784784
}

0 commit comments

Comments
 (0)