starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Move table template code to separate HTML files #8411

New Issue
Open
opened 2025-12-29 20:36:22 +01:00 by adam · 8 comments
adam commented 2025-12-29 20:36:22 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Aug 3, 2023).

Proposed Changes

Move all Django template code used to render table columns into discrete HTML files. For example, the IP addresses table has an address column which references the following template code, stored in a variable:

IPADDRESS_LINK = """
{% if record.pk %}
    <a href="{{ record.get_absolute_url }}" id="ipaddress_{{ record.pk }}">{{ record.address }}</a>
{% elif perms.ipam.add_ipaddress %}
    <a href="{% url 'ipam:ipaddress_add' %}?address={{ record.1 }}{% if object.vrf %}&vrf={{ object.vrf.pk }}{% endif %}{% if object.tenant %}&tenant={{ object.tenant.pk }}{% endif %}" class="btn btn-sm btn-success">{% if record.0 <= 65536 %}{{ record.0 }}{% else %}Many{% endif %} IP{{ record.0|pluralize }} available</a>
{% else %}
    {% if record.0 <= 65536 %}{{ record.0 }}{% else %}Many{% endif %} IP{{ record.0|pluralize }} available
{% endif %}
"""

This code, and similar blobs, would be moved to its own HTML file to be included by the table.

Justification

This better separates template code from application logic, and provides a cleaner approach to working with the template content.

We have experimented with this approach in the past and encountered performance issues, although that was years ago. We'll need to do some testing to ensure that the proposal is in fact viable.

Originally created by @jeremystretch on GitHub (Aug 3, 2023). ### Proposed Changes Move all Django template code used to render table columns into discrete HTML files. For example, the IP addresses table has an `address` column which references the following template code, stored in a variable: ```python IPADDRESS_LINK = """ {% if record.pk %} <a href="{{ record.get_absolute_url }}" id="ipaddress_{{ record.pk }}">{{ record.address }}</a> {% elif perms.ipam.add_ipaddress %} <a href="{% url 'ipam:ipaddress_add' %}?address={{ record.1 }}{% if object.vrf %}&vrf={{ object.vrf.pk }}{% endif %}{% if object.tenant %}&tenant={{ object.tenant.pk }}{% endif %}" class="btn btn-sm btn-success">{% if record.0 <= 65536 %}{{ record.0 }}{% else %}Many{% endif %} IP{{ record.0|pluralize }} available</a> {% else %} {% if record.0 <= 65536 %}{{ record.0 }}{% else %}Many{% endif %} IP{{ record.0|pluralize }} available {% endif %} """ ``` This code, and similar blobs, would be moved to its own HTML file to be included by the table. ### Justification This better separates template code from application logic, and provides a cleaner approach to working with the template content. We have experimented with this approach in the past and encountered performance issues, although that was years ago. We'll need to do some testing to ensure that the proposal is in fact viable.
adam added the type: housekeepingnetboxstatus: backlog labels 2025-12-29 20:36:22 +01:00
adam commented 2025-12-29 20:36:23 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Nov 2, 2023):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Nov 2, 2023): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 20:36:23 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (Nov 22, 2023):

Some code for timing these - bash script to call Django logged in page:

LOGIN_URL='http://localhost:8000/login/'
YOUR_USER='xxx'
YOUR_PASS='xxx'
COOKIES=cookies.txt
CURL_BIN="curl -s -c $COOKIES -b $COOKIES -e $LOGIN_URL"

echo -n "Django Auth: get csrftoken ..."
$CURL_BIN $LOGIN_URL > /dev/null
DJANGO_TOKEN="csrfmiddlewaretoken=$(grep csrftoken $COOKIES | sed 's/^.*csrftoken[[:space:]]*//')"

echo -n " perform login ..."
$CURL_BIN \
    -d "$DJANGO_TOKEN&username=$YOUR_USER&password=$YOUR_PASS" \
    -X POST $LOGIN_URL

echo -n " calling IP Address list ..."
$CURL_BIN \
    -w "@curl-format.txt" -o /dev/null \
    -d "$DJANGO_TOKEN&..." \
    -X GET http://localhost:8000/ipam/ip-addresses/?per_page=1000

echo " logout"
rm $COOKIES

curl-format.txt:

     time_namelookup:  %{time_namelookup}s\n
        time_connect:  %{time_connect}s\n
     time_appconnect:  %{time_appconnect}s\n
    time_pretransfer:  %{time_pretransfer}s\n
       time_redirect:  %{time_redirect}s\n
  time_starttransfer:  %{time_starttransfer}s\n
                     ----------\n
          time_total:  %{time_total}s\n
