Summary

Rework some core licensing stubs and prepare for new license actions.

Review Request #14401 — Created April 21, 2025 and updated May 21, 2025, 8:49 p.m.

Information

Owner

chipx86

Repository

Review Board

Branch

release-7.1.x

Bugs

Depends On

Blocks

14404

Reviewers

Groups

reviewboard

People

Description

License has been updated to provide consistent expiration-related
information, factoring in hard expiration dates, grace periods, and
"expires soon" logic.

LicenseStatus constants have been renamed to go with
licensed/unlicensed terms and expired-based terms.

There are new classes, errors, and stubs for license update checks and
for license actions (which will include things like manually uploading a
license).

License check updates will be driven in an upcoming change. The process
involves asking the License Provider for a license check payload,
sending that payload to an outside server, then passing the result back
to the License Provider for processing.

Type hints have been updated to utilize | instead of Union.

Upcoming changes will begin to flesh out more of this, and add UI around
license displays.

Testing Done

Unit tests pass.

Tested this along with in-progress changes, verifying all these new
capabilities being stubbed out in this change.

Commits

Summary	ID
Rework some core licensing stubs and prepare for new license actions. `License` has been updated to provide consistent expiration-related information, factoring in hard expiration dates, grace periods, and "expires soon" logic. `LicenseStatus` constants have been renamed to go with licensed/unlicensed terms and expired-based terms. There are new classes, errors, and stubs for license update checks and for license actions (which will include things like manually uploading a license). License check updates will be driven in an upcoming change. The process involves asking the License Provider for a license check payload, sending that payload to an outside server, then passing the result back to the License Provider for processing. Type hints have been updated to utilize `\|` instead of `Union`. Upcoming changes will begin to flesh out more of this, and add UI around license displays.	9c7405e1255632c833a2a031655137938a0dfc64

Summary

Rework some core licensing stubs and prepare for new license actions.

`License` has been updated to provide consistent expiration-related information, factoring in hard expiration dates, grace periods, and "expires soon" logic. `LicenseStatus` constants have been renamed to go with licensed/unlicensed terms and expired-based terms. There are new classes, errors, and stubs for license update checks and for license actions (which will include things like manually uploading a license). License check updates will be driven in an upcoming change. The process involves asking the License Provider for a license check payload, sending that payload to an outside server, then passing the result back to the License Provider for processing. Type hints have been updated to utilize `|` instead of `Union`. Upcoming changes will begin to flesh out more of this, and add UI around license displays.

9c7405e1255632c833a2a031655137938a0dfc64

Issues

Description	From	Last Updated
'datetime.timedelta' imported but unused Column: 1 Error code: F401	reviewbot	April 21, 2025, 12:24 a.m.
'django.utils.html.format_html' imported but unused Column: 1 Error code: F401	reviewbot	April 21, 2025, 12:24 a.m.
'reviewboard.licensing.errors.LicenseActionError' imported but unused Column: 1 Error code: F401	reviewbot	April 21, 2025, 12:25 a.m.
'reviewboard.licensing.license.LicenseStatus' imported but unused Column: 1 Error code: F401	reviewbot	April 21, 2025, 12:25 a.m.
redefinition of unused 'datetime' from line 9 Column: 5 Error code: F811	reviewbot	April 21, 2025, 12:25 a.m.
'datetime.datetime' imported but unused Column: 5 Error code: F401	reviewbot	April 21, 2025, 12:25 a.m.
'djblets.util.typing.SerializableJSONDict' imported but unused Column: 5 Error code: F401	reviewbot	April 21, 2025, 12:25 a.m.
'djblets.util.typing.SerializableJSONList' imported but unused Column: 5 Error code: F401	reviewbot	April 21, 2025, 12:25 a.m.
Mind changing this to use \| syntax?	david	April 24, 2025, 8:05 p.m.
Mind changing this to use \| syntax?	david	April 24, 2025, 8:05 p.m.
Should we make this (and get_expires_soon_days_threshold) properties?	david	April 25, 2025, 7:58 a.m.
Can we add a TODO comment to switch to StrEnum when we're 3.11+?	david	April 24, 2025, 8:09 p.m.
This needs a docstring.	david	April 24, 2025, 8:09 p.m.
'djblets.util.typing.SerializableJSONValue' imported but unused Column: 5 Error code: F401	reviewbot	April 24, 2025, 8:29 p.m.
'reviewboard.licensing.license_checks.RRequestCheckLicenseResult' imported but unused Column: 5 Error code: F401	reviewbot	April 24, 2025, 8:29 p.m.
redefinition of unused 'RequestCheckLicenseResult' from line 14 Column: 5 Error code: F811	reviewbot	April 24, 2025, 8:30 p.m.
Typo: licene	maubin	May 21, 2025, 8:49 p.m.

flake8 failed.

JSHint passed.

flake8

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

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

