Summary

Nicely print the web login URL when authenticating rbt post.

Review Request #14600 — Created Sept. 8, 2025 and submitted Dec. 9, 2025, 10:04 p.m.

Information

Owner

maubin

Repository

RBTools

Branch

release-5.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

In rbt post, a progress bar for commit validation starts up before we

know whether the client is authenticated or not. While the progress bar

is active, we'll prompt for auth credentials. When we prompt for web

login authentication, the "Please log in to the Review Board ..." line

gets printed onto the same line as the progress bar, since the cursor is

set by the bar who is not expected to deal with any external input/output.

When we prompt for username/password authentication, the line

gets printed onto the next line because we write a new line to STDOUT

before prompting for the credentials.
This change makes the web login logs prettier by checking if a progress

bar is active and then logging a new line if so for the web-login flow.

We are using an internal attribute to check if a bar is active, since I

couldn't find any public API for this. This should be fine for our

purposes, if anything changes with that attribute then we'll just get the

ugly printing again.

Testing Done

Made sure things looked nice when using rbt post and other commands
(rbt login, rbt status) when passing --web-login and when using
username and password prompting.

Commits

Summary	ID
Nicely print the web login URL when authenticating rbt post. In rbt post, a progress bar for commit validation starts up before we know whether the client is authenticated or not. While the progress bar is active, we'll prompt for auth credentials. When we prompt for web login authentication, for some reason the "Please log in to the Review Board ..." line gets printed onto the same line as the progress bar. However when we prompt for username/password authentication, the line gets printed onto the next line (as it should). I couldn't exactly figure out why these two differed, but this fixes that issue by checking if a progress bar is active and then logging a new line if so for the web-login flow. We are using an internal attribute to check if a bar is active, since I couldn't find any public API for this. This should be fine for our purposes, if anything changes with that attribute then we'll just get the ugly printing again.	bcbdd77bce4fac78a85eac5e32415cff9783b3a6

Summary

Nicely print the web login URL when authenticating rbt post.

In rbt post, a progress bar for commit validation starts up before we know whether the client is authenticated or not. While the progress bar is active, we'll prompt for auth credentials. When we prompt for web login authentication, for some reason the "Please log in to the Review Board ..." line gets printed onto the same line as the progress bar. However when we prompt for username/password authentication, the line gets printed onto the next line (as it should). I couldn't exactly figure out why these two differed, but this fixes that issue by checking if a progress bar is active and then logging a new line if so for the web-login flow. We are using an internal attribute to check if a bar is active, since I couldn't find any public API for this. This should be fine for our purposes, if anything changes with that attribute then we'll just get the ugly printing again.

bcbdd77bce4fac78a85eac5e32415cff9783b3a6

Issues

Description	From	Last Updated
The reason that's happened is most likely due to the following conditions: The progress bar is keeping the cursor position …	chipx86	Sept. 14, 2025, 4:56 p.m.
Can we import at the top of the module, or does it need to be here?	chipx86	Sept. 18, 2025, 3:06 a.m.
Seems like we could just import this as tqdm without the underscore.	david	Sept. 22, 2025, 11:18 p.m.
I realize I don't even need to do this weird import, I'll just import tqdm like we normally do.	maubin	Sept. 23, 2025, 12:01 a.m.

flake8 passed.

JSHint passed.

The issue has been dropped. Show all issues

The reason that's happened is most likely due to the following conditions:

The progress bar is keeping the cursor position set within the bar, for the next chunk, expecting to own all input/output.
The "Please log in" is a standard print, so it starts at the cursor position.
The prompt is more special. I believe it takes care to ensure it's on its own line, and uses hints to notify the terminal that input is to be provided for this. It can use readline to handle this, which is likely what's managing that.

maubin Sept. 18, 2025, 3:07 a.m.

Ohh woops I was getting my code paths mixed up and wasn't looking in BaseCommand.credentials_prompt, I was just looking in the standalone credentials_prompt function. BaseCommand.credentials_prompt does do a self.stdout.new_line().

rbtools/utils/web_login.py (Diff revision 1)

The issue has been resolved. Show all issues

Can we import at the top of the module, or does it need to be here?

maubin Sept. 18, 2025, 3:07 a.m.

It doesn't need to be here, it just seemed more appropriate to have the import contained to this function since its only used here. I can move it though.

Description:

		In rbt post, a progress bar for commit validation starts up before we
		know whether the client is authenticated or not. While the progress bar
		is active, we'll prompt for auth credentials. When we prompt for web
