A Laravel bus decorator that allows to await asynchronous command responses.
composer require ngmy/laravel-async-await-busCommand classes must implement the ShouldAwaitResponse interface and use the Respondable trait:
<?php
namespace App\Commands;
use App\Models\User;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Ngmy\LaravelAsyncAwaitBus\Concerns\Respondable;
use Ngmy\LaravelAsyncAwaitBus\Contracts\ShouldAwaitResponse;
class CreateNewArticleCommand implements ShouldQueue, ShouldAwaitResponse
{
use InteractsWithQueue, Queueable, SerializesModels, Respondable;
public function __construct(
public readonly User $user,
public readonly string $title,
public readonly string $body,
public readonly bool $published,
) {
}
}Handler classes must contain a handle method or an __invoke method, and must respond using the respond method of
command instances:
<?php
namespace App\Handlers\Commands;
use App\Commands\CreateNewArticleCommand;
class CreateNewArticleCommandHandler
{
public function handle(CreateNewArticleCommand $command): void
{
$article = $command->user->articles()->create([
'title' => $command->title,
'body' => $command->body,
'published' => $command->published,
'published_at' => $command->published ? now() : null,
]);
$command->respond($article->id);
}
}You need to register command and handler mappings. For example, you can register in the boot method of the
AppServiceProvider class:
use App\Commands\CreateNewArticleCommand;
use App\Handlers\Commands\CreateNewArticleCommandHandler;
use Illuminate\Contracts\Bus\Dispatcher as Bus;
$bus = $this->app->make(Bus::class);
$bus->map([
CreateNewArticleCommand::class => CreateNewArticleCommandHandler::class,
]);Now, you can await asynchronous command responses:
<?php
namespace App\Http\Controllers;
use App\Commands\CreateNewArticleCommand;
use App\Http\Controllers\Controller;
use App\Http\Requests\CreateNewArticleRequest;
use Illuminate\Contracts\Bus\Dispatcher as Bus;
use Illuminate\Http\RedirectResponse;
class CreateNewArticle extends Controller
{
public function __invoke(CreateNewArticleRequest $request, Bus $bus): RedirectResponse
{
$command = new CreateNewArticleCommand(
$request->user(),
$request->string('title'),
$request->string('body'),
$request->boolean('published'),
);
$id = $bus->dispatch($command);
return redirect("articles/{$id}");
}
}Of course, you can also use self-handling commands:
<?php
namespace App\Commands;
use App\Models\User;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Queue\ShouldQueue;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Queue\SerializesModels;
use Ngmy\LaravelAsyncAwaitBus\Concerns\Respondable;
use Ngmy\LaravelAsyncAwaitBus\Contracts\ShouldAwaitResponse;
class CreateNewArticleCommand implements ShouldQueue, ShouldAwaitResponse
{
use InteractsWithQueue, Queueable, SerializesModels, Respondable;
public function __construct(
public readonly User $user,
public readonly string $title,
public readonly string $body,
public readonly bool $published,
) {
}
public function handle(): void
{
$article = $this->user->articles()->create([
'title' => $this->title,
'body' => $this->body,
'published' => $this->published,
'published_at' => $this->published ? now() : null,
]);
$this->respond($article->id);
}
}Please see the changelog.
Laravel Async Await Bus is open-sourced software licensed under the MIT license.