-
Notifications
You must be signed in to change notification settings - Fork 1
Improve api key flow #113
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
Merged
Merged
Improve api key flow #113
Changes from all commits
Commits
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 hidden or 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -10,6 +10,7 @@ import {ErrorReason, HelpfulError} from '@/application/error'; | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import {UserApi} from '@/application/api/user'; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import {FileSystem} from '@/application/fs/fileSystem'; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import {WorkspaceApi} from '@/application/api/workspace'; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import {ProjectConfiguration} from '@/application/project/configuration/projectConfiguration'; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| export type CreateApiKeyInput = { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| name?: ApiKey['name'], | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
@@ -43,31 +44,9 @@ export class CreateApiKeyCommand implements Command<CreateApiKeyInput> { | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const {configurationManager, api, fileSystem, io} = this.config; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const configuration = await configurationManager.load(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const environment = input.environment ?? await io.input.select({ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| message: 'Which environment?', | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| options: ApplicationEnvironment.all() | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| .map( | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| value => ({ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| label: ApplicationEnvironment.getLabel(value), | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| value: value, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }), | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ), | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const applicationSlug = environment === ApplicationEnvironment.PRODUCTION | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ? configuration.applications.production | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| : configuration.applications.development; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| if (applicationSlug === undefined) { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| throw new HelpfulError( | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| `No ${ApplicationEnvironment.getLabel(environment).toLowerCase()} application ` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| + 'found in the project configuration.', | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| {reason: ErrorReason.INVALID_INPUT}, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const notifier = io.output.notify('Loading information'); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const environment = await this.getEnvironment(configuration, input.environment); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const applicationSlug = this.getApplicationSlug(configuration, environment); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const defaultName = input.name ?? `${(await api.user.getUser()).username} (CLI)`; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const features = await api.workspace.getFeatures({ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| organizationSlug: configuration.organization, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
@@ -131,4 +110,46 @@ export class CreateApiKeyCommand implements Command<CreateApiKeyInput> { | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| io.output.confirm(`API key saved to \`${fileName}\``); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| private getApplicationSlug(configuration: ProjectConfiguration, environment: ApplicationEnvironment): string { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const application = environment === ApplicationEnvironment.PRODUCTION | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ? configuration.applications.production | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| : configuration.applications.development; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| if (application === undefined) { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| throw new HelpfulError( | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| `No ${ApplicationEnvironment.getLabel(environment).toLowerCase()} application ` | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| + 'found in the project configuration.', | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| {reason: ErrorReason.INVALID_INPUT}, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| return application; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| private getEnvironment( | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| configuration: ProjectConfiguration, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| environment?: ApplicationEnvironment, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ): Promise<ApplicationEnvironment> { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| if (environment !== undefined) { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| return Promise.resolve(environment); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| if (configuration.applications.production === undefined) { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| return Promise.resolve(ApplicationEnvironment.DEVELOPMENT); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const {io: {input}} = this.config; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| return input.select({ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+130
to
+144
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| private getEnvironment( | |
| configuration: ProjectConfiguration, | |
| environment?: ApplicationEnvironment, | |
| ): Promise<ApplicationEnvironment> { | |
| if (environment !== undefined) { | |
| return Promise.resolve(environment); | |
| } | |
| if (configuration.applications.production === undefined) { | |
| return Promise.resolve(ApplicationEnvironment.DEVELOPMENT); | |
| } | |
| const {io: {input}} = this.config; | |
| return input.select({ | |
| private async getEnvironment( | |
| configuration: ProjectConfiguration, | |
| environment?: ApplicationEnvironment, | |
| ): Promise<ApplicationEnvironment> { | |
| if (environment !== undefined) { | |
| return environment; | |
| } | |
| if (configuration.applications.production === undefined) { | |
| return ApplicationEnvironment.DEVELOPMENT; | |
| } | |
| const {io: {input}} = this.config; | |
| return await input.select({ |
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.
If both
productionanddevelopmentare undefined, this code will default to DEVELOPMENT and only later throw—consider adding a guard here to surface a clear error when no environments are configured.