ACP2E-1547: Persistent Shopping Cart results in an Invalid state change requested error in checkout

Author: Anna Bukatar

app/code/Magento/Checkout/view/frontend/web/js/model/quote.js

@@ -141,6 +141,13 @@ define([
             });
 
             return total;
+        },
+
+        /**
+         * @return {Boolean}
+         */
+        isPersistent: function () {
+            return !!Number(quoteData['is_persistent']);
         }
     };
 });

app/code/Magento/Checkout/view/frontend/web/js/model/shipping-rate-processor/new-address.js

@@ -52,8 +52,10 @@ define([
                 shippingService.setShippingRates(cache);
                 shippingService.isLoading(false);
             } else {
+                let async = quote.isPersistent() ? false : true;
+
                 storage.post(
-                    serviceUrl, payload, false
+                    serviceUrl, payload, false, 'application/json', {}, async
                 ).done(function (result) {
                     rateRegistry.set(address.getCacheKey(), result);
                     shippingService.setShippingRates(result);

dev/tests/js/jasmine/tests/app/code/Magento/Checkout/frontend/js/model/shipping-rate-processor/new-address.test.js

@@ -0,0 +1,105 @@
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+define([
+    'squire',
+    'jquery',
+    'ko'
+], function (Squire, $, ko) {
+    'use strict';
+
+    var injector = new Squire(),
+        mixin,
+        serviceUrl = 'rest/V1/guest-carts/estimate-shipping-methods',
+        mocks = {
+            'mage/storage': {
+                post: function () {} // jscs:ignore jsDoc
+            },
+            'Magento_Customer/js/customer-data': {
+                get: jasmine.createSpy().and.returnValue(
+                    ko.observable({
+                        'data_id': 1
+                    })
+                )
+            },
+            'Magento_Checkout/js/model/url-builder': {
+                createUrl: jasmine.createSpy().and.returnValue(serviceUrl)
+            }
+        };
+
+    describe('Magento_Checkout/js/model/shipping-rate-processor/new-address', function () {
+        beforeEach(function (done) {
+            window.checkoutConfig = {
+                'quoteData': {
+                    'is_persistent': '0'
+                }
+            };
+
+            injector.mock(mocks);
+            injector.require(['Magento_Checkout/js/model/shipping-rate-processor/new-address'], function (Mixin) {
+                mixin = Mixin;
+                done();
+            });
+        });
+
+        afterEach(function () {
+            try {
+                injector.clean();
+                injector.remove();
+            } catch (e) {}
+
+            delete window.checkoutConfig.quoteData.is_persistent;
+        });
+
+        it('Check that estimate-shipping-methods API is called synchronously for persistent cart', function () {
+            var deferral = new $.Deferred();
+
+            window.checkoutConfig.quoteData.is_persistent = '1';
+            spyOn(mocks['mage/storage'], 'post').and.callFake(function () {
+                return deferral.resolve({});
+            });
+
+            mixin.getRates({
+                /** Stub */
+                'getCacheKey': function () {
+                    return false;
+                }
+            });
+
+            expect(mocks['mage/storage'].post).toHaveBeenCalledWith(
+                serviceUrl,
+                '{"address":{}}',
+                false,
+                'application/json',
+                {},
+                false
+            );
+        });
+
+        it('Check that estimate-shipping-methods API is called asynchronously', function () {
+            var deferral = new $.Deferred();
+
+            spyOn(mocks['mage/storage'], 'post').and.callFake(function () {
+                return deferral.resolve({});
+            });
+
+            mixin.getRates({
+                /** Stub */
+                'getCacheKey': function () {
+                    return false;
+                }
+            });
+
+            expect(mocks['mage/storage'].post).toHaveBeenCalledWith(
+                serviceUrl,
+                '{"address":{}}',
+                false,
+                'application/json',
+                {},
+                true
+            );
+        });
+    });
+});

lib/web/mage/storage.js

@@ -36,20 +36,23 @@ define(['jquery', 'mage/url'], function ($, urlBuilder) {
          * @param {Boolean} global
          * @param {String} contentType
          * @param {Object} headers
+         * @param {Boolean} async
          * @returns {Deferred}
          */
-        post: function (url, data, global, contentType, headers) {
+        post: function (url, data, global, contentType, headers, async) {
             headers = headers || {};
             global = global === undefined ? true : global;
             contentType = contentType || 'application/json';
+            async = async === undefined ? true : async;
 
             return $.ajax({
                 url: urlBuilder.build(url),
                 type: 'POST',
                 data: data,
                 global: global,
                 contentType: contentType,
-                headers: headers
+                headers: headers,
+                async: async
             });
         },