Contrib.social

NULL contextual argument should be skipped during views URL generation

Open on Drupal.org →
Created on 15 June 2024, 3 months ago
Updated 18 June 2024, 3 months ago

Problem/Motivation

I used the NULL contextual argument to skip the default URL argument value for rewriting it later with the custom argument_default plugin but I faced an issue with URL generation. My view except contextual filters also have exposed filters, and the problem is that exposed form action was wrong.

I investigated this issue deeper and found that this problem comes from \Drupal\views\Plugin\views\display\PathPluginBase::getRoute. When we generate routes for views we include all contextual arguments into the view display URL path.

Steps to reproduce

I have created dummy module that provides node type and view with exposed and contextual filters for reproducing this issue. So, steps to reproduce:

  1. Install the module (this module will generate on install 20 nodes needed for reproducing the problem)
  2. Go to the /views-null-argument-issue/{NodeID} (use any Node ID of views_null_argument_issue node type for NodeID) and check that
    • the view displays 10 items (result summary above of the form)
    • all items have the same type in the table
  3. Submit the exposed form with any filter value
  4. Check the following
    • the URL was changed to like this /views-null-argument-issue/{NodeID}/exception-value?...
    • the view displays 20 items (result summary above of the form)
    • there are type 1 and type 2 items

Proposed resolution

I think the NULL argument should be excluded from route params in the \Drupal\views\Plugin\views\display\PathPluginBase::getRoute to fix this issue.

We can exclude it by creating a new SkipFromRouteParamsInterface interface, and use this interface for filtering all arguments in the \Drupal\views\Plugin\views\display\PathPluginBase::getRoute to skip arguments that implement it.

Another way of fixing this is to exclude the NULL argument from the route params by configurations. We can add a new checkbox to the NULL argument configuration form that will be responsible for skipping it from route parameters.

In the end, both of these ideas should filter $argument_ids to exclude the NULL argument (and other arguments that implement either interface or configuration) in the \Drupal\views\Plugin\views\display\PathPluginBase::getRoute

Remaining tasks

User interface changes

API changes

Data model changes

Release notes snippet

🐛 Bug report
Status

Needs work

Version

11.0 🔥

Component
Views  →

Last updated about 12 hours ago

Created by

🇺🇦Ukraine Chizh273

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

Comments & Activities

  • Issue created by @Chizh273
  • Merge request !8422Issue #3454813: NULL contextual argument should be skipped during views URL generation → (Open) created by Chizh273
  • Issue was unassigned.
  • Status changed to Needs review 3 months ago
  • Comment 3 months ago →
    🇺🇦Ukraine Chizh273

    I have created MR with SkipFromRouteParamsInterface interface implementation. Could someone review it, pls?

  • Pipeline finished with Failed
    3 months ago
    Total: 634s
    #199821
  • Pipeline finished with Canceled
    3 months ago
    Total: 556s
    #200232
  • Pipeline finished with Canceled
    3 months ago
    Total: 300s
    #200240
  • Pipeline finished with Failed
    3 months ago
    Total: 584s
    #200243
  • Status changed to Needs work 3 months ago
  • Comment 3 months ago →
    🇺🇸United States smustgrave

    Thank you for reporting

    MR should point to 11.x as the current development branch

    Also tagged for tests to show the issue.

  • Pipeline finished with Failed
    3 months ago
    Total: 556s
    #201676
  • Pipeline finished with Failed
    3 months ago
    Total: 660s
    #201677
  • Comment 3 months ago →
    🇺🇦Ukraine Chizh273

    I have updated MR to point to 11.x

    Also, MR works fine for Drupal 10.3.x. and so in addition, I have added a patch version of this MR for Drupal 10.2.x.

  • Pipeline finished with Failed
    3 months ago
    Total: 866s
    #201796
  • Pipeline finished with Failed
    3 months ago
    Total: 924s
    #201795
contrib.social Blog FAQ Discussions
Production build 0.71.5 2024