-
Notifications
You must be signed in to change notification settings - Fork 2k
feat(client): add RESET command #3273
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sisyphusse1-ops
wants to merge
1
commit into
redis:master
Choose a base branch
from
sisyphusse1-ops:feat/reset
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+59
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| import { strict as assert } from 'node:assert'; | ||
| import testUtils, { GLOBAL } from '../test-utils'; | ||
| import RESET from './RESET'; | ||
| import { parseArgs } from './generic-transformers'; | ||
|
|
||
| describe('RESET', () => { | ||
| it('transformArguments', () => { | ||
| assert.deepEqual( | ||
| parseArgs(RESET), | ||
| ['RESET'] | ||
| ); | ||
| }); | ||
|
|
||
| testUtils.testWithClient('client.reset', async client => { | ||
| assert.equal( | ||
| await client.reset(), | ||
| 'RESET' | ||
| ); | ||
| }, GLOBAL.SERVERS.OPEN); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| import { CommandParser } from '../client/parser'; | ||
| import { SimpleStringReply, Command } from '../RESP/types'; | ||
|
|
||
| export default { | ||
| NOT_KEYED_COMMAND: true, | ||
| IS_READ_ONLY: true, | ||
| /** | ||
| * Performs a full reset of the connection state: discards any pending | ||
| * transaction (`MULTI`), unsubscribes from every channel/pattern, exits | ||
| * client tracking and monitor modes, selects database `0`, and resets | ||
| * `CLIENT TRACKINGINFO` and `CLIENT REPLY` state, among others. | ||
| * | ||
| * @param parser - The command parser | ||
| * @see https://redis.io/commands/reset/ | ||
| */ | ||
| parseCommand(parser: CommandParser) { | ||
| parser.push('RESET'); | ||
| }, | ||
| transformReply: undefined as unknown as () => SimpleStringReply<'RESET'> | ||
| } as const satisfies Command; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Auto-generated
resetshadows critical client state management methodHigh Severity
Adding
reset: RESET(andRESET) to the commands index causesattachConfigto place an auto-generatedreseton the subclass prototype, which shadowsRedisClient.prototype.reset(). The existingreset()method performs essential state management — calling#queue.reset()with special MONITOR/PubSub handling, disposing credentials subscriptions, re-running the handshake, and clearing#selectedDB,#monitorCallback,#dirtyWatch, and#watchEpoch. The auto-generated version just sends the rawRESETcommand via_executeCommand, leaving all client-side state stale. This also breaks the internalresetIfDirty()path used byRedisClientPool. Other commands with special client handling (MONITOR,SUBSCRIBE, etc.) are intentionally excluded from the commands index for this reason.Additional Locations (1)
packages/client/lib/commands/index.ts#L3498-L3499Reviewed by Cursor Bugbot for commit e2c8649. Configure here.