Skip to content

coder features list CLI command - #3533

Merged
spikecurtis merged 10 commits into
mainfrom
spike/3278_entitlements_cli
Aug 17, 2022
Merged

spikecurtis merged 10 commits into
mainfrom
spike/3278_entitlements_cli

Conversation

@spikecurtis

Copy link
Copy Markdown
Collaborator

Fixes #3278

Signed-off-by: Spike Curtis <spike@coder.com>
Signed-off-by: Spike Curtis <spike@coder.com>
Signed-off-by: Spike Curtis <spike@coder.com>
Signed-off-by: Spike Curtis <spike@coder.com>
Signed-off-by: Spike Curtis <spike@coder.com>
Signed-off-by: Spike Curtis <spike@coder.com>
@spikecurtis
spikecurtis requested review from a team and kylecarbs August 17, 2022 16:12
@spikecurtis
spikecurtis requested a review from a team as a code owner August 17, 2022 16:12
Comment thread cli/features_test.go

client := coderdtest.New(t, nil)
coderdtest.CreateFirstUser(t, client)
cmd, root := clitest.New(t, "features", "list", "-o", "json")

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Possibly slightly weird is that when you do -o json you get the whole Entitlements struct, but when you do -o table (or default output), you only get the features in the table.

What is missing in the table output are the warnings, but our plan is to print license warnings after every CLI command, so when that is done you will still get them in the output.

@kylecarbs kylecarbs left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one comment on the API, but LGTM.

Comment thread codersdk/features.go Outdated
Comment on lines +37 to +40
type EntitlementsRequest struct {
// placeholder so that we can add request parameters in future
// without breaking changes to the go API
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm tempted not to do this unless we have certainty that all parameters would be optional.

Otherwise a syntax error wouldn't occur, but the API request may fail.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have certainty that all parameters will be optional, but adding a new non-optional parameter is always an API breaking change.

If we formulate things with this placeholder, we at least have a straightforward way to add optional parameters in future without a breaking change. It's true that we could do opts ...EntilementsRequestOptions in future, but that's inconsistent with how other methods work, so I added the placeholder...

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, well, looks like my hand is being forced to what you suggest anyway. Typescript doesn't like the empty struct from our autogenerated code, so I'll just drop this. Not worth fixing for something we're not crazy about in the first place.

Signed-off-by: Spike Curtis <spike@coder.com>
Signed-off-by: Spike Curtis <spike@coder.com>
@spikecurtis
spikecurtis merged commit acd0cd6 into main Aug 17, 2022
@spikecurtis
spikecurtis deleted the spike/3278_entitlements_cli branch August 17, 2022 18:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Implement Entitlements API in AGPL

2 participants