fix: add DatabaseService provider to PulseModule (#1)

* fix: add DatabaseService provider to PulseModule

* refactor: naming

Author: code-xhyun

src/constants.ts

@@ -1,9 +1,9 @@
-export const JOB_NAME = Symbol('AGENDA_MODULE:JOB_NAME');
-export const AGENDA_JOB_OPTIONS = Symbol('AGENDA_JOB_OPTIONS');
-export const JOB_PROCESSOR_TYPE = Symbol('AGENDA_MODULE:JOB_PROCESSOR_TYPE');
-export const AGENDA_MODULE_CONFIG = Symbol('AGENDA_MODULE_CONFIG');
-export const AGENDA_QUEUE_EVENT = Symbol('AGENDA_QUEUE_EVENT');
-export const AGENDA_MODULE_QUEUE = Symbol('AGENDA_MODULE_QUEUE');
-export const ON_QUEUE_EVENT = Symbol('AGENDA_MODULE:ON_QUEUE_EVENT');
-export const QUEUE_CONFIG = Symbol('AGENDA_MODULE:QUEUE_CONFIG');
-export const DATABASE_CONNECTION = Symbol('AGENDA_MODULE:DATABASE_CONNECTION');
+export const JOB_NAME = Symbol('PULSE_MODULE:JOB_NAME');
+export const PULSE_JOB_OPTIONS = Symbol('PULSE_JOB_OPTIONS');
+export const JOB_PROCESSOR_TYPE = Symbol('PULSE_MODULE:JOB_PROCESSOR_TYPE');
+export const PULSE_MODULE_CONFIG = Symbol('PULSE_MODULE_CONFIG');
+export const PULSE_QUEUE_EVENT = Symbol('PULSE_QUEUE_EVENT');
+export const PULSE_MODULE_QUEUE = Symbol('PULSE_MODULE_QUEUE');
+export const ON_QUEUE_EVENT = Symbol('PULSE_MODULE:ON_QUEUE_EVENT');
+export const QUEUE_CONFIG = Symbol('PULSE_MODULE:QUEUE_CONFIG');
+export const DATABASE_CONNECTION = Symbol('PULSE_MODULE:DATABASE_CONNECTION');

src/decorators/define.decorator.ts

@@ -1,26 +1,21 @@
 import { applyDecorators, SetMetadata } from '@nestjs/common';
 import { DefineOptions } from '@pulsecron/pulse';
-import { JOB_PROCESSOR_TYPE, AGENDA_JOB_OPTIONS } from '../constants';
+import { JOB_PROCESSOR_TYPE, PULSE_JOB_OPTIONS } from '../constants';
 import { JobProcessorType } from '../enums';
 
 type NameAndDefineOptions = DefineOptions & Record<'name', string>;
 
 export function Define(name?: string): MethodDecorator;
 export function Define(options?: NameAndDefineOptions): MethodDecorator;
-export function Define(
-  nameOrOptions?: string | NameAndDefineOptions,
-): MethodDecorator {
+export function Define(nameOrOptions?: string | NameAndDefineOptions): MethodDecorator {
   let options = {};
 
   if (nameOrOptions) {
-    options =
-      typeof nameOrOptions === 'string'
-        ? { name: nameOrOptions }
-        : nameOrOptions;
+    options = typeof nameOrOptions === 'string' ? { name: nameOrOptions } : nameOrOptions;
   }
 
   return applyDecorators(
-    SetMetadata(AGENDA_JOB_OPTIONS, options),
-    SetMetadata(JOB_PROCESSOR_TYPE, JobProcessorType.DEFINE),
+    SetMetadata(PULSE_JOB_OPTIONS, options),
+    SetMetadata(JOB_PROCESSOR_TYPE, JobProcessorType.DEFINE)
   );
 }

src/decorators/queue.decorator.ts

@@ -1,6 +1,6 @@
 import { SetMetadata, Type } from '@nestjs/common';
 import { PulseQueueConfig } from '../interfaces';
-import { AGENDA_MODULE_QUEUE } from '../constants';
+import { PULSE_MODULE_QUEUE } from '../constants';
 
 export function Queue(): ClassDecorator;
 export function Queue(name: string): ClassDecorator;
@@ -13,6 +13,6 @@ export function Queue(nameOrConfig?: string | PulseQueueConfig): ClassDecorator
     : {};
 
   return (target: Type<any> | Function) => {
-    SetMetadata(AGENDA_MODULE_QUEUE, pulseConfig)(target);
+    SetMetadata(PULSE_MODULE_QUEUE, pulseConfig)(target);
   };
 }

src/decorators/schedulers.decorator.ts

@@ -1,41 +1,32 @@
-import { applyDecorators, SetMetadata } from "@nestjs/common";
-import { JOB_PROCESSOR_TYPE, AGENDA_JOB_OPTIONS } from "../constants";
-import { JobProcessorType } from "../enums";
-import { JobOptions } from "../interfaces/job-options.interface";
+import { applyDecorators, SetMetadata } from '@nestjs/common';
+import { JOB_PROCESSOR_TYPE, PULSE_JOB_OPTIONS } from '../constants';
+import { JobProcessorType } from '../enums';
+import { JobOptions } from '../interfaces/job-options.interface';
 
-export type RepeatableJobOptions = JobOptions & Record<"interval", string>;
+export type RepeatableJobOptions = JobOptions & Record<'interval', string>;
 
-export type NonRepeatableJobOptions = JobOptions &
-  Record<"when", string | Date>;
+export type NonRepeatableJobOptions = JobOptions & Record<'when', string | Date>;
 
-export type PulseModuleJobOptions =
-  | RepeatableJobOptions
-  | NonRepeatableJobOptions;
+export type PulseModuleJobOptions = RepeatableJobOptions | NonRepeatableJobOptions;
 
 export function Every(interval: string): MethodDecorator;
 export function Every(options: RepeatableJobOptions): MethodDecorator;
-export function Every(
-  intervalOrOptions: string | RepeatableJobOptions
-): MethodDecorator {
-  const options =
-    typeof intervalOrOptions === "string"
-      ? { interval: intervalOrOptions }
-      : intervalOrOptions;
+export function Every(intervalOrOptions: string | RepeatableJobOptions): MethodDecorator {
+  const options = typeof intervalOrOptions === 'string' ? { interval: intervalOrOptions } : intervalOrOptions;
 
   return applyDecorators(
-    SetMetadata(AGENDA_JOB_OPTIONS, options),
+    SetMetadata(PULSE_JOB_OPTIONS, options),
     SetMetadata(JOB_PROCESSOR_TYPE, JobProcessorType.EVERY)
   );
 }
 
 export function Schedule(when: string): MethodDecorator;
 export function Schedule(options: NonRepeatableJobOptions): MethodDecorator;
 export function Schedule(whenOrOptions: string | NonRepeatableJobOptions) {
-  const options =
-    typeof whenOrOptions === "string" ? { when: whenOrOptions } : whenOrOptions;
+  const options = typeof whenOrOptions === 'string' ? { when: whenOrOptions } : whenOrOptions;
 
   return applyDecorators(
-    SetMetadata(AGENDA_JOB_OPTIONS, options),
+    SetMetadata(PULSE_JOB_OPTIONS, options),
     SetMetadata(JOB_PROCESSOR_TYPE, JobProcessorType.SCHEDULE)
   );
 }
@@ -44,7 +35,7 @@ export function Now(name?: string): MethodDecorator {
   const options = { name };
 
   return applyDecorators(
-    SetMetadata(AGENDA_JOB_OPTIONS, options),
+    SetMetadata(PULSE_JOB_OPTIONS, options),
     SetMetadata(JOB_PROCESSOR_TYPE, JobProcessorType.NOW)
   );
 }

src/index.ts

@@ -1,2 +1,2 @@
-export * from "./decorators";
-export * from "./pulse.module";
+export * from './decorators';
+export * from './pulse.module';

src/providers/database.service.ts

@@ -1,33 +1,25 @@
-import { Db, MongoClient } from "mongodb";
-import { Inject, Injectable } from "@nestjs/common";
-import { PulseConfig } from "@pulsecron/pulse";
+import { Db, MongoClient } from 'mongodb';
+import { Inject, Injectable } from '@nestjs/common';
+import { PulseConfig } from '@pulsecron/pulse';
 
-import { AGENDA_MODULE_CONFIG } from "../constants";
+import { PULSE_MODULE_CONFIG } from '../constants';
 
 @Injectable()
 export class DatabaseService {
   private connection!: Db;
   private client?: MongoClient;
 
-  constructor(
-    @Inject(AGENDA_MODULE_CONFIG) private readonly config: PulseConfig
-  ) {
+  constructor(@Inject(PULSE_MODULE_CONFIG) private readonly config: PulseConfig) {
     if (config.mongo) {
       this.connection = config.mongo;
     } else {
-      this.client = new MongoClient(
-        config.db?.address as string,
-        config.db?.options
-      );
+      this.client = new MongoClient(config.db?.address as string, config.db?.options);
     }
   }
 
   async connect() {
     if (!this.connection) {
-      this.client = new MongoClient(
-        this.config.db?.address as string,
-        this.config.db?.options
-      );
+      this.client = new MongoClient(this.config.db?.address as string, this.config.db?.options);
 
       await this.client.connect();
 

src/providers/pulse-metadata.accessor.ts

@@ -1,21 +1,15 @@
-import { Injectable, Inject, Type } from "@nestjs/common";
-import { Reflector } from "@nestjs/core";
-import {
-  JOB_PROCESSOR_TYPE,
-  JOB_NAME,
-  AGENDA_JOB_OPTIONS,
-  AGENDA_MODULE_QUEUE,
-  ON_QUEUE_EVENT,
-} from "../constants";
-import { PulseModuleJobOptions } from "../decorators";
-import { JobProcessorType } from "../enums";
+import { Injectable, Inject, Type } from '@nestjs/common';
+import { Reflector } from '@nestjs/core';
+import { JOB_PROCESSOR_TYPE, JOB_NAME, PULSE_JOB_OPTIONS, PULSE_MODULE_QUEUE, ON_QUEUE_EVENT } from '../constants';
+import { PulseModuleJobOptions } from '../decorators';
+import { JobProcessorType } from '../enums';
 
 @Injectable()
 export class PulseMetadataAccessor {
   constructor(@Inject(Reflector.name) private readonly reflector: Reflector) {}
 
   isQueue(target: Type<any> | Function): boolean {
-    return !!this.reflector.get(AGENDA_MODULE_QUEUE, target);
+    return !!this.reflector.get(PULSE_MODULE_QUEUE, target);
   }
 
   isEventListener(target: Type<any> | Function): boolean {
@@ -31,7 +25,7 @@ export class PulseMetadataAccessor {
   }
 
   getQueueMetadata(target: Type<any> | Function): any {
-    return this.reflector.get(AGENDA_MODULE_QUEUE, target);
+    return this.reflector.get(PULSE_MODULE_QUEUE, target);
   }
 
   getJobProcessorType(target: Function): JobProcessorType {
@@ -43,6 +37,6 @@ export class PulseMetadataAccessor {
   }
 
   getJobProcessorMetadata(target: Type<any> | Function): PulseModuleJobOptions {
-    return this.reflector.get(AGENDA_JOB_OPTIONS, target);
+    return this.reflector.get(PULSE_JOB_OPTIONS, target);
   }
 }

src/pulse.module.ts

@@ -1,6 +1,6 @@
 import { DynamicModule, InjectionToken, Module, Provider, Type, forwardRef } from '@nestjs/common';
 import { DiscoveryModule, ModuleRef } from '@nestjs/core';
-import { AGENDA_MODULE_CONFIG } from './constants';
+import { PULSE_MODULE_CONFIG } from './constants';
 import { pulseFactory } from './factories';
 import { PulseConfigFactory, PulseModuleAsyncConfig, PulseModuleConfig, PulseQueueConfig } from './interfaces';
 import { PulseExplorer, PulseMetadataAccessor } from './providers';
@@ -10,14 +10,14 @@ import { getQueueConfigToken, getQueueToken } from './utils';
 
 @Module({
   imports: [DiscoveryModule],
-  providers: [PulseOrchestrator],
+  providers: [PulseOrchestrator, DatabaseService],
   exports: [PulseOrchestrator],
 })
 export class PulseModule {
   static forRoot(config: PulseModuleConfig): DynamicModule {
     const configProviders: Provider[] = [
       {
-        provide: AGENDA_MODULE_CONFIG,
+        provide: PULSE_MODULE_CONFIG,
         useValue: config,
       },
       DatabaseService,
@@ -35,7 +35,7 @@ export class PulseModule {
   }
 
   static forRootAsync(config: PulseModuleAsyncConfig<PulseModuleConfig>): DynamicModule {
-    const providers = this.createAsyncProviders<PulseModuleConfig>(AGENDA_MODULE_CONFIG, config);
+    const providers = this.createAsyncProviders<PulseModuleConfig>(PULSE_MODULE_CONFIG, config);
 
     return {
       global: true,
@@ -64,7 +64,7 @@ export class PulseModule {
       {
         provide: getQueueToken(name),
         useFactory: pulseFactory,
-        inject: [queueConfigToken, AGENDA_MODULE_CONFIG],
+        inject: [queueConfigToken, PULSE_MODULE_CONFIG],
       },
     ];
 
@@ -82,7 +82,7 @@ export class PulseModule {
       {
         provide: getQueueToken(name),
         useFactory: pulseFactory,
-        inject: [queueConfigToken, AGENDA_MODULE_CONFIG],
+        inject: [queueConfigToken, PULSE_MODULE_CONFIG],
       },
       ...this.createAsyncProviders<PulseQueueConfig>(queueConfigToken, config),
     ];