From 58a61da1209109496b0785f4ebfc87a565b23289 Mon Sep 17 00:00:00 2001
From: Kar Rui Lau <karrui.lau@gmail.com>
Date: Thu, 3 Jun 2021 12:44:29 +0800
Subject: [PATCH 01/11] feat(AdminAuthService):  add checkIsEmailAllowed
 service function

---
 src/public/services/AdminAuthService.ts | 29 +++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 src/public/services/AdminAuthService.ts

diff --git a/src/public/services/AdminAuthService.ts b/src/public/services/AdminAuthService.ts
new file mode 100644
index 0000000000..aa9359f23a
--- /dev/null
+++ b/src/public/services/AdminAuthService.ts
@@ -0,0 +1,29 @@
+import axios from 'axios'
+import validator from 'validator'
+
+const ADMIN_AUTH_ENDPOINT = '/api/v3/auth'
+
+/**
+ * Check whether the given email string is from an email domain.
+ * @param email the email to check
+ * @returns original email if email is valid
+ * @throws Error on invalid email
+ * @throws Error on non 2xx response
+ */
+export const checkIsEmailAllowed = async (email = ''): Promise<string> => {
+  if (!validator.isEmail(email)) {
+    throw new Error('Please enter a valid email address')
+  }
+
+  return axios
+    .post(`${ADMIN_AUTH_ENDPOINT}/email/validate`, { email })
+    .then(() => email)
+    .catch((error) => {
+      if (axios.isAxiosError(error) && error.response?.data) {
+        throw new Error(error.response.data)
+      }
+      throw new Error(
+        'Something went wrong while validating your email. Please refresh and try again',
+      )
+    })
+}

From 78e1523de8bc7c63fb91b26ecf341cff86ceba7b Mon Sep 17 00:00:00 2001
From: Kar Rui Lau <karrui.lau@gmail.com>
Date: Thu, 3 Jun 2021 12:45:16 +0800
Subject: [PATCH 02/11] ref: condense vm.checkEmail and vm.checkUser into
 single vm.login fn

---
 .../authentication.client.controller.js       | 43 ++++++-------------
 .../authentication/signin.client.view.html    |  2 +-
 2 files changed, 13 insertions(+), 32 deletions(-)

diff --git a/src/public/modules/users/controllers/authentication.client.controller.js b/src/public/modules/users/controllers/authentication.client.controller.js
index 403c9b2861..5dcc7450cb 100755
--- a/src/public/modules/users/controllers/authentication.client.controller.js
+++ b/src/public/modules/users/controllers/authentication.client.controller.js
@@ -1,10 +1,12 @@
 'use strict'
 
 const HttpStatus = require('http-status-codes')