~		login authentication, for some reason the "Please log in to the Review
~		Board ..." line gets printed onto the same line as the progress bar.
~		However when we prompt for username/password authentication, the line
~		gets printed onto the next line (as it should). I couldn't exactly
~		figure out why these two differed, but this fixes that issue by checking
~		if a progress bar is active and then logging a new line if so for the
~		web-login flow. We are using an internal attribute to check if a bar is
~		active, since I couldn't find any public API for this. This should be
~		fine for our purposes, if anything changes with that attribute then
~		we'll just get the ugly printing again.
	~	login authentication, the "Please log in to the Review Board ..." line
	~	gets printed onto the same line as the progress bar, since the cursor is
	~	set by the bar who is not expected to deal with any external input/output.
	~	When we prompt for username/password authentication, the line
	~	gets printed onto the next line because we write a new line to STDOUT
	~	before prompting for the credentials.
	~
	~	This change makes the web login logs prettier by checking if a progress
	~	bar is active and then logging a new line if so for the web-login flow.
	~	We are using an internal attribute to check if a bar is active, since I
	+	couldn't find any public API for this. This should be fine for our
	+	purposes, if anything changes with that attribute then we'll just get the
	+	ugly printing again.

Commits:

	Summary	ID
	Nicely print the web login URL when authenticating rbt post. In rbt post, a progress bar for commit validation starts up before we know whether the client is authenticated or not. While the progress bar is active, we'll prompt for auth credentials. When we prompt for web login authentication, for some reason the "Please log in to the Review Board ..." line gets printed onto the same line as the progress bar. However when we prompt for username/password authentication, the line gets printed onto the next line (as it should). I couldn't exactly figure out why these two differed, but this fixes that issue by checking if a progress bar is active and then logging a new line if so for the web-login flow. We are using an internal attribute to check if a bar is active, since I couldn't find any public API for this. This should be fine for our purposes, if anything changes with that attribute then we'll just get the ugly printing again.	1238f0ad60cf67b83a7ed4fa4355a5ce5fb77a10
	Nicely print the web login URL when authenticating rbt post. In rbt post, a progress bar for commit validation starts up before we know whether the client is authenticated or not. While the progress bar is active, we'll prompt for auth credentials. When we prompt for web login authentication, for some reason the "Please log in to the Review Board ..." line gets printed onto the same line as the progress bar. However when we prompt for username/password authentication, the line gets printed onto the next line (as it should). I couldn't exactly figure out why these two differed, but this fixes that issue by checking if a progress bar is active and then logging a new line if so for the web-login flow. We are using an internal attribute to check if a bar is active, since I couldn't find any public API for this. This should be fine for our purposes, if anything changes with that attribute then we'll just get the ugly printing again.	62194eab65c4f4027b1789d6cb42f1fab545fce6

Diff:

Revision 2 (+14)

Show changes

rbtools/utils/web_login.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

rbtools/utils/web_login.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Seems like we could just import this as tqdm without the underscore.
```

Change Summary:

Have a better tqdm import.

Commits:

	Summary	ID
	Nicely print the web login URL when authenticating rbt post. In rbt post, a progress bar for commit validation starts up before we know whether the client is authenticated or not. While the progress bar is active, we'll prompt for auth credentials. When we prompt for web login authentication, for some reason the "Please log in to the Review Board ..." line gets printed onto the same line as the progress bar. However when we prompt for username/password authentication, the line gets printed onto the next line (as it should). I couldn't exactly figure out why these two differed, but this fixes that issue by checking if a progress bar is active and then logging a new line if so for the web-login flow. We are using an internal attribute to check if a bar is active, since I couldn't find any public API for this. This should be fine for our purposes, if anything changes with that attribute then we'll just get the ugly printing again.	62194eab65c4f4027b1789d6cb42f1fab545fce6
	Nicely print the web login URL when authenticating rbt post. In rbt post, a progress bar for commit validation starts up before we know whether the client is authenticated or not. While the progress bar is active, we'll prompt for auth credentials. When we prompt for web login authentication, for some reason the "Please log in to the Review Board ..." line gets printed onto the same line as the progress bar. However when we prompt for username/password authentication, the line gets printed onto the next line (as it should). I couldn't exactly figure out why these two differed, but this fixes that issue by checking if a progress bar is active and then logging a new line if so for the web-login flow. We are using an internal attribute to check if a bar is active, since I couldn't find any public API for this. This should be fine for our purposes, if anything changes with that attribute then we'll just get the ugly printing again.	bcbdd77bce4fac78a85eac5e32415cff9783b3a6

Diff:

Revision 3 (+14)

Show changes

rbtools/utils/web_login.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

rbtools/utils/web_login.py (Diff revision 2)

The issue has been dropped. Show all issues

I realize I don't even need to do this weird import, I'll just import tqdm like we normally do.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-5.x (79bc7bd)