refactor: convert frontend MyInfo services to TypeScript

src/public/main.js

@@ -265,8 +265,6 @@ require('./modules/forms/services/form-error.client.factory.js')
 require('./modules/forms/services/spcp-session.client.factory.js')
 require('./modules/forms/services/spcp-redirect.client.factory.js')
 require('./modules/forms/services/spcp-validate-esrvcid.client.factory.js')
-require('./modules/forms/services/myinfo-redirect.client.factory.js')
-require('./modules/forms/services/myinfo-validate-esrvcid.client.factory.js')
 require('./modules/forms/services/submissions.client.factory.js')
 require('./modules/forms/services/toastr.client.factory.js')
 require('./modules/forms/services/attachment.client.service.js')

src/public/modules/forms/admin/controllers/activate-form-modal.client.controller.js

@@ -1,12 +1,13 @@
 const dedent = require('dedent-js')
+const MyInfoService = require('../../../../services/MyInfoService')
 
 angular
   .module('forms')
   .controller('ActivateFormController', [
     '$uibModalInstance',
     '$timeout',
+    '$q',
     'SpcpValidateEsrvcId',
-    'MyInfoValidateEsrvcId',
     'externalScope',
     'MailTo',
     ActivateFormController,
@@ -15,8 +16,8 @@ angular
 function ActivateFormController(
   $uibModalInstance,
   $timeout,
+  $q,
   SpcpValidateEsrvcId,
-  MyInfoValidateEsrvcId,
   externalScope,
   MailTo,
 ) {
@@ -119,7 +120,8 @@ function ActivateFormController(
       updateDisplay(null, { authType, esrvcId }, 0)
       return Promise.resolve(true)
     } else if (authType === 'MyInfo') {
-      return MyInfoValidateEsrvcId(target)
+      return $q
+        .when(MyInfoService.validateESrvcId(target))
         .then((response) => {
           if (response.isValid) {
             updateDisplay(null, { authType, esrvcId })

src/public/modules/forms/base/directives/submit-form.directive.js

@@ -1,6 +1,6 @@
 'use strict'
 const { cloneDeep } = require('lodash')
-
+const MyInfoService = require('../../../../services/MyInfoService')
 const {
   getVisibleFieldIds,
   getLogicUnitPreventingSubmit,
@@ -24,7 +24,7 @@ angular
   .module('forms')
   .directive('submitFormDirective', [
     '$window',
-    'FormFields',
+    '$q',
     'GTag',
     'SpcpRedirect',
     'SpcpSession',
@@ -35,13 +35,12 @@ angular
     '$uibModal',
     '$timeout',
     'Verification',
-    'MyInfoRedirect',
     submitFormDirective,
   ])
 
 function submitFormDirective(
   $window,
-  FormFields,
+  $q,
   GTag,
   SpcpRedirect,
   SpcpSession,
@@ -52,7 +51,6 @@ function submitFormDirective(
   $uibModal,
   $timeout,
   Verification,
-  MyInfoRedirect,
 ) {
   return {
     restrict: 'E',
@@ -94,9 +92,8 @@ function submitFormDirective(
 
       scope.formLogin = function (authType, rememberMe) {
         if (authType === 'MyInfo') {
-          return MyInfoRedirect({
-            formId: scope.form._id,
-          })
+          return $q
+            .when(MyInfoService.createRedirectURL(scope.form._id))
             .then((response) => {
               setReferrerToNull()
               $window.location.href = response.redirectURL

src/public/services/MyInfoService.ts

@@ -0,0 +1,31 @@
+import axios from 'axios'
+
+type RedirectURLResult = { redirectURL: string }
+
+// Exported for testing
+export const REDIRECT_URL_ENDPOINT = '/myinfo/redirect'
+export const VALIDATE_ESRVCID_ENDPOINT = '/myinfo/validate'
+
+export const createRedirectURL = (
+  formId: string,
+): Promise<RedirectURLResult> => {
+  return axios
+    .get<RedirectURLResult>(REDIRECT_URL_ENDPOINT, {
+      params: { formId },
+    })
+    .then(({ data }) => data)
+}
+
+type LoginPageValidationResult =
+  | { isValid: true }
+  | { isValid: false; errorCode: string | null }
+
+export const validateESrvcId = (
+  formId: string,
+): Promise<LoginPageValidationResult> => {
+  return axios
+    .get<LoginPageValidationResult>(VALIDATE_ESRVCID_ENDPOINT, {
+      params: { formId },
+    })
+    .then(({ data }) => data)
+}

src/public/services/__tests__/MyInfoService.test.ts

@@ -0,0 +1,93 @@
+import axios from 'axios'
+import { ObjectId } from 'bson'
+import { mocked } from 'ts-jest/utils'
+
+import * as MyInfoService from '../MyInfoService'
+
+jest.mock('axios')
+const MockAxios = mocked(axios, true)
+
+const MOCK_REDIRECT_URL = 'redirectURL'
+const MOCK_FORM_ID = new ObjectId().toHexString()
+
+describe('MyInfoService', () => {
+  afterEach(() => jest.resetAllMocks())
+  describe('createRedirectURL', () => {
+    it('should return the redirect URL when retrieval succeeds', async () => {
+      const mockData = { redirectURL: MOCK_REDIRECT_URL }
+      MockAxios.get.mockResolvedValueOnce({ data: mockData })
+
+      const result = await MyInfoService.createRedirectURL(MOCK_FORM_ID)
+
+      expect(MockAxios.get).toHaveBeenCalledWith(
+        MyInfoService.REDIRECT_URL_ENDPOINT,
+        {
+          params: { formId: MOCK_FORM_ID },
+        },
+      )
+      expect(result).toEqual(mockData)
+    })
+
+    it('should reject with error when API call fails', async () => {
+      const error = new Error('rejected')
+      MockAxios.get.mockRejectedValueOnce(error)
+
+      const rejectFunction = () => MyInfoService.createRedirectURL(MOCK_FORM_ID)
+
+      await expect(rejectFunction).rejects.toThrowError(error)
+      expect(MockAxios.get).toHaveBeenCalledWith(
+        MyInfoService.REDIRECT_URL_ENDPOINT,
+        {
+          params: { formId: MOCK_FORM_ID },
+        },
+      )
+    })
+  })
+
+  describe('validateESrvcId', () => {
+    it('should return isValid as true when the e-service ID is valid', async () => {
+      const mockData = { isValid: true }
+      MockAxios.get.mockResolvedValueOnce({ data: mockData })
+
+      const result = await MyInfoService.validateESrvcId(MOCK_FORM_ID)
+
+      expect(MockAxios.get).toHaveBeenCalledWith(
+        MyInfoService.VALIDATE_ESRVCID_ENDPOINT,
+        {
+          params: { formId: MOCK_FORM_ID },
+        },
+      )
+      expect(result).toEqual(mockData)
+    })
+
+    it('should return isValid as false and an errorcode when the e-service ID is invalid', async () => {
+      const mockData = { isValid: false, errorCode: '123' }
+      MockAxios.get.mockResolvedValueOnce({ data: mockData })
+
+      const result = await MyInfoService.validateESrvcId(MOCK_FORM_ID)
+
+      expect(MockAxios.get).toHaveBeenCalledWith(
+        MyInfoService.VALIDATE_ESRVCID_ENDPOINT,
+        {
+          params: { formId: MOCK_FORM_ID },
+        },
+      )
+      expect(result).toEqual(mockData)
+    })
+
+    it('should reject with error when API call fails', async () => {
+      const error = new Error('rejected')
+      MockAxios.get.mockRejectedValueOnce(error)
+
+      const rejectFunction = () => MyInfoService.validateESrvcId(MOCK_FORM_ID)
+
+      await expect(rejectFunction).rejects.toThrowError(error)
+      expect(MockAxios.get).toHaveBeenCalledWith(
+        MyInfoService.VALIDATE_ESRVCID_ENDPOINT,
+        {
+          params: { formId: MOCK_FORM_ID },
+        },
+      )
+    })
+  })
+})