@defra/forms-engine-plugin 4.0.61 → 4.1.0

package/src/server/plugins/payment/service.js

@@ -40,7 +40,7 @@ export class PaymentService {
    * @param {string} returnUrl
    * @param {string} reference
    * @param {boolean} isLivePayment
-   * @param {{ formId: string, slug: string }} metadata
+   * @param {{ formId: string, slug: string } | undefined } metadata
    */
   async createPayment(
     amount,
@@ -50,30 +50,42 @@ export class PaymentService {
     isLivePayment,
     metadata
   ) {
-    const response = await this.postToPayProvider({
-      amount,
-      description,
-      reference,
-      metadata,
-      return_url: returnUrl,
-      delayed_capture: true
-    })
-
-    logger.info(
-      buildPaymentInfo(
-        'create-payment',
-        'success',
-        `amount=${convertPenceToPounds(amount)}`,
-        isLivePayment,
-        response.payment_id
-      ),
-      `[payment] Created payment and user taken to enter pre-auth details for paymentId=${response.payment_id}`
-    )
-
-    return {
-      paymentId: response.payment_id,
-      paymentUrl: response._links.next_url.href
+    try {
+      const response = await this.postToPayProvider({
+        amount,
+        description,
+        reference,
+        metadata,
+        return_url: returnUrl,
+        delayed_capture: true
+      })
+
+      logger.info(
+        buildPaymentInfo(
+          'create-payment',
+          'success',
+          `amount=${convertPenceToPounds(amount)}`,
+          isLivePayment,
+          response.payment_id
+        ),
+        `[payment] Created payment and user taken to enter pre-auth details for paymentId=${response.payment_id}`
+      )
+
+      return {
+        paymentId: response.payment_id,
+        paymentUrl: response._links.next_url.href
+      }
+    } catch (err) {
+      const error =
+        /** @type {{ output?: { payload?: any }, message?: any }} */ (err)
+      if (isLivePayment) {
+        logger.error(
+          error.output?.payload ?? error.message,
+          `[payment] Failed to create payment session for reference ${reference}`
+        )
+      }
     }
+    return undefined
   }
 
   /**
@@ -207,10 +219,12 @@ export class PaymentService {
       return response.payload
     } catch (err) {
       const error = /** @type {Error} */ (err)
-      logger.error(
-        error,
-        `[payment] Error creating payment for reference=${payload.reference}: ${error.message}`
-      )
+      if (!error.message.includes('401 Unauthorized')) {
+        logger.error(
+          error,
+          `[payment] Error creating payment for reference=${payload.reference}: ${error.message}`
+        )
+      }
       throw err
     }
   }

package/src/server/plugins/payment/service.test.js

@@ -44,11 +44,11 @@ describe('payment service', () => {
         false,
         metadata
       )
-      expect(payment.paymentId).toBe('payment-id-12345')
-      expect(payment.paymentUrl).toBe('http://next-url-href/payment')
+      expect(payment?.paymentId).toBe('payment-id-12345')
+      expect(payment?.paymentUrl).toBe('http://next-url-href/payment')
     })
 
-    it('should throw if fails to create a payment - failed API call', async () => {
+    it('should return undefined if fails to create a payment - failed API call', async () => {
       jest
         .mocked(postJson)
         .mockRejectedValueOnce(new Error('internal creation error'))
@@ -56,19 +56,18 @@ describe('payment service', () => {
       const referenceNumber = 'ABC-DEF-123'
       const returnUrl = 'http://localhost:3009/payment-callback-handler'
       const metadata = { formId: 'form-id', slug: 'my-form-slug' }
-      await expect(() =>
-        service.createPayment(
-          100,
-          'Payment description',
-          returnUrl,
-          referenceNumber,
-          false,
-          metadata
-        )
-      ).rejects.toThrow('internal creation error')
+      const res = await service.createPayment(
+        100,
+        'Payment description',
+        returnUrl,
+        referenceNumber,
+        false,
+        metadata
+      )
+      expect(res).toBeUndefined()
     })
 
-    it('should throw if fails to create a payment - bad result from API call', async () => {
+    it('should return undefined if fails to create a payment - bad result from API call', async () => {
       const createPaymentResult = {
         state: {
           status: 'failed'
@@ -86,16 +85,15 @@ describe('payment service', () => {
       const referenceNumber = 'ABC-DEF-123'
       const returnUrl = 'http://localhost:3009/payment-callback-handler'
       const metadata = { formId: 'form-id', slug: 'my-form-slug' }
-      await expect(() =>
-        service.createPayment(
-          100,
-          'Payment description',
-          returnUrl,
-          referenceNumber,
-          false,
-          metadata
-        )
-      ).rejects.toThrow('Failed to create payment')
+      const res = await service.createPayment(
+        100,
+        'Payment description',
+        returnUrl,
+        referenceNumber,
+        false,
+        metadata
+      )
+      expect(res).toBeUndefined()
     })
   })
 

package/src/server/types.ts

@@ -29,6 +29,7 @@ export interface FormsService {
     id: string,
     state: FormStatus
   ) => Promise<FormDefinition | undefined>
+  getFormSecret: (formId: string, secretName: string) => Promise<string>
 }
 
 export interface FormSubmissionService {

package/src/server/utils/file-form-service.js

@@ -160,6 +160,17 @@ export class FileFormService {
        */
       getFormDefinition: (id) => {
         return Promise.resolve(this.getFormDefinition(id))
+      },
+
+      /**
+       * Get a form secret
+       * @param {string} _formId
+       * @param {string} _secretName
+       * @returns {Promise<string>}
+       */
+      getFormSecret: (_formId, _secretName) => {
+        // For local env only
+        return Promise.resolve(process.env.PAYMENT_PROVIDER_API_KEY_TEST ?? '')
       }
     }
   }

package/src/server/utils/file-form-service.test.js

@@ -101,6 +101,19 @@ describe('File-form-service', () => {
       )
       expect(res3?.name).toBe('All components')
       expect(res3?.startPage).toBe('/all-components')
+
+      const res4 = await interfaceImpl.getFormSecret(
+        '95e92559-968d-44ae-8666-2b1ad3dffd31',
+        'my-secret-name'
+      )
+      expect(res4).toBe('test-api-key')
+
+      delete process.env.PAYMENT_PROVIDER_API_KEY_TEST
+      const res5 = await interfaceImpl.getFormSecret(
+        '95e92559-968d-44ae-8666-2b1ad3dffd31',
+        'my-secret-name'
+      )
+      expect(res5).toBe('')
     })
   })
 

package/src/typings/hapi/index.d.ts

@@ -39,6 +39,7 @@ declare module '@hapi/hapi' {
       ) => Record<string, unknown> | Promise<Record<string, unknown>>
       saveAndExit?: PluginOptions['saveAndExit']
       baseUrl: string
+      services: PluginOptions['services']
     }
   }