Summary

Add an admin page for viewing and managing licenses.

Review Request #14404 — Created April 28, 2025 and submitted July 29, 2025, 1:34 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-7.1.x

Bugs

Depends On

~~14401~~

Blocks

14405

Reviewers

Groups

reviewboard

People

Description

Each license is represented by a License model and LicenseView view,
backed by state provided by the License Provider. Custom models, views,
and data can be provided as needed.

Some basic infrastructure is set up for custom actions and license
checks. To ease review, those capabilities will be introduced in a
follow-up change.

Testing Done

Python and JavaScript unit tests passed.

Tested this with some custom License Providers registered in extensions
as tests, and with Power Pack ported over to License Providers. Verified
that all the state and status updates introduced in this change function
as expected.

Commits

Summary	ID
Add an admin page for viewing and managing licenses. This adds a new dedicated Licenses page in the Admin UI for seeing all current registered licenses across License Providers. These indicate the state of the licenses, expiration information, provide license management, actions, and custom line items. Each license is represented by a `License` model and `LicenseView` view, backed by state provided by the License Provider. Custom models, views, and data can be provided as needed. Some basic infrastructure is set up for custom actions and license checks. To ease review, those capabilities will be introduced in a follow-up change.	61f43a312a3e05ef8a292a1a6272250b375cc82a

Summary

Add an admin page for viewing and managing licenses.

This adds a new dedicated Licenses page in the Admin UI for seeing all current registered licenses across License Providers. These indicate the state of the licenses, expiration information, provide license management, actions, and custom line items. Each license is represented by a `License` model and `LicenseView` view, backed by state provided by the License Provider. Custom models, views, and data can be provided as needed. Some basic infrastructure is set up for custom actions and license checks. To ease review, those capabilities will be introduced in a follow-up change.

61f43a312a3e05ef8a292a1a6272250b375cc82a

Files

Issues

Description	From	Last Updated
'json' imported but unused Column: 1 Error code: F401	reviewbot	April 28, 2025, 1:50 p.m.
'uuid.uuid4' imported but unused Column: 1 Error code: F401	reviewbot	April 28, 2025, 1:50 p.m.
'reviewboard.licensing.errors.LicenseActionError' imported but unused Column: 1 Error code: F401	reviewbot	April 28, 2025, 1:50 p.m.
'reviewboard.licensing.license_checks.ProcessCheckLicenseResult' imported but unused Column: 1 Error code: F401	reviewbot	April 28, 2025, 1:50 p.m.
'reviewboard.licensing.license_checks.ProcessCheckLicenseResultStatus' imported but unused Column: 1 Error code: F401	reviewbot	April 28, 2025, 1:50 p.m.
'djblets.util.typing.JSONValue' imported but unused Column: 5 Error code: F401	reviewbot	April 28, 2025, 1:50 p.m.
'djblets.util.typing.SerializableJSONValue' imported but unused Column: 5 Error code: F401	reviewbot	April 28, 2025, 1:50 p.m.
Why are we doing it this way instead of include('reviewboard.licensing.urls')? Seems like we should stay consistent.	david	June 17, 2025, 2:11 a.m.
Should we define a TypedDict for this return type so we get warnings about if anything we're assigning isn't the …	david	June 17, 2025, 2:19 a.m.
Switch these two import lines	david	June 17, 2025, 2:12 a.m.
These should come from collections.abc, not typing	david	June 17, 2025, 2:12 a.m.
Can we either mark this as internal (prefix with _) or add docstrings to it? Future docstring linting will complain …	david	June 17, 2025, 2:13 a.m.
Same here.	david	June 17, 2025, 2:13 a.m.
And here.	david	June 17, 2025, 2:13 a.m.
Can we add doc comments on these?	david	June 17, 2025, 2:14 a.m.
Please add a docstring.	david	June 17, 2025, 2:14 a.m.
Please add a docstring.	david	June 17, 2025, 2:15 a.m.
Please add a docstring.	david	June 17, 2025, 2:16 a.m.
Please add a docstring.	david	June 17, 2025, 2:16 a.m.
Seems like the T here got unintentionally capitalized.	david	June 25, 2025, 5:13 p.m.
tuple -> dict	david	June 17, 2025, 2:17 a.m.
This should fit on one line.	david	June 17, 2025, 2:19 a.m.
I feel like it'd be nicer to get rid of all the inner if plan_name: ... else: ... statements, and …	maubin	June 25, 2025, 7:53 p.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/licensing/tests/test_licenses_view.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'json' imported but unused

Column: 1
Error code: F401
```
reviewboard/licensing/tests/test_licenses_view.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'uuid.uuid4' imported but unused

Column: 1
Error code: F401
```
reviewboard/licensing/tests/test_licenses_view.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'reviewboard.licensing.errors.LicenseActionError' imported but unused

Column: 1
Error code: F401
```

reviewboard/licensing/tests/test_licenses_view.py (Diff revision 1)

The issue has been resolved. Show all issues

'reviewboard.licensing.license_checks.ProcessCheckLicenseResult' imported but unused

Column: 1
Error code: F401

reviewboard/licensing/tests/test_licenses_view.py (Diff revision 1)

The issue has been resolved. Show all issues

'reviewboard.licensing.license_checks.ProcessCheckLicenseResultStatus' imported but unused

Column: 1
Error code: F401

reviewboard/licensing/tests/test_licenses_view.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'djblets.util.typing.JSONValue' imported but unused

Column: 5
Error code: F401
```
reviewboard/licensing/tests/test_licenses_view.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'djblets.util.typing.SerializableJSONValue' imported but unused

Column: 5
Error code: F401
```

Change Summary:

Removed unused imports intended for the follow-up change.

Commits:

	Summary	ID
	Add an admin page for viewing and managing licenses. This adds a new dedicated Licenses page in the Admin UI for seeing all current registered licenses across License Providers. These indicate the state of the licenses, expiration information, provide license management, actions, and custom line items. Each license is represented by a `License` model and `LicenseView` view, backed by state provided by the License Provider. Custom models, views, and data can be provided as needed. Some basic infrastructure is set up for custom actions and license checks. To ease review, those capabilities will be introduced in a follow-up change.	dbc60a990cb29fad5e214c98abaa8b6977c7c0bf
	Add an admin page for viewing and managing licenses. This adds a new dedicated Licenses page in the Admin UI for seeing all current registered licenses across License Providers. These indicate the state of the licenses, expiration information, provide license management, actions, and custom line items. Each license is represented by a `License` model and `LicenseView` view, backed by state provided by the License Provider. Custom models, views, and data can be provided as needed. Some basic infrastructure is set up for custom actions and license checks. To ease review, those capabilities will be introduced in a follow-up change.	94a6067c0c98c25dd29cdc1e12649c75ab56826b

Diff:

Revision 2 (+4154 -16)

Show changes

	reviewboard/admin/urls.py
	reviewboard/licensing/provider.py
	reviewboard/licensing/urls.py
	reviewboard/licensing/views.py
	reviewboard/licensing/tests/test_licenses_view.py
	reviewboard/static/rb/css/bundles/admin.less
	reviewboard/static/rb/css/ui/admin/license.less
	reviewboard/static/rb/js/admin/index.ts
	8 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

reviewboard/admin/urls.py (Diff revision 2)

The issue has been resolved. Show all issues

Why are we doing it this way instead of include('reviewboard.licensing.urls')? Seems like we should stay consistent.

reviewboard/licensing/provider.py (Diff revision 2)

The issue has been dropped. Show all issues

Should we define a TypedDict for this return type so we get warnings about if anything we're assigning isn't the right type?

chipx86

June 17, 2025, 2:19 a.m.

There's changes coming, so let me tackle this in a different change.

reviewboard/licensing/tests/test_licenses_view.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Switch these two import lines
```
reviewboard/licensing/tests/test_licenses_view.py (Diff revision 2)
The issue has been resolved. Show all issues
```
These should come from collections.abc, not typing
```

reviewboard/licensing/tests/test_licenses_view.py (Diff revision 2)

The issue has been resolved. Show all issues

Can we either mark this as internal (prefix with _) or add docstrings to it? Future docstring linting will complain otherwise.

