Add named route fetching

src/Controllers/CypressController.php

@@ -3,12 +3,30 @@
 namespace Laracasts\Cypress\Controllers;
 
 use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Support\Facades\Route;
 use Illuminate\Support\Str;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Artisan;
 
 class CypressController
 {
+    public function routes()
+    {
+        $routes = Route::getRoutes()->getRoutes();
+
+        return collect($routes)
+            ->map(function (\Illuminate\Routing\Route $route) {
+                return [
+                    'name' => $route->getName(),
+                    'domain' => $route->getDomain(),
+                    'action' => $route->getActionName(),
+                    'uri' => $route->uri(),
+                    'method' => $route->methods(),
+                ];
+            })
+            ->keyBy('name');
+    }
+
     public function login(Request $request)
     {
         if ($attributes = $request->input('attributes')) {

src/CypressBoilerplateCommand.php

@@ -33,18 +33,25 @@ public function handle()
 
     protected function copyStubs()
     {
-        $this->files->copyDirectory(__DIR__.'/stubs/support', base_path('cypress/support'));
-        $this->files->copyDirectory(__DIR__.'/stubs/plugins', base_path('cypress/plugins'));
+        $this->files->copyDirectory(
+            __DIR__ . '/stubs/support',
+            base_path('cypress/support')
+        );
+        $this->files->copyDirectory(
+            __DIR__ . '/stubs/plugins',
+            base_path('cypress/plugins')
+        );
 
         $this->lineBreak();
 
         $this->status('Updated', 'cypress/support/index.js');
         $this->status('Updated', 'cypress/plugins/index.js');
         $this->status('Created', 'cypress/plugins/swap-env.js');
         $this->status('Created', 'cypress/support/laravel-commands.js');
+        $this->status('Created', 'cypress/support/laravel-routes.js');
         $this->status('Created', 'cypress/support/assertions.js');
 
-        if (! $this->files->exists($path = base_path('.env.cypress'))) {
+        if (!$this->files->exists($path = base_path('.env.cypress'))) {
             $this->files->copy(base_path('.env'), $path);
 
             $this->status('Created', '.env.cypress');
@@ -68,11 +75,11 @@ protected function requestCypressInstallation()
         $this->warn(
             <<<'EOT'
 
-                Cypress not found. Please install it through npm and try again.
+Cypress not found. Please install it through npm and try again.
 
-                npm install cypress --save-dev && npx cypress open
+npm install cypress --save-dev && npx cypress open
 
-                EOT
+EOT
         );
     }
 }

src/routes/cypress.php

@@ -3,9 +3,27 @@
 use Illuminate\Support\Facades\Route;
 use Laracasts\Cypress\Controllers\CypressController;
 
-Route::post('/__cypress__/factory', [CypressController::class, 'factory'])->name('cypress.factory');
-Route::post('/__cypress__/login', [CypressController::class, 'login'])->name('cypress.login');
-Route::post('/__cypress__/logout', [CypressController::class, 'logout'])->name('cypress.logout');
-Route::post('/__cypress__/artisan', [CypressController::class, 'artisan'])->name('cypress.artisan');
-Route::post('/__cypress__/run-php', [CypressController::class, 'runPhp'])->name('cypress.run-php');
-Route::get('/__cypress__/csrf_token', [CypressController::class, 'csrfToken'])->name('cypress.csrf-token');
+Route::post('/__cypress__/factory', [
+    CypressController::class,
+    'factory',
+])->name('cypress.factory');
+Route::post('/__cypress__/login', [CypressController::class, 'login'])->name(
+    'cypress.login'
+);
+Route::post('/__cypress__/logout', [CypressController::class, 'logout'])->name(
+    'cypress.logout'
+);
+Route::post('/__cypress__/artisan', [
+    CypressController::class,
+    'artisan',
+])->name('cypress.artisan');
+Route::post('/__cypress__/run-php', [CypressController::class, 'runPhp'])->name(
+    'cypress.run-php'
+);
+Route::get('/__cypress__/csrf_token', [
+    CypressController::class,
+    'csrfToken',
+])->name('cypress.csrf-token');
+Route::post('/__cypress__/routes', [CypressController::class, 'routes'])->name(
+    'cypress.routes'
+);

src/stubs/support/index.js

@@ -15,11 +15,14 @@
 
 import './commands';
 import './laravel-commands';
+import './laravel-routes';
 import './assertions';
 
 before(() => {
     cy.task('activateCypressEnvFile', {}, { log: false });
     cy.artisan('config:clear', {}, { log: false });
+
+    cy.refreshRoutes();
 });
 
 after(() => {

src/stubs/support/laravel-commands.js

@@ -63,6 +63,49 @@ Cypress.Commands.add('csrfToken', () => {
         .its('body', { log: false });
 });
 
+/**
+ * Fetch and store all named routes.
+ *
+ * @example cy.refreshRoutes();
+ */
+Cypress.Commands.add('refreshRoutes', () => {
+    return cy.csrfToken().then((token) => {
+        return cy
+            .request({
+                method: 'POST',
+                url: '/__cypress__/routes',
+                body: { _token: token },
+                log: false,
+            })
+            .its('body', { log: false })
+            .then((routes) => {
+                cy.writeFile('cypress/support/routes.json', routes, {
+                    log: false,
+                });
+
+                Cypress.Laravel.routes = routes;
+            });
+    });
+});
+
+/**
+ * Visit the given URL or route.
+ *
+ * @example cy.visit('foo/path');
+ *          cy.visit({ route: 'home' });
+ *          cy.visit({ route: 'team', parameters: { team: 1 } });
+ */
+Cypress.Commands.overwrite('visit', (originalFn, subject, options) => {
+    if (subject.route) {
+        return originalFn({
+            url: Cypress.Laravel.route(subject.route, subject.parameters || {}),
+            method: Cypress.Laravel.routes[subject.route].method[0],
+        });
+    }
+
+    return originalFn(subject, options);
+});
+
 /**
  * Create a new Eloquent factory.
  *

src/stubs/support/laravel-routes.js

@@ -0,0 +1,21 @@
+Cypress.Laravel = {
+    routes: {},
+
+    route: (name, parameters = {}) => {
+        assert(
+            Cypress.Laravel.routes.hasOwnProperty(name),
+            `Laravel route "${name}" exists.`
+        );
+
+        return ((uri) => {
+            Object.keys(parameters).forEach((parameter) => {
+                uri = uri.replace(
+                    new RegExp(`{${parameter}}`),
+                    parameters[parameter]
+                );
+            });
+
+            return uri;
+        })(Cypress.Laravel.routes[name].uri);
+    },
+};

tests/CypressControllerTest.php

@@ -3,6 +3,7 @@
 namespace Laracasts\Cypress\Tests;
 
 use Illuminate\Support\Facades\Artisan;
+use Illuminate\Support\Facades\Route;
 use Laracasts\Cypress\CypressServiceProvider;
 use Laracasts\Cypress\Tests\Support\TestUser;
 use Orchestra\Testbench\TestCase;
@@ -24,6 +25,24 @@ protected function setUp(): void
         config(['auth.providers.users.model' => TestUser::class]);
     }
 
+    /** @test */
+    function it_fetches_a_collection_of_named_routes()
+    {
+        Route::get('foo')->name('home');
+
+        $response = $this->post(route('cypress.routes'));
+
+        $response->assertJsonFragment([
+            'uri' => 'foo',
+            'name' => 'home',
+            'method' => ['GET', 'HEAD'],
+            'action' => 'Closure',
+            'domain' => null,
+        ]);
+
+        $this->assertArrayHasKey('home', $response->json());
+    }
+
     /** @test */
     public function it_logs_a_new_user_in()
     {

tests/CypressTest.php

@@ -20,7 +20,7 @@ protected function getPackageProviders($app)
     public function it_does_not_expose_cypress_routes_in_production()
     {
         $this->routeNames()->each(
-            fn ($name) => $this->assertFalse(Route::has($name))
+            fn($name) => $this->assertFalse(Route::has($name))
         );
     }
 
@@ -31,7 +31,7 @@ public function it_does_not_expose_cypress_routes_in_production()
     public function it_exposes_cypress_routes_if_not_in_production()
     {
         $this->routeNames()->each(
-            fn ($name) => $this->assertTrue(Route::has($name))
+            fn($name) => $this->assertTrue(Route::has($name))
         );
     }
 
@@ -44,16 +44,17 @@ protected function routeNames()
             'cypress.artisan',
             'cypress.run-php',
             'cypress.csrf-token',
+            'cypress.routes',
         ]);
     }
 
     protected function setUpAcceptanceEnvironment()
     {
-        app()->detectEnvironment(fn () => 'acceptance');
+        app()->detectEnvironment(fn() => 'acceptance');
     }
 
     protected function setUpProductionEnvironment()
     {
-        app()->detectEnvironment(fn () => 'production');
+        app()->detectEnvironment(fn() => 'production');
     }
 }