Skip to content

fix(plugins): correct error handling in plugin initialization #4311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 7, 2025

Conversation

deluan
Copy link
Member

@deluan deluan commented Jul 6, 2025

Description

This PR fixes a bug in plugin initialization error handling where the success/failure metric was inverted. The fix ensures that plugin initialization metrics correctly reflect the actual success or failure status of the operation.

Additionally, removes the unused errorMapper interface and related code that was no longer needed.

Related Issues

Type of Change

  • Bug fix
  • New feature
  • Documentation update
  • Refactor
  • Other (please describe):

Checklist

Please review and check all that apply:

  • My code follows the project's coding style
  • I have tested the changes locally
  • I have added or updated documentation as needed
  • I have added tests that prove my fix/feature works (or explain why not)
  • All existing and new tests pass

How to Test

  1. Start Navidrome with plugins enabled
  2. Monitor plugin initialization metrics
  3. Verify that success/failure metrics are correctly recorded
  4. Check that plugins initialize without errors

Screenshots / Demos (if applicable)

Updated the error handling logic in the plugin lifecycle manager to accurately record the success of the OnInit method. The change ensures that the metrics reflect whether the initialization was successful, improving the reliability of plugin metrics tracking. Additionally, removed the unused errorMapper interface from base_capability.go to clean up the codebase.

Signed-off-by: Deluan <deluan@navidrome.org>
@Copilot Copilot AI review requested due to automatic review settings July 6, 2025 00:03
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR corrects the inverted success/failure flag when recording plugin initialization metrics and cleans up an unused errorMapper interface and its related code.

  • Fixed inverted boolean in RecordPluginRequest call for OnInit
  • Removed dead errorMapper interface and mapping logic

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
plugins/plugin_lifecycle_manager.go Flip err != nil to err == nil for correct metric
plugins/base_capability.go Remove unused errorMapper interface and mapping

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @deluan, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses a critical bug in plugin initialization error handling, ensuring that success and failure metrics are accurately reported. Additionally, it cleans up the codebase by removing an obsolete and unused error mapping interface, contributing to better maintainability.

Highlights

  • Plugin Metrics Correction: Corrected an inverted boolean logic in plugins/plugin_lifecycle_manager.go to accurately record success/failure metrics for plugin initialization. Previously, err != nil was incorrectly used for the success metric, which has now been changed to err == nil.
  • Code Cleanup: Removed the unused errorMapper interface and its associated usage from plugins/base_capability.go. This interface and its implementation were no longer needed, simplifying the codebase.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request correctly fixes a bug where plugin initialization metrics were inverted and removes unused code related to errorMapper. The changes are accurate and improve the codebase. I've added one medium-severity suggestion to improve the clarity of logging around plugin initialization failures, which should aid future debugging.

@deluan deluan merged commit d041cb3 into master Jul 7, 2025
35 checks passed
@deluan deluan deleted the more-plugin-fixes branch July 7, 2025 19:24
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.

1 participant