Laravel Sanctumでこのエラーが発生しました。Kernel.php \Illuminate\Session\Middleware\StartSession::class,
のapi
ミドルウェアグループに追加して修正しましたが、私のapi.php
代わりに認証ルートが追加されweb.php
、Laravelが間違った認証ガードを使用していたため、後でこれが「機能する」とわかりました。
これらのルートをここに移動web.php
すると、AuthenticatesUsers.php
トレイトで適切に機能し始めました:
Route::group(['middleware' => ['guest', 'throttle:10,5']], function () {
Route::post('register', 'Auth\RegisterController@register')->name('register');
Route::post('login', 'Auth\LoginController@login')->name('login');
Route::post('password/email', 'Auth\ForgotPasswordController@sendResetLinkEmail');
Route::post('password/reset', 'Auth\ResetPasswordController@reset');
Route::post('email/verify/{user}', 'Auth\VerificationController@verify')->name('verification.verify');
Route::post('email/resend', 'Auth\VerificationController@resend');
Route::post('oauth/{driver}', 'Auth\OAuthController@redirectToProvider')->name('oauth.redirect');
Route::get('oauth/{driver}/callback', 'Auth\OAuthController@handleProviderCallback')->name('oauth.callback');
});
Route::post('logout', 'Auth\LoginController@logout')->name('logout');
RequestGuard::logout()
存在しないという別の奇妙なエラーが発生した後、私は問題を理解しました。
カスタム認証ルートがAuthenticatesUsersトレイトのメソッドを呼び出していることに気づきましたが、それを実現するために使用Auth::routes()
していませんでした。次に、LaravelがデフォルトでWebガードを使用していることを認識しましたroutes/web.php
。つまり、ルートはにある必要があります。
これが、Sanctumと分離されたVue SPAアプリでの私の設定の外観です。
Kernel.php
protected $middlewareGroups = [
'web' => [
\App\Http\Middleware\EncryptCookies::class,
\Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
\Illuminate\Session\Middleware\StartSession::class,
// \Illuminate\Session\Middleware\AuthenticateSession::class,
\Illuminate\View\Middleware\ShareErrorsFromSession::class,
\App\Http\Middleware\VerifyCsrfToken::class,
\Illuminate\Routing\Middleware\SubstituteBindings::class,
],
'api' => [
EnsureFrontendRequestsAreStateful::class,
\Illuminate\Routing\Middleware\SubstituteBindings::class,
'throttle:60,1',
],
];
注: Laravel Sanctumと同じドメインのVue SPAでは、セッションCookieにはhttpOnly Cookieを使用し、CSRFにはCookieと安全でないCookieを覚えているweb
ため、認証にはガードを使用し、その他のすべての保護されたJSONを返すルートはauth:sanctum
ミドルウェア。
config / auth.php
'defaults' => [
'guard' => 'web',
'passwords' => 'users',
],
...
'guards' => [
'web' => [
'driver' => 'session',
'provider' => 'users',
],
'api' => [
'driver' => 'token',
'provider' => 'users',
'hash' => false,
],
],
その後、ユニットは、この、批判的に、としてテストすることができAuth::check()
、Auth::user()
およびAuth::logout()
最小限の設定との最大の使用に期待通りの仕事AuthenticatesUsers
とRegistersUsers
特徴。
ログインユニットテストの例をいくつか示します。
TestCase.php
/**
* Creates and/or returns the designated regular user for unit testing
*
* @return \App\User
*/
public function user() : User
{
$user = User::query()->firstWhere('email', 'test-user@example.com');
if ($user) {
return $user;
}
// User::generate() is just a wrapper around User::create()
$user = User::generate('Test User', 'test-user@example.com', self::AUTH_PASSWORD);
return $user;
}
/**
* Resets AuthManager state by logging out the user from all auth guards.
* This is used between unit tests to wipe cached auth state.
*
* @param array $guards
* @return void
*/
protected function resetAuth(array $guards = null) : void
{
$guards = $guards ?: array_keys(config('auth.guards'));
foreach ($guards as $guard) {
$guard = $this->app['auth']->guard($guard);
if ($guard instanceof SessionGuard) {
$guard->logout();
}
}
$protectedProperty = new \ReflectionProperty($this->app['auth'], 'guards');
$protectedProperty->setAccessible(true);
$protectedProperty->setValue($this->app['auth'], []);
}
LoginTest.php
protected $auth_guard = 'web';
/** @test */
public function it_can_login()
{
$user = $this->user();
$this->postJson(route('login'), ['email' => $user->email, 'password' => TestCase::AUTH_PASSWORD])
->assertStatus(200)
->assertJsonStructure([
'user' => [
...expectedUserFields,
],
]);
$this->assertEquals(Auth::check(), true);
$this->assertEquals(Auth::user()->email, $user->email);
$this->assertAuthenticated($this->auth_guard);
$this->assertAuthenticatedAs($user, $this->auth_guard);
$this->resetAuth();
}
/** @test */
public function it_can_logout()
{
$this->actingAs($this->user())
->postJson(route('logout'))
->assertStatus(204);
$this->assertGuest($this->auth_guard);
$this->resetAuth();
}
Laravel authトレイトのregistered
とauthenticated
メソッドをオーバーライドして、204オプションだけでなくユーザーオブジェクトを返すようにしました。
public function authenticated(Request $request, User $user)
{
return response()->json([
'user' => $user,
]);
}
protected function registered(Request $request, User $user)
{
return response()->json([
'user' => $user,
]);
}
authトレイトのベンダーコードを確認してください。それらをそのまま使用することができ、さらに上記の2つの方法を使用できます。
- vendor / laravel / ui / auth-backend / RegistersUsers.php
- vendor / laravel / ui / auth-backend / AuthenticatesUsers.php
ログイン用のVue SPAのVuexアクションは次のとおりです。
async login({ commit }, credentials) {
try {
const { data } = await axios.post(route('login'), {
...credentials,
remember: credentials.remember || undefined,
});
commit(FETCH_USER_SUCCESS, { user: data.user });
commit(LOGIN);
return commit(CLEAR_INTENDED_URL);
} catch (err) {
commit(LOGOUT);
throw new Error(`auth/login# Problem logging user in: ${err}.`);
}
},
async logout({ commit }) {
try {
await axios.post(route('logout'));
return commit(LOGOUT);
} catch (err) {
commit(LOGOUT);
throw new Error(`auth/logout# Problem logging user out: ${err}.`);
}
},
Laravel Sanctum +同じドメインのVue SPA + authユニットテストがすべて私の標準に達するまでに1週間以上かかったので、ここでの私の回答が将来他の時間を節約するのに役立つことを願っています。