AC-2626: Migrate from jquery/jquery-cookie to js-cookie/js-cookie

Author: andrewbess

app/code/Magento/Cookie/view/base/web/js/jquery.storageapi.extended.js

@@ -5,7 +5,7 @@
 
 define([
     'jquery',
-    'jquery/jquery.cookie',
+    'js-cookie/cookie-wrapper',
     'jquery/jquery.storageapi.min'
 ], function ($) {
     'use strict';

app/code/Magento/Theme/view/base/requirejs-config.js

@@ -47,7 +47,8 @@ var config = {
             'jquery-ui-modules/widget': 'jquery/ui-modules/widget',
             'jquery-ui-modules/timepicker': 'jquery/timepicker',
             'vimeo': 'vimeo/player',
-            'vimeoWrapper': 'vimeo/vimeo-wrapper'
+            'vimeoWrapper': 'vimeo/vimeo-wrapper',
+            'jquery/jquery.cookie': 'js-cookie/cookie-wrapper'
         }
     },
     shim: {

lib/web/jquery/jquery.cookie.js

@@ -0,0 +1,51 @@
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+define([
+    'jquery',
+    'js-cookie/js.cookie'
+], function ($, cookie) {
+    'use strict';
+
+    var config = $.cookie = function (key, value, options) {
+        if (value !== undefined) {
+            options = $.extend({}, config.defaults, options);
+
+            return cookie.set(key, value, options);
+        }
+
+        var result = key ? undefined : {},
+            cookies = document.cookie ? document.cookie.split('; ') : [],
+            i;
+
+        for (i = 0; i < cookies.length; i++) {
+            var parts = cookies[i].split('='),
+                name = config.raw ? parts.shift() : decodeURIComponent(parts.shift()),
+                cookieValue = parts.join('=');
+
+            if (key && key === name) {
+                result = decodeURIComponent(cookieValue.replace('/\\+/g', ' '));
+                break;
+            }
+
+            if (!key && (cookieValue = decodeURIComponent(cookieValue.replace('/\\+/g', ' '))) !== undefined) {
+                result[name] = cookieValue;
+            }
+        }
+
+        return result;
+    }
+
+    config.defaults = {};
+
+    $.removeCookie = function (key, options) {
+        if ($.cookie(key) === undefined) {
+            return false;
+        }
+
+        $.cookie(key, '', $.extend({}, options, { expires: -1 }));
+        return !$.cookie(key);
+    };
+});

lib/web/js-cookie/cookie-wrapper.js

@@ -0,0 +1,147 @@
+/*! js-cookie v3.0.1 | MIT */
+;
+(function (global, factory) {
+    typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory() :
+        typeof define === 'function' && define.amd ? define(factory) :
+            (global = global || self, (function () {
+                var current = global.Cookies;
+                var exports = global.Cookies = factory();
+                exports.noConflict = function () { global.Cookies = current; return exports; };
+            }()));
+}(this, (function () { 'use strict';
+
+    /* eslint-disable no-var */
+    function assign (target) {
+        for (var i = 1; i < arguments.length; i++) {
+            var source = arguments[i];
+            for (var key in source) {
+                target[key] = source[key];
+            }
+        }
+        return target
+    }
+    /* eslint-enable no-var */
+
+    /* eslint-disable no-var */
+    var defaultConverter = {
+        read: function (value) {
+            if (value[0] === '"') {
+                value = value.slice(1, -1);
+            }
+            return value.replace(/(%[\dA-F]{2})+/gi, decodeURIComponent)
+        },
+        write: function (value) {
+            return encodeURIComponent(value).replace(
+                /%(2[346BF]|3[AC-F]|40|5[BDE]|60|7[BCD])/g,
+                decodeURIComponent
+            )
+        }
+    };
+    /* eslint-enable no-var */
+
+    /* eslint-disable no-var */
+
+    function init (converter, defaultAttributes) {
+        function set (key, value, attributes) {
+            if (typeof document === 'undefined') {
+                return
+            }
+
+            attributes = assign({}, defaultAttributes, attributes);
+
+            if (typeof attributes.expires === 'number') {
+                attributes.expires = new Date(Date.now() + attributes.expires * 864e5);
+            }
+            if (attributes.expires) {
+                attributes.expires = attributes.expires.toUTCString();
+            }
+
+            key = encodeURIComponent(key)
+                .replace(/%(2[346B]|5E|60|7C)/g, decodeURIComponent)
+                .replace(/[()]/g, escape);
+
+            var stringifiedAttributes = '';
+            for (var attributeName in attributes) {
+                if (!attributes[attributeName]) {
+                    continue
+                }
+
+                stringifiedAttributes += '; ' + attributeName;
+
+                if (attributes[attributeName] === true) {
+                    continue
+                }
+
+                // Considers RFC 6265 section 5.2:
+                // ...
+                // 3.  If the remaining unparsed-attributes contains a %x3B (";")
+                //     character:
+                // Consume the characters of the unparsed-attributes up to,
+                // not including, the first %x3B (";") character.
+                // ...
+                stringifiedAttributes += '=' + attributes[attributeName].split(';')[0];
+            }
+
+            return (document.cookie =
+                key + '=' + converter.write(value, key) + stringifiedAttributes)
+        }
+
+        function get (key) {
+            if (typeof document === 'undefined' || (arguments.length && !key)) {
+                return
+            }
+
+            // To prevent the for loop in the first place assign an empty array
+            // in case there are no cookies at all.
+            var cookies = document.cookie ? document.cookie.split('; ') : [];
+            var jar = {};
+            for (var i = 0; i < cookies.length; i++) {
+                var parts = cookies[i].split('=');
+                var value = parts.slice(1).join('=');
+
+                try {
+                    var foundKey = decodeURIComponent(parts[0]);
+                    jar[foundKey] = converter.read(value, foundKey);
+
+                    if (key === foundKey) {
+                        break
+                    }
+                } catch (e) {}
+            }
+
+            return key ? jar[key] : jar
+        }
+
+        return Object.create(
+            {
+                set: set,
+                get: get,
+                remove: function (key, attributes) {
+                    set(
+                        key,
+                        '',
+                        assign({}, attributes, {
+                            expires: -1
+                        })
+                    );
+                },
+                withAttributes: function (attributes) {
+                    return init(this.converter, assign({}, this.attributes, attributes))
+                },
+                withConverter: function (converter) {
+                    return init(assign({}, this.converter, converter), this.attributes)
+                }
+            },
+            {
+                attributes: { value: Object.freeze(defaultAttributes) },
+                converter: { value: Object.freeze(converter) }
+            }
+        )
+    }
+
+    var api = init(defaultConverter, { path: '/' });
+    /* eslint-enable no-var */
+
+    return api;
+
+})));

lib/web/js-cookie/js.cookie.js

@@ -6,7 +6,7 @@
 define([
     'jquery',
     'mage/mage',
-    'jquery/jquery.cookie'
+    'js-cookie/cookie-wrapper'
 ], function ($) {
     'use strict';