Cacheability issue when using _consumer_id query in JsonApi responses.

Re-roll for D10.1 and Consumers 1.17

I get this error once I put this patch in:

Drupal\consumers\EventSubscriber\ConsumerVaryEventSubscriber::onRespond(): Argument #1 ($event) must be of type Symfony\Component\HttpKernel\Event\FilterResponseEvent, Symfony\Component\HttpKernel\Event\ResponseEvent given in Drupal\consumers\EventSubscriber\ConsumerVaryEventSubscriber->onRespond() (line 26 of modules/contrib/consumers/src/EventSubscriber/ConsumerVaryEventSubscriber.php).

Hi @SocialNicheGuru
you need to update your drupal instance to 9.5 at least to avoid this problem.
This FilterResponseEvent class is deprecated and has been replaced by ResponseEvent.
Patch itself is no reason for your issue.
https://www.drupal.org/project/drupal/issues/3130651 →

Also I have tidied up the patch to remove php cs warnings.

Thanks for continuing to work on this. It would be helpful for me if someone could give me a quick set of instructions for testing this patch. And, should we include tests for this in the code? It looks like there was an attempt at writing tests in #2 but there are no tests in the latest patch.

Hi @eojthebrave
here I reworked test from #2 to work with D9+ and used a bit another approach with computed field.
I am posting only test here to make sure it fails and going to post another comment with test and fix

Fix to the machine name call to make it D9 and D10 compatible

Fix + test

Thanks for working on this. I've finally been able to take a look at the code and do a little testing.

When testing this out locally it looks like the code in \Drupal\consumers\ConsumerRouteEnhancer assumes that JSON:API is enabled. Without it enabled I get this error when trying to view a node Error: Class "Drupal\jsonapi\Routing\Routes" not found in Drupal\consumers\ConsumerRouteEnhancer->enhance() (line 50 of modules/contrib/consumers/src/ConsumerRouteEnhancer.php).

Additionally, in that class, this constant is set but never used \Drupal\consumers\ConsumerRouteEnhancer::CONSUMER_QUERY_PARAMETER so could probably be removed?

And maybe I'm just not clear on how this works, but if we're going to set a Vary: X-Consumer-ID header, should we also set an X-Consumer-ID header so that it knows what value to vary on?

Hi @eojthebrave,
thanks for the feedback, I have prepared updated patch with fixes

rakesh.regar → made their first commit to this issue’s fork.

Raised Merge Request with the #15 patch.

Thanks for making the updates @sickness29. I've just committed the patch from #15. So I think we can call this fixed now.

Thanks for everyone who has help work on this.

Automatically closed - issue fixed for 2 weeks with no activity.