Refactor to signel use route resolving method

This commit is contained in:
Fayaz Ahmed
2024-08-28 01:10:05 +05:30
parent deeb580fee
commit 4b5880eb30
10 changed files with 84 additions and 97 deletions
+2 -2
View File
@@ -8,7 +8,7 @@ import availabilityMixin from 'widget/mixins/availability';
import { getLocale } from './helpers/urlParamsHelper';
import { isEmptyObject } from 'widget/helpers/utils';
import Spinner from 'shared/components/Spinner.vue';
import { useRouterHelper } from 'widget/composables/useRouterHelper';
import useReplaceRoute from 'widget/composables/useReplaceRoute';
import {
getExtraSpaceToScroll,
loadedEventConfig,
@@ -29,7 +29,7 @@ export default {
},
mixins: [availabilityMixin, configMixin, darkModeMixin],
setup() {
const { replaceRoute } = useRouterHelper();
const replaceRoute = useReplaceRoute();
return { replaceRoute };
},
data() {
@@ -6,7 +6,7 @@ import FooterReplyTo from 'widget/components/FooterReplyTo.vue';
import ChatInputWrap from 'widget/components/ChatInputWrap.vue';
import { BUS_EVENTS } from 'shared/constants/busEvents';
import { sendEmailTranscript } from 'widget/api/conversation';
import { useRouterHelper } from 'widget/composables/useRouterHelper';
import useReplaceRoute from 'widget/composables/useReplaceRoute';
import { IFrameHelper } from '../helpers/utils';
import { CHATWOOT_ON_START_CONVERSATION } from '../constants/sdkEvents';
@@ -17,7 +17,7 @@ export default {
FooterReplyTo,
},
setup() {
const { replaceRoute } = useRouterHelper();
const replaceRoute = useReplaceRoute();
return { replaceRoute };
},
data() {
@@ -3,7 +3,7 @@ import availabilityMixin from 'widget/mixins/availability';
import nextAvailabilityTime from 'widget/mixins/nextAvailabilityTime';
import FluentIcon from 'shared/components/FluentIcon/Index.vue';
import HeaderActions from './HeaderActions.vue';
import { useRouterHelper } from 'widget/composables/useRouterHelper';
import useReplaceRoute from 'widget/composables/useReplaceRoute';
import darkMixin from 'widget/mixins/darkModeMixin.js';
export default {
@@ -36,7 +36,7 @@ export default {
},
},
setup() {
const { replaceRoute } = useRouterHelper();
const replaceRoute = useReplaceRoute();
return { replaceRoute };
},
computed: {
@@ -6,7 +6,7 @@ import { getContrastingTextColor } from '@chatwoot/utils';
import { isEmptyObject } from 'widget/helpers/utils';
import { getRegexp } from 'shared/helpers/Validators';
import messageFormatterMixin from 'shared/mixins/messageFormatterMixin';
import { useRouterHelper } from 'widget/composables/useRouterHelper';
import useReplaceRoute from 'widget/composables/useReplaceRoute';
import darkModeMixin from 'widget/mixins/darkModeMixin';
import configMixin from 'widget/mixins/configMixin';
@@ -23,7 +23,7 @@ export default {
},
},
setup() {
const { replaceRoute } = useRouterHelper();
const replaceRoute = useReplaceRoute();
return { replaceRoute };
},
data() {
@@ -0,0 +1,51 @@
import { describe, it, expect, vi } from 'vitest';
import { useReplaceRoute } from '../useReplaceRoute';
vi.mock('dashboard/composables/route', () => ({
useRouter: vi.fn(),
useRoute: vi.fn(),
}));
import { useRouter, useRoute } from 'dashboard/composables/route';
describe('useReplaceRoute', () => {
const mockReplace = vi.fn();
const mockRouter = { replace: mockReplace };
beforeEach(() => {
vi.clearAllMocks();
useRouter.mockReturnValue(mockRouter);
});
it('should replace route when current route is different', () => {
useRoute.mockReturnValue({ name: 'currentRoute' });
const replaceRoute = useReplaceRoute();
replaceRoute('newRoute', { id: 1 });
expect(mockReplace).toHaveBeenCalledWith({
name: 'newRoute',
params: { id: 1 },
});
});
it('should not replace route when current route is the same', () => {
useRoute.mockReturnValue({ name: 'sameRoute' });
const replaceRoute = useReplaceRoute();
const result = replaceRoute('sameRoute');
expect(mockReplace).not.toHaveBeenCalled();
expect(result).toBeUndefined();
});
it('should return the result of router.replace when replacing route', () => {
useRoute.mockReturnValue({ name: 'currentRoute' });
mockReplace.mockReturnValue('replacementResult');
const replaceRoute = useReplaceRoute();
const result = replaceRoute('newRoute');
expect(result).toBe('replacementResult');
});
});
@@ -1,59 +0,0 @@
import { describe, it, expect, vi, beforeEach } from 'vitest';
import { useRouterHelper } from '../useRouterHelper';
const mockRouter = {
currentRoute: { name: 'initialRoute' },
replace: vi.fn(),
};
vi.mock('../../composables/useRouterHelper', () => ({
useRouterHelper: () => ({
replaceRoute: async (name, params = {}) => {
if (mockRouter.currentRoute.name !== name) {
return mockRouter.replace({ name, params });
}
return undefined;
},
}),
}));
describe('useRouterHelper', () => {
let routerHelper;
beforeEach(() => {
vi.resetAllMocks();
mockRouter.currentRoute = { name: 'initialRoute' };
routerHelper = useRouterHelper();
});
describe('replaceRoute', () => {
it('should replace route when current route is different', async () => {
mockRouter.replace.mockResolvedValue(undefined);
await routerHelper.replaceRoute('newRoute', { id: 1 });
expect(mockRouter.replace).toHaveBeenCalledWith({
name: 'newRoute',
params: { id: 1 },
});
});
it('should not replace route when current route is the same', async () => {
mockRouter.currentRoute.name = 'sameRoute';
const result = await routerHelper.replaceRoute('sameRoute');
expect(mockRouter.replace).not.toHaveBeenCalled();
expect(result).toBeUndefined();
});
it('should handle router replace rejection', async () => {
const error = new Error('Navigation aborted');
mockRouter.replace.mockRejectedValue(error);
await expect(routerHelper.replaceRoute('newRoute')).rejects.toThrow(
'Navigation aborted'
);
});
});
});
@@ -0,0 +1,21 @@
import { useRouter, useRoute } from 'dashboard/composables/route';
/**
* Composable for replacing the current route with a new one if it's different.
* @param {string} name - The name of the route to replace with.
* @param {Object} params - The params to pass to the new route.
* @returns {Function} A function that replaces the route when called.
*/
export const useReplaceRoute = () => {
const router = useRouter();
const route = useRoute();
return (name, params = {}) => {
if (route.name !== name) {
return router.replace({ name, params });
}
return undefined;
};
};
export default useReplaceRoute;
@@ -1,26 +0,0 @@
import { useRouter, useRoute } from 'dashboard/composables/route';
/**
* Composable for handling router-related operations.
* @returns {Object} An object containing methods for router manipulation.
*/
export function useRouterHelper() {
const router = useRouter();
const route = useRoute();
/**
* Replaces the current route with a new one if it's different.
* @param {string} name - The name of the route to replace with.
* @param {Object} params - The params to pass to the new route.
* @returns {Promise|undefined} A promise that resolves when the navigation is complete, or undefined if no navigation occurs.
*/
const replaceRoute = async (name, params = {}) => {
if (route.name !== name) {
return router.replace({ name, params });
}
return undefined;
};
return {
replaceRoute,
};
}
+2 -2
View File
@@ -5,7 +5,7 @@ import ArticleCardSkeletonLoader from 'widget/components/ArticleCardSkeletonLoad
import { mapGetters } from 'vuex';
import darkModeMixin from 'widget/mixins/darkModeMixin';
import { useRouterHelper } from 'widget/composables/useRouterHelper';
import useReplaceRoute from 'widget/composables/useReplaceRoute';
import configMixin from 'widget/mixins/configMixin';
export default {
@@ -17,7 +17,7 @@ export default {
},
mixins: [configMixin, darkModeMixin],
setup() {
const { replaceRoute } = useRouterHelper();
const replaceRoute = useReplaceRoute();
return { replaceRoute };
},
computed: {
+2 -2
View File
@@ -1,7 +1,7 @@
<script>
import PreChatForm from '../components/PreChat/Form.vue';
import configMixin from '../mixins/configMixin';
import { useRouterHelper } from 'widget/composables/useRouterHelper';
import useReplaceRoute from 'widget/composables/useReplaceRoute';
import { isEmptyObject } from 'widget/helpers/utils';
import { ON_CONVERSATION_CREATED } from '../constants/widgetBusEvents';
@@ -11,7 +11,7 @@ export default {
},
mixins: [configMixin],
setup() {
const { replaceRoute } = useRouterHelper();
const replaceRoute = useReplaceRoute();
return { replaceRoute };
},
mounted() {