Frontend plugins #5155

lelemm · 2025-06-13T15:09:27Z

Draft PR for the frontend plugins

* added generic error notification * can now enable and disable plugins --------- Co-authored-by: Alec Bakholdin <abakho@icims.com>

netlify · 2025-06-13T15:09:31Z

❌ Deploy Preview for actualbudget failed.

Name	Link
🔨 Latest commit	`9facd26`
🔍 Latest deploy log	https://app.netlify.com/projects/actualbudget/deploys/684c8b843e2ac100083cc8d8

lelemm · 2025-06-13T15:10:44Z

@coderabbitai summary

coderabbitai · 2025-06-13T15:14:30Z

Walkthrough

This change introduces a comprehensive client-side plugin system to the application. It adds new types, APIs, and UI components to support plugin installation, management, and integration. The desktop client is extended with a plugin provider context, plugin modals, sidebar/menu extensions, plugin dashboard widgets, and theme management for plugins. A new @actual-app/plugins-core package is created to provide shared plugin types, UI components, and middleware. The plugin loader uses module federation and supports plugin database operations, migrations, and AQL queries. The sync server adds a CORS proxy with GitHub token support for secure plugin asset fetching. Core types, preferences, and server handlers are updated to support plugin storage, themes, and widget types.

Possibly related PRs

✨ component library - minimalistic infrastructure #4169: Establishes initial infrastructure for the component library, including package.json and exports; this PR builds upon and extends that infrastructure, especially regarding modal props and type definitions.

Suggested labels

dependencies

Suggested reviewers

joel-jeremy
MikesGlitch

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9713d09 and d697c10.

⛔ Files ignored due to path filters (2)

