Implemented: support for single logout

src/App.vue

@@ -41,13 +41,16 @@ export default defineComponent({
     }
   },
   methods: {
-    async presentLoader() {
+    async presentLoader(options = { message: '', backdropDismiss: true }) {
+      // When having a custom message remove already existing loader
+      if(options.message && this.loader) this.dismissLoader();
+
       if (!this.loader) {
         this.loader = await loadingController
           .create({
-            message: this.$t("Click the backdrop to dismiss."),
+            message: options.message ? this.$t(options.message) : this.$t("Click the backdrop to dismiss."),
             translucent: true,
-            backdropDismiss: true
+            backdropDismiss: options.backdropDismiss
           });
       }
       this.loader.present();
@@ -59,7 +62,8 @@ export default defineComponent({
       }
     },
     async unauthorised() {
-      this.store.dispatch("user/logout");
+      // Mark the user as unauthorised, this will help in not making the logout api call in actions
+      this.store.dispatch("user/logout", { isUserUnauthorised: true });
       const redirectUrl = window.location.origin + '/login';
       window.location.href = `${process.env.VUE_APP_LOGIN_URL}?redirectUrl=${redirectUrl}`;
     }

src/adapter/index.ts

@@ -1,10 +1,11 @@
-import { api, client, getConfig, initialise, resetConfig, updateInstanceUrl, updateToken } from '@hotwax/oms-api'
+import { api, client, getConfig, initialise, logout, resetConfig, updateInstanceUrl, updateToken } from '@hotwax/oms-api'
 
 export {
   api,
   client,
   getConfig,
   initialise,
+  logout,
   resetConfig,
   updateInstanceUrl,
   updateToken

src/locales/en.json

@@ -27,6 +27,7 @@
   "Log variance": "Log variance",
   "Login": "Login",
   "Logging in": "Logging in",
+  "Logging out": "Logging out",
   "Logout": "Logout",
   "Make sure you've reviewed the products and their counts before uploading them for review": "Make sure you've reviewed the products and their counts before uploading them for review",
   "No time zone found": "No time zone found",

src/main.ts

@@ -33,7 +33,7 @@ import permissionRules from '@/authorization/Rules';
 import permissionActions from '@/authorization/Actions';
 import { dxpComponents } from '@hotwax/dxp-components'
 import { login, logout, loader } from './user-utils';
-import { getConfig, initialise } from '@hotwax/oms-api';
+import { getConfig, initialise } from '@/adapter'
 
 const app = createApp(App)
   .use(IonicVue, {

src/store/modules/user/actions.ts

@@ -6,14 +6,15 @@ import * as types from './mutation-types'
 import { hasError, showToast } from '@/utils'
 import { translate } from '@/i18n'
 import { Settings } from 'luxon';
-import { updateInstanceUrl, updateToken, resetConfig } from '@/adapter'
+import { logout, updateInstanceUrl, updateToken, resetConfig } from '@/adapter'
 import {
   getServerPermissionsFromRules,
   prepareAppPermissions,
   resetPermissions,
   setPermissions
 } from '@/authorization'
 import { useAuthStore } from '@hotwax/dxp-components'
+import emitter from '@/event-bus'
 
 const actions: ActionTree<UserState, RootState> = {
 
@@ -92,7 +93,32 @@ const actions: ActionTree<UserState, RootState> = {
   /**
    * Logout user
    */
-  async logout ({ commit }) {
+  async logout ({ commit }, payload) {
+    // store the url on which we need to redirect the user after logout api completes in case of SSO enabled
+    let redirectionUrl = ''
+
+    emitter.emit('presentLoader', { message: 'Logging out', backdropDismiss: false })
+
+    // Calling the logout api to flag the user as logged out, only when user is authorised
+    // if the user is already unauthorised then not calling the logout api as it returns 401 again that results in a loop, thus there is no need to call logout api if the user is unauthorised
+    if(!payload?.isUserUnauthorised) {
+      let resp;
+
+      // wrapping the parsing logic in try catch as in some case the logout api makes redirection, and then we are unable to parse the resp and thus the logout process halts
+      try {
+        resp = await logout();
+
+        // Added logic to remove the `//` from the resp as in case of get request we are having the extra characters and in case of post we are having 403
+        resp = JSON.parse(resp.startsWith('//') ? resp.replace('//', '') : resp)
+      } catch(err) {
+        console.error('Error parsing data', err)
+      }
+
+      if(resp?.logoutAuthType == 'SAML2SSO') {
+        redirectionUrl = resp.logoutUrl
+      }
+    }
+
     const authStore = useAuthStore()
 
     // TODO add any other tasks if need
@@ -104,6 +130,14 @@ const actions: ActionTree<UserState, RootState> = {
 
     // reset plugin state on logout
     authStore.$reset()
+
+    // If we get any url in logout api resp then we will redirect the user to the url
+    if(redirectionUrl) {
+      window.location.href = redirectionUrl
+    }
+
+    emitter.emit('dismissLoader')
+    return redirectionUrl;
   },
 
   /**

src/user-utils/index.ts

@@ -4,7 +4,7 @@ import { loadingController } from '@ionic/vue'
 
 const login = async (payload: any) => store.dispatch('user/login', payload);
 
-const logout = async () => store.dispatch('user/logout');
+const logout = async (payload: any) => store.dispatch('user/logout', payload);
 
 const loader = {
   value: null as any,

src/views/Settings.vue

@@ -213,9 +213,12 @@ export default defineComponent({
         {
           text: this.$t('Ok'),
           handler: () => {
-            this.store.dispatch('user/logout').then(() => {
-              const redirectUrl = window.location.origin + '/login'
-              window.location.href = `${process.env.VUE_APP_LOGIN_URL}?isLoggedOut=true&redirectUrl=${redirectUrl}`
+            this.store.dispatch('user/logout', { isUserUnauthorised: false }).then((redirectionUrl) => {
+              // if not having redirection url then redirect the user to launchpad
+              if (!redirectionUrl) {
+                const redirectUrl = window.location.origin + '/login'
+                window.location.href = `${process.env.VUE_APP_LOGIN_URL}?isLoggedOut=true&redirectUrl=${redirectUrl}`
+              }
             })
           }
         }]
@@ -255,9 +258,12 @@ export default defineComponent({
       if (Object.keys(this.uploadProducts).length > 0) {
         this.presentAlertOnLogout();
       } else {
-        this.store.dispatch('user/logout').then(() => {
-          const redirectUrl = window.location.origin + '/login'
-          window.location.href = `${process.env.VUE_APP_LOGIN_URL}?isLoggedOut=true&redirectUrl=${redirectUrl}`
+        this.store.dispatch('user/logout', { isUserUnauthorised: false }).then((redirectionUrl) => {
+          // if not having redirection url then redirect the user to launchpad
+          if (!redirectionUrl) {
+            const redirectUrl = window.location.origin + '/login'
+            window.location.href = `${process.env.VUE_APP_LOGIN_URL}?isLoggedOut=true&redirectUrl=${redirectUrl}`
+          }
         })
       }
     },