Merge pull request #358 from opcodesio/api-only-setting

ability to not register web routes for Log Viewer

Author: arukompas

config/log-viewer.php

@@ -12,6 +12,8 @@
 
     'enabled' => env('LOG_VIEWER_ENABLED', true),
 
+    'api_only' => env('LOG_VIEWER_API_ONLY', false),
+
     'require_auth_in_production' => true,
 
     /*

src/LogViewerServiceProvider.php

@@ -95,14 +95,16 @@ protected function registerRoutes()
             $this->loadRoutesFrom(self::basePath('/routes/api.php'));
         });
 
-        Route::group([
-            'domain' => config('log-viewer.route_domain', null),
-            'prefix' => config('log-viewer.route_path'),
-            'namespace' => 'Opcodes\LogViewer\Http\Controllers',
-            'middleware' => config('log-viewer.middleware', null),
-        ], function () {
-            $this->loadRoutesFrom(self::basePath('/routes/web.php'));
-        });
+        if (! config('log-viewer.api_only', false)) {
+            Route::group([
+                'domain' => config('log-viewer.route_domain', null),
+                'prefix' => config('log-viewer.route_path'),
+                'namespace' => 'Opcodes\LogViewer\Http\Controllers',
+                'middleware' => config('log-viewer.middleware', null),
+            ], function () {
+                $this->loadRoutesFrom(self::basePath('/routes/web.php'));
+            });
+        }
     }
 
     protected function registerResources()

tests/Feature/RoutesTest.php

@@ -1,5 +1,7 @@
 <?php
 
+use Symfony\Component\Routing\Exception\RouteNotFoundException;
+
 test('the default url can be changed', function () {
     config()->set('log-viewer.route_path', 'new-log-route');
 
@@ -25,6 +27,22 @@
     expect(route('log-viewer.index'))->toBe('http://localhost');
 });
 
+test('only use api', function () {
+    config()->set('log-viewer.api_only', true);
+
+    reloadRoutes();
+
+    route('log-viewer.index');
+})->throws(RouteNotFoundException::class);
+
+test('only both api and web', function () {
+    config()->set('log-viewer.api_only', false);
+
+    reloadRoutes();
+
+    expect(route('log-viewer.index'))->toBe('http://localhost/log-viewer');
+});
+
 /*
 |--------------------------------------------------------------------------
 | HELPERS
@@ -33,5 +51,9 @@
 
 function reloadRoutes(): void
 {
+    // unset any routes that were set previously
+    app('router')->setRoutes(new \Illuminate\Routing\RouteCollection());
+
+    // boot the service provider to register the routes again
     (new \Opcodes\LogViewer\LogViewerServiceProvider(app()))->boot();
 }