Summary

Add support for custom license action handling.

Review Request #14470 — Created June 23, 2025 and updated June 26, 2025, 5:13 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-7.1.x

Bugs

Depends On

14469

Reviewers

Groups

reviewboard

People

Description

License Providers that register custom actions can now handle them in
requests from the client. This is done by registering the action name in
the License Provider's custom_actions set and then adding a
handle_<actionid>_action() method to handle the response.

BaseLicenseProvider.call_action() has been added to invoke these
actions. This does the work formerly done by the view, making it more
generally-useful outside of HTTP handling. This takes the action ID,
action request data, the license information to operate off of, and an
optional HTTP request (which may be needed by some actions).

The action data may be any arbitrary JSON-safe data. Previously, when
the view handled an action, it expected keys and values in the HTTP POST
data to be used as arguments, but now it requires an explicit
action_data JSON field, which can then be deserialized and passed to
action handlers.

The built-in actions (license-update-check, process-license-update,
and upload-license) now live on BaseLicenseProvider instead of the
view, giving call_action() access to them.

Testing Done

Unit tests pass.

Manually tested the license update flow and some custom actions.

Commits

Summary	ID
Add support for custom license action handling. License Providers that register custom actions can now handle them in requests from the client. This is done by registering the action name in the License Provider's `custom_actions` set and then adding a `handle_<actionid>_action()` method to handle the response. `BaseLicenseProvider.call_action()` has been added to invoke these actions. This does the work formerly done by the view, making it more generally-useful outside of HTTP handling. This takes the action ID, action request data, the license information to operate off of, and an optional HTTP request (which may be needed by some actions). The action data may be any arbitrary JSON-safe data. Previously, when the view handled an action, it expected keys and values in the HTTP POST data to be used as arguments, but now it requires an explicit `action_data` JSON field, which can then be deserialized and passed to action handlers. The built-in actions (`license-update-check`, `process-license-update`, and `upload-license`) now live on `BaseLicenseProvider` instead of the view, giving `call_action()` access to them.	95f572b5922db1463a1d3200e5a0363c56d673a9

Summary

Add support for custom license action handling.

License Providers that register custom actions can now handle them in requests from the client. This is done by registering the action name in the License Provider's `custom_actions` set and then adding a `handle_<actionid>_action()` method to handle the response. `BaseLicenseProvider.call_action()` has been added to invoke these actions. This does the work formerly done by the view, making it more generally-useful outside of HTTP handling. This takes the action ID, action request data, the license information to operate off of, and an optional HTTP request (which may be needed by some actions). The action data may be any arbitrary JSON-safe data. Previously, when the view handled an action, it expected keys and values in the HTTP POST data to be used as arguments, but now it requires an explicit `action_data` JSON field, which can then be deserialized and passed to action handlers. The built-in actions (`license-update-check`, `process-license-update`, and `upload-license`) now live on `BaseLicenseProvider` instead of the view, giving `call_action()` access to them.

95f572b5922db1463a1d3200e5a0363c56d673a9

Issues

Description	From	Last Updated
'typing.Mapping' imported but unused Column: 1 Error code: F401	reviewbot	June 23, 2025, 11:47 p.m.
'typing.Protocol' imported but unused Column: 1 Error code: F401	reviewbot	June 23, 2025, 11:47 p.m.
I think the TypeAlias import can be in TYPE_CHECKING	david	June 26, 2025, 2:46 a.m.
Can you add a docstring to this method?	david	June 26, 2025, 2:47 a.m.
This is missing a bunch of args.	david	June 26, 2025, 2:48 a.m.
undefined name 'e' Column: 20 Error code: F821	reviewbot	June 26, 2025, 3:06 a.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/licensing/provider.py (Diff revision 1)
The issue has been resolved. Show all issues
```
'typing.Mapping' imported but unused

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

Column: 1
Error code: F401
```

Change Summary:

Removed unused imports.

Commits:

	Summary	ID
	Add support for custom license action handling. License Providers that register custom actions can now handle them in requests from the client. This is done by registering the action name in the License Provider's `custom_actions` set and then adding a `handle_<actionid>_action()` method to handle the response. `BaseLicenseProvider.call_action()` has been added to invoke these actions. This does the work formerly done by the view, making it more generally-useful outside of HTTP handling. This takes the action ID, action request data, the license information to operate off of, and an optional HTTP request (which may be needed by some actions). The action data may be any arbitrary JSON-safe data. Previously, when the view handled an action, it expected keys and values in the HTTP POST data to be used as arguments, but now it requires an explicit `action_data` JSON field, which can then be deserialized and passed to action handlers. The built-in actions (`license-update-check`, `process-license-update`, and `upload-license`) now live on `BaseLicenseProvider` instead of the view, giving `call_action()` access to them.	ed8b9a94128de4d03cdea5fe43bfaf5b82de7249
	Add support for custom license action handling. License Providers that register custom actions can now handle them in requests from the client. This is done by registering the action name in the License Provider's `custom_actions` set and then adding a `handle_<actionid>_action()` method to handle the response. `BaseLicenseProvider.call_action()` has been added to invoke these actions. This does the work formerly done by the view, making it more generally-useful outside of HTTP handling. This takes the action ID, action request data, the license information to operate off of, and an optional HTTP request (which may be needed by some actions). The action data may be any arbitrary JSON-safe data. Previously, when the view handled an action, it expected keys and values in the HTTP POST data to be used as arguments, but now it requires an explicit `action_data` JSON field, which can then be deserialized and passed to action handlers. The built-in actions (`license-update-check`, `process-license-update`, and `upload-license`) now live on `BaseLicenseProvider` instead of the view, giving `call_action()` access to them.	4b30f67dd7a699d3848a37165703c9d7c2156bd8

Diff:

Revision 2 (+1894 -868)

Show changes

	docs/manual/extending/coderef/index.rst
	reviewboard/licensing/actions.py
	reviewboard/licensing/provider.py
	reviewboard/licensing/views.py
	reviewboard/licensing/tests/providers.py
	reviewboard/licensing/tests/test_license_provider.py
	reviewboard/licensing/tests/test_licenses_view.py
	reviewboard/static/rb/js/admin/models/licenseModel.ts

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

reviewboard/licensing/actions.py (Diff revision 2)
The issue has been resolved. Show all issues
```
I think the TypeAlias import can be in TYPE_CHECKING
```
reviewboard/licensing/tests/providers.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Can you add a docstring to this method?
```

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

The issue has been resolved. Show all issues

This is missing a bunch of args.

Change Summary:


Brought in all the changes just made to /r/14405/.
Added missing docs and fixed a wrong copy/pasted docstring in the test providers.
Moved the TypeAlias import into TYPE_CHECKING.

Commits:

	Summary	ID
	Add support for custom license action handling. License Providers that register custom actions can now handle them in requests from the client. This is done by registering the action name in the License Provider's `custom_actions` set and then adding a `handle_<actionid>_action()` method to handle the response. `BaseLicenseProvider.call_action()` has been added to invoke these actions. This does the work formerly done by the view, making it more generally-useful outside of HTTP handling. This takes the action ID, action request data, the license information to operate off of, and an optional HTTP request (which may be needed by some actions). The action data may be any arbitrary JSON-safe data. Previously, when the view handled an action, it expected keys and values in the HTTP POST data to be used as arguments, but now it requires an explicit `action_data` JSON field, which can then be deserialized and passed to action handlers. The built-in actions (`license-update-check`, `process-license-update`, and `upload-license`) now live on `BaseLicenseProvider` instead of the view, giving `call_action()` access to them.	4b30f67dd7a699d3848a37165703c9d7c2156bd8
	Add support for custom license action handling. License Providers that register custom actions can now handle them in requests from the client. This is done by registering the action name in the License Provider's `custom_actions` set and then adding a `handle_<actionid>_action()` method to handle the response. `BaseLicenseProvider.call_action()` has been added to invoke these actions. This does the work formerly done by the view, making it more generally-useful outside of HTTP handling. This takes the action ID, action request data, the license information to operate off of, and an optional HTTP request (which may be needed by some actions). The action data may be any arbitrary JSON-safe data. Previously, when the view handled an action, it expected keys and values in the HTTP POST data to be used as arguments, but now it requires an explicit `action_data` JSON field, which can then be deserialized and passed to action handlers. The built-in actions (`license-update-check`, `process-license-update`, and `upload-license`) now live on `BaseLicenseProvider` instead of the view, giving `call_action()` access to them.	2a121ad29d481b6d5d555aeab9dcb013bf23663b

Diff:

Revision 3 (+1984 -880)

Show changes

	docs/manual/extending/coderef/index.rst
	reviewboard/licensing/actions.py
	reviewboard/licensing/provider.py
	reviewboard/licensing/views.py
	reviewboard/licensing/tests/providers.py
	reviewboard/licensing/tests/test_license_provider.py
	reviewboard/licensing/tests/test_licenses_view.py
	reviewboard/static/rb/js/admin/models/licenseModel.ts

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/licensing/provider.py (Diff revision 3)
The issue has been resolved. Show all issues
```
undefined name 'e'

Column: 20
Error code: F821
```

Change Summary:

Added a line missing during git add -p.

Commits:

	Summary	ID
	Add support for custom license action handling. License Providers that register custom actions can now handle them in requests from the client. This is done by registering the action name in the License Provider's `custom_actions` set and then adding a `handle_<actionid>_action()` method to handle the response. `BaseLicenseProvider.call_action()` has been added to invoke these actions. This does the work formerly done by the view, making it more generally-useful outside of HTTP handling. This takes the action ID, action request data, the license information to operate off of, and an optional HTTP request (which may be needed by some actions). The action data may be any arbitrary JSON-safe data. Previously, when the view handled an action, it expected keys and values in the HTTP POST data to be used as arguments, but now it requires an explicit `action_data` JSON field, which can then be deserialized and passed to action handlers. The built-in actions (`license-update-check`, `process-license-update`, and `upload-license`) now live on `BaseLicenseProvider` instead of the view, giving `call_action()` access to them.	2a121ad29d481b6d5d555aeab9dcb013bf23663b
	Add support for custom license action handling. License Providers that register custom actions can now handle them in requests from the client. This is done by registering the action name in the License Provider's `custom_actions` set and then adding a `handle_<actionid>_action()` method to handle the response. `BaseLicenseProvider.call_action()` has been added to invoke these actions. This does the work formerly done by the view, making it more generally-useful outside of HTTP handling. This takes the action ID, action request data, the license information to operate off of, and an optional HTTP request (which may be needed by some actions). The action data may be any arbitrary JSON-safe data. Previously, when the view handled an action, it expected keys and values in the HTTP POST data to be used as arguments, but now it requires an explicit `action_data` JSON field, which can then be deserialized and passed to action handlers. The built-in actions (`license-update-check`, `process-license-update`, and `upload-license`) now live on `BaseLicenseProvider` instead of the view, giving `call_action()` access to them.	95f572b5922db1463a1d3200e5a0363c56d673a9

Diff:

Revision 4 (+1984 -880)

Show changes

	docs/manual/extending/coderef/index.rst
	reviewboard/licensing/actions.py
	reviewboard/licensing/provider.py
	reviewboard/licensing/views.py
	reviewboard/licensing/tests/providers.py
	reviewboard/licensing/tests/test_license_provider.py
	reviewboard/licensing/tests/test_licenses_view.py
	reviewboard/static/rb/js/admin/models/licenseModel.ts

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```