Replace Drush deprecated functions [#3164855]

Replace

drush_log
drush_print
drush_shell_exec
drush_shell_cd_and_exec
drush_get_context

Test script

## Developer tools

# Confirm that output list all update config files.
drush webform:devel:config:update

# Confirm that outout states 'Resetting message closed via *…'
drush webform:devel:reset

# Confirm that output states Documents generated to '/modules/sandbox/webform/html'.
drush webform:docs

# Confirm repair is execute
drush webform:repair

# Confirm schedule email cron is executed
drush webform:scheduled-email:cron

# Confirm YAML is tidied.
drush webform:tidy

## Composer

# Confirm that the website's composer.json file is update
drush webform:composer:update

## Libraries

# Confirm composer.json is generated
drush webform:libraries:composer

# Confirm that libraries are remove
drush webform:libraries:remove

# Confirm that libraries statuses is CDN
drush webform:libraries:status

# Confirm that libraries are download
drush webform:libraries:download

# Confirm that libraries statuses is Installed
drush webform:libraries:status

## Submissions

# Purge all contact submissions
drush -y webform:purge contact

# Generate 10 contact submissions
drush webform:generate contact 10

# Create a webform node and generate submissions
# @see /admin/structure/webform/manage/contact/references
drush webform:generate --entity-type=node --entity-id=16 contact 10

# Test invalidate source entity
drush webform:generate --entity-type=user --entity-id=1 contact 10

# Export all contact submissions
drush webform:export contact

# Export only contact webform node submissions
drush webform:export --entity-type=node --entity-id=16 contact

# Export latest 5 contact submissions
# THE BELOW COMMAND IS NOT WORKING AS EXPECTED.
drush webform:export --range-type=latest --range-latest=5 contact

# Export 10 contact submissions to a CSV file
drush webform:export --exporter=webform_submission_export_import contact > ~/contact.csv
cat ~/contact.csv

# Purge all contact submissions and confirm
drush -y webform:purge contact
drush webform:export contact

# Import all exported contact submissions in the CSV file
drush webform:import contact ~/contact.csv

# Confirm that there are now 10 restored submission
drush webform:export contact
drush webform:export --entity-type=node --entity-id=16 contact

# Confirm no orphaned submissions are found
drush webform:remove:orphans

Comment	File	Size	Author
#29	3164855-6.x-29.patch	21.2 KB	jrockowitz
#28	3164855-28.patch	21.26 KB	jrockowitz
#28	interdiff-3164855-27-28.txt	12.23 KB	jrockowitz
#27	3164855-8.x-5.x-27.patch	9.64 KB	jrockowitz
#23	3164855-23.patch	9.58 KB	paulocs
#23	interdiff-18-23.txt	237 bytes	paulocs
#18	interdiff-13-18.txt	2.73 KB	paulocs
#18	3164855-18.patch	9.3 KB	paulocs
#13	3164855-13.patch	8.68 KB	Pooja Ganjage
#10	3164855-10.patch	7.32 KB	jrockowitz
#10	interdiff-3164855-8-10.txt	3.25 KB	jrockowitz
#8	webform-replace_drush_deprecated_functions-3164855-8.patch	6.64 KB	zipymonkey
#6	webform-replace_drush_deprecated_functions-3164855-6.patch	6.6 KB	paulocs
#6	interdiff-2-6.txt	2.27 KB	paulocs
#2	webform-replace_drush_deprecated_functions-3164855-2.patch	6 KB	alexshipilov

Comments

Comment #1

12 August 2020 at 16:14

alexshipilov created an issue. See original summary.

Status	File	Size
new	webform-replace_drush_deprecated_functions-3164855-2.patch	6 KB

Comment #3

jrockowitz commented 12 August 2020 at 17:10

Comment #4

jrockowitz commented 12 August 2020 at 17:12

Thanks for contributing the patch. I linked to some related issues which include additional deprecated functions.

Comment #5

jrockowitz commented 23 August 2020 at 14:14

Status:

Needs review

» Needs work

Comment #6

paulocs

Portuguese, Brazil

Belo Horizonte

commented 10 November 2020 at 14:30

Status:

Needs work

» Needs review

Status	File	Size
new	interdiff-2-6.txt	2.27 KB
new	webform-replace_drush_deprecated_functions-3164855-6.patch	6.6 KB

Replaced deprecated $drupal_root = $this->drush_get_context('DRUSH_DRUPAL_ROOT');

Comment #7

ryan.ryan commented 19 November 2020 at 18:38

Issue summary:

View changes

I'm adding `drush_get_context` to the list, as it breaks `drush webform:composer:update`.

Comment #8

zipymonkey commented 19 January 2021 at 15:55

Status	File	Size
new	webform-replace_drush_deprecated_functions-3164855-8.patch	6.64 KB

Re-rolled the patch for the 6.0.0 release.

Comment #9

paulocs

Portuguese, Brazil

Belo Horizonte

commented 21 January 2021 at 16:44

Status:

Needs review

» Reviewed & tested by the community

For me it looks good!

Status	File	Size
new	interdiff-3164855-8-10.txt	3.25 KB
new	3164855-10.patch	7.32 KB

Comment #11

jrockowitz commented 12 March 2021 at 22:46

Status:

Reviewed & tested by the community

» Needs work

When someone has the chance they should merge the patch from #3194753: Patch to remove drush 10 warning

It would be awesome if someone could review and test all the existing webform commands in Drush 10.x.

I am currently not using Drush 10.x and this seems like a reasonable task to delegatete

Comment #12

paulocs

Portuguese, Brazil

Belo Horizonte

commented 16 March 2021 at 21:13

I found a problem when generating submissions.
Call to undefined function Drupal\webform\Plugin\DevelGenerate\drush_get_option()
I didn't have time to create a patch yet, but it has a problem.

Comment #13

Pooja Ganjage commented 17 March 2021 at 14:54

Status	File	Size
new	3164855-13.patch	8.68 KB

Hi,

Creating a patch as suggested in #12 comment.

Please review the patch.

Thanks.

Comment #14

Pooja Ganjage commented 17 March 2021 at 14:54

Status:

Needs work

» Needs review

Comment #15

jrockowitz commented 17 March 2021 at 14:56

Due to the complexity and challenge of this task, we might want to do interdiff's between patches. This will help people understand what is being fixed/improved.

@see https://www.drupal.org/docs/develop/git/using-git-to-contribute-to-drupa...

Comment #16

jrockowitz commented 17 March 2021 at 14:57

On a slightly related note, we might have to remove the support layer for Drush 8 in the new future.

Comment #17

paulocs

Portuguese, Brazil

Belo Horizonte

commented 17 March 2021 at 23:50

Assigned:

Unassigned

» paulocs

Patch #13 doesn't work.
I'll work on it.

Comment #18

paulocs

Portuguese, Brazil

Belo Horizonte

commented 18 March 2021 at 11:05

Assigned:

paulocs

» Unassigned

Status	File	Size
new	3164855-18.patch	9.3 KB
new	interdiff-13-18.txt	2.73 KB

I created a new patch so now webform-generate drush command is working.
I see that the _validateDrushParams() method is never used and maybe can be removed or used in generateElements() but it is not in the issue scope.
I'm atttaching a patch and interdiff 13-18.

Comment #19

paulocs

Portuguese, Brazil

Belo Horizonte

commented 20 March 2021 at 02:06

I tested webform-export, webform-import and webform-generate. They look good with drush 10.
The other commands still must be tested.

Comment #20

collinhaines commented 7 April 2021 at 14:20

I tested webform:libraries:download (thereby also testing webform:libraries:remove) with patch #18 and all libraries downloaded. Webform v6.0.2, Drush v10.4.2.

Comment #21

paulocs

Portuguese, Brazil

Belo Horizonte

commented 27 April 2021 at 13:09

Status:

Needs review

» Reviewed & tested by the community

I finished to test the commands webform-purge, webform-tidy, webform-libraries-status, webform-libraries-make, webform-libraries-composer, webform-repair, webform-remove-orphans, webform-docs (It works with drush 10 but the README module is no longer supported), webform-composer-update, webform-generate-commands.

They all look good with Drush 10, so moving to RTBC.

Comment #22

paulocs

Portuguese, Brazil

Belo Horizonte

commented 27 April 2021 at 14:06

Status:

Reviewed & tested by the community

» Needs work

Moving back to NW to merge patch from #3194753: Patch to remove drush 10 warning

Comment #23

paulocs

Portuguese, Brazil

Belo Horizonte

commented 27 April 2021 at 14:09

Status:

Needs work

» Reviewed & tested by the community

Status	File	Size
new	interdiff-18-23.txt	237 bytes
new	3164855-23.patch	9.58 KB

Adding the merged patch.

Comment #24

jrockowitz commented 22 May 2021 at 02:38

Continuing from #16

I am hoping once Drupal 9.x is the only supported version for Webform 6.x, we only support Drush 10.x.

@see https://www.drush.org/latest/install/#drupal-compatibility

Comment #25

jrockowitz commented 22 June 2021 at 12:17

Issue summary:

View changes

Comment #26

jrockowitz commented 22 June 2021 at 20:36

Issue summary:

View changes

Comment #27

jrockowitz commented 23 June 2021 at 11:48

Status	File	Size
new	3164855-8.x-5.x-27.patch	9.64 KB

Here is a backport to 8.x-5.x which I am going to test and hopefully commit.

Comment #28

jrockowitz commented 23 June 2021 at 12:43

Version:	6.x-dev	» 8.x-5.x-dev
Issue summary:	View changes
Status:	Reviewed & tested by the community	» Needs review

Status	File	Size
new	interdiff-3164855-27-28.txt	12.23 KB
new	3164855-28.patch	21.26 KB

The attached patch is for Webform 8.x-5.x and should be easy to apply to 6.x

The changes include...

Using Drush::bootstrapManager()->getRoot();
Removing Drush make support. Everyone needs to move to Composer.
Fix a minor issue with webform libraries
Cleaning up #3214974: [PHP8] - call_user_func_array problems

I ran through the test script using Drush 9 and now I will try Drush 10.

Comment #29

jrockowitz commented 23 June 2021 at 12:52

Status	File	Size
new	3164855-6.x-29.patch	21.2 KB

I just ran through the test script in Drush 10 and it is working great.

Attached is the same patch for Webform 6.x

Comment #30

23 June 2021 at 13:13

jrockowitz authored 72e3b99 on 8.x-5.x

Issue #3164855 by jrockowitz, paulocs, alexshipilov, Pooja Ganjage,...

Comment #31

23 June 2021 at 13:13

jrockowitz authored 72e3b99 on 6.x

Issue #3164855 by jrockowitz, paulocs, alexshipilov, Pooja Ganjage,...

Comment #32

jrockowitz commented 23 June 2021 at 13:13

Status:

Needs review

» Fixed

Comment #33

7 July 2021 at 13:14

Status:

Fixed

» Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

Replace Drush deprecated functions

Comments

Related issues

Referenced by