Add `buf registry whoami` command #3416

doriable · 2024-10-22T21:53:56Z

This adds a buf registry whoami command, which checks if you
are logged in to the Buf Schema Registry at a given domain. The domain
defaults buf.build if none is provided.

Fixes #3414

github-actions · 2024-10-22T21:54:14Z

The latest Buf updates on your PR. Results from workflow Buf CI / buf (pull_request).

Build	Format	Lint	Breaking	Updated (UTC)
`✅ passed`	`✅ passed`	`✅ passed`	`✅ passed`	Oct 24, 2024, 4:47 PM

doriable · 2024-10-22T21:54:50Z

CHANGELOG.md

@@ -2,7 +2,8 @@

 ## [Unreleased]

- No changes yet.
+- Add `buf beta registry whoami` command, which checks if you are logged in to the Buf Schema


Should we have this start as a beta command and then promote?

Moved this out of beta and directly to buf registry whoami.

doriable · 2024-10-22T21:58:09Z

private/buf/cmd/buf/command/beta/registry/whoami/whoami.go

+		if connectErr := new(connect.Error); errors.As(err, &connectErr) && connectErr.Code() == connect.CodeUnauthenticated {
+			return fmt.Errorf("Not currently logged in for %s", remote)
+		}


Checking for the unauthenticated error code here and returning this error, we get the following output:

$ buf beta registry whoami Failure: Not currently logged in for buf.build

If we do not check, and simply return what the error wrapper gives us, we get:

$ buf beta registry whoami Failure: you are not authenticated for buf.build. Set the BUF_TOKEN environment variable or run "buf registry login", using a Buf API token as the password. For details, visit https://buf.build/docs/bsr/authentication

Both clearly indicate to the user they are unauthenticated, so they both seem fine to me, it just depends on what we want the UX to be.

doriable · 2024-10-22T22:02:10Z

private/buf/cmd/buf/command/beta/registry/whoami/whoami.go

+		if connectErr := new(connect.Error); errors.As(err, &connectErr) && connectErr.Code() == connect.CodeUnauthenticated {
+			return fmt.Errorf("Not currently logged in for %s", remote)
+		}
+		return err


Right now, we aren't really differentiating between unauthenticated vs. other error states, everything exits 1 unless authenticated (which exits 0).

The error message will indicate the nature of the error, for example, in the case of an invalid remote:

$ buf beta registry whoami fake.address Failure: the server hosted at that remote is unavailable. Are you sure "fake.address" is a valid remote address?

But we do not do any special handling for the errors.

emcfarlane · 2024-10-22T22:27:00Z

private/buf/cmd/buf/command/beta/registry/whoami/whoami.go

+type flags struct{}
+
+func newFlags() *flags {
+	return &flags{}


What do you think about a --format=json for accessing the username?

I like this! I can add this.

Added --format=json (and --format=text will print the "logged in as" statement as before).

bufdev

Probably good to go

bufdev · 2024-10-23T18:12:05Z

private/buf/bufprint/bufprint.go

@@ -248,6 +248,14 @@ func NewOrganizationEntity(organization *ownerv1.Organization, remote string) En
 	}
 }

