Summary

Add a new UserDetailsProvider interface, with badge support.

Review Request #14283 — Created Jan. 2, 2025 and submitted Jan. 16, 2025, 4:10 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-7.1.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This introduces a new concept for extensions and users, User Details

Providers, implemented as subclasses of UserDetailsProvider. This is

a class that can build upon to let exetnsions provide additional

information about users without needing to worry about extending User,

Profile, or implementing whole new hooks.
UserDetailsProvider subclasses can be registered in a central registry

and then implement methods to provide certain kinds of details that

Review Board can then query for additional functionality.
Right now, these can provide badges for users. Badges are shown

alongside a user's name in certain parts of the UI (infoboxes and

discussions, currently). They contain text and may contain custom CSS or

even custom HTML.
This is purely built for extension authors to take advantage of, giving

companies greater control over Review Board.

Testing Done

Unit tests passed.

Tested with an extension that added some hard-coded badges. Verified these
showed up in reviews, discussions, and infoboxes.

Commits

Summary	ID
Add a new UserDetailsProvider interface, with badge support. This introduces a new concept for extensions and users, User Details Providers, implemented as subclasses of `UserDetailsProvider`. This is a class that can build upon to let exetnsions provide additional information about users without needing to worry about extending `User`, `Profile`, or implementing whole new hooks. `UserDetailsProvider` subclasses can be registered in a central registry and then implement methods to provide certain kinds of details that Review Board can then query for additional functionality. Right now, these can provide badges for users. Badges are shown alongside a user's name in certain parts of the UI (infoboxes and discussions, currently). They contain text and may contain custom CSS or even custom HTML. This is purely built for extension authors to take advantage of, giving companies greater control over Review Board.	ccd78885fef81f06464d98111466e7be3e534de5

Summary

Add a new UserDetailsProvider interface, with badge support.

This introduces a new concept for extensions and users, User Details Providers, implemented as subclasses of `UserDetailsProvider`. This is a class that can build upon to let exetnsions provide additional information about users without needing to worry about extending `User`, `Profile`, or implementing whole new hooks. `UserDetailsProvider` subclasses can be registered in a central registry and then implement methods to provide certain kinds of details that Review Board can then query for additional functionality. Right now, these can provide badges for users. Badges are shown alongside a user's name in certain parts of the UI (infoboxes and discussions, currently). They contain text and may contain custom CSS or even custom HTML. This is purely built for extension authors to take advantage of, giving companies greater control over Review Board.

ccd78885fef81f06464d98111466e7be3e534de5

Files

Issues

Description	From	Last Updated
'io.StringIO' imported but unused Column: 1 Error code: F401	reviewbot	Jan. 2, 2025, 11:42 p.m.
'reviewboard.accounts.user_details.UserBadge' imported but unused Column: 1 Error code: F401	reviewbot	Jan. 2, 2025, 11:42 p.m.
'reviewboard.extensions.hooks.users.UserBadgeInfo' imported but unused Column: 5 Error code: F401	reviewbot	Jan. 2, 2025, 11:42 p.m.
line too long (82 > 79 characters) Column: 80 Error code: E501	reviewbot	Jan. 2, 2025, 11:42 p.m.
This looks like it's out of date/copy-pasted from elsewhere. Should say it returns a SafeString of the HTML for all …	david	Jan. 13, 2025, 2:46 a.m.
Can we move the definition of css_class down so it's right above its use?	david	Jan. 13, 2025, 2:47 a.m.
This shouldn't have "optional" in here, since there's no default value.	david	Jan. 13, 2025, 3:42 p.m.
This seems like a copy-paste that wasn't updated. It should be more specific to the user info box.	maubin	Jan. 13, 2025, 3:43 p.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/accounts/templatetags/accounts.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'io.StringIO' imported but unused

Column: 1
Error code: F401
```
reviewboard/accounts/templatetags/accounts.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'reviewboard.accounts.user_details.UserBadge' imported but unused

Column: 1
Error code: F401
```

