Summary

Allow DJBLETS_HEALTHCHECK_IPS to list subnets.

Review Request #14579 — Created Sept. 1, 2025 and submitted Sept. 4, 2025, 2:20 p.m.

Information

Owner

david

Repository

Djblets

Branch

release-5.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

In some larger setups, the individual IP of the management node for a
cluster may not be fixed. This makes it very annoying to set the allowed
IP whitelist for the healthcheck endpoint.

This change makes it so the DJBLETS_HEALTHCHECK_IPS setting is now
formally a comma-separated list which can include either individual IP
addresses or CIDR subnets.

This change also adds unit tests for the healthcheck endpoint, which
didn't have any.

Testing Done


Verified that both individual IP and subnet matching worked as

  expected.
Ran unit tests.

Commits

Summary	ID
Allow DJBLETS_HEALTHCHECK_IPS to list subnets. In some larger setups, the individual IP of the management node for a cluster may not be fixed. This makes it very annoying to set the allowed IP whitelist for the healthcheck endpoint. This change makes it so the `DJBLETS_HEALTHCHECK_IPS` setting is now formally a comma-separated list which can include either individual IP addresses or CIDR subnets. This change also adds unit tests for the healthcheck endpoint, which didn't have any. Testing Done: - Verified that both individual IP and subnet matching worked as expected. - Ran unit tests.	ozqlwvmxzvoturkzosryzsotxqyyovwq

Summary

Allow DJBLETS_HEALTHCHECK_IPS to list subnets.

In some larger setups, the individual IP of the management node for a cluster may not be fixed. This makes it very annoying to set the allowed IP whitelist for the healthcheck endpoint. This change makes it so the `DJBLETS_HEALTHCHECK_IPS` setting is now formally a comma-separated list which can include either individual IP addresses or CIDR subnets. This change also adds unit tests for the healthcheck endpoint, which didn't have any. Testing Done: - Verified that both individual IP and subnet matching worked as expected. - Ran unit tests.

ozqlwvmxzvoturkzosryzsotxqyyovwq

Issues

Description	From	Last Updated
line too long (81 > 79 characters) Column: 80 Error code: E501	reviewbot	Sept. 1, 2025, 3:11 p.m.
continuation line over-indented for hanging indent Column: 17 Error code: E126	reviewbot	Sept. 1, 2025, 3:11 p.m.
continuation line unaligned for hanging indent Column: 13 Error code: E131	reviewbot	Sept. 1, 2025, 3:11 p.m.
Given the discussion in Slack, we can probably just make this all 5.3. I don't think we need to actually …	chipx86	Sept. 2, 2025, 2:48 p.m.
This should be in the same import group.	chipx86	Sept. 2, 2025, 2:48 p.m.
Missing Returns and Version Added.	chipx86	Sept. 2, 2025, 2:49 p.m.
Same note as above re: version.	chipx86	Sept. 2, 2025, 2:49 p.m.
These might be better in a setUpClass(). Also, we need to set the types above and null these out in …	chipx86	Sept. 2, 2025, 2:50 p.m.
No trailing period here or in the following tests.	chipx86	Sept. 2, 2025, 2:51 p.m.
We should check the logs.	chipx86	Sept. 2, 2025, 3:35 p.m.
Don't tests already use the local memory cache by default? I noticed some tests are using this and some aren't.	chipx86	Sept. 2, 2025, 2:52 p.m.
This can be assertJSONEqual(). Here and below.	chipx86	Sept. 2, 2025, 2:54 p.m.
This should check the logs.	chipx86	Sept. 2, 2025, 3:36 p.m.
Missing a trailing period.	chipx86	Sept. 2, 2025, 2:54 p.m.
This should check the logs.	chipx86	Sept. 2, 2025, 3:35 p.m.
This should check the logs.	chipx86	Sept. 2, 2025, 3:35 p.m.
This should check the logs.	chipx86	Sept. 2, 2025, 3:35 p.m.
Can you update the description and add a Version Changed (for 5.3) stating what's accepted for the setting? My fault, …	chipx86	Sept. 2, 2025, 3:07 p.m.
Blank line before this.	chipx86	Sept. 2, 2025, 3:07 p.m.
The other logs in here prefix as "Health check:"	chipx86	Sept. 2, 2025, 3:08 p.m.
This is missing the "Health check:" prefix.	chipx86	Sept. 2, 2025, 3:08 p.m.
This is missing the "Health check:" prefix.	chipx86	Sept. 2, 2025, 3:08 p.m.
These are missing a Version Added.	chipx86	Sept. 2, 2025, 3:08 p.m.
This should be 5.3	maubin	Sept. 2, 2025, 9:57 p.m.
"Django".	chipx86	Sept. 4, 2025, 2:20 p.m.

flake8 failed.

JSHint passed.

flake8

