Resources: set language-specific cacheCode, fixes AngularJS translation with multilingual

[mlutfy]

Overview

To reproduce:

• Enable another language (does not need to be multi-lingual, just multiple enabled locales)
• Under Admin>Debugging, enable asset caching.
• Go to an AngularJS page (with asset caching enabled) in English, such as the CiviCRM System Status, or the CiviCRM dashboard.
• Then switch languages, reload the AngularJS page

Result: the page will still be in English.

Example URL on dmaster, after adding French, and enabling asset-caching (dmaster does not enable it by default, because debugging is enabled):

• Go here: https://dmaster.demo.civicrm.org/civicrm/a/#/status
• Then change language: https://dmaster.demo.civicrm.org/civicrm/contact/view?reset=1&cid=203&lcMessages=fr_CA
• Then reload here: https://dmaster.demo.civicrm.org/civicrm/a/#/status

(because the core language switcher does not support AngularJS, fortunately the language-switcher extension does.)

Before

Pages are randomly translated:

After

Pages are always in the correct language.

Technical Details

My fix feels duct-tape-y. I don't know if it will cause other problems. Testing it in production for now. Opening the PR for discussion.

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[totten]

Oh, I like the general idea of incorporating the locale into the browser-side cache-busting code. It seems like it could make several kinds of resources more amenable to multilingual.

Applying the trick in this spot means it applies once - at the start of the page-request. These values might rotate during the page-request (e.g. if the cache-code needs to be expired/reset, or if the locale changes).

Haven't tested, but I think this might be more responsive:

diff --git a/CRM/Core/Resources.php b/CRM/Core/Resources.php
index 0175befd74..4e93411b04 100644
--- a/CRM/Core/Resources.php
+++ b/CRM/Core/Resources.php
@@ -334,9 +334,11 @@ class CRM_Core_Resources implements CRM_Core_Resources_CollectionAdderInterface
 
   /**
    * @return string
+   *   A random-looking string that may be appended to resource-URLs.
+   *   This should be URL-safe (ie use alphanumerics and underscores).
    */
   public function getCacheCode() {
-    return $this->cacheCode;
+    return $this->cacheCode . CRM_Core_I18n::getLocale();
   }
 
   /**
@@ -563,7 +565,7 @@ class CRM_Core_Resources implements CRM_Core_Resources_CollectionAdderInterface
     $hasQuery = strpos($url, '?') !== FALSE;
     $operator = $hasQuery ? '&' : '?';
 
-    return $url . $operator . 'r=' . $this->cacheCode;
+    return $url . $operator . 'r=' . $this->getCacheCode();
   }
 
   /**

[mlutfy]

Thanks Tim! I tested your suggestion and it works as well, and makes more sense. Updated my PR.

[seamuslee001]

@mlutfy test fails seem related

[mlutfy]

Yay tests pass, but I had to tweak them. Can someone double-check if it looks OK?

[totten]

@mlutfy Patch looks good. Update to the tests makes perfect sense. Did an r-run (browsing civicrm/a/#/status and changing language) and confirmed that the language updates (both visually and in the source/URLs).