reviewboard/licensing/tests/test_licenses_view.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Same here.
```
reviewboard/licensing/tests/test_licenses_view.py (Diff revision 2)
The issue has been resolved. Show all issues
```
And here.
```
reviewboard/licensing/tests/test_licenses_view.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Can we add doc comments on these?
```
reviewboard/licensing/tests/test_licenses_view.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Please add a docstring.
```
reviewboard/licensing/tests/test_licenses_view.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Please add a docstring.
```
reviewboard/licensing/tests/test_licenses_view.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Please add a docstring.
```
reviewboard/licensing/tests/test_licenses_view.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Please add a docstring.
```
reviewboard/licensing/views.py (Diff revision 2)
The issue has been resolved. Show all issues
```
tuple -> dict
```
reviewboard/static/rb/js/admin/views/licenseView.ts (Diff revision 2)
The issue has been resolved. Show all issues
```
This should fit on one line.
```

Change Summary:


The list of actions no longer takes up a full height if empty.
Switched an include to use a module name as a string instead of an import.
Fixed some docstring issues and added docstrings in tests.
Moved an import out of TYPE_CHECKING to fix a runtime issue.
Added a _ prefix to internal unit testing classes.
Fixed a unit test that wasn't updated in this change for Ink fixes.
Updated a TypeScript import to be one line.

Commits:

	Summary	ID
	Add an admin page for viewing and managing licenses. This adds a new dedicated Licenses page in the Admin UI for seeing all current registered licenses across License Providers. These indicate the state of the licenses, expiration information, provide license management, actions, and custom line items. Each license is represented by a `License` model and `LicenseView` view, backed by state provided by the License Provider. Custom models, views, and data can be provided as needed. Some basic infrastructure is set up for custom actions and license checks. To ease review, those capabilities will be introduced in a follow-up change.	94a6067c0c98c25dd29cdc1e12649c75ab56826b
	Add an admin page for viewing and managing licenses. This adds a new dedicated Licenses page in the Admin UI for seeing all current registered licenses across License Providers. These indicate the state of the licenses, expiration information, provide license management, actions, and custom line items. Each license is represented by a `License` model and `LicenseView` view, backed by state provided by the License Provider. Custom models, views, and data can be provided as needed. Some basic infrastructure is set up for custom actions and license checks. To ease review, those capabilities will be introduced in a follow-up change.	61f43a312a3e05ef8a292a1a6272250b375cc82a

Diff:

Revision 3 (+4192 -16)

Show changes

	reviewboard/admin/urls.py
	reviewboard/licensing/provider.py
	reviewboard/licensing/urls.py
	reviewboard/licensing/views.py
	reviewboard/licensing/tests/test_licenses_view.py
	reviewboard/static/rb/css/bundles/admin.less
	reviewboard/static/rb/css/ui/admin/license.less
	reviewboard/static/rb/js/admin/index.ts
	8 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

reviewboard/licensing/tests/test_licenses_view.py (Diff revisions 2 - 3)

The issue has been dropped. Show all issues

Seems like the T here got unintentionally capitalized.

chipx86

June 25, 2025, 5:19 p.m.

This was intentional. Because we're working with representations of elements and their properties and not HTML that gets normalized, we need to use the actual property names on the object. A HTMLTimeElement uses dateTime instead of datetime. My old implementation had an issue here.

reviewboard/licensing/provider.py (Diff revision 3)

The issue has been dropped. Show all issues

I feel like it'd be nicer to get rid of all the inner if plan_name: ... else: ... statements, and instead have something like this:
if plan_name:
    display_name = f'{product} ({plan_name})'
else:
    display_name = f'{product}'


And then use display_name in the summary strings.

chipx86

June 25, 2025, 5:19 p.m.

This is for localization purposes. When localizing strings, you don't always end up with the string in the same order you would in English, so if you compose it, you might get something wrong.

For instance, while it may be {product} ({plan_name}) in English, another language could effectively want to reverse that, not use parens, change inflection, or have some other issue that couldn't be solved when separating this part of the string out.

maubin

June 25, 2025, 7:54 p.m.
```
Ah got it.
```

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-7.1.x (1b9f858)