Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[5.8] Send LogoutOtherDevices event when request is made. #27865

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions src/Illuminate/Auth/Events/LogoutOtherDevices.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
<?php

namespace Illuminate\Auth\Events;

use Illuminate\Queue\SerializesModels;

class LogoutOtherDevices
{
use SerializesModels;

/**
* The authentication guard name.
*
* @var string
*/
public $guard;

/**
* The authenticated user.
*
* @var \Illuminate\Contracts\Auth\Authenticatable
*/
public $user;

/**
* Create a new event instance.
*
* @param string $guard
* @param \Illuminate\Contracts\Auth\Authenticatable $user
* @return void
*/
public function __construct($guard, $user)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason that the user parameter here and in the fireLogoutOtherDevicesEvent method isn't actually typehinted?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

None of the existing Auth event has a type-hint. If you want that feel free to make a different PR to suggest those changes. I don't want to bloat this PR to add huge changes just to be rejected.

{
$this->user = $user;
$this->guard = $guard;
}
}
17 changes: 17 additions & 0 deletions src/Illuminate/Auth/SessionGuard.php
Original file line number Diff line number Diff line change
Expand Up @@ -552,6 +552,8 @@ public function logoutOtherDevices($password, $attribute = 'password')

$this->queueRecallerCookie($this->user());

$this->fireLogoutOtherDevicesEvent($this->user());

return $result;
}

Expand Down Expand Up @@ -615,6 +617,21 @@ protected function fireAuthenticatedEvent($user)
}
}

/**
* Fire the logout other devices event if the dispatcher is set.
*
* @param \Illuminate\Contracts\Auth\Authenticatable $user
* @return void
*/
protected function fireLogoutOtherDevicesEvent($user)
{
if (isset($this->events)) {
$this->events->dispatch(new Events\LogoutOtherDevices(
Copy link
Contributor

@laurencei laurencei Mar 12, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the namespace be imported at the top - then just new LogoutOtherDevices(... here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm just following the other existing fire{EventName}Method structure in the class.

$this->name, $user
));
}
}

/**
* Fire the failed authentication attempt event with the given arguments.
*
Expand Down
22 changes: 22 additions & 0 deletions tests/Integration/Auth/AuthenticationTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use Illuminate\Auth\EloquentUserProvider;
use Illuminate\Auth\Events\Authenticated;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Auth\Events\LogoutOtherDevices;
use Illuminate\Tests\Integration\Auth\Fixtures\AuthenticationTestUser;

/**
Expand Down Expand Up @@ -185,6 +186,27 @@ public function test_logging_out()
});
}

public function test_logging_out_other_devices()
{
Event::fake();

$this->app['auth']->loginUsingId(1);

$user = $this->app['auth']->user();

$this->assertEquals(1, $user->id);

$this->app['auth']->logoutOtherDevices('adifferentpassword');
$this->assertEquals(1, $user->id);

Event::assertDispatched(LogoutOtherDevices::class, function ($event) {
$this->assertEquals('web', $event->guard);
$this->assertEquals(1, $event->user->id);

return true;
});
}

public function test_logging_in_out_via_attempt_remembering()
{
$this->assertTrue(
Expand Down