importsource: Only register listener if configured

[JOJ0]

Description

Does not fix anything, just corrects what the plugin is supposed to do. If the feature is not enabled, registering a listener is not required.

Added 2 new tests that prove this is the case.

• Documentation.
• Changelog. Not required since it is a new and unreleased plugin that has a changelog entry already.
• Tests.

[github-actions]

Thank you for the PR! The changelog has not been updated, so here is a friendly reminder to check if you need to add an entry.

[codecov]

❌ 1 Tests Failed:

Tests completed	Failed	Passed	Skipped
2294	1	2293	68

View the top 1 failed test(s) by shortest run time

test/plugins/test_importsource.py::ImportSourceTestListenerRegistration::test_listeners_not_registered_when_disabled

Stack Traces | 0.041s run time

self = <test.plugins.test_importsource.ImportSourceTestListenerRegistration testMethod=test_listeners_not_registered_when_disabled>

    #x1B[0m#x1B[94mdef#x1B[39;49;00m#x1B[90m #x1B[39;49;00m#x1B[92mtest_listeners_not_registered_when_disabled#x1B[39;49;00m(#x1B[96mself#x1B[39;49;00m):#x1B[90m#x1B[39;49;00m
    #x1B[90m    #x1B[39;49;00m#x1B[33m"""Test that listeners are not registered when suggest_removal is False."""#x1B[39;49;00m#x1B[90m#x1B[39;49;00m
        #x1B[96mself#x1B[39;49;00m.config[#x1B[96mself#x1B[39;49;00m.plugin][#x1B[33m"#x1B[39;49;00m#x1B[33msuggest_removal#x1B[39;49;00m#x1B[33m"#x1B[39;49;00m] = #x1B[94mFalse#x1B[39;49;00m#x1B[90m#x1B[39;49;00m
        #x1B[96mself#x1B[39;49;00m.load_plugins()#x1B[90m#x1B[39;49;00m
    #x1B[90m#x1B[39;49;00m
        plugin = plugins._instances[#x1B[94m0#x1B[39;49;00m]#x1B[90m#x1B[39;49;00m
>       #x1B[94massert#x1B[39;49;00m #x1B[95mnot#x1B[39;49;00m #x1B[96mhasattr#x1B[39;49;00m(plugin, #x1B[33m"#x1B[39;49;00m#x1B[33mstop_suggestions_for_albums#x1B[39;49;00m#x1B[33m"#x1B[39;49;00m)#x1B[90m#x1B[39;49;00m
#x1B[1m#x1B[31mE       AssertionError: assert not True#x1B[0m
#x1B[1m#x1B[31mE        +  where True = hasattr(<beetsplug.importsource.ImportSourcePlugin object at 0x7f8c745d03a0>, 'stop_suggestions_for_albums')#x1B[0m

#x1B[1m#x1B[31mtest/plugins/test_importsource.py#x1B[0m:163: AssertionError

To view more test analytics, go to the Test Analytics Dashboard
_{📋 Got 3 mins? Take this short survey to help us improve Test Analytics.}

[github-actions]

Thank you for the PR! The changelog has not been updated, so here is a friendly reminder to check if you need to add an entry.

[sourcery-ai]

Hey - I've found 1 issue, and left some high level feedback:

• When checking self.config["suggest_removal"] in __init__, consider using the appropriate config API (e.g. .get(bool) / .as_bool()) instead of relying on the truthiness of the ConfigView itself to make the intent explicit and avoid subtle behavior changes if the config layer changes.
• The tests access plugins._instances[0] which assumes a specific plugin ordering and a single instance; if possible, consider narrowing this to the concrete plugin instance more directly (e.g. by type or name) to make the tests more robust to future changes in plugin loading.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- When checking `self.config["suggest_removal"]` in `__init__`, consider using the appropriate config API (e.g. `.get(bool)` / `.as_bool()`) instead of relying on the truthiness of the ConfigView itself to make the intent explicit and avoid subtle behavior changes if the config layer changes.
- The tests access `plugins._instances[0]` which assumes a specific plugin ordering and a single instance; if possible, consider narrowing this to the concrete plugin instance more directly (e.g. by type or name) to make the tests more robust to future changes in plugin loading.

## Individual Comments

### Comment 1
<location> `beetsplug/importsource.py:29-30` </location>
<code_context>
-        self.register_listener(
-            "import_task_choice", self.prevent_suggest_removal
-        )
+        # Only register removal suggestion listeners if the feature is enabled
+        if self.config["suggest_removal"]:
+            # In order to stop future removal suggestions for an album we keep
+            # track of `mb_albumid`s in this set.
</code_context>

<issue_to_address>
**issue (bug_risk):** Guard should likely use a boolean value from config instead of relying on truthiness of the config view.

In beets, `self.config["suggest_removal"]` is a `ConfigView`, which is always truthy regardless of the configured boolean. As a result, this condition will always pass and the listeners will be registered even when the feature is disabled. Use the underlying boolean value instead (e.g. `self.config["suggest_removal"].get(bool)` or `.as_bool()`).
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[Copilot]

Pull request overview

This PR optimizes the importsource plugin by conditionally registering event listeners only when the suggest_removal feature is enabled. This follows the principle of not registering unnecessary event handlers when functionality is disabled.

Changes:

• Modified plugin initialization to conditionally register item_removed and import_task_choice listeners based on configuration
• Added comprehensive tests to verify listener registration behavior in both enabled and disabled states

Reviewed changes

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

File	Description
beetsplug/importsource.py	Wrapped listener registration and attribute initialization in a conditional block that checks the suggest_removal config value
test/plugins/test_importsource.py	Added new test class with two tests verifying that listeners and attributes are only created when the feature is enabled

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[github-actions]

Thank you for the PR! The changelog has not been updated, so here is a friendly reminder to check if you need to add an entry.

[Copilot]

Pull request overview

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