Set client name in `HELLO` handshake during connection initialization by LINKIWI · Pull Request #3294 · redis/go-redis

LINKIWI · 2025-03-09T18:38:30Z

Context

Connection initialization consists of 3 independent operations, executed sequentially:

Attempt a RESP 3 HELLO handshake (ref: https://github.com/redis/go-redis/blob/v9.7.1/redis.go#L313)
Pipeline request to set additional properties on the connection, including authentication, DB index, read-only mode, and client name (ref: https://github.com/redis/go-redis/blob/v9.7.1/redis.go#L326)
Pipeline request for client library information (ref: https://github.com/redis/go-redis/blob/v9.7.1/redis.go#L362)

The HELLO command supports an optional property, SETNAME, that allows the client name to be set on the connection at handshake-time, thus making any subsequent CLIENT SETNAME unnecesary.

https://redis.io/docs/latest/commands/hello/

Problem statement

We are running go-redis against a proprietary RESP protocol-compliant server that correctly recognizes and manipulates client names on connections.

The problem with the sequence of 3 operations above is that the client name is not known to the server until completion of step 2. This means that, the client identity is unknown at completion of step 1, and unknown at the start of step 2.

This has caused RESP handshakes to be flagged as coming from unknown clients.

Proposal

Since the HELLO command supports supplying the client name inline, simply pass the client-specified name in the HELLO request. This should be supported by any RESP3-compliant servers. This patch is a noop if the client name field is empty.

This does not remove CLIENT SETNAME from the subsequent pipeline; this is needed for backwards compatibility for RESP2 servers.

This patch solves the problem statement described above because the client identity on the connection will be known at the time HELLO completes (assuming a RESP3 client). This allows all subsequent commands (namely, steps 2 and 3 above) to be correctly associated with a client identity.

Manual test

Against an Elasticache Redis.

First, apply the follwing patch to go.mod, in order to include this patch:

...

replace (
        github.com/redis/go-redis/v9 v9.7.1 => github.com/LINKIWI/go-redis/v9 v9.0.0-20250309182633-934829e5964b
)

Program:

package main

import (
        "context"
        "fmt"
        "time"

        goredis "github.com/redis/go-redis/v9"
)

func main() {
        opts := &goredis.Options{
                Addr:       "<scrubbed>.0001.usw2.cache.amazonaws.com:6379",
                ClientName: "pr-3294",
        }

        rdb := goredis.NewClient(opts)

        for range time.NewTicker(1 * time.Second).C {
                pong, err := rdb.Ping(context.Background()).Result()
                fmt.Println(pong, err)
        }
}

Binary execution:

$ ./ping
PONG <nil>
PONG <nil>
PONG <nil>
PONG <nil>
PONG <nil>
PONG <nil>
PONG <nil>
PONG <nil>
PONG <nil>
PONG <nil>

Verify that the client name continues to be set properly by examining CLIENT LIST:

$ echo "client list" | redis-cli -h <scrubbed>.0001.usw2.cache.amazonaws.com | grep pr-3294
id=205685 addr=10.101.66.186:58264 laddr=10.101.254.26:6379 fd=134 name=pr-3294 age=55 idle=1 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=0 argv-mem=0 obl=0 oll=0 omem=0 tot-mem=20496 events=r cmd=ping user=default redir=-1

monkey92t · 2025-03-12T02:38:58Z

good~

ndyakov · 2025-03-12T21:50:16Z

@LINKIWI is there a way to test this agains elasticache for example?

LINKIWI · 2025-03-12T21:52:15Z

@LINKIWI is there a way to test this agains elasticache for example?

Do you mean a manual test? If so, sure, happy to exercise this manually against Elasticache directly and document the results in the PR description.

LINKIWI · 2025-03-12T22:17:19Z

@LINKIWI is there a way to test this agains elasticache for example?

Do you mean a manual test? If so, sure, happy to exercise this manually against Elasticache directly and document the results in the PR description.

@ndyakov I updated the PR description with the results of manual verification against an Elasticache Redis cluster. We are both on AWS, and already running this patch in production, so fortunately this test was straightforward.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/redis/go-redis/v9](https://github.com/redis/go-redis) | require | minor | `v9.7.3` -> `v9.8.0` | --- ### Release Notes <details> <summary>redis/go-redis (github.com/redis/go-redis/v9)</summary> ### [`v9.8.0`](https://github.com/redis/go-redis/releases/tag/v9.8.0) [Compare Source](redis/go-redis@v9.7.3...v9.8.0) ### 9.8.0 (2025-04-30) #### 🚀 Highlights - **Redis 8 Support**: Full compatibility with Redis 8.0, including testing and CI integration - **Enhanced Hash Operations**: Added support for new hash commands (`HGETDEL`, `HGETEX`, `HSETEX`) and `HSTRLEN` command - **Search Improvements**: Enabled Search DIALECT 2 by default and added `CountOnly` argument for `FT.Search` #### ✨ New Features - Added support for new hash commands: `HGETDEL`, `HGETEX`, `HSETEX` ([#3305](redis/go-redis#3305)) - Added `HSTRLEN` command for hash operations ([#2843](redis/go-redis#2843)) - Added `Do` method for raw query by single connection from `pool.Conn()` ([#3182](redis/go-redis#3182)) - Prevent false-positive marshaling by treating zero time.Time as empty in isEmptyValue ([#3273](redis/go-redis#3273)) - Added FailoverClusterClient support for Universal client ([#2794](redis/go-redis#2794)) - Added support for cluster mode with `IsClusterMode` config parameter ([#3255](redis/go-redis#3255)) - Added client name support in `HELLO` RESP handshake ([#3294](redis/go-redis#3294)) - **Enabled Search DIALECT 2 by default** ([#3213](redis/go-redis#3213)) - Added read-only option for failover configurations ([#3281](redis/go-redis#3281)) - Added `CountOnly` argument for `FT.Search` to use `LIMIT 0 0` ([#3338](redis/go-redis#3338)) - Added `DB` option support in `NewFailoverClusterClient` ([#3342](redis/go-redis#3342)) - Added `nil` check for the options when creating a client ([#3363](redis/go-redis#3363)) #### 🐛 Bug Fixes - Fixed `PubSub` concurrency safety issues ([#3360](redis/go-redis#3360)) - Fixed panic caused when argument is `nil` ([#3353](redis/go-redis#3353)) - Improved error handling when fetching master node from sentinels ([#3349](redis/go-redis#3349)) - Fixed connection pool timeout issues and increased retries ([#3298](redis/go-redis#3298)) - Fixed context cancellation error leading to connection spikes on Primary instances ([#3190](redis/go-redis#3190)) - Fixed RedisCluster client to consider `MASTERDOWN` a retriable error ([#3164](redis/go-redis#3164)) - Fixed tracing to show complete commands instead of truncated versions ([#3290](redis/go-redis#3290)) - Fixed OpenTelemetry instrumentation to prevent multiple span reporting ([#3168](redis/go-redis#3168)) - Fixed `FT.Search` Limit argument and added `CountOnly` argument for limit 0 0 ([#3338](redis/go-redis#3338)) - Fixed missing command in interface ([#3344](redis/go-redis#3344)) - Fixed slot calculation for `COUNTKEYSINSLOT` command ([#3327](redis/go-redis#3327)) - Updated PubSub implementation with correct context ([#3329](redis/go-redis#3329)) #### 📚 Documentation - Added hash search examples ([#3357](redis/go-redis#3357)) - Fixed documentation comments ([#3351](redis/go-redis#3351)) - Added `CountOnly` search example ([#3345](redis/go-redis#3345)) - Added examples for list commands: `LLEN`, `LPOP`, `LPUSH`, `LRANGE`, `RPOP`, `RPUSH` ([#3234](redis/go-redis#3234)) - Added `SADD` and `SMEMBERS` command examples ([#3242](redis/go-redis#3242)) - Updated `README.md` to use Redis Discord guild ([#3331](redis/go-redis#3331)) - Updated `HExpire` command documentation ([#3355](redis/go-redis#3355)) - Featured OpenTelemetry instrumentation more prominently ([#3316](redis/go-redis#3316)) - Updated `README.md` with additional information ([#310ce55](redis/go-redis@310ce55)) #### ⚡ Performance and Reliability - Bound connection pool background dials to configured dial timeout ([#3089](redis/go-redis#3089)) - Ensured context isn't exhausted via concurrent query ([#3334](redis/go-redis#3334)) #### 🔧 Dependencies and Infrastructure - Updated testing image to Redis 8.0-RC2 ([#3361](redis/go-redis#3361)) - Enabled CI for Redis CE 8.0 ([#3274](redis/go-redis#3274)) - Updated various dependencies: - Bumped golangci/golangci-lint-action from 6.5.0 to 7.0.0 ([#3354](redis/go-redis#3354)) - Bumped rojopolis/spellcheck-github-actions ([#3336](redis/go-redis#3336)) - Bumped golang.org/x/net in example/otel ([#3308](redis/go-redis#3308)) - Migrated golangci-lint configuration to v2 format ([#3354](redis/go-redis#3354)) #### ⚠️ Breaking Changes - **Enabled Search DIALECT 2 by default** ([#3213](redis/go-redis#3213)) - Dropped RedisGears (Triggers and Functions) support ([#3321](redis/go-redis#3321)) - Dropped FT.PROFILE command that was never enabled ([#3323](redis/go-redis#3323)) #### 🔒 Security - Fixed network error handling on SETINFO (CVE-2025-29923) ([#3295](redis/go-redis#3295)) #### 🧪 Testing - Added integration tests for Redis 8 behavior changes in Redis Search ([#3337](redis/go-redis#3337)) - Added vector types INT8 and UINT8 tests ([#3299](redis/go-redis#3299)) - Added test codes for search_commands.go ([#3285](redis/go-redis#3285)) - Fixed example test sorting ([#3292](redis/go-redis#3292)) #### 👥 Contributors We would like to thank all the contributors who made this release possible: [@alexander-menshchikov](https://github.com/alexander-menshchikov), [@EXPEbdodla](https://github.com/EXPEbdodla), [@afti](https://github.com/afti), [@dmaier-redislabs](https://github.com/dmaier-redislabs), [@four_leaf_clover](https://github.com/four_leaf_clover), [@alohaglenn](https://github.com/alohaglenn), [@gh73962](https://github.com/gh73962), [@justinmir](https://github.com/justinmir), [@LINKIWI](https://github.com/LINKIWI), [@liushuangbill](https://github.com/liushuangbill), [@golang88](https://github.com/golang88), [@gnpaone](https://github.com/gnpaone), [@ndyakov](https://github.com/ndyakov), [@nikolaydubina](https://github.com/nikolaydubina), [@oleglacto](https://github.com/oleglacto), [@andy-stark-redis](https://github.com/andy-stark-redis), [@rodneyosodo](https://github.com/rodneyosodo), [@dependabot](https://github.com/dependabot), [@rfyiamcool](https://github.com/rfyiamcool), [@frankxjkuang](https://github.com/frankxjkuang), [@fukua95](https://github.com/fukua95), [@soleymani-milad](https://github.com/soleymani-milad), [@ofekshenawa](https://github.com/ofekshenawa), [@khasanovbi](https://github.com/khasanovbi) </details> --- ### Configuration 📅 **Schedule**: Branch creation - Between 12:00 AM and 03:59 AM ( * 0-3 * * * ) (UTC), Automerge - Between 12:00 AM and 03:59 AM ( * 0-3 * * * ) (UTC). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/7739 Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org> Co-authored-by: Renovate Bot <forgejo-renovate-action@forgejo.org> Co-committed-by: Renovate Bot <forgejo-renovate-action@forgejo.org>

Set client name in HELLO RESP handshake

934829e

ndyakov approved these changes Mar 12, 2025

View reviewed changes

ndyakov merged commit 1c9309f into redis:master Mar 13, 2025

ndyakov added feature bug and removed feature labels Mar 13, 2025

ndyakov mentioned this pull request Mar 19, 2025

CLIENT SETNAME not working for idle connections. #3121

Closed

ofekshenawa pushed a commit that referenced this pull request Aug 10, 2025

Set client name in HELLO RESP handshake (#3294)

f3979d7

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Set client name in `HELLO` handshake during connection initialization#3294

Set client name in `HELLO` handshake during connection initialization#3294
ndyakov merged 1 commit into
redis:masterfrom
LINKIWI:hello-client-name

LINKIWI commented Mar 9, 2025 •

edited

Loading

Uh oh!

monkey92t commented Mar 12, 2025

Uh oh!

ndyakov commented Mar 12, 2025

Uh oh!

LINKIWI commented Mar 12, 2025

Uh oh!

LINKIWI commented Mar 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

LINKIWI commented Mar 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Context

Problem statement

Proposal

Manual test

Uh oh!

monkey92t commented Mar 12, 2025

Uh oh!

ndyakov commented Mar 12, 2025

Uh oh!

LINKIWI commented Mar 12, 2025

Uh oh!

LINKIWI commented Mar 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

LINKIWI commented Mar 9, 2025 •

edited

Loading