jason/DigitalConsumer.FixMyGlass
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Reapply "Big split"

Browse source 
This reverts commit 0b80154cd9.
This commit is contained in:
Chloe Herd 2025-05-13 16:36:13 -04:00
parent 541536b3af
commit d89f61a5b7
36 changed files with 518 additions and 413 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/layouts/estimate/estimate.vue
View file

@ -62,7 +62,7 @@ import { saveSession } from "@/helpers/heritage-integration/order-helper.js";
import baseMixin from "@/mixins/base-mixin.js";
import { queryStrings } from "@/constants/query-strings";
import { nextTick } from "vue";
import { consumeQueryFromStash } from "@/router/a-rewrite/logic/querystring-stash";
import { consumeQueryFromStash } from "@/router/a-rewrite/methods/helpers/querystring-stash";
// Define Validation Rules
defineRule("zip-required", required(errorMessages.SERVICE_ZIP_REQUIRED));

2
src/layouts/license-plate-lookup/license-plate-lookup.vue
View file

@ -119,7 +119,7 @@ import baseMixin from "@/mixins/base-mixin.js";
import store from "@/store";
import vinPagesMixin from "@/mixins/vin-pages-mixin";
import { fmgPageValues } from "@/router/router-constants/fmgPage-values";
import { consumeQueryFromStash } from "@/router/a-rewrite/logic/querystring-stash";
import { consumeQueryFromStash } from "@/router/a-rewrite/methods/helpers/querystring-stash";
import { queryStrings } from "@/constants/query-strings";
// DEFINE VALIDATION RULES

2
src/layouts/payment-method/payment-method.vue
View file

@ -168,7 +168,7 @@ import {
getSubTotal,
getSalesTax,
} from "@/helpers/pricing-helper.js";
import { consumeQueryFromStash } from "@/router/a-rewrite/logic/querystring-stash";
import { consumeQueryFromStash } from "@/router/a-rewrite/methods/helpers/querystring-stash";
defineRule("payment-method-required", required(errorMessages.OPTION_REQUIRED));
defineRule("recal-ack-required", required(errorMessages.RECAL_ACK_REQUIRED));

2
src/layouts/quote/quote.vue
View file

@ -169,7 +169,7 @@ import {
} from "@/helpers/heritage-integration/cookie-helper";
import { showFmgLoadingModal } from "@/helpers/loading-modal-helper";
import { fmgPageValues } from "@/router/router-constants/fmgPage-values";
import { consumeQueryFromStash } from "@/router/a-rewrite/logic/querystring-stash";
import { consumeQueryFromStash } from "@/router/a-rewrite/methods/helpers/querystring-stash";
import { storeMutations } from "@/constants/store-mutations";
defineRule("option-required", required(errorMessages.OPTION_REQUIRED));

2
src/layouts/service-zip/service-zip.vue
View file

@ -96,7 +96,7 @@ import { saveSession } from "@/helpers/heritage-integration/order-helper.js";
import baseMixin from "@/mixins/base-mixin.js";
import { queryStrings } from "@/constants/query-strings";
import { fmgPageValues } from "@/router/router-constants/fmgPage-values";
import { consumeQueryFromStash } from "@/router/a-rewrite/logic/querystring-stash";
import { consumeQueryFromStash } from "@/router/a-rewrite/methods/helpers/querystring-stash";
// Define Validation Rules
defineRule("zip-required", required(errorMessages.SERVICE_ZIP_REQUIRED));

2
src/layouts/vehicle/vehicle.vue
View file

@ -113,7 +113,7 @@ import { getQuerystringParameter } from "@/helpers/querystring-helper";
import {
consumeQueryFromStash,
peekQueryFromStash,
} from "@/router/a-rewrite/logic/querystring-stash";
} from "@/router/a-rewrite/methods/helpers/querystring-stash";
//define validation rules
defineRule("year-required", required(errorMessages.YEAR_REQUIRED));

2
src/layouts/vin-lookup/vin-lookup.vue
View file

@ -160,7 +160,7 @@ import baseMixin from "@/mixins/base-mixin.js";
import store from "@/store";
import vinPagesMixin from "@/mixins/vin-pages-mixin";
import { fmgPageValues } from "@/router/router-constants/fmgPage-values";
import { consumeQueryFromStash } from "@/router/a-rewrite/logic/querystring-stash";
import { consumeQueryFromStash } from "@/router/a-rewrite/methods/helpers/querystring-stash";
import { queryStrings } from "@/constants/query-strings";
// DEFINE VALIDATION RULES

6
src/router/a-rewrite/constants/externalUrl-values.js Normal file
View file

@ -0,0 +1,6 @@
const externalUrls = {
HERITAGE_FUNNEL: process.env.VUE_APP_HERITAGE_FUNNEL,
SAFELITE_HOP: process.env.VUE_APP_SAFELITE_HOP,
};
export { externalUrls };

