[Refactor] Notification plugins #9735

SchrodingersGat · 2025-06-03T23:58:35Z

Breaking Change

This PR represents a breaking change to any custom plugin which implements notification functionality. To continue to function, any such plugin must be reworked to follow the new approach:

Each custom notification method must be implemented as a separate plugin
Each custom notification method must inherit the NotificationMixin class
Refer to the 3x built-in notification plugins for examples

Details

This PR is a refactor of how notification methods are defined and collected.

Currently, it is a separate collection mechanism to plugins, and loading the notification methods is complex and somewhat "brittle" (compared to the plugin registry which has been optimized),

The intent here is to just make each notification method a plugin, which is then in line with our general concept of plugins. It also ensures that notification methods cannot be "collected" from plugins which are installed but not active (which is unfortunately the case currently).

Feature - Plugin User Settings

It introduces a new concept, a "per user" setting structure against plugins. This replaces the "NotificationSetting" which was stored once per user against each type of notification. The new approach is more generic as any plugin can store per-user settings.

Enhancements

Improve query efficiency when loading and checking plugin registry
Fix for "stock required for build" event - pass to the notification systems now

Tasks

Split built-in notification methods into separate plugins
Documentation for new built-in plugin types
Reimplement solution for per-user-per-plugin settings
Fix unit testing
Check that email notifications still work
Check that UI notification still work
API unit tests for new plugin-user-setting
Playwright tests for configuring plugin user settings
Fix remaining "notification settings" user settings panel

Related Issues

- Notifications handled by plugins

netlify · 2025-06-03T23:58:40Z

✅ Deploy Preview for inventree-web-pui-preview ready!

Name	Link
🔨 Latest commit	`f125dbb`
🔍 Latest deploy log	https://app.netlify.com/projects/inventree-web-pui-preview/deploys/688325edc7208c00083668d1
😎 Deploy Preview	https://deploy-preview-9735--inventree-web-pui-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 97 (no change from production) Accessibility: 81 (no change from production) Best Practices: 100 (no change from production) SEO: 78 (no change from production) PWA: - View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

- Ensure plugin slug is correctly attached - Consistent format - Logic fixes

codecov · 2025-06-04T00:35:30Z

Codecov Report

❌ Patch coverage is 92.88136% with 21 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.78%. Comparing base (6e81fa2) to head (f125dbb).
⚠️ Report is 2 commits behind head on master.

