Skip to content

A self-hosted media server and file management system

Custom Pulse Resources

aminnausin90c427a1597a
diff --git a/app/Http/Resources/Pulse/DashboardResource.php b/app/Http/Resources/Pulse/DashboardResource.php
new file mode 100644
index 00000000..44646b97
--- /dev/null
+++ b/app/Http/Resources/Pulse/DashboardResource.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Http\Resources\Pulse;
+
+use Illuminate\Http\Request;
+
+class DashboardResource extends PulseResource {
+ public function toArray(Request $request): array {
+ $resources = config('pulse-api.resources');
+
+ $result = $resources->mapWithKeys(function (string $resource, string $key) use ($request) {
+ return (new $resource(null, $this->period))->toArray($request);
+ });
+
+ return $result->toArray();
+ }
+}
diff --git a/app/Http/Resources/Pulse/PulseResource.php b/app/Http/Resources/Pulse/PulseResource.php
new file mode 100644
index 00000000..ad6d2258
--- /dev/null
+++ b/app/Http/Resources/Pulse/PulseResource.php
@@ -0,0 +1,90 @@
+<?php
+
+namespace App\Http\Resources\Pulse;
+
+use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Support\Collection;
+use Laravel\Pulse\Facades\Pulse;
+use Laravel\Pulse\Livewire\Concerns\HasPeriod;
+use Laravel\Pulse\Livewire\Concerns\RemembersQueries;
+
+class PulseResource extends JsonResource {
+ use HasPeriod, RemembersQueries;
+
+ public function __construct($resource, $period) {
+ parent::__construct($resource);
+ $this->period = $period;
+ }
+
+ /**
+ * Retrieve values for the given type.
+ *
+ * @param list<string> $keys
+ * @return \Illuminate\Support\Collection<string, object{
+ * timestamp: int,
+ * key: string,
+ * value: string
+ * }>
+ */
+ protected function values(string $type, ?array $keys = null): Collection {
+ return Pulse::values($type, $keys);
+ }
+
+ /**
+ * Retrieve aggregate values for plotting on a graph.
+ *
+ * @param list<string> $types
+ * @param 'count'|'min'|'max'|'sum'|'avg' $aggregate
+ * @return \Illuminate\Support\Collection<string, \Illuminate\Support\Collection<string, \Illuminate\Support\Collection<string, int|null>>>
+ */
+ protected function graph(array $types, string $aggregate): Collection {
+ return Pulse::graph($types, $aggregate, $this->periodAsInterval());
+ }
+
+ /**
+ * Retrieve aggregate values for the given type.
+ *
+ * @param 'count'|'min'|'max'|'sum'|'avg'|list<'count'|'min'|'max'|'sum'|'avg'> $aggregates
+ * @return \Illuminate\Support\Collection<int, mixed>
+ */
+ protected function aggregate(
+ string $type,
+ string|array $aggregates,
+ ?string $orderBy = null,
+ string $direction = 'desc',
+ int $limit = 101,
+ ): Collection {
+ return Pulse::aggregate($type, $aggregates, $this->periodAsInterval(), $orderBy, $direction, $limit);
+ }
+
+ /**
+ * Retrieve aggregate values for the given types.
+ *
+ * @param string|list<string> $types
+ * @param 'count'|'min'|'max'|'sum'|'avg' $aggregate
+ * @return \Illuminate\Support\Collection<int, mixed>
+ */
+ protected function aggregateTypes(
+ string|array $types,
+ string $aggregate,
+ ?string $orderBy = null,
+ string $direction = 'desc',
+ int $limit = 101,
+ ): Collection {
+ return Pulse::aggregateTypes($types, $aggregate, $this->periodAsInterval(), $orderBy, $direction, $limit);
+ }
+
+ /**
+ * Retrieve an aggregate total for the given types.
+ *
+ * @param string|list<string> $types
+ * @param 'count'|'min'|'max'|'sum'|'avg' $aggregate
+ * @return float|\Illuminate\Support\Collection<string, int>
+ */
+ protected function aggregateTotal(
+ array|string $types,
+ string $aggregate,
+ ): float|Collection {
+ return Pulse::aggregateTotal($types, $aggregate, $this->periodAsInterval());
+ }
+}
diff --git a/app/Http/Resources/Pulse/RequestsResource.php b/app/Http/Resources/Pulse/RequestsResource.php
new file mode 100644
index 00000000..23fed0f3
--- /dev/null
+++ b/app/Http/Resources/Pulse/RequestsResource.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace App\Http\Resources\Pulse;
+
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Config;
+use PauloHortelan\RequestsGraphPulse\Recorders\RequestsGraphRecorder;
+
+class RequestsResource extends PulseResource {
+ public function toArray(Request $request): array {
+ [$requests, $time, $runAt] = $this->remember(fn () => $this->graph(
+ [
+ 'informational',
+ 'successful',
+ 'redirection',
+ 'client_error',
+ 'server_error',
+ ],
+ 'count',
+ ));
+
+ return [
+ 'requests' => [
+ 'requests' => $requests,
+ 'time' => $time,
+ 'runAt' => $runAt,
+ $this->mergeWhen(
+ config('pulse-api.include_config'),
+ ['config' => [
+ 'sample_rate' => Config::get('pulse.recorders.' . RequestsGraphRecorder::class . '.sample_rate'),
+ 'record_informational' => Config::get('pulse.recorders.' . RequestsGraphRecorder::class . '.record_informational'),
+ 'record_successful' => Config::get('pulse.recorders.' . RequestsGraphRecorder::class . '.record_successful'),
+ 'record_redirection' => Config::get('pulse.recorders.' . RequestsGraphRecorder::class . '.record_redirection'),
+ 'record_client_error' => Config::get('pulse.recorders.' . RequestsGraphRecorder::class . '.record_client_error'),
+ 'record_server_error' => Config::get('pulse.recorders.' . RequestsGraphRecorder::class . '.record_server_error'),
+ ]]
+ ),
+ ],
+ ];
+ }
+}
diff --git a/app/Http/Resources/Pulse/ScheduleResource.php b/app/Http/Resources/Pulse/ScheduleResource.php
new file mode 100644
index 00000000..49353fdf
--- /dev/null
+++ b/app/Http/Resources/Pulse/ScheduleResource.php
@@ -0,0 +1,126 @@
+<?php
+
+namespace App\Http\Resources\Pulse;
+
+use Closure;
+use Cron\CronExpression;
+use DateTimeZone;
+use Illuminate\Console\Application;
+use Illuminate\Console\Scheduling\CallbackEvent;
+use Illuminate\Console\Scheduling\Event;
+use Illuminate\Console\Scheduling\Schedule as IlluminateSchedule;
+use Illuminate\Contracts\Console\Kernel as ConsoleKernel;
+use Illuminate\Http\Request;
+use Illuminate\Support\Carbon;
+use ReflectionClass;
+use ReflectionFunction;
+
+use function Safe\preg_replace;
+
+class ScheduleResource extends PulseResource {
+ public int|string|null $ignoreAfter = null;
+
+ public function toArray(Request $request): array {
+ [$events, $time, $runAt] = $this->remember(function (ConsoleKernel $kernel, IlluminateSchedule $schedule) {
+ $kernel->bootstrap();
+
+ $timezone = new DateTimeZone(config('app.timezone')); // @phpstan-ignore-line
+ $events = collect($schedule->events())
+ ->map(fn(Event $event): array => [
+ 'command' => $this->getCommand($event),
+ 'expression' => $this->getExpression($event),
+ 'next_due' => $this->getNextDueDateForEvent($event, $timezone)
+ ->diffForHumans(),
+ ]);
+
+ return $events;
+ });
+
+ return [
+ 'schedule' => [
+ 'schedule' => $events,
+ 'time' => $time,
+ 'runAt' => $runAt,
+ ],
+ ];
+ }
+
+ private function getClosureLocation(CallbackEvent $event): string {
+ $callback = (new ReflectionClass($event))->getProperty('callback')->getValue($event);
+
+ if ($callback instanceof Closure) {
+ $function = new ReflectionFunction($callback);
+
+ return sprintf(
+ '%s:%s',
+ str_replace(app()->basePath() . DIRECTORY_SEPARATOR, '', $function->getFileName() ?: ''),
+ $function->getStartLine()
+ );
+ }
+
+ if (is_string($callback)) {
+ return $callback;
+ }
+
+ if (is_array($callback)) {
+ $className = is_string($callback[0]) ? $callback[0] : $callback[0]::class;
+
+ return sprintf('%s::%s', $className, $callback[1]);
+ }
+
+ return sprintf('%s::__invoke', $callback::class); // @phpstan-ignore-line
+ }
+
+ private function getCommand(Event $event): string {
+ $command = str_replace([Application::phpBinary(), Application::artisanBinary()], [
+ 'php',
+ preg_replace("#['\"]#", '', Application::artisanBinary()),
+ ], $event->command ?? '');
+
+ if ($event instanceof CallbackEvent) {
+ $command = $event->getSummaryForDisplay();
+
+ if (in_array($command, ['Closure', 'Callback'], true)) {
+ $command = 'Closure at: ' . $this->getClosureLocation($event);
+ }
+ }
+
+ return mb_strlen($command) > 1 ? "{$command} " : '';
+ }
+
+ private function getExpression(Event $event): string {
+ if (! $event->isRepeatable()) {
+ return $event->getExpression();
+ }
+
+ return "{$event->getExpression()} ({$event->repeatSeconds}s)";
+ }
+
+ private function getNextDueDateForEvent(Event $event, DateTimeZone $timezone): Carbon {
+ $nextDueDate = Carbon::instance(
+ (new CronExpression($event->expression))
+ ->getNextRunDate(today()->setTimezone($event->timezone))
+ ->setTimezone($timezone)
+ );
+
+ if (! $event->isRepeatable()) {
+ return $nextDueDate;
+ }
+
+ $previousDueDate = Carbon::instance(
+ (new CronExpression($event->expression))
+ ->getPreviousRunDate(today()->setTimezone($event->timezone), allowCurrentDate: true)
+ ->setTimezone($timezone)
+ );
+
+ $now = today()->setTimezone($event->timezone);
+
+ if (! $now->copy()->startOfMinute()->eq($previousDueDate)) {
+ return $nextDueDate;
+ }
+
+ return $now
+ ->endOfSecond()
+ ->ceilSeconds($event->repeatSeconds); // @phpstan-ignore-line
+ }
+}