[SOLR-16946] Cluster Singleton stop method sometimes not called on Overseer close

• Type: Bug
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 9.0, 9.1, 9.2, 9.1.1, 9.3
• Fix Version/s: 9.4
• Component/s: Plugin system, SolrCloud
• Assignee: Noble Paul
• Reporter: Paul McArthur
• Created: 22/Aug/23 22:59
• Updated: 15/Oct/23 20:13
• Resolved: 23/Aug/23 12:02

Description

If a Cluster Singleton plugin is added, then the normal behavior is for the ClusterSingleton stop method to be called when the Overseer is closed.

However, if the plugin configuration is updated after it has been added, then the stop method is not called when the Overseer is closed.

When the /cluster/plugin API is called with an update payload, the ClusterSingletons.modified method is called, which adds the new plugin to the singletonMap (and starts it if applicable). Then it stops and removes the old one.

Given that the singletonMap is keyed on the plugin name, adding the replacement will overwrite the existing (old) entry in the map. Then when attempting to remove the previous plugin, the new replacement is inadvertently removed instead.

This leaves the singletonMap with no entry for the updated plugin. When the Overseer node goes down, the stop method is not called for the plugin because it does not have an entry in the map.

Issue Links

• links to: GitHub Pull Request #1862