djblets/util/tests/test_views.py (Diff revision 1)
The issue has been resolved. Show all issues
```
line too long (81 > 79 characters)

Column: 80
Error code: E501
```
djblets/util/tests/test_views.py (Diff revision 1)
The issue has been resolved. Show all issues
```
continuation line over-indented for hanging indent

Column: 17
Error code: E126
```
djblets/util/tests/test_views.py (Diff revision 1)
The issue has been resolved. Show all issues
```
continuation line unaligned for hanging indent

Column: 13
Error code: E131
```

Commits:

	Summary	ID
	Allow DJBLETS_HEALTHCHECK_IPS to list subnets. In some larger setups, the individual IP of the management node for a cluster may not be fixed. This makes it very annoying to set the allowed IP whitelist for the healthcheck endpoint. This change makes it so the `DJBLETS_HEALTHCHECK_IPS` setting is now formally a comma-separated list which can include either individual IP addresses or CIDR subnets. This change also adds unit tests for the healthcheck endpoint, which didn't have any. Testing Done: - Verified that both individual IP and subnet matching worked as expected. - Ran unit tests.	ozqlwvmxzvoturkzosryzsotxqyyovwq
	Allow DJBLETS_HEALTHCHECK_IPS to list subnets. In some larger setups, the individual IP of the management node for a cluster may not be fixed. This makes it very annoying to set the allowed IP whitelist for the healthcheck endpoint. This change makes it so the `DJBLETS_HEALTHCHECK_IPS` setting is now formally a comma-separated list which can include either individual IP addresses or CIDR subnets. This change also adds unit tests for the healthcheck endpoint, which didn't have any. Testing Done: - Verified that both individual IP and subnet matching worked as expected. - Ran unit tests.	ozqlwvmxzvoturkzosryzsotxqyyovwq

Diff:

Revision 2 (+990 -26)

Show changes

	djblets/util/views.py
	djblets/util/tests/test_views.py
	tests/settings.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:


Fix expected type of DJBLETS_HEALTHCHECK_IPS
Improve error handling when the setting isn't correct.

Commits:

	Summary	ID
	Allow DJBLETS_HEALTHCHECK_IPS to list subnets. In some larger setups, the individual IP of the management node for a cluster may not be fixed. This makes it very annoying to set the allowed IP whitelist for the healthcheck endpoint. This change makes it so the `DJBLETS_HEALTHCHECK_IPS` setting is now formally a comma-separated list which can include either individual IP addresses or CIDR subnets. This change also adds unit tests for the healthcheck endpoint, which didn't have any. Testing Done: - Verified that both individual IP and subnet matching worked as expected. - Ran unit tests.	ozqlwvmxzvoturkzosryzsotxqyyovwq
	Allow DJBLETS_HEALTHCHECK_IPS to list subnets. In some larger setups, the individual IP of the management node for a cluster may not be fixed. This makes it very annoying to set the allowed IP whitelist for the healthcheck endpoint. This change makes it so the `DJBLETS_HEALTHCHECK_IPS` setting is now formally a comma-separated list which can include either individual IP addresses or CIDR subnets. This change also adds unit tests for the healthcheck endpoint, which didn't have any. Testing Done: - Verified that both individual IP and subnet matching worked as expected. - Ran unit tests.	ozqlwvmxzvoturkzosryzsotxqyyovwq

Diff:

Revision 3 (+1022 -26)

Show changes

	djblets/util/views.py
	djblets/util/tests/test_views.py
	tests/settings.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

djblets/util/tests/test_views.py (Diff revision 3)

The issue has been resolved. Show all issues

Given the discussion in Slack, we can probably just make this all 5.3. I don't think we need to actually land on 4.0.x if we're just providing customer backports.

If we do keep this here, it'll need to be 4.1, since it's adding new functionality.

djblets/util/tests/test_views.py (Diff revision 3)
The issue has been resolved. Show all issues
```
This should be in the same import group.
```
djblets/util/tests/test_views.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Missing Returns and Version Added.
```
djblets/util/tests/test_views.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Same note as above re: version.
```

djblets/util/tests/test_views.py (Diff revision 3)

The issue has been resolved. Show all issues

These might be better in a setUpClass().

Also, we need to set the types above and null these out in a teardown.

djblets/util/tests/test_views.py (Diff revision 3)
The issue has been resolved. Show all issues
```
No trailing period here or in the following tests.
```
djblets/util/tests/test_views.py (Diff revision 3)
The issue has been resolved. Show all issues
```
We should check the logs.
```

djblets/util/tests/test_views.py (Diff revision 3)

The issue has been dropped. Show all issues

Don't tests already use the local memory cache by default? I noticed some tests are using this and some aren't.

david Sept. 2, 2025, 3:37 p.m.

They should, but this is here to explicitly test the results with certain settings values.

djblets/util/tests/test_views.py (Diff revision 3)
The issue has been resolved. Show all issues
```
This can be assertJSONEqual(). Here and below.
```
djblets/util/tests/test_views.py (Diff revision 3)
The issue has been resolved. Show all issues
```
This should check the logs.
```
djblets/util/tests/test_views.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Missing a trailing period.
```
djblets/util/tests/test_views.py (Diff revision 3)
The issue has been resolved. Show all issues
```
This should check the logs.
```
djblets/util/tests/test_views.py (Diff revision 3)
The issue has been resolved. Show all issues
```
This should check the logs.
```
djblets/util/tests/test_views.py (Diff revision 3)
The issue has been resolved. Show all issues
```
This should check the logs.
```
djblets/util/views.py (Diff revision 3)
```
Neat. TIL.
```

djblets/util/views.py (Diff revision 3)

The issue has been resolved. Show all issues

Can you update the description and add a Version Changed (for 5.3) stating what's accepted for the setting?

My fault, but we should also mention the setting in the first place.

djblets/util/views.py (Diff revision 3)
The issue has been resolved. Show all issues
```
Blank line before this.
```
djblets/util/views.py (Diff revision 3)
The issue has been resolved. Show all issues
```
The other logs in here prefix as "Health check:"
```
djblets/util/views.py (Diff revision 3)
The issue has been resolved. Show all issues
```
This is missing the "Health check:" prefix.
```
djblets/util/views.py (Diff revision 3)
The issue has been resolved. Show all issues
```
This is missing the "Health check:" prefix.
```
djblets/util/views.py (Diff revision 3)
The issue has been resolved. Show all issues
```
These are missing a Version Added.
```

Commits:

	Summary	ID
	Allow DJBLETS_HEALTHCHECK_IPS to list subnets. In some larger setups, the individual IP of the management node for a cluster may not be fixed. This makes it very annoying to set the allowed IP whitelist for the healthcheck endpoint. This change makes it so the `DJBLETS_HEALTHCHECK_IPS` setting is now formally a comma-separated list which can include either individual IP addresses or CIDR subnets. This change also adds unit tests for the healthcheck endpoint, which didn't have any. Testing Done: - Verified that both individual IP and subnet matching worked as expected. - Ran unit tests.	ozqlwvmxzvoturkzosryzsotxqyyovwq
	Allow DJBLETS_HEALTHCHECK_IPS to list subnets. In some larger setups, the individual IP of the management node for a cluster may not be fixed. This makes it very annoying to set the allowed IP whitelist for the healthcheck endpoint. This change makes it so the `DJBLETS_HEALTHCHECK_IPS` setting is now formally a comma-separated list which can include either individual IP addresses or CIDR subnets. This change also adds unit tests for the healthcheck endpoint, which didn't have any. Testing Done: - Verified that both individual IP and subnet matching worked as expected. - Ran unit tests.	ozqlwvmxzvoturkzosryzsotxqyyovwq

Branch:

release-4.x

release-5.x

Diff:

Revision 4 (+1104 -26)

Show changes

	djblets/util/views.py
	djblets/util/tests/test_views.py
	tests/settings.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

djblets/util/views.py (Diff revision 4)
The issue has been resolved. Show all issues
```
This should be 5.3
```

Commits:

	Summary	ID
	Allow DJBLETS_HEALTHCHECK_IPS to list subnets. In some larger setups, the individual IP of the management node for a cluster may not be fixed. This makes it very annoying to set the allowed IP whitelist for the healthcheck endpoint. This change makes it so the `DJBLETS_HEALTHCHECK_IPS` setting is now formally a comma-separated list which can include either individual IP addresses or CIDR subnets. This change also adds unit tests for the healthcheck endpoint, which didn't have any. Testing Done: - Verified that both individual IP and subnet matching worked as expected. - Ran unit tests.	ozqlwvmxzvoturkzosryzsotxqyyovwq
	Allow DJBLETS_HEALTHCHECK_IPS to list subnets. In some larger setups, the individual IP of the management node for a cluster may not be fixed. This makes it very annoying to set the allowed IP whitelist for the healthcheck endpoint. This change makes it so the `DJBLETS_HEALTHCHECK_IPS` setting is now formally a comma-separated list which can include either individual IP addresses or CIDR subnets. This change also adds unit tests for the healthcheck endpoint, which didn't have any. Testing Done: - Verified that both individual IP and subnet matching worked as expected. - Ran unit tests.	ozqlwvmxzvoturkzosryzsotxqyyovwq

Diff:

Revision 5 (+1104 -26)

Show changes

	djblets/util/views.py
	djblets/util/tests/test_views.py
	tests/settings.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

djblets/util/views.py (Diff revision 5)
The issue has been resolved. Show all issues
```
"Django".
```

Status:: Completed
Change Summary:: Pushed to release-5.x (08fa8c8)