Summary

Add an admin page for viewing and managing licenses.

Review Request #14404 — Created April 28, 2025 and updated 2 days, 18 hours ago

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

Light mode

Dark mode

Issues

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

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 4 days, 2 hours ago

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.

Fix it!

reviewboard/licensing/tests/test_licenses_view.py (Diff revisions 2 - 3)
An issue was opened. Show all issues
```
Seems like the T here got unintentionally capitalized.
```

Fix it!

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

An issue was opened. 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.