Automated Drupal 11 compatibility fixes for markdown

We are in the Drupal 7 to Drupal 11 migration. Not having a Drupal 11 Release of the Markdown module is blocking for us. If it is not fixed in the meantime, I'll have a look at this issue.

Note - I use Markdown to include module documentation, not with the text editor.

* web/modules/patched/markdown/src/Annotation/ComposerPackage.php 34 Call to deprecated method getInstalledVersion() of class Drupal\markdown\Util\Composer. Deprecated in markdown:8.x-2.0 and is removed from markdown:4.0.0. No replacement.

Marked as deprecated. Delete now?

* web/modules/patched/markdown/src/Annotation/ComposerPackage.php 34 Call to deprecated method getVersionFromClass() of class Drupal\markdown\Util\Composer. Deprecated in markdown:8.x-2.0 and is removed from markdown:4.0.0. No replacement.

As above

* web/modules/patched/markdown/src/BcSupport/SubformState.php 16 Class Drupal\markdown\BcSupport\SubformState extends deprecated class Drupal\markdown\BcSupport\FormStateDecoratorBase. Deprecated in markdown:8.x-2.0 and is removed from markdown:3.0.0. Use Drupal\Core\Form\FormStateDecoratorBase instead.

Delete now

Delete the whole BCSupport package

I can't see the referenced @todo Move upstream to https://www.drupal.org/project/installable_plugins. Something here https://www.drupal.org/docs/drupal-apis/plugin-api?

I can't see any references to "InstallablePlugin" outside of markdown. Is this a custom concept for markdown to manage the parsers?

This refactoring does fall apart here.

* web/modules/patched/markdown/src/Exception/MarkdownFileNotExistsException.php 11 Class Drupal\markdown\Exception\MarkdownFileNotExistsException extends deprecated class Drupal\markdown\Exception\MarkdownException. Deprecated in markdown:8.x-2.0 and is removed from markdown:3.0.0. Use Drupal\markdown\Exception\MarkdownExceptionInterface instead.

Refactor now.

PluginBase
PluginInterface

What is a similar module? 'Crop'? Footnotes?

Breaks in drush

PHP Fatal error: Trait "Symfony\Component\DependencyInjection\ContainerAwareTrait" not found in /Users/jrobens/Sites/gardensofstone2/web/modules/patched/markdown/src/PluginManager/InstallablePluginManager.php on line 32

Means this module isn't usable for me.

The best shot I can find to implement plugins is from 'feeds tamper'. I can take a shot at implementing this if it helps

use Drupal\Component\Plugin\PluginManagerInterface;
use Drupal\Core\Plugin\DefaultLazyPluginCollection;

ContainerAwareTrait has been deprecated
https://www.drupal.org/project/drupal/issues/3431362

Sometimes, a service needs access to several other services without being sure that all of them will actually be used. In those cases, you may want the instantiation of the services to be lazy. However, that's not possible using the explicit dependency injection since services are not all meant to be lazy.

CacheFactory, CacheTagsInvalidator, CheckProvider, StreamWrapperManager, KernelDestructionSubscriber all look like they could use this technique.

EntityTypeManager and ClassResolver are more tricky and need access to the entire container, but I think we could just inject the container as a service in these cases.

Used git pull and enabled the markdown module:

Trait "Symfony\\Component\\DependencyInjection\\ContainerAwareTrait" not found in /web/modules/patched/markdown/src/PluginManager/InstallablePluginManager.php on line 32

ContainerAwareTrait is deprecated in Symfony.: https://www.drupal.org/project/drupal/issues/3415938
ContainerAwareInterface deprecated

Drupal\Component\Plugin

current output of drush us-a markdown

Markdown,  3.0.1
Scanned on Wed, 8 Jan 2025 - 08:33

FILE: modules/contrib/markdown/src/PluginManager/InstallablePluginManager.php

STATUS         LINE                           MESSAGE
--------------------------------------------------------------------------------
Check manually 478  Call to deprecated method convertInstalledToLibraries() of
                    class
                    Drupal\markdown\PluginManager\InstallablePluginManager.
                    Deprecated in markdown:8.x-2.0 and is removed from
                    markdown:3.0.0. There is no replacement.
--------------------------------------------------------------------------------

I have applied !37. The site ran OK.

The use case is atypical. Prints out the README.md file as part of help. An error that I will follow up on

Error      Error: Call to undefined method League\CommonMark\CommonMarkConverter::convert() in                                                          
                                                Drupal\markdown\Plugin\Markdown\CommonMark\CommonMark->convertToHtml() (line 183 of                                                          
                                                web/modules/patched/markdown/src/Plugin/Markdown/CommonMark/CommonMark.php).  

The code is

else {
        // Use the Markdown filter to render the README.
        $filter_manager = \Drupal::service('plugin.manager.filter');
        $settings = \Drupal::configFactory()->get('markdown.settings')->getRawData();
        $config = ['settings' => $settings];
        $filter = $filter_manager->createInstance('markdown', $config);
        return $filter->process($text, 'en');
      }

This was on Drupal 10. The version of commonMark that was installed with Drupal 10 does not appear compatible. This problem does not occur on drupal 11. Original version league/commonmark:1.6.7

One more error on Drupal 11

drush cr

In ContainerBuilder.php line 1345:

The service "markdown_plugin_manager" tagged "plugin_manager_cache_clear" must not be abstract.

Got an error on cache clear as follows so resolved the issue.

PHP Fatal error:  Type of Drupal\markdown\Form\OverviewForm::$typedConfigManager must not be defined (as in class Drupal\Core\Form\ConfigFormBase) in /var/www/html/web/modules/contrib/markdown/src/Form/OverviewForm.php on line 0

