fix: protoCache map key support Buffer type #1106
Merged
Conversation
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
google-cla
bot
added
the
cla: yes
summer-ji-eng
changed the title
chingor13
reviewed
Sep 14, 2021
src/fallback.ts
Outdated
| @@ -81,7 +81,7 @@ export class GrpcClient { | |||
| authClient?: AuthClient; | |||
| fallback: boolean | 'rest' | 'proto'; | |||
| grpcVersion: string; | |||
| private static protoCache = new Map<string, protobuf.Root>(); | |||
| private static protoCache = new Map<string | Buffer, protobuf.Root>(); | |||
There was a problem hiding this comment.
Would it make sense to be more confident in the types of the internal data structure and ensure we always have a string key?
There was a problem hiding this comment.
Alternative way is to turn the hash value from Buffer to string. At line
const hash = objectHash(json).toString();
alexander-fenster
approved these changes
Sep 14, 2021
chingor13
approved these changes
Sep 14, 2021
gcf-merge-on-green bot
pushed a commit
that referenced
this pull request
Sep 14, 2021
🤖 I have created a release \*beep\* \*boop\* --- ### [2.25.3](https://www.github.com/googleapis/gax-nodejs/compare/v2.25.2...v2.25.3) (2021-09-14) ### Bug Fixes * protoCache map key support Buffer type ([#1106](https://www.github.com/googleapis/gax-nodejs/issues/1106)) ([a7ce8ab](https://www.github.com/googleapis/gax-nodejs/commit/a7ce8abc11be39722f6060f74b4d54ce6461dd40)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Tests fails at
The current
GrpcClient.protoCachemap key isStringtype. hash returnString | Buffer.Fix Solution:
Option 1: Allow maps key has two types, String | Buffer
Option 2: Secure the key as String type, but turn the
hashvalue fromobjectHashBuffer to String by usingtoString(),