reviewboard/accounts/templatetags/accounts.py (Diff revision 1)

The issue has been resolved. Show all issues

'reviewboard.extensions.hooks.users.UserBadgeInfo' imported but unused

Column: 5
Error code: F401

reviewboard/accounts/tests/test_template_tags.py (Diff revision 1)
The issue has been resolved. Show all issues
```
line too long (82 > 79 characters)

Column: 80
Error code: E501
```

Change Summary:


Removed unused imports.
Fixed a line length issue.

Commits:

	Summary	ID
	Add a new UserDetailsProvider interface, with badge support. This introduces a new concept for extensions and users, User Details Providers, implemented as subclasses of `UserDetailsProvider`. This is a class that can build upon to let exetnsions provide additional information about users without needing to worry about extending `User`, `Profile`, or implementing whole new hooks. `UserDetailsProvider` subclasses can be registered in a central registry and then implement methods to provide certain kinds of details that Review Board can then query for additional functionality. Right now, these can provide badges for users. Badges are shown alongside a user's name in certain parts of the UI (infoboxes and discussions, currently). They contain text and may contain custom CSS or even custom HTML. This is purely built for extension authors to take advantage of, giving companies greater control over Review Board.	70f647b787a24926709d67a021e20d6ff372c85e
	Add a new UserDetailsProvider interface, with badge support. This introduces a new concept for extensions and users, User Details Providers, implemented as subclasses of `UserDetailsProvider`. This is a class that can build upon to let exetnsions provide additional information about users without needing to worry about extending `User`, `Profile`, or implementing whole new hooks. `UserDetailsProvider` subclasses can be registered in a central registry and then implement methods to provide certain kinds of details that Review Board can then query for additional functionality. Right now, these can provide badges for users. Badges are shown alongside a user's name in certain parts of the UI (infoboxes and discussions, currently). They contain text and may contain custom CSS or even custom HTML. This is purely built for extension authors to take advantage of, giving companies greater control over Review Board.	18ea34617edd8f9ba378bbbb14124f84c2aaf54a

Diff:

Revision 2 (+1224 -26)

Show changes

	docs/manual/extending/index.rst
	docs/manual/extending/coderef/index.rst
	docs/manual/extending/extensions/hooks/index.rst
	docs/manual/extending/extensions/hooks/user-details-provider-hook.rst
	docs/stories/components/users/user-badges.stories.ts
	reviewboard/accounts/user_details.py
	reviewboard/accounts/templatetags/accounts.py
	reviewboard/accounts/tests/test_template_tags.py
	10 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

reviewboard/accounts/templatetags/accounts.py (Diff revision 2)

The issue has been resolved. Show all issues

This looks like it's out of date/copy-pasted from elsewhere. Should say it returns a SafeString of the HTML for all badges.

reviewboard/accounts/user_details.py (Diff revision 2)

The issue has been resolved. Show all issues

Can we move the definition of css_class down so it's right above its use?

Change Summary:


get_user_badges() now takes a Local Site and request.
Fixed using the wrong user objects for badges in some places.
Fixed outdated docstrings.
Reordered some code to keep definitions and logic together.

Commits:

	Summary	ID
	Add a new UserDetailsProvider interface, with badge support. This introduces a new concept for extensions and users, User Details Providers, implemented as subclasses of `UserDetailsProvider`. This is a class that can build upon to let exetnsions provide additional information about users without needing to worry about extending `User`, `Profile`, or implementing whole new hooks. `UserDetailsProvider` subclasses can be registered in a central registry and then implement methods to provide certain kinds of details that Review Board can then query for additional functionality. Right now, these can provide badges for users. Badges are shown alongside a user's name in certain parts of the UI (infoboxes and discussions, currently). They contain text and may contain custom CSS or even custom HTML. This is purely built for extension authors to take advantage of, giving companies greater control over Review Board.	18ea34617edd8f9ba378bbbb14124f84c2aaf54a
	Add a new UserDetailsProvider interface, with badge support. This introduces a new concept for extensions and users, User Details Providers, implemented as subclasses of `UserDetailsProvider`. This is a class that can build upon to let exetnsions provide additional information about users without needing to worry about extending `User`, `Profile`, or implementing whole new hooks. `UserDetailsProvider` subclasses can be registered in a central registry and then implement methods to provide certain kinds of details that Review Board can then query for additional functionality. Right now, these can provide badges for users. Badges are shown alongside a user's name in certain parts of the UI (infoboxes and discussions, currently). They contain text and may contain custom CSS or even custom HTML. This is purely built for extension authors to take advantage of, giving companies greater control over Review Board.	4c249d51d8c849b9a1d9c2db16b5973ae4b72ef6

Diff:

Revision 3 (+1298 -26)

Show changes

	docs/manual/extending/index.rst
	docs/manual/extending/coderef/index.rst
	docs/manual/extending/extensions/hooks/index.rst
	docs/manual/extending/extensions/hooks/user-details-provider-hook.rst
	docs/stories/components/users/user-badges.stories.ts
	reviewboard/accounts/user_details.py
	reviewboard/accounts/templatetags/accounts.py
	reviewboard/accounts/tests/test_template_tags.py
	10 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

reviewboard/accounts/user_details.py (Diff revisions 2 - 3)
The issue has been resolved. Show all issues
```
This shouldn't have "optional" in here, since there's no default value.
```

docs/manual/extending/index.rst (Diff revision 3)

The issue has been resolved. Show all issues

This seems like a copy-paste that wasn't updated. It should be more specific to the user info box.

Change Summary:


Removed an incorrect , optional from a parameter.
Fixed documentation for the UserInfoboxHook summary.

Commits:

	Summary	ID
	Add a new UserDetailsProvider interface, with badge support. This introduces a new concept for extensions and users, User Details Providers, implemented as subclasses of `UserDetailsProvider`. This is a class that can build upon to let exetnsions provide additional information about users without needing to worry about extending `User`, `Profile`, or implementing whole new hooks. `UserDetailsProvider` subclasses can be registered in a central registry and then implement methods to provide certain kinds of details that Review Board can then query for additional functionality. Right now, these can provide badges for users. Badges are shown alongside a user's name in certain parts of the UI (infoboxes and discussions, currently). They contain text and may contain custom CSS or even custom HTML. This is purely built for extension authors to take advantage of, giving companies greater control over Review Board.	4c249d51d8c849b9a1d9c2db16b5973ae4b72ef6
	Add a new UserDetailsProvider interface, with badge support. This introduces a new concept for extensions and users, User Details Providers, implemented as subclasses of `UserDetailsProvider`. This is a class that can build upon to let exetnsions provide additional information about users without needing to worry about extending `User`, `Profile`, or implementing whole new hooks. `UserDetailsProvider` subclasses can be registered in a central registry and then implement methods to provide certain kinds of details that Review Board can then query for additional functionality. Right now, these can provide badges for users. Badges are shown alongside a user's name in certain parts of the UI (infoboxes and discussions, currently). They contain text and may contain custom CSS or even custom HTML. This is purely built for extension authors to take advantage of, giving companies greater control over Review Board.	ccd78885fef81f06464d98111466e7be3e534de5

Diff:

Revision 4 (+1296 -26)

Show changes

	docs/manual/extending/index.rst
	docs/manual/extending/coderef/index.rst
	docs/manual/extending/extensions/hooks/index.rst
	docs/manual/extending/extensions/hooks/user-details-provider-hook.rst
	docs/stories/components/users/user-badges.stories.ts
	reviewboard/accounts/user_details.py
	reviewboard/accounts/templatetags/accounts.py
	reviewboard/accounts/tests/test_template_tags.py
	10 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-7.1.x (4ceeeff)