Lumenで「lumen Session store not set on request.」というエラーが出た時の対処

他のプロジェクトからコードをコピペしてきたらエラーに遭遇したので、対処方法をメモ。

sessionミドルウェアが読み込まれているか?

boostrap/app.phpに下記の内容が入っていればOKなはずです。

$app->extend("session",function($obj)use($app){
    $app->configure("session");
    $app->configure('services');
    return $obj;
});
$app->alias("session",\Illuminate\Session\SessionManager::class);
$app->register(\Illuminate\Session\SessionServiceProvider::class);
$app->middleware([
    \Illuminate\Session\Middleware\StartSession::class
]);

Lumenではセッションマネージャーがすでに入っているけど、有効になっていないだけなので、読み込みを指定すれば使用することができます。

session用の設定ファイルがあるか?

Laravelと違って、Lumenでは設定ファイルが初期の状態ではありません。

ルート以下に「config」ディレクトリを作成して、session.phpファイルを設定しておかないと、エラーが発生します。

session.phpはLaravelから取ってくるか、下記のコードをコピペしてみてください。(Lumen 5.6で動作確認済み)

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | Default Session Driver
    |--------------------------------------------------------------------------
    |
    | This option controls the default session "driver" that will be used on
    | requests. By default, we will use the lightweight native driver but
    | you may specify any of the other wonderful drivers provided here.
    |
    | Supported: "file", "cookie", "database", "apc",
    |            "memcached", "redis", "array"
    |
    */

    'driver' => env('SESSION_DRIVER', 'file'),

    /*
    |--------------------------------------------------------------------------
    | Session Lifetime
    |--------------------------------------------------------------------------
    |
    | Here you may specify the number of minutes that you wish the session
    | to be allowed to remain idle before it expires. If you want them
    | to immediately expire on the browser closing, set that option.
    |
    */

    'lifetime' => env('SESSION_LIFETIME', 120),

    'expire_on_close' => env('SESSION_EXPIRE_ON_CLOSE', false),

    /*
    |--------------------------------------------------------------------------
    | Session Encryption
    |--------------------------------------------------------------------------
    |
    | This option allows you to easily specify that all of your session data
    | should be encrypted before it is stored. All encryption will be run
    | automatically by Laravel and you can use the Session like normal.
    |
    */

    'encrypt' => false,

    /*
    |--------------------------------------------------------------------------
    | Session File Location
    |--------------------------------------------------------------------------
    |
    | When using the native session driver, we need a location where session
    | files may be stored. A default has been set for you but a different
    | location may be specified. This is only needed for file sessions.
    |
    */

    'files' => storage_path('framework/sessions'),

    /*
    |--------------------------------------------------------------------------
    | Session Database Connection
    |--------------------------------------------------------------------------
    |
    | When using the "database" or "redis" session drivers, you may specify a
    | connection that should be used to manage these sessions. This should
    | correspond to a connection in your database configuration options.
    |
    */

    'connection' => env('SESSION_DATABASE_CONNECTION',"default"),

    /*
    |--------------------------------------------------------------------------
    | Session Database Table
    |--------------------------------------------------------------------------
    |
    | When using the "database" session driver, you may specify the table we
    | should use to manage the sessions. Of course, a sensible default is
    | provided for you; however, you are free to change this as needed.
    |
    */

    'table' => env('SESSION_DATABASE_TABLE', 'sessions'),

    /*
    |--------------------------------------------------------------------------
    | Session Sweeping Lottery
    |--------------------------------------------------------------------------
    |
    | Some session drivers must manually sweep their storage location to get
    | rid of old sessions from storage. Here are the chances that it will
    | happen on a given request. By default, the odds are 2 out of 100.
    |
    */

    'lottery' => [2, 100],

    /*
    |--------------------------------------------------------------------------
    | Session Cookie Name
    |--------------------------------------------------------------------------
    |
    | Here you may change the name of the cookie used to identify a session
    | instance by ID. The name specified here will get used every time a
    | new session cookie is created by the framework for every driver.
    |
    */

    'cookie' => 'laravel_session',

    /*
    |--------------------------------------------------------------------------
    | Session Cookie Path
    |--------------------------------------------------------------------------
    |
    | The session cookie path determines the path for which the cookie will
    | be regarded as available. Typically, this will be the root path of
    | your application but you are free to change this when necessary.
    |
    */

    'path' => '/',

    /*
    |--------------------------------------------------------------------------
    | Session Cookie Domain
    |--------------------------------------------------------------------------
    |
    | Here you may change the domain of the cookie used to identify a session
    | in your application. This will determine which domains the cookie is
    | available to in your application. A sensible default has been set.
    |
    */

    'domain' => null,

    /*
    |--------------------------------------------------------------------------
    | HTTPS Only Cookies
    |--------------------------------------------------------------------------
    |
    | By setting this option to true, session cookies will only be sent back
    | to the server if the browser has a HTTPS connection. This will keep
    | the cookie from being sent to you if it can not be done securely.
    |
    */
    'secure' => env("SESSION_HTTPS",isset($_SERVER["HTTPS"])),

];

セッション保存用のディレクトリがあるか?

セッションの保存方法をファイルにしている場合は、storage/frameworkディレクトリ以下に「session」というディレクトリが必要です。

ディレクトリがなかったり、パーミッションが書き込みできない場合は、

(1/1) ErrorException

file_put_contents(/../../storage/framework/sessions/SqlKSzoPLPrZr20f7B7gtiq8peQ5ZjltCpiUxgUj): failed to open stream: No such file or directory

というエラーが出ます。


上記の3つ大丈夫なら、自分の環境ではエラーが消えました。

Lumenは日本語情報が少ないですが、海外のフォーラムなどには情報が比較的あるので助かりますね。