JSON serializer issue for Protection Rules defined in configuration.py #10641

New Issue

adam · 2025-12-29T21:34:02+01:00

adam commented

2025-12-29 21:34:02 +01:00

Originally created by @atownson on GitHub (Jan 9, 2025).

Originally assigned to: @atownson on GitHub.

Deployment Type

Self-hosted

Triage priority

N/A

NetBox Version

v4.1.11

Python Version

3.12

Steps to Reproduce

Create a custom Protection_Rule in the configuration.py. Example:

from extras.validators import CustomValidator

# Prevent IP addresses from being deleted by a cascading delete
class IpAddressProtectionRule(CustomValidator):
    def validate(self, instance, request):
        if hasattr(instance, 'primary_ip') and instance.primary_ip is not None:
            self.fail('This instance has a related IP address(es).')


PROTECTION_RULES = {
    'dcim.device': (
        IpAddressProtectionRule(),
    ),
}

Restart NetBox services
Navigate to Admin -> System

Expected Behavior

The system detail page is returned.

Observed Behavior

An exception is thrown:

Originally created by @atownson on GitHub (Jan 9, 2025). Originally assigned to: @atownson on GitHub. ### Deployment Type Self-hosted ### Triage priority N/A ### NetBox Version v4.1.11 ### Python Version 3.12 ### Steps to Reproduce 1. Create a custom `Protection_Rule` in the configuration.py. Example: ``` from extras.validators import CustomValidator # Prevent IP addresses from being deleted by a cascading delete class IpAddressProtectionRule(CustomValidator): def validate(self, instance, request): if hasattr(instance, 'primary_ip') and instance.primary_ip is not None: self.fail('This instance has a related IP address(es).') PROTECTION_RULES = { 'dcim.device': ( IpAddressProtectionRule(), ), } ``` 2. Restart NetBox services 3. Navigate to Admin -> System ### Expected Behavior The system detail page is returned. ### Observed Behavior An exception is thrown: ![image](https://github.com/user-attachments/assets/041d5221-2562-4b68-8b9a-19b495993b44)

adam added the type: bug status: accepted severity: medium labels 2025-12-29 21:34:02 +01:00

adam closed this issue

2025-12-29 21:34:02 +01:00

adam commented

2025-12-29 21:34:03 +01:00

@atownson commented on GitHub (Jan 9, 2025):

I believe the fix for this is to update netbox/netbox/tempates/core/inc/config_data.html as follows:
Current:

...
  <tr>
    <th scope="row" class="border-0 ps-3">{% trans "Protection rules" %}</th>
    {% if config.PROTECTION_RULES %}
      <td class="border-0"><pre>{{ config.PROTECTION_RULES|json }}</pre></td>
    {% else %}
      <td class="border-0">{{ ''|placeholder }}</td>
    {% endif %}
  </tr>
...

Proposed change:

...
  <tr>
    <th scope="row" class="border-0 ps-3">{% trans "Protection rules" %}</th>
    {% if config.PROTECTION_RULES %}
      <td class="border-0"><pre>{{ config.PROTECTION_RULES }}</pre></td>
    {% else %}
      <td class="border-0">{{ ''|placeholder }}</td>
    {% endif %}
  </tr>
...

This will match the CUSTOM_VALIDATORS block above it. I can submit a PR for this if approved.

@atownson commented on GitHub (Jan 9, 2025): I believe the fix for this is to update **netbox/netbox/tempates/core/inc/config_data.html** as follows: Current: ``` ... <tr> <th scope="row" class="border-0 ps-3">{% trans "Protection rules" %}</th> {% if config.PROTECTION_RULES %} <td class="border-0"><pre>{{ config.PROTECTION_RULES|json }}</pre></td> {% else %} <td class="border-0">{{ ''|placeholder }}</td> {% endif %} </tr> ... ``` Proposed change: ``` ... <tr> <th scope="row" class="border-0 ps-3">{% trans "Protection rules" %}</th> {% if config.PROTECTION_RULES %} <td class="border-0"><pre>{{ config.PROTECTION_RULES }}</pre></td> {% else %} <td class="border-0">{{ ''|placeholder }}</td> {% endif %} </tr> ... ``` This will match the CUSTOM_VALIDATORS block above it. I can submit a PR for this if approved.

adam commented

2025-12-29 21:34:03 +01:00

@jeremystretch commented on GitHub (Jan 13, 2025):

Thanks @atownson, I've assigned this to you.

@jeremystretch commented on GitHub (Jan 13, 2025): Thanks @atownson, I've assigned this to you.

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#10641