Summary

Display the correct value for the client web login server capability and add docs.

Review Request #13693 — Created April 3, 2024 and submitted April 16, 2024, 9:28 a.m.

Information

Owner

maubin

Repository

Review Board

Branch

release-5.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

When building the client web login capability in the server info resource,
we would grab the client_web_login setting from the site configuration
but use a default value of False if the setting doesn't exist in the site
configuration. We should actually be using the default value that is set in
siteconfig.py, which is True. This change fixes that.

This change also adds documentation that explains how certain services can
authenticate to Review Board via the login page and that API tokens will be
automatically created for them. We also add docs for the automatic token
expiration setting that was added in the admin authentication page.

Testing Done


Tested rbt login to a server that didn't have a client_web_login

  setting in site config, saw that it defaulted to web-based login.
Built and viewed the docs that I added.
Ran unit tests.

Commits

Summary	ID
Display the correct value for the client web login server capability.	0b5ed02daf65aa0263cdb2109ede76971c830f39

Issues

Description	From	Last Updated
'djblets.db.fields.json_field.JSONDict' imported but unused Column: 5 Error code: F401	reviewbot	April 3, 2024, 3:34 p.m.
Can we add an assertion at the beginning of this that the key is not present in the siteconfig settings …	david	April 3, 2024, 9:51 p.m.
This says "login" three times in the space of 9 words. I'm not sure we have a real standard here, …	david	April 4, 2024, 11 a.m.
Same "login login" problem here.	david	April 4, 2024, 11:02 a.m.
pop is most useful when we want to return the value as part of it. We can instead use del …	chipx86	April 10, 2024, 8:43 a.m.
We should be able to just check against siteconfig.settings, which will be faster than checking keys().	chipx86	April 10, 2024, 8:52 a.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/accounts/tests/test_client_login_view.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'djblets.db.fields.json_field.JSONDict' imported but unused

Column: 5
Error code: F401
```

Commits:

	Summary	ID
	Display the correct value for the client web login server capability.	3441bd1aec16cdd0eeb0a1d68a15ffa949cd4082
	Display the correct value for the client web login server capability.	c0c18247b9eace5c225020429da061bdadfbb19b

Diff:

Revision 2 (+106 -2)

Show changes

	docs/manual/admin/configuration/authentication-settings.rst
	docs/manual/webapi/2.0/authenticating.rst
	reviewboard/accounts/tests/test_client_login_view.py
	reviewboard/webapi/server_info.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

reviewboard/accounts/tests/test_client_login_view.py (Diff revision 2)

The issue has been resolved. Show all issues

Can we add an assertion at the beginning of this that the key is not present in the siteconfig settings JSONField?

Change Summary:


Removed an assertEquals call because its deprecated.
Actually made sure the client login settings were removed from the site configuration

  in the unit test where we test for that.

Commits:

	Summary	ID
	Display the correct value for the client web login server capability.	c0c18247b9eace5c225020429da061bdadfbb19b
	Display the correct value for the client web login server capability.	b288a4e30824ef44e2b5b9f0de1fe6790e33f820

Diff:

Revision 3 (+124 -4)

Show changes

	docs/manual/admin/configuration/authentication-settings.rst
	docs/manual/webapi/2.0/authenticating.rst
	reviewboard/accounts/tests/test_client_login_view.py
	reviewboard/webapi/server_info.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

docs/manual/admin/configuration/authentication-settings.rst (Diff revision 3)

The issue has been resolved. Show all issues

This says "login" three times in the space of 9 words.

I'm not sure we have a real standard here, but my personal inclination is that we should use "login" as a noun/adjective, and "log in" as a verb.

So perhaps something like "... directing the user to log in via the web site. Upon successful authentication, the API token ..." ?

docs/manual/webapi/2.0/authenticating.rst (Diff revision 3)
The issue has been resolved. Show all issues
```
Same "login login" problem here.
```

Commits:

	Summary	ID
	Display the correct value for the client web login server capability.	b288a4e30824ef44e2b5b9f0de1fe6790e33f820
	Display the correct value for the client web login server capability.	5babd36546fc43551c99c189d2db2736aad24dfc

Diff:

Revision 4 (+122 -4)

Show changes

	docs/manual/admin/configuration/authentication-settings.rst
	docs/manual/webapi/2.0/authenticating.rst
	reviewboard/accounts/tests/test_client_login_view.py
	reviewboard/webapi/server_info.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

reviewboard/accounts/tests/test_client_login_view.py (Diff revision 4)

The issue has been resolved. Show all issues

pop is most useful when we want to return the value as part of it. We can instead use del siteconfig.settings[...].

reviewboard/accounts/tests/test_client_login_view.py (Diff revision 4)

The issue has been resolved. Show all issues

We should be able to just check against siteconfig.settings, which will be faster than checking keys().

Commits:

	Summary	ID
	Display the correct value for the client web login server capability.	5babd36546fc43551c99c189d2db2736aad24dfc
	Display the correct value for the client web login server capability.	0b5ed02daf65aa0263cdb2109ede76971c830f39

Diff:

Revision 5 (+122 -4)

Show changes

	docs/manual/admin/configuration/authentication-settings.rst
	docs/manual/webapi/2.0/authenticating.rst
	reviewboard/accounts/tests/test_client_login_view.py
	reviewboard/webapi/server_info.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
A congratulatory header
```

Ship it!

```
Ship It!
```

```
Howdy
```

Status:: Completed
Change Summary:: Pushed to release-5.0.x (6cd8bd2)