Improve the arduino-app-cli version command by adding the "server version" #31 #49
Conversation
|
|
martacarbone
force-pushed
the
cli_server_version
branch
from
7484347 to
466245c
Compare
| url, err := getValidOrDefaultUrl(host) | ||
| if err != nil { | ||
| feedback.Fatal(i18n.Tr("Error: invalid host:port format"), feedback.ErrBadArgument) | ||
| } |
There was a problem hiding this comment.
Here you can just use url.Parse, but anyway I would parse the url right after getting the flag, e.g., host, _ := cmd.Flags().GetString("host"), so you can directly handle the error.
Then here you can just add the path with
url = url.Join("/v1/version")
| return serverResponse.Version, nil | ||
| } | ||
|
|
||
| type serverVersionResponse struct { |
There was a problem hiding this comment.
Usually structs used only for parsing JSON are defined directly inside the function that uses them
| } | ||
|
|
||
| var serverResponse serverVersionResponse | ||
| if err := json.Unmarshal(body, &serverResponse); err != nil { |
There was a problem hiding this comment.
Probably in this case, you aren't improving much, but usually it is better to make JSON handling the decoding buffer instead of reading the body into a buffer and then passing it to json library.
| if err := json.Unmarshal(body, &serverResponse); err != nil { | |
| var serverResponse struct { | |
| Version string `json:"version"` | |
| } | |
| if err := json.NewDecoder(resp.Body).Decode(&serverResponse); err != nil { |
|
|
||
| func (r versionResult) String() string { | ||
| return fmt.Sprintf("%s v%s", r.AppName, r.Version) | ||
| return fmt.Sprintf("client: %s\nserver: %s", |
There was a problem hiding this comment.
I am wondering if we should make a more text-friendly line like
Arduino App CLI v0.6.6
daemon server at "localhost:8800" v0.6.6
| ClientVersion string `json:"version"` | ||
| ServerVersion string `json:"serverVersion"` |
There was a problem hiding this comment.
I would probably return those info
| ClientVersion string `json:"version"` | |
| ServerVersion string `json:"serverVersion"` | |
| AppName string `json:"app_name"` | |
| Version string `json:"version"` | |
| DaemonVersion string `json:"daemon_version"` |
There was a problem hiding this comment.
We could print the name with the arduino-flasher-cli output https://github.com/arduino/arduino-flasher-cli/blob/1899741a4e890a2ff0727669d23d25b6499e0522/main.go#L63
Arduino App CLI
BUT I would avoid theapp_name that can be misleading (the term "app" is for the Arduino Apps).
maybe only "name" in the json field.
| func versionHandler(clientVersion string, host string) { | ||
| httpClient := http.Client{ | ||
| Timeout: time.Second, | ||
| } | ||
| result := doVersionHandler(httpClient, clientVersion, host) | ||
| feedback.PrintResult(result) | ||
| } |
There was a problem hiding this comment.
Maybe this extra function is too much. I think it is ok to just move this code directly inside the Run function of the cobra command.
| const ( | ||
| DefaultHostname = "localhost" | ||
| DefaultPort = "8800" | ||
| ) |
There was a problem hiding this comment.
if there isn't any reason, I would just define a single const
| const ( | |
| DefaultHostname = "localhost" | |
| DefaultPort = "8800" | |
| ) | |
| const defaultDaemon = "localhost:8800" |
4 participants
Motivation
When running arduino-app-cli version instead of only returning the version of the currently run executable (the CLI) we should also return the version of the "server" (the daemon/service running and waiting for HTTP API requests).
Change description
This change make a version request to the running daemon and adds the output to the
arduino-app-cli versioncommand.It also adds "ServerVersion" and removes "AppName" from the output.
Additional Notes
Reviewer checklist
main.