Drop support for user & pass login #3835

joanlopez · 2024-07-09T13:19:02Z

What?

Drop k6 Cloud login support for email and password login: this includes the interactive cli triggered when running k6 cloud login, it should instead request your API token.

Add warning about when it will be removed (v0.55)

Why?

Checklist

I have performed a self-review of my code.
I have added tests for my changes.
I have run linter locally (make lint) and all checks pass.
I have run tests locally (make tests) and all tests pass.
I have commented on my code, particularly in hard-to-understand areas.

Related PR(s)/Issue(s)

Important notice: this commit declare a cobra sub-command holding the logic for the `k6 cloud run` sub-command, but does not register it. In this commit, we duplicate the logic from the existing `k6 cloud` logic, with very little adjustments, to support the later registry of the `k6 cloud run` command. To simplify the collaboration on this and further reviews, we delegate any refactoring of the original cloud command's logic, to a further commit or Pull Request.

Important notice: this commit declare a cobra sub-command holding the logic for the `k6 cloud login` sub-command, but does not register it. In this commit, we duplicate the logic from the existing `k6 login` logic, with very little adjustments, to support the later registry of the `k6 cloud login` command. To simplify the collaboration on this and further reviews, we delegate any refactoring of the original cloud command's logic, to a further commit or Pull Request. This new `k6 cloud login` command is notably focusing solely on authenticating with the Grafana Cloud k6, and by design does not aim to support InfluxDB authentication.

joanlopez · 2024-07-09T13:27:21Z

cmd/cloud_login.go

@@ -30,7 +28,7 @@ func getCmdCloudLogin(gs *state.GlobalState) *cobra.Command {

 	// loginCloudCommand represents the 'cloud login' command
 	exampleText := getExampleText(gs, `
-  # Log in with an email/password.
+  # Prompt for a k6 Cloud token.


Should we keep both: prompting for a token when running k6 cloud login and -t [TOKEN]?

It sounds a bit redundant, and as we're planning to ship it in v1.0, I think it deserves some care in terms of carefully thinking of its implications.

Some thoughts:

In favor of k6 cloud login:

Default behavior, user friendly walkthrough (although it could be replaced with a decent help)

Doesn't fully (only partially) break the currently existing, interactive, behavior.

In favor of -t [TOKEN]:

Friendlier for CLI environments (less interactivity is required)

More flexible for future auth mechanisms (extensibility after v1.0)

cc/ @oleiade @dgzlopes

I would like to invest time in improving the interactive flow in the future (e.g., picking the default stack, using a magic link to the browser to authenticate). But yeah, I have no strong opinions on what we should do with it as of today... But it is true that if it is only to pass the token, it feels a bit redundant.

Then, I'd probably vote to keep both but generally recommend the use of -t, I guess 🤔

Sorry for the delay, I agree, we should keep both: prompt for the token, and support -t 👍🏻

joanlopez · 2024-07-09T13:31:09Z

cmd/cloud_login.go

@@ -79,18 +77,6 @@ func (c *cmdCloudLogin) run(cmd *cobra.Command, _ []string) error {
 		}
 	}

-	// We want to use this fully consolidated config for things like
-	// host addresses, so users can overwrite them with env vars.
-	consolidatedCurrentConfig, warn, err := cloudapi.GetConsolidatedConfig(


The consolidated config was used to initialize the cloudapi.Client, no longer needed.

joanlopez · 2024-07-09T13:36:29Z

cmd/cloud_login.go

-			consolidatedCurrentConfig.Timeout.TimeDuration())
-
-		var res *cloudapi.LoginResponse
-		res, err = client.Login(email, password)


I think that would be nice to have a similar method but to check the correctness of the given token.
Like a health endpoint, but with authentication. Wdyt? cc/ @oleiade @dgzlopes

PS: I think that's not supported yet, but would require some changes in Backend.

I agree! It would be nice to validate the token.

Can we do this by just trying to call one of the authenticated APIs? But yeah, a dedicated endpoint maybe would be better. I think you should involve someone from backend 👀

We discussed internally it with the Backend team, and they'll add support for the /login endpoint to also accept a token for auth (as an alternative for now, to keep backwards compatible; and as the unique method supported in the future).

However, as that will take some time, I guess we can move forward with this PR and add that in the next iteration (I'll create an issue to do not forget).

@joanlopez Can you expand a bit on the reason for having it, please? What is the user journey that we expect here, and what are the benefits?

Sure @codebien! The purpose of such check would be to make the resulting user experience better.

Now, when the user logs in with email & password, they get immediate feedback whether those credentials were correct or not, and the token saved is always valid, as it is returned by the API.

However, after these changes, the user won't log in, but would just set a token. So, if we don't add an extra check to verify whether the token is valid or not, the user won't receive such feedback until they try to run another command. While, in my opinion, would be much better to give them the feedback of whether the token was valid or not at time of running k6 cloud login.

Does that sound good to you? Do you have any other suggestion?

Thanks! 🙇🏻

Gotcha, that sounds good and valuable to me! 🎉

I would argue that this was the behaviour before for -t on the cli.

I am not against both that and this to do some checks, but I would not block this PR on endpoint to check this.

I would argue that this was the behaviour before for -t on the cli.

Yeah, that was my initial thought, but having being like this doesn't mean we cannot improve the user experience, imo. Plus, the use of token was arguably an alternative for the main login flow with standard credentials (although I know that in practice that's no longer the case), but now it will become the main (and unique?), and so I think there's more reason to keep the main login flow with a good user experience, as it used to be the case for email and password.

I am not against both that and this to do some checks, but I would not block this PR on endpoint to check this.

Yeah, I agree! That's why said above:

However, as that will take some time, I guess we can move forward with this PR and add that in the next iteration (I'll create an issue to do not forget).

codebien · 2024-08-01T11:56:52Z

cmd/cloud_login.go

+			Banner: "Enter your token to authenticate with k6 Cloud.\n" +
+				"Please, consult the k6 Cloud documentation for instructions on how to generate one:\n" +
+				"https://grafana.com/docs/grafana-cloud/testing/k6/author-run/tokens-and-cli-authentication",


Should we link directly to the Grafana app page where the token is?

joanlopez · 2024-08-05T09:02:14Z

Closing in favor of #3886

oleiade and others added 7 commits June 26, 2024 14:20

Register run and login subcommands of the cloud command

7ec4090

Add deprecation warning to k6 login and k6 login cloud commands

7923b62

FIXME add tests assert k6 cloud run command's arguments handling

1468a97

Merge remote-tracking branch 'upstream/master' into cloud_subcommands

c325f05

Drop support for user & pass login

d849ff9

joanlopez added cloud documentation-needed A PR which will need a separate PR for documentation labels Jul 9, 2024

joanlopez requested a review from oleiade July 9, 2024 13:19

joanlopez self-assigned this Jul 9, 2024

joanlopez requested a review from a team as a code owner July 9, 2024 13:19

joanlopez requested review from olegbespalov and removed request for a team July 9, 2024 13:19

joanlopez commented Jul 9, 2024

View reviewed changes

Add banner with instructions link

0404171

oleiade force-pushed the cloud_subcommands branch 2 times, most recently from aad9c76 to 2b0bc1f Compare July 23, 2024 15:47

Base automatically changed from cloud_subcommands to master July 24, 2024 10:53

joanlopez mentioned this pull request Jul 30, 2024

Release v0.53.0 #3872

Merged

5 tasks

joanlopez added this to the v0.55.0 milestone Aug 1, 2024

joanlopez mentioned this pull request Aug 1, 2024

Deprecation notice for email & password login (k6 cloud login) #3879

Closed

5 tasks

codebien reviewed Aug 1, 2024

View reviewed changes

joanlopez modified the milestones: v0.55.0, v0.53.0 Aug 5, 2024

joanlopez mentioned this pull request Aug 5, 2024

Drop support for log in with email & password in the new k6 cloud login #3886

Merged

5 tasks

joanlopez closed this Aug 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Drop support for user & pass login #3835

Drop support for user & pass login #3835

joanlopez commented Jul 9, 2024 •

edited

Loading

joanlopez Jul 9, 2024 •

edited

Loading

dgzlopes Jul 10, 2024 •

edited

Loading

joanlopez Jul 11, 2024

oleiade Aug 1, 2024

joanlopez Jul 9, 2024

joanlopez Jul 9, 2024

dgzlopes Jul 10, 2024

joanlopez Jul 11, 2024 •

edited

Loading

codebien Jul 11, 2024

joanlopez Jul 11, 2024

codebien Jul 11, 2024 •

edited

Loading

mstoykov Jul 11, 2024

joanlopez Jul 11, 2024

codebien Aug 1, 2024

joanlopez commented Aug 5, 2024

Drop support for user & pass login #3835

Drop support for user & pass login #3835

Conversation

joanlopez commented Jul 9, 2024 • edited Loading

What?

Why?

Checklist

Related PR(s)/Issue(s)

joanlopez Jul 9, 2024 • edited Loading

Choose a reason for hiding this comment

dgzlopes Jul 10, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joanlopez Jul 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codebien Jul 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joanlopez commented Aug 5, 2024

joanlopez commented Jul 9, 2024 •

edited

Loading

joanlopez Jul 9, 2024 •

edited

Loading

dgzlopes Jul 10, 2024 •

edited

Loading

joanlopez Jul 11, 2024 •

edited

Loading

codebien Jul 11, 2024 •

edited

Loading