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

Fix host resolution order in auth login #1370

Merged
merged 25 commits into from
Aug 14, 2024
Merged

Conversation

shreyas-goenka
Copy link
Contributor

@shreyas-goenka shreyas-goenka commented Apr 16, 2024

Changes

The auth login command today prefers a host URL specified in a profile before selecting the one explicitly provided by a user as a command line argument.

This PR fixes this bug and refactors the code to make it more linear and easy to read. Note that the same issue exists in the auth token command and is fixed here as well.

Tests

Unit tests, and manual testing.

@shreyas-goenka shreyas-goenka changed the title Improvements to auth login command Improvements to auth login command Apr 16, 2024
cmd/auth/login.go Outdated Show resolved Hide resolved
cmd/auth/auth.go Outdated Show resolved Hide resolved
cmd/auth/auth.go Outdated Show resolved Hide resolved
cmd/auth/auth.go Show resolved Hide resolved
cmd/auth/login.go Outdated Show resolved Hide resolved
cmd/auth/login.go Outdated Show resolved Hide resolved
cmd/auth/login.go Outdated Show resolved Hide resolved
libs/auth/oauth.go Outdated Show resolved Hide resolved
@shreyas-goenka
Copy link
Contributor Author

shreyas-goenka commented Jul 5, 2024

Note: This PR has been on hold until I can check the UI components are robust on Mac and Windows. We use a new feature of prompt UI here that we did not use before. Not urgent so I'll resume this once I get the chance.

@shreyas-goenka shreyas-goenka changed the title Improvements to auth login command Fix host and account-id resolution order in auth login Aug 13, 2024
@shreyas-goenka
Copy link
Contributor Author

Note: I have removed the changes related to using prompt.Validate components from promptui since the library can sometimes be glitchy and I don't want to validate the UI right now. Evenually we will figure out a std library for all our prompting needs.

Copy link
Contributor

@pietern pietern left a comment

Choose a reason for hiding this comment

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

Thanks, looks good.

Adding @mgyucht for review as well.

cmd/auth/auth.go Outdated Show resolved Hide resolved
cmd/auth/auth.go Outdated Show resolved Hide resolved
cmd/auth/login.go Show resolved Hide resolved
cmd/auth/login.go Outdated Show resolved Hide resolved
cmd/auth/login.go Show resolved Hide resolved
@pietern pietern requested review from mgyucht and removed request for mgyucht August 13, 2024 18:38
@pietern pietern changed the title Fix host and account-id resolution order in auth login Fix host and account ID resolution order in auth login Aug 13, 2024
Copy link
Contributor

@pietern pietern left a comment

Choose a reason for hiding this comment

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

How does this change the account ID resolution order though?

I can only see a change in host resolution order.

@shreyas-goenka shreyas-goenka changed the title Fix host and account ID resolution order in auth login Fix host resolution order in auth login Aug 14, 2024
@shreyas-goenka
Copy link
Contributor Author

shreyas-goenka commented Aug 14, 2024

@pietern Yeah, you are right. There are no changes to the account-id resolution order. I updated the PR description and title.