Fatal error: Type of Drupal\markdown\Form\OverviewForm::$typedConfigManager must not be defined (as in class Drupal\Core\Form\ConfigFormBase) in /var/www/html/web/modules/contrib/markdown/src/Form/OverviewForm.php on line 0
 [warning] Drush command terminated abnormally.

Please review.

I got a fatal error on a D10 site:

Error: Call to undefined method League\CommonMark\CommonMarkConverter::convert() in Drupal\markdown\Plugin\Markdown\CommonMark\CommonMark->convertToHtml() (line 183 of /Users/youri/Websites/drupal/modules/wip/markdown/src/Plugin/Markdown/CommonMark/CommonMark.php).

Is it possible that the code drops support for CommonMark v1? And is that necessary? I would say that should be handled in #3283349: Add support for Commonmark v2. So I think that commit 3283349 should be reverted.

@megachriz The module should probably drop support for Commonmark v1 given it is insecure / out of support. But I agree that is best handled in #3283349: Add support for Commonmark v2

I reverted a commit. I think it would also be a good idea to revert anything that tries to fix deprecations from Markdown itself. However, if fixing these deprecations is necessary for Drupal 11 support, they should of course be done, but even in that case I think it would still be better to handle these in an other issue first. Because it looks like that some attempts to fix these deprecations here introduced new bugs.

I've checked MR !37 and it says: "Test summary: 350 failed, 425 total tests"

Do we need to refactor it?

Also, after applying the patch, I've scanned it with the upgrade status module. The result is below:

CONTRIBUTED PROJECTS
--------------------------------------------------------------------------------
Markdown
Scanned on Thu, 08/28/2025 - 12:14.

9 warnings found.

web/modules/contrib/markdown/src/Plugin/Markdown/CommonMark/CommonMark.php:
+----------------+------+-----------------------------------------------------------------------------------------------------------------------------------+
| status         | line | message                                                                                                                           |
+----------------+------+-----------------------------------------------------------------------------------------------------------------------------------+
| Check
manually | 183  | Call to deprecated method convertToHtml() of class
League\CommonMark\MarkdownConverter: since 2.2; use {@link
convert()} instead
 |
+----------------+------+-----------------------------------------------------------------------------------------------------------------------------------+
web/modules/contrib/markdown/src/Plugin/Markdown/InstallablePluginBase.php:
+----------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| status         | line | message                                                                                                                                                                                                                                                               |
+----------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Check
manually | 95   | Call to method getPluginCollections() of deprecated
interface
Drupal\markdown\BcSupport\ObjectWithPluginCollectionInterfac
e. Deprecated in markdown:8.x-2.0 and is removed from
markdown:3.0.0. Use
Drupal\Core\Plugin\ObjectWithPluginCollectionInterface
instead.
 |
+----------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
web/modules/contrib/markdown/src/PluginManager/AllowedHtmlManager.php:
+----------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| status         | line | message                                                                                                                                                                                                               |
+----------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Check
manually | 454  | Access to deprecated property $requiresFilter of class
Drupal\markdown\Annotation\MarkdownAllowedHtml. Deprecated
in markdown:8.x-2.0 and is removed from markdown:3.0.0. Use
the "requirements" properties instead.
 |
| Check
manually | 460  | Access to deprecated property $requiresFilter of class
Drupal\markdown\Annotation\MarkdownAllowedHtml. Deprecated
in markdown:8.x-2.0 and is removed from markdown:3.0.0. Use
the "requirements" properties instead.
 |
+----------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
web/modules/contrib/markdown/src/PluginManager/InstallablePluginManager.php:
+----------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| status         | line | message                                                                                                                                                                                                               |
+----------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Check
manually | 214  | Call to method setContainer() of deprecated interface
Symfony\Component\DependencyInjection\ContainerAwareInterfac
e: since Symfony 6.4, use dependency injection instead
                                            |
| Check
manually | 478  | Call to deprecated method convertInstalledToLibraries() of
class
Drupal\markdown\PluginManager\InstallablePluginManager.
Deprecated in markdown:8.x-2.0 and is removed from
markdown:3.0.0. There is no replacement.
 |
| Check
manually | 561  | Access to deprecated property $versionConstraint of class
Drupal\markdown\Annotation\InstallableLibrary. Deprecated in
markdown:8.x-2.0 and is removed from markdown:3.0.0. Use the
"requirements" property instead.
 |
| Check
manually | 565  | Access to deprecated property $versionConstraint of class
Drupal\markdown\Annotation\InstallableLibrary. Deprecated in
markdown:8.x-2.0 and is removed from markdown:3.0.0. Use the
"requirements" property instead.
 |
+----------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
web/modules/contrib/markdown/markdown.info.yml:
+----------------+------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| status         | line | message                                                                                                                                            |
+----------------+------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| Check
manually | 5    | Value of core_version_requirement: ^9.2 | ^10 is not
compatible with the next major version of Drupal core. See
https://drupal.org/node/3070687.
 |
+----------------+------+----------------------------------------------------------------------------------------------------------------------------------------------------+

Thanks all for helping get this over the hump. There still might be bugs but I tested it and fixed most of the tests in D11 with CommonMark 2. I left common mark 1.6 support for any BC but anybody on that should jump to 2.7 because of the security stuff there.

This is great, thanks! Could you publish a new release?

@fmb not quite yet. Working on getting a bunch of fixes and phpstan clean up first #3373147: Fix phpstan deprecation errors Then I will feel more comfortable with a release.

All right, thanks!

And I see lots of test failures with Drupal Core 11.3.x-dev, while all tests pass with Drupal Core 11.2.8. 🤔
I hope my client will give me some time to help with this.

This caused an issue with headings in CommonMark GFM: #3580640: CommonMark GFM does not format headings