Closes: #18535

bctiemann · 2025-01-29T23:31:31Z

Changes the behavior of the PluginConfig.validate method so that if a plugin with incompatible min or max version specified, it raises an IncompatiblePluginError which is caught in settings.py and registering the plugin is skipped, allowing NetBox to launch cleanly with the plugin disabled.

netbox/netbox/settings.py

a084ed22 · 2025-01-30T07:32:00Z

Just to understand, this would print a warning at netbox upgrade time? The experience of figuring out which plugin has a strict max_version specified and breaks the upgrade process even on patch upgrades during the database migration step could really use to be more explanatory.

bctiemann · 2025-01-30T15:45:00Z

Yes, it would look like this:

Unable to load plugin netbox_branching: Plugin netbox_branching requires NetBox maximum version 4.2.1 (current: 4.2.2).
Watching for file changes with StatReloader
Performing system checks...

jeremystretch

We might want to rename the table columns. Currently, a plugin which fails to load shows false under "Installed" but confusingly still reports an installed version:

We should also highlight any plugins which failed to load to draw attention to them.

netbox/core/plugins.py

bctiemann · 2025-02-23T23:53:40Z

I renamed "Installed" to "Active", and I added a custom table column that allows an alert icon with a tooltip that explains the incompatibility issue:

jeremystretch

This renders an alert for every non-installed plugin. The value for is_installed should probably be None if the plugin has not been added to PLUGINS, and False if it has been added but failed to load.

jeremystretch · 2025-02-25T13:56:24Z

netbox/netbox/tables/columns.py

@@ -707,3 +707,22 @@ class DistanceColumn(TemplateColumn):

    def __init__(self, template_code=template_code, order_by='_abs_distance', **kwargs):
        super().__init__(template_code=template_code, order_by=order_by, **kwargs)
+
+
+class PluginActiveColumn(BooleanColumn):


I'm not sure a custom column is needed here. Could we just use BooleanColumn and pass a custom HTML string for false_mark?

It doesn't look like it, if I want the false_mark text to be dynamically generated (i.e. to reflect the compatible version range). All the usage guidance I've been able to find suggests that the only way to add custom functionality referencing other columns is to subclass and override.

Also, in investigating this I found that BooleanColumn (and really all columns) ignore None values altogether and just render an — by default; if I comment out EMPTY_MARK it causes no ill effects. So setting is_installed to None means it doesn't trigger any custom column logic at all. I think for clarity I'll have to set another boolean field failed_to_load and reference that in the custom column logic, and set is_installed to True for all local plugins as it was before.

We might want to clean up BooleanColumn to remove the references to it, to avoid giving future devs the mistaken impression that we can incorporate None values into custom column logic.

Could you just use a TemplateColumn then? I'd like to avoid introducing a new column class that only has one use case.

Good call, I think this will do the trick.

I fussed around a bunch trying to centralize the TRUE_MARK etc strings to avoid redundancy, but then realized we're already re-hard-coding those <i class="mdi mdi-check-bold"></i> in a million places so this only adds a little incremental chaos.

netbox/netbox/settings.py

…display status in Plugins page

…ns, and display status in Plugins page" This reverts commit d97bf2a.

…with tooltip

Co-authored-by: Jeremy Stretch <jstretch@netboxlabs.com>

This reverts commit d1ea60f.

jeremystretch · 2025-02-27T15:06:39Z

netbox/core/plugins.py

    is_local: bool = False  # extra field for locally installed plugins
    is_installed: bool = False
+    failed_to_load: bool = False


I'm having a hard time discerning the difference between is_local and is_installed. It seems that any installed plugin has is_local set to True. Additionally, failed_to_load feels backward to me.

Could we simplify these to two attributes: is_enabled and is_installed (or is_loaded)? These would indicate whether the plugin is listed in settings.PLUGINS and whether is has been successfully loaded into the registry, respectively.

How about this -- is_local (which mirrors the local_plugins etc verbage, as opposed to catalog_plugins); and is_loaded, which indicates whether it's loaded into the registry. This removes is_installed as redundant, and the is_installed column remains on the table class but is purely rendered via the template logic.

jeremystretch · 2025-02-27T15:17:10Z

netbox/core/tables/template_code.py

@@ -14,3 +14,13 @@
 OBJECTCHANGE_REQUEST_ID = """
 <a href="{% url 'core:objectchange_list' %}?request_id={{ value }}">{{ value }}</a>
 """