Column: 1
Error code: F401
```

reviewboard/licensing/provider.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/provider.py (Diff revision 1)

The issue has been resolved. Show all issues

'reviewboard.licensing.license.LicenseStatus' imported but unused

Column: 1
Error code: F401

reviewboard/licensing/provider.py (Diff revision 1)
The issue has been resolved. Show all issues
```
redefinition of unused 'datetime' from line 9

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

Column: 5
Error code: F401
```

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

The issue has been resolved. Show all issues

'djblets.util.typing.SerializableJSONDict' imported but unused

Column: 5
Error code: F401

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

The issue has been resolved. Show all issues

'djblets.util.typing.SerializableJSONList' imported but unused

Column: 5
Error code: F401

Change Summary:

Removed unused imports.

Commits:

	Summary	ID
	Rework some core licensing stubs and prepare for new license actions. `License` has been updated to provide consistent expiration-related information, factoring in hard expiration dates, grace periods, and "expires soon" logic. `LicenseStatus` constants have been renamed to go with licensed/unlicensed terms and expired-based terms. There are new classes, errors, and stubs for license update checks and for license actions (which will include things like manually uploading a license). License check updates will be driven in an upcoming change. The process involves asking the License Provider for a license check payload, sending that payload to an outside server, then passing the result back to the License Provider for processing. Type hints have been updated to utilize `\|` instead of `Union`. Upcoming changes will begin to flesh out more of this, and add UI around license displays.	11705549fc4dadf6a836bc38c1d471608f2d92ca
	Rework some core licensing stubs and prepare for new license actions. `License` has been updated to provide consistent expiration-related information, factoring in hard expiration dates, grace periods, and "expires soon" logic. `LicenseStatus` constants have been renamed to go with licensed/unlicensed terms and expired-based terms. There are new classes, errors, and stubs for license update checks and for license actions (which will include things like manually uploading a license). License check updates will be driven in an upcoming change. The process involves asking the License Provider for a license check payload, sending that payload to an outside server, then passing the result back to the License Provider for processing. Type hints have been updated to utilize `\|` instead of `Union`. Upcoming changes will begin to flesh out more of this, and add UI around license displays.	f0298a734d28ce2998231606c8402486237a3e59

Diff:

Revision 2 (+820 -72)

Show changes

	docs/manual/extending/coderef/index.rst
	reviewboard/licensing/errors.py
	reviewboard/licensing/license.py
	reviewboard/licensing/license_checks.py
	reviewboard/licensing/provider.py
	reviewboard/licensing/tests/__init__.py
	reviewboard/licensing/tests/test_license_info.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

reviewboard/licensing/license.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Mind changing this to use | syntax?
```
reviewboard/licensing/license.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Mind changing this to use | syntax?
```

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

The issue has been dropped. Show all issues

Should we make this (and get_expires_soon_days_threshold) properties?

chipx86 April 22, 2025, 2:59 p.m.

They initially were. I ended up changing them to methods just to help distinguish fixed values in the dataclass from attributes with dynamic results. But I'm not married to it.

chipx86 April 24, 2025, 8:28 p.m.

Been thinking about this, and I think because this method in particular may change results every time you call it (time-based), I'd like to keep it a function so it doesn't have the same static feel as the other properties on this class. The threshold one, I could go either way.

david April 25, 2025, 7:58 a.m.
```
OK, sure.
```

reviewboard/licensing/license_checks.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Can we add a TODO comment to switch to StrEnum when we're 3.11+?
```
reviewboard/licensing/tests/test_license_info.py (Diff revision 2)
The issue has been resolved. Show all issues
```
This needs a docstring.
```

Change Summary:


Altered the license check requests to return a new payload and to centralize functions.
get_license_actions() no longer returns any default actions.
Switched more types to | union syntax.
Added a missing docstring and a TODO.

Commits:

	Summary	ID
	Rework some core licensing stubs and prepare for new license actions. `License` has been updated to provide consistent expiration-related information, factoring in hard expiration dates, grace periods, and "expires soon" logic. `LicenseStatus` constants have been renamed to go with licensed/unlicensed terms and expired-based terms. There are new classes, errors, and stubs for license update checks and for license actions (which will include things like manually uploading a license). License check updates will be driven in an upcoming change. The process involves asking the License Provider for a license check payload, sending that payload to an outside server, then passing the result back to the License Provider for processing. Type hints have been updated to utilize `\|` instead of `Union`. Upcoming changes will begin to flesh out more of this, and add UI around license displays.	f0298a734d28ce2998231606c8402486237a3e59
	Rework some core licensing stubs and prepare for new license actions. `License` has been updated to provide consistent expiration-related information, factoring in hard expiration dates, grace periods, and "expires soon" logic. `LicenseStatus` constants have been renamed to go with licensed/unlicensed terms and expired-based terms. There are new classes, errors, and stubs for license update checks and for license actions (which will include things like manually uploading a license). License check updates will be driven in an upcoming change. The process involves asking the License Provider for a license check payload, sending that payload to an outside server, then passing the result back to the License Provider for processing. Type hints have been updated to utilize `\|` instead of `Union`. Upcoming changes will begin to flesh out more of this, and add UI around license displays.	327bb61425fb92a0c9172c058dc0fe82d3059cf8

Diff:

Revision 3 (+870 -114)

Show changes

	docs/manual/extending/coderef/index.rst
	reviewboard/licensing/errors.py
	reviewboard/licensing/license.py
	reviewboard/licensing/license_checks.py
	reviewboard/licensing/provider.py
	reviewboard/licensing/tests/__init__.py
	reviewboard/licensing/tests/test_license_info.py

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

'djblets.util.typing.SerializableJSONValue' imported but unused

Column: 5
Error code: F401

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

The issue has been resolved. Show all issues

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

Column: 5
Error code: F401

Change Summary:

Removed unused imports and fixed a typo in a typing import.

Commits:

	Summary	ID
	Rework some core licensing stubs and prepare for new license actions. `License` has been updated to provide consistent expiration-related information, factoring in hard expiration dates, grace periods, and "expires soon" logic. `LicenseStatus` constants have been renamed to go with licensed/unlicensed terms and expired-based terms. There are new classes, errors, and stubs for license update checks and for license actions (which will include things like manually uploading a license). License check updates will be driven in an upcoming change. The process involves asking the License Provider for a license check payload, sending that payload to an outside server, then passing the result back to the License Provider for processing. Type hints have been updated to utilize `\|` instead of `Union`. Upcoming changes will begin to flesh out more of this, and add UI around license displays.	327bb61425fb92a0c9172c058dc0fe82d3059cf8
	Rework some core licensing stubs and prepare for new license actions. `License` has been updated to provide consistent expiration-related information, factoring in hard expiration dates, grace periods, and "expires soon" logic. `LicenseStatus` constants have been renamed to go with licensed/unlicensed terms and expired-based terms. There are new classes, errors, and stubs for license update checks and for license actions (which will include things like manually uploading a license). License check updates will be driven in an upcoming change. The process involves asking the License Provider for a license check payload, sending that payload to an outside server, then passing the result back to the License Provider for processing. Type hints have been updated to utilize `\|` instead of `Union`. Upcoming changes will begin to flesh out more of this, and add UI around license displays.	8bc4dbbf8a71fc98e7ba0aa66266e9c6ecb5fd2f

Diff:

Revision 4 (+866 -116)

Show changes

	docs/manual/extending/coderef/index.rst
	reviewboard/licensing/errors.py
	reviewboard/licensing/license.py
	reviewboard/licensing/license_checks.py
	reviewboard/licensing/provider.py
	reviewboard/licensing/tests/__init__.py
	reviewboard/licensing/tests/test_license_info.py

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

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

The issue has been resolved. Show all issues

redefinition of unused 'RequestCheckLicenseResult' from line 14

Column: 5
Error code: F811

Change Summary:

Removed an extra import my editor helpfully added...

Commits:

	Summary	ID
	Rework some core licensing stubs and prepare for new license actions. `License` has been updated to provide consistent expiration-related information, factoring in hard expiration dates, grace periods, and "expires soon" logic. `LicenseStatus` constants have been renamed to go with licensed/unlicensed terms and expired-based terms. There are new classes, errors, and stubs for license update checks and for license actions (which will include things like manually uploading a license). License check updates will be driven in an upcoming change. The process involves asking the License Provider for a license check payload, sending that payload to an outside server, then passing the result back to the License Provider for processing. Type hints have been updated to utilize `\|` instead of `Union`. Upcoming changes will begin to flesh out more of this, and add UI around license displays.	8bc4dbbf8a71fc98e7ba0aa66266e9c6ecb5fd2f
	Rework some core licensing stubs and prepare for new license actions. `License` has been updated to provide consistent expiration-related information, factoring in hard expiration dates, grace periods, and "expires soon" logic. `LicenseStatus` constants have been renamed to go with licensed/unlicensed terms and expired-based terms. There are new classes, errors, and stubs for license update checks and for license actions (which will include things like manually uploading a license). License check updates will be driven in an upcoming change. The process involves asking the License Provider for a license check payload, sending that payload to an outside server, then passing the result back to the License Provider for processing. Type hints have been updated to utilize `\|` instead of `Union`. Upcoming changes will begin to flesh out more of this, and add UI around license displays.	9c7405e1255632c833a2a031655137938a0dfc64

Diff:

Revision 5 (+864 -116)

Show changes

	docs/manual/extending/coderef/index.rst
	reviewboard/licensing/errors.py
	reviewboard/licensing/license.py
	reviewboard/licensing/license_checks.py
	reviewboard/licensing/provider.py
	reviewboard/licensing/tests/__init__.py
	reviewboard/licensing/tests/test_license_info.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Ship it! Fix it!

reviewboard/licensing/license_checks.py (Diff revision 5)
An issue was opened. Show all issues
```
Typo: licene
```