+const AdminAuthService = require('../../../services/AdminAuthService')
 
 angular
   .module('users')
   .controller('AuthenticationController', [
+    '$q',
     '$scope',
     '$state',
     '$timeout',
@@ -15,6 +17,7 @@ angular
   ])
 
 function AuthenticationController(
+  $q,
   $scope,
   $state,
   $timeout,
@@ -54,7 +57,7 @@ function AuthenticationController(
 
   vm.handleEmailKeyUp = function (e) {
     if (e.keyCode == 13) {
-      vm.isSubmitEmailDisabled === false && vm.checkEmail()
+      vm.isSubmitEmailDisabled === false && vm.login()
       // condition vm.isSubmitEmailDisabled == false is necessary to prevent retries using enter key
       // when submit button is disabled
     } else {
@@ -122,45 +125,23 @@ function AuthenticationController(
   // 4 - Verify OTP
 
   /**
-   * Conducts front-end check of user email format
+   * Checks validity of email domain (i.e. agency) and sends login OTP if email
+   * is valid.
    */
-  vm.checkEmail = function () {
+  vm.login = function () {
     vm.buttonClicked = true
-    if (/\S+@\S+\.\S+/.test(vm.credentials.email)) {
-      vm.credentials.email = vm.credentials.email.toLowerCase()
-      vm.checkUser()
-    } else {
-      // Invalid email
-      vm.buttonClicked = false
-      vm.signInMsg = {
-        isMsg: true,
-        isError: true,
-        msg: 'Please enter a valid email',
-      }
-      vm.isSubmitEmailDisabled = true
-    }
-  }
-
-  /**
-   * Checks validity of email domain (i.e. agency)
-   * Directs user to otp input page
-   */
-  vm.checkUser = function () {
-    Auth.checkUser(vm.credentials).then(
-      function () {
-        vm.sendOtp()
-      },
-      function (error) {
+    $q.when(AdminAuthService.checkIsEmailAllowed(vm.credentials.email))
+      .then(() => vm.sendOtp())
+      .catch((error) => {
         // Invalid agency
         vm.buttonClicked = false
         vm.signInMsg = {
           isMsg: true,
           isError: true,
-          msg: error,
+          msg: error.message,
         }
         vm.isSubmitEmailDisabled = true
-      },
-    )
+      })
   }
 
   /**
diff --git a/src/public/modules/users/views/authentication/signin.client.view.html b/src/public/modules/users/views/authentication/signin.client.view.html
index 48d6f7fb90..189d2e3c89 100755
--- a/src/public/modules/users/views/authentication/signin.client.view.html
+++ b/src/public/modules/users/views/authentication/signin.client.view.html
@@ -40,7 +40,7 @@
         <div class="btn-grp">
           <button
             class="btn-custom btn-medium"
-            ng-click="vm.checkEmail()"
+            ng-click="vm.login()"
             ng-disabled="vm.buttonClicked || vm.isSubmitEmailDisabled"
           >
             Get Started

From c6e001b32aa13733316f01d5f519034a9c423864 Mon Sep 17 00:00:00 2001
From: Kar Rui Lau <karrui.lau@gmail.com>
Date: Thu, 3 Jun 2021 12:53:05 +0800
Subject: [PATCH 03/11] feat(AdminAuthService): add sendLoginOtp function

---
 src/public/services/AdminAuthService.ts | 31 ++++++++++++++++++++++++-
 1 file changed, 30 insertions(+), 1 deletion(-)

diff --git a/src/public/services/AdminAuthService.ts b/src/public/services/AdminAuthService.ts
index aa9359f23a..310447ed7a 100644
--- a/src/public/services/AdminAuthService.ts
+++ b/src/public/services/AdminAuthService.ts
@@ -16,7 +16,9 @@ export const checkIsEmailAllowed = async (email = ''): Promise<string> => {
   }
 
   return axios
-    .post(`${ADMIN_AUTH_ENDPOINT}/email/validate`, { email })
+    .post(`${ADMIN_AUTH_ENDPOINT}/email/validate`, {
+      email: email.toLowerCase(),
+    })
     .then(() => email)
     .catch((error) => {
       if (axios.isAxiosError(error) && error.response?.data) {
@@ -27,3 +29,30 @@ export const checkIsEmailAllowed = async (email = ''): Promise<string> => {
       )
     })
 }
+
+/**
+ * Sends login OTP to given email
+ * @param email email to send login OTP to
+ * @returns success string if login OTP is sent successfully
+ * @throws Error on invalid email
+ * @throws Error on non 2xx response
+ */
+export const sendLoginOtp = async (email = ''): Promise<string> => {
+  if (!validator.isEmail(email)) {
+    throw new Error('Please enter a valid email address')
+  }
+
+  return axios
+    .post<string>(`${ADMIN_AUTH_ENDPOINT}/otp/generate`, {
+      email: email.toLowerCase(),
+    })
+    .then(({ data }) => data)
+    .catch((error) => {
+      if (axios.isAxiosError(error) && error.response?.data) {
+        throw new Error(error.response.data)
+      }
+      throw new Error(
+        'Failed to send login OTP. Please try again later and if the problem persists, contact us.',
+      )
+    })
+}

From 62a0f45344899356fafb1bb6a4af6672dbd34054 Mon Sep 17 00:00:00 2001
From: Kar Rui Lau <karrui.lau@gmail.com>
Date: Thu, 3 Jun 2021 12:53:55 +0800
Subject: [PATCH 04/11] ref: use AdminAuthService.sendLoginOtp

---
 .../authentication.client.controller.js        | 18 +++++++-----------
 1 file changed, 7 insertions(+), 11 deletions(-)

diff --git a/src/public/modules/users/controllers/authentication.client.controller.js b/src/public/modules/users/controllers/authentication.client.controller.js
index 5dcc7450cb..b25d5124b0 100755
--- a/src/public/modules/users/controllers/authentication.client.controller.js
+++ b/src/public/modules/users/controllers/authentication.client.controller.js
@@ -154,9 +154,9 @@ function AuthenticationController(
     vm.isOtpSending = true
     vm.buttonClicked = true
     vm.showOtpDelayNotification = false
-    const { email } = vm.credentials
-    Auth.sendOtp({ email }).then(
-      function (success) {
+
+    $q.when(AdminAuthService.sendLoginOtp(vm.credentials.email))
+      .then((success) => {
         vm.isOtpSending = false
         vm.buttonClicked = false
         // Configure message to be show
@@ -176,21 +176,17 @@ function AuthenticationController(
           vm.signInMsg.isMsg = false
           vm.showOtpDelayNotification = true
         }, 20000)
-      },
-      function (error) {
+      })
+      .catch((error) => {
         vm.isOtpSending = false
         vm.buttonClicked = false
         // Configure message to be shown
-        const msg =
-          (error && error.data && error.data.message) ||
-          'Failed to send login OTP. Please try again later and if the problem persists, contact us.'
         vm.signInMsg = {
           isMsg: true,
           isError: true,
-          msg,
+          msg: error.message,
         }
-      },
-    )
+      })
   }
 
   /**

From a191533135d1606878406d000f9a2f8c1beb5964 Mon Sep 17 00:00:00 2001
From: Kar Rui Lau <karrui.lau@gmail.com>
Date: Mon, 7 Jun 2021 13:19:52 +0800
Subject: [PATCH 05/11] ref: rename AdminAuthService to AuthService

better fit API prefix
---
 .../users/controllers/authentication.client.controller.js   | 6 +++---
 src/public/services/{AdminAuthService.ts => AuthService.ts} | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)
 rename src/public/services/{AdminAuthService.ts => AuthService.ts} (90%)

diff --git a/src/public/modules/users/controllers/authentication.client.controller.js b/src/public/modules/users/controllers/authentication.client.controller.js
index b25d5124b0..928ad9df50 100755
--- a/src/public/modules/users/controllers/authentication.client.controller.js
+++ b/src/public/modules/users/controllers/authentication.client.controller.js
@@ -1,7 +1,7 @@
 'use strict'
 
 const HttpStatus = require('http-status-codes')
-const AdminAuthService = require('../../../services/AdminAuthService')
+const AuthService = require('../../../services/AuthService')
 
 angular
   .module('users')
@@ -130,7 +130,7 @@ function AuthenticationController(
    */
   vm.login = function () {
     vm.buttonClicked = true
-    $q.when(AdminAuthService.checkIsEmailAllowed(vm.credentials.email))
+    $q.when(AuthService.checkIsEmailAllowed(vm.credentials.email))
       .then(() => vm.sendOtp())
       .catch((error) => {
         // Invalid agency
@@ -155,7 +155,7 @@ function AuthenticationController(
     vm.buttonClicked = true
     vm.showOtpDelayNotification = false
 
-    $q.when(AdminAuthService.sendLoginOtp(vm.credentials.email))
+    $q.when(AuthService.sendLoginOtp(vm.credentials.email))
       .then((success) => {
         vm.isOtpSending = false
         vm.buttonClicked = false
diff --git a/src/public/services/AdminAuthService.ts b/src/public/services/AuthService.ts
similarity index 90%
rename from src/public/services/AdminAuthService.ts
rename to src/public/services/AuthService.ts
index 310447ed7a..9fda7ec3d6 100644
--- a/src/public/services/AdminAuthService.ts
+++ b/src/public/services/AuthService.ts
@@ -1,7 +1,7 @@
 import axios from 'axios'
 import validator from 'validator'
 
-const ADMIN_AUTH_ENDPOINT = '/api/v3/auth'
+const AUTH_ENDPOINT = '/api/v3/auth'
 
 /**
  * Check whether the given email string is from an email domain.
@@ -16,7 +16,7 @@ export const checkIsEmailAllowed = async (email = ''): Promise<string> => {
   }
 
   return axios
-    .post(`${ADMIN_AUTH_ENDPOINT}/email/validate`, {
+    .post(`${AUTH_ENDPOINT}/email/validate`, {
       email: email.toLowerCase(),
     })
     .then(() => email)
@@ -43,7 +43,7 @@ export const sendLoginOtp = async (email = ''): Promise<string> => {
   }
 
   return axios
-    .post<string>(`${ADMIN_AUTH_ENDPOINT}/otp/generate`, {
+    .post<string>(`${AUTH_ENDPOINT}/otp/generate`, {
       email: email.toLowerCase(),
     })
     .then(({ data }) => data)

From 6938d5ebfe636bedb33babcbbfe52df734401ded Mon Sep 17 00:00:00 2001
From: Kar Rui Lau <karrui.lau@gmail.com>
Date: Mon, 7 Jun 2021 13:39:49 +0800
Subject: [PATCH 06/11] feat: remove all catch transformations from AuthService

not needed, may interfere with React migration. Should just handle it in the caller

# Conflicts:
#	src/public/modules/users/controllers/authentication.client.controller.js
#	src/public/services/AuthService.ts
---
 .../authentication.client.controller.js       | 40 ++++++++++++++-----
 src/public/services/AuthService.ts            | 36 +++--------------
 2 files changed, 37 insertions(+), 39 deletions(-)

diff --git a/src/public/modules/users/controllers/authentication.client.controller.js b/src/public/modules/users/controllers/authentication.client.controller.js
index 928ad9df50..aa24fb50fb 100755
--- a/src/public/modules/users/controllers/authentication.client.controller.js
+++ b/src/public/modules/users/controllers/authentication.client.controller.js
@@ -1,6 +1,8 @@
 'use strict'
 
 const HttpStatus = require('http-status-codes')
+const get = require('lodash/get')
+const validator = require('validator').default
 const AuthService = require('../../../services/AuthService')
 
 angular
@@ -118,6 +120,16 @@ function AuthenticationController(
     }
   }
 
+  const setEmailSignInError = (errorMsg) => {
+    vm.buttonClicked = false
+    vm.signInMsg = {
+      isMsg: true,
+      isError: true,
+      msg: errorMsg,
+    }
+    vm.isSubmitEmailDisabled = true
+  }
+
   // Steps of sign-in process
   // 1 - Check if user email is in valid format
   // 2 - Check if user's email domain (i.e. agency) is valid
@@ -130,17 +142,22 @@ function AuthenticationController(
    */
   vm.login = function () {
     vm.buttonClicked = true
+
+    const email = vm.credentials.email
+    if (!validator.isEmail(email)) {
+      setEmailSignInError('Please enter a valid email address')
+      return
+    }
+
     $q.when(AuthService.checkIsEmailAllowed(vm.credentials.email))
       .then(() => vm.sendOtp())
       .catch((error) => {
-        // Invalid agency
-        vm.buttonClicked = false
-        vm.signInMsg = {
-          isMsg: true,
-          isError: true,
-          msg: error.message,
-        }
-        vm.isSubmitEmailDisabled = true
+        const errorMsg = get(
+          error,
+          'response.data',
+          'Something went wrong while validating your email. Please refresh and try again',
+        )
+        setEmailSignInError(errorMsg)
       })
   }
 
@@ -178,13 +195,18 @@ function AuthenticationController(
         }, 20000)
       })
       .catch((error) => {
+        const errorMsg = get(
+          error,
+          'response.data',
+          'Failed to send login OTP. Please try again later and if the problem persists, contact us.',
+        )
         vm.isOtpSending = false
         vm.buttonClicked = false
         // Configure message to be shown
         vm.signInMsg = {
           isMsg: true,
           isError: true,
-          msg: error.message,
+          msg: errorMsg,
         }
       })
   }
diff --git a/src/public/services/AuthService.ts b/src/public/services/AuthService.ts
index 9fda7ec3d6..46a0c49569 100644
--- a/src/public/services/AuthService.ts
+++ b/src/public/services/AuthService.ts
@@ -1,33 +1,21 @@
 import axios from 'axios'
-import validator from 'validator'
+import { Opaque } from 'type-fest'
 
 const AUTH_ENDPOINT = '/api/v3/auth'
 
+type Email = Opaque<string, 'Email'>
+
 /**
  * Check whether the given email string is from an email domain.
  * @param email the email to check
  * @returns original email if email is valid
- * @throws Error on invalid email
- * @throws Error on non 2xx response
  */
-export const checkIsEmailAllowed = async (email = ''): Promise<string> => {
-  if (!validator.isEmail(email)) {
-    throw new Error('Please enter a valid email address')
-  }
-
+export const checkIsEmailAllowed = async (email: string): Promise<Email> => {
   return axios
     .post(`${AUTH_ENDPOINT}/email/validate`, {
       email: email.toLowerCase(),
     })
-    .then(() => email)
-    .catch((error) => {
-      if (axios.isAxiosError(error) && error.response?.data) {
-        throw new Error(error.response.data)
-      }
-      throw new Error(
-        'Something went wrong while validating your email. Please refresh and try again',
-      )
-    })
+    .then(() => email as Email)
 }
 
 /**
@@ -37,22 +25,10 @@ export const checkIsEmailAllowed = async (email = ''): Promise<string> => {
  * @throws Error on invalid email
  * @throws Error on non 2xx response
  */
-export const sendLoginOtp = async (email = ''): Promise<string> => {
-  if (!validator.isEmail(email)) {
-    throw new Error('Please enter a valid email address')
-  }
-
+export const sendLoginOtp = async (email: Email): Promise<string> => {
   return axios
     .post<string>(`${AUTH_ENDPOINT}/otp/generate`, {
       email: email.toLowerCase(),
     })
     .then(({ data }) => data)
-    .catch((error) => {
-      if (axios.isAxiosError(error) && error.response?.data) {
-        throw new Error(error.response.data)
-      }
-      throw new Error(
-        'Failed to send login OTP. Please try again later and if the problem persists, contact us.',
-      )
-    })
 }

From 0c53ae47e0beea3e956b6328d295ce63ad127f0d Mon Sep 17 00:00:00 2001
From: Kar Rui Lau <karrui.lau@gmail.com>
Date: Mon, 7 Jun 2021 14:05:48 +0800
Subject: [PATCH 07/11] test(AuthService): unit tests for checkIsEmailAllowed +
 sendLoginOtp

---
 src/public/services/AuthService.ts            |  3 +-
 .../services/__tests__/AuthService.test.ts    | 60 +++++++++++++++++++
 2 files changed, 62 insertions(+), 1 deletion(-)
 create mode 100644 src/public/services/__tests__/AuthService.test.ts

diff --git a/src/public/services/AuthService.ts b/src/public/services/AuthService.ts
index 46a0c49569..ad07dfcb35 100644
--- a/src/public/services/AuthService.ts
+++ b/src/public/services/AuthService.ts
@@ -1,7 +1,8 @@
 import axios from 'axios'
 import { Opaque } from 'type-fest'
 
-const AUTH_ENDPOINT = '/api/v3/auth'
+// Exported for testing.
+export const AUTH_ENDPOINT = '/api/v3/auth'
 
 type Email = Opaque<string, 'Email'>
 
diff --git a/src/public/services/__tests__/AuthService.test.ts b/src/public/services/__tests__/AuthService.test.ts
new file mode 100644
index 0000000000..7ce4b2053e
--- /dev/null
+++ b/src/public/services/__tests__/AuthService.test.ts
@@ -0,0 +1,60 @@
+import axios from 'axios'
+import { mocked } from 'ts-jest/utils'
+import { Opaque } from 'type-fest'
+
+import {
+  AUTH_ENDPOINT,
+  checkIsEmailAllowed,
+  sendLoginOtp,
+} from '../AuthService'
+
+jest.mock('axios')
+
+const MockAxios = mocked(axios, true)
+
+// Duplicated here instead of exporting from AuthService to prevent production
+// code from casting to Email type without going through a type guard/validator.
+type TestEmail = Opaque<string, 'Email'>
+
+describe('AuthService', () => {
+  describe('checkIsEmailAllowed', () => {
+    const EXPECTED_POST_ENDPOINT = `${AUTH_ENDPOINT}/email/validate`
+
+    it('should return given email argument when email is allowed', async () => {
+      // Arrange
+      const mockEmail = 'this.should.RETURN@example.com'
+      MockAxios.post.mockResolvedValueOnce({ status: 200 })
+
+      // Act
+      const actual = await checkIsEmailAllowed(mockEmail)
+
+      // Assert
+      expect(actual).toEqual(mockEmail)
+      expect(MockAxios.post).toHaveBeenCalledWith(EXPECTED_POST_ENDPOINT, {
+        email: mockEmail.toLowerCase(),
+      })
+    })
+  })
+
+  describe('sendLoginOtp', () => {
+    const EXPECTED_POST_ENDPOINT = `${AUTH_ENDPOINT}/otp/generate`
+
+    it('should return success string when OTP is successfully generated', async () => {
+      // Arrange
+      const mockEmail = 'otp-email@example.com'
+      const mockSuccessStr = 'yippee ki yay'
+      MockAxios.post.mockResolvedValueOnce({
+        data: mockSuccessStr,
+      })
+
+      // Act
+      const actual = await sendLoginOtp(mockEmail as TestEmail)
+
+      // Assert
+      expect(actual).toEqual(mockSuccessStr)
+      expect(MockAxios.post).toHaveBeenCalledWith(EXPECTED_POST_ENDPOINT, {
+        email: mockEmail.toLowerCase(),
+      })
+    })
+  })
+})

From 675960b65da81205c982221f8da7e08f97593cf2 Mon Sep 17 00:00:00 2001
From: Kar Rui Lau <karrui.lau@gmail.com>
Date: Mon, 7 Jun 2021 14:20:05 +0800
Subject: [PATCH 08/11] feat: remove unused functions from old auth.client

---
 .../users/services/auth.client.service.js     | 29 -------------------
 1 file changed, 29 deletions(-)

diff --git a/src/public/modules/users/services/auth.client.service.js b/src/public/modules/users/services/auth.client.service.js
index 2ca5083b7d..a5bf7f719e 100644
--- a/src/public/modules/users/services/auth.client.service.js
+++ b/src/public/modules/users/services/auth.client.service.js
@@ -21,8 +21,6 @@ function Auth($q, $http, $state, $window) {
    */
 
   let authService = {
-    checkUser,
-    sendOtp,
     verifyOtp,
     getUser,
     setUser,
@@ -66,33 +64,6 @@ function Auth($q, $http, $state, $window) {
         return null
       })
   }
-
-  function checkUser(credentials) {
-    let deferred = $q.defer()
-    $http.post('/api/v3/auth/email/validate', credentials).then(
-      function (response) {
-        deferred.resolve(response.data)
-      },
-      function (error) {
-        deferred.reject(error.data)
-      },
-    )
-    return deferred.promise
-  }
-
-  function sendOtp(credentials) {
-    let deferred = $q.defer()
-    $http.post('/api/v3/auth/otp/generate', credentials).then(
-      function (response) {
-        deferred.resolve(response.data)
-      },
-      function (error) {
-        deferred.reject(error)
-      },
-    )
-    return deferred.promise
-  }
-
   function verifyOtp(credentials) {
     let deferred = $q.defer()
     $http.post('/api/v3/auth/otp/verify', credentials).then(

From f429926b808dc70d4b280c9441121fd824e3a871 Mon Sep 17 00:00:00 2001
From: Kar Rui Lau <karrui.lau@gmail.com>
Date: Wed, 9 Jun 2021 10:49:51 +0800
Subject: [PATCH 09/11] fix(auth.client.ctl): correctly retrieve error msg when
 sendOtp fails

---
 .../users/controllers/authentication.client.controller.js       | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/public/modules/users/controllers/authentication.client.controller.js b/src/public/modules/users/controllers/authentication.client.controller.js
index aa24fb50fb..4ac92def2b 100755
--- a/src/public/modules/users/controllers/authentication.client.controller.js
+++ b/src/public/modules/users/controllers/authentication.client.controller.js
@@ -197,7 +197,7 @@ function AuthenticationController(
       .catch((error) => {
         const errorMsg = get(
           error,
-          'response.data',
+          'response.data.message',
           'Failed to send login OTP. Please try again later and if the problem persists, contact us.',
         )
         vm.isOtpSending = false

From 6db9252c45c08360072610c919974ff9c4ac07ba Mon Sep 17 00:00:00 2001
From: Kar Rui Lau <karrui.lau@gmail.com>
Date: Wed, 9 Jun 2021 10:59:12 +0800
Subject: [PATCH 10/11] test(AuthService): add clarity to test block

Co-authored-by: tshuli <63710093+tshuli@users.noreply.github.com>
---
 src/public/services/AuthService.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/public/services/AuthService.ts b/src/public/services/AuthService.ts
index ad07dfcb35..32edb8325e 100644
--- a/src/public/services/AuthService.ts
+++ b/src/public/services/AuthService.ts
@@ -7,7 +7,7 @@ export const AUTH_ENDPOINT = '/api/v3/auth'
 type Email = Opaque<string, 'Email'>
 
 /**
- * Check whether the given email string is from an email domain.
+ * Check whether the given email string is from a whitelisted email domain.
  * @param email the email to check
  * @returns original email if email is valid
  */

From 3a2c1c49ba7ddea3340d7349f776f7188b7b725e Mon Sep 17 00:00:00 2001
From: Kar Rui Lau <karrui.lau@gmail.com>
Date: Wed, 9 Jun 2021 11:06:14 +0800
Subject: [PATCH 11/11] feat(AuthService): remove throw documentation on
 sendLoginOtp

---
 src/public/services/AuthService.ts | 2 --
 1 file changed, 2 deletions(-)

diff --git a/src/public/services/AuthService.ts b/src/public/services/AuthService.ts
index 32edb8325e..c08e1c5ccf 100644
--- a/src/public/services/AuthService.ts
+++ b/src/public/services/AuthService.ts
@@ -23,8 +23,6 @@ export const checkIsEmailAllowed = async (email: string): Promise<Email> => {
  * Sends login OTP to given email
  * @param email email to send login OTP to
  * @returns success string if login OTP is sent successfully
- * @throws Error on invalid email
- * @throws Error on non 2xx response
  */
 export const sendLoginOtp = async (email: Email): Promise<string> => {
   return axios