[Drupal 9.x] Declaration of Drupal\webform\Plugin\DevelGenerate\WebformSubmissionDevelGenerate::validateDrushParams($args) must be compatible with Drupal\devel_generate\DevelGenerateBaseInterface::validateDrushParams(array $args, array $options = Array)

According to @weitzman:

Packages are welcome to use the conflict metadata built into Composer, among other mechanisms.

So it seems it is up to Webform to make sure it does not use an incompatible base plugin.

Thanks! I like the idea, (although in a perfect world I don't think it should be up to module maintainers to do this, as I've documented in #3155737: If a Throwable occurs when a Plugin is loaded, log an error and move on, do not die with a fatal error). One potential issue is that this patch assumes there is a "version" string in /var/www/html/modules/contrib/devel/devel_generate/devel_generate.info.yml, but $info['version'] will be NULL for users who have the development snapshot of devel-8.x-2.x. Probably an edge case, but I thought it worth mentioning!

I will set to "needs work" the following scenario still fails.

Step 1:

Install Webform 5.18 and Devel 8.x-2.1

Step 2:

Apply the patch from #3 to Webform

Step 3:

drush en webform_example_custom_form webform_ui devel devel_generate -y

Step 4:

/admin/structure/webform/manage/webform_example_custom_form/handlers

Step 5:

Press "+ add email" and in the "Add Email handler" section, press "Save"

Step 6:

Go to /webform/webform_example_custom_form/test

Step 7:

Press "Submit". For me, I am expecting it to work, but I get:

Fatal error: Declaration of Drupal\webform\Plugin\DevelGenerate\WebformSubmissionDevelGenerate::validateDrushParams(array $args, array $options = Array) must be compatible with Drupal\devel_generate\DevelGenerateBaseInterface::validateDrushParams($args) in /var/www/html/modules/contrib/webform/src/Plugin/DevelGenerate/WebformSubmissionDevelGenerate.php on line 32

I can confirm webform_devel_generate_info_alter() is being called and "strpos($info['version'], '8.x-') === 0" returns TRUE, so something else seems to be triggering this problem.

For what it's worth, steps 4 and 5, above, are necessary to reproduce the problem; if you don't add an email handler everything works fine.

Thanks. I'm still getting the error so I reinstalled everything from scratch, including Drupal and Drush, on a completely new Docker container, and I still cannot get this patch to work with devel 2.1.

Seems to be related to the autoloading mechanism and webform sending an email.

Here are complete steps starting from a blank machine:

* Install drush 10.3.0
* Install Drupal 8.9.1
* Install a fresh Drupal:

drush si -y

* Download webform and devel

export COMPOSER_MEMORY_LIMIT=-1 && composer require drupal/webform drupal/devel:~2.1

* Make sure we have the 2.1 version of devel and the latest version of webform:

$ drush pml|grep \(webform\)
  Webform         Webform (webform)                   Disabled   8.x-5.18       
$ drush pml|grep \(devel_generate\)
  Development     Devel Generate (devel_generate)     Disabled   8.x-2.1        

* Enable some modules:

drush en webform_example_custom_form webform_ui devel devel_generate -y

* Apply the patch

cd /var/www/html/modules/contrib/webform
curl -O https://www.drupal.org/files/issues/2020-06-30/3155654-6.patch
patch -p1 < 3155654-6.patch
rm 3155654-6.patch

* Clear all caches for good measure:

drush cr
drush cc drush

* Log in as user 1 and go to /admin/structure/webform/manage/webform_example_custom_form/handlers

* Press "+ add email" and in the "Add Email handler" section, press "Save"

* Go to /webform/webform_example_custom_form/test

* Press "Submit". For me, I am expecting it to work, but I still get the error.

Fatal error: Declaration of Drupal\webform\Plugin\DevelGenerate\WebformSubmissionDevelGenerate::validateDrushParams(array $args, array $options = Array) must be compatible with Drupal\devel_generate\DevelGenerateBaseInterface::validateDrushParams($args) in /var/www/html/modules/contrib/webform/src/Plugin/DevelGenerate/WebformSubmissionDevelGenerate.php on line 32

I added the following code before the class declaration (just after the "use" declarations) at /var/www/html/modules/contrib/webform/src/Plugin/DevelGenerate/WebformSubmissionDevelGenerate.php:

die(print_r(debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS)));

