Realtime and non-realtime Collaboration result in DocumentList error

Created on 23 October 2024, 2 months ago

Problem/Motivation

https://git.drupalcode.org/project/ckeditor5_premium_features/-/blob/1.3... has 'DocumentList' which results in this failure:

ckeditor5-dll.js?v=41.3.1:5 plugin-obsolete-documentlist Object
Read more: https://ckeditor.com/docs/ckeditor5/latest/support/error-codes.html#error-pā€¦
n @ ckeditor5-dll.js?v=41.3.1:5

The same with ckeditor5_premium_features_collaboration.ckeditor5.yml

Steps to reproduce

Attempt to use realtime or non-realtime collaboration

Proposed resolution

Fix use of deprecated code

Remaining tasks

Not sure

User interface changes

Note sure

API changes

Not sure

Data model changes

Not sure

šŸ› Bug report
Status

Active

Version

1.3

Component

Plugin: Collaboration

Created by

šŸ‡¬šŸ‡§United Kingdom scott_euser

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @scott_euser
  • šŸ‡¬šŸ‡§United Kingdom scott_euser
  • šŸ‡µšŸ‡±Poland salmonek

    Hi @scott_euser
    We're aware of this warning. It is being kept for backwards compatibility and as for now besides displaying warning it doesn't produce errors.
    DocumentList plugin is used in Comments and Collaboration (as suggestions can be commented), it allows to add list in comment (using autoformat functionality).
    In Drupal up to 10.2 with CKEditor 5 versions prior to 41.0.0 there were available plugins DocumentList and List (incompatible with Drupal's core CKEditor 5 build).
    CKEditor 5 v41.0.0 (v41.3.1 is in Drupal 10.3) changed the plugin names:
    DocumentList -> List
    List -> LegacyList
    DocumentList became obsolete, but sill an alias for List

    The problem with changing plugin used in the module to List would be that for sites using Drupal prior to 10.3 it would mean to change to unsupported plugin.
    So up until DocumentList is kept as alias (or we'll gain info that it causes some error), we'll be willing to not put that change into official release.
    In case you would like to get rid of that warning I'm posting a patch that is compatible with Premium Features v1.3.2 which chnages the plugin.

    I'll set the status to postponed. We can close after chnage will land in official release.

  • šŸ‡¬šŸ‡§United Kingdom scott_euser

    Okay sounds good, and thanks for the patch!

  • šŸ‡¬šŸ‡§United Kingdom scott_euser

    I did try out the patch but actually that leads to a complete error rather than warning, so will leave it off for now.

    Here is the error in case you need it:

    ckeditor5.js?sluq6o:464 Debugging can be done with an unminified version of CKEditor by installing from the source file. Consult documentation at https://www.drupal.org/node/3258901
    hook.js:608 CKEditorError: plugincollection-soft-required {"missingPlugin":"DocumentList","requiredBy":"CommentsAdapter"}
    Read more: https://ckeditor.com/docs/ckeditor5/latest/support/error-codes.html#error-plugincollection-soft-required
        at ckeditor5-dll.js?v=41.3.1:5:125401
        at ckeditor5-dll.js?v=41.3.1:5:125545
        at Array.forEach (<anonymous>)
        at u (ckeditor5-dll.js?v=41.3.1:5:125347)
        at ckeditor5-dll.js?v=41.3.1:5:123978
        at Array.reduce (<anonymous>)
        at e (ckeditor5-dll.js?v=41.3.1:5:123929)
        at l.init (ckeditor5-dll.js?v=41.3.1:5:124054)
        at V.initPlugins (ckeditor5-dll.js?v=41.3.1:5:133962)
        at editor-classic.js?v=41.3.1:4:10883
  • šŸ‡µšŸ‡±Poland salmonek

    Attaching updated patch.
    Previous one didn't change library version, so besides cache rebuild a browser's cache flush was required.
    This one requires only cache rebuild.

Production build 0.71.5 2024