+func NewUserEntity(user *registryv1alpha1.User) Entity {


bufdev · 2024-10-23T18:12:17Z

private/buf/cmd/buf/command/registry/whoami/whoami.go

+	formatFlagName = "format"
+)
+
+func NewCommand(


bufdev · 2024-10-23T18:12:57Z

private/buf/cmd/buf/command/registry/whoami/whoami.go

+	}
+	user := currentUserResponse.Msg.User
+	if user == nil {
+		return errors.New("No user found for provided token")


What am I supposed to do with this as a user? What provided token? Where did the provided token come from? This error message doesn't help me much.

This mirrors the error that is returned from buf registry login when we check the token:

buf/private/buf/cmd/buf/command/registry/registrylogin/registrylogin.go

Lines 212 to 214 in 81698bb

if user == nil {

return errors.New("no user found for provided token")

}

We can prompt the user to get a new token using buf registry login. If that makes sense, then I can update the error message on both sides.

I didn't provide a token though. Like as a user, this command does not accept a token, so it doesn't make sense to tell the user that their provided token didn't result in a user.

I get that this is the error message for the other one, but this just means both need to be updated, and should in no way reference tokens, as the user does not interact with tokens (typically) via either this command of buf registry login.

That is fair -- I left the buf registry login error as-is, since it's part of a validation flow where the token is provided through the command. For this one, I provided instructions to the user to refresh their credentials and to check the env var if set.

That doesn't make sense to me - the error message is just as confusing for buf registry login.

bufdev · 2024-10-23T18:13:19Z

Adjust the title and description

bufdev · 2024-10-24T14:57:06Z

private/buf/cmd/buf/command/registry/whoami/whoami.go

+	user := currentUserResponse.Msg.User
+	if user == nil {
+		return fmt.Errorf(
+			`No valid user found for login credentials. Run %q to refresh your credentials. If you have %s environment variable set, ensure that the token is valid.`,


"If you have BUF_TOKEN environment variable set" isn't proper english, I believe you mean "If you have the BUF_TOKEN environment variable set".

"Run 'buf registry login' to refresh your credentials" isn't correct. If someone runs "buf registry whoami acme.buf.dev", they should be instructed to run "buf registry login acme.buf.dev".

Change "No valid user found for login credentials" to "No user is logged in to %s", with the hostname being put in there.

Errors are now reported as:

$ buf registry whoami Failure: No user is logged in to buf.build. Run "buf registry login" to refresh your credentials. If you have the BUF_TOKEN environment variable set, ensure that the token is valid. exit status 1 $ buf registry whoami bufbuild.internal Failure: No user is logged in to bufbuild.internal. Run "buf registry login bufbuild.internal" to refresh your credentials. If you have the BUF_TOKEN environment variable set, ensure that the token is valid. exit status 1

doriable added 2 commits October 22, 2024 17:47

Add buf beta registry whoami command

00a1b80

Add changelog

800e723

doriable commented Oct 22, 2024

View reviewed changes

doriable requested review from bufdev and emcfarlane October 22, 2024 22:02

doriable marked this pull request as ready for review October 22, 2024 22:03

emcfarlane approved these changes Oct 22, 2024

View reviewed changes

bufdev reviewed Oct 23, 2024

View reviewed changes

doriable added 2 commits October 23, 2024 12:15

Merge remote-tracking branch 'origin/main' into 3414-buf-registry-whoami

137df84

Address comments

d13cfcb

doriable requested review from emcfarlane and bufdev October 23, 2024 18:11

bufdev reviewed Oct 23, 2024

View reviewed changes

doriable changed the title ~~Add buf beta registry whoami command~~ Add buf registry whoami command Oct 23, 2024

doriable added 5 commits October 23, 2024 14:19

Add godocs

2872b32

Merge remote-tracking branch 'origin/main' into 3414-buf-registry-whoami

c5c4e72

Return instructions for users to refresh their credentials.

ef73b4a

Slight wording change

e7dc6d8

Merge remote-tracking branch 'origin/main' into 3414-buf-registry-whoami

32dda66

bufdev reviewed Oct 24, 2024

View reviewed changes

Fix error message on invalid users

ae4bee4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `buf registry whoami` command #3416

Add `buf registry whoami` command #3416

doriable commented Oct 22, 2024 •

edited

Loading

github-actions bot commented Oct 22, 2024 •

edited

Loading

doriable Oct 22, 2024

bufdev Oct 23, 2024

doriable Oct 23, 2024

doriable Oct 22, 2024

doriable Oct 22, 2024

emcfarlane Oct 22, 2024

doriable Oct 22, 2024

doriable Oct 23, 2024

bufdev left a comment

bufdev Oct 23, 2024

bufdev Oct 23, 2024

bufdev Oct 23, 2024

doriable Oct 23, 2024

bufdev Oct 23, 2024

doriable Oct 23, 2024

bufdev Oct 24, 2024

bufdev commented Oct 23, 2024

bufdev Oct 24, 2024 •

edited

Loading

emcfarlane Oct 24, 2024

	if user == nil {
	return errors.New("no user found for provided token")
	}

Add buf registry whoami command #3416

Are you sure you want to change the base?

Add buf registry whoami command #3416

Conversation

doriable commented Oct 22, 2024 • edited Loading

github-actions bot commented Oct 22, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bufdev left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bufdev commented Oct 23, 2024

bufdev Oct 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Add `buf registry whoami` command #3416

Add `buf registry whoami` command #3416

doriable commented Oct 22, 2024 •

edited

Loading

github-actions bot commented Oct 22, 2024 •

edited

Loading

bufdev Oct 24, 2024 •

edited

Loading