allow a way of creating client from known environment variables #166
Labels
enhancement
Improvements to the current code that are not breaking current functionality
Comments
karencfv
added
the
enhancement
sudomateo
added a commit
to sudomateo/oxidecomputer-oxide.go
that referenced
this issue
Dec 22, 2023
Previously, there were two exported functions to create an Oxide API client. - `func NewClient(token, userAgent, host string) (*Client, error)` - `func NewClientFromEnv(userAgent string) (*Client, error)` These two functions required a user agent to be passed as an argument, which should be an optional argument instead. Additionally, having two separate functions means a user must switch functions when they wish to switch to or from using an environment to configure the client. The code always created a custom `http.RoundTripper` to be used as the transport for the underlying HTTP client. The only function of this custom tranport was to add HTTP headers to the request. This patch updates the SDK to export a single function to create an Oxide API client. - `func NewClientWithOpts(opts ...Opt) (*Client, error)` This new function uses the functional options pattern to accept optional configuration for the client, taking inspiration from the popular [Docker Go SDK](https://github.com/moby/moby/blob/46f7ab808b9504d735d600e259ca0723f76fb164/client/client.go#L182). Now, a user can not only build an API client from their environment, but also override the user agent or HTTP client used. The custom transport was removed and the logic to set HTTP headers for the request was moved into the `buildRequest` method where it will have access to the user agent string and the request to set the headers. With these changes, it's possible for a user to create a client without a host or token, but that's something that I'd like to discuss as part of this patch since I'm not aware of what the desired behavior is for this client. Closes: oxidecomputer#165, oxidecomputer#166
sudomateo
added a commit
to sudomateo/oxidecomputer-oxide.go
that referenced
this issue
Dec 22, 2023
Previously, there were two exported functions to create an Oxide API client. - `func NewClient(token, userAgent, host string) (*Client, error)` - `func NewClientFromEnv(userAgent string) (*Client, error)` These two functions required a user agent to be passed as an argument, which should be an optional argument instead. Additionally, having two separate functions means a user must switch functions when they wish to switch to or from using an environment to configure the client. The code always created a custom `http.RoundTripper` to be used as the transport for the underlying HTTP client. The only function of this custom tranport was to add HTTP headers to the request. This patch updates the SDK to export a single function to create an Oxide API client. - `func NewClientWithOpts(opts ...Opt) (*Client, error)` This new function uses the functional options pattern to accept optional configuration for the client, taking inspiration from the popular [Docker Go SDK](https://github.com/moby/moby/blob/46f7ab808b9504d735d600e259ca0723f76fb164/client/client.go#L182). Now, a user can not only build an API client from their environment, but also override the user agent or HTTP client used. The custom transport was removed and the logic to set HTTP headers for the request was moved into the `buildRequest` method where it will have access to the user agent string and the request to set the headers. With these changes, it's possible for a user to create a client without a host or token, but that's something that I'd like to discuss as part of this patch since I'm not aware of what the desired behavior is for this client. Closes: oxidecomputer#165, oxidecomputer#166
sudomateo
added a commit
to sudomateo/oxidecomputer-oxide.go
that referenced
this issue
Jan 17, 2024
Previously, there were two exported functions to create an Oxide API client. - `func NewClient(token, userAgent, host string) (*Client, error)` - `func NewClientFromEnv(userAgent string) (*Client, error)` These two functions required a user agent to be passed as an argument, which should be an optional argument instead. Additionally, having two separate functions means a user must switch functions when they wish to switch to or from using an environment to configure the client. The code always created a custom `http.RoundTripper` to be used as the transport for the underlying HTTP client. The only function of this custom tranport was to add HTTP headers to the request. This patch updates the SDK to export a single function to create an Oxide API client. - `func NewClient(cfg *Config) (*Client, error)` This new function uses a new `Config` type to accept optional configuration for the client. Now, a user can not only build an API client from their environment, but also override the user agent or HTTP client used. The custom transport was removed and the logic to set HTTP headers for the request was moved into the `buildRequest` method where it will have access to the user agent string and the request to set the headers. Closes: oxidecomputer#165, oxidecomputer#166
sudomateo
added a commit
to sudomateo/oxidecomputer-oxide.go
that referenced
this issue
Jan 17, 2024
Previously, there were two exported functions to create an Oxide API client. - `func NewClient(token, userAgent, host string) (*Client, error)` - `func NewClientFromEnv(userAgent string) (*Client, error)` These two functions required a user agent to be passed as an argument, which should be an optional argument instead. Additionally, having two separate functions means a user must switch functions when they wish to switch to or from using an environment to configure the client. The code always created a custom `http.RoundTripper` to be used as the transport for the underlying HTTP client. The only function of this custom tranport was to add HTTP headers to the request. This patch updates the SDK to export a single function to create an Oxide API client. - `func NewClient(cfg *Config) (*Client, error)` This new function uses a new `Config` type to accept optional configuration for the client. Now, a user can not only build an API client from their environment, but also override the user agent or HTTP client used. The custom transport was removed and the logic to set HTTP headers for the request was moved into the `buildRequest` method where it will have access to the user agent string and the request to set the headers. Closes: oxidecomputer#165, oxidecomputer#166
sudomateo
added a commit
to sudomateo/oxidecomputer-oxide.go
that referenced
this issue
Jan 17, 2024
Previously, there were two exported functions to create an Oxide API client. - `func NewClient(token, userAgent, host string) (*Client, error)` - `func NewClientFromEnv(userAgent string) (*Client, error)` These two functions required a user agent to be passed as an argument, which should be an optional argument instead. Additionally, having two separate functions means a user must switch functions when they wish to switch to or from using an environment to configure the client. The code always created a custom `http.RoundTripper` to be used as the transport for the underlying HTTP client. The only function of this custom tranport was to add HTTP headers to the request. This patch updates the SDK to export a single function to create an Oxide API client. - `func NewClient(cfg *Config) (*Client, error)` This new function uses a new `Config` type to accept optional configuration for the client. Now, a user can not only build an API client from their environment, but also override the user agent or HTTP client used. The custom transport was removed and the logic to set HTTP headers for the request was moved into the `buildRequest` method where it will have access to the user agent string and the request to set the headers. Closes: oxidecomputer#165, oxidecomputer#166
sudomateo
added a commit
to sudomateo/oxidecomputer-oxide.go
that referenced
this issue
Jan 19, 2024
Previously, there were two exported functions to create an Oxide API client. - `func NewClient(token, userAgent, host string) (*Client, error)` - `func NewClientFromEnv(userAgent string) (*Client, error)` These two functions required a user agent to be passed as an argument, which should be an optional argument instead. Additionally, having two separate functions means a user must switch functions when they wish to switch to or from using an environment to configure the client. The code always created a custom `http.RoundTripper` to be used as the transport for the underlying HTTP client. The only function of this custom tranport was to add HTTP headers to the request. This patch updates the SDK to export a single function to create an Oxide API client. - `func NewClient(cfg *Config) (*Client, error)` This new function uses a new `Config` type to accept optional configuration for the client. Now, a user can not only build an API client from their environment, but also override the user agent or HTTP client used. The custom transport was removed and the logic to set HTTP headers for the request was moved into the `buildRequest` method where it will have access to the user agent string and the request to set the headers. Closes: oxidecomputer#165, oxidecomputer#166
sudomateo
added a commit
to sudomateo/oxidecomputer-oxide.go
that referenced
this issue
Jan 19, 2024
Previously, there were two exported functions to create an Oxide API client. - `func NewClient(token, userAgent, host string) (*Client, error)` - `func NewClientFromEnv(userAgent string) (*Client, error)` These two functions required a user agent to be passed as an argument, which should be an optional argument instead. Additionally, having two separate functions means a user must switch functions when they wish to switch to or from using an environment to configure the client. The code always created a custom `http.RoundTripper` to be used as the transport for the underlying HTTP client. The only function of this custom tranport was to add HTTP headers to the request. This patch updates the SDK to export a single function to create an Oxide API client. - `func NewClient(cfg *Config) (*Client, error)` This new function uses a new `Config` type to accept optional configuration for the client. Now, a user can not only build an API client from their environment, but also override the user agent or HTTP client used. The custom transport was removed and the logic to set HTTP headers for the request was moved into the `buildRequest` method where it will have access to the user agent string and the request to set the headers. Closes: oxidecomputer#165, oxidecomputer#166
karencfv
pushed a commit
that referenced
this issue
Jan 22, 2024
* oxide: refactor exported client API Previously, there were two exported functions to create an Oxide API client. - `func NewClient(token, userAgent, host string) (*Client, error)` - `func NewClientFromEnv(userAgent string) (*Client, error)` These two functions required a user agent to be passed as an argument, which should be an optional argument instead. Additionally, having two separate functions means a user must switch functions when they wish to switch to or from using an environment to configure the client. The code always created a custom `http.RoundTripper` to be used as the transport for the underlying HTTP client. The only function of this custom tranport was to add HTTP headers to the request. This patch updates the SDK to export a single function to create an Oxide API client. - `func NewClient(cfg *Config) (*Client, error)` This new function uses a new `Config` type to accept optional configuration for the client. Now, a user can not only build an API client from their environment, but also override the user agent or HTTP client used. The custom transport was removed and the logic to set HTTP headers for the request was moved into the `buildRequest` method where it will have access to the user agent string and the request to set the headers. Closes: #165, #166 * oxide: address review feedback * oxide: correct authorization header and update tests When the authorization header was moved to the `buildRequest` function, the `Bearer` part was left out. That meant the total header was: Authorization: TOKEN Instead of: Authorization: Bearer TOKEN This commit fixes that.
|
Fixed by #180 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
At the moment you have to specify token and host when creating the client. Since it seems
OXIDE_HOSTandOXIDE_TOKENwas already used for the Terraform provider and Oxide CLI, you could possibly have something like:The text was updated successfully, but these errors were encountered: