refactor(webhook-services): migrate webhook services to neverthrow

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

@@ -31,7 +31,7 @@ import { IPopulatedUser, IUserSchema } from '../../types/user'
 import { MB } from '../constants/filesize'
 import { OverrideProps } from '../modules/form/admin-form/admin-form.types'
 import { transformEmails } from '../modules/form/form.utils'
-import { validateWebhookUrl } from '../modules/webhook/webhook.utils'
+import { validateWebhookUrl } from '../modules/webhook/webhook.validation'
 
 import getAgencyModel from './agency.server.model'
 import {

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

@@ -11,6 +11,7 @@ import {
   IEncryptSubmissionModel,
   ISubmissionModel,
   ISubmissionSchema,
+  IWebhookResponse,
   IWebhookResponseSchema,
   MyInfoAttribute,
   SubmissionCursorData,
@@ -185,6 +186,18 @@ EncryptSubmissionSchema.methods.getWebhookView = function (
   }
 }
 
+EncryptSubmissionSchema.statics.addWebhookResponse = function (
+  this: IEncryptSubmissionModel,
+  submissionId: string,
+  webhookResponse: IWebhookResponse,
+): Promise<IEncryptedSubmissionSchema | null> {
+  return this.findOneAndUpdate(
+    { _id: submissionId },
+    { $push: { webhookResponses: webhookResponse } },
+    { new: true, setDefaultsOnInsert: true, runValidators: true },
+  ).exec()
+}
+
 EncryptSubmissionSchema.statics.findSingleMetadata = function (
   this: IEncryptSubmissionModel,
   formId: string,

src/app/modules/myinfo/myinfo.util.ts

@@ -16,6 +16,7 @@ import {
   IPopulatedForm,
   MapRouteError,
 } from '../../../types'
+import { hasProp } from '../../utils/has-prop'
 import { DatabaseError, MissingFeatureError } from '../core/core.errors'
 import { FormNotFoundError } from '../form/form.errors'
 import {
@@ -303,20 +304,6 @@ export const validateMyInfoForm = (
   return ok(form as IMyInfoForm)
 }
 
-/**
- * Utility to narrow type of an object by determining whether
- * it contains the given property.
- * @param obj Object
- * @param prop Property to check
- */
-export const hasProp = <K extends string>(
-  // eslint-disable-next-line @typescript-eslint/ban-types
-  obj: object | Record<string, unknown>,
-  prop: K,
-): obj is Record<K, unknown> => {
-  return prop in obj
-}
-
 /**
  * Type guard for MyInfo cookie.
  * @param cookie Unknown object

src/app/modules/submission/encrypt-submission/encrypt-submission.controller.ts

@@ -29,7 +29,7 @@ import { mapVerifyMyInfoError } from '../../myinfo/myinfo.util'
 import { SpcpFactory } from '../../spcp/spcp.factory'
 import { getPopulatedUserById } from '../../user/user.service'
 import { VerifiedContentFactory } from '../../verified-content/verified-content.factory'
-import { pushData as webhookPushData } from '../../webhook/webhook.service'
+import { WebhookFactory } from '../../webhook/webhook.factory'
 import {
   getProcessedResponses,
   sendEmailConfirmations,
@@ -360,12 +360,16 @@ export const handleEncryptedSubmission: RequestHandler = async (req, res) => {
   })
 
   // Fire webhooks if available
+  // Note that we push data to webhook endpoints on a best effort basis
+  // As such, we should not await on these post requests
   const webhookUrl = form.webhook?.url
-  const submissionWebhookView = submission.getWebhookView()
   if (webhookUrl) {
-    // Note that we push data to webhook endpoints on a best effort basis
-    // As such, we should not await on these post requests
-    void webhookPushData(webhookUrl, submissionWebhookView)
+    void WebhookFactory.sendWebhook(
+      submission,
+      webhookUrl,
+    ).andThen((response) =>
+      WebhookFactory.saveWebhookRecord(submission._id, response),
+    )
   }
 
   // Send Email Confirmations