Unverified Commit 2f6cbfb6 authored by Lauri Timmanee's avatar Lauri Timmanee
Browse files

Issue #3248188 by Wim Leers, bnjmnm: Plugin definition DX: validate drupal.conditions 

(cherry picked from commit e264ec68)
parent 372a1fe0

core/modules/ckeditor5/src/Plugin/CKEditor5PluginDefinition.php

+29 −0
Original line number Diff line number Diff line
@@ -191,6 +191,35 @@ private function validateDrupalAspects(string $id, array $definition): void { 
      }

    }



    if ($definition['drupal']['conditions'] !== FALSE) {

      // @see \Drupal\ckeditor5\Plugin\CKEditor5PluginManager::isPluginDisabled()

      // @see \Drupal\ckeditor5\Plugin\Validation\Constraint\ToolbarItemConditionsMetConstraintValidator::validate()

      $supported_condition_types = [

        'toolbarItem' => function ($value): ?string {

          return is_string($value) ? NULL : 'A string corresponding to a CKEditor 5 toolbar item must be specified.';

        },

        'imageUploadStatus' => function ($value): ?string {

          return is_bool($value) ? NULL : 'A boolean indicating whether image uploads must be enabled (true) or not (false) must be specified.';

        },

        'filter' => function ($value): ?string {

          return is_string($value) ? NULL : 'A string corresponding to a filter plugin ID must be specified.';

        },

        'plugins' => function ($value): ?string {

          return is_array($value) && Inspector::assertAllStrings($value) ? NULL : 'A list of strings, each corresponding to a CKEditor 5 plugin ID must be specified.';

        },

      ];

      $unsupported_condition_types = array_keys(array_diff_key($definition['drupal']['conditions'], $supported_condition_types));

      if (!empty($unsupported_condition_types)) {

        throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition has a "drupal.conditions" value that contains some unsupported condition types: "%s". Only the following conditions types are supported: "%s".', $id, implode(', ', $unsupported_condition_types), implode('", "', array_keys($supported_condition_types))));

      }

      foreach ($definition['drupal']['conditions'] as $condition_type => $value) {

        $assessment = $supported_condition_types[$condition_type]($value);

        if (is_string($assessment)) {

          throw new InvalidPluginDefinitionException($id, sprintf('The "%s" CKEditor 5 plugin definition has an invalid "drupal.conditions" item. "%s" is set to an invalid value. %s', $id, $condition_type, $assessment));

        }

      }

    }



    if ($definition['drupal']['admin_library'] !== FALSE) {

      [$extension, $library] = explode('/', $definition['drupal']['admin_library'], 2);

      if (\Drupal::service('library.discovery')->getLibraryByName($extension, $library) === FALSE) {

core/modules/ckeditor5/tests/src/Kernel/CKEditor5PluginManagerTest.php

+188 −0
Original line number Diff line number Diff line
@@ -337,6 +337,194 @@ public function providerTestInvalidPluginDefinitions(): \Generator { 
      NULL,

    ];



    // Add conditions.

    yield 'unsupported condition type' => [

      <<<YAML

ckeditor5_invalid_plugin_foo_bar:

  ckeditor5:

    plugins: {}

  drupal:

    label: "Foo bar"

    elements:

      - <foo>

      - <bar>

    admin_library: ckeditor5/admin.basic

    conditions:

      foo: bar

YAML,

      'The "ckeditor5_invalid_plugin_foo_bar" CKEditor 5 plugin definition has a "drupal.conditions" value that contains some unsupported condition types: "foo". Only the following conditions types are supported: "toolbarItem", "imageUploadStatus", "filter", "plugins".',

    ];

    yield 'invalid condition: toolbarItem' => [

      <<<YAML

ckeditor5_invalid_plugin_foo_bar:

  ckeditor5:

    plugins: {}

  drupal:

    label: "Foo bar"

    elements:

      - <foo>

      - <bar>

    admin_library: ckeditor5/admin.basic

    conditions:

      toolbarItem: [bold, italic]

YAML,

      'The "ckeditor5_invalid_plugin_foo_bar" CKEditor 5 plugin definition has an invalid "drupal.conditions" item. "toolbarItem" is set to an invalid value. A string corresponding to a CKEditor 5 toolbar item must be specified.',

    ];

    yield 'valid condition: toolbarItem' => [

      <<<YAML

ckeditor5_invalid_plugin_foo_bar:

  ckeditor5:

    plugins: {}

  drupal:

    label: "Foo bar"

    elements:

      - <foo>

      - <bar>

    admin_library: ckeditor5/admin.basic

    conditions:

      toolbarItem: bold

YAML,

      NULL,

    ];

    yield 'invalid condition: filter' => [

      <<<YAML

ckeditor5_invalid_plugin_foo_bar:

  ckeditor5:

    plugins: {}

  drupal:

    label: "Foo bar"

    elements:

      - <foo>

      - <bar>

    admin_library: ckeditor5/admin.basic

    conditions:

      toolbarItem: bold

      filter: true

YAML,

      'The "ckeditor5_invalid_plugin_foo_bar" CKEditor 5 plugin definition has an invalid "drupal.conditions" item. "filter" is set to an invalid value. A string corresponding to a filter plugin ID must be specified.',

    ];

    yield 'valid condition: filter' => [

      <<<YAML

ckeditor5_invalid_plugin_foo_bar:

  ckeditor5:

    plugins: {}

  drupal:

    label: "Foo bar"

    elements:

      - <foo>

      - <bar>

    admin_library: ckeditor5/admin.basic

    conditions:

      toolbarItem: bold

      filter: filter_caption

YAML,

      NULL,

    ];

    yield 'invalid condition: imageUploadStatus' => [

      <<<YAML

ckeditor5_invalid_plugin_foo_bar:

  ckeditor5:

    plugins: {}

  drupal:

    label: "Foo bar"

    elements:

      - <foo>

      - <bar>

    admin_library: ckeditor5/admin.basic

    conditions:

      toolbarItem: bold

      filter: filter_caption

      imageUploadStatus: 'true'

YAML,

      'The "ckeditor5_invalid_plugin_foo_bar" CKEditor 5 plugin definition has an invalid "drupal.conditions" item. "imageUploadStatus" is set to an invalid value. A boolean indicating whether image uploads must be enabled (true) or not (false) must be specified.',

    ];

    yield 'valid condition: imageUploadStatus' => [

      <<<YAML

ckeditor5_invalid_plugin_foo_bar:

  ckeditor5:

    plugins: {}

  drupal:

    label: "Foo bar"

    elements:

      - <foo>

      - <bar>

    admin_library: ckeditor5/admin.basic

    conditions:

      toolbarItem: bold

      filter: filter_caption

      imageUploadStatus: true

YAML,

      NULL,

    ];

    yield 'invalid condition: plugins' => [

      <<<YAML

ckeditor5_invalid_plugin_foo_bar:

  ckeditor5:

    plugins: {}

  drupal:

    label: "Foo bar"

    elements:

      - <foo>

      - <bar>

    admin_library: ckeditor5/admin.basic

    conditions:

      toolbarItem: bold

      filter: filter_caption

      imageUploadStatus: true

      plugins: ckeditor5_imageCaption

YAML,

      'The "ckeditor5_invalid_plugin_foo_bar" CKEditor 5 plugin definition has an invalid "drupal.conditions" item. "plugins" is set to an invalid value. A list of strings, each corresponding to a CKEditor 5 plugin ID must be specified.',

    ];

    yield 'valid condition: plugins' => [

      <<<YAML

ckeditor5_invalid_plugin_foo_bar:

  ckeditor5:

    plugins: {}

  drupal:

    label: "Foo bar"

    elements:

      - <foo>

      - <bar>

    admin_library: ckeditor5/admin.basic

    conditions:

      toolbarItem: bold

      filter: filter_caption

      imageUploadStatus: true

      plugins: [ckeditor5_imageCaption]

YAML,

      NULL,

    ];

    yield 'unconditional: for plugins that should always loaded' => [

      <<<YAML

ckeditor5_invalid_plugin_foo_bar:

  ckeditor5:

    plugins: {}

  drupal:

    label: "Foo bar"

    elements:

      - <foo>

      - <bar>

    admin_library: ckeditor5/admin.basic

    conditions: []

YAML,

      NULL,

    ];

    yield 'explicitly unconditional' => [

      <<<YAML

ckeditor5_invalid_plugin_foo_bar:

  ckeditor5:

    plugins: {}

  drupal:

    label: "Foo bar"

    elements:

      - <foo>

      - <bar>

    admin_library: ckeditor5/admin.basic

    conditions: false

YAML,

      NULL,

    ];



    // Add a plugin class; observe what additional requirements need to be met.

    yield 'added plugin class' => [

      <<<YAML