Rewriting Region handling in Redis to use hashkeys and fix LUA scripts to use 2 keys

[MichaConrad]

Full rewrite of how regions are handled in Redis.
Because of the hashing of keys in cluster scenarios, the region key and all keys of the region must generate the same hash, otherwise the feature wouldn't really work because the LUA script updates the region on Put and Add.

To achieve this, the implementation now makes use of hash keys, the region will be enclosed by { and }.
That means, the full keys is now {<region>}:<key> instead of <region>:<key>.

That also solves an issue where I had to encode the key and region string in case the values contain the : separator.
This logic got removed.

The new implementation also validates key and region to now contain hash keys, at least if regions are used.
You could still only define a key with hash keys as long as you leave the region null.

Also:

• Rewriting the LUA scripts to use 2 keys, one for the full key and one optional region key which gets used to update the region.

This is technically a bigger breaking change, and, although I'm usually not creating a major version for such a small change, I think it is necessary. Especially because the new region logic is not compatible with the old and reading old values could result in errors.

[Copilot]

Pull Request Overview

This PR refactors Redis Lua script parameter handling by moving the region parameter from a value parameter (ARGV[7]) to a key parameter (KEYS[2]). This change affects the _scriptAdd and _scriptPut scripts, along with updates to the Eval method signature to accept a regionKey parameter, and updates to all call sites to pass the region as a key.

• Lua scripts now use KEYS[2] instead of ARGV[7] for region tracking
• Eval method signature updated to accept RedisKey regionKey parameter
• All Eval call sites updated to pass region as a key parameter

Comments suppressed due to low confidence (2)

src/CacheManager.StackExchange.Redis/RedisCacheHandle.cs:871

• The region parameter at index 6 (line 870) should be removed from the parameters array. The region is now passed as KEYS[2] through the Eval method's regionKey parameter (lines 876, 880), making this ARGV[7] entry redundant and potentially causing incorrect behavior if the scripts reference ARGV indices beyond 6.

 // ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks)
var parameters = new RedisValue[]
{
value,
item.ValueType.AssemblyQualifiedName,
(int)item.ExpirationMode,
(long)item.ExpirationTimeout.TotalMilliseconds,
item.CreatedUtc.Ticks,
item.UsesExpirationDefaults,
string.IsNullOrWhiteSpace(item.Region) ? string.Empty : item.Region
};

src/CacheManager.StackExchange.Redis/RedisCacheHandle.cs:861

• The comment is incomplete and should be updated to document all parameters. It should be: '// ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks), [6]: usesDefaultExpiration'

 // ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[MichaConrad]

Full rewrite of how regions are handled in Redis.
Because of the hashing of keys in cluster scenarios, the region key and all keys of the region must generate the same hash, otherwise the feature wouldn't really work because the LUA script updates the region on Put and Add.

To achieve this, the implementation now makes use of hash keys, the region will be enclosed by { and }.
That means, the full keys is now {<region>}:<key> instead of <region>:<key>.

That also solves an issue where I had to encode the key and region string in case the values contain the : separator.
This logic got removed.

The new implementation also validates key and region to now contain hash keys, at least if regions are used.
You could still only define a key with hash keys as long as you leave the region null.

Also:

• Rewriting the LUA scripts to use 2 keys, one for the full key and one optional region key which gets used to update the region.

This is technically a bigger breaking change, and, although I'm usually not creating a major version for such a small change, I think it is necessary. Especially because the new region logic is not compatible with the old and reading old values could result in errors.

[Copilot]

Pull Request Overview

This PR refactors Redis Lua script parameter handling by moving the region parameter from a value parameter (ARGV[7]) to a key parameter (KEYS[2]). This change affects the _scriptAdd and _scriptPut scripts, along with updates to the Eval method signature to accept a regionKey parameter, and updates to all call sites to pass the region as a key.

• Lua scripts now use KEYS[2] instead of ARGV[7] for region tracking
• Eval method signature updated to accept RedisKey regionKey parameter
• All Eval call sites updated to pass region as a key parameter

