TimezoneController could return a cacheable response

Open on Drupal.org →

Created on 23 March 2025, 18 days ago

Problem/Motivation

Responses returned by TimezoneController are not cacheable.
I don't think the responses varies so we should be able to cache it.

Steps to reproduce

Send a GET request to /system/timezone/CET.
The response has these headers:

Cache-Control: must-revalidate, no-cache, private
X-Drupal-Cache: UNCACHEABLE (no cacheability)
X-Drupal-Dynamic-Cache: UNCACHEABLE (no cacheability)

Proposed resolution

The controller should return a CacheableJsonResponse with the appropriate cache contexts (probably route).

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

✨ Feature request

Status

Active

Version

11.0 🔥

Component

other

Created by

🇫🇷France prudloff Lille

Live updates comments and jobs are added and updated live.

Novice
It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

Sign in to follow issues

Merge Requests

!11651TimezoneController could return a cacheable response
Open
🇺🇸United States mediabounds
updated 3 days ago

Comments & Activities

Issue created by @prudloff
Comment 14 days ago →
🇺🇸United States mediabounds
I'm going to take a look today during DrupalCon Atlanta's contribution day.
Merge request !11651Return a cacheable response from TimezoneController → (Open) created by mediabounds
Pipeline finished with Failed
14 days ago
Total: 122s
#458818
Comment 14 days ago →
🇺🇸United States mediabounds
Since the response of this controller is based on the path arguments, then the only cache context needed is route.

Additionally, I needed to add logic to set $is_daylight_saving_time to -1 if it was not specified in the route parameters. Otherwise, NULL was passed to timezone_name_from_abbr which generated a PHP notice and impacted the cachebility of the response (due to a message being added to the messenger service).
Comment 14 days ago →
🇺🇸United States mediabounds
Pipeline finished with Failed
14 days ago
Total: 570s
#458828
Pipeline finished with Success
14 days ago
Total: 453s
#458884
Comment 4 days ago →
🇺🇸United States smustgrave
https://git.drupalcode.org/issue/drupal-3514879/-/jobs/4794239 shows the test coverage.

left one comment on the MR.

probably need a very simple CR about the return change. Rest looks godd
Comment 4 days ago →
🇫🇷France prudloff Lille
@smustgrave I can't see your comment on the MR?
Comment 3 days ago →
🇺🇸United States mediabounds
I'm not familiar enough with the contribution process to know if I should write a draft of the change record before sending this back to "Needs Review" or if responding to the MR comment is enough and the "Needs change record" tag needs added.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024