Refactor PluginsService to use plugin file path for better stability #15871
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…e that is more likely to change.
Collaborator
|
|
iamgabrielma
approved these changes
Jul 7, 2025
| /// - Parameters: | ||
| /// - siteID: The site ID to search for the plugin. | ||
| /// - plugin: The plugin's file path (e.g., "woocommerce/woocommerce.php" for WooCommerce). | ||
| /// - isActive: Whether to wait for the plugin to be active or inactive. |
Contributor
There was a problem hiding this comment.
nit: I think the usage of "wait for" bit here could be miss leading, since we're not waiting but matching the current plugin state in storage. wdyt?
Suggested change
| /// - isActive: Whether to wait for the plugin to be active or inactive. | |
| /// - isActive: Whether to match a plugin that is currently active or inactive. |
Contributor
Author
There was a problem hiding this comment.
Thanks for catching this inaccurate comment, updated the comment in 5f83b82.
| public func waitForPluginInStorage(siteID: Int64, pluginName: String, isActive: Bool) async -> SystemPlugin { | ||
| let predicate = \StorageSystemPlugin.siteID == siteID && \StorageSystemPlugin.name == pluginName && \StorageSystemPlugin.active == isActive | ||
| let nameDescriptor = NSSortDescriptor(keyPath: \StorageSystemPlugin.name, ascending: true) | ||
| public func waitForPluginInStorage(siteID: Int64, plugin: String, isActive: Bool) async -> SystemPlugin { |
Contributor
There was a problem hiding this comment.
Nit: How about updating the signature to pluginPath, or similar? Just to be more explicit about what we need to pass in.
…waitForPluginInStorage` to improve readability.
Collaborator
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For WOOMOB-760
Just one review is required.
Description
Refactors the
PluginsService.waitForPluginInStoragemethod to use the stable plugin file path identifier instead of the potentially changing plugin display name. This change improves reliability when querying for plugins in storage by using the plugin's file path (e.g., "woocommerce/woocommerce.php") which is less likely to change compared to display names.The plugin file path is the stable identifier used by WordPress internally and returned by the WooCommerce REST API
/wp-json/wc/v3/system_statusendpoint in theactive_plugins.pluginfield.Steps to reproduce
Testing information
RELEASE-NOTES.txtif necessary.