Deprecate implicit String-to-UTF8-bytes ticket methods #5405
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
The implicit String-to-UTF8-bytes ticket methods are potentially confusing when the user really wants to get a query scoped variable ticket. From the perspective of the java client, this may materialize as errors that look something like: ``` Exception in thread "main" io.deephaven.client.impl.TableHandle$UncheckedTableHandleException: io.deephaven.client.impl.TableHandle$TableHandleException: io.grpc.StatusRuntimeException: FAILED_PRECONDITION: Could not resolve 'sourceId': no resolver for route '84' (byte) ``` In this case, we can see that the user likely had some variable name that starts with "t" (ascii 84) and tried to use the variable name directly with one of the String-to-UTF8-bytes ticket methods. This PR aims to deprecates those methods and internally removes any usage that we have on them.
devinrsmith
added
NoDocumentationNeeded
java-client
NoReleaseNotesNeeded
rbasralian
previously approved these changes
Apr 25, 2024
devinrsmith
commented
Apr 25, 2024
Comment on lines
+36
to
+38
| * @deprecated prefer to be explicit and either use {@link #of(byte[])} or {@link #fromQueryScopeField(String)} | ||
| */ | ||
| @Deprecated |
There was a problem hiding this comment.
@rbasralian brought up point; should we prefer to add a more explicitly named fromUtf8 so users can still have an un-deprecated call to this feature? I do think that of(String) made it too easy to mess up, but there may still be general value in the function?
There was a problem hiding this comment.
I'd vote no, String.toBytes(StandardCharsets.UTF8) or whatnot is right there (assuming they want utf8 and not ascii etc...).
At least not without some feedback requesting this.
niloc132
previously approved these changes
May 10, 2024
…ate-implicit-string-as-utf8-ticket
niloc132
approved these changes
May 14, 2024
devinrsmith
deleted the
ticket-table-deprecate-implicit-string-as-utf8-ticket
branch
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
The implicit String-to-UTF8-bytes ticket methods are potentially confusing when the user really wants to get a query scoped variable ticket. From the perspective of the java client, this may materialize as errors that look something like:
In this case, we can see that the user likely had some variable name that starts with "t" (ascii 84) and tried to use the variable name directly with one of the String-to-UTF8-bytes ticket methods.
This PR aims to deprecates those methods and internally removes any usage that we have on them.