Use cached ScriptModule objects in Scripts List view #11557

New Issue

adam · 2025-12-29T21:46:43+01:00

adam commented

2025-12-29 21:46:43 +01:00

Originally created by @Nick-Gatti on GitHub (Sep 2, 2025).

NetBox version

v4.3.6

Feature type

Change to existing functionality

Proposed functionality

I'm testing switching over from local file storage of scripts to hosting in an S3 bucket, and noticed an immediate slowdown (~10s) when loading the ScriptListView. From what it looks like, it seems like the view accesses script modules to determine the classes each time it's loaded- which in this case now means that each file gets downloaded from S3 every time. The ScriptModule caches the scripts inside it- could we switch the ListView to access the cached values to avoid redownloading each time?

Use case

Would speed up loading the scripts view page significantly.

Database changes

No response

External dependencies

No response

Originally created by @Nick-Gatti on GitHub (Sep 2, 2025). ### NetBox version v4.3.6 ### Feature type Change to existing functionality ### Proposed functionality I'm testing switching over from local file storage of scripts to hosting in an S3 bucket, and noticed an immediate slowdown (~10s) when loading the ScriptListView. From what it looks like, it seems like the view accesses script modules to determine the classes each time it's loaded- which in this case now means that each file gets downloaded from S3 every time. The ScriptModule caches the scripts inside it- could we switch the ListView to access the cached values to avoid redownloading each time? ### Use case Would speed up loading the scripts view page significantly. ### Database changes _No response_ ### External dependencies _No response_

adam added the type: feature status: needs owner complexity: medium netbox labels 2025-12-29 21:46:43 +01:00

adam commented

2025-12-29 21:46:44 +01:00

@bctiemann commented on GitHub (Sep 4, 2025):

Worth looking into -- need however to ensure that the cache is refreshed whenever the script is changed.

@bctiemann commented on GitHub (Sep 4, 2025): Worth looking into -- need however to ensure that the cache is refreshed whenever the script is changed.

adam commented

2025-12-29 21:46:44 +01:00

@Nick-Gatti commented on GitHub (Sep 4, 2025):

Worth looking into -- need however to ensure that the cache is refreshed whenever the script is changed.

From what I can tell, this is already done with a post_save signal.

@Nick-Gatti commented on GitHub (Sep 4, 2025): > Worth looking into -- need however to ensure that the cache is refreshed whenever the script is changed. From what I can tell, this is already done with a [post_save signal](https://github.com/netbox-community/netbox/blob/ea50786b5c68af6ca7eca91cfde36f8211f6b44b/netbox/extras/models/scripts.py#L192).

adam commented

2025-12-29 21:46:45 +01:00

@ross-cello commented on GitHub (Sep 5, 2025):

The caching might not quite do what one fully expects at present.

If, for example, I change a class within the script (remove, add, rename), this often requires an Edit/Save in UI to propagate those changes on top of a datasource sync.
This at least appears to be the case with a directory datasource. Sync otherwise refreshes the content of said classes.

Looking at that link from @Nick-Gatti, does sync_classes need to be moved inside sync_data as well, or otherwise also called on a datasource sync?

EDIT: Just re-tested on v4.4.0. Still present (Prod is v4.3.2)
Recreated using below, manipulating the classes between syncs. We don't trigger the behaviour often, so have just lived with the workaround.

from extras.scripts import Script

class SomeClass(Script):
    class Meta:
        name = "Some Class"
    def run(self, data, commit):
        return "Nothing to see here. Move along!"

class SomeNewClass(Script):
    class Meta:
        name = "Some New Class"
    def run(self, data, commit):
        return "Nothing to see here. Move along!"

@ross-cello commented on GitHub (Sep 5, 2025): The caching might not quite do what one fully expects at present. If, for example, I change a class within the script (remove, add, rename), this often requires an Edit/Save in UI to propagate those changes on top of a datasource sync. This at least appears to be the case with a directory datasource. Sync otherwise refreshes the content of said classes. Looking at that link from @Nick-Gatti, does `sync_classes` need to be moved inside `sync_data` as well, or otherwise also called on a datasource sync? EDIT: Just re-tested on v4.4.0. Still present (Prod is v4.3.2) Recreated using below, manipulating the classes between syncs. We don't trigger the behaviour often, so have just lived with the workaround. ``` from extras.scripts import Script class SomeClass(Script): class Meta: name = "Some Class" def run(self, data, commit): return "Nothing to see here. Move along!" class SomeNewClass(Script): class Meta: name = "Some New Class" def run(self, data, commit): return "Nothing to see here. Move along!" ```

Sign in to join this conversation.

Branches Tags

main

21050-device-oob-ip-may-become-orphaned

21102-fix-graphiql-explorer

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#11557