Add CKEditor 5 compatibility and keep supporting CKEditor 4

I wrote Dave Reid a PM.

With no success. No reply. :(

Dear maintainers, I also stumbled over the issue on a new D9.5.4 install with PHP 8.1.16 and after some frustrating trials I finally found this thread. The functionality would be great to have, but CKE5 does not pick up the icon, so I cannot use the modules Entity embed and URL embed. Can't be such a big deal to make the project really D9/D10 compatible, or is it? Installing CKE4 just for the sake of the embed functionality is no option for me. The fix would be greatly appreciated. Regards

@hieuntnguyen how do I test your patch? It applied cleanly, but I'm not sure how to verify what it's fixing.

I am facing the same issue. I applied the patch from #18 but it doesn't do anything for me to test. This looks exactly the same patch as what was submitted as a merge request.

Am I missing something?

Gotcha, yeah I needed to use another module that leveraged embed to see it in action. Tested this entity_embed issue ✨ Drupal 10 & CKEditor 5 readiness Fixed and everything looks like it's working. Great work!

Setting the correct version. The merge request is more complete as the patch provided in #18

Also RTBC++ (tested in combination with entity_embed)

I tested out the merge request and everything looked good. Hope there can be a release for this soon.

Added a functional test covering the modified access check. The new EmbedButtonCKEditor5AccessCheckTest is almost entirely a copy of EmbedButtonEditorAccessCheckTest slightly adapted for CKEditor5. Note that it was necessary to extract CKE4 specific code from the base class in order to ensure that the new test runs without CKE4 enabled.

Subscribe

I have a ckeditor5 button created using the Embed module ("Embed type" = Views with "Filter which Views to be allowed as options" checked).
When I click on the icon in the editor toolbar, I get this ajax error:

The website encountered an unexpected error. Please try again later.

Drupal\Component\Plugin\Exception\PluginNotFoundException: The "" entity type does not exist. in Drupal\Core\Entity\EntityTypeManager->getDefinition() (line 139 of core/lib/Drupal/Core/Entity/EntityTypeManager.php).
Drupal\Core\Entity\EntityTypeManager->getHandler() (Line: 192)
Drupal\Core\Entity\EntityTypeManager->getStorage() (Line: 147)
Drupal\entity_embed\Form\EntityEmbedDialog->loadEntityByAttributes() (Line: 194)
Drupal\entity_embed\Form\EntityEmbedDialog->buildForm()
call_user_func_array() (Line: 534)
Drupal\Core\Form\FormBuilder->retrieveForm() (Line: 281)
Drupal\Core\Form\FormBuilder->buildForm() (Line: 73)
Drupal\Core\Controller\FormController->getContentResult()
call_user_func_array() (Line: 123)
Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->Drupal\Core\EventSubscriber\{closure}() (Line: 580)
Drupal\Core\Render\Renderer->executeInRenderContext() (Line: 124)
Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->wrapControllerExecutionInRenderContext() (Line: 97)
Drupal\Core\EventSubscriber\EarlyRenderingControllerWrapperSubscriber->Drupal\Core\EventSubscriber\{closure}() (Line: 169)
Symfony\Component\HttpKernel\HttpKernel->handleRaw() (Line: 81)
Symfony\Component\HttpKernel\HttpKernel->handle() (Line: 58)
Drupal\Core\StackMiddleware\Session->handle() (Line: 48)
Drupal\Core\StackMiddleware\KernelPreHandle->handle() (Line: 270)
Drupal\shield\ShieldMiddleware->bypass() (Line: 137)
Drupal\shield\ShieldMiddleware->handle() (Line: 48)
Drupal\Core\StackMiddleware\ReverseProxyMiddleware->handle() (Line: 51)
Drupal\Core\StackMiddleware\NegotiationMiddleware->handle() (Line: 49)
Drupal\remove_http_headers\StackMiddleware\RemoveHttpHeadersMiddleware->handle() (Line: 23)
Stack\StackedHttpKernel->handle() (Line: 718)
Drupal\Core\DrupalKernel->handle() (Line: 19)

Drupal version : 9.5.5
PHP version : 8.0.21

All works good!
The "Entity embed" dev with this patch( https://www.drupal.org/project/entity_embed/issues/3272732 ✨ Drupal 10 & CKEditor 5 readiness Fixed ) can't work without this patch.
Please merge its.

Just wanted to say I'm aware of this and working on some of the other issue in the queue to help unblock this a bit more. We could use reviews on 📌 When CKEditor5 is installed, only allow SVGs for button icons Fixed at this point first.

I consolidated the tests into just one test with a data provider since the tests were essentially the same, just the editor config was different. I understand movement was slow on this but it was clear that some actual code reviews were needed, not just testing functionality. A gentle reminder that in the future it would be appreciated if we could get more involvement on that level of reviews, it would be really helpful!

If this passes tests I will merge and get out a new release.

Testing patch version on Drupal 10 since the MR doesn't pass.

Wait this is missing a couple more things:

* Validation between embed button entity IDs and CKEditor5 button plugin IDs.
* The validation that the required filter is enabled when an embed button that requires one is enabled

* Validation to prevent conflicts between embed button entity IDs and CKEditor5 button plugin IDs.
* The validation that the required filter is enabled when an embed button that requires one is enabled.

I just talked with @WimLeers and the first one will be solved by implementers like Entity Embed properly namespacing their plugins going forward, so I don't need to add CKEditor5 conflict detection. The second item is provided out of the box with the new CKEditor5 plugin "conditions" so we don't need that as well.

I did notice there was some possible base class and deriver I could grab from the Entity Embed MR to provide here.

In case anybody is in a hurry to temporarily solve the problem introduced in commit c69445bb with annotations, here is a quick patch you can apply after the MR (something like this)

            "drupal/embed": {
                "3309747 - CKEditor 5 compatibility" : "https://git.drupalcode.org/project/embed/-/merge_requests/2.patch",
                "Embed bug" : "patches/embed_cke5_annotation_bug.patch"
            },

It just deletes the @code documentation block. This is temporary a workaround / hotfix.

The problem was this line:
@Translation('Your label'),

Annotations doesn't like single quotes. 😊

Attached a static patch for builds to use

Create a patch for 8.x-1.6 to use

Issue should always target the dev branch :)

I tested this MR along with https://www.drupal.org/project/entity_embed/issues/3272732 ✨ Drupal 10 & CKEditor 5 readiness Fixed and it works like charm !

Environment config:

Drupal 10.1 using DDev
PHP 8.1
Embed & Entity Embed 8.x-1.x branches with patches applied

hiding patch from #41 that was for 1.6 only and did not include all changes from the MR

It can't be applied in 1.6, so I made a temporary patch.

Can this be released as Drupal 9 EOL is just 2 months away?

The above patch in #45 does not include the latest fixes from the merge request.

There's an extra whitespace after the * in one of the files which is making it impossible to apply as a patch

 * @endcode
 * 
 * @see \Drupal\ckeditor5\Annotation\CKEditor5Plugin

https://git.drupalcode.org/project/embed/-/merge_requests/2/diffs#777e0e...

In Drupal 10, PHP 8.1.21, with Embed & Entity Embed 8.x-1.x branches, I tried https://www.drupal.org/files/issues/2023-07-12/entity_embed-3272732-MR-1... → with either https://www.drupal.org/files/issues/2023-07-26/3309747-45.patch → or https://www.drupal.org/files/issues/2023-06-29/3309747-CKEditor-5-compat... → . Although the patches applied, the custom icon image for an embed button doesn’t show up in CKEditor 5, rather the E icon is showing up.

I am trying to get a D10 up and running and I can't get any of these patches to apply either.

Just tried the patches from embed and entity_embed, same as rimbu002, the feature is there but the icons are "E".

@phjou @rimbu002
in `/admin/config/content/embed` Each embed type needs to have an SVG uploaded for their toolbar button icon to show up correctly in ckeditor5.

Attaching latest diff from MR !12 as static patch for composer builds.

Uploaded a patch to work with 8.x-1.6 →
The patch in #52 works with latest dev branch
this patch works with 1.6.0

Seems that it's not applying with all important changes in the 8.x-1.x branch

This patch file is having all changes on the 8.x-1.x branch and the patch in #52

The following is stopping applying the patch on the Drupal.org packaged code.

diff --git a/embed.info.yml b/embed.info.yml
index c116518..b81162c 100644
--- a/embed.info.yml
+++ b/embed.info.yml
@@ -4,3 +4,6 @@ description: 'Provides a framework for different types of embeds in text editors
 core_version_requirement: ^9.3 | ^10
 package: Filters
 configure: entity.embed_button.collection
+test_dependencies:
+  - drupal:ckeditor
+  - drupal:ckeditor5

The #52 patch is the right one to use
The patch in #57 having all changes from 1.6.0 + the patch in #52

The MR for this was last changed here https://www.drupal.org/project/embed/issues/3309747#mr2-note186453 📌 Add CKEditor 5 compatibility and keep supporting CKEditor 4 RTBC

A static patch is available in #40 that still applies to dev, please do not upload any more as it can create more confusion and noise for the maintainers to review.

#41 also reports a compatible patch for 1.6.

Confirming that I've tested the MR changes in the link above along with the latest changes in ✨ Drupal 10 & CKEditor 5 readiness Fixed as at 5dbcef96 and things seem to be working well (tested embedding webforms and media along with linking media).

I have been testing this extensively and merged this into 8.x-1.x. I will test this out with the Entity Embed related issue to confirm and then tag a new release.

Amazing, thanks so much @Dave Reid!

As found in v1.7.

Thanks @Dave Reid

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

Thank you!!!