Merge pull request #1858 from hydephp/deeper-realtime-compiler-integration

Refactor realtime compiler to handle virtual routes through the service container

Author: emmadesilva

.idea/misc.xml

@@ -18,6 +18,7 @@ This serves two purposes:
 - Removed the nullable type hint from the `PostAuthor` class's `name` property as it is now always set in https://github.com/hydephp/develop/pull/1794
 - Improved the accessibility of the heading permalinks feature in https://github.com/hydephp/develop/pull/1803
 - Updated to HydeFront v3.4 in https://github.com/hydephp/develop/pull/1803
+- Realtime Compiler: Virtual routes are now managed through the service container in https://github.com/hydephp/develop/pull/1858
 
 ### Deprecated
 - The `PostAuthor::getName()` method is now deprecated and will be removed in v2. (use `$author->name` instead) in https://github.com/hydephp/develop/pull/1794

RELEASE_NOTES.md

@@ -33,6 +33,13 @@
             "pestphp/pest-plugin": false
         }
     },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "Hyde\\RealtimeCompiler\\RealtimeCompilerServiceProvider"
+            ]
+        }
+    },
     "require-dev": {
         "phpunit/phpunit": "^10.0",
         "robiningelbrecht/phpunit-pretty-print": "^1.3",

composer.lock

@@ -330,7 +330,7 @@ protected function createPage(): void
         $content = $this->request->data['contentInput'] ?? $this->abort(400, 'Must provide content');
         $pageType = $this->request->data['pageTypeSelection'] ?? $this->abort(400, 'Must provide page type');
 
-        // Optional data
+        // Optional data // Todo: Filter empty data? Comment them?
         $postDescription = $this->request->data['postDescription'] ?? null;
         $postCategory = $this->request->data['postCategory'] ?? null;
         $postAuthor = $this->request->data['postAuthor'] ?? null;

packages/realtime-compiler/composer.json

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hyde\RealtimeCompiler\Http;
+
+use Desilva\Microserve\Request;
+use Desilva\Microserve\Response;
+use Desilva\Microserve\JsonResponse;
+
+class VirtualRouteController
+{
+    public static function ping(): JsonResponse
+    {
+        return new JsonResponse(200, 'OK', [
+            'server' => 'Hyde/RealtimeCompiler',
+        ]);
+    }
+
+    public static function dashboard(Request $request): Response
+    {
+        return (new DashboardController($request))->handle();
+    }
+
+    public static function liveEdit(Request $request): Response
+    {
+        return (new LiveEditController($request))->handle();
+    }
+}

packages/realtime-compiler/src/Http/DashboardController.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hyde\RealtimeCompiler;
+
+use Desilva\Microserve\Response;
+
+/**
+ * @public This class is part of the public API and is covered by the backward compatibility promise.
+ */
+class RealtimeCompiler
+{
+    /** @var array<string, callable(\Desilva\Microserve\Request): Response> */
+    protected array $virtualRoutes = [];
+
+    /** @param callable(\Desilva\Microserve\Request): Response $route */
+    public function registerVirtualRoute(string $uri, callable $route): void
+    {
+        $this->virtualRoutes[$uri] = $route;
+    }
+
+    /** @return array<string, callable(\Desilva\Microserve\Request): Response> */
+    public function getVirtualRoutes(): array
+    {
+        return $this->virtualRoutes;
+    }
+}

packages/realtime-compiler/src/Http/VirtualRouteController.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Hyde\RealtimeCompiler;
+
+use Illuminate\Support\ServiceProvider;
+use Hyde\RealtimeCompiler\Http\LiveEditController;
+use Hyde\RealtimeCompiler\Http\DashboardController;
+use Hyde\RealtimeCompiler\Http\VirtualRouteController;
+
+class RealtimeCompilerServiceProvider extends ServiceProvider
+{
+    public function register(): void
+    {
+        $this->app->singleton(RealtimeCompiler::class);
+    }
+
+    public function boot(): void
+    {
+        $router = $this->app->make(RealtimeCompiler::class);
+
+        $router->registerVirtualRoute('/ping', [VirtualRouteController::class, 'ping']);
+
+        if (DashboardController::enabled()) {
+            $router->registerVirtualRoute('/dashboard', [VirtualRouteController::class, 'dashboard']);
+        }
+
+        if (LiveEditController::enabled()) {
+            $router->registerVirtualRoute('/_hyde/live-edit', [VirtualRouteController::class, 'liveEdit']);
+        }
+    }
+}

packages/realtime-compiler/src/RealtimeCompiler.php

@@ -13,7 +13,6 @@
 use Hyde\Framework\Exceptions\RouteNotFoundException;
 use Hyde\Framework\Features\Documentation\DocumentationSearchPage;
 use Hyde\Pages\Concerns\HydePage;
-use Hyde\RealtimeCompiler\Concerns\InteractsWithLaravel;
 use Hyde\RealtimeCompiler\Concerns\SendsErrorResponses;
 use Hyde\RealtimeCompiler\Http\DashboardController;
 use Desilva\Microserve\HtmlResponse;
@@ -25,26 +24,16 @@
 class PageRouter
 {
     use SendsErrorResponses;
-    use InteractsWithLaravel;
 
     protected Request $request;
 
     public function __construct(Request $request)
     {
         $this->request = $request;
-        $this->bootApplication();
     }
 
     protected function handlePageRequest(): Response
     {
-        if ($this->request->path === '/dashboard' && DashboardController::enabled()) {
-            return (new DashboardController($this->request))->handle();
-        }
-
-        if ($this->request->path === '/_hyde/live-edit' && LiveEditController::enabled()) {
-            return (new LiveEditController($this->request))->handle();
-        }
-
         return new HtmlResponse(200, 'OK', [
             'body' => $this->getHtml($this->getPageFromRoute()),
         ]);

packages/realtime-compiler/src/RealtimeCompilerServiceProvider.php

@@ -4,9 +4,9 @@
 
 namespace Hyde\RealtimeCompiler\Routing;
 
-use Desilva\Microserve\JsonResponse;
 use Desilva\Microserve\Request;
 use Desilva\Microserve\Response;
+use Hyde\RealtimeCompiler\RealtimeCompiler;
 use Hyde\RealtimeCompiler\Actions\AssetFileLocator;
 use Hyde\RealtimeCompiler\Concerns\SendsErrorResponses;
 use Hyde\RealtimeCompiler\Models\FileObject;
@@ -20,10 +20,6 @@ class Router
 
     protected Request $request;
 
-    protected array $virtualRoutes = [
-        '/ping',
-    ];
-
     public function __construct(Request $request)
     {
         $this->request = $request;
@@ -35,12 +31,12 @@ public function handle(): Response
             return $this->proxyStatic();
         }
 
-        if (in_array($this->request->path, $this->virtualRoutes)) {
-            if ($this->request->path === '/ping') {
-                return new JsonResponse(200, 'OK', [
-                    'server' => 'Hyde/RealtimeCompiler',
-                ]);
-            }
+        $this->bootApplication();
+
+        $virtualRoutes = app(RealtimeCompiler::class)->getVirtualRoutes();
+
+        if (isset($virtualRoutes[$this->request->path])) {
+            return $virtualRoutes[$this->request->path]($this->request);
         }
 
         return PageRouter::handle($this->request);