WIP crontab implementation

Author: tacxou

service/src/core/categories/_dto/categories.dto.ts

@@ -44,7 +44,7 @@ export class CategoriesCreateDto extends AbstractCustomFieldsDto {
 }
 
 export class CategoriesDto extends CategoriesCreateDto {
-  @IsString()
+  @IsMongoId()
   @ApiProperty()
   public _id: string
 }

service/src/core/crontabs/_dto/crontabs.dto.ts

@@ -1,7 +1,46 @@
-import { PartialType } from "@nestjs/swagger"
+import { ApiProperty, PartialType } from '@nestjs/swagger'
+import { IsBoolean, IsMongoId, IsNotEmpty, IsOptional, IsString, ValidateNested, IsArray } from 'class-validator'
+import { Type } from 'class-transformer'
 
 export class CrontabsCreateDto {
+  @IsString()
+  @IsNotEmpty()
+  @ApiProperty()
+  public name: string
 
+  @IsString()
+  @IsOptional()
+  @ApiProperty()
+  public description?: string
+
+  @IsString()
+  @IsNotEmpty()
+  @ApiProperty()
+  //TODO: validate cron expression
+  public interval: string
+
+  @IsArray()
+  @ValidateNested({ each: true })
+  @Type(() => Object)
+  @ApiProperty()
+  public actions: { [key: string]: any }[]
+
+  @IsMongoId()
+  @IsOptional()
+  @ApiProperty()
+  public pluginId?: string
+
+  @IsBoolean()
+  @IsOptional()
+  @ApiProperty()
+  public disabled?: boolean
 }
 
-export class CrontabsUpdateDto extends PartialType(CrontabsCreateDto) {}
+export class CrontabsDto extends CrontabsCreateDto {
+  @IsMongoId()
+  @ApiProperty()
+  public _id: string
+}
+
+export class CrontabsUpdateDto extends PartialType(CrontabsCreateDto) {
+}

service/src/core/crontabs/_schemas/crontabs.schema.ts

@@ -1,9 +1,7 @@
 import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose'
-import { Document, ObjectId, Types } from 'mongoose'
+import { ObjectId, Types } from 'mongoose'
 import { AbstractSchema } from '~/_common/abstracts/schemas/abstract.schema'
 
-export type CrontabsDocument = Crontabs & Document
-
 @Schema({
   collection: 'crontabs',
   versionKey: false,
@@ -15,33 +13,28 @@ export class Crontabs extends AbstractSchema {
   })
   public name: string
 
-  @Prop({
-    required: true,
-    type: String,
-  })
+  @Prop({ type: String })
   public description: string
 
   @Prop({
     required: true,
-    type: Object,
+    type: String,
+    //TODO: validate cron expression
   })
-  public interval: { [key: string]: any }
+  public interval: string
 
   @Prop({
     required: true,
-    type: Object,
+    type: [Object],
   })
-  public actions: { [key: string]: any }
+  public actions: { [key: string]: any }[]
 
-  @Prop({
-    required: true,
-    type: Types.ObjectId,
-  })
-  public pluginId: ObjectId
+  @Prop({ type: Types.ObjectId })
+  public pluginId?: ObjectId
 
   @Prop({
-    required: true,
     type: Boolean,
+    default: false,
   })
   public disabled: boolean
 }

service/src/core/crontabs/crontabs.controller.ts

@@ -1,25 +1,39 @@
-import { Body, Controller, Delete, Get, HttpStatus, Param, Patch, Post, Req, Res } from '@nestjs/common'
-import { CrontabsCreateDto, CrontabsUpdateDto } from './_dto/crontabs.dto'
+import { Body, Controller, Delete, Get, HttpStatus, Param, Patch, Post, Res } from '@nestjs/common'
+import { CrontabsCreateDto, CrontabsDto, CrontabsUpdateDto } from './_dto/crontabs.dto'
 import { CrontabsService } from './crontabs.service'
 import { AbstractController } from '~/_common/abstracts/abstract.controller'
 import { ApiParam } from '@nestjs/swagger'
-import { SearchFilterSchema, FilterSchema, SearchFilterOptions, FilterOptions, ObjectIdValidationPipe } from '@streamkits/nestjs_module_scrud'
+import {
+  FilterOptions,
+  FilterSchema,
+  ObjectIdValidationPipe,
+  SearchFilterOptions,
+  SearchFilterSchema,
+} from '@streamkits/nestjs_module_scrud'
 import { Types } from 'mongoose'
