Merge pull request #18158 from craftcms/chore/cookie-name-tweak

Use periods instead of colons in cookie names

Author: brandonkelly

CHANGELOG-WIP.md

@@ -139,6 +139,7 @@
 - Improved element index performance. ([#17557](https://github.com/craftcms/cms/pull/17557))
 - Improved element query performance. ([#17850](https://github.com/craftcms/cms/pull/17850))
 - Reduced the number of queries executed when working with nested entries, addresses, and content blocks. ([#18142](https://github.com/craftcms/cms/issues/18142))
+- Session-based cookies no longer use colons (`:`) in their names. ([#18158](https://github.com/craftcms/cms/pull/18158))
 - Fixed a bug where elements with unsaved changes could show outdated attribute/field values within element index tables, chips, and cards throughout the control panel. ([#17915](https://github.com/craftcms/cms/pull/17915))
 - Fixed a bug where Table fields with the “Static Rows” setting enabled would lose track of which values belonged to which row headings, if the “Default Values” table was reordered. ([#17090](https://github.com/craftcms/cms/issues/17090))
 - Fixed a bug where requests with invalid tokens would throw an exception before the application was fully initialized, which could lead to other errors. ([#18000](https://github.com/craftcms/cms/issues/18000))

src/templates/_elements/sources.twig

@@ -88,7 +88,7 @@
                     {% if source.heading | length %}
                         {% embed '_includes/disclosure-toggle' with {
                             persist: true,
-                            storageKey: 'sources-list:' ~ key,
+                            storageKey: 'sources-list.' ~ key,
                             controls: sourceId,
                             attributes: {
                                 class: 'source-item__toggle'
@@ -120,7 +120,7 @@
                     {% if source.nested is defined and source.nested is not empty %}
                         {% embed '_includes/disclosure-toggle' with {
                             persist: true,
-                            storageKey: 'sources-list:'~ key,
+                            storageKey: 'sources-list.'~ key,
                             controls: key,
                             attributes: {
                                 class: 'source-item__toggle'

src/templates/_includes/disclosure-toggle.twig

@@ -9,7 +9,7 @@
 
 {% set cookieState = null %}
 {% if persist and storageMode == 'cookies' and storageKey %}
-    {% set cookieState = storageKey ? craft.app.request.rawCookies.value('Craft-' ~ craft.app.systemUid ~  ':' ~ storageKey) : null %}
+    {% set cookieState = storageKey ? craft.app.request.rawCookies.value("Craft-#{craft.app.systemUid}.#{storageKey}") : null %}
 {% endif %}
 
 {% set state = state ?? cookieState %}

src/templates/_layouts/cp.twig

@@ -327,7 +327,7 @@ history.replaceState(undefined, undefined, window.location.href.match(/^[^#]*/)[
                             </div><!-- #content-container -->
 
                             {% if details is not empty %}
-                                <div id="details-container" tabindex="-1" data-state="{{  craft.app.request.rawCookies.value('Craft-' ~ craft.app.systemUid ~  ':sidebar-details')}}">
+                                <div id="details-container" tabindex="-1" data-state="{{  craft.app.request.rawCookies.value("Craft-#{craft.app.systemUid}.sidebar-details")}}">
                                     <div id="details">
                                         <div class="details">
                                             {{ details|raw }}

src/web/assets/cp/dist/cp.js

@@ -2388,7 +2388,7 @@ $.extend(Craft, {
     // Adapted from https://developer.mozilla.org/en-US/docs/Web/API/Document/cookie
     return document.cookie.replace(
       new RegExp(
-        `(?:(?:^|.*;\\s*)Craft-${Craft.systemUid}:${name}\\s*\\=\\s*([^;]*).*$)|^.*$`
+        `(?:(?:^|.*;\\s*)Craft-${Craft.systemUid}.${name}\\s*\\=\\s*([^;]*).*$)|^.*$`
       ),
       '$1'
     );
@@ -2410,7 +2410,7 @@ $.extend(Craft, {
    */
   setCookie: function (name, value, options) {
     options = $.extend({}, this.defaultCookieOptions, options);
-    let cookie = `Craft-${Craft.systemUid}:${name}=${encodeURIComponent(
+    let cookie = `Craft-${Craft.systemUid}.${name}=${encodeURIComponent(
       value
     )}`;
     if (options.path) {