Comments suppressed due to low confidence (2)

src/CacheManager.StackExchange.Redis/RedisCacheHandle.cs:871

• The region parameter at index 6 (line 870) should be removed from the parameters array. The region is now passed as KEYS[2] through the Eval method's regionKey parameter (lines 876, 880), making this ARGV[7] entry redundant and potentially causing incorrect behavior if the scripts reference ARGV indices beyond 6.

 // ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks)
var parameters = new RedisValue[]
{
value,
item.ValueType.AssemblyQualifiedName,
(int)item.ExpirationMode,
(long)item.ExpirationTimeout.TotalMilliseconds,
item.CreatedUtc.Ticks,
item.UsesExpirationDefaults,
string.IsNullOrWhiteSpace(item.Region) ? string.Empty : item.Region
};

src/CacheManager.StackExchange.Redis/RedisCacheHandle.cs:861

• The comment is incomplete and should be updated to document all parameters. It should be: '// ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks), [6]: usesDefaultExpiration'

 // ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[MichaConrad]

Full rewrite of how regions are handled in Redis.
Because of the hashing of keys in cluster scenarios, the region key and all keys of the region must generate the same hash, otherwise the feature wouldn't really work because the LUA script updates the region on Put and Add.

To achieve this, the implementation now makes use of hash keys, the region will be enclosed by { and }.
That means, the full keys is now {<region>}:<key> instead of <region>:<key>.

That also solves an issue where I had to encode the key and region string in case the values contain the : separator.
This logic got removed.

The new implementation also validates key and region to now contain hash keys, at least if regions are used.
You could still only define a key with hash keys as long as you leave the region null.

Also:

• Rewriting the LUA scripts to use 2 keys, one for the full key and one optional region key which gets used to update the region.

This is technically a bigger breaking change, and, although I'm usually not creating a major version for such a small change, I think it is necessary. Especially because the new region logic is not compatible with the old and reading old values could result in errors.

[Copilot]

Pull Request Overview

This PR refactors Redis Lua script parameter handling by moving the region parameter from a value parameter (ARGV[7]) to a key parameter (KEYS[2]). This change affects the _scriptAdd and _scriptPut scripts, along with updates to the Eval method signature to accept a regionKey parameter, and updates to all call sites to pass the region as a key.

• Lua scripts now use KEYS[2] instead of ARGV[7] for region tracking
• Eval method signature updated to accept RedisKey regionKey parameter
• All Eval call sites updated to pass region as a key parameter

Comments suppressed due to low confidence (2)

src/CacheManager.StackExchange.Redis/RedisCacheHandle.cs:871

• The region parameter at index 6 (line 870) should be removed from the parameters array. The region is now passed as KEYS[2] through the Eval method's regionKey parameter (lines 876, 880), making this ARGV[7] entry redundant and potentially causing incorrect behavior if the scripts reference ARGV indices beyond 6.

 // ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks)
var parameters = new RedisValue[]
{
value,
item.ValueType.AssemblyQualifiedName,
(int)item.ExpirationMode,
(long)item.ExpirationTimeout.TotalMilliseconds,
item.CreatedUtc.Ticks,
item.UsesExpirationDefaults,
string.IsNullOrWhiteSpace(item.Region) ? string.Empty : item.Region
};

src/CacheManager.StackExchange.Redis/RedisCacheHandle.cs:861

• The comment is incomplete and should be updated to document all parameters. It should be: '// ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks), [6]: usesDefaultExpiration'

 // ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[MichaConrad]

Full rewrite of how regions are handled in Redis.
Because of the hashing of keys in cluster scenarios, the region key and all keys of the region must generate the same hash, otherwise the feature wouldn't really work because the LUA script updates the region on Put and Add.

To achieve this, the implementation now makes use of hash keys, the region will be enclosed by { and }.
That means, the full keys is now {<region>}:<key> instead of <region>:<key>.

That also solves an issue where I had to encode the key and region string in case the values contain the : separator.
This logic got removed.

