add disconnect and sync options for clear/cart

CHANGELOG.md

@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix hiding overlay for newsletter modal - @gibkigonzo (#3970)
 - Fix problem with storeView as dependency in filters - @gibkigonzo (#3968)
 - Fix v-model not working in BaseRadioButton - @lukeromanowicz (#4035)
+- add disconnect and sync options for clear/cart - @gibkigonzo (#4062)
 
 ## [1.10.5] - 28.11.2019
 

core/modules/cart/store/actions.ts

@@ -135,11 +135,21 @@ const actions: ActionTree<CartState, RootState> = {
   async disconnect ({ commit }) {
     commit(types.CART_LOAD_CART_SERVER_TOKEN, null)
   },
-  /** Clear the cart content */
-  async clear ({ commit, dispatch, getters }) {
+  /**
+   * It will always clear cart items on frontend.
+   * Options:
+   * sync - if you want to sync it with backend.
+   * disconnect - if you want to clear cart token.
+   */
+  async clear ({ commit, dispatch }, { disconnect = true, sync = true } = {}) {
     await commit(types.CART_LOAD_CART, [])
-    await commit(types.CART_LOAD_CART_SERVER_TOKEN, null)
-    await commit(types.CART_SET_ITEMS_HASH, null)
+    if (sync) {
+      await dispatch('sync', { forceClientState: true })
+    }
+    if (disconnect) {
+      await commit(types.CART_SET_ITEMS_HASH, null)
+      await dispatch('disconnect')
+    }
   },
   /** Refresh the payment methods with the backend */
   async syncPaymentMethods ({ getters, rootGetters, dispatch }, { forceServerSync = false }) {

core/modules/cart/test/unit/store/actions.spec.ts

@@ -74,6 +74,7 @@ describe('Cart actions', () => {
   it('clear deletes all cart products and token', async () => {
     const contextMock = {
       commit: jest.fn(),
+      dispatch: jest.fn(),
       getters: { isCartSyncEnabled: false }
     };
     const wrapper = (actions: any) => actions.clear(contextMock);
@@ -82,7 +83,43 @@ describe('Cart actions', () => {
 
     await wrapper(cartActions);
 
-    expect(contextMock.commit).toBeCalledWith(types.CART_LOAD_CART, []);
+    expect(contextMock.commit).toHaveBeenNthCalledWith(1, types.CART_LOAD_CART, []);
+    expect(contextMock.dispatch).toHaveBeenNthCalledWith(1, 'sync', { forceClientState: true });
+    expect(contextMock.commit).toHaveBeenNthCalledWith(2, types.CART_SET_ITEMS_HASH, null);
+    expect(contextMock.dispatch).toHaveBeenNthCalledWith(2, 'disconnect');
+  });
+
+  it('clear deletes all cart products but keep token', async () => {
+    const contextMock = {
+      commit: jest.fn(),
+      dispatch: jest.fn(),
+      getters: { isCartSyncEnabled: false }
+    };
+    const wrapper = (actions: any) => actions.clear(contextMock, { disconnect: false });
+
+    config.cart = { synchronize: false };
+
+    await wrapper(cartActions);
+
+    expect(contextMock.commit).toHaveBeenNthCalledWith(1, types.CART_LOAD_CART, []);
+    expect(contextMock.dispatch).toHaveBeenNthCalledWith(1, 'sync', { forceClientState: true });
+  });
+
+  it('clear deletes all cart products and token, but not sync with backend', async () => {
+    const contextMock = {
+      commit: jest.fn(),
+      dispatch: jest.fn(),
+      getters: { isCartSyncEnabled: false }
+    };
+    const wrapper = (actions: any) => actions.clear(contextMock, { sync: false });
+
+    config.cart = { synchronize: false };
+
+    await wrapper(cartActions);
+
+    expect(contextMock.commit).toHaveBeenNthCalledWith(1, types.CART_LOAD_CART, []);
+    expect(contextMock.commit).toHaveBeenNthCalledWith(2, types.CART_SET_ITEMS_HASH, null);
+    expect(contextMock.dispatch).toHaveBeenNthCalledWith(1, 'disconnect');
   });
 
   describe('create', () => {

core/modules/checkout/store/checkout/actions.ts

@@ -16,7 +16,8 @@ const actions: ActionTree<CheckoutState, RootState> = {
       const result = await dispatch('order/placeOrder', order, {root: true})
       if (!result.resultCode || result.resultCode === 200) {
         Vue.prototype.$db.usersCollection.setItem('last-cart-bypass-ts', new Date().getTime())
-        await dispatch('cart/clear', null, {root: true})
+        // clear cart without sync, because after order cart will be already cleared on backend
+        await dispatch('cart/clear', { sync: false }, {root: true})
         if (state.personalDetails.createAccount) {
           commit(types.CHECKOUT_DROP_PASSWORD)
         }

core/modules/user/store/actions.ts

@@ -297,7 +297,9 @@ const actions: ActionTree<UserState, RootState> = {
     context.dispatch('cart/disconnect', {}, { root: true })
       .then(() => { context.dispatch('clearCurrentUser') })
       .then(() => { Vue.prototype.$bus.$emit('user-after-logout') })
-      .then(() => { context.dispatch('cart/clear', null, { root: true }) })
+      // clear cart without sync, because after logout we don't want to clear cart on backend
+      // user should have items when he comes back
+      .then(() => { context.dispatch('cart/clear', { sync: false }, { root: true }) })
     if (!silent) {
       rootStore.dispatch('notification/spawnNotification', {
         type: 'success',

src/modules/instant-checkout/components/InstantCheckout.vue

@@ -143,7 +143,8 @@ export default {
               this.$store.dispatch('checkout/setThankYouPage', true)
               this.$store.commit('ui/setMicrocart', false)
               this.$router.push(this.localizedRoute('/checkout'))
-              this.$store.dispatch('cart/clear', null, {root: true})
+              // clear cart without sync, because after order cart will be already cleared on backend
+              this.$store.dispatch('cart/clear', { sync: false }, {root: true})
             }
           })
         })

src/themes/default/components/core/blocks/Microcart/Microcart.vue

@@ -210,8 +210,9 @@ export default {
         action1: { label: i18n.t('Cancel'), action: 'close' },
         action2: { label: i18n.t('OK'),
           action: async () => {
-            await this.$store.dispatch('cart/clear') // just clear the items without sync
-            await this.$store.dispatch('cart/sync', { forceClientState: true })
+            // We just need to clear cart on frontend and backend.
+            // but cart token can be reused
+            await this.$store.dispatch('cart/clear', { disconnect: false })
           }
         },
         hasNoTimeout: true