Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

CRM-20254: add cache buster string for custom CSS #9980

Merged
merged 4 commits into from
Mar 16, 2017
Merged

CRM-20254: add cache buster string for custom CSS #9980

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6f12c6e
CRM-20254: add cache buster string for custom CSS and improve query s…
mickadoo Mar 14, 2017
595caa4
CRM-20254: set cache buster code for tests
mickadoo Mar 14, 2017
03449a5
CRM-20254: simplify adding cache code logic. remove useless test case
mickadoo Mar 15, 2017
33603e1
CRM-20254: code style changes
mickadoo Mar 15, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions CRM/Core/Resources.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,7 +500,7 @@ public function getUrl($ext, $file = NULL, $addCacheCode = FALSE) {
$file = '';
}
if ($addCacheCode) {
$file .= '?r=' . $this->getCacheCode();
$file = $this->addCacheCode($file);
}
// TODO consider caching results
$base = $this->paths->hasVariable($ext)
Expand Down Expand Up @@ -643,7 +643,8 @@ public function addCoreStyles($region = 'html-header') {
// Load custom or core css
$config = CRM_Core_Config::singleton();
if (!empty($config->customCSSURL)) {
$this->addStyleUrl($config->customCSSURL, 99, $region);
$customCSSURL = $this->addCacheCode($config->customCSSURL);
$this->addStyleUrl($customCSSURL, 99, $region);
}
if (!Civi::settings()->get('disable_core_css')) {
$this->addStyleFile('civicrm', 'css/civicrm.css', -99, $region);
Expand Down Expand Up @@ -881,4 +882,27 @@ private function resolveFileName(&$fileName, $extName) {
}
}

/**
* @param string $url
* @return string
*/
public function addCacheCode($url) {
parse_str(parse_url($url, PHP_URL_QUERY), $queryParts);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There was previous discussion on the best approach here from @totten which you can see here. It might look suspicious but I'm not trying to hide his comments ! I just messed up by opening the PR to the wrong branch.

$existing = isset($queryParts['r']) ? $queryParts['r'] : NULL;
$latest = $this->cacheCode;

if ($existing) {
if ($existing === $latest) {
return $url; // no need to update
}
else {
return str_replace('r=' . $existing, 'r=' . $latest, $url);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, so this leads to my main confusion in the PR: I don't understand the scenario where (a) the URL already has r=XYZ and (b) we need to change it. Do you have an example?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@totten It's my unfamiliarity with the system that led me to putting that there to cover all cases. I thought maybe it might be possible that the cache buster string could change. If you can be sure it'll never happen I can rewrite it without it to just cover

  • $url has a query string and we need to append cache buster with '&'
  • $url has no query string and we need to append cache buster with '?'

Which should simplify things a lot

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that rewrite/simplification sounds good.

The cache busting string does, of course, change from time-to-time, but I look at it this way:

  • The signature for Resources::getUrl() says that it takes an extension-name and file-name (not a URL fragment). The intended usage is this: someone calls addScriptFile(...) or addStyleFile(...), then it automatically composes the URL and outputs the markup. There's no opportunity in that flow for someone to append their own query-parameters or re-append the cache-code.
  • As a general matter, the code is and should be stable because we want caching to work. The cache code should only change in a few limited cases: (a) the sysadmin does some kind of system update (upgrade core; install a new extension) or (b) the sysadmin/developer explicitly flushes the caches.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@totten it's certainly a lot simpler with that change!

I did a quick comparison on the performance of parse_url vs. str_pos which I mentioned on Stack Overflow, also in the hope that if I'm wrong about the check someone will point it out.

}
}

$operator = empty($queryParts) ? '?' : '&';

return $url . $operator . 'r=' . $latest;
}

}
40 changes: 40 additions & 0 deletions tests/phpunit/CRM/Core/ResourcesTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ class CRM_Core_ResourcesTest extends CiviUnitTestCase {
*/
protected $mapper;

/**
* @var string for testing cache buster generation
*/
protected $cacheBusterString = 'xBkdk3';

protected $originalRequest;
protected $originalGet;

Expand Down Expand Up @@ -348,4 +353,39 @@ public function _createMapper(CRM_Utils_Cache_Interface $cache = NULL, $cacheKey
return array($basedir, $c, $mapper);
}

/**
* @param string $url
* @param string $expected
*
* @dataProvider urlForCacheCodeProvider
*/
public function testAddingCacheCode($url, $expected) {
$resources = CRM_Core_Resources::singleton();
$this->assertEquals($expected, $resources->addCacheCode($url));
}

/**
* @return array
*/
public function urlForCacheCodeProvider() {
return array(
array(
'http://www.civicrm.org',
'http://www.civicrm.org?r=' . $this->cacheBusterString,
),
array(
'www.civicrm.org/custom.css?foo=bar',
'www.civicrm.org/custom.css?foo=bar&r=' . $this->cacheBusterString,
),
array(
'civicrm.org/custom.css?r=old&foo=bar',
'civicrm.org/custom.css?r=' . $this->cacheBusterString . '&foo=bar',
),
array(
'civicrm.org/custom.css?car=blue&foo=bar',
'civicrm.org/custom.css?car=blue&foo=bar&r=' . $this->cacheBusterString,
),
);
}

}