Compatibility with JSONAPI 2.x / Core 8.7.x

+1

We have tried the development version: 8.x-2.x-dev of the entity_share module together with Drupal 8.7.0-beta1. During the installation we receive the following error message:

[php7:notice] [pid 127] [client 10.0.0.26:35908] Symfony\\Component\\DependencyInjection\\Exception\\ServiceNotFoundException: The service "entity_share_client.jsonapi_helper" has a dependency on a non-existent service "jsonapi.serializer_do_not_use_removal_imminent". in /var/www/html/vendor/symfony/dependency-injection/Compiler/CheckExceptionOnInvalidReferenceBehaviorPass.php on line 31 #0 /var/www/html/vendor/symfony/dependency-injection/Compiler/AbstractRecursivePass.php(60): Symfony\\Component\\DependencyInjection\\Compiler\\CheckExceptionOnInvalidReferenceBehaviorPass->processValue(Object(Symfony\\Component\\DependencyInjection\\Reference), false)\n#1 /var/www/html/vendor/symfony/dependency-injection/Compiler/CheckExceptionOnInvalidReferenceBehaviorPass.php(28): Symfony\\Component\\DependencyInjection\\Compiler\\AbstractRecursivePass->processValue(Array, false)\n#2 /var/www/html/vendor/symfony/dependency-injection/Compiler/AbstractRecursivePass.php(67): Symfony\\Component\\DependencyInjection\\Compiler\\CheckExceptionOnInvalidReferenceBehaviorPass->processValue(Array)\n#3 /var/www/html/vendor/symfony/dependency-injection/Compiler/CheckExceptionOnInvalidReferenceBehaviorPass.php(28): Symfony\\Component\\DependencyInjection\\Compiler\\AbstractRecursivePass->processValue(Object(Symfony\\Component\\DependencyInjection\\Definition), true)\n#4 /var/www/html/vendor/symfony/dependency-injection/Compiler/AbstractRecursivePass.php(60): Symfony\\Component\\DependencyInjection\\Compiler\\CheckExceptionOnInvalidReferenceBehaviorPass->processValue(Object(Symfony\\Component\\DependencyInjection\\Definition), true)\n#5 /var/www/html/vendor/symfony/dependency-injection/Compiler/CheckExceptionOnInvalidReferenceBehaviorPass.php(28): Symfony\\Component\\DependencyInjection\\Compiler\\AbstractRecursivePass->processValue(Array, true)\n#6 /var/www/html/vendor/symfony/dependency-injection/Compiler/AbstractRecursivePass.php(39): Symfony\\Component\\DependencyInjection\\Compiler\\CheckExceptionOnInvalidReferenceBehaviorPass->processValue(Array, true)\n#7 /var/www/html/vendor/symfony/dependency-injection/Compiler/Compiler.php(141): Symfony\\Component\\DependencyInjection\\Compiler\\AbstractRecursivePass->process(Object(Drupal\\Core\\DependencyInjection\\ContainerBuilder))\n#8 /var/www/html/vendor/symfony/dependency-injection/ContainerBuilder.php(788): Symfony\\Component\\DependencyInjection\\Compiler\\Compiler->compile(Object(Drupal\\Core\\DependencyInjection\\ContainerBuilder))\n#9 /var/www/html/core/lib/Drupal/Core/DrupalKernel.php(1346): Symfony\\Component\\DependencyInjection\\ContainerBuilder->compile()\n#10 /var/www/html/core/lib/Drupal/Core/DrupalKernel.php(920): Drupal\\Core\\DrupalKernel->compileContainer()\n#11 /var/www/html/core/lib/Drupal/Core/Update/UpdateKernel.php(42): Drupal\\Core\\DrupalKernel->initializeContainer()\n#12 /var/www/html/core/lib/Drupal/Core/DrupalKernel.php(476): Drupal\\Core\\Update\\UpdateKernel->initializeContainer()\n#13 /var/www/html/core/lib/Drupal/Core/Update/UpdateKernel.php(65): Drupal\\Core\\DrupalKernel->boot()\n#14 /var/www/html/update.php(28): Drupal\\Core\\Update\\UpdateKernel->handle(Object(Symfony\\Component\\HttpFoundation\\Request))\n#15 {main}, referer...

