Resolving module:uninstall hanging without response #32955

tschallacka · 2021-05-05T19:55:57Z

This fix is based on #3544

Basically, when Magento command bin/magento module:uninstall Module_Name is called it will hang indefinitely, even for half an hour. The only way to exit is to CTRL +C out of it.

I posted my research in this issue here: https://blog.tschallacka.de/2021/05/binmagento-moduleuninstall-never.html but it boils down that when auth.json is not found in the Magento root dir, composer will prompt for the access keys to repo.magento.com, but as the output is contained in a BufferedOutput that doesn't output to STDOUT this isn't visible.

My proposed fix, before initiating the uninstall via composer, check if auth.json exists in the root dir.
When auth.json is not found, an FileNotFoundException is thrown, adding a reference to https://devdocs.magento.com/guides/v2.4/install-gde/prereq/dev_install.html#authentication-file so they can resolve the issue.

For testing have a module that registers a custom attribute that you remove with an uninstaller, with a missing auth.json in the Magento root directory.

<?php namespace Test\Dummy\Setup;

use Magento\Catalog\Model\Product;
use Magento\Eav\Setup\EavSetupFactory;
use Magento\Framework\Setup\ModuleContextInterface;
use Magento\Framework\Setup\SchemaSetupInterface;
use Magento\Framework\Setup\UninstallInterface;
use Symfony\Component\Console\Output\ConsoleOutput;

class Uninstall implements UninstallInterface
{
    protected $eavSetupFactory;
    protected $output;

    public function __construct(EavSetupFactory $eavSetupFactory, ConsoleOutput $output)
    {
        $this->eavSetupFactory = $eavSetupFactory;
        $this->output = $output;
    }

    /**
     * @inheritDoc
     */
    public function uninstall(SchemaSetupInterface $setup, ModuleContextInterface $context)
    {
        $eavSetup = $this->eavSetupFactory->create();
        $this->output->writeln("Starting to remove the attributes for something.");
        $eavSetup->removeAttribute(Product::ENTITY, UpgradeData::SOME_ATTRIBUTE);
    }
}

Description (*)

Added a private method ModuleUninstaller::failOnMissingAuthJson().
This method tests whether auth.json exists in the Magento root dir. When it is not found it throws a meaningful error message with a reference to the developer documentation.

This method is called in ModuleUninstaller::uninstallCode()

Related Pull Requests

Fixed Issues (if relevant)

Fixes bin/magento module:uninstall never completes #3544

Manual testing scenarios (*)

Fresh install of magento
install https://github.com/tschallacka/mage2-dummy-test
run bin/magento module:enable Test_Dummy && bin/magento setup:upgrade && bin/magento module:disable Test_Dummy && bin/magento module:uninstall Test_Dummy
Type yes twice to the questions
Process will hang forever. After roughly 30-60 seconds, only when you type gibberish/hit enter a few times you'll get the output from an exception handler.

Questions or comments

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
All automated tests passed successfully (all builds are green)

When auth.json is not found, an FileNotFoundException is thrown. This is to fix issue magento#3544 This will prevent workarounds like described at https://blog.tschallacka.de/2021/05/binmagento-moduleuninstall-never.html

m2-assistant · 2021-05-05T19:56:00Z

Hi @tschallacka. Thank you for your contribution
Here are some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests
Semantic Version Checker

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

⚠️ According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

🕙 You can find the schedule on the Magento Community Calendar page.

📞 The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

tschallacka · 2021-05-05T20:02:15Z

@magento run all tests

magento-automated-testing · 2021-05-05T20:02:19Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

tschallacka · 2021-05-05T22:35:36Z

I'm seeing a cross at the functional tests, yet I don't see any failing tests, only one yellow test that is wholly unrelated to this pr. Is that test broken?

Also, I signed the document, when wil the status update?

ihor-sviziev · 2021-05-06T06:19:32Z

setup/src/Magento/Setup/Model/ModuleUninstaller.php

+    private function failOnMissingAuthJson() 
+    {
+        $auth_json_path = BP . DIRECTORY_SEPARATOR . 'auth.json';
+        if (!file_exists($auth_json_path)) {
+            $error_message = sprintf('auth.json at %s could not be found. Refer to https://devdocs.magento.com/guides/v2.4/install-gde/prereq/dev_install.html#authentication-file how to install this file.', $auth_json_path);
+            throw new FileNotFoundException($error_message);
+        }
+    }


Are you sure it's ok to make the auth.json mandatory? I don't think so, as we might set the credentials globally.

I have set my auth.json globally, via ~/.composer/auth.json and that works fine when a manual ~ composer update or ~ composer remove xxx is run. But when this composer sub process is started up, via the ~ bin/magento module:uninstall it doesn't read from ~/.composer/auth.json for whatever reason, which then leads to the bug as is set out in the related issue as it prompts for the password behind the scenes. It only continues on when the data is present in the auth.json file.

I've made a dummy repo here of the plugin that demonstrates the issue. https://github.com/tschallacka/mage2-dummy-test

When there is an auth.json in the root it runs fine, as is highlighted in my blog post. If there is no auth.json in the root, it hangs and gives issues.

It looks like the issue is related to incorrect composer usage, so it's not reading the global auth.json file. The correct fix should fix this inconsistent behavior.

I'd be amenable to make a more comprehensive test if you could point me to where the wrapped composer instance tries to read auth.json and when it fails, if you have a better suggested course of action, to prevent the hanging screen i'm open. Just an error message like in my plugin perhaps?

