RemoveJsonapiFormatCompilerPass removes api_json from serializer.formats but not from serializer.format_providers, hence allowing it to be selected in REST export View displays

As a result, 'api_json' still leaks to places that use the latter parameter, such as RestExport::getFormatOptions(), which causes it to show up as an option when configuring a RestExport display.

Something must have changed then, because that definitely used to be fixed :( Or maybe we missed something! But making sure it doesn't show up in Views was of course a key goal of that issue.

I reproduced the problem.

That's also explicitly documented in #2841027: JSON API format should only be used on JSON API routes, but can currently also be used for REST resources, which introduced that class.

Come to think of it, do we need this compiler pass at all? The PHPDoc for it says:

But the JSON:API module also should not have to define an alternative 'serializer' service.

Except it now does, ever since #2923779-15: Normalizers violate NormalizerInterface.

That is a great point! #2923779: Normalizers violate NormalizerInterface indeed introduced our own serializer service. That means that most of the measures introduced in #2841027 are now obsolete.

So why do we still add a api_json encoder to the 'serializer' service?

Because \Drupal\jsonapi\EventSubscriber\ResourceResponseSubscriber::renderResponseBody() still does

      $response->setContent($serializer->encode($jsonapi_doc_object, $format));

However, we can factor that away, by just using the core serialization module's json encoder.

Then we run into one last blocker: JSON:API's subclass of serialization's JSON encoder does one extra thing. We can just move that into ResourceResponseSubscriber.

Let's see if this passes all tests.

One CS violation is masking a lot of failures. I can fix those failures, but the changes to fix those failures do show why we had that encoder still around.

I'll be the first to admit that this is where JSON:API module's internals are ugly and confusing. But don't forget we had to do this as well as #2923779: Normalizers violate NormalizerInterface precisely because of architectural flaws in Symfony's Serialization component… 😔

Sorry for the noise — I'm migrating to a new computer while working on this.

Fewer changes. I like it more than my proposal :)

RTBC, but I'd like at least one of my two fellow maintainers to also +1 before committing.

The title doesn't make it clear why this is considered a bug.

Just had one nit. If tests pass, I think this can go in.

+++ b/jsonapi.services.yml
@@ -97,7 +97,7 @@ services:
-      - { name: encoder, priority: 21, format: 'api_json' }
+      - { name: jsonapi_encoder_do_not_use_removal_imminent, priority: 21, format: 'api_json' }

I don't think we need the priority any more then.

WFM! Thanks for adding a tests :)

👌