The new implementation also validates key and region to now contain hash keys, at least if regions are used.
You could still only define a key with hash keys as long as you leave the region null.

Also:

• Rewriting the LUA scripts to use 2 keys, one for the full key and one optional region key which gets used to update the region.

This is technically a bigger breaking change, and, although I'm usually not creating a major version for such a small change, I think it is necessary. Especially because the new region logic is not compatible with the old and reading old values could result in errors.

[Copilot]

Pull Request Overview

This PR refactors Redis Lua script parameter handling by moving the region parameter from a value parameter (ARGV[7]) to a key parameter (KEYS[2]). This change affects the _scriptAdd and _scriptPut scripts, along with updates to the Eval method signature to accept a regionKey parameter, and updates to all call sites to pass the region as a key.

• Lua scripts now use KEYS[2] instead of ARGV[7] for region tracking
• Eval method signature updated to accept RedisKey regionKey parameter
• All Eval call sites updated to pass region as a key parameter

Comments suppressed due to low confidence (2)

src/CacheManager.StackExchange.Redis/RedisCacheHandle.cs:871

• The region parameter at index 6 (line 870) should be removed from the parameters array. The region is now passed as KEYS[2] through the Eval method's regionKey parameter (lines 876, 880), making this ARGV[7] entry redundant and potentially causing incorrect behavior if the scripts reference ARGV indices beyond 6.

 // ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks)
var parameters = new RedisValue[]
{
value,
item.ValueType.AssemblyQualifiedName,
(int)item.ExpirationMode,
(long)item.ExpirationTimeout.TotalMilliseconds,
item.CreatedUtc.Ticks,
item.UsesExpirationDefaults,
string.IsNullOrWhiteSpace(item.Region) ? string.Empty : item.Region
};

src/CacheManager.StackExchange.Redis/RedisCacheHandle.cs:861

• The comment is incomplete and should be updated to document all parameters. It should be: '// ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks), [6]: usesDefaultExpiration'

 // ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[MichaConrad]

Full rewrite of how regions are handled in Redis.
Because of the hashing of keys in cluster scenarios, the region key and all keys of the region must generate the same hash, otherwise the feature wouldn't really work because the LUA script updates the region on Put and Add.

To achieve this, the implementation now makes use of hash keys, the region will be enclosed by { and }.
That means, the full keys is now {<region>}:<key> instead of <region>:<key>.

That also solves an issue where I had to encode the key and region string in case the values contain the : separator.
This logic got removed.

The new implementation also validates key and region to now contain hash keys, at least if regions are used.
You could still only define a key with hash keys as long as you leave the region null.

Also:

• Rewriting the LUA scripts to use 2 keys, one for the full key and one optional region key which gets used to update the region.

This is technically a bigger breaking change, and, although I'm usually not creating a major version for such a small change, I think it is necessary. Especially because the new region logic is not compatible with the old and reading old values could result in errors.

[Copilot]

Pull Request Overview

This PR refactors Redis Lua script parameter handling by moving the region parameter from a value parameter (ARGV[7]) to a key parameter (KEYS[2]). This change affects the _scriptAdd and _scriptPut scripts, along with updates to the Eval method signature to accept a regionKey parameter, and updates to all call sites to pass the region as a key.

• Lua scripts now use KEYS[2] instead of ARGV[7] for region tracking
• Eval method signature updated to accept RedisKey regionKey parameter
• All Eval call sites updated to pass region as a key parameter

Comments suppressed due to low confidence (2)

src/CacheManager.StackExchange.Redis/RedisCacheHandle.cs:871

• The region parameter at index 6 (line 870) should be removed from the parameters array. The region is now passed as KEYS[2] through the Eval method's regionKey parameter (lines 876, 880), making this ARGV[7] entry redundant and potentially causing incorrect behavior if the scripts reference ARGV indices beyond 6.

 // ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks)
