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

Invalid import inside plugin code can result in partially loaded plugin #3677

New Issue
Closed
opened 2025-12-29 18:30:33 +01:00 by adam · 2 comments
adam commented 2025-12-29 18:30:33 +01:00
Owner
Copy Link

Originally created by @dgarros on GitHub (May 11, 2020).

Environment

  • Python version: 3.7.7
  • NetBox version: 2.8.3

Steps to Reproduce

  1. Install a plugin that is importing a non valid object, for example in views.py
  2. Start NetBox
  3. Navigate to the plugin section in the admin page (/admin/plugins/installed-plugins/)

Expected Behavior

If a plugin code is not valid an error message should be generated when NetBox is starting and the plugin should be ignored/not installed.

Ideally the error message should provide some information to troubleshoot the issue.

Observed Behavior

When the code of a plugin is not valid, there is no error message visible when NetBox start and the plugin is partially loaded.
The plugin will be listed under /admin/plugins/installed-plugins/
Depending on what is broken and what features the plugin is using it could result in a broken UI too.
In my case the import error was in the views.py file and the plugin included a navigation.py file to add a menu.
The UI was not working anymore because the namespace of the plugin was not properly defined.

NoReverseMatch at /
'netbox_onboarding' is not a registered namespace inside 'plugins'
Originally created by @dgarros on GitHub (May 11, 2020). ### Environment * Python version: 3.7.7 * NetBox version: 2.8.3 ### Steps to Reproduce 1. Install a plugin that is importing a non valid object, for example in views.py 2. Start NetBox 3. Navigate to the plugin section in the admin page (/admin/plugins/installed-plugins/) ### Expected Behavior If a plugin code is not valid an error message should be generated when NetBox is starting and the plugin should be ignored/not installed. Ideally the error message should provide some information to troubleshoot the issue. ### Observed Behavior When the code of a plugin is not valid, there is no error message visible when NetBox start and the plugin is partially loaded. The plugin will be listed under `/admin/plugins/installed-plugins/` Depending on what is broken and what features the plugin is using it could result in a broken UI too. In my case the import error was in the views.py file and the plugin included a navigation.py file to add a menu. The UI was not working anymore because the namespace of the plugin was not properly defined. ``` NoReverseMatch at / 'netbox_onboarding' is not a registered namespace inside 'plugins' ```
adam closed this issue 2025-12-29 18:30:33 +01:00
adam commented 2025-12-29 18:30:33 +01:00
Author
Owner
Copy Link

@lampwins commented on GitHub (May 11, 2020):

I'm not sure what we can really do here as this is simply a side effect of the interpreted nature of Python coupled with some runtime specifics of Django. The fact is, the view module is not imported by Django until the URL path is actually evaluated which occurs on a reverse lookup. In other words, Django doesn't know there is a problem until it actually tries to resolve the URL and I am not aware of a way to force that at startup. I think this really just comes down to the testing burden on the plugin developer.

@lampwins commented on GitHub (May 11, 2020): I'm not sure what we can really do here as this is simply a side effect of the interpreted nature of Python coupled with some runtime specifics of Django. The fact is, the view module is not imported by Django until the URL path is actually evaluated which occurs on a reverse lookup. In other words, Django doesn't know there is a problem until it actually tries to resolve the URL and I am not aware of a way to force that at startup. I think this really just comes down to the testing burden on the plugin developer.
adam commented 2025-12-29 18:30:33 +01:00
Author
Owner
Copy Link

@glennmatthews commented on GitHub (Jun 29, 2020):

At least one place that logging and/or more extensive error handling for plugins would be useful is in extras/plugins/urls.py:

# Register base/API URL patterns for each plugin
for plugin_path in settings.PLUGINS:
    plugin_name = plugin_path.split('.')[-1]
    app = apps.get_app_config(plugin_name)     # GFM: an error in the plugin's base __init__.py will not be caught here, and NetBox will abort entirely
    base_url = getattr(app, 'base_url') or app.label

    # Check if the plugin specifies any base URLs
    try:
        urlpatterns = import_string(f"{plugin_path}.urls.urlpatterns")
        plugin_patterns.append(
            path(f"{base_url}/", include((urlpatterns, app.label)))
        )
    except ImportError:
        pass   # GFM: an ImportError here will be silently ignored; an error message would be preferable
    # GFM:  note that any other exception in loading the plugin urls (SyntaxError, for example) will cause NetBox to abort

    # Check if the plugin specifies any API URLs
    try:
        urlpatterns = import_string(f"{plugin_path}.api.urls.urlpatterns")
        plugin_api_patterns.append(
            path(f"{base_url}/", include((urlpatterns, f"{app.label}-api")))
        )
    except ImportError:
        pass   # GFM: same comments here

It would be good to log something in the ImportError case instead of a simple pass.

@glennmatthews commented on GitHub (Jun 29, 2020): At least one place that logging and/or more extensive error handling for plugins would be useful is in `extras/plugins/urls.py`: ```python # Register base/API URL patterns for each plugin for plugin_path in settings.PLUGINS: plugin_name = plugin_path.split('.')[-1] app = apps.get_app_config(plugin_name) # GFM: an error in the plugin's base __init__.py will not be caught here, and NetBox will abort entirely base_url = getattr(app, 'base_url') or app.label # Check if the plugin specifies any base URLs try: urlpatterns = import_string(f"{plugin_path}.urls.urlpatterns") plugin_patterns.append( path(f"{base_url}/", include((urlpatterns, app.label))) ) except ImportError: pass # GFM: an ImportError here will be silently ignored; an error message would be preferable # GFM: note that any other exception in loading the plugin urls (SyntaxError, for example) will cause NetBox to abort # Check if the plugin specifies any API URLs try: urlpatterns = import_string(f"{plugin_path}.api.urls.urlpatterns") plugin_api_patterns.append( path(f"{base_url}/", include((urlpatterns, f"{app.label}-api"))) ) except ImportError: pass # GFM: same comments here ``` It would be good to log something in the `ImportError` case instead of a simple `pass`.
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
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#3677
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?