+
+PLUGIN_IS_INSTALLED = """
+{% if record.failed_to_load %}


A plugin could fail to load for other reasons though, presumably. I'd avoid assuming it was due to a version incompatibility.

Rephrased the tooltip accordingly. It's possible to do an on-the-fly validation of the version range to see whether it should be suggested at all, but that got a bit too hairy.

…ns table

bctiemann commented Jan 29, 2025

View reviewed changes

netbox/netbox/settings.py Outdated Show resolved Hide resolved

bctiemann requested a review from jeremystretch January 29, 2025 23:33

bctiemann changed the base branch from feature to main February 5, 2025 15:31

bctiemann changed the base branch from main to feature February 5, 2025 15:45

bctiemann changed the title ~~Closes: #18535 - Skip incompatible plugins during startup and remove from PLUGINS~~ Closes: #18535 - Skip incompatible plugins during startup Feb 5, 2025

jeremystretch requested changes Feb 6, 2025

View reviewed changes

netbox/core/plugins.py Outdated Show resolved Hide resolved

bctiemann requested a review from jeremystretch February 23, 2025 23:54

jeremystretch requested changes Feb 25, 2025

View reviewed changes

bctiemann force-pushed the 18535-skip-incompatible-plugins branch from 2d7e332 to b5e9ae0 Compare February 25, 2025 16:55

bctiemann and others added 9 commits February 25, 2025 12:04

Skip incompatible plugins during startup and remove from PLUGINS

dd2ca38

Handle exceptions on request processors in incompatible plugins, and …

baab200

…display status in Plugins page

Revert "Handle exceptions on request processors in incompatible plugi…

8b6a241

…ns, and display status in Plugins page" This reverts commit d97bf2a.

Resolve merge conflicts

1423a1f

Skip incompatible plugins during startup and remove from PLUGINS

55b5b7c

Rename Installed column to Active, and add custom PluginActiveColumn …

28cf67b

…with tooltip

Fix is_installed

1d6a656

Simplify plugin_config.validate syntax

92a5623

Co-authored-by: Jeremy Stretch <jstretch@netboxlabs.com>

Merge feature

d1ea60f

bctiemann force-pushed the 18535-skip-incompatible-plugins branch from b5e9ae0 to d1ea60f Compare February 25, 2025 17:05

bctiemann added 3 commits February 25, 2025 12:06

Revert "Merge feature"

9b7c10e

This reverts commit d1ea60f.

Undo simplification

d802f93

Add failed_to_load logic

26bac97

bctiemann added this to the v4.3 milestone Feb 25, 2025

bctiemann added 3 commits February 25, 2025 14:11

Use a TemplateColumn for is_installed

fdc879f

Remove custom column class

8e14b10

Remove merge vestige

633d0c9

jeremystretch self-requested a review February 27, 2025 14:36

jeremystretch requested changes Feb 27, 2025

View reviewed changes

Simplify plugin attributes for is_installed column

f934712

jeremystretch self-requested a review March 6, 2025 15:38

Use placeholders for false values to increase legibility of the plugi…

749c1a1

…ns table

jeremystretch approved these changes Mar 10, 2025

View reviewed changes

jeremystretch merged commit b5d970f into feature Mar 10, 2025
6 checks passed

jeremystretch deleted the 18535-skip-incompatible-plugins branch March 10, 2025 14:51

github-actions bot locked as resolved and limited conversation to collaborators Apr 10, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Closes: #18535 - Skip incompatible plugins during startup #18537

Closes: #18535 - Skip incompatible plugins during startup #18537

Uh oh!

bctiemann commented Jan 29, 2025

Uh oh!

Uh oh!

a084ed22 commented Jan 30, 2025

Uh oh!

bctiemann commented Jan 30, 2025

Uh oh!

jeremystretch left a comment •

edited

Loading

Uh oh!

Uh oh!

bctiemann commented Feb 23, 2025

Uh oh!

jeremystretch left a comment

Uh oh!

jeremystretch Feb 25, 2025

Uh oh!

bctiemann Feb 25, 2025

Uh oh!

jeremystretch Feb 25, 2025

Uh oh!

bctiemann Feb 25, 2025

Uh oh!

Uh oh!

jeremystretch Feb 27, 2025

Uh oh!

bctiemann Mar 3, 2025

Uh oh!

jeremystretch Feb 27, 2025

Uh oh!

bctiemann Mar 3, 2025

Uh oh!

Uh oh!

Uh oh!

Closes: #18535 - Skip incompatible plugins during startup #18537

Closes: #18535 - Skip incompatible plugins during startup #18537

Uh oh!

Conversation

bctiemann commented Jan 29, 2025

Closes: #18535

Uh oh!

Uh oh!

a084ed22 commented Jan 30, 2025

Uh oh!

bctiemann commented Jan 30, 2025

Uh oh!

jeremystretch left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bctiemann commented Feb 23, 2025

Uh oh!

jeremystretch left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jeremystretch left a comment •

edited

Loading