Initial commit

vendor/laravel/pail/src/Handler.php

@@ -0,0 +1,121 @@
+<?php
+
+namespace Laravel\Pail;
+
+use Illuminate\Console\Events\CommandStarting;
+use Illuminate\Contracts\Container\Container;
+use Illuminate\Foundation\Auth\User;
+use Illuminate\Log\Context\Repository as ContextRepository;
+use Illuminate\Log\Events\MessageLogged;
+use Illuminate\Queue\Events\JobExceptionOccurred;
+use Illuminate\Queue\Events\JobProcessing;
+use Illuminate\Support\Collection;
+use Illuminate\Support\Facades\Auth;
+use Throwable;
+
+class Handler
+{
+    /**
+     * The last lifecycle captured event.
+     */
+    protected CommandStarting|JobProcessing|JobExceptionOccurred|null $lastLifecycleEvent = null;
+
+    /**
+     * The artisan command being executed, if any.
+     */
+    protected ?string $artisanCommand = null;
+
+    /**
+     * Creates a new instance of the handler.
+     */
+    public function __construct(
+        protected Container $container,
+        protected Files $files,
+        protected bool $runningInConsole,
+    ) {
+        //
+    }
+
+    /**
+     * Reports the given message logged.
+     */
+    public function log(MessageLogged $messageLogged): void
+    {
+        $files = $this->files->all();
+
+        if ($files->isEmpty()) {
+            return;
+        }
+
+        $context = $this->context($messageLogged);
+
+        $files->each(
+            fn (File $file) => $file->log(
+                $messageLogged->level,
+                $messageLogged->message,
+                $context,
+            ),
+        );
+    }
+
+    /**
+     * Sets the last application lifecycle event.
+     */
+    public function setLastLifecycleEvent(CommandStarting|JobProcessing|JobExceptionOccurred|null $event): void
+    {
+        if ($event instanceof CommandStarting) {
+            $this->artisanCommand = $event->command;
+        }
+
+        $this->lastLifecycleEvent = $event;
+    }
+
+    /**
+     * Builds the context array.
+     *
+     * @return array<string, mixed>
+     */
+    protected function context(MessageLogged $messageLogged): array
+    {
+        $context = ['__pail' => ['origin' => match (true) {
+            $this->artisanCommand && $this->lastLifecycleEvent && in_array($this->lastLifecycleEvent::class, [JobProcessing::class, JobExceptionOccurred::class]) => [
+                'type' => 'queue',
+                'command' => $this->artisanCommand,
+                'queue' => $this->lastLifecycleEvent->job->getQueue(),
+                'job' => $this->lastLifecycleEvent->job->resolveName(),
+            ],
+            $this->runningInConsole => [
+                'type' => 'console',
+                'command' => $this->artisanCommand,
+            ],
+            default => [
+                'type' => 'http',
+                'method' => request()->method(),
+                'path' => request()->path(),
+                'auth_id' => Auth::id(),
+                'auth_email' => Auth::user() instanceof User ? Auth::user()->email : null, // @phpstan-ignore property.notFound
+            ],
+        }]];
+
+        if (isset($messageLogged->context['exception']) && $this->lastLifecycleEvent instanceof JobExceptionOccurred) {
+            if ($messageLogged->context['exception'] === $this->lastLifecycleEvent->exception) {
+                $this->setLastLifecycleEvent(null);
+            }
+        }
+
+        $context['__pail']['origin']['trace'] = isset($messageLogged->context['exception'])
+            && $messageLogged->context['exception'] instanceof Throwable ? collect($messageLogged->context['exception']->getTrace())
+                ->filter(fn (array $frame) => isset($frame['file']))
+                ->map(fn (array $frame) => [
+                    'file' => $frame['file'], // @phpstan-ignore offsetAccess.notFound
+                    'line' => $frame['line'] ?? null,
+                ])->values()
+            : null;
+
+        return collect($messageLogged->context)
+            ->merge($context)
+            ->when($this->container->bound(ContextRepository::class), function (Collection $context) {
+                return $context->merge($this->container->make(ContextRepository::class)->all()); // @phpstan-ignore method.nonObject
+            })->toArray();
+    }
+}