Skip to content
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 5 commits into from
Sep 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions mongodbatlas/mongodbatlas.go
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ type Client struct {
ServerlessInstances ServerlessInstancesService
LiveMigration LiveMigrationService
AccessTracking AccessTrackingService
ServiceVersion ServiceVersionService

onRequestCompleted RequestCompletionCallback
}
Expand Down Expand Up @@ -279,6 +280,7 @@ func NewClient(httpClient *http.Client) *Client {
c.ServerlessInstances = &ServerlessInstancesServiceOp{Client: c}
c.LiveMigration = &LiveMigrationServiceOp{Client: c}
c.AccessTracking = &AccessTrackingServiceOp{Client: c}
c.ServiceVersion = &ServiceVersionServiceOp{Client: c}

return c
}
Expand Down Expand Up @@ -564,3 +566,38 @@ func setListOptions(s string, opt interface{}) (string, error) {
origURL.RawQuery = origValues.Encode()
return origURL.String(), nil
}

// ServiceVersion represents version information.
type ServiceVersion struct {
GitHash string
Version string
}

// String serializes VersionInfo into string.
func (v *ServiceVersion) String() string {
return fmt.Sprintf("gitHash=%s; versionString=%s", v.GitHash, v.Version)
}

func parseVersionInfo(s string) *ServiceVersion {
if s == "" {
return nil
}

var result ServiceVersion
pairs := strings.Split(s, ";")
for _, pair := range pairs {
keyvalue := strings.Split(strings.TrimSpace(pair), "=")
switch keyvalue[0] {
case "gitHash":
result.GitHash = keyvalue[1]
case "versionString":
result.Version = keyvalue[1]
}
Copy link
Collaborator

@colm-quinn colm-quinn Sep 2, 2021

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.

Copy link
Contributor Author

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 format gitHash=[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.

Copy link
Collaborator

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.

}
return &result
}

// ServiceVersion parses version information returned in the response.
func (resp *Response) ServiceVersion() *ServiceVersion {
return parseVersionInfo(resp.Header.Get("X-MongoDB-Service-Version"))
}
51 changes: 51 additions & 0 deletions mongodbatlas/service_version.go
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
}
37 changes: 37 additions & 0 deletions mongodbatlas/service_version_test.go
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)
}
}