Drupal 8.7 is available now. We would like to update our sites, but we use entity_share for synchronization of some content types. Is there any chance, that the entity_share will be updated for JSON API ~2.0 or should we look for some other solution?

It looks like, the module is no longer developed because of the issue: Provide a supported API for entity denormalization.

Quick fix for this problem:

"replace": {
        "drupal/jsonapi": "*"
    },

in your composer.json.

Hi Oskar,

if I try:

    "require": {
        ...
        "drupal/entity_share": "2.x-dev"
    },
    "replace": {
        "drupal/core": "^8.7",
        "drupal/jsonapi": "*"
    },

I get the following conflict:

uid_1000@256f0fdc468f:/var/www/html$ composer update
Loading composer repositories with package information
Updating dependencies (including require-dev)
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Installation request for drupal/drupal No version set (parsed as 1.0.0) -> satisfiable by drupal/drupal[No version set (parsed as 1.0.0)].
    - drupal/entity_share 2.x-dev requires drupal/jsonapi ~2.0 -> satisfiable by drupal/jsonapi[2.x-dev, 2.4.0, 2.3.0, 2.2.0, 2.1.0, 2.0.0, 2.0.0-rc4, 2.0.0-rc3, 2.0.0-rc2, 2.0.0-rc1, 2.0.0-beta2, 2.0.0-beta1].
    - don't install drupal/jsonapi 2.x-dev|remove drupal/drupal No version set (parsed as 1.0.0)
    - don't install drupal/jsonapi 2.4.0|remove drupal/drupal No version set (parsed as 1.0.0)
    - don't install drupal/jsonapi 2.3.0|remove drupal/drupal No version set (parsed as 1.0.0)
    - don't install drupal/jsonapi 2.2.0|remove drupal/drupal No version set (parsed as 1.0.0)
    - don't install drupal/jsonapi 2.1.0|remove drupal/drupal No version set (parsed as 1.0.0)
    - don't install drupal/jsonapi 2.0.0|remove drupal/drupal No version set (parsed as 1.0.0)
    - don't install drupal/jsonapi 2.0.0-rc4|remove drupal/drupal No version set (parsed as 1.0.0)
    - don't install drupal/jsonapi 2.0.0-rc3|remove drupal/drupal No version set (parsed as 1.0.0)
    - don't install drupal/jsonapi 2.0.0-rc2|remove drupal/drupal No version set (parsed as 1.0.0)
    - don't install drupal/jsonapi 2.0.0-rc1|remove drupal/drupal No version set (parsed as 1.0.0)
    - don't install drupal/jsonapi 2.0.0-beta2|remove drupal/drupal No version set (parsed as 1.0.0)
    - don't install drupal/jsonapi 2.0.0-beta1|remove drupal/drupal No version set (parsed as 1.0.0)
    - Installation request for drupal/entity_share 2.x-dev -> satisfiable by drupal/entity_share[2.x-dev].

Okay, unexpected, but I just realised it doesn't help anyway. The service `jsonapi.serializer_do_not_use_removal_imminent` will still be missing so even if you get it to install the site won't run.

EDIT: I also realise I posted my quick fix idea in the wrong issue. Everything was wrong :-)

Here's a patch for all the necessary changes found so far.

I've never used this module prior to Drupal 8.7 so there might be other issues I've not found and upgrade path from jsonapi contrib to core module is not tested.

Hello,

I will update the project page to indicate that the module is not compatible with JSONAPI 2.x and Core 8.7.x.

