Skip to content

Upgrading

From 1.0.0

Run drush updb after deploying.

  • Settings format. Update 10002 moves the mapping settings from the enabled_mappings map to a disabled_mappings list. Mapping keys contain a dot, which configuration keys may not, so in 1.0.0 saving the settings form failed whenever a mapping existed. Export configuration after the update.
  • Cache key. The key now includes the scheme and host, so existing files are unreachable. The cache rebuild that drush updb runs deletes them.
  • Invalidation. Files now also expire with the response's max-age and are discarded when the anonymous role changes.
  • Uninstall now deletes the cache directory.
  • Apache. On Apache with Drupal's .htaccess, 1.0.0 never cached anything: every request carried an empty Authorization header, which it took for credentials. Caching starts working after the update.
  • Path matching. Mappings match the path routing sees, so language-prefixed paths and aliases of a mapped path are now cached. The key also encodes the URL language.
  • Refused responses. Responses that declare Vary (other than Accept-Encoding), or vary by content language on a site with customised content language detection, are no longer cached.
  • File names are now keyed with the hash salt, and the cache directory denies web access on Apache. Nothing should fetch cache files by URL.
  • Header replay. Content-Disposition, Link and X-Robots-Tag are now replayed on a hit.
  • File limit. Each mapping holds at most 10000 files unless it sets max_files.
  • Core versions. core_version_requirement is now ^10.6 || ^11.3 || ^12: Drupal 12 is added, and Drupal 10.3 to 10.5 and 11.0 to 11.2, which no longer receive security releases, are dropped.

From development snapshots before 1.0.0

The first snapshots redirected mapped paths to a guessed file URL and generated files from a 404 handler. Since 1.0.0 the route runs normally and its response is stored on the way out.

  • Mapped paths no longer redirect. They return 200 at their own URL.
  • Query strings are no longer dropped. Declare the parameters you serve in query_allowlist; anything else is served live.
  • uri_prefix is ignored with a warning. Files left under a custom location are not managed and can be removed by hand.
  • Mapping IDs are namespaced by module, so settings are re-keyed from products to my_module.products by update 10001. A setting it cannot place unambiguously is dropped, the mapping reverts to enabled, and the update reports which.