refactor(): Rename GraphileWorkerService to WorkerService

Author: madeindjs

README.md

@@ -15,7 +15,7 @@ Why you should prefer Graphile Worker instead of [Bull](https://github.com/nestj
 ## Features
 
 - use a `GraphileWorkerModule` to register Graphile Worker with a `asRootAsync` to pass dynamic parameters
-- provide a `GraphileWorkerService` to add jobs or start runner
+- provide a `WorkerService` to add jobs or start runner
 - provide a `OnWorkerEvenet` decorator to add custom behavior on `job:success` for example
 
 ## Installation
@@ -82,15 +82,15 @@ export class AppModule {}
 
 ## Create jobs
 
-You may use `GraphileWorkerService`:
+You may use `WorkerService`:
 
 ```ts
-import { GraphileWorkerService } from '@app/graphile-worker';
+import { WorkerService } from '@app/graphile-worker';
 import { Controller, HttpCode, Post } from '@nestjs/common';
 
 @Controller()
 export class AppController {
-  constructor(private readonly graphileWorker: GraphileWorkerService) {}
+  constructor(private readonly graphileWorker: WorkerService) {}
 
   @Post()
   @HttpCode(201)
@@ -114,16 +114,16 @@ export class AppController {
 
 ## Start runner
 
-Add `GraphileWorkerService.run` in `main.ts` file:
+Add `WorkerService.run` in `main.ts` file:
 
 ```ts
-import { GraphileWorkerService } from '@app/graphile-worker';
+import { WorkerService } from '@app/graphile-worker';
 import { NestFactory } from '@nestjs/core';
 import { AppModule } from './app.module';
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
-  app.get(GraphileWorkerService).run();
+  app.get(WorkerService).run();
   await app.listen(3000);
 }
 bootstrap();
@@ -170,12 +170,6 @@ $ npm run test:cov
 
 Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
 
-## Stay in touch
-
-- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
-- Website - [https://nestjs.com](https://nestjs.com/)
-- Twitter - [@nestframework](https://twitter.com/nestframework)
-
 ## License
 
 Nest is [MIT licensed](LICENSE).

src/graphile-worker.module.ts

@@ -4,32 +4,32 @@ import {
   GraphileWorkerAsyncConfiguration,
   GraphileWorkerConfigurationFactory,
   RunnerOptionWithoutEvents,
-} from './interfaces/config.interface';
+} from './interfaces/module-config.interfaces';
 import {
   ConfigurationService,
   CONFIGURATION_SERVICE_KEY,
 } from './services/configuration.service';
-import { GraphileWorkerService } from './services/graphile-worker.service';
 import { ListenerExplorerService } from './services/listener-explorer.service';
 import { MetadataAccessorService } from './services/metadata-accessor.service';
+import { WorkerService } from './services/worker.service';
 
 export const GRAPHILE_WORKER_TOKEN = Symbol.for('NestJsGraphileWorker');
 
 const internalsProviders = [
   MetadataAccessorService,
   ListenerExplorerService,
-  GraphileWorkerService,
+  WorkerService,
 ];
 
 const internalsModules = [DiscoveryModule];
 
 @Module({
-  providers: [GraphileWorkerService],
-  exports: [GraphileWorkerService],
+  providers: [WorkerService],
+  exports: [WorkerService],
 })
 export class GraphileWorkerModule {
   /**
-   * Registers a globally available `GraphileWorkerService`.
+   * Registers a globally available `WorkerService`.
    *
    * Example:
    *
@@ -55,12 +55,12 @@ export class GraphileWorkerModule {
       imports: internalsModules,
       module: GraphileWorkerModule,
       providers: [graphileConfigurationServiceProvider, ...internalsProviders],
-      exports: [GraphileWorkerService],
+      exports: [WorkerService],
     };
   }
 
   /**
-   * Registers a globally available `GraphileWorkerService`.
+   * Registers a globally available `WorkerService`.
    *
    * Example:
    *

src/index.ts

@@ -1,3 +1,3 @@
 export * from './decorators/worker-hooks.decorators';
 export * from './graphile-worker.module';
-export * from './services/graphile-worker.service';
+export * from './services/worker.service';

src/interfaces/config.interface.ts renamed to src/interfaces/module-config.interfaces.ts

@@ -11,16 +11,6 @@ export interface GraphileWorkerConfigurationFactory {
 
 export interface GraphileWorkerAsyncConfiguration
   extends Pick<ModuleMetadata, 'imports'> {
-  /**
-   * Existing Provider to be used.
-   */
-  // useExisting?: Type<GraphileWorkerConfigurationFactory>;
-
-  /**
-   * Type (class name) of provider (instance to be registered and injected).
-   */
-  // useClass?: Type<GraphileWorkerConfigurationFactory>;
-
   /**
    * Factory function that returns an instance of the provider to be injected.
    */

src/services/configuration.service.ts

@@ -11,5 +11,4 @@ export class ConfigurationService {
   }
 }
 
-// TODO: try to remove this ?
 export const CONFIGURATION_SERVICE_KEY = Symbol.for(ConfigurationService.name);

src/services/graphile-worker.service.spec.ts renamed to src/services/worker.service.spec.ts

@@ -3,16 +3,16 @@ import {
   ConfigurationService,
   CONFIGURATION_SERVICE_KEY,
 } from './configuration.service';
-import { GraphileWorkerService } from './graphile-worker.service';
 import { ListenerExplorerService } from './listener-explorer.service';
+import { WorkerService } from './worker.service';
 
-describe(GraphileWorkerService.name, () => {
-  let service: GraphileWorkerService;
+describe(WorkerService.name, () => {
+  let service: WorkerService;
 
   beforeEach(async () => {
     const module: TestingModule = await Test.createTestingModule({
       providers: [
-        GraphileWorkerService,
+        WorkerService,
         {
           provide: ListenerExplorerService,
           useValue: {
@@ -32,7 +32,7 @@ describe(GraphileWorkerService.name, () => {
       ],
     }).compile();
 
-    service = module.get<GraphileWorkerService>(GraphileWorkerService);
+    service = module.get<WorkerService>(WorkerService);
   });
 
   it('should be defined', () => {

src/services/graphile-worker.service.ts renamed to src/services/worker.service.ts

@@ -15,8 +15,8 @@ import {
 import { ListenerExplorerService } from './listener-explorer.service';
 
 @Injectable()
-export class GraphileWorkerService {
-  private readonly logger = new Logger(GraphileWorkerService.name);
+export class WorkerService {
+  private readonly logger = new Logger(WorkerService.name);
   private isMigrationDone: boolean;
   private readonly options: RunnerOptions;