Merge pull request #2191 from Safelite/feature/CASH-79-ajc

Feature/CASH-79 Save Progress feature

src/digital-components/modal/modal.vue

@@ -25,17 +25,17 @@
                 </div>
                 <div class="modal-body ps-5 pe-5 pb-4 pt-1">
                     <slot></slot>
-                </div>
+                    <div class="modal-footer px-5 py-4">
-                <div class="modal-footer px-5 py-4">
+                        <modalButtonMain
-                    <modalButtonMain
+                            isPrimary
-                        isPrimary
+                            class="w-100"
-                        class="w-100"
+                            id="modalbtn"
-                        id="modalbtn"
+                            ref="modalButtonMain"
-                        ref="modalButtonMain"
+                            loaderColor="white"
-                        loaderColor="white"
+                            :buttonText="footerButtonText"
-                        :buttonText="footerButtonText"
+                            @click-event="validateAndEmit"
-                        @click-event="validateAndEmit"
+                            :class="isFooterButtonDisabled && 'form-test-invalid'" />
-                        :class="isFooterButtonDisabled && 'form-test-invalid'" />
+                    </div>
                 </div>
             </div>
         </div>
@@ -53,6 +53,7 @@ export default {
     props: {
         headerText: String,
         footerButtonText: String,
+        suppressPageScroll: Boolean,
         onModalOpenedCallback: {
             type: Function,
         },
@@ -107,8 +108,10 @@ export default {
         onModalClosed() {
             this.resetButtonStyle();
             this.onModalClosedCallback?.();
+            if (this.suppressPageScroll) document.querySelector("body").classList.remove("prevent-modal-scroll");
         },
         openModal() {
+            if (this.suppressPageScroll) document.querySelector("body").classList.add("prevent-modal-scroll");
             const modal = Modal.getOrCreateInstance(document.getElementById(this.modalId));
             modal.show();
             this.$emit("isModalOpened", true);
@@ -231,6 +234,29 @@ export default {
         }
     }
 }
+.save-progress-modal-question {
+    p.modal-body {
+        padding: 0;
+    }
+    .modal-body {
+        display: flex;
+        flex-direction: column;
+        .textbox-question {
+            padding: .25rem 0;
+            label {
+                text-align: left;
+                font-weight: 600;
+            }
+        }
+    }
+    .modal-disclaimer {
+        font-size: .75rem;
+        order: 2;
+    }
+    .modal-footer {
+        padding: 1.5rem 0;
+    }
+}
 body {
     .modal-backdrop {
         height: 100%;

src/fmg-components/layouts/questions-page-layout/questions-page-layout.vue

@@ -25,7 +25,7 @@
                 </div>
             </div>
             <div class="row justify-content-center">
-                <div class="col-md-6 col-xl-4">
+                <div class="col-md-6 col-xl-4 question-chain-wrapper">
                     <div v-for="(questionsDatum, i) in questionsData" :key="questionsDatum.key">
                         <questionChain
                             ref="questionChain"
@@ -37,6 +37,8 @@
                             :validationRules="validationRules" />
                     </div>
 
+                    <slot></slot>
+
                     <navbar
                         ref="navbar"
                         cmsWidgetName="FunnelFooterWidget"
@@ -112,5 +114,13 @@ export default {
             text-align: left;
         }
     }
+    .question-chain-wrapper {
+        display: flex;
+        flex-direction: column;
+
+        .nav-bar {
+            order: 1;
+        }
+    }
 }
 </style>

src/fmg-components/save-progress-modal-question/save-progress-modal-question.spec.js

@@ -0,0 +1,51 @@
+import { mount, shallowMount } from "@vue/test-utils";
+import saveProgressModalQuestion from "./save-progress-modal-question";
+import { getMountOptions } from "@/helpers/unit-test-helper.js";
+
+jest.mock("@/digital-components/modal/modal", () => ({
+    methods: {
+        openModal: jest.fn(),
+        resetButtonStyle: jest.fn(),
+    },
+}));
+
+describe("save-progress-modal-question ", () => {
+    describe("when openModal is run ", () => {
+        test("the modal should open ", () => {
+            // Arrange
+            const { wrapper } = setupMocks({
+                props: {
+                    modelValue: "",
+                    modalWidgetName: "testModal",
+                },
+            });
+
+            // Act
+            wrapper.vm.openModal();
+
+            // Assert
+            expect(wrapper.vm.modal).not.toBeNull();
+        });
+    });
+});
+
+function setupMocks({ options, props }) {
+    const mountOptions = getMountOptions({
+        ...options,
+    });
+
+    const mockBaseMixin = {
+        methods: {
+            getCmsContent: jest.fn(),
+            dispatchStoreAction: jest.fn(),
+        },
+    };
+
+    if (props) mountOptions.propsData = props;
+
+    mountOptions.global.mixins = [mockBaseMixin];
+
+    const wrapper = mount(saveProgressModalQuestion, mountOptions);
+
+    return { wrapper };
+}

src/fmg-components/save-progress-modal-question/save-progress-modal-question.vue

@@ -0,0 +1,191 @@
+<template>
+    <div class="save-progress-modal-question">
+        <buttonMain
+            ref="buttonMain"
+            v-if="!isProgressSaved"
+            :buttonText="buttonText"
+            loaderColor="white"
+            :suppressLoader="true"
+            @click-event="openModal" />
+        <alert
+            class="my-4"
+            v-else
+            cmsWidgetName="SaveProgressModalAlertWidget"
+            alertClass="alert-success" />
+        <modal
+            :ref="modalName"
+            :headerText="modalHeaderText"
+            suppressPageScroll
+            :footerButtonText="modalButtonText"
+            @footer-button-event="saveProgress">
+            <p class="modal-body">{{ modalBodyText }}</p>
+            <saveProgressQuestion
+                ref="saveProgressQuestion"
+                v-model="userInput"
+                cmsWidgetName="SaveProgressQuestionWidget" />
+            <p class="modal-disclaimer" v-html="modalDisclaimerText"></p>
+        </modal>
+    </div>
+</template>
+
+<script>
+import saveProgressQuestion from "@/fmg-components/save-progress-modal-question/save-progress-question/save-progress-question";
+import modal from "@/digital-components/modal/modal";
+import { storeActions } from "@/constants/store-actions.js";
+import buttonMain from "@/ux-components/button-main/button-main";
+import alert from "@/ux-components/alert/alert";
+
+export default {
+    name: "save-progress-modal-question",
+
+    data() {
+        return {
+            userInput: "",
+            isProgressSaved: false,
+        };
+    },
+    props: {
+        modelValue: Object,
+        modalWidgetName: String,
+        pageName: String,
+    },
+    computed: {
+        buttonText() {
+            return this.getCmsContent(this.modalWidgetName, "SubheaderText");
+        },
+        modalHeaderText() {
+            return this.getCmsContent(this.modalWidgetName, "HeaderText");
+        },
+        modalBodyText() {
+            return this.getCmsContent(this.modalWidgetName, "BodyText");
+        },
+        modalButtonText() {
+            return this.getCmsContent(this.modalWidgetName, "FooterText");
+        },
+        modalDisclaimerText() {
+            return this.getCmsContent(this.modalWidgetName, "FooterText2");
+        },
+        modalName() {
+            return this.modalWidgetName;
+        },
+        modal() {
+            return this.$refs[this.modalName];
+        },
+    },
+    methods: {
+        openModal() {
+            this.modal.openModal();
+            this.modal.resetButtonStyle();
+        },
+        async saveProgress() {
+            // save email address to store
+            await this.dispatchStoreAction(storeActions.SAVE_EMAIL, this.userInput, false);
+
+            // hide save progress button; show success message alert
+            this.isProgressSaved = true;
+
+            this.modal.closeModal();
+
+            // send store call to send to new API (that triggers an email send)
+            this.$emit("save-progress");
+        },
+    },
+
+    components: {
+        modal,
+        buttonMain,
+        saveProgressQuestion,
+        alert,
+    },
+};
+</script>
+
+<style lang="scss" scoped>
+.save-progress-modal-question {
+    order: 2;
+    .btn-secondary {
+        position: relative;
+        background: $blue-100;
+        border: 1px solid transparent;
+        border-radius: $border-radius-lg;
+        color: $blue;
+        font-weight: 500;
+        font-size: .875rem;
+        transition: all 150ms linear;
+        height: 3.5rem;
+        width: 100%;
+        text-decoration: underline;
+        text-underline-offset: .5rem;
+        &:hover {
+            background: linear-gradient(270deg, $blue 0%, $blue-800 100%);
+            color: $white;
+        }
+        &:focus, // Mouse, touch, stylus focus
+    &:focus-visible {
+            // Keyboard focus for accessibility
+            outline: none;
+            box-shadow:
+                0 0 0 3px $white,
+                0 0 0 5.5px $blue-700;
+            color: $white;
+            background: linear-gradient(270deg, rgba(6, 87, 124, 1) 0%, rgba(6, 87, 124, 1) 100%);
+        }
+        &:disabled {
+            background: transparent;
+            color: $gray-550 !important;
+            font-weight: 400;
+            height: 48px;
+            border: 1px solid $gray-550;
+            border-radius: $border-radius-lg;
+            cursor: pointer;
+            pointer-events: all;
+        }
+        &.has-loader {
+            color: $blue;
+            background-color: $blue;
+            pointer-events: none;
+        }
+        &.delay {
+            // fixes flicker while transitioning between states
+            transition: background 0s 0s ease-in-out;
+        }
+    }
+    :deep(.alert) {
+        border-radius: $border-radius-lg;
+        border: 1px solid $green;
+    }
+    :deep(.alert-heading) {
+        position: relative;
+        font-weight: 600;
+        font-size: 1rem;
+        color: $black;
+        text-align: left;
+        padding-left: 1.5rem;
+        &::before {
+            position: absolute;
+            content: "";
+            background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 16 16'%3E%3Cpath fill='%230C7E47' d='M8 0a8 8 0 1 0 0 16A8 8 0 0 0 8 0Zm3.7 6.171-4.449 4.45a.559.559 0 0 1-.8 0l-2.16-2.16a.563.563 0 0 1 .792-.8l1.76 1.76 4.066-4.042a.563.563 0 1 1 .792.8v-.008Z'/%3E%3C/svg%3E");
+            width: 1rem;
+            height: 1rem;
+            top: 6px;
+            left: 0;
+        }
+    }
+}
+.applied-promo {
+    font-size: 0.875rem;
+    font-weight: 500;
+    line-height: 24px;
+    color: $green;
+
+    .promo-code {
+        text-transform: uppercase;
+    }
+}
+.alert {
+    color: $red;
+    font-size: 0.875rem;
+    font-weight: 500;
+    line-height: 24px;
+}
+</style>

src/fmg-components/save-progress-modal-question/save-progress-question/save-progress-question.spec.js

@@ -0,0 +1,40 @@
+import { shallowMount } from "@vue/test-utils";
+import saveProgressQuestion from "./save-progress-question";
+
+describe("save-progress-question.vue", () => {
+    it("Should get the modelValue", async () => {
+        // Arrange
+        const text = "test";
+        const wrapper = shallowMount(saveProgressQuestion, {
+            props: {
+                modelValue: text,
+            },
+            attachTo: document.body,
+        });
+
+        // Act
+        const modelValueText = wrapper.vm.value;
+        wrapper.vm.value = "test also";
+
+        // Assert
+        expect(modelValueText).toEqual("test");
+    });
+
+    it("Should emit to set value", async () => {
+        // Arrange
+        const text = "test";
+        const wrapper = shallowMount(saveProgressQuestion, {
+            props: {
+                modelValue: text,
+            },
+            attachTo: document.body,
+        });
+
+        // Act
+        const modelValueText = wrapper.vm.value;
+        wrapper.vm.value = "test also";
+
+        // Assert
+        expect(wrapper.emitted("update:modelValue")).toEqual([["test also"]]);
+    });
+});

src/fmg-components/save-progress-modal-question/save-progress-question/save-progress-question.vue

@@ -0,0 +1,62 @@
+<template>
+    <textboxQuestion
+        ref="saveProgressInputTextQuestion"
+        :cmsWidgetName="cmsWidgetName"
+        v-model="value"
+        inputId="saveProgressUserInput"
+        questionAlignment="center"
+        cornerStyle="rounded"
+        :displayQuestionText="true"
+        isRequired
+        @input="validateEmail"
+        validationRules="email-address-required|email-address-format" />
+</template>
+
+<script>
+import textboxQuestion from "@/digital-components/textbox-question/textbox-question";
+
+//Supporting Files
+import { defineRule } from "vee-validate";
+import { required, regex } from "@/helpers/validation-rules";
+import { errorMessages } from "@/constants/error-messages";
+
+// Define Validation Rules
+defineRule("email-address-required", required(errorMessages.EMAIL_ADDRESS_REQUIRED));
+defineRule(
+    "email-address-format",
+    regex(
+        /^([a-zA-Z0-9_\-.+]+)@([a-zA-Z0-9-]+)\.([a-zA-Z]{2,})$/,
+        errorMessages.EMAIL_ADDRESS_FORMAT
+    )
+);
+
+const EMAIL_REGEX = /[^a-zA-Z0-9_\-.+@]/g;
+
+export default {
+    name: "save-progress-question",
+    props: {
+        modelValue: String,
+        cmsWidgetName: String,
+    },
+    computed: {
+        value: {
+            get: function () {
+                return this.modelValue;
+            },
+            set: function (newValue) {
+                this.$emit("update:modelValue", newValue);
+            },
+        },
+    },
+    methods: {
+        validateEmail() {
+            setTimeout(() => {
+                this.value = this.value.replace(EMAIL_REGEX, "");
+            });
+        },
+    },
+    components: {
+        textboxQuestion,
+    },
+};
+</script>

src/layouts/capability-questions/capability-questions.vue

@@ -12,13 +12,22 @@
             @forwardButtonAction="forwardButtonAction"
             @back-click="navigateBack"
             :key="currentGlassIndex"
-            :index="currentGlassIndex" />
+            :index="currentGlassIndex">
+            
+            <!-- save progress goes into <slot> on questions-page-layout -->
+            <saveProgressModalQuestion 
+                modalWidgetName="SaveProgressModalWidget"
+                v-if="!isEmailInStoreOnPageLoad"
+                @save-progress="saveProgress" />
+
+        </questions-page-layout>
     </Form>
 </template>
 
 <script>
 // Components
 import questionsPageLayout from "@/fmg-components/layouts/questions-page-layout/questions-page-layout";
+import saveProgressModalQuestion from "@/fmg-components/save-progress-modal-question/save-progress-modal-question";
 
 // Supporting Files
 import { fetchCmsContentForPage } from "@/helpers/cms-content-helper";
@@ -31,6 +40,7 @@ import { required } from "@/helpers/validation-rules";
 import { errorMessages } from "@/constants/error-messages";
 import vehicleQuestionsMixin from "@/mixins/vehicle-questions-mixin";
 import baseMixin from "@/mixins/base-mixin.js";
+import { saveQuote } from "@/helpers/heritage-integration/order-helper.js";
 
 // DEFINE VALIDATION RULES
 defineRule("questions-required", required(errorMessages.OPTION_REQUIRED));
@@ -52,9 +62,12 @@ export default {
 
         const resultMap = await settleAllPromises(promiseResultMap);
 
+        const emailFromStore = store.getters.order.customer.emailAddress;
+
         // Call the "next" function to complete the transition to this page.
         next(async (vm) => {
             vm.setCmsContent(resultMap.cmsContent);
+            vm.isEmailInStoreOnPageLoad = emailFromStore?.length > 0;
             if (store.getters.externalParameterState?.isExternalParameter) {
                 if (store.getters.externalParameterServiceZip.zipCode) {
                     await baseMixin.methods.dispatchStoreAction(
@@ -76,6 +89,7 @@ export default {
             questionsData: null,
             selectedAnswers: {},
             currentGlassIndex: 0,
+            isEmailInStoreOnPageLoad: null,
         };
     },
     computed: {
@@ -145,6 +159,9 @@ export default {
                 this.questionsData
             );
         },
+        saveProgress() {
+            saveQuote({ pageNameToLog: "capability-questions" });
+        },
         async forwardButtonAction() {
             const questionAnswersArray = this.questionsData.map((glass) => {
                 // get answerResult2 of returned answer
@@ -205,6 +222,7 @@ export default {
     components: {
         Form,
         questionsPageLayout,
+        saveProgressModalQuestion,
     },
 };
 </script>

src/layouts/molding-questions/molding-questions.vue

@@ -12,13 +12,22 @@
             @forwardButtonAction="forwardButtonAction"
             @back-click="navigateBack"
             :key="currentGlassIndex"
-            :index="currentGlassIndex" />
+            :index="currentGlassIndex">
+            
+            <!-- save progress goes into <slot> on questions-page-layout -->
+            <saveProgressModalQuestion 
+                modalWidgetName="SaveProgressModalWidget"
+                v-if="!isEmailInStoreOnPageLoad"
+                @save-progress="saveProgress" />
+
+        </questions-page-layout>
     </Form>
 </template>
 
 <script>
 // Components
 import questionsPageLayout from "@/fmg-components/layouts/questions-page-layout/questions-page-layout";
+import saveProgressModalQuestion from "@/fmg-components/save-progress-modal-question/save-progress-modal-question";
 
 // Supporting Files
 import { fetchCmsContentForPage } from "@/helpers/cms-content-helper";
@@ -31,6 +40,7 @@ import { required } from "@/helpers/validation-rules";
 import { errorMessages } from "@/constants/error-messages";
 import vehicleQuestionsMixin from "@/mixins/vehicle-questions-mixin";
 import baseMixin from "@/mixins/base-mixin.js";
+import { saveQuote } from "@/helpers/heritage-integration/order-helper.js";
 
 // DEFINE VALIDATION RULES
 defineRule("questions-required", required(errorMessages.OPTION_REQUIRED));
@@ -52,9 +62,12 @@ export default {
 
         const resultMap = await settleAllPromises(promiseResultMap);
 
+        const emailFromStore = store.getters.order.customer.emailAddress;
+
         // Call the "next" function to complete the transition to this page.
         next(async (vm) => {
             vm.setCmsContent(resultMap.cmsContent);
+            vm.isEmailInStoreOnPageLoad = emailFromStore?.length > 0;
             if (store.getters.externalParameterState?.isExternalParameter) {
                 if (store.getters.externalParameterServiceZip.zipCode) {
                     await baseMixin.methods.dispatchStoreAction(
@@ -77,6 +90,7 @@ export default {
             questionsData: null,
             selectedAnswers: {},
             currentGlassIndex: 0,
+            isEmailInStoreOnPageLoad: null,
         };
     },
     computed: {
@@ -145,6 +159,9 @@ export default {
                 this.questionsData
             );
         },
+        saveProgress() {
+            saveQuote({ pageNameToLog: "molding-questions" });
+        },
         async forwardButtonAction() {
             const questionAnswersArray = this.questionsData.map((glass) => {
                 return {
@@ -189,6 +206,7 @@ export default {
     components: {
         Form,
         questionsPageLayout,
+        saveProgressModalQuestion,
     },
 };
 </script>

src/layouts/part-questions/part-questions.vue

@@ -12,13 +12,22 @@
             @forwardButtonAction="forwardButtonAction"
             @back-click="navigateBack"
             :key="currentGlassIndex"
-            :index="currentGlassIndex" />
+            :index="currentGlassIndex">
+            
+            <!-- save progress goes into <slot> on questions-page-layout -->
+            <saveProgressModalQuestion 
+                modalWidgetName="SaveProgressModalWidget"
+                v-if="!isEmailInStoreOnPageLoad"
+                @save-progress="saveProgress" />
+
+        </questions-page-layout>
     </Form>
 </template>
 
 <script>
 // Components
 import questionsPageLayout from "@/fmg-components/layouts/questions-page-layout/questions-page-layout";
+import saveProgressModalQuestion from "@/fmg-components/save-progress-modal-question/save-progress-modal-question";
 
 // Supporting Files
 import { fetchCmsContentForPage } from "@/helpers/cms-content-helper";
@@ -31,6 +40,7 @@ import { required } from "@/helpers/validation-rules";
 import { errorMessages } from "@/constants/error-messages";
 import vehicleQuestionsMixin from "@/mixins/vehicle-questions-mixin";
 import baseMixin from "@/mixins/base-mixin.js";
+import { saveQuote } from "@/helpers/heritage-integration/order-helper.js";
 
 // DEFINE VALIDATION RULES
 defineRule("questions-required", required(errorMessages.OPTION_REQUIRED));
@@ -52,9 +62,12 @@ export default {
 
         const resultMap = await settleAllPromises(promiseResultMap);
 
+        const emailFromStore = store.getters.order.customer.emailAddress;
+
         // Call the "next" function to complete the transition to this page.
         next(async (vm) => {
             vm.setCmsContent(resultMap.cmsContent);
+            vm.isEmailInStoreOnPageLoad = emailFromStore?.length > 0;
             if (store.getters.externalParameterState?.isExternalParameter) {
                 if (store.getters.externalParameterServiceZip.zipCode) {
                     const serviceState = store.getters.order.serviceLocation.state;
@@ -78,6 +91,7 @@ export default {
             questionsData: null,
             selectedAnswers: {},
             currentGlassIndex: 0,
+            isEmailInStoreOnPageLoad: null,
         };
     },
     computed: {
@@ -144,6 +158,9 @@ export default {
                 this.questionsData
             );
         },
+        saveProgress() {
+            saveQuote({ pageNameToLog: "part-questions" });
+        },
         async forwardButtonAction() {
             const questionAnswersArray = this.questionsData.map((glass) => {
                 return {
@@ -185,6 +202,7 @@ export default {
     components: {
         Form,
         questionsPageLayout,
+        saveProgressModalQuestion,
     },
 };
 </script>

src/styles/common-styles.scss

@@ -77,7 +77,7 @@ body {
         }
     }
 }
-.modal-open {
+.modal-open:not(.prevent-modal-scroll) {
     .container-fluid {
         &.page-container-grouped-styles {
             overflow: hidden;

src/ux-components/button-main/button-main.vue

@@ -5,7 +5,7 @@
         :class="[
             isPrimary ? 'btn-primary' : 'btn-secondary',
             isFloat ? 'float-end' : '',
-            isLoaderDisplayed ? 'has-loader' : '',
+            (isLoaderDisplayed && !suppressLoader) ? 'has-loader' : '',
         ]"
         @click="clicked">
         <span class="m-0">{{ this.buttonText }}</span>
@@ -47,7 +47,7 @@ export default {
                 true
             );
             if (!this.isDisabled) {
-                this.isLoaderDisplayed = true;
+                if (!this.suppressLoader) this.isLoaderDisplayed = true;
                 this.$emit("click-event");
             }
         },