Skip to content

Show legacy plugin errors to users - #280

Open
mnorrisvuw wants to merge 1 commit into
musescore:mainfrom
mnorrisvuw:fix-28545-plugin-error-dialog
Open

Show legacy plugin errors to users#280
mnorrisvuw wants to merge 1 commit into
musescore:mainfrom
mnorrisvuw:fix-28545-plugin-error-dialog

Conversation

@mnorrisvuw

@mnorrisvuw mnorrisvuw commented Sep 8, 2026

Copy link
Copy Markdown

Resolves: musescore/MuseScore#28545

This is the muse_framework portion of the MuseScore plug-in error-reporting change. It displays errors encountered while loading or creating legacy QML plug-ins, provides the technical message as copyable details, and allows long details text to wrap in the shared error-details view.

Companion MuseScore PR: musescore/MuseScore#34864

Validation:

  • git diff --check

  • Uncrustify validation of extpluginrunner.cpp and extpluginrunner.h

  • Built and launched MuseScore Studio Development

  • Tested with several deliberate QML plug-in errors

  • I signed the CLA as michaelnorris.

  • The title of the PR describes the problem it addresses.

  • Each commit's message describes its purpose and effects, and references the issue it resolves.

  • The code in the PR follows the coding rules.

  • I understand all aspects of the code I'm contributing and I'm able to explain it if requested.

  • The code compiles and runs on my machine. I have manually tested and verified that my changes fulfil their intended purpose.

  • No prior attempts to resolve this problem exist, or if they do, they are described above.

  • There are no unnecessary changes.

  • I created a unit test or vtest to verify the changes I made (if applicable).

Build configuration

audacity: audacity/audacity/master
audacity platforms: linux_x64
musescore: mnorrisvuw/MuseScore/codex/fix-28545-plugin-error-dialog
musescore platforms: linux_x64

@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Warning

Review limit reached

Next included review available in 48 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: d4c8e05a-3b6f-4d38-8fcf-0602b3c2a6ce

📥 Commits

Reviewing files that changed from the base of the PR and between ca7b5fa and ca2987c.

📒 Files selected for processing (2)
  • framework/extensions/internal/legacy/extpluginrunner.cpp
  • framework/extensions/internal/legacy/extpluginrunner.h

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 31c652d8-adad-47d7-a094-58156815dae9

📥 Commits

Reviewing files that changed from the base of the PR and between b20183e and ca7b5fa.

📒 Files selected for processing (3)
  • framework/extensions/internal/legacy/extpluginrunner.cpp
  • framework/extensions/internal/legacy/extpluginrunner.h
  • framework/interactive/qml/Muse/Interactive/ErrorDetailsView.qml

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

ExtPluginRunner now displays translated interactive error dialogs for QML load failures, object creation failures, and invalid plugin object types. It logs trimmed error details and preserves the existing return codes. ErrorDetailsView constrains content to the available width, uses vertical-only scrolling, sizes rows by height, and wraps long error text.

Priority: ➖ Normal

Severity of issue fixed: Medium

Merge Risk: ⚪ Minimal · up to ca7b5

Legacy QML plug-in load and creation failures now present copyable, wrapped error details to users while retaining the existing failure results. No concrete current-head merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 2 files. (1 skipped: 1… Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues check ✅ Passed The changes satisfy issue [#28545] by displaying legacy QML plug-in load and creation errors in an interactive dialog, while preserving technical details for reporting and enabling long details text t…
Out of Scope Changes check ✅ Passed All changes support the linked issue. The ErrorDetailsView updates are directly related to displaying copyable, readable technical plug-in error details.
Title check ✅ Passed The title clearly summarizes the main change: showing errors from legacy plug-ins to users.
Description check ✅ Passed The description identifies the resolved issue, explains the user-facing change, lists validation steps, completes the repository checklist, and provides build configuration. The unit test checkbox is …
Full details: Docstring Coverage

Explanation

Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 2 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@mnorrisvuw
mnorrisvuw force-pushed the fix-28545-plugin-error-dialog branch from ca7b5fa to ca2987c Compare September 8, 2026 23:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Display plug-in errors/logs to user if an error is encountered

1 participant