❌ Your patch status has failed because the patch coverage (83.78%) is below the target coverage (95.00%). You can increase the patch coverage or adjust the target coverage.
❌ Your project status has failed because the head coverage (91.61%) is below the target coverage (92.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #9735      +/-   ##
==========================================
- Coverage   86.82%   86.78%   -0.05%     
==========================================
  Files        1251     1253       +2     
  Lines       55398    55331      -67     
  Branches     2089     2089              
==========================================
- Hits        48102    48019      -83     
- Misses       6783     6799      +16     
  Partials      513      513

Flag	Coverage Δ
backend	`88.48% <92.88%> (-0.06%)`	⬇️
migrations	`42.82% <42.71%> (+0.02%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components	Coverage Δ
Backend Apps	`91.20% <94.97%> (+0.01%)`	⬆️
Backend General	`91.61% <83.78%> (-0.84%)`	⬇️
Frontend	`70.11% <ø> (+0.01%)`	⬆️

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

matmair

TBH there are so many lost / fundamentally changed mechanisms that I can not compare this to the current implementation as it just shares some entry points and names.
This means a new write of every even slightly complex notification method plugin and refactors for all plugins that trigger notifications.

src/backend/InvenTree/common/notifications.py

SchrodingersGat · 2025-06-05T01:42:12Z

@matmair fair comments - I'll see if I can adjust this to reduce the number of changes required

…enTree into notification-plugins

- Actually *use* the notification system - Fix for email template

- Allows plugins to define per-user settings

SchrodingersGat · 2025-07-19T04:50:16Z

I think the difference in code coverage here is due to deleted lines in the codebase....

In any case, @matmair this is ready for review now. The key points are:

Notification methods are now delivered by "normal" plugin approach
Yes, this is a breaking change (which is why I want to get it done now, before 1.0.0)
Plugins can now specify "user-specific settings". This replaces the concept of "notification setting" which was specific to a notificationmethod

Copilot

Pull Request Overview

This pull request refactors the notification system to treat notification methods as individual plugins instead of being part of a larger plugin. It implements a new user-specific settings system for plugins, changes the notification architecture to use the NotificationMixin, and replaces the NotificationUserSetting model with PluginUserSetting.

Splits core notification methods (UI, Email, Slack) into separate plugins
Introduces plugin-specific user settings through new PluginUserSetting model
Replaces the legacy notification collection system with plugin-based approach

Reviewed Changes

Copilot reviewed 57 out of 57 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/frontend/tests/pui_plugins.spec.ts	Adds new Playwright test for plugin user settings functionality
src/frontend/src/states/SettingsStates.tsx	Updates plugin settings state to accept endpoint parameter
src/frontend/src/pages/Index/Settings/UserSettings.tsx	Adds Plugin Settings tab to user settings
src/frontend/src/pages/Index/Settings/UserPluginSettings.tsx	New component for managing user-specific plugin settings
src/frontend/src/components/settings/SettingList.tsx	Adds support for plugin user settings and onLoaded callback
src/frontend/lib/enums/ApiEndpoints.tsx	Adds new API endpoint for plugin user settings
src/backend/InvenTree/users/ruleset.py	Updates ruleset to reference new PluginUserSetting model
src/backend/InvenTree/templates/email/*.html	New and updated email templates
src/backend/InvenTree/plugin/serializers.py	Replaces NotificationUserSetting with PluginUserSetting serializer
src/backend/InvenTree/plugin/samples/integration/sample.py	Adds example user settings to sample plugin
src/backend/InvenTree/plugin/registry.py	Updates built-in plugin names for new notification structure
src/backend/InvenTree/plugin/plugin.py	Adds NOTIFICATION mixin enum
src/backend/InvenTree/plugin/models.py	Replaces NotificationUserSetting with PluginUserSetting model
src/backend/InvenTree/plugin/migrations/	Database migrations for model changes
src/backend/InvenTree/plugin/builtin/integration/core_notifications.py	Refactors notification methods into separate plugin classes
src/backend/InvenTree/plugin/base/integration/SettingsMixin.py	Adds user settings support to SettingsMixin
src/backend/InvenTree/plugin/base/integration/NotificationMixin.py	New mixin for notification plugins
src/backend/InvenTree/plugin/api.py	Adds API endpoints for plugin user settings
src/backend/InvenTree/plugin/admin.py	Updates admin interface for new models
src/backend/InvenTree/common/notifications.py	Refactors notification triggering to use plugin system
src/backend/InvenTree/build/tasks.py	Updates build notification to use new system
Multiple test files	Updates tests to work with new notification architecture
docs/	Documentation updates for new notification plugins and mixins

src/backend/InvenTree/templates/email/build_order_required_stock.html

src/backend/InvenTree/build/tasks.py

src/backend/InvenTree/plugin/base/integration/NotificationMixin.py

src/backend/InvenTree/plugin/builtin/integration/core_notifications.py

Co-authored-by: Copilot <[email protected]>

…n.py Co-authored-by: Copilot <[email protected]>

…enTree into notification-plugins

matmair · 2025-07-21T20:17:28Z

TBH I am still not a fan of this change, I feel like notification settings should be a first-party component just like other settings. Moving them to the plugins makes them far more obscure.
The rest (except coverage) looks fine.

matmair · 2025-07-21T20:20:02Z

The new plugin user settings seem to not be covered fully, there seems to be stuff missing on the APIs

SchrodingersGat · 2025-07-23T09:44:43Z

TBH I am still not a fan of this change, I feel like notification settings should be a first-party component just like other settings.

I see what you mean, but the plugin specific notification settings are controlled exclusively by the plugins which implement them.

What about a compromise:

First-Party Settings

Add some specific "first party" user settings for notifications (such as "enable emails" / "enable UI notifications")
First party plugins reference these settings, rather than their own "plugin specific" settings
These settings are placed in the "user notification settings" panel
Any other "third party" plugins which provide notification support will have their settings appear in the "plugin settings" panel

Edit

I came up with a cleaner way - display all user settings for notification plugins in the "user notifications" tab:

This approach also works nicely for global plugin settings:

SchrodingersGat · 2025-07-23T21:51:01Z

@matmair coverage has been increased across new features, and the notification settings now appear in their own panel

SchrodingersGat added 6 commits June 3, 2025 09:33

Refactor notification concept

ba626cb

- Notifications handled by plugins

Cleanup

642524a

Merge remote-tracking branch 'origin/master' into transition-methods

6c19f42

Merge remote-tracking branch 'origin/master' into notification-plugins

1373b3f

Only send email if template provided in context

2de7fcc

Logic cleanup

0cb0e2f

SchrodingersGat added this to the 1.0.0 milestone Jun 3, 2025

SchrodingersGat requested a review from matmair as a code owner June 3, 2025 23:58

SchrodingersGat added plugin Plugin ecosystem refactor labels Jun 3, 2025

SchrodingersGat marked this pull request as draft June 3, 2025 23:58

SchrodingersGat added the breaking Indicates a major update or change which breaks compatibility label Jun 4, 2025

SchrodingersGat added 2 commits June 4, 2025 00:10

Fix log_error call

0a13561

Refactor error logging

d50b1ca

- Ensure plugin slug is correctly attached - Consistent format - Logic fixes

matmair reviewed Jun 5, 2025

View reviewed changes

src/backend/InvenTree/common/notifications.py Outdated Show resolved Hide resolved

SchrodingersGat added 9 commits June 6, 2025 07:22

Merge branch 'master' into notification-plugins

9192dce

More robust plugin lookup

5517820

Refactor calls to tringger_notification

add2bc0

Merge branch 'master' into notification-plugins

fedd5eb

Merge branch 'master' into notification-plugins

aa53cd7

Merge branch 'notification-plugins' of github.com:SchrodingersGat/Inv…

0cba79d

…enTree into notification-plugins

Tweak for build stock notification

67a0c09

Low stock notification refactor

3cb64ed

- Actually *use* the notification system - Fix for email template

Check stock only when build is issued

1d33662

SchrodingersGat added the bug Identifies a bug which needs to be addressed label Jun 9, 2025

SchrodingersGat added 2 commits June 9, 2025 01:33

Updated documentation

d33d12a

Add PluginUserSetting class

3dc626f

- Allows plugins to define per-user settings

SchrodingersGat requested review from matmair and Copilot July 19, 2025 04:50

Copilot AI reviewed Jul 19, 2025

View reviewed changes

SchrodingersGat and others added 7 commits July 19, 2025 14:55

Update src/backend/InvenTree/build/tasks.py

9eee1fd

Co-authored-by: Copilot <[email protected]>

Update src/backend/InvenTree/plugin/base/integration/NotificationMixi…

cc45e79

…n.py Co-authored-by: Copilot <[email protected]>

Func updates

b5f6f32

Merge branch 'notification-plugins' of github.com:SchrodingersGat/Inv…

4fcf11a

…enTree into notification-plugins

Format

42dc7e9

Merge branch 'master' into notification-plugins

da1be86

Merge branch 'master' into notification-plugins

a0cf0e9

SchrodingersGat added 2 commits July 23, 2025 11:54

Merge branch 'master' into notification-plugins

69813e4

Merge branch 'master' into notification-plugins

1313047

SchrodingersGat added 7 commits July 23, 2025 09:54

Add notification settings

22262e2

Refactor plugin settings groups

90c0b0b

Fix func type

d25237b

Merge remote-tracking branch 'origin/master' into notification-plugins

c7fa1d3

Adjust message

3323fcb

Additional unit tests

631c0d9

Additional playwright tests

4b86875

SchrodingersGat added 3 commits July 23, 2025 21:57

Additional playwright test

50e2f12

Merge branch 'master' into notification-plugins

6b664e0

Merge branch 'master' into notification-plugins

f125dbb

SchrodingersGat merged commit 1085625 into inventree:master Jul 26, 2025
30 of 33 checks passed

SchrodingersGat deleted the notification-plugins branch July 26, 2025 03:06

1337joe mentioned this pull request Jul 26, 2025

Correct api version numbers #10081

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[Refactor] Notification plugins #9735

[Refactor] Notification plugins #9735

Uh oh!

SchrodingersGat commented Jun 3, 2025 •

edited

Loading

Uh oh!

netlify bot commented Jun 3, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jun 4, 2025 •

edited

Loading

Uh oh!

matmair left a comment •

edited

Loading

Uh oh!

Uh oh!

SchrodingersGat commented Jun 5, 2025

Uh oh!

SchrodingersGat commented Jul 19, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matmair commented Jul 21, 2025

Uh oh!

matmair commented Jul 21, 2025

Uh oh!

SchrodingersGat commented Jul 23, 2025 •

edited

Loading

Uh oh!

SchrodingersGat commented Jul 23, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

[Refactor] Notification plugins #9735

[Refactor] Notification plugins #9735

Uh oh!

Conversation

SchrodingersGat commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Breaking Change

Details

Feature - Plugin User Settings

Enhancements

Tasks

Related Issues

Uh oh!

netlify bot commented Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for inventree-web-pui-preview ready!

Uh oh!

codecov bot commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

matmair 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!

SchrodingersGat commented Jun 5, 2025

Uh oh!

SchrodingersGat commented Jul 19, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

matmair commented Jul 21, 2025

Uh oh!

matmair commented Jul 21, 2025

Uh oh!

SchrodingersGat commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

First-Party Settings

Edit

Uh oh!

SchrodingersGat commented Jul 23, 2025

Uh oh!

Uh oh!

Uh oh!

SchrodingersGat commented Jun 3, 2025 •

edited

Loading

netlify bot commented Jun 3, 2025 •

edited

Loading

codecov bot commented Jun 4, 2025 •

edited

Loading

matmair left a comment •

edited

Loading

SchrodingersGat commented Jul 23, 2025 •

edited

Loading