-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
41675a4
commit 2193a77
Showing
10 changed files
with
240 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
147 changes: 147 additions & 0 deletions
147
packages/cli/src/commands/add/job-queue/add-job-queue.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| import { cancel, isCancel, text } from '@clack/prompts'; | ||
| import { camelCase, pascalCase } from 'change-case'; | ||
| import { Node, Scope } from 'ts-morph'; | ||
|
|
||
| import { CliCommand, CliCommandReturnVal } from '../../../shared/cli-command'; | ||
| import { ServiceRef } from '../../../shared/service-ref'; | ||
| import { analyzeProject, selectPlugin, selectServiceRef } from '../../../shared/shared-prompts'; | ||
| import { VendurePluginRef } from '../../../shared/vendure-plugin-ref'; | ||
| import { addImportsToFile } from '../../../utilities/ast-utils'; | ||
|
|
||
| const cancelledMessage = 'Add API extension cancelled'; | ||
|
|
||
| export interface AddJobQueueOptions { | ||
| plugin?: VendurePluginRef; | ||
| } | ||
|
|
||
| export const addJobQueueCommand = new CliCommand({ | ||
| id: 'add-job-queue', | ||
| category: 'Plugin: Job Queue', | ||
| description: 'Defines an new job queue on a service', | ||
| run: options => addJobQueue(options), | ||
| }); | ||
|
|
||
| async function addJobQueue( | ||
| options?: AddJobQueueOptions, | ||
| ): Promise<CliCommandReturnVal<{ serviceRef: ServiceRef }>> { | ||
| const providedVendurePlugin = options?.plugin; | ||
| const project = await analyzeProject({ providedVendurePlugin, cancelledMessage }); | ||
| const plugin = providedVendurePlugin ?? (await selectPlugin(project, cancelledMessage)); | ||
| const serviceRef = await selectServiceRef(project, plugin); | ||
|
|
||
| const jobQueueName = await text({ | ||
| message: 'What is the name of the job queue?', | ||
| initialValue: 'my-background-task', | ||
| validate: input => { | ||
| if (!/^[a-z][a-z-0-9]+$/.test(input)) { | ||
| return 'The job queue name must be lowercase and contain only letters, numbers and dashes'; | ||
| } | ||
| }, | ||
| }); | ||
|
|
||
| if (isCancel(jobQueueName)) { | ||
| cancel(cancelledMessage); | ||
| process.exit(0); | ||
| } | ||
|
|
||
| addImportsToFile(serviceRef.classDeclaration.getSourceFile(), { | ||
| moduleSpecifier: '@vendure/core', | ||
| namedImports: ['JobQueue', 'JobQueueService', 'SerializedRequestContext'], | ||
| }); | ||
|
|
||
| addImportsToFile(serviceRef.classDeclaration.getSourceFile(), { | ||
| moduleSpecifier: '@vendure/common/lib/generated-types', | ||
| namedImports: ['JobState'], | ||
| }); | ||
|
|
||
| addImportsToFile(serviceRef.classDeclaration.getSourceFile(), { | ||
| moduleSpecifier: '@nestjs/common', | ||
| namedImports: ['OnModuleInit'], | ||
| }); | ||
|
|
||
| serviceRef.injectDependency({ | ||
| name: 'jobQueueService', | ||
| type: 'JobQueueService', | ||
| }); | ||
|
|
||
| serviceRef.classDeclaration.addProperty({ | ||
| name: camelCase(jobQueueName), | ||
| scope: Scope.Private, | ||
| type: writer => writer.write('JobQueue<{ ctx: SerializedRequestContext, someArg: string; }>'), | ||
| }); | ||
|
|
||
| serviceRef.classDeclaration.addImplements('OnModuleInit'); | ||
| let onModuleInitMethod = serviceRef.classDeclaration.getMethod('onModuleInit'); | ||
| if (!onModuleInitMethod) { | ||
| onModuleInitMethod = serviceRef.classDeclaration.addMethod({ | ||
| name: 'onModuleInit', | ||
| isAsync: false, | ||
| returnType: 'void', | ||
| scope: Scope.Public, | ||
| }); | ||
| onModuleInitMethod.setScope(Scope.Private); | ||
| } | ||
| onModuleInitMethod.setIsAsync(true); | ||
| onModuleInitMethod.setReturnType('Promise<void>'); | ||
| const body = onModuleInitMethod.getBody(); | ||
| if (Node.isBlock(body)) { | ||
| body.addStatements(writer => { | ||
| writer | ||
| .write( | ||
| `this.${camelCase(jobQueueName)} = await this.jobQueueService.createQueue({ | ||
| name: '${jobQueueName}', | ||
| process: async job => { | ||
| // Deserialize the RequestContext from the job data | ||
| const ctx = RequestContext.deserialize(job.data.ctx); | ||
| // The "someArg" property is passed in when the job is triggered | ||
| const someArg = job.data.someArg; | ||
| // Inside the \`process\` function we define how each job | ||
| // in the queue will be processed. | ||
| // Let's simulate some long-running task | ||
| const totalItems = 10; | ||
| for (let i = 0; i < totalItems; i++) { | ||
| await new Promise(resolve => setTimeout(resolve, 500)); | ||
| // You can optionally respond to the job being cancelled | ||
| // during processing. This can be useful for very long-running | ||
| // tasks which can be cancelled by the user. | ||
| if (job.state === JobState.CANCELLED) { | ||
| throw new Error('Job was cancelled'); | ||
| } | ||
| // Progress can be reported as a percentage like this | ||
| job.setProgress(Math.floor(i / totalItems * 100)); | ||
| } | ||
| // The value returned from the \`process\` function is stored | ||
| // as the "result" field of the job | ||
| return { | ||
| processedCount: totalItems, | ||
| message: \`Successfully processed \${totalItems} items\`, | ||
| }; | ||
| }, | ||
| })`, | ||
| ) | ||
| .newLine(); | ||
| }).forEach(s => s.formatText()); | ||
| } | ||
|
|
||
| serviceRef.classDeclaration | ||
| .addMethod({ | ||
| name: `trigger${pascalCase(jobQueueName)}`, | ||
| scope: Scope.Public, | ||
| parameters: [{ name: 'ctx', type: 'RequestContext' }], | ||
| statements: writer => { | ||
| writer.write(`return this.${camelCase(jobQueueName)}.add({ | ||
| ctx: ctx.serialize(), | ||
| someArg: 'foo', | ||
| })`); | ||
| }, | ||
| }) | ||
| .formatText(); | ||
|
|
||
| await project.save(); | ||
|
|
||
| return { project, modifiedSourceFiles: [serviceRef.classDeclaration.getSourceFile()], serviceRef }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.