@lenne.tech/nest-server 8.6.15 → 8.6.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lenne.tech/nest-server",
-  "version": "8.6.15",
+  "version": "8.6.16",
   "description": "Modern, fast, powerful Node.js web framework in TypeScript based on Nest with a GraphQL API and a connection to MongoDB (or other databases).",
   "keywords": [
     "node",
@@ -26,13 +26,14 @@
     "reinit": "rimraf package-lock.json && rimraf node_modules && npm cache clean --force && npm i && npm run test:e2e && npm run build",
     "reinit:force": "rimraf package-lock.json && rimraf node_modules && npm cache clean --force && npm i --force && npm run test:e2e",
     "reinit:legacy": "rimraf package-lock.json && rimraf node_modules && npm cache clean --force && npm i --legacy-peer-deps && npm run test:e2e",
-    "start": "npm run start:dev",
+    "start": "npm run start:local",
     "stop": "./node_modules/.bin/pm2 delete nest",
     "start:pm2": "./node_modules/.bin/grunt",
     "start:prod": "./node_modules/.bin/grunt productive",
     "start:nodemon": "ts-node -r tsconfig-paths/register src/main.ts",
     "start:debug": "nodemon --config nodemon-debug.json",
     "start:dev": "nodemon",
+    "start:local": "NODE_ENV=local nodemon",
     "test": "NODE_ENV=local jest",
     "test:cov": "NODE_ENV=local jest --coverage",
     "test:debug": "NODE_ENV=local node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
@@ -66,6 +67,7 @@
     "@nestjs/mongoose": "9.1.1",
     "@nestjs/passport": "8.2.2",
     "@nestjs/platform-express": "8.4.7",
+    "@nestjs/schedule": "^2.0.1",
     "apollo-server-core": "3.9.0",
     "apollo-server-express": "3.9.0",
     "bcrypt": "5.0.1",
@@ -93,6 +95,7 @@
   },
   "devDependencies": {
     "@nestjs/testing": "8.4.7",
+    "@types/cron": "^2.0.0",
     "@types/ejs": "3.1.1",
     "@types/jest": "28.1.3",
     "@types/lodash": "4.14.182",

package/src/config.env.ts

@@ -1,3 +1,4 @@
+import { CronExpression } from '@nestjs/schedule';
 import { join } from 'path';
 import { IServerOptions } from './core/common/interfaces/server-options.interface';
 
@@ -5,6 +6,63 @@ import { IServerOptions } from './core/common/interfaces/server-options.interfac
  * Configuration for the different environments
  */
 const config: { [env: string]: IServerOptions } = {
+  // ===========================================================================
+  // Local environment
+  // ===========================================================================
+  local: {
+    cronJobs: {
+      sayHello: {
+        cronTime: CronExpression.EVERY_5_MINUTES,
+        timeZone: 'Europe/Berlin',
+        runOnInit: false,
+      },
+    },
+    email: {
+      smtp: {
+        auth: {
+          user: 'rebeca68@ethereal.email',
+          pass: 'v5WUScAN98AzGbRjpc',
+        },
+        host: 'smtp.ethereal.email',
+        port: 587,
+        secure: false,
+      },
+      mailjet: {
+        api_key_public: 'MAILJET_API_KEY_PUBLIC',
+        api_key_private: 'MAILJET_API_KEY_PRIVATE',
+      },
+      defaultSender: {
+        email: 'rebeca68@ethereal.email',
+        name: 'Rebeca Sixtyeight',
+      },
+      verificationLink: 'http://localhost:4200/user/verification',
+      passwordResetLink: 'http://localhost:4200/user/password-reset',
+    },
+    env: 'local',
+    execAfterInit: 'npm run docs:bootstrap',
+    graphQl: {
+      driver: {
+        debug: true,
+        introspection: true,
+      },
+    },
+    jwt: {
+      secret: 'SECRET_OR_PRIVATE_KEY_DEV',
+    },
+    mongoose: {
+      uri: 'mongodb://localhost/nest-server-dev',
+    },
+    port: 3000,
+    staticAssets: {
+      path: join(__dirname, '..', 'public'),
+      options: { prefix: '' },
+    },
+    templates: {
+      path: join(__dirname, 'templates'),
+      engine: 'ejs',
+    },
+  },
+
   // ===========================================================================
   // Development environment
   // ===========================================================================

package/src/core/common/interfaces/cron-job-config.interface.ts

@@ -0,0 +1,52 @@
+import { CronExpression } from '@nestjs/schedule';
+import { CronCommand } from 'cron';
+import { Falsy } from '../types/falsy.type';
+
+/**
+ * Interface for cron job configuration
+ */
+export interface CronJobConfig {
+  /**
+   * The context within which to execute the onTick method. This defaults to the cronjob itself allowing you to call
+   * `this.stop()`. However, if you change this you'll have access to the functions and values within your context
+   * object.
+   */
+  context?: any;
+
+  /**
+   * The time to fire off your job. This can be in the form of cron syntax or a JS `Date` object.
+   */
+  cronTime: CronExpression | string | Date | Falsy;
+
+  /**
+   * A function that will fire when the job is complete, when it is stopped.
+   */
+  onComplete?: CronCommand | null;
+
+  /**
+   * This will immediately fire your `onTickfunction as soon as the requisit initialization has happened.
+   * This option is set to ``true``` by default.
+   */
+  runOnInit?: boolean;
+
+  /**
+   * Specify the timezone for the execution. This will modify the actual time relative to your timezone.
+   * If the timezone is invalid, an error is thrown. Can be any string accepted by luxon's `DateTime.setZone()`
+   * (https://moment.github.io/luxon/api-docs/index.html#datetimesetzone).
+   */
+  timeZone?: string;
+
+  /**
+   * If you have code that keeps the event loop running and want to stop the node process when that finishes
+   * regardless of the state of your cronjob, you can do so making use of this parameter. This is off by default and
+   * cron will run as if it needs to control the event loop. For more information take a look at
+   * timers#timers_timeout_unref  from the NodeJS docs.
+   */
+  unrefTimeout?: boolean;
+
+  /**
+   * This allows you to specify the offset of your timezone rather than using the `timeZoneparam.
+   * Probably don't use both ``timeZone` andutcOffset`` together or weird things may happen.
+   */
+  utcOffset?: string | number;
+}

package/src/core/common/interfaces/server-options.interface.ts

@@ -3,13 +3,22 @@ import { GqlModuleAsyncOptions } from '@nestjs/graphql';
 import { JwtModuleOptions } from '@nestjs/jwt';
 import { MongooseModuleOptions } from '@nestjs/mongoose';
 import { ServeStaticOptions } from '@nestjs/platform-express/interfaces/serve-static-options.interface';
+import { CronExpression } from '@nestjs/schedule';
 import * as SMTPTransport from 'nodemailer/lib/smtp-transport';
+import { Falsy } from '../types/falsy.type';
+import { CronJobConfig } from './cron-job-config.interface';
 import { MailjetOptions } from './mailjet-options.interface';
 
 /**
  * Options for the server
  */
 export interface IServerOptions {
+  /**
+   * Cron jobs configuration object with the name of the cron job function as key
+   * and the cron expression or config as value
+   */
+  cronJobs?: Record<string, CronExpression | string | Date | Falsy | CronJobConfig>;
+
   /**
    * SMTP and template configuration for sending emails
    */

package/src/core/common/services/core-cron-jobs.service.ts

@@ -0,0 +1,101 @@
+import { CronExpression, SchedulerRegistry } from '@nestjs/schedule';
+import { CronJob } from 'cron';
+import { CronJobConfig } from '../interfaces/cron-job-config.interface';
+import { Falsy } from '../types/falsy.type';
+
+/**
+ * Cron jobs service to extend
+ */
+export abstract class CoreCronJobs {
+  /**
+   * Config for cron jobs
+   */
+  config: {
+    [key: string]: any;
+    log: boolean;
+  };
+
+  // ===================================================================================================================
+  // Initializations
+  // ===================================================================================================================
+
+  /**
+   * Integrate services and init chron jobs
+   */
+  protected constructor(
+    protected schedulerRegistry: SchedulerRegistry,
+    protected cronJobs: Record<string, CronExpression | string | Date | Falsy | CronJobConfig>,
+    options?: { log?: boolean }
+  ) {
+    this.config = {
+      log: true,
+      ...options,
+    };
+    this.initCronJobs();
+  }
+
+  /**
+   * Init cron jobs
+   */
+  protected initCronJobs() {
+    // Get cron jobs
+    if (!this.cronJobs) {
+      return;
+    }
+
+    // Init cron jobs
+    for (const [name, CronExpressionOrConfig] of Object.entries(this.cronJobs)) {
+      // Check config
+      if (!CronExpressionOrConfig) {
+        continue;
+      }
+
+      // Prepare config
+      let config: CronExpression | string | Date | Falsy | CronJobConfig = CronExpressionOrConfig;
+      if (typeof config === 'string' || config instanceof Date) {
+        config = {
+          cronTime: config,
+        };
+      }
+
+      // Set defaults
+      config = {
+        timeZone: 'Europe/Berlin',
+        runOnInit: true,
+        ...config,
+      };
+
+      // Check if cron job should be activated
+      if (!config?.cronTime) {
+        continue;
+      }
+
+      // check if cron job exists
+      if (!this[name]) {
+        if (this.config.log) {
+          console.log('Missing cron job function ' + name);
+        }
+        continue;
+      }
+
+      // Init cron job
+      const job = new CronJob(
+        config.cronTime,
+        () => {
+          this[name]();
+        },
+        null,
+        true,
+        config.timeZone,
+        config.context,
+        config.runOnInit,
+        config.utcOffset,
+        config.unrefTimeout
+      );
+      this.schedulerRegistry.addCronJob(name, job);
+      if (this.config.log && this.schedulerRegistry.getCronJob(name)) {
+        console.log(`CronJob ${name} initialized with "${config.cronTime}"`);
+      }
+    }
+  }
+}

package/src/core/common/services/crud.service.ts

@@ -1,4 +1,5 @@
 import { NotFoundException } from '@nestjs/common';
+import { FilterQuery, QueryOptions } from 'mongoose';
 import { FilterArgs } from '../args/filter.args';
 import { merge } from '../helpers/config.helper';
 import { convertFilterArgsToQuery } from '../helpers/filter.helper';
@@ -12,7 +13,7 @@ export abstract class CrudService<T extends CoreModel = any> extends ModuleServi
    * Create item
    */
   async create(input: any, serviceOptions?: ServiceOptions): Promise<T> {
-    merge({ prepareInput: { create: true } }, serviceOptions);
+    serviceOptions = merge({ prepareInput: { create: true } }, serviceOptions);
     return this.process(
       async (data) => {
         const currentUserId = serviceOptions?.currentUser?.id;
@@ -36,13 +37,24 @@ export abstract class CrudService<T extends CoreModel = any> extends ModuleServi
   /**
    * Get items via filter
    */
-  async find(filterArgs?: FilterArgs, serviceOptions?: ServiceOptions): Promise<T[]> {
+  async find(
+    filter?: FilterArgs | { filterQuery?: FilterQuery<any>; queryOptions?: QueryOptions },
+    serviceOptions?: ServiceOptions
+  ): Promise<T[]> {
     return this.process(
       async (data) => {
-        const filterQuery = convertFilterArgsToQuery(data.input);
-        return this.mainDbModel.find(filterQuery[0], null, filterQuery[1]).exec();
+        // Prepare filter query
+        const filterQuery = { filterQuery: data?.input?.filterQuery, queryOptions: data?.input?.queryOptions };
+        if (data?.input instanceof FilterArgs) {
+          const converted = convertFilterArgsToQuery(data.input);
+          filterQuery.filterQuery = converted[0];
+          filterQuery.queryOptions = converted[1];
+        }
+
+        // Find in DB
+        return this.mainDbModel.find(filterQuery.filterQuery, null, filterQuery.queryOptions).exec();
       },
-      { input: filterArgs, serviceOptions }
+      { input: filter, serviceOptions }
     );
   }
 

package/src/core/common/types/falsy.type.ts

@@ -0,0 +1,4 @@
+/**
+ * Falsy type for anything that is considered false if it occurs in a Boolean context
+ */
+export type Falsy = false | 0 | '' | null | undefined;

package/src/index.ts

@@ -34,6 +34,7 @@ export * from './core/common/inputs/single-filter.input';
 export * from './core/common/inputs/sort.input';
 export * from './core/common/interceptors/check-response.interceptor';
 export * from './core/common/interfaces/core-persistence-model.interface';
+export * from './core/common/interfaces/cron-job-config.interface';
 export * from './core/common/interfaces/mailjet-options.interface';
 export * from './core/common/interfaces/prepare-input-options.interface';
 export * from './core/common/interfaces/prepare-output-options.interface';
@@ -48,12 +49,14 @@ export * from './core/common/scalars/any.scalar';
 export * from './core/common/scalars/date.scalar';
 export * from './core/common/scalars/json.scalar';
 export * from './core/common/services/config.service';
+export * from './core/common/services/core-cron-jobs.service';
 export * from './core/common/services/crud.service';
 export * from './core/common/services/email.service';
 export * from './core/common/services/mailjet.service';
 export * from './core/common/services/module.service';
 export * from './core/common/services/template.service';
 export * from './core/common/types/core-model-constructor.type';
+export * from './core/common/types/falsy.type';
 export * from './core/common/types/field-selection.type';
 export * from './core/common/types/ids.type';
 export * from './core/common/types/maybe-promise.type';

package/src/server/common/services/cron-jobs.service.ts

@@ -0,0 +1,26 @@
+import { Injectable } from '@nestjs/common';
+import { SchedulerRegistry } from '@nestjs/schedule';
+import envConfig from '../../../config.env';
+import { CoreCronJobs } from '../../../core/common/services/core-cron-jobs.service';
+
+@Injectable()
+export class CronJobs extends CoreCronJobs {
+  // ===================================================================================================================
+  // Initializations
+  // ===================================================================================================================
+
+  /**
+   * Init cron jobs
+   */
+  constructor(protected schedulerRegistry: SchedulerRegistry) {
+    super(schedulerRegistry, envConfig.cronJobs, { log: true });
+  }
+
+  // ===================================================================================================================
+  // Cron jobs
+  // ===================================================================================================================
+
+  protected sayHello() {
+    console.log('Hello :)');
+  }
+}

package/src/server/server.module.ts

@@ -1,7 +1,9 @@
 import { Module } from '@nestjs/common';
+import { ScheduleModule } from '@nestjs/schedule';
 import envConfig from '../config.env';
 import { CoreModule } from '../core.module';
 import { CoreAuthService } from '../core/modules/auth/services/core-auth.service';
+import { CronJobs } from './common/services/cron-jobs.service';
 import { AuthModule } from './modules/auth/auth.module';
 import { FileModule } from './modules/file/file.module';
 import { ServerController } from './server.controller';
@@ -18,6 +20,9 @@ import { ServerController } from './server.controller';
     // Include CoreModule for standard processes
     CoreModule.forRoot(CoreAuthService, AuthModule.forRoot(envConfig.jwt), envConfig),
 
+    // Include cron job handling
+    ScheduleModule.forRoot(),
+
     // Include AuthModule for authorization handling,
     // which will also include UserModule
     AuthModule.forRoot(envConfig.jwt),
@@ -26,6 +31,8 @@ import { ServerController } from './server.controller';
     FileModule,
   ],
 
+  providers: [CronJobs],
+
   // Include REST controllers
   controllers: [ServerController],