chore: Improve logging, Refactor store email validator, improve error handling for sending emails, Minor fixes

Author: HamzaJarane

app/controllers/contacts_controller.ts

@@ -3,19 +3,19 @@ import { storeEmailValidator } from '#validators/email';
 import type { HttpContext } from '@adonisjs/core/http'
 import logger from '@adonisjs/core/services/logger';
 import db from '@adonisjs/lucid/services/db';
+import { Exception } from '@adonisjs/core/exceptions';
 
 export default class ContactsController {
-    public async store({ request }: HttpContext) {
+    public async store({ request, response }: HttpContext) {
         const data = request.all();
 
         const payload = await storeEmailValidator.validate(data);
         const pastMessages = await EmailMessage.query().where('email', payload.email).orWhere('ip', request.ip());
 
         if(pastMessages.length >= 3) {
-            return {
-                success: false,
+            return response.tooManyRequests({
                 message: 'You can\'t send anymore messages'
-            };
+            });
         }
 
         const trx = await db.transaction();
@@ -31,14 +31,12 @@ export default class ContactsController {
             trx.rollback();
             logger.error(e);
 
-            return {
-                success: false,
-                message: 'Server error'
-            };
+            throw new Exception('Server error', {
+                status: 500,
+                code: 'E_SERVER_ERROR',
+            });
         }
 
-        return {
-            success: true
-        };
+        return response.ok({});
     }
 }

app/services/email_service.ts

@@ -1,35 +1,44 @@
 import EmailMessage from "#models/email_message";
 import mail from '@adonisjs/mail/services/main';
 import env from '#start/env';
+import logger from '@adonisjs/core/services/logger';
 
 export class EmailService {
   public async handleContactMessage(emailMessage: EmailMessage) {
-    await mail.send((message) => {
-      message
-        .to(env.get('EMAIL_TO'))
-        .from(emailMessage.email)
-        .subject(`New message from: [ ${emailMessage.name} ] - [ ${emailMessage.email} ]`)
-        .htmlView(
-          'emails/contact_new_message',
-          {
-            email: emailMessage.email,
-            name: emailMessage.name,
-            message: emailMessage.message
-          }
-        )
-    });
+    try {
+      await mail.send((message) => {
+        message
+          .to(env.get('EMAIL_TO'))
+          .from(env.get('EMAIL_FROM'), 'My website')
+          .subject(`New message from: [ ${emailMessage.name} ] - [ ${emailMessage.email} ]`)
+          .htmlView(
+            'emails/contact_new_message',
+            {
+              email: emailMessage.email,
+              name: emailMessage.name,
+              message: emailMessage.message
+            }
+          )
+      });
+    } catch (error) {
+      logger.error(error);
+    }
 
-    await mail.send((message) => {
-      message
-        .to(emailMessage.email)
-        .from(env.get('EMAIL_FROM'))
-        .subject(`[AUTO-MESSAGE] Thanks for contacting - [ ${emailMessage.name} ]`)
-        .htmlView(
-          'emails/contact_reply_to_sender',
-          {
-            name: emailMessage.name,
-          }
-        )
-    });
+    try {
+      await mail.send((message) => {
+        message
+          .to(emailMessage.email)
+          .from(env.get('EMAIL_FROM'), 'Hamza.im')
+          .subject(`[AUTO-MESSAGE] Thanks for contacting - [ ${emailMessage.name} ]`)
+          .htmlView(
+            'emails/contact_reply_to_sender',
+            {
+              name: emailMessage.name,
+            }
+          )
+      });
+    } catch (error) {
+      logger.error(error);
+    }
   }
 }

app/validators/email.ts

@@ -5,6 +5,5 @@ export const storeEmailValidator = vine.compile(
         name: vine.string().trim().maxLength(25),
         email: vine.string().trim().email(),
         message: vine.string().trim().maxLength(255),
-        locale: vine.string().trim().maxLength(5).nullable(),
     })
 )

config/logger.ts

@@ -18,7 +18,14 @@ const loggerConfig = defineConfig({
         targets: targets()
           .pushIf(!app.inProduction, targets.pretty())
           .pushIf(app.inProduction, targets.file({ destination: 1 }))
-          .toArray(),
+          .push({
+            target: 'pino/file',
+            options: {
+              destination: './logs/app.log'
+            },
+            level: 'info'
+          })
+          .toArray()
       },
     },
   },
@@ -31,5 +38,5 @@ export default loggerConfig
  * in your application.
  */
 declare module '@adonisjs/core/types' {
-  export interface LoggersList extends InferLoggers<typeof loggerConfig> {}
+  export interface LoggersList extends InferLoggers<typeof loggerConfig> { }
 }