How to catch exceptions in handle methods

[kai0310]

Hey there 👋 Thanks for the great package.

I present here as an example a program that throws an error in a handle method and catches this error and displays it in a modal. This is the smallest example that presents this problem.

Minimum code ✍️

class CreateOrder
{
    use AsAction;

    /**
     * @throws CannotOrderItemException
     */
    public function handle(Item $item): Order
    {
        $unpaid = Auth::user()?->orders()->delivered()->notPaid()->count();

        if ($unpaid >= Order::MAX_ORDER) {
            return throw CannotOrderItemException::hasUnpaid();
        }
        
        // and create Order Object.....  
    }
}

try {
    $order = CreateOrder::run($this->item);
} catch (CannotOrderItemException $e) {
    // show error modal
}

What's at stake 🤧

The IDE will tell me that a CannotOrderItemException is never thrown within a try. This may be because execution is done only once via the run method. However, since it is not an independent run method, it is not possible to specify separately the exceptions that may be thrown. If I write code that throws exceptions in a handle method using Laravel Actions, how is it smart to resolve these?

[kai0310]

@lorisleiva Oops. I forgot to mentions it.

[travisaustin]

This requires a little extra effort, but it should work:

class CreateOrder
{
    use AsAction;

    use \Lorisleiva\Actions\Concerns\AsObject {
        \Lorisleiva\Actions\Concerns\AsObject::run as parentRun;
    }

    /**
     * @see static::handle()
     * @param mixed ...$arguments
     * @return mixed
     * @throws CannotOrderItemException
     */
    public static function run(...$arguments)
    {
        return self::parentRun(...$arguments);
    }
    
    /**
     * @throws CannotOrderItemException
     */
    public function handle(Item $item): Order
    {
        $unpaid = Auth::user()?->orders()->delivered()->notPaid()->count();

        if ($unpaid >= Order::MAX_ORDER) {
            return throw CannotOrderItemException::hasUnpaid();
        }
        
        // and create Order Object.....  
    }
}

[kai0310]

@travisaustin Thanks! However, it is only a first aid kind of thing, and I don't think it is a smart thing to do.

[Wulfheart]

What about registering it as a Laravel Exception and handling it there?

[kai0310]

@Wulfheart

Thank you very much. However, I still can't seem to figure out how to do that.

[Wulfheart]

No idea. Just a hint for you...

[jameshulse]

I think you shouldn't be throwing an exception, but instead returning a kind of 'Result' object.

[kai0310]

Ah, pretty good 👍🏻

I was feeling that throwing it as an exception would make the code more readable, but I guess I can solve it by returning a new object like a (e.g., Result) object! thanks

[kai0310]

This is not a problem with this package, but with the PHPDocument specification. As such, I am closing this issue.

It seems we need to discuss how to use the package, not how to solve the problem as a package.