api key add start date and end date (expiration), add endpoint update name, add endpoint update date, make difference port and port expose for docker

Author: andrechristikan

.env.example

@@ -13,7 +13,7 @@ DEBUGGER_HTTP_WRITE_INTO_CONSOLE=false
 DEBUGGER_SYSTEM_WRITE_INTO_FILE=true
 DEBUGGER_SYSTEM_WRITE_INTO_CONSOLE=true
 
-JOB_ENABLE=false
+JOB_ENABLE=true
 
 DATABASE_HOST=mongodb://localhost:30001,localhost:30002,localhost:30003
 DATABASE_NAME=ack

.github/workflows/cd.yml

@@ -15,6 +15,7 @@ jobs:
     env: 
       APP_NAME: ${{ github.event.repository.name }}
       APP_PORT: 3000
+      APP_PORT_EXPOSE: 3000
       APP_NETWORK: app-network
 
     steps:
@@ -58,7 +59,7 @@ jobs:
             docker network create ${{ env.APP_NETWORK }} --driver=bridge
             docker run -itd \
               --hostname ${{ env.APP_NAME}} \
-              --publish ${{ env.APP_PORT }}:${{ env.APP_PORT }} \
+              --publish ${{ env.APP_PORT_EXPOSE }}:${{ env.APP_PORT }} \
               --network ${{ env.APP_NETWORK }} \
               --volume /app/${{ env.APP_NAME}}/logs/:/app/logs/ \
               --volume /app/${{ env.APP_NAME}}/.env:/app/.env \

README.md

@@ -88,6 +88,8 @@ Next development
 * [x] Fix automation testing
 * [x] Pagination move from decorator to service pagination -> make pipe transformer -> wrap into group decorator ResponsePaging
 * [x] Check Swagger for pagination
+* [x] ApiKey add startDate and endDate
+* [x] Make docker port expose be difference with port app
 * [ ] SSO
     * [ ] Google
     * [ ] Apple
@@ -465,7 +467,6 @@ If your code behind commit with the original, please update your code and resolv
 
 [![Github][github-shield]][author-github]
 [![LinkedIn][linkedin-shield]][author-linkedin]
-[![Instagram][instagram-shield]][author-instagram]
 
 <!-- BADGE LINKS -->
 [ack-contributors-shield]: https://img.shields.io/github/contributors/andrechristikan/ack-nestjs-boilerplate?style=for-the-badge
@@ -485,11 +486,9 @@ If your code behind commit with the original, please update your code and resolv
 
 [github-shield]: https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white
 [linkedin-shield]: https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white
-[instagram-shield]: https://img.shields.io/badge/Instagram-E4405F?style=for-the-badge&logo=instagram&logoColor=white
 
 <!-- CONTACTS -->
 [author-linkedin]: https://linkedin.com/in/andrechristikan
-[author-instagram]: https://www.instagram.com/___ac.k
 [author-email]: mailto:[email protected]
 [author-github]: https://github.com/andrechristikan
 
@@ -510,7 +509,6 @@ If your code behind commit with the original, please update your code and resolv
 
 <!-- Reference -->
 [ref-nestjs]: http://nestjs.com
-[ref-nestjs-cqrs]: https://docs.nestjs.com/recipes/cqrs
 [ref-mongoose]: https://mongoosejs.com
 [ref-mongodb]: https://docs.mongodb.com/
 [ref-nodejs]: https://nodejs.org/

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ack-nestjs-boilerplate",
-  "version": "4.0.3",
+  "version": "4.1.0",
   "description": "Ack NestJs Boilerplate",
   "repository": {
     "type": "git",

scripts/jenkinsfile

@@ -9,6 +9,7 @@ pipeline {
         APP_NAME = 'ack' // this will be container name
         APP_NETWORK = 'app-network' // this network name
         APP_PORT = 3000 // this project will serve in port 0.0.0.0:3000
+        APP_EXPOSE_PORT = 3000 // this project will expose at port 0.0.0.0:3000
 
         NODE_JS = 'lts' // depends with our jenkins setting 
 
@@ -184,7 +185,7 @@ pipeline {
 
                         sshCommand remote: remote, command: "docker run -itd  \
                             --hostname ${APP_NAME} \
-                            --publish ${APP_PORT}:${APP_PORT} \
+                            --publish ${APP_EXPOSE_PORT}:${APP_PORT} \
                             --network ${APP_NETWORK} \
                             --volume /app/${APP_NAME}/logs/:/app/logs/ \
                             --volume /app/${APP_NAME}/.env:/app/.env \

src/common/api-key/constants/api-key.status-code.constant.ts

@@ -2,8 +2,9 @@ export enum ENUM_API_KEY_STATUS_CODE_ERROR {
     API_KEY_NEEDED_ERROR = 5120,
     API_KEY_NOT_FOUND_ERROR = 5121,
     API_KEY_IS_ACTIVE_ERROR = 5122,
-    API_KEY_INACTIVE_ERROR = 5123,
-    API_KEY_INVALID_ERROR = 5124,
-    API_KEY_PREFIX_INVALID_ERROR = 5125,
-    API_KEY_WRONG_ERROR = 5126,
+    API_KEY_EXPIRED_ERROR = 5123,
+    API_KEY_INACTIVE_ERROR = 5124,
+    API_KEY_INVALID_ERROR = 5125,
+    API_KEY_PREFIX_INVALID_ERROR = 5126,
+    API_KEY_WRONG_ERROR = 5127,
 }

src/common/api-key/controllers/api-key.admin.controller.ts

@@ -18,6 +18,7 @@ import {
 import {
     ApiKeyGetGuard,
     ApiKeyUpdateActiveGuard,
+    ApiKeyUpdateGuard,
     ApiKeyUpdateInactiveGuard,
     ApiKeyUpdateResetGuard,
 } from 'src/common/api-key/decorators/api-key.admin.decorator';
@@ -29,9 +30,12 @@ import {
     ApiKeyInactiveDoc,
     ApiKeyListDoc,
     ApiKeyResetDoc,
+    ApiKeyUpdateDoc,
 } from 'src/common/api-key/docs/api-key.admin.doc';
 import { ApiKeyCreateDto } from 'src/common/api-key/dtos/api-key.create.dto';
 import { ApiKeyRequestDto } from 'src/common/api-key/dtos/api-key.request.dto';
+import { ApiKeyUpdateDateDto } from 'src/common/api-key/dtos/api-key.update-date.dto';
+import { ApiKeyUpdateNameDto } from 'src/common/api-key/dtos/api-key.update-name.dto';
 import { IApiKeyEntity } from 'src/common/api-key/interfaces/api-key.interface';
 import { ApiKeyEntity } from 'src/common/api-key/repository/entities/api-key.entity';
 import { ApiKeyCreateSerialization } from 'src/common/api-key/serializations/api-key.create.serialization';
@@ -58,6 +62,7 @@ import {
     IResponse,
     IResponsePaging,
 } from 'src/common/response/interfaces/response.interface';
+import { ResponseIdSerialization } from 'src/common/response/serializations/response.id.serialization';
 
 @ApiTags('admin.apiKey')
 @Controller({
@@ -225,7 +230,7 @@ export class ApiKeyAdminController {
         ENUM_AUTH_PERMISSIONS.API_KEY_RESET
     )
     @AuthJwtAdminAccessProtected()
-    @Put('/update/:apiKey/reset')
+    @Patch('/update/:apiKey/reset')
     async reset(@GetApiKey() apiKey: ApiKeyEntity): Promise<IResponse> {
         try {
             const updated: IApiKeyEntity = await this.apiKeyService.reset(
@@ -245,4 +250,59 @@ export class ApiKeyAdminController {
             });
         }
     }
+
+    @ApiKeyUpdateDoc()
+    @Response('apiKey.update', { serialization: ResponseIdSerialization })
+    @ApiKeyUpdateGuard()
+    @RequestParamGuard(ApiKeyRequestDto)
+    @AuthPermissionProtected(
+        ENUM_AUTH_PERMISSIONS.API_KEY_READ,
+        ENUM_AUTH_PERMISSIONS.API_KEY_UPDATE
+    )
+    @AuthJwtAdminAccessProtected()
+    @Put('/update/:apiKey')
+    async updateName(
+        @Body() body: ApiKeyUpdateNameDto,
+        @GetApiKey() apiKey: ApiKeyEntity
+    ): Promise<IResponse> {
+        try {
+            await this.apiKeyService.updateName(apiKey._id, body);
+        } catch (err: any) {
+            throw new InternalServerErrorException({
+                statusCode: ENUM_ERROR_STATUS_CODE_ERROR.ERROR_UNKNOWN,
+                message: 'http.serverError.internalServerError',
+                error: err.message,
+            });
+        }
+
+        return { _id: apiKey._id };
+    }
+
+    @ApiKeyUpdateDoc()
+    @Response('apiKey.updateDate', { serialization: ResponseIdSerialization })
+    @ApiKeyUpdateGuard()
+    @RequestParamGuard(ApiKeyRequestDto)
+    @AuthPermissionProtected(
+        ENUM_AUTH_PERMISSIONS.API_KEY_READ,
+        ENUM_AUTH_PERMISSIONS.API_KEY_UPDATE,
+        ENUM_AUTH_PERMISSIONS.API_KEY_UPDATE_DATE
+    )
+    @AuthJwtAdminAccessProtected()
+    @Put('/update/:apiKey/date')
+    async updateDate(
+        @Body() body: ApiKeyUpdateDateDto,
+        @GetApiKey() apiKey: ApiKeyEntity
+    ): Promise<IResponse> {
+        try {
+            await this.apiKeyService.updateDate(apiKey._id, body);
+        } catch (err: any) {
+            throw new InternalServerErrorException({
+                statusCode: ENUM_ERROR_STATUS_CODE_ERROR.ERROR_UNKNOWN,
+                message: 'http.serverError.internalServerError',
+                error: err.message,
+            });
+        }
+
+        return { _id: apiKey._id };
+    }
 }

src/common/api-key/decorators/api-key.admin.decorator.ts

@@ -1,6 +1,7 @@
 import { applyDecorators, SetMetadata, UseGuards } from '@nestjs/common';
 import { API_KEY_ACTIVE_META_KEY } from 'src/common/api-key/constants/api-key.constant';
 import { ApiKeyActiveGuard } from 'src/common/api-key/guards/api-key.active.guard';
+import { ApiKeyExpiredGuard } from 'src/common/api-key/guards/api-key.expired.guard';
 import { ApiKeyNotFoundGuard } from 'src/common/api-key/guards/api-key.not-found.guard';
 import { ApiKeyPutToRequestGuard } from 'src/common/api-key/guards/api-key.put-to-request.guard';
 
@@ -10,12 +11,25 @@ export function ApiKeyGetGuard(): MethodDecorator {
     );
 }
 
+export function ApiKeyUpdateGuard(): MethodDecorator {
+    return applyDecorators(
+        UseGuards(
+            ApiKeyPutToRequestGuard,
+            ApiKeyNotFoundGuard,
+            ApiKeyActiveGuard,
+            ApiKeyExpiredGuard
+        ),
+        SetMetadata(API_KEY_ACTIVE_META_KEY, [true])
+    );
+}
+
 export function ApiKeyUpdateResetGuard(): MethodDecorator {
     return applyDecorators(
         UseGuards(
             ApiKeyPutToRequestGuard,
             ApiKeyNotFoundGuard,
-            ApiKeyActiveGuard
+            ApiKeyActiveGuard,
+            ApiKeyExpiredGuard
         ),
         SetMetadata(API_KEY_ACTIVE_META_KEY, [true])
     );
@@ -26,7 +40,8 @@ export function ApiKeyUpdateActiveGuard(): MethodDecorator {
         UseGuards(
             ApiKeyPutToRequestGuard,
             ApiKeyNotFoundGuard,
-            ApiKeyActiveGuard
+            ApiKeyActiveGuard,
+            ApiKeyExpiredGuard
         ),
         SetMetadata(API_KEY_ACTIVE_META_KEY, [false])
     );
@@ -37,7 +52,8 @@ export function ApiKeyUpdateInactiveGuard(): MethodDecorator {
         UseGuards(
             ApiKeyPutToRequestGuard,
             ApiKeyNotFoundGuard,
-            ApiKeyActiveGuard
+            ApiKeyActiveGuard,
+            ApiKeyExpiredGuard
         ),
         SetMetadata(API_KEY_ACTIVE_META_KEY, [true])
     );

src/common/api-key/docs/api-key.admin.doc.ts

@@ -11,6 +11,7 @@ import { ApiKeyCreateSerialization } from 'src/common/api-key/serializations/api
 import { ApiKeyGetSerialization } from 'src/common/api-key/serializations/api-key.get.serialization';
 import { ApiKeyListSerialization } from 'src/common/api-key/serializations/api-key.list.serialization';
 import { Doc, DocPaging } from 'src/common/doc/decorators/doc.decorator';
+import { ResponseIdSerialization } from 'src/common/response/serializations/response.id.serialization';
 
 export function ApiKeyListDoc(): MethodDecorator {
     return applyDecorators(
@@ -99,3 +100,19 @@ export function ApiKeyResetDoc(): MethodDecorator {
         })
     );
 }
+
+export function ApiKeyUpdateDoc(): MethodDecorator {
+    return applyDecorators(
+        Doc<ResponseIdSerialization>('apiKey.update', {
+            auth: {
+                jwtAccessToken: true,
+            },
+            request: {
+                params: ApiKeyDocParamsGet,
+            },
+            response: {
+                serialization: ResponseIdSerialization,
+            },
+        })
+    );
+}

src/common/api-key/dtos/api-key.create.dto.ts

@@ -1,5 +1,13 @@
+import { faker } from '@faker-js/faker';
 import { ApiProperty, PartialType } from '@nestjs/swagger';
-import { IsNotEmpty, IsOptional, IsString, MaxLength } from 'class-validator';
+import { Type } from 'class-transformer';
+import {
+    IsDate,
+    IsNotEmpty,
+    IsOptional,
+    IsString,
+    MaxLength,
+} from 'class-validator';
 
 export class ApiKeyCreateDto {
     @ApiProperty({
@@ -12,6 +20,28 @@ export class ApiKeyCreateDto {
     @MaxLength(50)
     name: string;
 
+    @ApiProperty({
+        description: 'Api Key start date',
+        example: faker.date.recent(),
+        required: false,
+        nullable: true,
+    })
+    @IsOptional()
+    @Type(() => Date)
+    @IsDate()
+    startDate?: Date;
+
+    @ApiProperty({
+        description: 'Api Key end date',
+        example: faker.date.recent(),
+        required: false,
+        nullable: true,
+    })
+    @IsOptional()
+    @Type(() => Date)
+    @IsDate()
+    endDate?: Date;
+
     @ApiProperty({
         description: 'Description of api key',
         example: 'blabla description',