Throw an exception when building route paths unsupported by Drupal

Open on Drupal.org →

Created on 23 July 2024, about 2 months ago

Updated 24 July 2024, about 2 months ago

Problem/Motivation

I recently tried to implement a route of the format /openapi/{plugin_id}.{content_type} to allow for a URL like /openapi/jsonapi.yaml. This is supported upstream in Symfony but not in Drupal → . (Similarly, you cannot have two parameters which are not separated by a slash, such as {a}{b}.

Steps to reproduce

This is a Drupalism and confusing. Tackling the underlying constraints is a huge lift, but we should at least throw an exception when compiling routes when Drupal doesn't like the path.

Proposed resolution

Throw an exception when compiling route paths that we know aren't supported by Drupal, with a pointer to helpful docs.

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

✨ Feature request

Status

Needs work

Version

11.0 🔥

Component

Last updated 8 days ago

Maintained by
🇺🇸United States @tim.plunkett

Created by

🇺🇸United States bradjones1 Digital Nomad Life

Live updates comments and jobs are added and updated live.

Needs tests
The change is currently missing an automated test that fails when run with the original code, and succeeds when the bug has been fixed.

Sign in to follow issues

Merge Requests

!8907Throw an exception when building route paths unsupported by Drupal
Open
🇮🇳India Akhil Babu
updated about 2 months ago

Comments & Activities

Issue created by @bradjones1
Comment about 2 months ago →
🇮🇳India Akhil Babu Chengannur
Akhil Babu → made their first commit to this issue’s fork.
Merge request !8907Issues/3463415: Throw an exception when building route paths unsupported by Drupal. → (Open) created by Akhil Babu
Comment about 2 months ago →
🇮🇳India Akhil Babu Chengannur
This would be very helpfull. Right now, Drupal just shows a 'page not found' message when the route is invalid.
Pipeline finished with Success
about 2 months ago
Total: 477s
#233115
Status changed to Needs work about 2 months ago6:22pm 24 July 2024
Comment about 2 months ago →
🇺🇸United States bradjones1 Digital Nomad Life
@Akhil Babu, thanks for this! I think this change could be made pretty easily, and your MR gets at the core (only?) real code change that needs to be made. (I think a LogicException might be more appropriate here?)

What this needs, though, is tests that validate the universe of allowed and disallowed patterns. That would also help in documenting in code what is and isn't allowed by Drupal's route builder.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024