var parameters = new RedisValue[]
{
value,
item.ValueType.AssemblyQualifiedName,
(int)item.ExpirationMode,
(long)item.ExpirationTimeout.TotalMilliseconds,
item.CreatedUtc.Ticks,
item.UsesExpirationDefaults,
string.IsNullOrWhiteSpace(item.Region) ? string.Empty : item.Region
};

src/CacheManager.StackExchange.Redis/RedisCacheHandle.cs:861

• The comment is incomplete and should be updated to document all parameters. It should be: '// ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks), [6]: usesDefaultExpiration'

 // ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[MichaConrad]

Full rewrite of how regions are handled in Redis.
Because of the hashing of keys in cluster scenarios, the region key and all keys of the region must generate the same hash, otherwise the feature wouldn't really work because the LUA script updates the region on Put and Add.

To achieve this, the implementation now makes use of hash keys, the region will be enclosed by { and }.
That means, the full keys is now {<region>}:<key> instead of <region>:<key>.

That also solves an issue where I had to encode the key and region string in case the values contain the : separator.
This logic got removed.

The new implementation also validates key and region to now contain hash keys, at least if regions are used.
You could still only define a key with hash keys as long as you leave the region null.

Also:

• Rewriting the LUA scripts to use 2 keys, one for the full key and one optional region key which gets used to update the region.

This is technically a bigger breaking change, and, although I'm usually not creating a major version for such a small change, I think it is necessary. Especially because the new region logic is not compatible with the old and reading old values could result in errors.

[Copilot]

Pull Request Overview

This PR refactors Redis Lua script parameter handling by moving the region parameter from a value parameter (ARGV[7]) to a key parameter (KEYS[2]). This change affects the _scriptAdd and _scriptPut scripts, along with updates to the Eval method signature to accept a regionKey parameter, and updates to all call sites to pass the region as a key.

• Lua scripts now use KEYS[2] instead of ARGV[7] for region tracking
• Eval method signature updated to accept RedisKey regionKey parameter
• All Eval call sites updated to pass region as a key parameter

Comments suppressed due to low confidence (2)

src/CacheManager.StackExchange.Redis/RedisCacheHandle.cs:871

• The region parameter at index 6 (line 870) should be removed from the parameters array. The region is now passed as KEYS[2] through the Eval method's regionKey parameter (lines 876, 880), making this ARGV[7] entry redundant and potentially causing incorrect behavior if the scripts reference ARGV indices beyond 6.

 // ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks)
var parameters = new RedisValue[]
{
value,
item.ValueType.AssemblyQualifiedName,
(int)item.ExpirationMode,
(long)item.ExpirationTimeout.TotalMilliseconds,
item.CreatedUtc.Ticks,
item.UsesExpirationDefaults,
string.IsNullOrWhiteSpace(item.Region) ? string.Empty : item.Region
};

src/CacheManager.StackExchange.Redis/RedisCacheHandle.cs:861

• The comment is incomplete and should be updated to document all parameters. It should be: '// ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks), [6]: usesDefaultExpiration'

 // ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[MichaConrad]

Full rewrite of how regions are handled in Redis.
Because of the hashing of keys in cluster scenarios, the region key and all keys of the region must generate the same hash, otherwise the feature wouldn't really work because the LUA script updates the region on Put and Add.

To achieve this, the implementation now makes use of hash keys, the region will be enclosed by { and }.
That means, the full keys is now {<region>}:<key> instead of <region>:<key>.

That also solves an issue where I had to encode the key and region string in case the values contain the : separator.
This logic got removed.

The new implementation also validates key and region to now contain hash keys, at least if regions are used.
You could still only define a key with hash keys as long as you leave the region null.

Also:

• Rewriting the LUA scripts to use 2 keys, one for the full key and one optional region key which gets used to update the region.

This is technically a bigger breaking change, and, although I'm usually not creating a major version for such a small change, I think it is necessary. Especially because the new region logic is not compatible with the old and reading old values could result in errors.

[Copilot]

Pull Request Overview

