Skip to content
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

Remove Plugin.createComponents method that specifies individual services #101457

Merged
merged 4 commits into from Oct 30, 2023

Conversation

thecoop
Copy link
Member

@thecoop thecoop commented Oct 27, 2023

Remove the createComponents method that specifies individual services, in favour of the PluginServices method.

This is a breaking change for all plugin implementations; implementations should move to the createComponents(PluginServices) method

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra (Team:Core/Infra)

Copy link
Contributor

@ldematte ldematte left a comment

Choose a reason for hiding this comment

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

LGTM, of course when CI passes :)
(I see you added the serverless update test too, so this will cover all!)

@williamrandolph
Copy link
Contributor

I'd suggest a small change to the "breaking change" message. While it would be a breaking change for a lot of plugins, plugins aren't required to override createComponents. For example, I checked our plugins examples directory and none of them use it. Furthermore, stable plugins interfaces don't use this method, so a stable analysis plugin would not be affected.

Rather, I'd specify that it's a breaking change for any plugin that overrides Plugin#createComponents.

I hope I'm not coming off as pedantic. Mainly I don't want to accidentally imply that we're breaking the stability guarantee for stable plugins when we're not actually doing that.

@thecoop
Copy link
Member Author

thecoop commented Oct 27, 2023

I've tweaked the changelog wording

Copy link
Contributor

@williamrandolph williamrandolph left a comment

Choose a reason for hiding this comment

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

LGTM!

@thecoop thecoop merged commit bf2921f into elastic:main Oct 30, 2023
14 checks passed
@thecoop thecoop deleted the remove-create-components branch October 30, 2023 11:41
mark-vieira pushed a commit to mark-vieira/elasticsearch that referenced this pull request Nov 2, 2023
…ces (elastic#101457)

This is a breaking change for plugins implementing createComponents. Subclasses should be refactored to implement the method that takes a PluginServices object instead.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants