Postmark setup- email for notifying admin on user sign

.github/workflows/main.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Set up node
         uses: actions/setup-node@v3
         with:
-          node-version: '19.x'
+          node-version: "19.x"
           # cache: yarn
           # cache-dependency-path: './apps/web/package-lock.json'
       - name: Install yarn
@@ -38,7 +38,7 @@ jobs:
       - name: Set up node
         uses: actions/setup-node@v3
         with:
-          node-version: '19.x'
+          node-version: "19.x"
           # cache: yarn
           # cache-dependency-path: './apps/web/package-lock.json'
       - name: Install yarn
@@ -56,7 +56,7 @@ jobs:
       - name: Set up node
         uses: actions/setup-node@v3
         with:
-          node-version: '19.x'
+          node-version: "19.x"
           # cache: yarn
           # cache-dependency-path: './apps/server/package-lock.json'
       - name: Install yarn

README.md

@@ -25,21 +25,21 @@ NextJS, NestJS, Prisma, PostgreSQL
 1. Create a .env file in `apps/web` and `apps/server` and configure environment variables using the provided example files.
 
    `apps/server/.env`
-   | VARIABLE           | VALUE                                                                                                                           |   |   |   |
+   | VARIABLE | VALUE | | | |
    |--------------------|---------------------------------------------------------------------------------------------------------------------------------|---|---|---|
-   | DOMAIN             | <http://localhost>                                                                                                              |   |   |   |
-   | BACKEND_PORT       | 8080                                                                                                                            |   |   |   |
-   | SALT_ROUNDS        | 10                                                                                                                              |   |   |   |
-   | DATABASE_URL       | postgresql://user:pass@localhost:5432/db?schema=public                                                                          |   |   |   |
-   | JWT_SECRET         | Execute the following to generate a random secret key: node -e "console.log(require('crypto').randomBytes(32).toString('hex'))" |   |   |   |
-   | JWT_VALID_DURATION | 600                                                                                                                             |   |   |   |
-   | FRONTEND_DOMAIN    | <http://localhost:3002>                                                                                                         |   |   |   |
+   | DOMAIN | <http://localhost> | | | |
+   | BACKEND_PORT | 8080 | | | |
+   | SALT_ROUNDS | 10 | | | |
+   | DATABASE_URL | postgresql://user:pass@localhost:5432/db?schema=public | | | |
+   | JWT_SECRET | Execute the following to generate a random secret key: node -e "console.log(require('crypto').randomBytes(32).toString('hex'))" | | | |
+   | JWT_VALID_DURATION | 600 | | | |
+   | FRONTEND_DOMAIN | <http://localhost:3002> | | | |
 
    `apps/web/.env`
-   | VARIABLE           | VALUE                                                                                                                           |   |   |   |
+   | VARIABLE | VALUE | | | |
    |--------------------|---------------------------------------------------------------------------------------------------------------------------------|---|---|---|
-   | DOMAIN             | <http://localhost>                                                                                                              |   |   |   |
-   | FRONTEND_PORT      | 3000                                                                                                                            |   |   |   |
+   | DOMAIN | <http://localhost> | | | |
+   | FRONTEND_PORT | 3000 | | | |
 
 2. Install yarn dependencies. We currently use Yarn and Yarn workspaces to manage dependencies.
 

apps/babel.config.js

@@ -1,8 +1,11 @@
 module.exports = {
-    presets: ["next/babel"],
-    plugins: [
-      ["@locator/babel-jsx/dist", {
+  presets: ["next/babel"],
+  plugins: [
+    [
+      "@locator/babel-jsx/dist",
+      {
         env: "development",
-      }]
-    ]
-  };
+      },
+    ],
+  ],
+};

apps/proxy.ts

@@ -10,8 +10,7 @@ const app = express();
 const proxy = createProxyMiddleware({
   target: "http://localhost:3000", // all requests to be routed to frontend running on port 3000
   router: {
-    "/api/auth": "http://localhost:3000",
-    "/api/v1": "http://localhost:8080", // all requests prefixed with "/api" to be routed to backend running on port 3001
+    "/api": "http://localhost:8080", // all requests prefixed with "/api" to be routed to backend running on port 3001
   },
   ws: true,
   logLevel: "warn",

apps/server/.env.example

@@ -3,9 +3,9 @@ BACKEND_PORT=8080
 SALT_ROUNDS=10
 
 # Prisma
-DATABASE_URL= 
+DATABASE_URL=
 
-JWT_SECRET= 
+JWT_SECRET=
 JWT_REFRESH_SECRET=
 JWT_VALID_DURATION=600
 JWT_REFRESH_VALID_DURATION=604800

apps/server/package.json

@@ -38,10 +38,10 @@
     "cookie-parser": "^1.4.6",
     "jwt-decode": "^4.0.0",
     "nestjs-config": "^1.4.11",
-    "next-auth": "^4.24.6",
     "passport": "^0.6.0",
     "passport-jwt": "^4.0.1",
     "passport-local": "^1.0.0",
+    "postmark": "^4.0.2",
     "prisma": "^5.2.0",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.8.1",

apps/server/prisma/seed.ts

@@ -231,28 +231,28 @@ async function main() {
       id: '777c1974-3104-4744-ae31-7a9296e7784a',
       firstName: 'Helen',
       lastName: 'Miao',
-      email: 'email1@kaiyangzhenggmail.onmicrosoft.com',
+      email: 'email1@gmail.com',
       positionId: CHIEF_OF_STAFF_UUID,
     },
     {
       id: '339cf78e-d13f-4069-b1f7-dee0c64afb31',
       firstName: 'Kai',
       lastName: 'Zheng',
-      email: 'email2@kaiyangzhenggmail.onmicrosoft.com',
+      email: 'email2@gmail.com',
       positionId: CHIEF_FIN_OFFICER_UUID,
     },
     {
       id: 'c6de4017-cb1f-44f1-a707-0f38239e0bca',
       firstName: 'Iris',
       lastName: 'Zhang',
-      email: 'email3@kaiyangzhenggmail.onmicrosoft.com',
+      email: 'email3@gmail.com',
       positionId: AGG_DIR_UUID,
     },
     {
       id: 'b386ef53-d2d1-4bfd-a44c-55b1750a874e',
       firstName: 'Anshul',
       lastName: 'Shirude',
-      email: 'email4@kaiyangzhenggmail.onmicrosoft.com',
+      email: 'email4@gmail.com',
       positionId: CHIEF_LEARNING_ENGAGEMENT_UUID,
     },
   ];

apps/server/src/app.controller.ts

@@ -43,7 +43,7 @@ export class AppController {
   }
 
   @UseGuards(LocalAuthGuard)
-  @Post('/auth/login')
+  @Post('auth/login')
   @ApiOkResponse({ type: JwtEntity })
   @ApiForbiddenResponse({ description: AppErrorMessage.FORBIDDEN })
   @ApiUnprocessableEntityResponse({
@@ -76,7 +76,7 @@ export class AppController {
   }
 
   @UseGuards(JwtRefreshAuthGuard)
-  @Get('/auth/refresh')
+  @Get('auth/refresh')
   @ApiBearerAuth()
   @ApiOkResponse({ type: JwtEntity })
   @ApiForbiddenResponse({ description: AppErrorMessage.FORBIDDEN })

apps/server/src/form-instances/form-instances.controller.spec.ts

@@ -13,6 +13,7 @@ import { NotFoundException } from '@nestjs/common';
 import { Prisma } from '@prisma/client';
 import { PositionsService } from '../positions/positions.service';
 import { LoggerServiceImpl } from '../logger/logger.service';
+import { PostmarkService } from '../postmark/postmark.service';
 
 describe('FormInstancesController', () => {
   let controller: FormInstancesController;
@@ -28,6 +29,7 @@ describe('FormInstancesController', () => {
         PositionsService,
         PrismaService,
         LoggerServiceImpl,
+        PostmarkService,
       ],
     }).compile();
 

apps/server/src/form-instances/form-instances.module.ts

@@ -5,10 +5,11 @@ import { PrismaModule } from '../prisma/prisma.module';
 import { FormTemplatesModule } from '../form-templates/form-templates.module';
 import { PositionsModule } from '../positions/positions.module';
 import { LoggerModule } from '../logger/logger.module';
+import { PostmarkService } from '../postmark/postmark.service';
 
 @Module({
   controllers: [FormInstancesController],
-  providers: [FormInstancesService],
+  providers: [FormInstancesService, PostmarkService],
   exports: [FormInstancesService],
   imports: [PrismaModule, FormTemplatesModule, PositionsModule, LoggerModule],
 })

apps/server/src/form-instances/form-instances.service.spec.ts

@@ -7,6 +7,7 @@ import { Prisma } from '@prisma/client';
 import { FormTemplateErrorMessage } from '../form-templates/form-templates.errors';
 import { FormInstanceErrorMessage } from './form-instance.errors';
 import { PositionsErrorMessage } from '../positions/positions.errors';
+import { PostmarkService } from '../postmark/postmark.service';
 
 const formInstance1Id = 'formInstanceId1';
 const formInstance2Id = 'formInstanceId2';
@@ -229,6 +230,7 @@ describe('FormInstancesService', () => {
         FormInstancesService,
         FormTemplatesService,
         PositionsService,
+        PostmarkService,
         {
           provide: PrismaService,
           useValue: db,

apps/server/src/form-instances/form-instances.service.ts

@@ -15,13 +15,15 @@ import { PositionsErrorMessage } from '../positions/positions.errors';
 import { SignatureErrorMessage } from '../signatures/signatures.errors';
 import { EmployeeErrorMessage } from '../employees/employees.errors';
 import { UserEntity } from '../auth/entities/user.entity';
+import { PostmarkService } from '../postmark/postmark.service';
 
 @Injectable()
 export class FormInstancesService {
   constructor(
     private prisma: PrismaService,
     private formTemplateService: FormTemplatesService,
     private positionService: PositionsService,
+    private postmarkService: PostmarkService,
   ) {}
 
   /**
@@ -273,6 +275,7 @@ export class FormInstancesService {
       where: { id: formInstanceId },
       include: {
         signatures: { include: { signerPosition: true, userSignedBy: true } },
+        originator: true,
       },
     });
 
@@ -331,8 +334,17 @@ export class FormInstancesService {
           signatures: { include: { signerPosition: true, userSignedBy: true } },
         },
       });
+      //this.postmarkService.sendEmail('[email protected]', 'test email: form signed by everyone', 'this is a test');
     }
-
+    const emailBody: string = `Hi Iris, your form has been signed by user: ${JSON.stringify(
+      currentUser.email,
+    )}.`;
+    const emailSubject: string = `Form signed by user ${currentUser.email}`;
+    this.postmarkService.sendEmail(
+      '[email protected]',
+      emailSubject,
+      emailBody,
+    );
     return updatedFormInstance;
   }
 

apps/server/src/main.ts

@@ -22,7 +22,7 @@ async function bootstrap() {
     });
   }
 
-  app.setGlobalPrefix('api/v1');
+  app.setGlobalPrefix('api');
 
   const config = new DocumentBuilder()
     .setTitle('MFA Form Automator API')

apps/server/src/postmark/postmark.service.ts

@@ -0,0 +1,27 @@
+import { Injectable } from '@nestjs/common';
+import { ServerClient } from 'postmark';
+
+@Injectable()
+export class PostmarkService {
+  client: ServerClient;
+
+  constructor() {
+    this.client = new ServerClient(process.env.POSTMARK_SERVER_KEY || '');
+  }
+
+  async sendEmail(to: string, subject: string, textBody: string) {
+    try {
+      this.client.sendEmail({
+        From: '[email protected]',
+        To: to,
+        Subject: subject,
+        // TODO FIXME when this is uncommented the text body doesn't show up
+        // 'HtmlBody': '<strong>Hello < /strong> dear Postmark user.',
+        TextBody: textBody,
+        MessageStream: 'outbound',
+      });
+    } catch (error) {
+      console.error('Error sending email through postmark:', error);
+    }
+  }
+}

apps/web/package.json

@@ -11,8 +11,6 @@
     "gen-client": "openapi --input http://localhost:4000/api-json --output ./src/client --client axios"
   },
   "dependencies": {
-    "@azure/identity": "^4.0.1",
-    "@azure/storage-blob": "^12.17.0",
     "@chakra-ui/icons": "^2.1.1",
     "@chakra-ui/react": "^2.4.9",
     "@emotion/react": "^11.10.5",

apps/web/src/client/services/DefaultService.ts

@@ -17,7 +17,7 @@ export class DefaultService {
     public static appControllerGetHello(): CancelablePromise<string> {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/api/v1',
+            url: '/api',
         });
     }
 
@@ -32,7 +32,7 @@ export class DefaultService {
     ): CancelablePromise<JwtEntity | any> {
         return __request(OpenAPI, {
             method: 'POST',
-            url: '/api/v1/auth/login',
+            url: '/api/auth/login',
             body: requestBody,
             mediaType: 'application/json',
             errors: {
@@ -50,7 +50,7 @@ export class DefaultService {
     public static appControllerRefresh(): CancelablePromise<JwtEntity> {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/api/v1/auth/refresh',
+            url: '/api/auth/refresh',
             errors: {
                 400: `Bad Request`,
                 403: `Unauthorized Request`,
@@ -66,7 +66,7 @@ export class DefaultService {
     public static appControllerLogout(): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/api/v1/auth/logout',
+            url: '/api/auth/logout',
         });
     }
 

apps/web/src/client/services/DepartmentsService.ts

@@ -22,7 +22,7 @@ export class DepartmentsService {
     ): CancelablePromise<DepartmentEntity> {
         return __request(OpenAPI, {
             method: 'POST',
-            url: '/api/v1/departments',
+            url: '/api/departments',
             body: requestBody,
             mediaType: 'application/json',
             errors: {
@@ -43,7 +43,7 @@ export class DepartmentsService {
     ): CancelablePromise<Array<DepartmentEntity>> {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/api/v1/departments',
+            url: '/api/departments',
             query: {
                 'limit': limit,
             },
@@ -64,7 +64,7 @@ export class DepartmentsService {
     ): CancelablePromise<DepartmentEntity> {
         return __request(OpenAPI, {
             method: 'GET',
-            url: '/api/v1/departments/{id}',
+            url: '/api/departments/{id}',
             path: {
                 'id': id,
             },
@@ -88,7 +88,7 @@ export class DepartmentsService {
     ): CancelablePromise<DepartmentEntity> {
         return __request(OpenAPI, {
             method: 'PATCH',
-            url: '/api/v1/departments/{id}',
+            url: '/api/departments/{id}',
             path: {
                 'id': id,
             },
@@ -113,7 +113,7 @@ export class DepartmentsService {
     ): CancelablePromise<any> {
         return __request(OpenAPI, {
             method: 'DELETE',
-            url: '/api/v1/departments/{id}',
+            url: '/api/departments/{id}',
             path: {
                 'id': id,
             },