build: release v5.15.0 - webhook attachments

CHANGELOG.md

@@ -4,8 +4,15 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v5.15.0](https://github.com/opengovsg/FormSG/compare/v5.14.1...v5.15.0)
+
+- feat: Add webhook support for storage mode attachments [`#1713`](https://github.com/opengovsg/FormSG/pull/1713)
+
 #### [v5.14.1](https://github.com/opengovsg/FormSG/compare/v5.14.0...v5.14.1)
 
+> 15 June 2021
+
+- chore: bump version to v5.14.1 [`d7a612e`](https://github.com/opengovsg/FormSG/commit/d7a612e55ed56aac1d7784d25a8b894b924f3401)
 - fix: allow read key in permissionList when updating collaborators [`6ae1af6`](https://github.com/opengovsg/FormSG/commit/6ae1af6859e8b9be275204f4274ba396a6769ff4)
 
 #### [v5.14.0](https://github.com/opengovsg/FormSG/compare/v5.13.1...v5.14.0)
@@ -166,7 +173,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - fix(verification): loosen OTP waiting time by 2 seconds [`#1957`](https://github.com/opengovsg/FormSG/pull/1957)
 - chore: bump version to 5.12.0 [`85759bc`](https://github.com/opengovsg/FormSG/commit/85759bc9dc01f73da3cbd0ec73c636e58e983948)
 
-#### [v5.11.0](https://github.com/opengovsg/FormSG/compare/v5.10.1...v5.11.0)
+#### [v5.11.0](https://github.com/opengovsg/FormSG/compare/v5.10.0...v5.11.0)
 
 > 25 May 2021
 
@@ -234,11 +241,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - chore(deps-dev): bump @typescript-eslint/eslint-plugin [`#1868`](https://github.com/opengovsg/FormSG/pull/1868)
 - fix(deps): bump @sentry/integrations from 6.3.5 to 6.3.6 [`#1850`](https://github.com/opengovsg/FormSG/pull/1850)
 - chore: bump version to 5.11.0 [`54b1958`](https://github.com/opengovsg/FormSG/commit/54b1958d0968e670ef145461d9d7859384d573ef)
-
-#### [v5.10.1](https://github.com/opengovsg/FormSG/compare/v5.10.0...v5.10.1)
-
-> 17 May 2021
-
 - chore: bump version to v5.10.1 [`0442cd7`](https://github.com/opengovsg/FormSG/commit/0442cd72637019fb1e43bce5f8f5abe14ee79f8c)
 - fix: allow for unknown keys in updateEndPage validator [`617d86a`](https://github.com/opengovsg/FormSG/commit/617d86a28910eec6ebd3249a2de636086429d6a6)
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "FormSG",
   "description": "Form Manager for Government",
-  "version": "5.14.1",
+  "version": "5.15.0",
   "homepage": "https://form.gov.sg",
   "authors": [
     "FormSG <[email protected]>"

src/app/models/__tests__/submission.server.model.spec.ts

@@ -68,6 +68,7 @@ describe('Submission Model', () => {
           isRetryEnabled: true,
           webhookView: {
             data: {
+              attachmentDownloadUrls: {},
               formId: String(form._id),
               submissionId: String(submission._id),
               encryptedContent: MOCK_ENCRYPTED_CONTENT,
@@ -120,6 +121,7 @@ describe('Submission Model', () => {
           isRetryEnabled: false,
           webhookView: {
             data: {
+              attachmentDownloadUrls: {},
               formId: String(form._id),
               submissionId: String(submission._id),
               encryptedContent: MOCK_ENCRYPTED_CONTENT,
@@ -155,6 +157,7 @@ describe('Submission Model', () => {
           isRetryEnabled: false,
           webhookView: {
             data: {
+              attachmentDownloadUrls: {},
               formId: String(form._id),
               submissionId: String(submission._id),
               encryptedContent: MOCK_ENCRYPTED_CONTENT,
@@ -268,6 +271,7 @@ describe('Submission Model', () => {
             created: expect.any(Date),
             encryptedContent: MOCK_ENCRYPTED_CONTENT,
             verifiedContent: undefined,
+            attachmentDownloadUrls: {},
             version: 1,
           },
         })
@@ -294,6 +298,7 @@ describe('Submission Model', () => {
         // Assert
         expect(actualWebhookView).toEqual({
           data: {
+            attachmentDownloadUrls: {},
             formId: expect.any(String),
             submissionId: expect.any(String),
             created: expect.any(Date),
@@ -336,6 +341,7 @@ describe('Submission Model', () => {
         // Assert
         expect(actualWebhookView).toEqual({
           data: {
+            attachmentDownloadUrls: {},
             formId: expect.any(String),
             submissionId: expect.any(String),
             created: expect.any(Date),

src/app/models/field/attachmentField.ts

@@ -1,11 +1,6 @@
 import { Document, Schema } from 'mongoose'
 
-import {
-  AttachmentSize,
-  IAttachmentField,
-  IFormSchema,
-  ResponseMode,
-} from '../../../types'
+import { AttachmentSize, IAttachmentField, IFormSchema } from '../../../types'
 
 // Manual override since mongoose types don't have generics yet.
 interface IAttachmentFieldSchema extends IAttachmentField, Document {
@@ -24,22 +19,6 @@ const createAttachmentFieldSchema = () => {
     },
   })
 
-  // Prevent attachments from being saved on a webhooked form.
-  AttachmentFieldSchema.pre<IAttachmentFieldSchema>(
-    'validate',
-    function (next) {
-      const { webhook, responseMode } = this.parent()
-
-      if (responseMode === ResponseMode.Encrypt && webhook?.url) {
-        return next(
-          Error('Attachments are not allowed when a form has a webhook url'),
-        )
-      }
-
-      return next()
-    },
-  )
-
   return AttachmentFieldSchema
 }
 

src/app/models/submission.server.model.ts

@@ -187,13 +187,18 @@ EncryptSubmissionSchema.methods.getWebhookView = function (
   const formId = this.populated('form')
     ? String(this.form._id)
     : String(this.form)
+  const attachmentRecords = Object.fromEntries(
+    this.attachmentMetadata ?? new Map(),
+  )
+
   const webhookData: WebhookData = {
     formId,
     submissionId: String(this._id),
     encryptedContent: this.encryptedContent,
     verifiedContent: this.verifiedContent,
     version: this.version,
     created: this.created,
+    attachmentDownloadUrls: attachmentRecords,
   }
 
   return {

src/app/modules/webhook/__tests__/webhook.service.spec.ts

@@ -94,6 +94,9 @@ describe('webhook.service', () => {
       formId: MOCK_FORM_ID,
       submissionId: MOCK_SUBMISSION_ID,
       verifiedContent: 'mockVerifiedContent',
+      attachmentDownloadUrls: {
+        'some-field-id': 'https://mock.s3.url/some/s3/url/timeout=3600',
+      },
       version: 1,
     },
   }

src/app/modules/webhook/webhook.errors.ts

@@ -12,6 +12,20 @@ export class WebhookValidationError extends ApplicationError {
   }
 }
 
+/**
+ * Webhook failed to generate S3 presigned URLs for attachments
+ */
+export class WebhookFailedWithPresignedUrlGenerationError extends ApplicationError {
+  meta: {
+    originalError: unknown
+  }
+
+  constructor(error: unknown, message = 'Presigned Url Generation failed') {
+    super(message)
+    this.meta = { originalError: error }
+  }
+}
+
 /**
  * Webhook returned non-200 status, but error is not instance of AxiosError
  */