feat: add support for exclude_params query parameter to exclude param (…

…#2115)
opengovsg · Jul 25, 2023 · a274a37 · a274a37
1 parent c5f498a
commit a274a37
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/backend/src/email/middlewares/email-transactional.middleware.ts b/backend/src/email/middlewares/email-transactional.middleware.ts
@@ -59,12 +59,15 @@ export const InitEmailTransactionalMiddleware = (
   }
   type ReqBodyWithId = ReqBody & { emailMessageTransactionalId: string }
 
-  function convertMessageModelToResponse(message: EmailMessageTransactional) {
+  function convertMessageModelToResponse(
+    message: EmailMessageTransactional,
+    excludeParams = false
+  ) {
     return {
       id: message.id,
       from: message.from,
       recipient: message.recipient,
-      params: message.params,
+      params: excludeParams ? undefined : message.params,
       attachments_metadata: message.attachmentsMetadata,
       status: message.status,
       error_code: message.errorCode,
@@ -214,7 +217,8 @@ export const InitEmailTransactionalMiddleware = (
   async function listMessages(req: Request, res: Response): Promise<void> {
     // validation from Joi doesn't carry over into type safety here
     // following code transforms query params into type-safe arguments for EmailTransactionalService
-    const { limit, offset, status, created_at, sort_by, tag } = req.query
+    const { limit, offset, status, created_at, sort_by, tag, exclude_params } =
+      req.query
     const userId: string = req.session?.user?.id.toString() // id is number in session; convert to string for tests to pass (weird)
     const filter = created_at ? { createdAt: created_at } : undefined
     const sortBy = sort_by?.toString().replace(/[+-]/, '')
@@ -233,7 +237,9 @@ export const InitEmailTransactionalMiddleware = (
     })
     res.status(200).json({
       has_more: hasMore,
-      data: messages.map(convertMessageModelToResponse),
+      data: messages.map((m) =>
+        convertMessageModelToResponse(m, exclude_params as unknown as boolean)
+      ),
     })
   }
 

diff --git a/backend/src/email/routes/email-transactional.routes.ts b/backend/src/email/routes/email-transactional.routes.ts
@@ -65,6 +65,7 @@ export const InitEmailTransactionalRoute = (
       limit: Joi.number().integer().min(1).max(1000).default(10),
       offset: Joi.number().integer().min(0).default(0),
       tag: Joi.string().max(255),
+      exclude_params: Joi.boolean().default(false),
       status: Joi.string()
         .uppercase()
         .valid(...Object.values(TransactionalEmailMessageStatus)),