@arthanson commented on GitHub (Nov 22, 2023): Some code for timing these - bash script to call Django logged in page: ``` LOGIN_URL='http://localhost:8000/login/' YOUR_USER='xxx' YOUR_PASS='xxx' COOKIES=cookies.txt CURL_BIN="curl -s -c $COOKIES -b $COOKIES -e $LOGIN_URL" echo -n "Django Auth: get csrftoken ..." $CURL_BIN $LOGIN_URL > /dev/null DJANGO_TOKEN="csrfmiddlewaretoken=$(grep csrftoken $COOKIES | sed 's/^.*csrftoken[[:space:]]*//')" echo -n " perform login ..." $CURL_BIN \ -d "$DJANGO_TOKEN&username=$YOUR_USER&password=$YOUR_PASS" \ -X POST $LOGIN_URL echo -n " calling IP Address list ..." $CURL_BIN \ -w "@curl-format.txt" -o /dev/null \ -d "$DJANGO_TOKEN&..." \ -X GET http://localhost:8000/ipam/ip-addresses/?per_page=1000 echo " logout" rm $COOKIES ``` curl-format.txt: ``` time_namelookup: %{time_namelookup}s\n time_connect: %{time_connect}s\n time_appconnect: %{time_appconnect}s\n time_pretransfer: %{time_pretransfer}s\n time_redirect: %{time_redirect}s\n time_starttransfer: %{time_starttransfer}s\n ----------\n time_total: %{time_total}s\n ```
adam commented 2025-12-29 20:36:24 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Nov 22, 2023):

This can be greatly simplified by adding 'ipam.ipaddress' to EXEMPT_VIEW_PERMISSIONS, which obviates the need for authentication.

Also, the IP addresses list is fairly unique in that it invoked additional logic to annotate available space among IPs, which induces additional overhead. We should select a different object for a cleaner evaluation of the change's impact.

@jeremystretch commented on GitHub (Nov 22, 2023): This can be greatly simplified by adding `'ipam.ipaddress'` to `EXEMPT_VIEW_PERMISSIONS`, which obviates the need for authentication. Also, the IP addresses list is fairly unique in that it invoked additional logic to annotate available space among IPs, which induces additional overhead. We should select a different object for a cleaner evaluation of the change's impact.
adam commented 2025-12-29 20:36:24 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (Nov 22, 2023):

Interfaces has three templated columns - with inline code 200 records ~0.9s, with template files ~15.4s, also had some weird very long timings when I first switched to the template files but wasn't able to get those again even trying to clear any potential caches. Over 15x slower using the template files.

With per_page=1000 inline=3.8s template files=78s so it's not a fixed overhead as this is 20x slower. Looks like django-tables2 is reinitializing the template each row or something. So this is a no-go for now, will look at a repo scenario and file a bug/FR in django-tables2.

@arthanson commented on GitHub (Nov 22, 2023): Interfaces has three templated columns - with inline code 200 records ~0.9s, with template files ~15.4s, also had some weird very long timings when I first switched to the template files but wasn't able to get those again even trying to clear any potential caches. Over 15x slower using the template files. With per_page=1000 inline=3.8s template files=78s so it's not a fixed overhead as this is 20x slower. Looks like django-tables2 is reinitializing the template each row or something. So this is a no-go for now, will look at a repo scenario and file a bug/FR in django-tables2.
adam commented 2025-12-29 20:36:24 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Mar 7, 2024):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Mar 7, 2024): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 20:36:24 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (Jun 5, 2024):

Tried a demo program to show the issue, but actually the templated columns in separate HTML file is slightly faster. Will need to try one line at a time in the NB app to narrow down what is causing the slowness.
mysite.zip

@arthanson commented on GitHub (Jun 5, 2024): Tried a demo program to show the issue, but actually the templated columns in separate HTML file is slightly faster. Will need to try one line at a time in the NB app to narrow down what is causing the slowness. [mysite.zip](https://github.com/user-attachments/files/15592275/mysite.zip)
adam commented 2025-12-29 20:36:25 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Mar 14, 2025):

I'm opening this up to dig into again, as it doesn't appear to be strictly blocked by any outstanding issues.

@jeremystretch commented on GitHub (Mar 14, 2025): I'm opening this up to dig into again, as it doesn't appear to be strictly blocked by any outstanding issues.
adam commented 2025-12-29 20:36:25 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Jun 13, 2025):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Jun 13, 2025): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/main/CONTRIBUTING.md).
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label netbox status: backlog type: housekeeping
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#8411
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?