Summary

Complete the support for custom license actions.

Review Request #14509 — Created July 16, 2025 and submitted Sept. 17, 2025, 8:31 a.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-7.1.x

Bugs

Depends On

~~14614~~

Reviewers

Groups

reviewboard

People

Description

Actions are no longer hard-coded client-side, and custom actions no
longer require subclassing RB.LicenseView.

A registered action can now provide extra_data, which can be handled
specially by a RB.LicenseView subclass, and call_args, which will be
included in an action call back to the License Provider when clicked.

License action handlers can provide new license action updates, just
like a Check Update request, by returning license_infos in the
response. It can also redirect to a URL by providing redirect_urls.

This makes it possible for an action to begin a more involved
license-related flow kicked off by the License Provider and going
through other servers or URLs.

Since actions are more dynamic now, we no longer hard-code the Manage
License and Upload License actions within RB.LicenseView. Instead,
BaseLicenseProvider.get_license_actions() now registers these by
default, and subclasses can override them or reposition them.

Since the Upload License action is special, RB.LicenseView still needs
to handle it specially. This is now done through
RB.LicenseView.actionBuilders, which is a mapping of action IDs to
custom builder functions. The Upload License handler is registered in
this mapping.

Testing Done

Unit tests pass.

Registered some custom actions and verified that clicking them triggered
a call handled the License Provider. Also verified that the license_infos
and redirect_url results worked.

Commits

Summary	ID
Complete the support for custom license actions. Actions are no longer hard-coded client-side, and custom actions no longer require subclassing `RB.LicenseView`. A registered action can now provide `extra_data`, which can be handled specially by a `RB.LicenseView` subclass, and `call_args`, which will be included in an action call back to the License Provider when clicked. License action handlers can provide new license action updates, just like a Check Update request, by returning `license_infos` in the response. It can also redirect to a URL by providing `redirect_urls`. This makes it possible for an action to begin a more involved license-related flow kicked off by the License Provider and going through other servers or URLs. Since actions are more dynamic now, we no longer hard-code the Manage License and Upload License actions within `RB.LicenseView`. Instead, `BaseLicenseProvider.get_license_actions()` now registers these by default, and subclasses can override them or reposition them. Since the Upload License action is special, `RB.LicenseView` still needs to handle it specially. This is now done through `RB.LicenseView.actionBuilders`, which is a mapping of action IDs to custom builder functions. The Upload License handler is registered in this mapping.	64100d85ff645b637c7139376f1e3b6a6f04f7bd

Summary

Complete the support for custom license actions.

Actions are no longer hard-coded client-side, and custom actions no longer require subclassing `RB.LicenseView`. A registered action can now provide `extra_data`, which can be handled specially by a `RB.LicenseView` subclass, and `call_args`, which will be included in an action call back to the License Provider when clicked. License action handlers can provide new license action updates, just like a Check Update request, by returning `license_infos` in the response. It can also redirect to a URL by providing `redirect_urls`. This makes it possible for an action to begin a more involved license-related flow kicked off by the License Provider and going through other servers or URLs. Since actions are more dynamic now, we no longer hard-code the Manage License and Upload License actions within `RB.LicenseView`. Instead, `BaseLicenseProvider.get_license_actions()` now registers these by default, and subclasses can override them or reposition them. Since the Upload License action is special, `RB.LicenseView` still needs to handle it specially. This is now done through `RB.LicenseView.actionBuilders`, which is a mapping of action IDs to custom builder functions. The Upload License handler is registered in this mapping.

64100d85ff645b637c7139376f1e3b6a6f04f7bd

Issues

Description	From	Last Updated
Shouldn't this be typelets.json?	david	Aug. 6, 2025, 10:30 p.m.
We should probably have a try/catch here to catch any errors from the async operation.	david	Sept. 15, 2025, 2:07 a.m.
This doc comment needs "Args:"	david	Sept. 15, 2025, 2:09 a.m.
Even though it can't be a #method, this can probably still be marked with private.	david	Sept. 15, 2025, 2:10 a.m.

flake8 passed.

JSHint passed.

Change Summary:

Action serialization now leaves out optional attributes unless specified.

