-
Notifications
You must be signed in to change notification settings - Fork 34
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
CLOUDP-82836: Parse service version #248
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
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 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 |
---|---|---|
@@ -0,0 +1,51 @@ | ||
// Copyright 2021 MongoDB Inc | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package mongodbatlas | ||
|
||
import ( | ||
"context" | ||
"net/http" | ||
) | ||
|
||
const versionPath = "api/private/unauth/version" | ||
|
||
// ServiceVersionService is an interface for the version private endpoint of the MongoDB Atlas API. | ||
gssbzn marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// | ||
// We currently make no promise to support or document this service or endpoint | ||
// beyond what can be seen here. | ||
type ServiceVersionService interface { | ||
Get(context.Context) (*ServiceVersion, *Response, error) | ||
} | ||
|
||
type ServiceVersionServiceOp struct { | ||
Client PlainRequestDoer | ||
} | ||
|
||
// Get gets the version information and parses it. | ||
func (s *ServiceVersionServiceOp) Get(ctx context.Context) (*ServiceVersion, *Response, error) { | ||
req, err := s.Client.NewPlainRequest(ctx, http.MethodGet, versionPath) | ||
if err != nil { | ||
return nil, nil, err | ||
} | ||
|
||
resp, err := s.Client.Do(ctx, req, nil) | ||
if err != nil { | ||
return nil, nil, err | ||
} | ||
|
||
version := resp.ServiceVersion() | ||
|
||
return version, resp, nil | ||
} |
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 |
---|---|---|
@@ -0,0 +1,37 @@ | ||
// Copyright 2021 MongoDB Inc | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
|
||
package mongodbatlas | ||
|
||
import ( | ||
"fmt" | ||
"net/http" | ||
"testing" | ||
) | ||
|
||
func TestServiceVersionService_Get(t *testing.T) { | ||
client, mux, teardown := setup() | ||
defer teardown() | ||
|
||
mux.HandleFunc("/api/private/unauth/version", func(w http.ResponseWriter, r *http.Request) { | ||
testMethod(t, r, http.MethodGet) | ||
fmt.Fprint(w, "someGitHash") | ||
}) | ||
|
||
_, _, err := client.ServiceVersion.Get(ctx) | ||
|
||
if err != nil { | ||
t.Fatalf("ServiceVersion.Get returned error: %v", err) | ||
} | ||
} |
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.
[q] Should we log/fail on any other case? I generally don't like switches without a default, as changes can go undetected. If we had a default error, along with a unit test, a structure change to the client would immediately fail here.
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.
Thanks for your question.
For context, we are using the header
X-MongoDB-Service-Version
which should contain the formatgitHash=[some git hash]; versionString=[some version e.g. 5.0.0.100.20210710T1827Z]
In case I receive keys I do not support I am ignoring them, for instance
gitHash=[some git hash]; versionString=[some version e.g. 5.0.0.100.20210710T1827Z]; keyNotKnown=[value]
I think ignoring keys is an acceptable thing to do, that is exactly what the
encoding/json
package does if you're missing some fields in your struct.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.
Fair enough, if we added logging, the client would get a bunch of warnings constantly as the shape changes as well, which is not a great experience.