Add cy.currentUser() command

JeffreyWay · JeffreyWay · commit 6d208820a31c · 2022-02-14T11:14:53.000-05:00
diff --git a/README.md b/README.md
@@ -112,6 +112,24 @@ test('authenticated users can see the dashboard', () => {
 });
 ```
 
+### cy.currentUser()
+
+Fetch the currently authenticated user object from the server, if any. Equivalent to Laravel's `auth()->user()`.
+
+```js
+test('authenticated users can see the dashboard', () => {
+    cy.login({ email: 'joe@example.com' });
+
+    cy.currentUser().its('email').should('eq', 'joe@example.com');
+    
+    // or...
+    
+    cy.currentUser().then(user => {
+        expect(user.email).to.eql('joe@example.com');
+    });
+});
+```
+
 
 ### cy.logout()
 
diff --git a/src/Controllers/CypressController.php b/src/Controllers/CypressController.php
@@ -57,6 +57,11 @@ public function login(Request $request)
         });
     }
 
+    public function currentUser()
+    {
+        return auth()->user()?->setHidden([])->setVisible([]);
+    }
+
     public function logout()
     {
         auth()->logout();
diff --git a/src/routes/cypress.php b/src/routes/cypress.php
@@ -10,3 +10,4 @@
 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');
+Route::post('/__cypress__/current-user', [CypressController::class, 'currentUser'])->name('cypress.current-user');
diff --git a/src/stubs/support/laravel-commands.js b/src/stubs/support/laravel-commands.js
@@ -33,6 +33,32 @@ Cypress.Commands.add('login', (attributes = {}) => {
         .its('body', { log: false });
 });
 
+/**
+ * Fetch the currently authenticated user object.
+ *
+ * @example cy.currentUser();
+ */
+Cypress.Commands.add('currentUser', () => {
+    return cy.csrfToken().then((token) => {
+        return cy
+            .request({
+                method: 'POST',
+                url: '/__cypress__/current-user',
+                body: { _token: token },
+                log: false,
+            })
+            .then((response) => {
+                if (!response.body) {
+                    cy.log('No authenticated user found.');
+                }
+
+                Cypress.Laravel.currentUser = response?.body;
+
+                return response?.body;
+            });
+    });
+});
+
 
 /**
  * Logout the current user.
@@ -55,7 +81,6 @@ Cypress.Commands.add('logout', () => {
         });
 });
 
-
 /**
  * Fetch a CSRF token.
  *
@@ -71,7 +96,6 @@ Cypress.Commands.add('csrfToken', () => {
         .its('body', { log: false });
 });
 
-
 /**
  * Fetch and store all named routes.
  *
@@ -97,7 +121,6 @@ Cypress.Commands.add('refreshRoutes', () => {
     });
 });
 
-
 /**
  * Visit the given URL or route.
  *
@@ -116,7 +139,6 @@ Cypress.Commands.overwrite('visit', (originalFn, subject, options) => {
     return originalFn(subject, options);
 });
 
-
 /**
  * Create a new Eloquent factory.
  *
@@ -180,7 +202,6 @@ Cypress.Commands.add('create', (model, count = 1, attributes = {}, load = [], st
         .its('body', { log: false });
 });
 
-
 /**
  * Refresh the database state.
  *
@@ -193,7 +214,6 @@ Cypress.Commands.add('refreshDatabase', (options = {}) => {
     return cy.artisan('migrate:fresh', options);
 });
 
-
 /**
  * Seed the database.
  *
@@ -208,7 +228,6 @@ Cypress.Commands.add('seed', (seederClass) => {
     });
 });
 
-
 /**
  * Trigger an Artisan command.
  *
@@ -247,7 +266,6 @@ Cypress.Commands.add('artisan', (command, parameters = {}, options = {}) => {
     });
 });
 
-
 /**
  * Execute arbitrary PHP.
  *
diff --git a/tests/CypressControllerTest.php b/tests/CypressControllerTest.php
@@ -51,6 +51,17 @@ public function it_logs_a_new_user_in()
         $this->assertTrue(auth()->check());
     }
 
+    /** @test */
+    public function it_fetches_the_currently_authenticated_user()
+    {
+        $this->post(route('cypress.login'), ['attributes' => ['email' => 'joe@example.com']]);
+
+        $response = $this->post(route('cypress.current-user'));
+
+        $this->assertNotNull($response->json());
+        $this->assertEquals('joe@example.com', $response->json()['email']);
+    }
+
     /** @test */
     public function it_makes_all_logged_in_user_attributes_visible()
     {
@@ -66,7 +77,7 @@ public function it_makes_all_logged_in_user_attributes_visible()
     /** @test */
     public function it_logs_a_user_in()
     {
-        $response = $this->post(route('cypress.login'), [
+        $this->post(route('cypress.login'), [
             'attributes' => ['name' => 'Frank'],
             'state' => ['guest']
         ]);

Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,11 @@ public function login(Request $request)`
`57`	`57`	`});`
`58`	`58`	`}`
`59`	`59`
	`60`	`+ public function currentUser()`
	`61`	`+ {`
	`62`	`+ return auth()->user()?->setHidden([])->setVisible([]);`
	`63`	`+ }`
	`64`	`+`
`60`	`65`	`public function logout()`
`61`	`66`	`{`
`62`	`67`	`auth()->logout();`