Add niljs/ prefix to niljs Client-Version header #193
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
ukorvl
force-pushed
the
change-niljs-client-version-header
branch
from
78f01b2 to
d8191b4
Compare
ukorvl
force-pushed
the
change-niljs-client-version-header
branch
from
d8191b4 to
7c33441
Compare
ukorvl
force-pushed
the
change-niljs-client-version-header
branch
from
7c33441 to
49c9650
Compare
olegrok
approved these changes
Feb 6, 2025
olegrok
reviewed
Feb 6, 2025
| @@ -98,8 +98,9 @@ func (s *Server) validateRequest(r *http.Request) (int, error) { | |||
|
|
|||
| // Niljs is supported by server | |||
| header := r.Header.Get(nilJsVersionHeader) | |||
| if header != "" { | |||
| version, err := semver.NewVersion(header) | |||
| parsedHeader := header[len(niljsClientVersionPrefix):] | |||
There was a problem hiding this comment.
please check that header length is enough. Otherwise it's easy to crash server by invalid header
There was a problem hiding this comment.
Or you can use strings.HasPrefix function
olegrok
reviewed
Feb 6, 2025
Comment on lines
699
to
703
| s.Run("Unsupported version", func() { | ||
| client := rpc_client.NewClientWithDefaultHeaders(s.Endpoint, logger, map[string]string{"Client-Version": "0.0.1"}) | ||
| client := rpc_client.NewClientWithDefaultHeaders(s.Endpoint, logger, map[string]string{"Client-Version": "niljs/0.0.1"}) | ||
| _, err := client.ChainId(s.Context) | ||
| s.Require().ErrorContains(err, "unexpected status code: 426: specified niljs version 0.0.1, minimum supported is") | ||
| }) |
There was a problem hiding this comment.
You can add new test that checks that "Client-Version": "abc" is handled properly
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.
This pull request introduces changes to include a version prefix in the
Client-Versionheader. The most important changes include defining a new constant for the version prefix, updating the server to handle the prefixed version, and modifying tests and client code to use the new version format.Changes to version management:
nil/services/rpc/internal/http/connection.go: Added a new constantniljsClientVersionPrefixto define the version prefix.nil/services/rpc/internal/http/server.go: IntroducedniljsClientVersionPrefixLengthandtrimmedMinSupportedNiljsVersionto handle the prefixed version and updatedparsedMinSupportedNiljsVersionto use the trimmed version.Updates to tests and client code:
nil/tests/basic/basic_test.go: Updated test cases to use the newClient-Versionformat with theniljs/prefix.niljs/src/rpc/rpcClient.ts: Modified thecreateRPCClientfunction to include theniljs/prefix in theClient-Versionheader.