Improve options

Author: madeindjs

libs/graphile-worker/src/graphile-worker.module.ts

@@ -1,4 +1,5 @@
 import { DynamicModule, Module, Provider } from '@nestjs/common';
+import { WorkerUtilsOptions } from 'graphile-worker';
 import { GraphileWorkerService } from './graphile-worker.service';
 
 export const GRAPHILE_WORKER_TOKEN = Symbol.for('NestJsGraphileWorker');
@@ -8,16 +9,24 @@ export const GRAPHILE_WORKER_TOKEN = Symbol.for('NestJsGraphileWorker');
   exports: [GraphileWorkerService],
 })
 export class GraphileWorkerModule {
-  /**
-   *
-   * @param connectionString `${env.TYPEORM_CONNECTION}://${env.TYPEORM_USERNAME}:${env.TYPEORM_PASSWORD}@${env.TYPEORM_HOST}/${env.TYPEORM_DATABASE}`
-  }
-   * @returns
-   */
-  static forRoot(connectionString: string): DynamicModule {
+  static forRoot(options: WorkerUtilsOptions): DynamicModule;
+  static forRoot(connectionString: string): DynamicModule;
+  static forRoot(connectionStringOrOptions: unknown): DynamicModule {
+    let options: WorkerUtilsOptions = {};
+
+    if (typeof connectionStringOrOptions === 'string') {
+      options.connectionString = connectionStringOrOptions;
+    } else if (isWorkerUtilsOptions(connectionStringOrOptions)) {
+      options = connectionStringOrOptions;
+    } else {
+      throw Error(
+        'Cannot detect type of option provided for `GraphileWorkerModule.forRoot()`',
+      );
+    }
+
     const graphileWorkerService: Provider = {
       provide: GraphileWorkerService,
-      useValue: new GraphileWorkerService(connectionString),
+      useValue: new GraphileWorkerService(options),
     };
 
     return {
@@ -28,3 +37,7 @@ export class GraphileWorkerModule {
     };
   }
 }
+
+function isWorkerUtilsOptions(options: unknown): options is WorkerUtilsOptions {
+  return (options as WorkerUtilsOptions).connectionString !== undefined;
+}

libs/graphile-worker/src/graphile-worker.service.ts

@@ -12,25 +12,16 @@ export class GraphileWorkerService {
   private readonly logger = new Logger(GraphileWorkerService.name);
   private isMigrationDone: boolean;
 
-  constructor(private readonly connectionString: string) {}
+  constructor(private readonly options: WorkerUtilsOptions) {}
 
   async quickAddJob(
-    options: WorkerUtilsOptions,
     identifier: string,
     payload?: unknown,
     spec?: TaskSpec,
   ): Promise<Job> {
     await this.runMigrations();
 
-    const job = await quickAddJob(
-      {
-        connectionString: this.connectionString,
-        ...options,
-      },
-      identifier,
-      payload,
-      spec,
-    );
+    const job = await quickAddJob(this.options, identifier, payload, spec);
 
     this.logger.debug(`quickAddJob add job #${job.id}`);
 
@@ -42,7 +33,7 @@ export class GraphileWorkerService {
       return;
     }
 
-    await runMigrations({ connectionString: this.connectionString });
+    await runMigrations(this.options);
     this.logger.debug('Run migrations');
     this.isMigrationDone = true;
   }

src/app.controller.ts

@@ -8,6 +8,6 @@ export class AppController {
   @Post()
   @HttpCode(201)
   async addJob() {
-    await this.graphileWorker.quickAddJob({}, 'test', { hello: 'world' });
+    await this.graphileWorker.quickAddJob('test', { hello: 'world' });
   }
 }

src/app.module.ts

@@ -4,9 +4,9 @@ import { AppController } from './app.controller';
 
 @Module({
   imports: [
-    GraphileWorkerModule.forRoot(
-      'postgres://example:password@postgres/example',
-    ),
+    GraphileWorkerModule.forRoot({
+      connectionString: 'postgres://example:password@postgres/example',
+    }),
   ],
   controllers: [AppController],
   providers: [],