Problem/Motivation

jsonapi_views_views_preview_info_alter() is checking for exposed filters by field name instead of by identifier.

When previewing a JSON:API Views -enabled view with an exposed filter, the log shows warnings like the following for each exposed filter:

Warning: Undefined array key "created" in jsonapi_views_views_preview_info_alter() (line 43 of web/modules/contrib/jsonapi_views/jsonapi_views.module)

Steps to reproduce

  1. Create a view on nodes and ensure that "Exposed via JSON:API" is set to "Yes".
  2. Add a filter on a node field, make it exposed, and set its [required] "Filter identifier".
  3. Preview the view below.

The filter won't show up in the URL in the "JSON:API Views", and there will be a warning like the above in the site log.

Proposed resolution

Check for filter identifier instead of just field name.

CommentFileSizeAuthor
#3 jsonapi_views-use_filter_identifier-3376193-3.patch922 bytesjeffschuler
#2 jsonapi_views-use_filter_identifier-3376193-2.patch915 bytesjeffschuler

Issue fork jsonapi_views-3376193

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

jeffschuler created an issue. See original summary.

jeffschuler’s picture

jeffschuler
Location Boulder, Colorado
commented
Assigned: jeffschuler » Unassigned
Status: Active » Needs review
StatusFileSize
new jsonapi_views-use_filter_identifier-3376193-2.patch915 bytes
jeffschuler’s picture

jeffschuler
Location Boulder, Colorado
commented
StatusFileSize
new jsonapi_views-use_filter_identifier-3376193-3.patch922 bytes

Missed an isset().

< +        if ($input[$param]) {
---
> +        if (isset($input[$param])) {
nuuou’s picture

nuuou commented

+1 on this. Ran into this exact same issue on a handful of projects, and this fixed it for me!

anybody’s picture

anybody
Primary language German
Location Porta Westfalica
commented
Issue tags: +Needs tests, +Novice

@jeffschuler thanks, this is an important fix! Could someone maybe turn the patch from #3 into a MR and add tests?

anybody’s picture

anybody
Primary language German
Location Porta Westfalica
commented

Turned #3 into a MR to speed things up.

anybody opened merge request !16

anybody’s picture

anybody
Primary language German
Location Porta Westfalica
commented

FYI: #3277489: Undefined index: XXX in jsonapi_views_views_preview_info_alter() is a duplicate with a different approach.

deciphered made their first commit to this issue’s fork.

  • deciphered committed eabd6bbf on 8.x-1.x 
    test(#3376193): cover exposed filter identifier in preview URL

deciphered’s picture

deciphered
Primary language English
Location Ballarat, Victoria, Australia
commented
Status: Needs review » Fixed

Thanks all, this is fixed and committed for the upcoming 8.x-1.2 release.

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.