-
Notifications
You must be signed in to change notification settings - Fork 65
refactor: template steps #813
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
Open
davidfrigolet
wants to merge
3
commits into
develop
Choose a base branch
from
features/refactor-template-steps
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
125 changes: 125 additions & 0 deletions
125
core/flamingock-core-api/src/main/java/io/flamingock/api/template/TemplateStep.java
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,125 @@ | ||
| /* | ||
| * Copyright 2025 Flamingock (https://www.flamingock.io) | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package io.flamingock.api.template; | ||
|
|
||
| /** | ||
| * Represents a single step in a step-based change template. | ||
| * | ||
| * <p>Each step contains an {@code apply} operation that executes during the forward | ||
| * migration, and an optional {@code rollback} operation that executes if the step | ||
| * or a subsequent step fails.</p> | ||
| * | ||
| * <h2>YAML Structure</h2> | ||
| * <pre>{@code | ||
| * steps: | ||
| * - apply: | ||
| * type: createCollection | ||
| * collection: users | ||
| * rollback: | ||
| * type: dropCollection | ||
| * collection: users | ||
| * - apply: | ||
| * type: insert | ||
| * collection: users | ||
| * parameters: | ||
| * documents: | ||
| * - name: "John" | ||
| * rollback: | ||
| * type: delete | ||
| * collection: users | ||
| * parameters: | ||
| * filter: {} | ||
| * }</pre> | ||
| * | ||
| * <h2>Rollback Behavior</h2> | ||
| * <ul> | ||
| * <li>Rollback is optional - steps without rollback are skipped during rollback</li> | ||
| * <li>When a step fails, all previously successful steps are rolled back in reverse order</li> | ||
| * <li>Rollback errors are logged but don't stop the rollback process</li> | ||
| * </ul> | ||
| * | ||
| * @param <APPLY> the type of the apply payload | ||
| * @param <ROLLBACK> the type of the rollback payload | ||
| */ | ||
| public class TemplateStep<APPLY, ROLLBACK> { | ||
|
|
||
| private APPLY apply; | ||
| private ROLLBACK rollback; | ||
|
|
||
| public TemplateStep() { | ||
| } | ||
|
|
||
| public TemplateStep(APPLY apply, ROLLBACK rollback) { | ||
| this.apply = apply; | ||
| this.rollback = rollback; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the apply payload for this step. | ||
| * | ||
| * @return the apply payload (required) | ||
| */ | ||
| public APPLY getApply() { | ||
| return apply; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the apply payload for this step. | ||
| * | ||
| * @param apply the apply payload | ||
| */ | ||
| public void setApply(APPLY apply) { | ||
| this.apply = apply; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the rollback payload for this step. | ||
| * | ||
| * @return the rollback payload, or null if no rollback is defined | ||
| */ | ||
| public ROLLBACK getRollback() { | ||
| return rollback; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the rollback payload for this step. | ||
| * | ||
| * @param rollback the rollback payload (optional) | ||
| */ | ||
| public void setRollback(ROLLBACK rollback) { | ||
| this.rollback = rollback; | ||
| } | ||
|
|
||
| /** | ||
| * Checks if this step has a rollback payload defined. | ||
| * | ||
| * @return true if a rollback payload is defined | ||
| */ | ||
| public boolean hasRollback() { | ||
| return rollback != null; | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| StringBuilder sb = new StringBuilder("TemplateStep{"); | ||
| sb.append("apply=").append(apply); | ||
| if (rollback != null) { | ||
| sb.append(", rollback=").append(rollback); | ||
| } | ||
| sb.append('}'); | ||
| return sb.toString(); | ||
| } | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
Cannot make this at least a generic list List? Ideally a
List<TemplateStep>