module commands to be marked as unstable and require clients to opt in #2766
There are no files selected for viewing
This file contains 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 |
|---|---|---|
| @@ -1,11 +1,69 @@ | ||
| import { RedisArgument, Command, UnwrapReply, NullReply, NumberReply, TuplesToMapReply, Resp2Reply, SimpleStringReply } from '@redis/client/dist/lib/RESP/types'; | ||
|
|
||
| export type BfInfoReplyMap = TuplesToMapReply<[ | ||
| [SimpleStringReply<'Capacity'>, NumberReply], | ||
| [SimpleStringReply<'Size'>, NumberReply], | ||
| [SimpleStringReply<'Number of filters'>, NumberReply], | ||
| [SimpleStringReply<'Number of items inserted'>, NumberReply], | ||
| [SimpleStringReply<'Expansion rate'>, NullReply | NumberReply] | ||
| ]>; | ||
|
|
||
| export interface BfInfoReply { | ||
| capacity?: NumberReply; | ||
| size?: NumberReply; | ||
| numberOfFilters?: NumberReply; | ||
| numberOfInsertedItems?: NumberReply; | ||
| expansionRate?: NullReply | NumberReply; | ||
| } | ||
|
|
||
| export default { | ||
| FIRST_KEY_INDEX: 1, | ||
| IS_READ_ONLY: true, | ||
| transformArguments(key: RedisArgument) { | ||
| return ['BF.INFO', key]; | ||
| }, | ||
| transformReply: { | ||
| 2: (reply: UnwrapReply<Resp2Reply<BfInfoReplyMap>>): BfInfoReply => { | ||
| return { | ||
| capacity: reply[1], | ||
| size: reply[3], | ||
| numberOfFilters: reply[5], | ||
| numberOfInsertedItems: reply[7], | ||
| expansionRate: reply[9] | ||
| } | ||
| }, | ||
| 3: (reply: UnwrapReply<BfInfoReplyMap>): BfInfoReply => { | ||
| if (reply instanceof Map) { | ||
| throw new Error("BF.INFO shouldn't be used with type mapping to map or array"); | ||
| /* | ||
| return { | ||
|
There was a problem hiding this comment. We should only modify the keys ( edit: same for some more info commands, I'm not going to copy this comment.. |
||
| capacity: reply.get("Capacity" as unknown as BlobStringReply<'Capacity'>), | ||
| size: reply.get("Size" as unknown as BlobStringReply<"Size">), | ||
| numberOfFilters: reply.get("Number of filters" as unknown as BlobStringReply<"Number of filters">), | ||
| numberOfInsertedItems: reply.get('Number of items inserted' as unknown as BlobStringReply<'Number of items inserted'>), | ||
| expansionRate: reply.get('Expansion rate' as unknown as BlobStringReply<'Expansion rate'>), | ||
| } | ||
| */ | ||
| } else if (reply instanceof Array) { | ||
| throw new Error("BF.INFO shouldn't be used with type mapping to map or array"); | ||
| /* | ||
| return { | ||
| capacity: reply[1], | ||
| size: reply[3], | ||
| numberOfFilters: reply[5], | ||
| numberOfInsertedItems: reply[7], | ||
| expansionRate: reply[9] | ||
| } | ||
| */ | ||
| } else { | ||
| return { | ||
| capacity: reply["Capacity"], | ||
| size: reply["Size"], | ||
| numberOfFilters: reply["Number of filters"], | ||
| numberOfInsertedItems: reply["Number of items inserted"], | ||
| expansionRate: reply["Expansion rate"] | ||
| } | ||
| } | ||
| }, | ||
| }, | ||
| } as const satisfies Command; | ||
This file contains 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
This file contains 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 |
|---|---|---|
| @@ -1,53 +1,88 @@ | ||
| import { RedisArgument, Command, NumberReply, TuplesToMapReply, UnwrapReply, Resp2Reply, SimpleStringReply } from '@redis/client/dist/lib/RESP/types'; | ||
|
|
||
| export type CfInfoReplyMap = TuplesToMapReply<[ | ||
| [SimpleStringReply<'Size'>, NumberReply], | ||
| [SimpleStringReply<'Number of buckets'>, NumberReply], | ||
| [SimpleStringReply<'Number of filters'>, NumberReply], | ||
| [SimpleStringReply<'Number of items inserted'>, NumberReply], | ||
| [SimpleStringReply<'Number of items deleted'>, NumberReply], | ||
| [SimpleStringReply<'Bucket size'>, NumberReply], | ||
| [SimpleStringReply<'Expansion rate'>, NumberReply], | ||
| [SimpleStringReply<'Max iterations'>, NumberReply] | ||
| ]>; | ||
|
|
||
| export interface CfInfoReply { | ||
| size: NumberReply; | ||
| numberOfBuckets: NumberReply; | ||
| numberOfFilters: NumberReply; | ||
| numberOfInsertedItems: NumberReply; | ||
| numberOfDeletedItems: NumberReply; | ||
| bucketSize: NumberReply; | ||
| expansionRate: NumberReply; | ||
| maxIteration: NumberReply; | ||
| } | ||
|
|
||
| export default { | ||
| FIRST_KEY_INDEX: 1, | ||
| IS_READ_ONLY: true, | ||
| transformArguments(key: RedisArgument) { | ||
| return ['CF.INFO', key]; | ||
| }, | ||
|
|
||
| transformReply: { | ||
| 2: (reply: UnwrapReply<Resp2Reply<CfInfoReplyMap>>): CfInfoReply => { | ||
| return { | ||
| size: reply[1], | ||
| numberOfBuckets: reply[3], | ||
| numberOfFilters: reply[5], | ||
| numberOfInsertedItems: reply[7], | ||
| numberOfDeletedItems: reply[9], | ||
| bucketSize: reply[11], | ||
| expansionRate: reply[13], | ||
| maxIteration: reply[15] | ||
| } | ||
| }, | ||
| 3: (reply: UnwrapReply<CfInfoReplyMap>): CfInfoReply => { | ||
| if (reply instanceof Map) { | ||
| throw new Error("CF.INFO shouldn't be used with type mapping to map or array"); | ||
| /* | ||
| return { | ||
| size: reply.get("Size" as unknown as BlobStringReply<"Size">)!, | ||
| numberOfBuckets: reply.get('Number of buckets' as unknown as BlobStringReply<'Number of buckets'>)!, | ||
| numberOfFilters: reply.get('Number of filters' as unknown as BlobStringReply<"Number of filters">)!, | ||
| numberOfInsertedItems: reply.get('Number of items inserted' as unknown as BlobStringReply<'Number of items inserted'>)!, | ||
| numberOfDeletedItems: reply.get('Number of items deleted' as unknown as BlobStringReply<'Number of items deleted'>)!, | ||
| bucketSize: reply.get('Bucket size' as unknown as BlobStringReply<'Bucket size'>)!, | ||
| expansionRate: reply.get('Expansion rate' as unknown as BlobStringReply<'Expansion rate'>)!, | ||
| maxIteration: reply.get('Max iterations' as unknown as BlobStringReply<'Max iterations'>)! | ||
| } | ||
| */ | ||
| } else if (reply instanceof Array) { | ||
| throw new Error("CF.INFO shouldn't be used with type mapping to map or array"); | ||
| /* | ||
| return { | ||
| size: reply[1], | ||
| numberOfBuckets: reply[3], | ||
| numberOfFilters: reply[5], | ||
| numberOfInsertedItems: reply[7], | ||
| numberOfDeletedItems: reply[9], | ||
| bucketSize: reply[11], | ||
| expansionRate: reply[13], | ||
| maxIteration: reply[15] | ||
| } | ||
| */ | ||
| } else { | ||
| return { | ||
| size: reply['Size'], | ||
| numberOfBuckets: reply['Number of buckets'], | ||
| numberOfFilters: reply['Number of filters'], | ||
| numberOfInsertedItems: reply['Number of items inserted'], | ||
| numberOfDeletedItems: reply['Number of items deleted'], | ||
| bucketSize: reply['Bucket size'], | ||
| expansionRate: reply['Expansion rate'], | ||
| maxIteration: reply['Max iterations'] | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| } as const satisfies Command; |
Oops, something went wrong.
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.
https://github.com/redis/node-redis/blob/v5/docs/v4-to-v5.md?plain=1#L238
#2506
I'm not sure if we should keep the keys as is for the sake of consistency or transform them for the sake of "friendly/javascripty"..
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.
it says there "to avoid unneccessary transformations" (and confusion but I honestly don't think that is the case).
In this case a transformation is neccessary anyways, so might as well make it friendly. I also distinguish between "info" objects that are defined data structures, and generic maps that can contain any set of keys/values (as I'll discuss on the next one)