Here is a partial trace which leads to WebformSubmissionDevelGenerate being autoloaded instead of WebformSubmissionDevelGenerateDeprecated:

Array
(
    [0] => Array
        (
            [file] => /var/www/html/vendor/composer/ClassLoader.php
            [line] => 444
            [function] => include
        )

    [1] => Array
        (
            [file] => /var/www/html/vendor/composer/ClassLoader.php
            [line] => 322
            [function] => Composer\Autoload\includeFile
        )

    [2] => Array
        (
            [function] => loadClass
            [class] => Composer\Autoload\ClassLoader
            [type] => ->
        )

    [3] => Array
        (
            [file] => /var/www/html/modules/contrib/webform/webform.module
            [line] => 392
            [function] => spl_autoload_call
        )

    [4] => Array
        (
            [file] => /var/www/html/core/lib/Drupal/Core/Mail/MailManager.php
            [line] => 271
            [function] => webform_mail
        )

    [5] => Array
        (
            [file] => /var/www/html/core/lib/Drupal/Core/Mail/MailManager.php
            [line] => 179
            [function] => doMail
            [class] => Drupal\Core\Mail\MailManager
            [type] => ->
        )

    [6] => Array
        (
            [file] => /var/www/html/core/lib/Drupal/Core/Render/Renderer.php
            [line] => 573
            [function] => Drupal\Core\Mail\{closure}
            [class] => Drupal\Core\Mail\MailManager
            [type] => ->
        )

    [7] => Array
        (
            [file] => /var/www/html/core/lib/Drupal/Core/Mail/MailManager.php
            [line] => 180
            [function] => executeInRenderContext
            [class] => Drupal\Core\Render\Renderer
            [type] => ->
        )

    [8] => Array
        (
            [file] => /var/www/html/modules/contrib/webform/src/Plugin/WebformHandler/EmailWebformHandler.php
            [line] => 1202
            [function] => mail
            [class] => Drupal\Core\Mail\MailManager
            [type] => ->
        )

I cannot make sense of why we are loading this as it is useless to send emails, but that seems to be how it's done.

Thanks @jrockowitz

So our situation now is we both have:

* New standard install of Drupal 8.9.1
* Drush 10.3.0
* Webform 8.x-5.18 with the patch at #6
* Devel 8.x-2.1 (not 4.0.0)'s devel_generate enabled
* A webform with an Email handler

In your case after clearing drush and drupal cache (drush cr; drush cc drush) you can submit the webform with the email handler and you do not get a fatal error.

In my case after clearing drush and drupal cache (drush cr; drush cc drush) I systematically get the fatal error.

The only thing which might differ between our environments, then, is the PHP version and composer file. Anything else?

My php version is

PHP 7.4.7 (cli) (built: Jun 11 2020 18:33:07) ( NTS )
Copyright (c) The PHP Group
Zend Engine v3.4.0, Copyright (c) Zend Technologies
    with Zend OPcache v7.4.7, Copyright (c), by Zend Technologies

And my composer file is:

{
    "name": "drupal/recommended-project",
    "description": "Project template for Drupal 8 projects with a relocated document root",
    "type": "project",
    "license": "GPL-2.0-or-later",
    "homepage": "https://www.drupal.org/project/drupal",
    "support": {
        "docs": "https://www.drupal.org/docs/user_guide/en/index.html",
        "chat": "https://www.drupal.org/node/314178"
    },
    "repositories": [
        {
            "type": "composer",
            "url": "https://packages.drupal.org/8"
        }
    ],
    "require": {
        "composer/installers": "^1.2",
        "drupal/bootstrap": "^3.23",
        "drupal/core-composer-scaffold": "^8.8",
        "drupal/core-project-message": "^8.8",
        "drupal/core-recommended": "^8.8",
        "drupal/core-vendor-hardening": "^8.8",
        "drupal/devel": "~2.1",
        "drupal/field_group": "^3.1",
        "drupal/masquerade": "^2.0@beta",
        "drupal/metatag": "^1.13",
        "drupal/paragraphs": "^1.12",
        "drupal/pathauto": "^1.8",
        "drupal/smtp": "^1.0@RC",
        "drupal/stage_file_proxy": "^1.0",
        "drupal/token": "^1.7",
        "drupal/webform": "^5.18",
        "drush/drush": "~10"
    },
    "require-dev": {
        "drupal/core-dev": "^8.8"
    },
    "conflict": {
        "drupal/drupal": "*"
    },
    "minimum-stability": "dev",
    "prefer-stable": true,
    "config": {
        "sort-packages": true
    },
    "extra": {
        "drupal-scaffold": {
            "locations": {
                "web-root": "./"
            }
        },
        "installer-paths": {
            "./core": ["type:drupal-core"],
            "./libraries/{$name}": ["type:drupal-library"],
            "./modules/contrib/{$name}": ["type:drupal-module"],
            "./profiles/contrib/{$name}": ["type:drupal-profile"],
            "./themes/contrib/{$name}": ["type:drupal-theme"],
            "drush/Commands/contrib/{$name}": ["type:drupal-drush"],
            "./modules/custom/{$name}": ["type:drupal-custom-module"],
            "./themes/custom/{$name}": ["type:drupal-custom-theme"]
        },
        "drupal-core-project-message": {
            "include-keys": ["homepage", "support"],
            "post-create-project-cmd-message": [
                "<bg=blue;fg=white>                                                         </>",
                "<bg=blue;fg=white>  Congratulations, you’ve installed the Drupal codebase  </>",
                "<bg=blue;fg=white>  from the drupal/recommended-project template!          </>",
                "<bg=blue;fg=white>                                                         </>",
                "",
                "<bg=yellow;fg=black>Next steps</>:",

                "  * Install the site: https://www.drupal.org/docs/8/install",
                "  * Read the user guide: https://www.drupal.org/docs/user_guide/en/index.html",
                "  * Get support: https://www.drupal.org/support",
                "  * Get involved with the Drupal community:",
                "      https://www.drupal.org/getting-involved",
                "  * Remove the plugin that prints this message:",
                "      composer remove drupal/core-project-message"
            ]
        }
    }
}

It would be cool to get to the bottom of why I can reproduce this on a new test environment and it also happens on a production environment, but in your case it does not happen...

I will leave this at "needs review" as I cannot confirm it works for me; but I cannot provide a reproducible error either.

@jrockowitz

Another question: with the following setup:

* New standard install of Drupal 8.9.1
* Drush 10.3.0
* Webform 8.x-5.18 unpatched enabled
* Devel 4.0.0 (not 8.x-2.1)'s devel_generate enabled
* A webform with an Email handler
* drush cc drush && drush cr

When you submit a webform with the email handler, can you reproduce a fatal error? If not we should bring the priority of this to normal.

Happens with PHP 7.3 also, on an Acquia environment.

I think I found the issue:

In webform.module at line 392, there is the following code:

/**
 * Implements hook_mail().
 */
function webform_mail($key, &$message, $params) {
  // Never send emails when using devel generate to create 1000's of
  // submissions.
  if (\Drupal::moduleHandler()->moduleExists('devel_generate')
    && \Drupal\webform\Plugin\DevelGenerate\WebformSubmissionDevelGenerate::isGeneratingSubmissions()) {
    $message['send'] = FALSE;
  }

Here we will need to use the correct class also (WebformSubmissionDevelGenerate for devel >= 4.0.0, otherwise WebformSubmissionDevelGenerateDeprecated.

I can't figure out why you cannot reproduce the issue, though. Are you sure devel_generate is enabled on your environment, and you are using an email handler when submitting the form?

I also did a quick search for WebformSubmissionDevelGenerate in the Webform codebase and found:

$ grep -R 'WebformSubmissionDevelGenerate' .
./webform.module:    && \Drupal\webform\Plugin\DevelGenerate\WebformSubmissionDevelGenerate::isGeneratingSubmissions()) {
Binary file ./.git/index matches
./modules/webform_demo/webform_demo_application_evaluation/webform_demo_application_evaluation.install:      /** @var \Drupal\webform\Plugin\DevelGenerate\WebformSubmissionDevelGenerate $webform_submission_devel_generate */
./modules/webform_demo/webform_demo_application_evaluation/webform_demo_application_evaluation.install:    /** @var \Drupal\webform\Plugin\DevelGenerate\WebformSubmissionDevelGenerate $webform_submission_devel_generate */
./src/WebformSubmissionGenerate.php: * @see \Drupal\webform\Plugin\DevelGenerate\WebformSubmissionDevelGenerate
./src/Plugin/DevelGenerate/WebformSubmissionDevelGenerate.php: * Provides a WebformSubmissionDevelGenerate plugin.
./src/Plugin/DevelGenerate/WebformSubmissionDevelGenerate.php:class WebformSubmissionDevelGenerate extends DevelGenerateBase implements ContainerFactoryPluginInterface {
./src/Plugin/DevelGenerate/WebformSubmissionDevelGenerate.php:   * Constructs a WebformSubmissionDevelGenerate object.
./src/WebformSubmissionGenerateInterface.php: * @see \Drupal\webform\Plugin\DevelGenerate\WebformSubmissionDevelGenerate
./src/Commands/WebformCliService.php:    /** @var \Drupal\webform\Plugin\DevelGenerate\WebformSubmissionDevelGenerate $instance */

So this might need to be fixed elsewhere also.

@jrockowitz thanks. The patch says 0 bytes and loads as a blank page for me.

This portion of the patch is causing issues for me, is it there by mistake:

diff --git a/src/WebformHelpManager.php b/src/WebformHelpManager.php
index 5802ffe9e..6c9e3157c 100644
--- a/src/WebformHelpManager.php
+++ b/src/WebformHelpManager.php
@@ -1364,12 +1364,6 @@ class WebformHelpManager implements WebformHelpManagerInterface {
         'youtube_id' => 'WQG6163r9Rs',
         'presentation_id' => '1Mn7qlSR_njTZcGAM3PNQZR8Tvg7qtPhZFQja7Mj5uzI',
       ],
-      'everyone' => [
-        'title' => $this->t('Webforms for Everyone'),
-        'content' => $this->t('This presentation explores how site owners, site builders, and developers can leverage the Webform module for Drupal 8 to build complex and robust forms for their end-users.'),
-        'youtube_id' => 'zvilAbrczGM',
-        'presentation_id' => '1APpt-55Ht_WLZc656KfQUXUoIAb-PTOmbMwSYSAw6G4',
-      ],
     ];
 

I'll set to needs work.

Thanks for the great work and fast response!

I'll set this to RTBC based on the following tests:

* Patched webform 5.18 and Devel 8.x-2.1, submitting a form with an email handler works.
* Patched webform 5.18 and Devel 4.0.0, submitting a form with an email handler works.

(I ran into #3156132: Warning: htmlspecialchars() expects parameter 1 to be string while testing thing but I think it's unrelated so I opened a new issue.)

This patch will also make it to the 6.x branch through the regular process, correct?

Related to #3447608: Fatal error: Type of Drupal\webform\Plugin\DevelGenerate\WebformSubmissionDevelGenerate::$entityTypeManager must be and #3499830: Move DevelGenerate plugin to a new webform_devel_generate module within this project