-import { Request, Response } from 'express'
+import { Response } from 'express'
+import { PartialProjectionType } from '~/_common/types/partial-projection.type'
+import { ApiCreateDecorator } from '~/_common/decorators/api-create.decorator'
+import { ApiPaginatedDecorator } from '~/_common/decorators/api-paginated.decorator'
+import { PickProjectionHelper } from '~/_common/helpers/pick-projection.helper'
+import { ApiReadResponseDecorator } from '~/_common/decorators/api-read-response.decorator'
+import { ApiUpdateDecorator } from '~/_common/decorators/api-update.decorator'
+import { ApiDeletedResponseDecorator } from '~/_common/decorators/api-deleted-response.decorator'
 
 @Controller('crontabs')
 export class CrontabsController extends AbstractController {
-  protected readonly projection = {
+  protected static readonly projection: PartialProjectionType<CrontabsDto> = {
     name: 1,
-    description: 1,
+    interval: 1,
   }
 
-  constructor(private readonly _service: CrontabsService) {
+  public constructor(private readonly _service: CrontabsService) {
     super()
   }
 
   @Post()
-  public async create(@Req() req: Request, @Res() res: Response, @Body() body: CrontabsCreateDto) {
+  @ApiCreateDecorator(CrontabsCreateDto, CrontabsDto)
+  public async create(@Res() res: Response, @Body() body: CrontabsCreateDto): Promise<Response> {
     const data = await this._service.create(body)
     return res.status(HttpStatus.CREATED).json({
       statusCode: HttpStatus.CREATED,
@@ -28,8 +42,9 @@ export class CrontabsController extends AbstractController {
   }
 
   @Get()
-  public async search(@Res() res: Response, @SearchFilterSchema() searchFilterSchema: FilterSchema, @SearchFilterOptions() searchFilterOptions: FilterOptions) {
-    const [data, total] = await this._service.findAndCount(searchFilterSchema, this.projection, searchFilterOptions)
+  @ApiPaginatedDecorator(PickProjectionHelper(CrontabsDto, CrontabsController.projection))
+  public async search(@Res() res: Response, @SearchFilterSchema() searchFilterSchema: FilterSchema, @SearchFilterOptions() searchFilterOptions: FilterOptions): Promise<Response> {
+    const [data, total] = await this._service.findAndCount(searchFilterSchema, CrontabsController.projection, searchFilterOptions)
     return res.status(HttpStatus.OK).json({
       statusCode: HttpStatus.OK,
       total,
@@ -39,7 +54,8 @@ export class CrontabsController extends AbstractController {
 
   @Get(':_id([0-9a-fA-F]{24})')
   @ApiParam({ name: '_id', type: String })
-  public async read(@Param('_id', ObjectIdValidationPipe) _id: Types.ObjectId, @Res() res: Response) {
+  @ApiReadResponseDecorator(CrontabsDto)
+  public async read(@Param('_id', ObjectIdValidationPipe) _id: Types.ObjectId, @Res() res: Response): Promise<Response> {
     const data = await this._service.findById(_id)
     return res.status(HttpStatus.OK).json({
       statusCode: HttpStatus.OK,
@@ -49,7 +65,8 @@ export class CrontabsController extends AbstractController {
 
   @Patch(':_id([0-9a-fA-F]{24})')
   @ApiParam({ name: '_id', type: String })
-  public async update(@Param('_id', ObjectIdValidationPipe) _id: Types.ObjectId, @Body() body: CrontabsUpdateDto, @Res() res: Response) {
+  @ApiUpdateDecorator(CrontabsUpdateDto, CrontabsDto)
+  public async update(@Param('_id', ObjectIdValidationPipe) _id: Types.ObjectId, @Body() body: CrontabsUpdateDto, @Res() res: Response): Promise<Response> {
     const data = await this._service.update(_id, body)
     return res.status(HttpStatus.OK).json({
       statusCode: HttpStatus.OK,
@@ -59,7 +76,8 @@ export class CrontabsController extends AbstractController {
 
   @Delete(':_id([0-9a-fA-F]{24})')
   @ApiParam({ name: '_id', type: String })
-  public async remove(@Param('_id', ObjectIdValidationPipe) _id: Types.ObjectId, @Res() res: Response) {
+  @ApiDeletedResponseDecorator(CrontabsDto)
+  public async remove(@Param('_id', ObjectIdValidationPipe) _id: Types.ObjectId, @Res() res: Response): Promise<Response> {
     const data = await this._service.delete(_id)
     return res.status(HttpStatus.OK).json({
       statusCode: HttpStatus.OK,

service/src/core/crontabs/crontabs.module.ts

@@ -1,6 +1,6 @@
 import { Module } from '@nestjs/common'
 import { MongooseModule } from '@nestjs/mongoose'
-import { CrontabsSchema, Crontabs } from './_schemas/crontabs.schema'
+import { Crontabs, CrontabsSchema } from './_schemas/crontabs.schema'
 import { CrontabsService } from './crontabs.service'
 import { CrontabsController } from './crontabs.controller'
 

service/src/core/crontabs/crontabs.service.ts

@@ -6,7 +6,7 @@ import { AbstractServiceSchema } from '~/_common/abstracts/abstract.service.sche
 
 @Injectable()
 export class CrontabsService extends AbstractServiceSchema {
-  constructor(@InjectModel(Crontabs.name) protected _model: Model<Crontabs>) {
+  public constructor(@InjectModel(Crontabs.name) protected _model: Model<Crontabs>) {
     super()
   }
 }