Laravel Octane Compatability

[yassir3wad]

Package version

v5.0.3

Describe the bug

When running the application with Octane (using Vapor + Octane), Laravel retains connection/service instances in memory between requests. However, upon terminating an operation, Laravel calls the connection’s disconnect() method, causing the connection to become null. Subsequent operations then encounter a null connection, resulting in an exception when attempting to call Elasticsearch operations.

{
    "message": "Call to a member function search() on null",
    "exception": "Error",
    "file": "/var/task/vendor/pdphilip/elasticsearch/src/Connection.php",
    "line": 614,
}

To Reproduce

1. Deploy a Laravel application using Vapor with Octane enabled.
2. Use the Elasticsearch package to perform operations.
3. Observe that after an operation (where Laravel disconnects the service), any subsequent Elasticsearch call fails because $this->connection is null.

Expected behavior

Before executing any Elasticsearch operation (e.g., search(), select(), count(), etc.), the connection should be verified and reconnected if necessary. This behavior is similar to how the Laravel MySQL driver manages connections via the run method, ensuring a valid connection for every operation.
https://github.com/laravel/framework/blob/12.x/src/Illuminate/Database/Connection.php#L768

Actual Behavior:

After Laravel disconnects the connection post-operation, any subsequent Elasticsearch calls result in a Call to a member function search() on null error, due to the stale connection instance.

Proposed Fix:

Ensure that the reconnectIfMissingConnection() method is invoked before any internal Elasticsearch operation is executed within the Connection class. This will help maintain a valid connection state across operations when running with long-lived Octane workers.

[yassir3wad]

Hi @pdphilip ,

Maybe we can create another method inside the connection class, similar to getClient (see here). This new method would:

• Call reconnectIfMissingConnection() to ensure that the Elasticsearch client is connected.
• Return the active client instead of using the raw $this->connection property.

After adding this new method, we could update all locations in the connection class where $this->connection is used (e.g. in methods such as search(), count(), etc.) so that they first obtain the client via this new method.

Here is the implementation/fix (I can open a pr once confirmed):
yassir3wad@93c7021
yassir3wad@c106158

Alternatively, as a simpler approach, we could add a call to reconnectIfMissingConnection() at the beginning of each method (e.g. search(), count(), etc.) to ensure that the connection is always valid when an operation is executed.

Thanks!

[pdphilip]

Interesting. Since the package extends Laravel's database classes that are SQL-oriented, disconnect() is a necessary feature to detach from the PDO connection - usually for memory concerns. However Elasticsearch, of course, doesn't actually have a connection, it's a REST API, so there's never really a need to "disconnect" it.

I'm more inclined to reset the connection on disconnect, ie:

public function disconnect(): void
{
    $this->connection = $this->createConnection();
}

Could you implement the above and try your side?

Also, yassir3wad@93c7021 is correct. it should be like this. I'll update.

[yassir3wad]

Hi @pdphilip - Resetting the connection on disconnect also worked.
yassir3wad@f4ed6d3

[pdphilip]

Update in v5.0.4 @yassir3wad