@shreyas-goenka shreyas-goenka added this pull request to the merge queue Aug 14, 2024
Merged via the queue into main with commit 1225fc0 Aug 14, 2024
5 checks passed
@shreyas-goenka shreyas-goenka deleted the fix/auth-login-host branch August 14, 2024 13:09
andrewnester added a commit that referenced this pull request Aug 15, 2024
CLI:
 * Add command line autocomplete to the fs commands ([#1622](#1622)).
 * Add trailing slash to directory to produce completions for ([#1666](#1666)).
 * Fix ability to import the CLI repository as module ([#1671](#1671)).
 * Fix host resolution order in `auth login` ([#1370](#1370)).
 * Print text logs in `import-dir` and `export-dir` commands ([#1682](#1682)).

Bundles:
 * Expand and upload local wheel libraries for all task types ([#1649](#1649)).
 * Clarify file format required for the `config-file` flag in `bundle init` ([#1651](#1651)).
 * Fixed incorrectly cleaning up python wheel dist folder ([#1656](#1656)).
 * Merge job parameters based on their name ([#1659](#1659)).
 * Fix glob expansion after running a generic build command ([#1662](#1662)).
 * Upload local libraries even if they don't have artifact defined ([#1664](#1664)).

Internal:
 * Fix python wheel task integration tests ([#1648](#1648)).
 * Skip pushing Terraform state after destroy ([#1667](#1667)).
 * Enable Spark JAR task test ([#1658](#1658)).
 * Run Spark JAR task test on multiple DBR versions ([#1665](#1665)).
 * Stop tracking file path locations in bundle resources ([#1673](#1673)).
 * Update VS Code settings to match latest value from IDE plugin ([#1677](#1677)).
 * Use `service.NamedIdMap` to make lookup generation deterministic ([#1678](#1678)).
 * [Internal] Remove dependency to the `openapi` package of the Go SDK ([#1676](#1676)).
 * Upgrade TF provider to 1.50.0 ([#1681](#1681)).
 * Upgrade Go SDK to 0.44.0 ([#1679](#1679)).

API Changes:
 * Changed `databricks account budgets create` command . New request type is .
 * Changed `databricks account budgets create` command to return .
 * Changed `databricks account budgets delete` command . New request type is .
 * Changed `databricks account budgets delete` command to return .
 * Changed `databricks account budgets get` command . New request type is .
 * Changed `databricks account budgets get` command to return .
 * Changed `databricks account budgets list` command to require request of .
 * Changed `databricks account budgets list` command to return .
 * Changed `databricks account budgets update` command . New request type is .
 * Changed `databricks account budgets update` command to return .
 * Added `databricks account usage-dashboards` command group.
 * Changed `databricks model-versions get` command to return .
 * Changed `databricks cluster-policies create` command with new required argument order.
 * Changed `databricks cluster-policies edit` command with new required argument order.
 * Added `databricks clusters update` command.
 * Added `databricks genie` command group.
 * Changed `databricks permission-migration migrate-permissions` command . New request type is .
 * Changed `databricks permission-migration migrate-permissions` command to return .
 * Changed `databricks account workspace-assignment delete` command to return .
 * Changed `databricks account workspace-assignment update` command with new required argument order.
 * Changed `databricks account custom-app-integration create` command with new required argument order.
 * Changed `databricks account custom-app-integration list` command to require request of .
 * Changed `databricks account published-app-integration list` command to require request of .
 * Removed `databricks apps` command group.
 * Added `databricks notification-destinations` command group.
 * Changed `databricks shares list` command to require request of .
 * Changed `databricks alerts create` command . New request type is .
 * Changed `databricks alerts delete` command . New request type is .
 * Changed `databricks alerts delete` command to return .
 * Changed `databricks alerts get` command with new required argument order.
 * Changed `databricks alerts list` command to require request of .
 * Changed `databricks alerts list` command to return .
 * Changed `databricks alerts update` command . New request type is .
 * Changed `databricks alerts update` command to return .
 * Changed `databricks queries create` command . New request type is .
 * Changed `databricks queries delete` command . New request type is .
 * Changed `databricks queries delete` command to return .
 * Changed `databricks queries get` command with new required argument order.
 * Changed `databricks queries list` command to return .
 * Removed `databricks queries restore` command.
 * Changed `databricks queries update` command . New request type is .
 * Added `databricks queries list-visualizations` command.
 * Changed `databricks query-visualizations create` command . New request type is .
 * Changed `databricks query-visualizations delete` command . New request type is .
 * Changed `databricks query-visualizations delete` command to return .
 * Changed `databricks query-visualizations update` command . New request type is .
 * Changed `databricks statement-execution execute-statement` command to return .
 * Changed `databricks statement-execution get-statement` command to return .
 * Added `databricks alerts-legacy` command group.
 * Added `databricks queries-legacy` command group.
 * Added `databricks query-visualizations-legacy` command group.

OpenAPI commit f98c07f9c71f579de65d2587bb0292f83d10e55d (2024-08-12)
Dependency updates:
 * Bump github.com/hashicorp/hc-install from 0.7.0 to 0.8.0 ([#1652](#1652)).
 * Bump golang.org/x/sync from 0.7.0 to 0.8.0 ([#1655](#1655)).
 * Bump golang.org/x/mod from 0.19.0 to 0.20.0 ([#1654](#1654)).
 * Bump golang.org/x/oauth2 from 0.21.0 to 0.22.0 ([#1653](#1653)).
 * Bump golang.org/x/text from 0.16.0 to 0.17.0 ([#1670](#1670)).
 * Bump golang.org/x/term from 0.22.0 to 0.23.0 ([#1669](#1669)).
github-merge-queue bot pushed a commit that referenced this pull request Aug 19, 2024
CLI:
* Add command line autocomplete to the fs commands
([#1622](#1622)).
* Add trailing slash to directory to produce completions for
([#1666](#1666)).
* Fix ability to import the CLI repository as module
([#1671](#1671)).
* Fix host resolution order in `auth login`
([#1370](#1370)).
* Print text logs in `import-dir` and `export-dir` commands
([#1682](#1682)).

Bundles:
* Expand and upload local wheel libraries for all task types
([#1649](#1649)).
* Clarify file format required for the `config-file` flag in `bundle
init` ([#1651](#1651)).
* Fixed incorrectly cleaning up python wheel dist folder
([#1656](#1656)).
* Merge job parameters based on their name
([#1659](#1659)).
* Fix glob expansion after running a generic build command
([#1662](#1662)).
* Upload local libraries even if they don't have artifact defined
([#1664](#1664)).

Internal:
* Fix python wheel task integration tests
([#1648](#1648)).
* Skip pushing Terraform state after destroy
([#1667](#1667)).
* Enable Spark JAR task test
([#1658](#1658)).
* Run Spark JAR task test on multiple DBR versions
([#1665](#1665)).
* Stop tracking file path locations in bundle resources
([#1673](#1673)).
* Update VS Code settings to match latest value from IDE plugin
([#1677](#1677)).
* Use `service.NamedIdMap` to make lookup generation deterministic
([#1678](#1678)).
* [Internal] Remove dependency to the `openapi` package of the Go SDK
([#1676](#1676)).
* Upgrade TF provider to 1.50.0
([#1681](#1681)).
* Upgrade Go SDK to 0.44.0
([#1679](#1679)).

API Changes:
* Changed `databricks account budgets create` command . New request type
is .
 * Changed `databricks account budgets create` command to return .
* Changed `databricks account budgets delete` command . New request type
is .
 * Changed `databricks account budgets delete` command to return .
* Changed `databricks account budgets get` command . New request type is
.
 * Changed `databricks account budgets get` command to return .
* Changed `databricks account budgets list` command to require request
of .
 * Changed `databricks account budgets list` command to return .
* Changed `databricks account budgets update` command . New request type
is .
 * Changed `databricks account budgets update` command to return .
 * Added `databricks account usage-dashboards` command group.
 * Changed `databricks model-versions get` command to return .
* Changed `databricks cluster-policies create` command with new required
argument order.
* Changed `databricks cluster-policies edit` command with new required
argument order.
 * Added `databricks clusters update` command.
 * Added `databricks genie` command group.
* Changed `databricks permission-migration migrate-permissions` command
. New request type is .
* Changed `databricks permission-migration migrate-permissions` command
to return .
* Changed `databricks account workspace-assignment delete` command to
return .
* Changed `databricks account workspace-assignment update` command with
new required argument order.
* Changed `databricks account custom-app-integration create` command
with new required argument order.
* Changed `databricks account custom-app-integration list` command to
require request of .
* Changed `databricks account published-app-integration list` command to
require request of .
 * Removed `databricks apps` command group.
 * Added `databricks notification-destinations` command group.
 * Changed `databricks shares list` command to require request of .
 * Changed `databricks alerts create` command . New request type is .
 * Changed `databricks alerts delete` command . New request type is .
 * Changed `databricks alerts delete` command to return .
* Changed `databricks alerts get` command with new required argument
order.
 * Changed `databricks alerts list` command to require request of .
 * Changed `databricks alerts list` command to return .
 * Changed `databricks alerts update` command . New request type is .
 * Changed `databricks alerts update` command to return .
 * Changed `databricks queries create` command . New request type is .
 * Changed `databricks queries delete` command . New request type is .
 * Changed `databricks queries delete` command to return .
* Changed `databricks queries get` command with new required argument
order.
 * Changed `databricks queries list` command to return .
 * Removed `databricks queries restore` command.
 * Changed `databricks queries update` command . New request type is .
 * Added `databricks queries list-visualizations` command.
* Changed `databricks query-visualizations create` command . New request
type is .
* Changed `databricks query-visualizations delete` command . New request
type is .
 * Changed `databricks query-visualizations delete` command to return .
* Changed `databricks query-visualizations update` command . New request
type is .
* Changed `databricks statement-execution execute-statement` command to
return .
* Changed `databricks statement-execution get-statement` command to
return .
 * Added `databricks alerts-legacy` command group.
 * Added `databricks queries-legacy` command group.
 * Added `databricks query-visualizations-legacy` command group.

OpenAPI commit f98c07f9c71f579de65d2587bb0292f83d10e55d (2024-08-12)
Dependency updates:
* Bump github.com/hashicorp/hc-install from 0.7.0 to 0.8.0
([#1652](#1652)).
* Bump golang.org/x/sync from 0.7.0 to 0.8.0
([#1655](#1655)).
* Bump golang.org/x/mod from 0.19.0 to 0.20.0
([#1654](#1654)).
* Bump golang.org/x/oauth2 from 0.21.0 to 0.22.0
([#1653](#1653)).
* Bump golang.org/x/text from 0.16.0 to 0.17.0
([#1670](#1670)).
* Bump golang.org/x/term from 0.22.0 to 0.23.0
([#1669](#1669)).
github-merge-queue bot pushed a commit that referenced this pull request Sep 4, 2024
## Changes
With #1370 we started to error if
a profile name was not provided in a non-tty setting. The Databricks
VSCode extension, however, uses the `auth login` command to simply
refresh the tokens. Thus, this PR is a regression fix for that use case.

## Tests
Manually, `databricks auth login --host
https://e2-dogfood.staging.cloud.databricks.com` no longer errors.
Instead it successfully refreshes the credentials.
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.

3 participants