packages/plugins-core/MIGRATION.md is excluded by !**/*.md
yarn.lock is excluded by !**/yarn.lock, !**/*.lock

📒 Files selected for processing (66)

package.json (2 hunks)
packages/component-library/package.json (1 hunks)
packages/component-library/src/props/modalProps.ts (1 hunks)
packages/desktop-client/.gitignore (1 hunks)
packages/desktop-client/package.json (3 hunks)
packages/desktop-client/service-worker/plugin-sw.js (1 hunks)
packages/desktop-client/src/browser-preload.browser.js (2 hunks)
packages/desktop-client/src/components/App.tsx (3 hunks)
packages/desktop-client/src/components/FinancesApp.tsx (6 hunks)
packages/desktop-client/src/components/LoggedInUser.tsx (3 hunks)
packages/desktop-client/src/components/Modals.tsx (3 hunks)
packages/desktop-client/src/components/ThemeSelector.tsx (3 hunks)
packages/desktop-client/src/components/budget/envelope/BalanceMovementMenu.tsx (3 hunks)
packages/desktop-client/src/components/common/Modal.tsx (2 hunks)
packages/desktop-client/src/components/modals/PluginModal.tsx (1 hunks)
packages/desktop-client/src/components/modals/SelectNewPluginModal.tsx (1 hunks)
packages/desktop-client/src/components/plugins/ManagePlugins.tsx (1 hunks)
packages/desktop-client/src/components/plugins/PluginCustomPage.tsx (1 hunks)
packages/desktop-client/src/components/plugins/Plugins.tsx (1 hunks)
packages/desktop-client/src/components/plugins/PluginsHeader.tsx (1 hunks)
packages/desktop-client/src/components/plugins/RenderPluginsComponent.tsx (1 hunks)
packages/desktop-client/src/components/reports/Overview.tsx (7 hunks)
packages/desktop-client/src/components/reports/reports/PluginCard.tsx (1 hunks)
packages/desktop-client/src/components/schedules/index.tsx (1 hunks)
packages/desktop-client/src/components/settings/Experimental.tsx (1 hunks)
packages/desktop-client/src/components/settings/Themes.tsx (4 hunks)
packages/desktop-client/src/components/sidebar/PrimaryButtons.tsx (5 hunks)
packages/desktop-client/src/components/sidebar/Sidebar.tsx (3 hunks)
packages/desktop-client/src/hooks/useFeatureFlag.ts (1 hunks)
packages/desktop-client/src/plugin/ActualPluginsProvider.tsx (1 hunks)
packages/desktop-client/src/plugin/core/githubUtils.ts (1 hunks)
packages/desktop-client/src/plugin/core/pluginInstaller.ts (1 hunks)
packages/desktop-client/src/plugin/core/pluginLoader.ts (1 hunks)
packages/desktop-client/src/plugin/core/pluginStore.ts (1 hunks)
packages/desktop-client/src/style/theme.tsx (6 hunks)
packages/desktop-client/vite.config.mts (2 hunks)
packages/loot-core/package.json (2 hunks)
packages/loot-core/src/client/modals/modalsSlice.ts (2 hunks)
packages/loot-core/src/client/notifications/notificationsSlice.ts (3 hunks)
packages/loot-core/src/platform/server/indexeddb/index.web.ts (1 hunks)
packages/loot-core/src/server/dashboard/app.ts (1 hunks)
packages/loot-core/src/server/main.ts (4 hunks)
packages/loot-core/src/server/plugins/pluginUtil.ts (1 hunks)
packages/loot-core/src/server/preferences/app.ts (4 hunks)
packages/loot-core/src/types/models/actual-plugin-stored.d.ts (1 hunks)
packages/loot-core/src/types/models/dashboard.d.ts (2 hunks)
packages/loot-core/src/types/models/plugin-file.d.ts (1 hunks)
packages/loot-core/src/types/prefs.d.ts (4 hunks)
packages/loot-core/src/types/server-handlers.d.ts (2 hunks)
packages/plugins-core/.gitignore (1 hunks)
packages/plugins-core/package.json (1 hunks)
packages/plugins-core/src/BasicModalComponents.tsx (1 hunks)
packages/plugins-core/src/index.ts (1 hunks)
packages/plugins-core/src/middleware.ts (1 hunks)
packages/plugins-core/src/types/actualPlugin.d.ts (1 hunks)
packages/plugins-core/src/types/actualPluginEntry.d.ts (1 hunks)
packages/plugins-core/src/types/actualPluginManifest.d.ts (1 hunks)
packages/plugins-core/src/types/query.ts (1 hunks)
packages/plugins-core/src/types/toolkit.d.ts (1 hunks)
packages/plugins-core/src/utils.ts (1 hunks)
packages/plugins-core/tsconfig.json (1 hunks)
packages/plugins-core/vite.config.mts (1 hunks)
packages/sync-server/src/app-cors-proxy.js (1 hunks)
packages/sync-server/src/app.js (2 hunks)
packages/sync-server/src/load-config.js (2 hunks)
tsconfig.json (1 hunks)

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

lelemm · 2025-06-13T20:35:15Z

🤖 Auto-generated Release Notes

Hey @lelemm! I've automatically created a release notes file based on CodeRabbit's analysis:

Category: Feature
Summary: Introduce a client-side plugin system with installation, management, and integration features.
File: upcoming-release-notes/5155.md

The release notes file has been committed to the repository. You can edit it if needed before the merging.

github-actions · 2025-06-21T02:12:16Z

👋 Hi! It looks like this PR has not had any changes for a week now. Would you like someone to review this PR? If so - please remove the "[WIP]" prefix from the PR title. That will let the community know that this PR is open for a review.

github-actions · 2025-06-29T02:15:15Z

👋 Hi! It looks like this PR has not had any changes for a week now. Would you like someone to review this PR? If so - please remove the "[WIP]" prefix from the PR title. That will let the community know that this PR is open for a review.

github-actions · 2025-07-14T02:15:17Z

👋 Hi! It looks like this PR has not had any changes for a week now. Would you like someone to review this PR? If so - please remove the "[WIP]" prefix from the PR title. That will let the community know that this PR is open for a review.

github-actions · 2025-07-22T02:15:00Z

This PR was closed because it has been stalled for 5 days with no activity.

lelemm and others added 21 commits April 4, 2025 00:19

Frontend plugins

0fb1449

workbox too much messages

e9fcb84

Fix refs

2721455

clean up

15279c5

more features

d4da476

more modal functions

f2e4430

small fix

e061204

multiple features implemented

39b174b

small fix

727f1c6

Close modal

8c1473e

Events

64e5ae5

Fixed route rendering

4e132df

Added option to render item in the topbar

9aec1f6

load plugin from vite dev

ff7ba8c

✨ [Feature] Plugin enable/disable button (actualbudget#4773)

5e51012

* added generic error notification * can now enable and disable plugins --------- Co-authored-by: Alec Bakholdin <abakho@icims.com>

Added hot reload to plugins

0a59f36

added database handling

cd47bdd

aql exposed

41e6c31

custom themes + typecheck

d400fd6

cors proxy respecting whitelist

f136e42

dashboard custom card

d697c10

actual-github-bot bot added the 🚧 WIP label Jun 13, 2025

actualbudget deleted a comment from coderabbitai bot Jun 13, 2025

lelemm pushed a commit that referenced this pull request Jun 13, 2025

Add release notes for PR #5155

8976a59

github-actions bot and others added 3 commits June 13, 2025 13:01

Add release notes for PR actualbudget#5155

a79182a

Delete upcoming-release-notes/5155.md

f7f7259

Add release notes for PR actualbudget#5155

e7a1504

github-actions bot and others added 7 commits June 13, 2025 13:34

Add release notes for PR actualbudget#5155

00f82a8

Delete upcoming-release-notes/5155.md

29cec88

Add release notes for PR actualbudget#5155

807abba

Delete upcoming-release-notes/5155.md

9f86555

Add release notes for PR actualbudget#5155

70bf6fe

Delete upcoming-release-notes/5155.md

ae6fcaf

Add release notes for PR actualbudget#5155

b65341a

actualbudget deleted a comment from coderabbitai bot Jun 13, 2025

lelemm and others added 2 commits June 13, 2025 17:34

Delete upcoming-release-notes/5155.md

abe23f4

Add release notes for PR actualbudget#5155

9facd26

github-actions bot added the Stale label Jun 21, 2025

matt-fidd removed the Stale label Jun 21, 2025

github-actions bot added Stale and removed Stale labels Jun 29, 2025

github-actions bot added the Stale label Jul 14, 2025

github-actions bot closed this Jul 22, 2025

actual-github-bot bot removed the 🚧 WIP label Jul 22, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Frontend plugins #5155

Frontend plugins #5155

Uh oh!

lelemm commented Jun 13, 2025

Uh oh!

netlify bot commented Jun 13, 2025 •

edited

Loading

Uh oh!

lelemm commented Jun 13, 2025

Uh oh!

coderabbitai bot commented Jun 13, 2025

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

lelemm commented Jun 13, 2025

Uh oh!

github-actions bot commented Jun 21, 2025

Uh oh!

github-actions bot commented Jun 29, 2025

Uh oh!

github-actions bot commented Jul 14, 2025

Uh oh!

github-actions bot commented Jul 22, 2025

Uh oh!

Uh oh!

Uh oh!

Frontend plugins #5155

Frontend plugins #5155

Uh oh!

Conversation

lelemm commented Jun 13, 2025

Uh oh!

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

Uh oh!

❌ Deploy Preview for actualbudget failed.

Uh oh!

lelemm commented Jun 13, 2025

Uh oh!

coderabbitai bot commented Jun 13, 2025

Walkthrough

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

lelemm commented Jun 13, 2025

Uh oh!

github-actions bot commented Jun 21, 2025

Uh oh!

github-actions bot commented Jun 29, 2025

Uh oh!

github-actions bot commented Jul 14, 2025

Uh oh!

github-actions bot commented Jul 22, 2025

Uh oh!

Uh oh!

netlify bot commented Jun 13, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)