feat(plugins): Support refactoring out core code #733
Closed
Conversation
This file contains 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
Utility to help refactor core service functionality out into plugins.
An example `PluginRefactorRule`, for removing `kork-pubsub-aws` from core could be put in `kork-pubsub`:
```java
public class AwsPubsubPluginRefactorRule implements PluginRefactorRule {
private final static String PLUGIN_ID = "io.spinnaker.infra.amazon";
private final static String IGNORE_KEY = "korkPubsubSqs";
@nonnull
@OverRide
public Set<MissingPlugin> checkForMissingPlugins(
@nonnull Environment environment,
@nonnull SpinnakerPluginManager pluginManager
) {
if (hasAwsPubsubEnabled(environment) && !pluginManager.hasPlugin(PLUGIN_ID)) {
return Collections.singleton(new MissingPlugin(
PLUGIN_ID,
"'amazon.pubsub.enabled' is true, but SQS support has been moved out of core into a plugin.",
IGNORE_KEY,
this,
null
));
}
return Collections.emptySet();
}
private static boolean hasAwsPubsubEnabled(Environment environment) {
return environment.getProperty("pubsub.amazon.enabled", Boolean.class, false);
}
}
```
robzienert
commented
Aug 5, 2020
| @@ -20,7 +20,8 @@ dependencies { | |||
| implementation("com.squareup.retrofit2:converter-jackson") | |||
| implementation("com.squareup.okhttp3:logging-interceptor") | |||
|
|
|||
| implementation "org.pf4j:pf4j" | |||
| // Needs to be api because SpinnakerPluginManager extends DefaultPluginManager. | |||
| api "org.pf4j:pf4j" | |||
There was a problem hiding this comment.
I was kicking around the idea of a PluginService that would encapsulate the PluginManager, allowing this to stay implementation, but decided against out of laziness. I can revisit if we want.
jonsie
reviewed
Aug 5, 2020
|
|
||
| @Bean | ||
| public static PluginRefactorRule amazonSqsPluginRefactorRule() { | ||
| return new AwsPubsubPluginRefactorRule(); |
There was a problem hiding this comment.
Are you planning on adding this here?
jonsie
reviewed
Aug 5, 2020
| fun toMessage(): String = | ||
| "${source.javaClass.simpleName} has detected plugin '${pluginId}'${minVersionMessage()} is missing: ${message.trim('.')}. " + | ||
| "If you know this plugin's capabilities are satisfied another way, you may ignore this rule by setting " + | ||
| "'${ignoreConfig(ignoreKey)}' to 'true'" |
jonsie
approved these changes
Aug 5, 2020
jonsie
reviewed
Aug 5, 2020
| * Helps core services and libraries break existing functionality out into plugins by helping operators detect | ||
| * removed functionality. | ||
| */ | ||
| interface PluginRefactorRule { |
jonsie
reviewed
Aug 5, 2020
| * if a service is configured for functionality that was built into the core service offering, but has since | ||
| * been refactored out into a plugin. | ||
| */ | ||
| class PluginRefactorService( |
There was a problem hiding this comment.
And add @Alpha here too I think.
|
Will revisit another time. |
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.
Utility to help refactor core service functionality out into plugins.
An example
PluginRefactorRule, for removingkork-pubsub-awsfrom core could be put inkork-pubsub:✏️ I had originally written this with the concept of auto-downloading plugins, but I've rolled that back in favor of hard-crashing the service. Downloading on behalf of the operator can be revisited down the road if need be.