Commits:

	Summary	ID
	Complete the support for custom license actions. Actions are no longer hard-coded client-side, and custom actions no longer require subclassing `RB.LicenseView`. A registered action can now provide `extra_data`, which can be handled specially by a `RB.LicenseView` subclass, and `call_args`, which will be included in an action call back to the License Provider when clicked. License action handlers can provide new license action updates, just like a Check Update request, by returning `license_infos` in the response. It can also redirect to a URL by providing `redirect_urls`. This makes it possible for an action to begin a more involved license-related flow kicked off by the License Provider and going through other servers or URLs. Since actions are more dynamic now, we no longer hard-code the Manage License and Upload License actions within `RB.LicenseView`. Instead, `BaseLicenseProvider.get_license_actions()` now registers these by default, and subclasses can override them or reposition them. Since the Upload License action is special, `RB.LicenseView` still needs to handle it specially. This is now done through `RB.LicenseView.actionBuilders`, which is a mapping of action IDs to custom builder functions. The Upload License handler is registered in this mapping.	b97389a03df013fee680782e02e4439fd652409e
	Complete the support for custom license actions. Actions are no longer hard-coded client-side, and custom actions no longer require subclassing `RB.LicenseView`. A registered action can now provide `extra_data`, which can be handled specially by a `RB.LicenseView` subclass, and `call_args`, which will be included in an action call back to the License Provider when clicked. License action handlers can provide new license action updates, just like a Check Update request, by returning `license_infos` in the response. It can also redirect to a URL by providing `redirect_urls`. This makes it possible for an action to begin a more involved license-related flow kicked off by the License Provider and going through other servers or URLs. Since actions are more dynamic now, we no longer hard-code the Manage License and Upload License actions within `RB.LicenseView`. Instead, `BaseLicenseProvider.get_license_actions()` now registers these by default, and subclasses can override them or reposition them. Since the Upload License action is special, `RB.LicenseView` still needs to handle it specially. This is now done through `RB.LicenseView.actionBuilders`, which is a mapping of action IDs to custom builder functions. The Upload License handler is registered in this mapping.	43c8d273d77ad9bb4f658e63d12474caa7ec104e

Diff:

Revision 2 (+258 -38)

Show changes

	reviewboard/licensing/actions.py
	reviewboard/licensing/provider.py
	reviewboard/static/rb/js/admin/models/licenseModel.ts
	reviewboard/static/rb/js/admin/views/licenseView.ts
	reviewboard/static/rb/js/admin/views/tests/licenseViewTests.ts

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Fixed the docstring for get_license_actions() to mention the new behavior.

Commits:

	Summary	ID
	Complete the support for custom license actions. Actions are no longer hard-coded client-side, and custom actions no longer require subclassing `RB.LicenseView`. A registered action can now provide `extra_data`, which can be handled specially by a `RB.LicenseView` subclass, and `call_args`, which will be included in an action call back to the License Provider when clicked. License action handlers can provide new license action updates, just like a Check Update request, by returning `license_infos` in the response. It can also redirect to a URL by providing `redirect_urls`. This makes it possible for an action to begin a more involved license-related flow kicked off by the License Provider and going through other servers or URLs. Since actions are more dynamic now, we no longer hard-code the Manage License and Upload License actions within `RB.LicenseView`. Instead, `BaseLicenseProvider.get_license_actions()` now registers these by default, and subclasses can override them or reposition them. Since the Upload License action is special, `RB.LicenseView` still needs to handle it specially. This is now done through `RB.LicenseView.actionBuilders`, which is a mapping of action IDs to custom builder functions. The Upload License handler is registered in this mapping.	43c8d273d77ad9bb4f658e63d12474caa7ec104e
	Complete the support for custom license actions. Actions are no longer hard-coded client-side, and custom actions no longer require subclassing `RB.LicenseView`. A registered action can now provide `extra_data`, which can be handled specially by a `RB.LicenseView` subclass, and `call_args`, which will be included in an action call back to the License Provider when clicked. License action handlers can provide new license action updates, just like a Check Update request, by returning `license_infos` in the response. It can also redirect to a URL by providing `redirect_urls`. This makes it possible for an action to begin a more involved license-related flow kicked off by the License Provider and going through other servers or URLs. Since actions are more dynamic now, we no longer hard-code the Manage License and Upload License actions within `RB.LicenseView`. Instead, `BaseLicenseProvider.get_license_actions()` now registers these by default, and subclasses can override them or reposition them. Since the Upload License action is special, `RB.LicenseView` still needs to handle it specially. This is now done through `RB.LicenseView.actionBuilders`, which is a mapping of action IDs to custom builder functions. The Upload License handler is registered in this mapping.	8390ee99f3fbf397013266fb64dda2c397b16a19

Diff:

Revision 3 (+264 -48)

Show changes

	reviewboard/licensing/actions.py
	reviewboard/licensing/provider.py
	reviewboard/static/rb/js/admin/models/licenseModel.ts
	reviewboard/static/rb/js/admin/views/licenseView.ts
	reviewboard/static/rb/js/admin/views/tests/licenseViewTests.ts

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

reviewboard/licensing/actions.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Shouldn't this be typelets.json?
```

Change Summary:

Fixed an incorrect typing import.

Commits:

	Summary	ID
	Complete the support for custom license actions. Actions are no longer hard-coded client-side, and custom actions no longer require subclassing `RB.LicenseView`. A registered action can now provide `extra_data`, which can be handled specially by a `RB.LicenseView` subclass, and `call_args`, which will be included in an action call back to the License Provider when clicked. License action handlers can provide new license action updates, just like a Check Update request, by returning `license_infos` in the response. It can also redirect to a URL by providing `redirect_urls`. This makes it possible for an action to begin a more involved license-related flow kicked off by the License Provider and going through other servers or URLs. Since actions are more dynamic now, we no longer hard-code the Manage License and Upload License actions within `RB.LicenseView`. Instead, `BaseLicenseProvider.get_license_actions()` now registers these by default, and subclasses can override them or reposition them. Since the Upload License action is special, `RB.LicenseView` still needs to handle it specially. This is now done through `RB.LicenseView.actionBuilders`, which is a mapping of action IDs to custom builder functions. The Upload License handler is registered in this mapping.	8390ee99f3fbf397013266fb64dda2c397b16a19
	Complete the support for custom license actions. Actions are no longer hard-coded client-side, and custom actions no longer require subclassing `RB.LicenseView`. A registered action can now provide `extra_data`, which can be handled specially by a `RB.LicenseView` subclass, and `call_args`, which will be included in an action call back to the License Provider when clicked. License action handlers can provide new license action updates, just like a Check Update request, by returning `license_infos` in the response. It can also redirect to a URL by providing `redirect_urls`. This makes it possible for an action to begin a more involved license-related flow kicked off by the License Provider and going through other servers or URLs. Since actions are more dynamic now, we no longer hard-code the Manage License and Upload License actions within `RB.LicenseView`. Instead, `BaseLicenseProvider.get_license_actions()` now registers these by default, and subclasses can override them or reposition them. Since the Upload License action is special, `RB.LicenseView` still needs to handle it specially. This is now done through `RB.LicenseView.actionBuilders`, which is a mapping of action IDs to custom builder functions. The Upload License handler is registered in this mapping.	e6cc1ff8926f14fe789830dbd4555631c28bfc3c

Diff:

Revision 4 (+264 -48)

Show changes

	reviewboard/licensing/actions.py
	reviewboard/licensing/provider.py
	reviewboard/static/rb/js/admin/models/licenseModel.ts
	reviewboard/static/rb/js/admin/views/licenseView.ts
	reviewboard/static/rb/js/admin/views/tests/licenseViewTests.ts

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

reviewboard/static/rb/js/admin/views/licenseView.ts (Diff revision 4)
The issue has been resolved. Show all issues
```
We should probably have a try/catch here to catch any errors from the async operation.
```
reviewboard/static/rb/js/admin/views/licenseView.ts (Diff revision 4)
The issue has been resolved. Show all issues
```
This doc comment needs "Args:"
```

reviewboard/static/rb/js/admin/views/licenseView.ts (Diff revision 4)

The issue has been resolved. Show all issues

Even though it can't be a #method, this can probably still be marked with private.

chipx86 Sept. 15, 2025, 2:11 a.m.

Originally I was intending for this to be public so I could specialize it in Power Pack, but not anymore.

Depends On:: ~~14614 - Add support for custom license action handling.~~

Change Summary:


Added default error handling for action buttons.
Added missing "Args" docs.
Made buildUploadLicenseActionButton private, and prefixed with _.

Commits:

	Summary	ID
	Complete the support for custom license actions. Actions are no longer hard-coded client-side, and custom actions no longer require subclassing `RB.LicenseView`. A registered action can now provide `extra_data`, which can be handled specially by a `RB.LicenseView` subclass, and `call_args`, which will be included in an action call back to the License Provider when clicked. License action handlers can provide new license action updates, just like a Check Update request, by returning `license_infos` in the response. It can also redirect to a URL by providing `redirect_urls`. This makes it possible for an action to begin a more involved license-related flow kicked off by the License Provider and going through other servers or URLs. Since actions are more dynamic now, we no longer hard-code the Manage License and Upload License actions within `RB.LicenseView`. Instead, `BaseLicenseProvider.get_license_actions()` now registers these by default, and subclasses can override them or reposition them. Since the Upload License action is special, `RB.LicenseView` still needs to handle it specially. This is now done through `RB.LicenseView.actionBuilders`, which is a mapping of action IDs to custom builder functions. The Upload License handler is registered in this mapping.	e6cc1ff8926f14fe789830dbd4555631c28bfc3c
	Complete the support for custom license actions. Actions are no longer hard-coded client-side, and custom actions no longer require subclassing `RB.LicenseView`. A registered action can now provide `extra_data`, which can be handled specially by a `RB.LicenseView` subclass, and `call_args`, which will be included in an action call back to the License Provider when clicked. License action handlers can provide new license action updates, just like a Check Update request, by returning `license_infos` in the response. It can also redirect to a URL by providing `redirect_urls`. This makes it possible for an action to begin a more involved license-related flow kicked off by the License Provider and going through other servers or URLs. Since actions are more dynamic now, we no longer hard-code the Manage License and Upload License actions within `RB.LicenseView`. Instead, `BaseLicenseProvider.get_license_actions()` now registers these by default, and subclasses can override them or reposition them. Since the Upload License action is special, `RB.LicenseView` still needs to handle it specially. This is now done through `RB.LicenseView.actionBuilders`, which is a mapping of action IDs to custom builder functions. The Upload License handler is registered in this mapping.	64100d85ff645b637c7139376f1e3b6a6f04f7bd

Diff:

Revision 5 (+292 -48)

Show changes

	reviewboard/licensing/actions.py
	reviewboard/licensing/provider.py
	reviewboard/static/rb/js/admin/models/licenseModel.ts
	reviewboard/static/rb/js/admin/views/licenseView.ts
	reviewboard/static/rb/js/admin/views/tests/licenseViewTests.ts

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-7.1.x (0b3baee)