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

support rollback to specified release (#2858) #3093

Merged
merged 6 commits into from
Jun 14, 2020
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
support rollback to specified release (#2858)
cbcc committed May 26, 2020
commit 44e94d203ef71ce5566902b07ac9458c1cbe6f61
Original file line number Diff line number Diff line change
@@ -168,9 +168,15 @@ public ReleaseDTO updateAndPublish(@PathVariable("appId") String appId,
@Transactional
@PutMapping("/releases/{releaseId}/rollback")
public void rollback(@PathVariable("releaseId") long releaseId,
@RequestParam(name="toReleaseId", defaultValue = "-1") long toReleaseId,
@RequestParam("operator") String operator) {

Release release = releaseService.rollback(releaseId, operator);
Release release;
if (toReleaseId > -1) {
release = releaseService.rollbackTo(releaseId, toReleaseId, operator);
} else {
release = releaseService.rollback(releaseId, operator);
}

String appId = release.getAppId();
String clusterName = release.getClusterName();
Original file line number Diff line number Diff line change
@@ -25,6 +25,8 @@ Release findFirstByAppIdAndClusterNameAndNamespaceNameAndIsAbandonedFalseOrderBy

List<Release> findByAppIdAndClusterNameAndNamespaceNameAndIsAbandonedFalseOrderByIdDesc(String appId, String clusterName, String namespaceName, Pageable page);

List<Release> findByAppIdAndClusterNameAndNamespaceNameAndIdBetweenOrderByIdDesc(String appId, String clusterName, String namespaceName, long formId, long toId);
cbcc marked this conversation as resolved.
Show resolved Hide resolved

List<Release> findByReleaseKeyIn(Set<String> releaseKey);

List<Release> findByIdIn(Set<Long> releaseIds);
Original file line number Diff line number Diff line change
@@ -131,6 +131,20 @@ public List<Release> findActiveReleases(String appId, String clusterName, String
return releases;
}

public List<Release> findByReleaseIdBetween(String appId, String clusterName, String namespaceName,
cbcc marked this conversation as resolved.
Show resolved Hide resolved
long fromReleaseId, long toReleaseId) {
List<Release>
releases =
releaseRepository.findByAppIdAndClusterNameAndNamespaceNameAndIdBetweenOrderByIdDesc(appId, clusterName,
namespaceName,
fromReleaseId,
toReleaseId);
if (releases == null) {
return Collections.emptyList();
}
return releases;
}

@Transactional
public Release mergeBranchChangeSetsAndRelease(Namespace namespace, String branchName, String releaseName,
String releaseComment, boolean isEmergencyPublish,
@@ -454,6 +468,57 @@ public Release rollback(long releaseId, String operator) {
return release;
}

@Transactional
public Release rollbackTo(long releaseId, long toReleaseId, String operator) {
if (releaseId == toReleaseId) {
throw new BadRequestException("current release equal to target release");
}

Release release = findOne(releaseId);
Release toRelease = findOne(toReleaseId);
if (release == null || toRelease == null) {
throw new NotFoundException("release not found");
}
if (release.isAbandoned()) {
throw new BadRequestException("release is not active");
}

String appId = release.getAppId();
String clusterName = release.getClusterName();
String namespaceName = release.getNamespaceName();

List<Release> releases;
boolean isBackward = toReleaseId < releaseId;
if (isBackward) {
releases = findByReleaseIdBetween(appId, clusterName, namespaceName,
toReleaseId, releaseId);
if (toRelease.isAbandoned()) {
cbcc marked this conversation as resolved.
Show resolved Hide resolved
toRelease.setAbandoned(false);
toRelease.setDataChangeLastModifiedBy(operator);
releaseRepository.save(toRelease);
}
} else {
releases = findByReleaseIdBetween(appId, clusterName, namespaceName,
releaseId, toReleaseId);
}

for (int i = 0; i < releases.size() - 1; i++) {
releases.get(i).setAbandoned(isBackward);
cbcc marked this conversation as resolved.
Show resolved Hide resolved
releases.get(i).setDataChangeLastModifiedBy(operator);
}

releaseRepository.saveAll(releases);

releaseHistoryService.createReleaseHistory(appId, clusterName,
namespaceName, clusterName, toReleaseId,
release.getId(), ReleaseOperation.ROLLBACK, null, operator);

//publish child namespace if namespace has child
rollbackChildNamespace(appId, clusterName, namespaceName, Lists.newArrayList(release, toRelease), operator);

return release;
}

private void rollbackChildNamespace(String appId, String clusterName, String namespaceName,
List<Release> parentNamespaceTwoLatestActiveRelease, String operator) {
Namespace parentNamespace = namespaceService.findOne(appId, clusterName, namespaceName);
Original file line number Diff line number Diff line change
@@ -9,6 +9,7 @@
import com.ctrip.framework.apollo.biz.repository.ReleaseRepository;
import com.ctrip.framework.apollo.common.exception.BadRequestException;

import java.util.ArrayList;
import java.util.Optional;
import org.junit.Assert;
import org.junit.Before;
@@ -108,6 +109,72 @@ public void testRollback() {
Assert.assertEquals(user, firstRelease.getDataChangeLastModifiedBy());
}

@Test
public void testRollbackToBackward() {
List<Release> releaseList = new ArrayList<>();
for (int i = 0; i < 3; i++) {
Release release = new Release();
release.setId(3 - i);
release.setAppId(appId);
release.setClusterName(clusterName);
release.setNamespaceName(namespaceName);
release.setAbandoned(false);
releaseList.add(release);
}
long releaseId1 = 1;
long releaseId3 = 3;
when(releaseRepository.findById(releaseId1)).thenReturn(Optional.of(releaseList.get(2)));
when(releaseRepository.findById(releaseId3)).thenReturn(Optional.of(releaseList.get(0)));
when(releaseRepository.findByAppIdAndClusterNameAndNamespaceNameAndIdBetweenOrderByIdDesc(appId,
clusterName,
namespaceName,
releaseId1,
releaseId3))
.thenReturn(releaseList);

releaseService.rollbackTo(releaseId3, releaseId1, user);

verify(releaseRepository).saveAll(releaseList);
Assert.assertTrue(releaseList.get(0).isAbandoned());
Assert.assertTrue(releaseList.get(1).isAbandoned());
Assert.assertFalse(releaseList.get(2).isAbandoned());
Assert.assertEquals(user, releaseList.get(0).getDataChangeLastModifiedBy());
Assert.assertEquals(user, releaseList.get(1).getDataChangeLastModifiedBy());
}

@Test
public void testRollbackToForward() {
List<Release> releaseList = new ArrayList<>();
for (int i = 0; i < 3; i++) {
Release release = new Release();
release.setId(3 - i);
release.setAppId(appId);
release.setClusterName(clusterName);
release.setNamespaceName(namespaceName);
release.setAbandoned(true);
releaseList.add(release);
}
releaseList.get(2).setAbandoned(false);
long releaseId1 = 1;
long releaseId3 = 3;
when(releaseRepository.findById(releaseId1)).thenReturn(Optional.of(releaseList.get(2)));
when(releaseRepository.findById(releaseId3)).thenReturn(Optional.of(releaseList.get(0)));
when(releaseRepository.findByAppIdAndClusterNameAndNamespaceNameAndIdBetweenOrderByIdDesc(appId,
clusterName,
namespaceName,
releaseId1,
releaseId3))
.thenReturn(releaseList);

releaseService.rollbackTo(releaseId1, releaseId3, user);

verify(releaseRepository).saveAll(releaseList);
Assert.assertFalse(releaseList.get(0).isAbandoned());
Assert.assertFalse(releaseList.get(1).isAbandoned());
Assert.assertFalse(releaseList.get(2).isAbandoned());
Assert.assertEquals(user, releaseList.get(0).getDataChangeLastModifiedBy());
Assert.assertEquals(user, releaseList.get(1).getDataChangeLastModifiedBy());
}

@Test
public void testFindRelease() throws Exception {
Original file line number Diff line number Diff line change
@@ -347,6 +347,12 @@ public void rollback(Env env, long releaseId, String operator) {
"releases/{releaseId}/rollback?operator={operator}",
null, releaseId, operator);
}

public void rollbackTo(Env env, long releaseId, long toReleaseId, String operator) {
restTemplate.put(env,
"releases/{releaseId}/rollback?toReleaseId={toReleaseId}&operator={operator}",
null, releaseId, toReleaseId, operator);
}
}

@Service
Original file line number Diff line number Diff line change
@@ -112,6 +112,16 @@ public ReleaseDTO createGrayRelease(@PathVariable String appId,
return createdRelease;
}

@GetMapping("/envs/{env}/releases/{releaseId}")
public ReleaseDTO get(@PathVariable String env,
@PathVariable long releaseId) {
ReleaseDTO release = releaseService.findReleaseById(Env.valueOf(env), releaseId);

if (release == null) {
throw new NotFoundException("release not found");
}
return release;
}

@GetMapping(value = "/apps/{appId}/envs/{env}/clusters/{clusterName}/namespaces/{namespaceName}/releases/all")
public List<ReleaseBO> findAllReleases(@PathVariable String appId,
@@ -153,7 +163,8 @@ public ReleaseCompareResult compareRelease(@PathVariable String env,

@PutMapping(path = "/envs/{env}/releases/{releaseId}/rollback")
public void rollback(@PathVariable String env,
@PathVariable long releaseId) {
@PathVariable long releaseId,
@RequestParam(defaultValue = "-1") long toReleaseId) {
ReleaseDTO release = releaseService.findReleaseById(Env.valueOf(env), releaseId);

if (release == null) {
@@ -164,7 +175,11 @@ public void rollback(@PathVariable String env,
throw new AccessDeniedException("Access is denied");
}

releaseService.rollback(Env.valueOf(env), releaseId, userInfoHolder.getUser().getUserId());
if (toReleaseId > -1) {
releaseService.rollbackTo(Env.valueOf(env), releaseId, toReleaseId, userInfoHolder.getUser().getUserId());
} else {
releaseService.rollback(Env.valueOf(env), releaseId, userInfoHolder.getUser().getUserId());
}

ConfigPublishEvent event = ConfigPublishEvent.instance();
event.withAppId(release.getAppId())
Original file line number Diff line number Diff line change
@@ -143,6 +143,10 @@ public void rollback(Env env, long releaseId, String operator) {
releaseAPI.rollback(env, releaseId, operator);
}

public void rollbackTo(Env env, long releaseId, long toReleaseId, String operator) {
releaseAPI.rollbackTo(env, releaseId, toReleaseId, operator);
}

public ReleaseCompareResult compare(Env env, long baseReleaseId, long toCompareReleaseId) {

ReleaseDTO baseRelease = null;
21 changes: 21 additions & 0 deletions apollo-portal/src/main/resources/static/config/history.html
Original file line number Diff line number Diff line change
@@ -111,6 +111,16 @@ <h6 class="col-md-5 text-right" ng-bind="releaseHistory.releaseTimeFormatted"></
<small ng-show="history.releaseComment" ng-bind="history.releaseComment"></small>
</div>
<div class="col-md-7 text-right">
<button type="button" class="btn btn-default btn-sm" data-tooltip="tooltip" data-placement="bottom"
title="{{'Config.History.RollbackToTips' | translate }}"
ng-show="namespace.hasReleasePermission
&& (history.operation == 0 || history.operation == 1
|| history.operation == 4 || history.operation == 5
|| history.operation == 6)"
cbcc marked this conversation as resolved.
Show resolved Hide resolved
ng-click="preRollback()">
<img src="../img/rollback.png">
{{'Config.History.RollbackTo' | translate }}
</button>
<div class="btn-group">
<button type="button" class="btn btn-default btn-sm"
ng-class="{'active':history.viewType == 'diff'}" data-tooltip="tooltip"
@@ -256,6 +266,15 @@ <h4 class="text-center empty-container" ng-show="!isConfigHidden">
</section>

<showtextmodal text="text"></showtextmodal>

<rollbackmodal app-id="pageContext.appId" env="pageContext.env" cluster="pageContext.clusterName">
</rollbackmodal>

<apolloconfirmdialog apollo-dialog-id="'rollbackAlertDialog'"
apollo-title="'Config.RollbackAlert.DialogTitle' | translate"
apollo-detail="'Config.RollbackAlert.DialogContent' | translate" apollo-show-cancel-btn="true"
apollo-confirm="rollback">
</apolloconfirmdialog>
</div>


@@ -291,6 +310,7 @@ <h4 class="text-center empty-container" ng-show="!isConfigHidden">
<script type="application/javascript" src="../scripts/services/ReleaseHistoryService.js"></script>
<script type="application/javascript" src="../scripts/services/ConfigService.js"></script>
<script type="application/javascript" src="../scripts/services/PermissionService.js"></script>
<script type="application/javascript" src="../scripts/services/EventManager.js"></script>

<script type="application/javascript" src="../scripts/AppUtils.js"></script>
<script type="application/javascript" src="../scripts/controller/config/ReleaseHistoryController.js"></script>
@@ -299,6 +319,7 @@ <h4 class="text-center empty-container" ng-show="!isConfigHidden">
<script type="application/javascript" src="../scripts/directive/directive.js"></script>
<script type="application/javascript" src="../scripts/directive/show-text-modal-directive.js"></script>
<script type="application/javascript" src="../scripts/directive/diff-directive.js"></script>
<script type="application/javascript" src="../scripts/directive/rollback-modal-directive.js"></script>
</body>

</html>
4 changes: 4 additions & 0 deletions apollo-portal/src/main/resources/static/i18n/en.json
Original file line number Diff line number Diff line change
@@ -289,6 +289,7 @@
"Component.Publish.OpPublish": "Release",
"Component.Rollback.To": "roll back to",
"Component.Rollback.Tips": "This operation will roll back to the last released version, and the current version is abandoned, but there is no impact to the currently editing configurations. You may view the currently effective version in the release history page",
"Component.RollbackTo.Tips": "This operation will roll back to this released version, and the current version is abandoned, but there is no impact to the currently editing configurations",
cbcc marked this conversation as resolved.
Show resolved Hide resolved
"Component.Rollback.ClickToView": "Click to view",
"Component.Rollback.ItemType": "Type",
"Component.Rollback.ItemKey": "Key",
@@ -646,6 +647,8 @@
"Config.History.OperationType8": "Delete Grayscale(Full Release)",
"Config.History.UrgentPublish": "Emergency Release",
"Config.History.LoadMore": "Load more",
"Config.History.RollbackTo": "Rollback To This Release",
"Config.History.RollbackToTips": "Rollback released configuration to this release",
"Config.History.ChangedItem": "Changed Configuration",
"Config.History.ChangedItemTips": "View changes between this release and the previous release",
"Config.History.AllItem": "Full Configuration",
@@ -749,6 +752,7 @@
"ReleaseModal.AllPublished": "Full Release Successfully",
"ReleaseModal.AllPublishFailed": "Failed to Full Release",
"Rollback.NoRollbackList": "No released history to rollback",
"Rollback.SameAsCurrentRelease": "This release is the same as current release",
"Rollback.RollbackSuccessfully": "Rollback Successfully",
"Rollback.RollbackFailed": "Failed to Rollback",
"Revoke.RevokeFailed": "Failed to Revoke",
4 changes: 4 additions & 0 deletions apollo-portal/src/main/resources/static/i18n/zh-CN.json
Original file line number Diff line number Diff line change
@@ -289,6 +289,7 @@
"Component.Publish.OpPublish": "发布",
"Component.Rollback.To": "回滚到",
"Component.Rollback.Tips": "此操作将会回滚到上一个发布版本,且当前版本作废,但不影响正在修改的配置。可在发布历史页面查看当前生效的版本",
"Component.RollbackTo.Tips":"此操作将会回滚到此发布版本,且当前版本作废,但不影响正在修改的配置",
cbcc marked this conversation as resolved.
Show resolved Hide resolved
"Component.Rollback.ClickToView": "点击查看",
"Component.Rollback.ItemType": "Type",
"Component.Rollback.ItemKey": "Key",
@@ -646,6 +647,8 @@
"Config.History.OperationType8": "删除灰度(全量发布)",
"Config.History.UrgentPublish": "紧急发布",
"Config.History.LoadMore": "加载更多",
"Config.History.RollbackTo": "回滚到此版本",
"Config.History.RollbackToTips": "回滚已发布的配置到此版本",
"Config.History.ChangedItem": "变更的配置",
"Config.History.ChangedItemTips": "查看此次发布与上次版本的变更",
"Config.History.AllItem": "全部配置",
@@ -749,6 +752,7 @@
"ReleaseModal.AllPublished": "全量发布成功",
"ReleaseModal.AllPublishFailed": "全量发布失败",
"Rollback.NoRollbackList": "没有可以回滚的发布历史",
"Rollback.SameAsCurrentRelease": "该版本与当前版本相同",
"Rollback.RollbackSuccessfully": "回滚成功",
"Rollback.RollbackFailed": "回滚失败",
"Revoke.RevokeFailed": "撤销失败",
Loading