425
src/router/a-rewrite/index.js
View file

@ -1,216 +1,16 @@
import { routeData, FUNNEL_START_PAGE } from "@/router/a-rewrite/constants/routes";
import { createRoute, createVirtualRoute } from "@/router/a-rewrite/logic/create-route";
import { navigateToHeritageFunnel } from "@/helpers/heritage-integration/navigation-helper";
import { createWebHistory, createRouter } from "vue-router";
import { getDestination } from "@/router/a-rewrite/logic/get-destination";
import analyticsMixin from "@/mixins/analytics-mixin";
import { routes } from "@/router/a-rewrite/methods/routes";
import { afterEach } from "@/router/a-rewrite/methods/after-each";
import { beforeEach } from "@/router/a-rewrite/methods/before-each";
import { bailout } from "@/router/a-rewrite/methods/error";
import {
getFunnelCookie,
deleteFunnelCookie,
updateOrCreateFunnelCookie,
} from "@/helpers/heritage-integration/cookie-helper";
import { isSavedSessionStillActive } from "@/helpers/heritage-integration/session-helper";
import { loadSessionIfPresent, saveSession } from "@/helpers/heritage-integration/order-helper";
import store from "@/store";
import { storeActions } from "@/constants/store-actions";
import { storeMutations } from "@/constants/store-mutations";
import { sessionStorageKeyConstants } from "@/constants/session-storage";
import { savePageData } from "@/router/a-rewrite/logic/save-page-data";
import eventBus from "@/helpers/event-bus/event-bus";
import { globalEvents, globalEventTypes } from "@/constants/events";
import { autoRouteTable } from "@/router/a-rewrite/constants/auto-route-table";
import { queryStrings } from "@/constants/query-strings";
import { consumeReferralQuerystrings } from "@/router/a-rewrite/logic/consume-referral-info";
import { initializeFromQueryStrings } from "@/router/a-rewrite/logic/initialize-from-querystrings";
import { getBoolFromString } from "@/helpers/boolean-helper";
import { isVerifiedInsurance } from "@/router/a-rewrite/logic/requires-verified-redirect";
import baseMixin from "@/mixins/base-mixin";
import { runExperiments } from "@/router/a-rewrite/logic/run-experiments";
navigateWithoutSaving,
navigateWithSaving,
navigateWithPageData,
navigateAndForceTopLevelNavigation,
} from "@/router/a-rewrite/methods/navigate";
import { navigateToExternalUrl } from "@/router/a-rewrite/methods/navigate-external";
import { createWebHistory, createRouter } from "vue-router";
import { ROUTE_PREFIX_FULL } from "@/router/a-rewrite/constants/route-prefix";
import { buildManualUrl } from "@/router/a-rewrite/logic/build-manual-url";
import { consumeQueryFromStash, stashAllQueries } from "@/router/a-rewrite/logic/querystring-stash";
const routes = [
// Non-virtual pages.
createRoute(routeData.VEHICLE, async (to, from) => {
// If cookie indicates that vehicle has changed during insurance flow, reset parts info.
const hasVehicleChanged = getBoolFromString(getFunnelCookie()?.HasDelayedClaimRegistration);
if (hasVehicleChanged) {
store.commit(storeMutations.RESET_GLASS_PARTS_STATE);
}
if (isVerifiedInsurance()) {
return {
name: routeData.VEHICLE_DAMAGE.name,
replace: true,
};
}
}),
createRoute(routeData.VEHICLE_DAMAGE),
createRoute(routeData.ESTIMATE),
createRoute(routeData.ADDRESS_LOOKUP),
createRoute(routeData.VIN_LOOKUP),
createRoute(routeData.LICENSE_PLATE_LOOKUP),
createRoute(routeData.SERVICE_ZIP),
createRoute(routeData.ADDRESS_VEHICLES),
createRoute(routeData.VEHICLE_PARTS),
createRoute(routeData.PART_QUESTIONS),
createRoute(routeData.MOLDING_QUESTIONS),
createRoute(routeData.CAPABILITY_QUESTIONS),
createRoute(routeData.QUOTE, async (to, from) => {
if (isVerifiedInsurance()) {
return {
name: routeData.HERITAGE.name,
replace: true,
};
}
const offerQuote = to.query?.[queryStrings.OFFER_QUOTE];
if (offerQuote === "true") {
store.commit(storeMutations.UPDATE_IS_INSURANCE, false);
}
}),
createRoute(routeData.INSURANCE_COMPANY, async (to, from) => {
if (isVerifiedInsurance()) {
return {
name: routeData.HERITAGE.name,
replace: true,
};
}
}),
createRoute(routeData.SERVICE_LOCATION),
createRoute(routeData.SCHEDULE),
createRoute(routeData.CUSTOMER_DETAILS),
createRoute(routeData.PAYMENT_METHOD),
createRoute(routeData.PAYMENT),
createRoute(routeData.PAYMENT_PIA_RETURN),
createRoute(routeData.CONFIRMATION),
createRoute(routeData.RETURN_USER),
// Virtual pages (resolve to a non-virtual page.)
createVirtualRoute(routeData.LANDING, async (to, from) => {
await initializeFromQueryStrings();
// Save querystrings to temporary stash so they can be referred to later.
stashAllQueries(to);
// Change referral info. For use in local testing for insurance crossover.
await consumeReferralQuerystrings();
// Check for fmgpage parameter
const fmgPage = to?.query?.fmgPage;
if (fmgPage && router.hasRoute(fmgPage)) {
return {
name: fmgPage,
replace: true,
};
}
// If a session is still in memory, go to return-user.
if (store.getters.vehicle?.year > 0) {
console.log(`trying to redirect!`);
return {
name: routeData.RETURN_USER.name,
replace: true,
};
}
// Otherwise, load session and auto-route
return {
name: routeData.LOAD_SESSION.name,
replace: true,
};
}),
createVirtualRoute(routeData.HERITAGE, async (to, from) => {
await navigateToHeritageFunnel({ shouldSaveSession: false, pageNameToLog: to.name });
}),
createVirtualRoute(routeData.LOAD_SESSION, async (to, from) => {
const loadSessionResponse = await loadSessionIfPresent(false, to.name);
return {
name: routeData.AUTO_ROUTE.name,
replace: true,
};
}),
createVirtualRoute(routeData.AUTO_ROUTE, async (to, from) => {
for (let i = 0; i < autoRouteTable.length; i++) {
const testRouteData = autoRouteTable[i];
const isReady = await router.checkPagePrerequisites(testRouteData.name);
if (isReady) {
return {
name: testRouteData.name,
replace: true,
};
}
}
return {
name: FUNNEL_START_PAGE,
replace: true,
};
}),
createVirtualRoute(routeData.ERROR, async (to, from) => {
// If we've already encountered one error, clear session to avoid more.
// Otherwise mark that we encoutnered an error here.
if (store.getters.applicationUser.hasAlreadyTriggeredError) {
return {
name: routeData.RESTART.name,
replace: true,
};
} else {
await store.dispatch(storeActions.UPDATE_HAS_TRIGGERED_ERROR, true);
}
// Add error event to bus
eventBus.addEventToBus(
globalEvents.Categories.GLOBAL_ALERT,
globalEvents.SubCategories.UNKNOWN_ERROR,
{
isDismissable: true,
messageCopy: "",
messageHeadline: "We're sorry, something went wrong.",
type: globalEventTypes.Danger,
}
);
let nextPage = FUNNEL_START_PAGE.name;
baseMixin.methods?.ResetExternalParamsAndHideModal();
if (store.getters.payment?.insuranceCoverage?.isVerified) {
nextPage = routeData.VEHICLE_DAMAGE.name;
}
if (from.name === nextPage) {
// Router won't load the page if we redirect to the already existing page
// Force refresh in this scenario.
router.go(0);
return false;
}
return {
name: nextPage,
replace: false,
};
}),
createVirtualRoute(routeData.RESTART, async (to, from) => {
await store.dispatch(storeActions.RESET_STATE);
deleteFunnelCookie();
if (from.name === FUNNEL_START_PAGE.name) {
// Router won't load the page if we redirect to the already existing page
// Force refresh in this scenario.
router.go(0);
return false;
}
return {
name: FUNNEL_START_PAGE.name,
replace: true,
};
}),
];
const router = createRouter({
history: createWebHistory(ROUTE_PREFIX_FULL),
@ -221,201 +21,18 @@ const router = createRouter({
},
});
////-- Global Guards
// Set guards
router.afterEach(async (to, from) => afterEach(to, from));
router.beforeEach(async (to, from) => beforeEach(to, from));
router.beforeEach(async (to, from) => {
console.log(to);
try {
await analyticsMixin.methods.validateSession();
// Bind methods for external use
router.navigateWithSaving = navigateWithSaving;
router.navigateWithoutSaving = navigateWithoutSaving;
router.navigateWithPageData = navigateWithPageData;
router.navigateAndForceTopLevelNavigation = navigateAndForceTopLevelNavigation;
if (getFunnelCookie()?.SuppressConceptFunnel) {
// Redirect to heritage.
return {
name: routeData.HERITAGE.name,
};
}
router.bailout = bailout;
// Ensure session has not expired
if (getFunnelCookie() !== null && !isSavedSessionStillActive()) {
const errorPayload = {
cause: "expired session",
currentPage: from?.name,
nextPage: to?.name,
};
router.bailout(errorPayload, true);
return false;
}
// Block navigation if an order has been submitted.
if (window.sessionStorage.getItem(sessionStorageKeyConstants.SUBMITTED_STATE) !== null) {
if (to.name !== FUNNEL_START_PAGE.name && to.name !== routeData.CONFIRMATION.name) {
return false;
}
}
// Process funnel cookie.
updateOrCreateFunnelCookie();
// If sent from heritage, need to load session.
const fromHeritageFlag = consumeQueryFromStash(queryStrings.FROM_HERITAGE);
if (fromHeritageFlag) {
await loadSessionIfPresent(true, routeData.SERVICE_LOCATION.name);
}
// Ensure page-prerequisites are fulfilled
const arePagePrerequisitesValid = await router.checkPagePrerequisites(to.name);
if (!arePagePrerequisitesValid) {
const errorPayload = {
cause: "invalid page prerequisites for page",
currentPage: from?.name,
nextPage: to?.name,
};
router.bailout(errorPayload);
return;
}
await runExperiments(to.name);
} catch (error) {
const errorPayload = {
cause: "Uncaught exception in `beforeEach`.",
currentPage: from?.name,
nextPage: to?.name,
};
console.log(error);
router.bailout(errorPayload);
return;
}
});
router.afterEach(async (to, from) => {
// Push page view to GA
analyticsMixin.methods.pushPageViewToGA();
// Push experiments to Data Layer
analyticsMixin.methods.pushExperimentsToDataLayer();
// Push current order status to Data Layer
analyticsMixin.methods.pushOrderToDataLayer();
});
////-- End Global Guards
////-- Bound Functions
router.getRoute = (pageName) => {
return router.getRoutes().find((r) => r.name === pageName);
};
router.checkPagePrerequisites = async (pageName) => {
const route = router.getRoute(pageName);
if (!route) {
return false;
}
let component = route.components;
// Virtual routes have no component, so skip check.
if (!component) {
return true;
}
if (component?.default?.methods === undefined) {
component = await component?.default();
}
return component?.default?.methods?.arePagePrerequisitesValid();
};
router.navigateWithoutSaving = async (scenario, currentPageName) => {
return await router.navigate(currentPageName, scenario, false);
};
router.navigateWithSaving = async (scenario, currentPageName) => {
return await router.navigate(currentPageName, scenario, true);
};
router.navigateWithPageData = async (scenario, currentPageName, pageData = {}) => {
const nextPage = getDestination(currentPageName, scenario);
await savePageData(nextPage.name, pageData);
return await router.navigate(currentPageName, scenario, true);
};
router.navigateAndForceTopLevelNavigation = async (scenario, currentPageName, saving = false) => {
return await router.navigate(currentPageName, scenario, saving, true);
};
router.bailout = (errorPayload, forceRestart = false) => {
analyticsMixin.methods.pushPageErrorToDataLayer(errorPayload);
if (forceRestart) {
router.push({
name: routeData.RESTART.name,
});
} else {
router.push({
name: routeData.ERROR.name,
});
}
};
router.navigate = async (
currentPageName,
scenario,
withSaving = false,
forceTopLevelNav = false
) => {
// Check to see if calling page is same as current page.
// If not, cancel navigation before it begins.
const callingRoute = currentPageName;
const actualRoute = router.currentRoute.value.name;
if (callingRoute !== actualRoute) {
return false;
}
const nextPage = getDestination(currentPageName, scenario);
if (!nextPage) {
console.error(
`Could not navigate from ${currentPageName} via scenario ${scenario}. Ensure routing table is configured correctly.`
);
const errorPayload = {
cause: "invalid page name",
currentPage: currentPageName,
nextPage: nextPage?.name,
};
router.bailout(errorPayload);
return;
}
if (withSaving) {
await saveSession({ pageNameToLog: nextPage.name });
}
// Some pages require manually setting the next url
// to work with iframes.
if (forceTopLevelNav) {
const newUrl = buildManualUrl(nextPage);
window.top.location.href = newUrl;
return;
}
// All other pages use router.push
router.push({
name: nextPage.name,
query: nextPage.params ?? {},
});
};
////-- End Router Functions
router.navigateToExternalUrl = navigateToExternalUrl;
export default router;

12
src/router/a-rewrite/methods/after-each.js Normal file
View file

@ -0,0 +1,12 @@
import analyticsMixin from "@/mixins/analytics-mixin";
export async function afterEach(to, from) {
// Push page view to GA
analyticsMixin.methods.pushPageViewToGA();
// Push experiments to Data Layer
analyticsMixin.methods.pushExperimentsToDataLayer();
// Push current order status to Data Layer
analyticsMixin.methods.pushOrderToDataLayer();
}

83
src/router/a-rewrite/methods/before-each.js Normal file
View file

@ -0,0 +1,83 @@
import { queryStrings } from "@/constants/query-strings";
import { sessionStorageKeyConstants } from "@/constants/session-storage";
import {
getFunnelCookie,
updateOrCreateFunnelCookie,
} from "@/helpers/heritage-integration/cookie-helper";
import { loadSessionIfPresent } from "@/helpers/heritage-integration/order-helper";
import { isSavedSessionStillActive } from "@/helpers/heritage-integration/session-helper";
import analyticsMixin from "@/mixins/analytics-mixin";
import { routeData, FUNNEL_START_PAGE } from "@/router/a-rewrite/constants/routes";
import { consumeQueryFromStash } from "@/router/a-rewrite/methods/helpers/querystring-stash";
import { runExperiments } from "@/router/a-rewrite/methods/helpers/run-experiments";
import { bailout } from "@/router/a-rewrite/methods/error";
import { checkPagePrerequisites } from "@/router/a-rewrite/methods/page-prerequisites";
export async function beforeEach(to, from) {
try {
await analyticsMixin.methods.validateSession();
if (getFunnelCookie()?.SuppressConceptFunnel) {
// Redirect to heritage.
return {
name: routeData.HERITAGE.name,
};
}
// Ensure session has not expired
if (getFunnelCookie() !== null && !isSavedSessionStillActive()) {
const errorPayload = {
cause: "expired session",
currentPage: from?.name,
nextPage: to?.name,
};
bailout(errorPayload, true);
return false;
}
// Block navigation if an order has been submitted.
if (window.sessionStorage.getItem(sessionStorageKeyConstants.SUBMITTED_STATE) !== null) {
if (to.name !== FUNNEL_START_PAGE.name && to.name !== routeData.CONFIRMATION.name) {
return false;
}
}
// Process funnel cookie.
updateOrCreateFunnelCookie();
// If sent from heritage, need to load session.
const fromHeritageFlag = consumeQueryFromStash(queryStrings.FROM_HERITAGE);
if (fromHeritageFlag) {
await loadSessionIfPresent(true, routeData.SERVICE_LOCATION.name);
}
// Ensure page-prerequisites are fulfilled
const arePagePrerequisitesValid = await checkPagePrerequisites(to.name);
if (!arePagePrerequisitesValid) {
const errorPayload = {
cause: "invalid page prerequisites for page",
currentPage: from?.name,
nextPage: to?.name,
};
bailout(errorPayload);
return;
}
await runExperiments(to.name);
} catch (error) {
const errorPayload = {
cause: "Uncaught exception in `beforeEach`.",
currentPage: from?.name,
nextPage: to?.name,
};
console.log(error);
bailout(errorPayload);
return;
}
}

17
src/router/a-rewrite/methods/error.js Normal file
View file

@ -0,0 +1,17 @@
import analyticsMixin from "@/mixins/analytics-mixin";
import { routeData } from "@/router/a-rewrite/constants/routes";
import router from "@/router/a-rewrite";
export async function bailout(errorPayload, forceRestart = false) {
analyticsMixin.methods.pushPageErrorToDataLayer(errorPayload);
if (forceRestart) {
router.push({
name: routeData.RESTART.name,
});
} else {
router.push({
name: routeData.ERROR.name,
});
}
}

5
src/router/a-rewrite/methods/get-route.js Normal file
View file

@ -0,0 +1,5 @@
import router from "@/router/a-rewrite";
export function getRoute(pageName) {
return router.getRoutes().find((r) => r.name === pageName);
}

2
src/router/a-rewrite/logic/build-manual-url.js → src/router/a-rewrite/methods/helpers/build-manual-url.js
View file

@ -9,7 +9,7 @@ export function buildManualUrl(nextPage) {
return url;
}
function buildSearchParams(paramList) {
export function buildSearchParams(paramList) {
if (!paramList) {
return "";
}

0
src/router/a-rewrite/logic/consume-referral-info.js → src/router/a-rewrite/methods/helpers/consume-referral-info.js
View file

2
src/router/a-rewrite/logic/create-route.js → src/router/a-rewrite/methods/helpers/create-route.js
View file

@ -1,4 +1,4 @@
import { lazyLoadComponent } from "@/router/a-rewrite/logic/lazy-load-component";
import { lazyLoadComponent } from "@/router/a-rewrite/methods/helpers/lazy-load-component";
import { routeData } from "@/router/a-rewrite/constants/routes";
export function createRoute(routeDatum, beforeEnter = async (to, from) => undefined) {

0
src/router/a-rewrite/logic/get-destination.js → src/router/a-rewrite/methods/helpers/get-destination.js
View file

0
src/router/a-rewrite/logic/initialize-from-querystrings.js → src/router/a-rewrite/methods/helpers/initialize-from-querystrings.js
View file

0
src/router/a-rewrite/logic/lazy-load-component.js → src/router/a-rewrite/methods/helpers/lazy-load-component.js
View file

0
src/router/a-rewrite/logic/querystring-stash.js → src/router/a-rewrite/methods/helpers/querystring-stash.js
View file

0
src/router/a-rewrite/logic/requires-verified-redirect.js → src/router/a-rewrite/methods/helpers/requires-verified-redirect.js
View file

0
src/router/a-rewrite/logic/run-experiments.js → src/router/a-rewrite/methods/helpers/run-experiments.js
View file

0
src/router/a-rewrite/logic/save-page-data.js → src/router/a-rewrite/methods/helpers/save-page-data.js
View file

10
src/router/a-rewrite/methods/navigate-external.js Normal file
View file

@ -0,0 +1,10 @@
export function navigateToExternalUrl(url, optionalQuery = {}) {
// possibly show some loading screen in the future here.
var externalUrl = new URL(url);
for (const queryKey in optionalQuery) {
externalUrl.searchParams.append(queryKey, optionalQuery[queryKey]);
}
window.location.assign(externalUrl);
}

84
src/router/a-rewrite/methods/navigate.js Normal file
View file

@ -0,0 +1,84 @@
import { saveSession } from "@/helpers/heritage-integration/order-helper";
import { buildManualUrl } from "@/router/a-rewrite/methods/helpers/build-manual-url";
import { getDestination } from "@/router/a-rewrite/methods/helpers/get-destination";
import { savePageData } from "@/router/a-rewrite/methods/helpers/save-page-data";
import router from "@/router/a-rewrite";
import { bailout } from "@/router/a-rewrite/methods/error";
async function navigate(scenario, currentPageName, withSaving = false, forceTopLevelNav = false) {
console.log(`Navigate:\n
- scenario: ${scenario}\n
- currentPage: ${currentPageName}\n
- withSaving: ${withSaving}\n
- forceTopLevelNav: ${forceTopLevelNav}`);
// Check to see if calling page is same as current page.
// If not, cancel navigation before it begins.
const callingRoute = currentPageName;
const actualRoute = router.currentRoute.value.name;
if (callingRoute !== actualRoute) {
return false;
}
const nextPage = getDestination(currentPageName, scenario);
if (!nextPage) {
console.error(
`Could not navigate from ${currentPageName} via scenario ${scenario}. Ensure routing table is configured correctly.`
);
const errorPayload = {
cause: "invalid page name",
currentPage: currentPageName,
nextPage: nextPage?.name,
};
bailout(errorPayload);
return;
}
if (withSaving) {
await saveSession({ pageNameToLog: nextPage.name });
}
// Some pages require manually setting the next url
// to work with iframes.
if (forceTopLevelNav) {
const newUrl = buildManualUrl(nextPage);
window.top.location.href = newUrl;
return;
}
// All other pages use router.push
router.push({
name: nextPage.name,
query: nextPage.params ?? {},
});
}
//// -- Aliases: what's actually called
export async function navigateWithoutSaving(scenario, currentPageName) {
return await navigate(scenario, currentPageName, false);
}
export async function navigateWithSaving(scenario, currentPageName) {
return await navigate(scenario, currentPageName, true);
}
export async function navigateWithPageData(scenario, currentPageName, pageData = {}) {
const nextPage = getDestination(currentPageName, scenario);
await savePageData(nextPage.name, pageData);
return await navigate(scenario, currentPageName, true);
}
export async function navigateAndForceTopLevelNavigation(
scenario,
currentPageName,
saving = false
) {
return await navigate(scenario, currentPageName, saving, true);
}

22
src/router/a-rewrite/methods/page-prerequisites.js Normal file
View file

@ -0,0 +1,22 @@
import { getRoute } from "@/router/a-rewrite/methods/get-route";
export async function checkPagePrerequisites(pageName) {
const route = getRoute(pageName);
if (!route) {
return false;
}
let component = route.components;
// Virtual routes have no component, so skip check.
if (!component) {
return true;
}
if (component?.default?.methods === undefined) {
component = await component?.default();
}
return component?.default?.methods?.arePagePrerequisitesValid();
}

23
src/router/a-rewrite/methods/route-logic/auto-route.js Normal file
View file

@ -0,0 +1,23 @@
import { autoRouteTable } from "@/router/a-rewrite/constants/auto-route-table";
import { FUNNEL_START_PAGE } from "@/router/a-rewrite/constants/routes";
import { checkPagePrerequisites } from "@/router/a-rewrite/methods/page-prerequisites";
export async function autoRouteBeforeEnter(to, from) {
for (let i = 0; i < autoRouteTable.length; i++) {
const testRouteData = autoRouteTable[i];
const isReady = await checkPagePrerequisites(testRouteData.name);
if (isReady) {
return {
name: testRouteData.name,
replace: true,
};
}
}
return {
name: FUNNEL_START_PAGE,
replace: true,
};
}

52
src/router/a-rewrite/methods/route-logic/error.js Normal file
View file

@ -0,0 +1,52 @@
import { globalEvents, globalEventTypes } from "@/constants/events";
import { storeActions } from "@/constants/store-actions";
import eventBus from "@/helpers/event-bus/event-bus";
import baseMixin from "@/mixins/base-mixin";
import router from "@/router/a-rewrite";
import { routeData, FUNNEL_START_PAGE } from "@/router/a-rewrite/constants/routes";
import store from "@/store";
export async function errorBeforeEnter(to, from) {
// If we've already encountered one error, clear session to avoid more.
// Otherwise mark that we encoutnered an error here.
if (store.getters.applicationUser.hasAlreadyTriggeredError) {
return {
name: routeData.RESTART.name,
replace: true,
};
} else {
await store.dispatch(storeActions.UPDATE_HAS_TRIGGERED_ERROR, true);
}
// Add error event to bus
eventBus.addEventToBus(
globalEvents.Categories.GLOBAL_ALERT,
globalEvents.SubCategories.UNKNOWN_ERROR,
{
isDismissable: true,
messageCopy: "",
messageHeadline: "We're sorry, something went wrong.",
type: globalEventTypes.Danger,
}
);
let nextPage = FUNNEL_START_PAGE.name;
baseMixin.methods?.ResetExternalParamsAndHideModal();
if (store.getters.payment?.insuranceCoverage?.isVerified) {
nextPage = routeData.VEHICLE_DAMAGE.name;
}
if (from.name === nextPage) {
// Router won't load the page if we redirect to the already existing page
// Force refresh in this scenario.
router.go(0);
return false;
}
return {
name: nextPage,
replace: false,
};
}

5
src/router/a-rewrite/methods/route-logic/heritage.js Normal file
View file

@ -0,0 +1,5 @@
import { navigateToHeritageFunnel } from "@/helpers/heritage-integration/navigation-helper";
export async function heritageBeforeEnter(to, from) {
await navigateToHeritageFunnel({ shouldSaveSession: false, pageNameToLog: to.name });
}

11
src/router/a-rewrite/methods/route-logic/insurance-company.js Normal file
View file

@ -0,0 +1,11 @@
import { routeData } from "@/router/a-rewrite/constants/routes";
import { isVerifiedInsurance } from "@/router/a-rewrite/methods/helpers/requires-verified-redirect";
export async function insuranceCompanyBeforeEnter(to, from) {
if (isVerifiedInsurance()) {
return {
name: routeData.HERITAGE.name,
replace: true,
};
}
}

38
src/router/a-rewrite/methods/route-logic/landing.js Normal file
View file

@ -0,0 +1,38 @@
import router from "@/router/a-rewrite";
import { routeData } from "@/router/a-rewrite/constants/routes";
import { consumeReferralQuerystrings } from "@/router/a-rewrite/methods/helpers/consume-referral-info";
import { initializeFromQueryStrings } from "@/router/a-rewrite/methods/helpers/initialize-from-querystrings";
import { stashAllQueries } from "@/router/a-rewrite/methods/helpers/querystring-stash";
import store from "@/store";
export async function landingBeforeEnter(to, from) {
await initializeFromQueryStrings();
// Save querystrings to temporary stash so they can be referred to later.
stashAllQueries(to);
// Change referral info. For use in local testing for insurance crossover.
await consumeReferralQuerystrings();
// Check for fmgpage parameter
const fmgPage = to?.query?.fmgPage;
if (fmgPage && router.hasRoute(fmgPage)) {
return {
name: fmgPage,
replace: true,
};
}
// If a session is still in memory, go to return-user.
if (store.getters.vehicle?.year > 0) {
console.log(`trying to redirect!`);
return {
name: routeData.RETURN_USER.name,
replace: true,
};
}
// Otherwise, load session and auto-route
return {
name: routeData.LOAD_SESSION.name,
replace: true,
};
}

11
src/router/a-rewrite/methods/route-logic/load-session.js Normal file
View file

@ -0,0 +1,11 @@
import { loadSessionIfPresent } from "@/helpers/heritage-integration/order-helper";
import { routeData } from "@/router/a-rewrite/constants/routes";
export async function loadSessionBeforeEnter(to, from) {
const loadSessionResponse = await loadSessionIfPresent(false, to.name);
return {
name: routeData.AUTO_ROUTE.name,
replace: true,
};
}

20
src/router/a-rewrite/methods/route-logic/quote.js Normal file
View file

@ -0,0 +1,20 @@
import { queryStrings } from "@/constants/query-strings";
import { storeMutations } from "@/constants/store-mutations";
import { routeData } from "@/router/a-rewrite/constants/routes";
import { isVerifiedInsurance } from "@/router/a-rewrite/methods/helpers/requires-verified-redirect";
import store from "@/store";
export async function quoteBeforeEnter(to, from) {
if (isVerifiedInsurance()) {
return {
name: routeData.HERITAGE.name,
replace: true,
};
}
const offerQuote = to.query?.[queryStrings.OFFER_QUOTE];
if (offerQuote === "true") {
store.commit(storeMutations.UPDATE_IS_INSURANCE, false);
}
}

22
src/router/a-rewrite/methods/route-logic/restart.js Normal file
View file

@ -0,0 +1,22 @@
import { storeActions } from "@/constants/store-actions";
import { deleteFunnelCookie } from "@/helpers/heritage-integration/cookie-helper";
import router from "@/router/a-rewrite";
import { FUNNEL_START_PAGE } from "@/router/a-rewrite/constants/routes";
import store from "@/store";
export async function restartBeforeEnter(to, from) {
await store.dispatch(storeActions.RESET_STATE);
deleteFunnelCookie();
if (from.name === FUNNEL_START_PAGE.name) {
// Router won't load the page if we redirect to the already existing page
// Force refresh in this scenario.
router.go(0);
return false;
}
return {
name: FUNNEL_START_PAGE.name,
replace: true,
};
}

21
src/router/a-rewrite/methods/route-logic/vehicle.js Normal file
View file

@ -0,0 +1,21 @@
import { storeMutations } from "@/constants/store-mutations";
import { getBoolFromString } from "@/helpers/boolean-helper";
import { getFunnelCookie } from "@/helpers/heritage-integration/cookie-helper";
import { routeData } from "@/router/a-rewrite/constants/routes";
import { isVerifiedInsurance } from "@/router/a-rewrite/methods/helpers/requires-verified-redirect";
import store from "@/store";
export async function vehicleBeforeEnter(to, from) {
// If cookie indicates that vehicle has changed during insurance flow, reset parts info.
const hasVehicleChanged = getBoolFromString(getFunnelCookie()?.HasDelayedClaimRegistration);
if (hasVehicleChanged) {
store.commit(storeMutations.RESET_GLASS_PARTS_STATE);
}
if (isVerifiedInsurance()) {
return {
name: routeData.VEHICLE_DAMAGE.name,
replace: true,
};
}
}

46
src/router/a-rewrite/methods/routes.js Normal file
View file

@ -0,0 +1,46 @@
import { createRoute, createVirtualRoute } from "@/router/a-rewrite/methods/helpers/create-route";
import { routeData } from "@/router/a-rewrite/constants/routes";
import { vehicleBeforeEnter } from "@/router/a-rewrite/methods/route-logic/vehicle";
import { quoteBeforeEnter } from "@/router/a-rewrite/methods/route-logic/quote";
import { insuranceCompanyBeforeEnter } from "@/router/a-rewrite/methods/route-logic/insurance-company";
import { landingBeforeEnter } from "@/router/a-rewrite/methods/route-logic/landing";
import { heritageBeforeEnter } from "@/router/a-rewrite/methods/route-logic/heritage";
import { loadSessionBeforeEnter } from "@/router/a-rewrite/methods/route-logic/load-session";
import { autoRouteBeforeEnter } from "@/router/a-rewrite/methods/route-logic/auto-route";
import { errorBeforeEnter } from "@/router/a-rewrite/methods/route-logic/error";
import { restartBeforeEnter } from "@/router/a-rewrite/methods/route-logic/restart";
export const routes = [
// Non-virtual pages.
createRoute(routeData.VEHICLE, vehicleBeforeEnter),
createRoute(routeData.VEHICLE_DAMAGE),
createRoute(routeData.ESTIMATE),
createRoute(routeData.ADDRESS_LOOKUP),
createRoute(routeData.VIN_LOOKUP),
createRoute(routeData.LICENSE_PLATE_LOOKUP),
createRoute(routeData.SERVICE_ZIP),
createRoute(routeData.ADDRESS_VEHICLES),
createRoute(routeData.VEHICLE_PARTS),
createRoute(routeData.PART_QUESTIONS),
createRoute(routeData.MOLDING_QUESTIONS),
createRoute(routeData.CAPABILITY_QUESTIONS),
createRoute(routeData.QUOTE, quoteBeforeEnter),
createRoute(routeData.INSURANCE_COMPANY, insuranceCompanyBeforeEnter),
createRoute(routeData.SERVICE_LOCATION),
createRoute(routeData.SCHEDULE),
createRoute(routeData.CUSTOMER_DETAILS),
createRoute(routeData.PAYMENT_METHOD),
createRoute(routeData.PAYMENT),
createRoute(routeData.PAYMENT_PIA_RETURN),
createRoute(routeData.CONFIRMATION),
createRoute(routeData.RETURN_USER),
// Virtual pages (resolve to a non-virtual page.)
createVirtualRoute(routeData.LANDING, landingBeforeEnter),
createVirtualRoute(routeData.HERITAGE, heritageBeforeEnter),
createVirtualRoute(routeData.LOAD_SESSION, loadSessionBeforeEnter),
createVirtualRoute(routeData.AUTO_ROUTE, autoRouteBeforeEnter),
createVirtualRoute(routeData.ERROR, errorBeforeEnter),
createVirtualRoute(routeData.RESTART, restartBeforeEnter),
];