I don't know exactly where that code located, but it looks like the composer remove logic is here:

magento2/lib/internal/Magento/Framework/Composer/Remove.php

Lines 41 to 52 in 8b9fff5

public function remove(array $packages)

{

$composerApplication = $this->composerApplicationFactory->create();

return $composerApplication->runComposerCommand(

[

'command' => 'remove',

'packages' => $packages,

'--no-update-with-dependencies' => true,

]

);

}

Please set the breakpoint on this code and debug deeper.

It looks like the issue is related to incorrect composer usage, so it's not reading the global auth.json file. The correct fix should fix this inconsistent behavior.

totally agree, that composer should read auth.json anywhere

@ihor-sviziev if you read my blog post at https://blog.tschallacka.de/2021/05/binmagento-moduleuninstall-never.html you can follow my tracking process how I traced the composer path related to the output. I never delved into the actual process of composer itself as it takes so many twists and turns that after 15 minutes of pressing step into I still wasn't at the auth.json search steps. I must admit I kinda gave up.

m2-assistant · 2021-05-06T08:53:06Z

Hi @tschallacka, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

tschallacka · 2021-05-06T08:55:17Z

@magento run Functional Tests B2B

magento-automated-testing · 2021-05-06T08:55:21Z

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

dharake · 2021-09-05T10:35:48Z

2.4.3 CE. Even with correct utilisation of auth.json the command bin/magento module:uninstall still hangs indefinitely at the code removal step.

Green2Matter · 2021-11-17T12:37:31Z

2.4.3-p1 CE and I'm hit by this bug. I have auth.json populated with access credentials. Any solution, workaround available?

Added a check if auth.json exists.

0624b6f

When auth.json is not found, an FileNotFoundException is thrown. This is to fix issue magento#3544 This will prevent workarounds like described at https://blog.tschallacka.de/2021/05/binmagento-moduleuninstall-never.html

magento-engcom-team added Component: Setup Release Line: 2.4 labels May 5, 2021

tschallacka mentioned this pull request May 5, 2021

bin/magento module:uninstall never completes #3544

Closed

Den4ik self-assigned this May 5, 2021

m2-community-project bot added the Progress: review label May 5, 2021

ihor-sviziev reviewed May 6, 2021

View reviewed changes

m2-community-project bot assigned ihor-sviziev May 6, 2021

ihor-sviziev added the Progress: needs update label May 6, 2021

m2-community-project bot removed the Progress: needs update label May 6, 2021

tschallacka closed this May 6, 2021

tschallacka reopened this May 6, 2021

m2-community-project bot removed the Progress: review label May 6, 2021

m2-community-project bot added the Progress: review label May 6, 2021

ihor-sviziev added the Progress: needs update label May 6, 2021

m2-community-project bot removed the Progress: needs update label May 6, 2021

ihor-sviziev added Progress: needs update and removed Progress: review labels May 6, 2021

m2-community-project bot added Progress: review and removed Progress: needs update labels May 6, 2021

ihor-sviziev removed their assignment May 6, 2021

gabrieldagama added the Priority: P3 May be fixed according to the position in the backlog. label May 13, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Resolving module:uninstall hanging without response #32955

Resolving module:uninstall hanging without response #32955

tschallacka commented May 5, 2021 •

edited

Loading

m2-assistant bot commented May 5, 2021

tschallacka commented May 5, 2021

magento-automated-testing bot commented May 5, 2021

tschallacka commented May 5, 2021

ihor-sviziev May 6, 2021

tschallacka May 6, 2021

ihor-sviziev May 6, 2021

tschallacka May 6, 2021

ihor-sviziev May 6, 2021

Den4ik May 6, 2021

tschallacka May 6, 2021

m2-assistant bot commented May 6, 2021

tschallacka commented May 6, 2021

magento-automated-testing bot commented May 6, 2021

dharake commented Sep 5, 2021

Green2Matter commented Nov 17, 2021

	public function remove(array $packages)
	{
	$composerApplication = $this->composerApplicationFactory->create();

	return $composerApplication->runComposerCommand(
	[
	'command' => 'remove',
	'packages' => $packages,
	'--no-update-with-dependencies' => true,
	]
	);
	}

Resolving module:uninstall hanging without response #32955

Are you sure you want to change the base?

Resolving module:uninstall hanging without response #32955

Conversation

tschallacka commented May 5, 2021 • edited Loading

Description (*)

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

m2-assistant bot commented May 5, 2021

tschallacka commented May 5, 2021

magento-automated-testing bot commented May 5, 2021

tschallacka commented May 5, 2021

ihor-sviziev May 6, 2021

Choose a reason for hiding this comment

tschallacka May 6, 2021

Choose a reason for hiding this comment

ihor-sviziev May 6, 2021

Choose a reason for hiding this comment

tschallacka May 6, 2021

Choose a reason for hiding this comment

ihor-sviziev May 6, 2021

Choose a reason for hiding this comment

Den4ik May 6, 2021

Choose a reason for hiding this comment

tschallacka May 6, 2021

Choose a reason for hiding this comment

m2-assistant bot commented May 6, 2021

tschallacka commented May 6, 2021

magento-automated-testing bot commented May 6, 2021

dharake commented Sep 5, 2021

Green2Matter commented Nov 17, 2021

tschallacka commented May 5, 2021 •

edited

Loading