This PR refactors Redis Lua script parameter handling by moving the region parameter from a value parameter (ARGV[7]) to a key parameter (KEYS[2]). This change affects the _scriptAdd and _scriptPut scripts, along with updates to the Eval method signature to accept a regionKey parameter, and updates to all call sites to pass the region as a key.

• Lua scripts now use KEYS[2] instead of ARGV[7] for region tracking
• Eval method signature updated to accept RedisKey regionKey parameter
• All Eval call sites updated to pass region as a key parameter

Comments suppressed due to low confidence (2)

src/CacheManager.StackExchange.Redis/RedisCacheHandle.cs:871

• The region parameter at index 6 (line 870) should be removed from the parameters array. The region is now passed as KEYS[2] through the Eval method's regionKey parameter (lines 876, 880), making this ARGV[7] entry redundant and potentially causing incorrect behavior if the scripts reference ARGV indices beyond 6.

 // ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks)
var parameters = new RedisValue[]
{
value,
item.ValueType.AssemblyQualifiedName,
(int)item.ExpirationMode,
(long)item.ExpirationTimeout.TotalMilliseconds,
item.CreatedUtc.Ticks,
item.UsesExpirationDefaults,
string.IsNullOrWhiteSpace(item.Region) ? string.Empty : item.Region
};

src/CacheManager.StackExchange.Redis/RedisCacheHandle.cs:861

• The comment is incomplete and should be updated to document all parameters. It should be: '// ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks), [6]: usesDefaultExpiration'

 // ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[MichaConrad]

Full rewrite of how regions are handled in Redis.
Because of the hashing of keys in cluster scenarios, the region key and all keys of the region must generate the same hash, otherwise the feature wouldn't really work because the LUA script updates the region on Put and Add.

To achieve this, the implementation now makes use of hash keys, the region will be enclosed by { and }.
That means, the full keys is now {<region>}:<key> instead of <region>:<key>.

That also solves an issue where I had to encode the key and region string in case the values contain the : separator.
This logic got removed.

The new implementation also validates key and region to now contain hash keys, at least if regions are used.
You could still only define a key with hash keys as long as you leave the region null.

Also:

• Rewriting the LUA scripts to use 2 keys, one for the full key and one optional region key which gets used to update the region.

This is technically a bigger breaking change, and, although I'm usually not creating a major version for such a small change, I think it is necessary. Especially because the new region logic is not compatible with the old and reading old values could result in errors.

[Copilot]

Pull Request Overview

This PR refactors Redis Lua script parameter handling by moving the region parameter from a value parameter (ARGV[7]) to a key parameter (KEYS[2]). This change affects the _scriptAdd and _scriptPut scripts, along with updates to the Eval method signature to accept a regionKey parameter, and updates to all call sites to pass the region as a key.

• Lua scripts now use KEYS[2] instead of ARGV[7] for region tracking
• Eval method signature updated to accept RedisKey regionKey parameter
• All Eval call sites updated to pass region as a key parameter

Comments suppressed due to low confidence (2)

src/CacheManager.StackExchange.Redis/RedisCacheHandle.cs:871

• The region parameter at index 6 (line 870) should be removed from the parameters array. The region is now passed as KEYS[2] through the Eval method's regionKey parameter (lines 876, 880), making this ARGV[7] entry redundant and potentially causing incorrect behavior if the scripts reference ARGV indices beyond 6.

 // ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks)
var parameters = new RedisValue[]
{
value,
item.ValueType.AssemblyQualifiedName,
(int)item.ExpirationMode,
(long)item.ExpirationTimeout.TotalMilliseconds,
item.CreatedUtc.Ticks,
item.UsesExpirationDefaults,
string.IsNullOrWhiteSpace(item.Region) ? string.Empty : item.Region
};

src/CacheManager.StackExchange.Redis/RedisCacheHandle.cs:861

• The comment is incomplete and should be updated to document all parameters. It should be: '// ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks), [6]: usesDefaultExpiration'

 // ARGV [1]: value, [2]: type, [3]: expirationMode, [4]: expirationTimeout(millis), [5]: created(ticks)

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.