Add phase-configs support to Hook model for target-app resolution #1812
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| package org.cloudfoundry.multiapps.controller.process.steps; | ||
|
|
||
| import java.text.MessageFormat; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| import jakarta.inject.Named; | ||
| import org.cloudfoundry.multiapps.controller.client.lib.domain.CloudApplicationExtended; | ||
| import org.cloudfoundry.multiapps.controller.core.model.ApplicationColor; | ||
| import org.cloudfoundry.multiapps.controller.core.model.BlueGreenApplicationNameSuffix; | ||
| import org.cloudfoundry.multiapps.controller.core.model.HookPhaseProcessType; | ||
| import org.cloudfoundry.multiapps.controller.core.model.SupportedParameters; | ||
| import org.cloudfoundry.multiapps.controller.process.Messages; | ||
| import org.cloudfoundry.multiapps.controller.process.variables.Variables; | ||
| import org.cloudfoundry.multiapps.mta.model.Hook; | ||
| import org.springframework.beans.factory.config.BeanDefinition; | ||
| import org.springframework.context.annotation.Scope; | ||
|
|
||
| @Named("resolveHookTaskTargetAppStep") | ||
| @Scope(BeanDefinition.SCOPE_PROTOTYPE) | ||
| public class ResolveHookTaskTargetAppStep extends SyncFlowableStep { | ||
|
|
||
| private static final String PHASE_KEY = "phase"; | ||
| private static final String TARGET_APP_KEY = "target-app"; | ||
| private static final String APPLICATION_PHASE_SUBSTRING = ".application."; | ||
|
|
||
| @Override | ||
| protected StepPhase executeStep(ProcessContext context) { | ||
| CloudApplicationExtended app = context.getVariable(Variables.APP_TO_PROCESS); | ||
| Hook hook = context.getVariable(Variables.HOOK_FOR_EXECUTION); | ||
|
Contributor
There was a problem hiding this comment. Instead of passing it as argument, just get it in resolveTargetAppName |
||
|
|
||
| String resolvedAppName = resolveTargetAppName(context, app, hook); | ||
| if (!resolvedAppName.equals(app.getName())) { | ||
| context.setVariable(Variables.APP_TO_PROCESS, buildAppWithName(app, resolvedAppName)); | ||
| } | ||
|
|
||
| return StepPhase.DONE; | ||
| } | ||
|
|
||
| private String resolveTargetAppName(ProcessContext context, CloudApplicationExtended app, Hook hook) { | ||
| if (hook == null) { | ||
| return app.getName(); | ||
| } | ||
|
|
||
| List<Map<String, String>> phasesConfig = getPhasesConfig(hook); | ||
| if (phasesConfig.isEmpty()) { | ||
| return app.getName(); | ||
| } | ||
|
|
||
| String currentPhase = buildCurrentPhaseString(context, hook); | ||
| String targetApp = phasesConfig.stream() | ||
| .filter(config -> currentPhase.equals(config.get(PHASE_KEY))) | ||
| .map(config -> config.get(TARGET_APP_KEY)) | ||
| .findFirst() | ||
| .orElse(null); | ||
|
|
||
| if (targetApp == null) { | ||
| return app.getName(); | ||
| } | ||
|
|
||
| return resolveAppNameForTarget(context, app, targetApp); | ||
| } | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| private List<Map<String, String>> getPhasesConfig(Hook hook) { | ||
| Object phasesConfigValue = hook.getParameters() | ||
| .get(SupportedParameters.PHASES_CONFIG); | ||
| if (phasesConfigValue instanceof List) { | ||
| return (List<Map<String, String>>) phasesConfigValue; | ||
| } | ||
| return List.of(); | ||
| } | ||
|
|
||
| private String buildCurrentPhaseString(ProcessContext context, Hook hook) { | ||
| String hookExecutionPhase = context.getVariable(Variables.HOOK_EXECUTION_PHASE); | ||
| return hook.getPhases() | ||
| .stream() | ||
| .filter(p -> p.equals(hookExecutionPhase)) | ||
| .findFirst() | ||
| .orElseGet(() -> hook.getPhases() | ||
| .stream() | ||
| .filter(p -> p.contains(APPLICATION_PHASE_SUBSTRING)) | ||
| .findFirst() | ||
| .orElse("")); | ||
|
Comment on lines
+80
to
+84
Contributor
There was a problem hiding this comment. Why are we searching for the first application hook? |
||
| } | ||
|
|
||
| private String resolveAppNameForTarget(ProcessContext context, CloudApplicationExtended app, String targetApp) { | ||
|
Contributor
There was a problem hiding this comment. What will happen if we using hook:
Contributor
Author
There was a problem hiding this comment. With the current implementation we hit 404. What’s the right approach here- should the process fail or just log a warning? Also, should the combination of phase: blue-green.application.before-start.idle and target-app: live even be allowed during an initial deployment? |
||
| ApplicationColor idleColor = context.getVariable(Variables.IDLE_MTA_COLOR); | ||
| ApplicationColor liveColor = context.getVariable(Variables.LIVE_MTA_COLOR); | ||
|
|
||
| if (idleColor == null || liveColor == null) { | ||
| return resolveAppNameWithLiveIdleSuffix(app.getName(), targetApp); | ||
| } | ||
|
|
||
| if (HookPhaseProcessType.HookProcessPhase.IDLE.getType().equals(targetApp)) { | ||
| return swapColorSuffix(app.getName(), liveColor, idleColor); | ||
| } | ||
| if (HookPhaseProcessType.HookProcessPhase.LIVE.getType().equals(targetApp)) { | ||
| return swapColorSuffix(app.getName(), idleColor, liveColor); | ||
| } | ||
| return app.getName(); | ||
| } | ||
|
|
||
| private String resolveAppNameWithLiveIdleSuffix(String appName, String targetApp) { | ||
| String liveSuffix = BlueGreenApplicationNameSuffix.LIVE.asSuffix(); | ||
| String idleSuffix = BlueGreenApplicationNameSuffix.IDLE.asSuffix(); | ||
|
|
||
| if (HookPhaseProcessType.HookProcessPhase.IDLE.getType().equals(targetApp)) { | ||
| if (appName.endsWith(liveSuffix)) { | ||
|
Contributor
There was a problem hiding this comment. When blue-green.application.before-start.idle is used. The apps are still called (for example): |
||
| return appName.substring(0, appName.length() - liveSuffix.length()); | ||
| } | ||
| if (!appName.endsWith(idleSuffix)) { | ||
| return appName + idleSuffix; | ||
| } | ||
| } | ||
| if (HookPhaseProcessType.HookProcessPhase.LIVE.getType().equals(targetApp)) { | ||
|
Contributor
There was a problem hiding this comment. Can we simplify these conditions as they are hard to read? -- |
||
| if (appName.endsWith(idleSuffix)) { | ||
| return appName.substring(0, appName.length() - idleSuffix.length()); | ||
| } | ||
| if (!appName.endsWith(liveSuffix)) { | ||
| return appName + liveSuffix; | ||
| } | ||
| } | ||
| return appName; | ||
| } | ||
|
|
||
| private String swapColorSuffix(String appName, ApplicationColor fromColor, ApplicationColor toColor) { | ||
| String fromSuffix = fromColor.asSuffix(); | ||
| String toSuffix = toColor.asSuffix(); | ||
| if (appName.endsWith(fromSuffix)) { | ||
| return appName.substring(0, appName.length() - fromSuffix.length()) + toSuffix; | ||
| } | ||
| if (!appName.endsWith(toSuffix)) { | ||
| return appName + toSuffix; | ||
| } | ||
|
Comment on lines
+127
to
+135
Contributor
There was a problem hiding this comment. Can you just remove suffix BlueGreenApplicationNameSuffix::removeSuffix then append toColor? |
||
| return appName; | ||
| } | ||
|
|
||
| private CloudApplicationExtended buildAppWithName(CloudApplicationExtended app, String resolvedAppName) { | ||
| return org.cloudfoundry.multiapps.controller.client.lib.domain.ImmutableCloudApplicationExtended.copyOf(app) | ||
| .withName(resolvedAppName); | ||
| } | ||
|
|
||
| @Override | ||
| protected String getStepErrorMessage(ProcessContext context) { | ||
| return MessageFormat.format(Messages.ERROR_EXECUTING_HOOK, | ||
| context.getVariable(Variables.HOOK_FOR_EXECUTION).getName()); | ||
| } | ||
|
|
||
| } | ||
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
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
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
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
extract this validation in a new class