As mentioned in comment 5, the main problem is to fix the issue #2939827: Provide a supported API for entity denormalization. The composer.json constraint can easily be removed but the module won't work.

+++ b/modules/entity_share_client/src/Service/JsonapiHelper.php
@@ -339,9 +339,11 @@ class JsonapiHelper implements JsonapiHelperInterface {
+      // JSONAPI no longer includes uuid in attributes so we're using id

Also, thanks for pointing this.

Hello,

I am almost to a working state.

Here is a patch. In entity_share/modules/entity_share_client/src/Form/PullForm.php you need to comment:

// TODO: Fix. Filter on uuid is no more possible.
    $query['filter']['uuid-filter'] = [
      'condition' => [
        'path' => 'uuid',
        'operator' => 'IN',
        'value' => array_values($selected_entities),
      ],
    ];

For this to work, so all the content will be pulled not the selected one. I have asked on the jsonapi channel on Slack if it was still possible to make filter on uuid. I am waiting for a response.

Thanks @borgenk, your patch points me some places to look at. There was still a lot of other places to fix.

Thanks for the review.

I think I found my answer: https://www.drupal.org/node/3015183

I will test and update the patch if it is ok.

Working ok. Also found other problems.

Will commit soon!

I have made a bunch of commits to separate all the problem founds.

Please test the last dev version.

Thanks for working on this!

Running
- drupal/core, 8.7.1
- drupal/entity_share, dev-2.x
I get the following error when pulling content entities to the client.

Error: Call to a member function getClass() on null in Drupal\jsonapi\Normalizer\FieldItemNormalizer->denormalize() (line 117 of /mnt/persist/www/docroot/releases/20190520071434/web/core/modules/jsonapi/src/Normalizer/FieldItemNormalizer.php) #0 /mnt/persist/www/docroot/releases/20190520071434/vendor/symfony/serializer/Serializer.php(182): Drupal\jsonapi\Normalizer\FieldItemNormalizer->denormalize(NULL, 'Drupal\\Core\\Fie...', 'api_json', Array) #1 /mnt/persist/www/docroot/releases/20190520071434/web/core/modules/jsonapi/src/Serializer/Serializer.php(75): Symfony\Component\Serializer\Serializer->denormalize(NULL, 'Drupal\\Core\\Fie...', 'api_json', Array) #2 /mnt/persist/www/docroot/releases/20190520071434/web/core/modules/jsonapi/src/Normalizer/FieldNormalizer.php(65): Drupal\jsonapi\Serializer\Serializer->denormalize(NULL, 'Drupal\\Core\\Fie...', 'api_json', Array) #3 /mnt/persist/www/docroot/releases/20190520071434/vendor/symfony/serializer/Serializer.php(182): Drupal\jsonapi\Normalizer\FieldNormalizer->denormalize(NULL, '\\Drupal\\Core\\Fi...', 'api_json', Array) #4 /mnt/persist/www/docroot/releases/20190520071434/web/core/modules/jsonapi/src/Serializer/Serializer.php(75): Symfony\Component\Serializer\Serializer->denormalize(NULL, '\\Drupal\\Core\\Fi...', 'api_json', Array) #5 /mnt/persist/www/docroot/releases/20190520071434/web/core/modules/jsonapi/src/Normalizer/ContentEntityDenormalizer.php(77): Drupal\jsonapi\Serializer\Serializer->denormalize(NULL, '\\Drupal\\Core\\Fi...', 'api_json', Array) #6 /mnt/persist/www/docroot/releases/20190520071434/web/core/modules/jsonapi/src/Normalizer/EntityDenormalizerBase.php(99): Drupal\jsonapi\Normalizer\ContentEntityDenormalizer->prepareInput(Array, Object(Drupal\jsonapi\ResourceType\ResourceType), 'api_json', Array) #7 /mnt/persist/www/docroot/releases/20190520071434/vendor/symfony/serializer/Serializer.php(182): Drupal\jsonapi\Normalizer\EntityDenormalizerBase->denormalize(Array, 'Drupal\\node\\Ent...', 'api_json', Array) #8 /mnt/persist/www/docroot/releases/20190520071434/web/core/modules/jsonapi/src/Serializer/Serializer.php(75): Symfony\Component\Serializer\Serializer->denormalize(Array, 'Drupal\\node\\Ent...', 'api_json', Array) #9 /mnt/persist/www/docroot/releases/20190520071434/web/core/modules/jsonapi/src/Normalizer/JsonApiDocumentTopLevelNormalizer.php(169): Drupal\jsonapi\Serializer\Serializer->denormalize(Array, 'Drupal\\node\\Ent...', 'api_json', Array) #10 /mnt/persist/www/docroot/releases/20190520071434/web/modules/contrib/entity_share/modules/entity_share_client/src/Service/JsonapiHelper.php(212): Drupal\jsonapi\Normalizer\JsonApiDocumentTopLevelNormalizer->denormalize(Array, 'Drupal\\node\\Ent...', 'api_json', Array) #11 /mnt/persist/www/docroot/releases/20190520071434/web/modules/contrib/entity_share/modules/entity_share_client/src/Service/JsonapiHelper.php(357): Drupal\entity_share_client\Service\JsonapiHelper->extractEntity(Array) #12 /mnt/persist/www/docroot/releases/20190520071434/web/modules/contrib/entity_share/modules/entity_share_client/src/JsonapiBatchHelper.php(39): Drupal\entity_share_client\Service\JsonapiHelper->importEntityListData(Array) #13 /mnt/persist/www/docroot/releases/20190520071434/web/core/includes/batch.inc(295): Drupal\entity_share_client\JsonapiBatchHelper::importEntityListBatch(Object(Drupal\entity_share_client\Entity\Remote), Array, Array) #14 /mnt/persist/www/docroot/releases/20190520071434/web/core/includes/batch.inc(137): _batch_process() #15 /mnt/persist/www/docroot/releases/20190520071434/web/core/includes/batch.inc(93): _batch_do() #16 /mnt/persist/www/docroot/releases/20190520071434/web/core/modules/system/src/Controller/BatchController.php(55): _batch_page(Object(Symfony\Component\HttpFoundation\Request)) #17 [internal function]: Drupal\system\Controller\BatchController->batchPage(Object(Symfony\Component\HttpFoundation\Request)) #18 /mnt/persist/www/docroot/releases/20190520071434/web/core/lib/Drupal/Core/EventSubscriber/EarlyRenderingControllerWrapperSubscriber.php(123): call_user_func_array(Array, Array) #19 /mnt/persist/www/docroot/releases/20190520071434/web/core/lib/Drupal/Core/Render/Renderer.php(582): Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->Drupal\Core\EventSubscriber\{closure}() #20 /mnt/persist/www/docroot/releases/20190520071434/web/core/lib/Drupal/Core/EventSubscriber/EarlyRenderingControllerWrapperSubscriber.php(124): Drupal\Core\Render\Renderer->executeInRenderContext(Object(Drupal\Core\Render\RenderContext), Object(Closure)) #21 /mnt/persist/www/docroot/releases/20190520071434/web/core/lib/Drupal/Core/EventSubscriber/EarlyRenderingControllerWrapperSubscriber.php(97): Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->wrapControllerExecutionInRenderContext(Array, Array) #22 /mnt/persist/www/docroot/releases/20190520071434/vendor/symfony/http-kernel/HttpKernel.php(151): Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->Drupal\Core\EventSubscriber\{closure}() #23 /mnt/persist/www/docroot/releases/20190520071434/vendor/symfony/http-kernel/HttpKernel.php(68): Symfony\Component\HttpKernel\HttpKernel->handleRaw(Object(Symfony\Component\HttpFoundation\Request), 1) #24 /mnt/persist/www/docroot/releases/20190520071434/web/core/lib/Drupal/Core/StackMiddleware/Session.php(57): Symfony\Component\HttpKernel\HttpKernel->handle(Object(Symfony\Component\HttpFoundation\Request), 1, true) #25 /mnt/persist/www/docroot/releases/20190520071434/web/core/lib/Drupal/Core/StackMiddleware/KernelPreHandle.php(47): Drupal\Core\StackMiddleware\Session->handle(Object(Symfony\Component\HttpFoundation\Request), 1, true) #26 /mnt/persist/www/docroot/releases/20190520071434/web/core/modules/page_cache/src/StackMiddleware/PageCache.php(106): Drupal\Core\StackMiddleware\KernelPreHandle->handle(Object(Symfony\Component\HttpFoundation\Request), 1, true) #27 /mnt/persist/www/docroot/releases/20190520071434/web/core/modules/page_cache/src/StackMiddleware/PageCache.php(85): Drupal\page_cache\StackMiddleware\PageCache->pass(Object(Symfony\Component\HttpFoundation\Request), 1, true) #28 /mnt/persist/www/docroot/releases/20190520071434/web/core/lib/Drupal/Core/StackMiddleware/ReverseProxyMiddleware.php(47): Drupal\page_cache\StackMiddleware\PageCache->handle(Object(Symfony\Component\HttpFoundation\Request), 1, true) #29 /mnt/persist/www/docroot/releases/20190520071434/web/core/lib/Drupal/Core/StackMiddleware/NegotiationMiddleware.php(52): Drupal\Core\StackMiddleware\ReverseProxyMiddleware->handle(Object(Symfony\Component\HttpFoundation\Request), 1, true) #30 /mnt/persist/www/docroot/releases/20190520071434/vendor/stack/builder/src/Stack/StackedHttpKernel.php(23): Drupal\Core\StackMiddleware\NegotiationMiddleware->handle(Object(Symfony\Component\HttpFoundation\Request), 1, true) #31 /mnt/persist/www/docroot/releases/20190520071434/web/core/lib/Drupal/Core/DrupalKernel.php(693): Stack\StackedHttpKernel->handle(Object(Symfony\Component\HttpFoundation\Request), 1, true) #32 /mnt/persist/www/docroot/releases/20190520071434/web/index.php(19): Drupal\Core\DrupalKernel->handle(Object(Symfony\Component\HttpFoundation\Request)) #33 {main}.

Thanks for testing!

I am currently updating ess_test sub-module because I got errors on install.

Would it be possible to have the structure of your entities? And/Or steps to reproduce starting from a fresh Drupal install?

The least I can do.

We're running this on a pretty complex site, and some of the logic is probably things my client doesn't want me to share. So a complete setup is probably a bad idea. But the entity we're syncing is just a node with these fields:

field_body Text (formatted, long)
field_category Entity reference (taxonomy term)
field_footnote Text (formatted, long)
field_headline Text (plain)
field_image Image
field_members_only Boolean
field_reference Entity reference (node)
field_date Date
field_summary Text (formatted, long)
field_tags Entity reference (taxonomy term)

Thanks for the updates.

It seems to work now with the latest commits.

@OWast: You probably need to apply this Drupal core patch (scheduled for 8.8) https://www.drupal.org/files/issues/2019-04-24/3048348-9.patch due to a bug in the JSONAPI module. See https://www.drupal.org/project/drupal/issues/3048348.

Confirmed. Outstanding!

Thanks for the details.

I have pushed an update of the ess_test module that provides a basic structure to test field types. I have no problem except for dynamic entity reference field.

Because in entity_share/modules/entity_share_client/src/Service/JsonapiHelper.php updateRelationships()

if ($field_data['data'] != NULL && isset($field_data['links']['related']['href'])) {

For dynamic entity reference fields there is no "related" link only "self". So I will need to update the logic to get related entities. I think that unfortunately will mean more requests and I know that some of our projects suffer from performance due to data volume or complex data structure.

@OWast, I think I got a similar bug on friday when for testing I used devel generate and the entities were not very well generated. Maybe in your app you have some generated entities with missing attributes or a null value where it should not be possible.

Keeping the issue open for dynamic entity reference fix.

The dynamic entity reference issue has its dedicated issue now: #3056102: Support dynamic entity reference fields.

Thanks all for testing.

I will make an alpha version soon to have more people testing.

I'm testing with the alpha version 5, and Core 8.7.7

I applied the patch in #20, but the issue is still there:

An AJAX HTTP error occurred.
HTTP Result Code: 200
Debugging information follows.
Path: /batch?id=12&op=do_nojs&op=do
StatusText: OK
ResponseText: Error: Call to a member function getClass() on null in Drupal\jsonapi\Normalizer\FieldItemNormalizer->denormalize() (line 130 of /app/docroot/core/modules/jsonapi/src/Normalizer/FieldItemNormalizer.php).

any feedback on what I'm doing wrong? I am using the default landing page/basic page that comes with Drupal, and a basic taxonomy. All cases fail with that error ^^.

Hi,

@alexmoreno, please open a new bug report.

Do you have any special fields, like metatag?

It is really strange that you got errors, now with all the automated tests, standards fields are covered.

nothing special, just default fields, although I am using Acquia Lightning distribution. Maybe something is going on in the Lightning fields as it adds some extra beef. However I also synced taxonomies, which should have not anything extra, and that failed as well.

I'll open a ticket as suggested and will do some testings today.

The same issue is coming for me
An AJAX HTTP error occurred.
HTTP Result Code: 200
Debugging information follows.
Path: /batch?id=12&op=do_nojs&op=do
StatusText: OK
ResponseText: Error: Call to a member function getClass() on null in Drupal\jsonapi\Normalizer\FieldItemNormalizer->denormalize() (line 130 of /app/docroot/core/modules/jsonapi/src/Normalizer/FieldItemNormalizer.php).

to be clear, the error I was getting was a problem with my own setup, I should have updated that @Grimreaper helped finding that out.

If you have a different field between server and client, when the client tries to pull those fields it will crash and show that 200 error. I would recommend you to simplify your setup as much as you can (less fields) and start adding from there so you can find what's going on.

I wonder if some debugging or better messaging could be added here, like instead of the

Call to a member function getClass() on null

something more descriptive or that could even point to what field is exactly crashing. Just thinking out loud

Hi Team,

Yes we are using metatag may that is the reason we are getting the below error
An AJAX HTTP error occurred.
HTTP Result Code: 200
Debugging information follows.
Path: /batch?id=12&op=do_nojs&op=do
StatusText: OK
ResponseText: Error: Call to a member function getClass() on null in Drupal\jsonapi\Normalizer\FieldItemNormalizer->denormalize() (line 130 of /app/docroot/core/modules/jsonapi/src/Normalizer/FieldItemNormalizer.php).

Please suggest us anyway to resolve this issue.

Hi Team,

Yes we are using metatag may that is the reason we are getting the below error
An AJAX HTTP error occurred.
HTTP Result Code: 200
Debugging information follows.
Path: /batch?id=12&op=do_nojs&op=do
StatusText: OK
ResponseText: Error: Call to a member function getClass() on null in Drupal\jsonapi\Normalizer\FieldItemNormalizer->denormalize() (line 130 of /app/docroot/core/modules/jsonapi/src/Normalizer/FieldItemNormalizer.php).

Please suggest to us anyway to resolve this issue.

@svsrinivas2, please see the dedicated issue to Metatag support #3060702: Compatibility with Metatag Fields and the updated README.txt file and project description.

This issue is closed, so it is not advised to post comment on it.

have any update on this issue