[8.x] Make it possible to use prefixes on Predis per Connection

[tben]

This PR allows the ability to use prefixes on a per connection basis for Predis.

Basically the only way to setup a prefix is by doing the following ['redis' => ['options' => ['prefix' => 'prefix:']]] in the /config/database.php file.

So copying a similar setup in PHPRedis. Each connection can be given a unique prefix by defining them within the individual connection config like so ['redis' => ['connection1' => ['prefix' => 'prefix:'], 'connection2' => ['prefix' => 'prefix2:']]].

[GrahamCampbell]

empty is not the right function here. it will not permit using 0 as a prefix.

[tben]

I simply copied the code from

framework/src/Illuminate/Redis/Connectors/PhpRedisConnector.php

Line 94 in a049279

if (! empty($config['prefix'])) {

Do we want to allow zeros within PHPRedis Connector as well?

[taylorotwell]

Please share what the actual formatted Redis configuration would look like using these new options. Please mark as ready for review when you have done so.

[tben]

Assuming I'm understanding your question correct. The formatted Redis configuration would look like:

/config/database.php

'redis' => [
    'client' => env('REDIS_CLIENT', 'predis'),

    'default' => [
        'host' => env('REDIS_HOST', '127.0.0.1'),
        'password' => env('REDIS_PASSWORD', null),
        'port' => env('REDIS_PORT', 6379),
        'database' => env('REDIS_DB', 0),
        'prefix' => env('REDIS_PREFIX', 'prefix:'),
    ],

    'cache' => [
        'host' => env('REDIS_HOST', '127.0.0.1'),
        'password' => env('REDIS_PASSWORD', null),
        'port' => env('REDIS_PORT', 6379),
        'database' => env('REDIS_CACHE_DB', 1),
        'prefix' => env('REDIS_PREFIX', 'prefix2:'),
    ],
],

[jasonvarga]

We were just looking into this and noticed it was already possible to put a prefix on a specific store. You just had to nest it under an options array. This works for both phpredis and predis clients.

'redis' => [
    'cache' => [
        'host' => env('REDIS_HOST', '127.0.0.1'),
        'password' => env('REDIS_PASSWORD', null),
        'port' => env('REDIS_PORT', 6379),
        'database' => env('REDIS_CACHE_DB', 1),
        
        'options' => [ // 👈 you needed this
            'prefix' => env('REDIS_PREFIX', 'prefix2:'),
        ]
    ],
],

So now this PR introduces an inconsistency. You can now add un-nested prefix keys to predis stores, but not phpredis.

Although my first instinct was to plop prefix right onto the store, too. Maybe we should just apply this to the phpredis connector.

[tben]

It's been a while since I've look at the code but the change was centered around how predis client code expected the prefix to be presented. Atleast when I committed the code there was no way to pass this information to the predis code in a way that would allow it to function. It's possible that code changes now allow for it.

[jasonvarga]

In the few lines above what was added in this PR, you can see that the options were already being merged in:

$formattedOptions = array_merge(
    ['timeout' => 10.0], $options, Arr::pull($config, 'options', [])
);

[tben]

framework/src/Illuminate/Redis/RedisManager.php

Lines 107 to 115 in 4a2f5e9

	$options = $this->config['options'] ?? [];
	if (isset($this->config[$name])) {
	return $this->connector()->connect(
	$this->parseConnectionConfiguration($this->config[$name]),
	array_merge(Arr::except($options, 'parameters'), ['parameters' => Arr::get($options, 'parameters.'.$name, Arr::get($options, 'parameters', []))])
	);
	}

If you take a look at the code above. That's the parent code that calls the function that I modified. As you can see originally it would only send the global redis options not the individual options through the $config variable. This behaviour has since changed which is why it now works for you.

But I did want to point out that this code does seem pointless now but it does actually keep the setting the same between the two redis drivers settings. As you can setup a prefix in the exact same way for phpredis.

framework/src/Illuminate/Redis/Connectors/PhpRedisConnector.php

Lines 98 to 100 in 2f51de5

	if (! empty($config['prefix'])) {
	$client->setOption(Redis::OPT_PREFIX, $config['prefix']);
	}

[jasonvarga]

The first argument passed into connect() would be the store's config, which could have options in it.

[tben]

@jasonvarga Okay, I just checked on my local machine and you were correct. Yeah, that's really is my bad. :( I swear down that options didn't work for me when I wrote this fix.