Migrating from Laravel Deployer to Deployer 7: die() does not seem to stop the deploy anymore.

[JVFP]

Hi,

I'm trying to migrate from Laravel Deployer to Deployer 7.
Somehow die() doesn't seem to stop the deploy anymore, is that intended or am I maybe missing something?

Here's an example:

<?php

namespace Deployer;

require 'recipe/common.php';

host('example.org')
    ->set('remote_user', 'deployer')
    ->set('deploy_path', '~/example');

task('app:confirm', function () {
    if ( ! askConfirmation("Are you sure you want to deploy?")) {
        die('Ok, not deploying.');
    }
});

task('deploy', [
    'app:confirm',
    'app:confirm',
    'app:confirm',
]);

The output:

task crm:confirm
[example.org] Are you sure you want to deploy? [y/N] 
Ok, not deploying.
task crm:confirm
[example.org] Are you sure you want to deploy? [y/N] 
Ok, not deploying.
task crm:confirm
[example.org] Are you sure you want to deploy? [y/N] 
Ok, not deploying.

Expected output:

task crm:confirm
[example.org] Are you sure you want to deploy? [y/N] 
Ok, not deploying.

[antonmedv]

Die will only kill the worker. Throw an Exception. Or GeasefullShutdownException.

But this is a nice idea. Will be cool to kill the master with die.

[antonmedv]

It changed in v7 as new features was added of parallel runs.

[JVFP]

The deploy still seems to keep running on after a GracefulShutdownException. Just ran into one from the deploy:lock task but it just kept on going:

task('deploy', [
    'app:confirm',
    'local:build',
]);

desc('Build app locally');
task('local:build', function() {
    on(localhost(), function() {
            invoke('deploy:lock');
            invoke('deploy:release');
    });
});

Output:

task deploy:lock
[localhost]  Deployer\Exception\GracefulShutdownException  in deploy.php on line 85:
[localhost]
[localhost]   Deploy locked by vagrant.
[localhost]   Execute "deploy:unlock" task to unlock.
[localhost]
task deploy:info

If I move the 'app:confirm' task to be invoked inside 'local:build' before 'deploy:lock' like so:

task('local:build', function() {
    on(localhost(), function() {
            invoke('app:confirm');
            invoke('deploy:lock');
            invoke('deploy:release');
    });
});

and throw a default \Exception in there it does seem to stop running, but if I throw a GracefulShutdownException inside 'app:confirm' it just keeps on going. I can't really seem to figure out what I'm doing wrong.

[JVFP]

It looks like this has to do with the on() function:
It catches to GracefulShutdownException and renders it but since it doesn't re-throw it the any tasks after the on() will still run.

function on($hosts, callable $callback): void
{
    if (!is_array($hosts) && !($hosts instanceof \Traversable)) {
        $hosts = [$hosts];
    }

    foreach ($hosts as $host) {
        if ($host instanceof Host) {
            $host->config()->load();
            Context::push(new Context($host));
            try {
                $callback($host);
                $host->config()->save();
            } catch (GracefulShutdownException $e) {
                Deployer::get()->messenger->renderException($e, $host);
            } finally {
                Context::pop();
            }
        } else {
            throw new \InvalidArgumentException("Function on can iterate only on Host instances.");
        }
    }
}

Is there a way to make it stop the whole deploy instead of just the tasks inside the on() handler?

[antonmedv]

It looks like a bug. I created an issue to fix it.

[JVFP]

For now a workaround could be to catch any GracefulShutdownException and re-throw it as a generic Exception to stop the whole deploy:

task('local:build', function() {
    on(localhost(), function() {
            try {
                invoke('app:confirm');
                invoke('deploy:lock');
                invoke('deploy:release');
            } catch (GracefulShutdownException $e) {
                throw new \Exception($e->getMessage());
            }
    });
});