Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Apologies for the title. I wasn't sure how to make it more succinct.
Problem/Motivation
Handlers provided by modules are removed from the webform if the providing module is selected for uninstall even if the confirmation form for the un-installation is cancelled.
Steps to reproduce
- go to https://simplytest.me/
- Choose Webform ( I tested 5.16, 5.22 and 5.23-beta1)
- When logged in, install the Webform Scheduled Email Handler module
- Go to the Emails/Handlers for the default Contact webform
- Add a Scheduled Email Handler with any configuration
- Go to the module Uninstall form
- Select Webform Scheduled Email Handler to uninstall and click the Uninstall button
- You will see the uninstall confirm form which will list the contact form as an item to have configuration updated
- Click Cancel
- Return to the Emails/Handlers for the Contact form
- The Scheduled email handler will not be present anymore
The handler actually drops off of the webform as soon as the uninstall button is clicked on the uninstall list.
If you open the uninstall form in a new tab and get to the uninstall confirmation screen and then check your Handlers again in another tab your handler will be gone.
I noticed this when testing a custom module that is providing a webform handler. I was testing the uninstall/install process for the module and noticed that my handlers went missing even though I had chickened out and not uninstalled the module just yet. I had cancelled the uninstall at the confirmation form.
I then tried it with a handler provided by the webform module proper and experienced the same thing. Three tests on separate simplytest.me instances with nothing else installed have done the same thing. I'm not sure in the slightest yet why this happens.
Proposed resolution
Prevent handlers from being removed from webforms until their providing modules are fully uninstalled.
Remaining tasks
User interface changes
API changes
Data model changes
| Comment | File | Size | Author |
|---|---|---|---|
| #3 | 3183339-3.patch | 1.1 KB | jrockowitz |
| |||
| #2 | 3183339-2.patch | 1.96 KB | jrockowitz |
Comments
Comment #2
jrockowitz CreditAttribution: jrockowitz as a volunteer and at The Big Blue House commentedI was able to reproduce this issue and the attached patch fixes it but \Drupal\webform\Plugin\WebformHandlerInterface::deleteHandler is no longer invoked when a handler is deleted while its dependant module is uninstalled.
Still, I agree that this is a major bug where a handler is globally removed if someone just considers uninstalling its associated module.
Comment #3
jrockowitz CreditAttribution: jrockowitz as a volunteer and at The Big Blue House commentedComment #4
jimmynash CreditAttribution: jimmynash commentedI tested the patch manually against my older version on my project at 5.16 and it did work.
I don't know what you mean about the deleteHandler not being invoked though. Is that a side effect of the patch in #3?
I still need to test this against an updated version but it did work for where I'm at now.
Thanks!
Comment #5
jrockowitz CreditAttribution: jrockowitz as a volunteer and at The Big Blue House commentedWhen the handler was deleted via the uninstall screen,
Webform::deleteWebformHandler was being invoked. With this patch, Webform::deleteWebformHandle is no longer invoked when a handler is uninstalled. This is a very minor change and I doubt anyone is using \Drupal\webform\Plugin\WebformHandlerInterface::deleteHandler
Comment #7
jrockowitz CreditAttribution: jrockowitz as a volunteer and at The Big Blue House commentedI committed the patch since it addresses a Major issue. Please download the latest dev release to review.