Add stop button for audit log rotation (#17054)

Signed-off-by: AllForNothing <sshijun@vmware.com>

src/portal/src/app/base/left-side-nav/clearing-job/audit-log-purge/history/purge-history.component.html

@@ -4,7 +4,22 @@
 <span class="refresh-btn" (click)="refresh()">
     <clr-icon shape="refresh"></clr-icon>
 </span>
-<clr-datagrid [clrDgLoading]="loading" (clrDgRefresh)="getJobs(true, $event)">
+<clr-datagrid
+    [(clrDgSelected)]="selectedRow"
+    [clrDgLoading]="loading"
+    (clrDgRefresh)="getJobs(true, $event)">
+    <clr-dg-action-bar>
+        <div class="btn-group">
+            <button
+                id="stop-purge"
+                type="button"
+                class="btn btn-secondary"
+                [disabled]="!canStop()"
+                (click)="openStopExecutionsDialog()">
+                {{ 'REPLICATION.STOPJOB' | translate }}
+            </button>
+        </div>
+    </clr-dg-action-bar>
     <clr-dg-column [clrDgField]="'id'">{{
         'GC.JOB_ID' | translate
     }}</clr-dg-column>

src/portal/src/app/base/left-side-nav/clearing-job/audit-log-purge/history/purge-history.component.spec.ts

@@ -13,6 +13,7 @@ import { delay } from 'rxjs/operators';
 import { PurgeHistoryComponent } from './purge-history.component';
 import { ExecHistory } from '../../../../../../../ng-swagger-gen/models/exec-history';
 import { PurgeService } from 'ng-swagger-gen/services/purge.service';
+import { ConfirmationDialogService } from '../../../../global-confirmation-dialog/confirmation-dialog.service';
 
 describe('GcHistoryComponent', () => {
     let component: PurgeHistoryComponent;
@@ -65,11 +66,18 @@ describe('GcHistoryComponent', () => {
             }
         },
     };
+    const fakedConfirmationDialogService = {
+        openComfirmDialog() {},
+    };
     beforeEach(() => {
         TestBed.configureTestingModule({
             declarations: [PurgeHistoryComponent],
             imports: [SharedTestingModule],
             providers: [
+                {
+                    provide: ConfirmationDialogService,
+                    useValue: fakedConfirmationDialogService,
+                },
                 { provide: PurgeService, useValue: fakedPurgeService },
                 // open auto detect
                 { provide: ComponentFixtureAutoDetect, useValue: true },
@@ -103,4 +111,14 @@ describe('GcHistoryComponent', () => {
             `${CURRENT_BASE_HREF}/system/purgeaudit/1/log`
         );
     });
+    it('stopping purging should work', () => {
+        const sy: jasmine.Spy = spyOn(
+            fakedConfirmationDialogService,
+            'openComfirmDialog'
+        ).and.returnValue(undefined);
+        const stopBtn: HTMLButtonElement =
+            fixture.nativeElement.querySelector('#stop-purge');
+        stopBtn.dispatchEvent(new Event('click'));
+        expect(sy.calls.count()).toEqual(1);
+    });
 });

src/portal/src/app/base/left-side-nav/clearing-job/audit-log-purge/history/purge-history.component.ts

@@ -1,8 +1,12 @@
-import { Component, OnDestroy } from '@angular/core';
+import { Component, OnDestroy, OnInit } from '@angular/core';
 import { ClrDatagridStateInterface } from '@clr/angular';
-import { GCHistory } from 'ng-swagger-gen/models/gchistory';
+import { finalize, forkJoin, Subscription, timer } from 'rxjs';
-import { finalize, Subscription, timer } from 'rxjs';
+import {
-import { REFRESH_TIME_DIFFERENCE } from 'src/app/shared/entities/shared.const';
+    ConfirmationButtons,
+    ConfirmationState,
+    ConfirmationTargets,
+    REFRESH_TIME_DIFFERENCE,
+} from 'src/app/shared/entities/shared.const';
 import { ErrorHandler } from 'src/app/shared/units/error-handler/error-handler';
 import {
     CURRENT_BASE_HREF,
@@ -13,14 +17,17 @@ import {
 } from 'src/app/shared/units/utils';
 import { PurgeService } from '../../../../../../../ng-swagger-gen/services/purge.service';
 import { JOB_STATUS, NO, YES } from '../../clearing-job-interfact';
+import { ConfirmationMessage } from '../../../../global-confirmation-dialog/confirmation-message';
+import { ConfirmationDialogService } from '../../../../global-confirmation-dialog/confirmation-dialog.service';
+import { ExecHistory } from '../../../../../../../ng-swagger-gen/models/exec-history';
 
 @Component({
     selector: 'app-purge-history',
     templateUrl: './purge-history.component.html',
     styleUrls: ['./purge-history.component.scss'],
 })
-export class PurgeHistoryComponent implements OnDestroy {
+export class PurgeHistoryComponent implements OnInit, OnDestroy {
-    jobs: Array<GCHistory> = [];
+    jobs: Array<ExecHistory> = [];
     loading: boolean = true;
     timerDelay: Subscription;
     pageSize: number = getPageSizeFromLocalStorage(
@@ -30,10 +37,61 @@ export class PurgeHistoryComponent implements OnDestroy {
     page: number = 1;
     total: number = 0;
     state: ClrDatagridStateInterface;
+    selectedRow: ExecHistory[] = [];
+    isStopOnGoing: boolean = false;
+    subscription: Subscription;
     constructor(
         private purgeService: PurgeService,
-        private errorHandler: ErrorHandler
+        private errorHandler: ErrorHandler,
+        private confirmationDialogService: ConfirmationDialogService
     ) {}
+    ngOnInit() {
+        if (!this.subscription) {
+            this.subscription =
+                this.confirmationDialogService.confirmationConfirm$.subscribe(
+                    message => {
+                        if (
+                            message &&
+                            message.state === ConfirmationState.CONFIRMED &&
+                            message.source ===
+                                ConfirmationTargets.STOP_AUDIT_LOG_ROTATION
+                        ) {
+                            this.stopRotation(message.data);
+                        }
+                    }
+                );
+        }
+    }
+    ngOnDestroy() {
+        if (this.timerDelay) {
+            this.timerDelay.unsubscribe();
+            this.timerDelay = null;
+        }
+        if (this.subscription) {
+            this.subscription.unsubscribe();
+            this.subscription = null;
+        }
+    }
+
+    stopRotation(execHistories: ExecHistory[]) {
+        this.isStopOnGoing = true;
+        forkJoin(
+            execHistories.map(item => {
+                return this.purgeService.stopPurge({
+                    purgeId: item.id,
+                });
+            })
+        )
+            .pipe(finalize(() => (this.isStopOnGoing = false)))
+            .subscribe({
+                next: res => {
+                    this.errorHandler.info('CLEARANCES.STOP_PURGE_SUCCESS');
+                },
+                error: err => {
+                    this.errorHandler.error(err);
+                },
+            });
+    }
     refresh() {
         this.page = 1;
         this.total = 0;
@@ -81,7 +139,22 @@ export class PurgeHistoryComponent implements OnDestroy {
                         if (xHeader) {
                             this.total = parseInt(xHeader, 0);
                         }
-                        this.jobs = res.body;
+                        if (!withLoading) {
+                            if (res?.body?.length) {
+                                res.body.forEach(item => {
+                                    this.jobs.forEach(item2 => {
+                                        if (item2.id === item.id) {
+                                            item2.job_status = item.job_status;
+                                            item2.update_time =
+                                                item.update_time;
+                                        }
+                                    });
+                                });
+                            }
+                        } else {
+                            this.selectedRow = [];
+                            this.jobs = res.body;
+                        }
                     }
                     // to avoid some jobs not finished.
                     if (!this.timerDelay) {
@@ -124,14 +197,36 @@ export class PurgeHistoryComponent implements OnDestroy {
         return NO;
     }
 
-    ngOnDestroy() {
-        if (this.timerDelay) {
-            this.timerDelay.unsubscribe();
-            this.timerDelay = null;
-        }
-    }
-
     getLogLink(id): string {
         return `${CURRENT_BASE_HREF}/system/purgeaudit/${id}/log`;
     }
+    canStop(): boolean {
+        if (this.isStopOnGoing) {
+            return false;
+        }
+        if (this.selectedRow?.length) {
+            return (
+                this.selectedRow.filter(item => {
+                    return (
+                        item.job_status === JOB_STATUS.PENDING ||
+                        item.job_status === JOB_STATUS.RUNNING
+                    );
+                })?.length > 0
+            );
+        }
+        return false;
+    }
+
+    openStopExecutionsDialog() {
+        const executionIds = this.selectedRow.map(robot => robot.id).join(',');
+        let StopExecutionsMessage = new ConfirmationMessage(
+            'REPLICATION.STOP_TITLE',
+            'REPLICATION.STOP_SUMMARY',
+            executionIds,
+            this.selectedRow,
+            ConfirmationTargets.STOP_AUDIT_LOG_ROTATION,
+            ConfirmationButtons.CONFIRM_CANCEL
+        );
+        this.confirmationDialogService.openComfirmDialog(StopExecutionsMessage);
+    }
 }

src/portal/src/app/base/left-side-nav/clearing-job/audit-log-purge/set-job/set-job.component.html

@@ -54,8 +54,8 @@
     <form #purgeForm="ngForm" class="clr-form clr-form-horizontal p-0">
         <div class="clr-form-control mt-0">
             <span class="required font-style flex-200"
-                >{{ 'CLEARANCES.KEEP_IN' | translate }}
+                >{{ 'CLEARANCES.KEEP_IN' | translate
-                <clr-tooltip>
+                }}<clr-tooltip>
                     <clr-icon
                         clrTooltipTrigger
                         shape="info-circle"

src/portal/src/app/base/left-side-nav/clearing-job/gc-page/gc/gc-history/gc-history.component.html

@@ -11,6 +11,7 @@
     <clr-dg-action-bar>
         <div class="btn-group">
             <button
+                id="stop-gc"
                 type="button"
                 class="btn btn-secondary"
                 [disabled]="!canStop()"

src/portal/src/app/base/left-side-nav/clearing-job/gc-page/gc/gc-history/gc-history.component.spec.ts

@@ -14,6 +14,7 @@ import { Registry } from '../../../../../../../../ng-swagger-gen/models/registry
 import { GcService } from '../../../../../../../../ng-swagger-gen/services/gc.service';
 import { CURRENT_BASE_HREF } from '../../../../../../shared/units/utils';
 import { delay } from 'rxjs/operators';
+import { ConfirmationDialogService } from '../../../../../global-confirmation-dialog/confirmation-dialog.service';
 
 describe('GcHistoryComponent', () => {
     let component: GcHistoryComponent;
@@ -65,12 +66,22 @@ describe('GcHistoryComponent', () => {
                 return of(response).pipe(delay(0));
             }
         },
+        stopGC() {
+            return of(null);
+        },
+    };
+    const fakedConfirmationDialogService = {
+        openComfirmDialog() {},
     };
     beforeEach(() => {
         TestBed.configureTestingModule({
             declarations: [GcHistoryComponent],
             imports: [SharedTestingModule],
             providers: [
+                {
+                    provide: ConfirmationDialogService,
+                    useValue: fakedConfirmationDialogService,
+                },
                 { provide: GcService, useValue: fakedGcService },
                 // open auto detect
                 { provide: ComponentFixtureAutoDetect, useValue: true },
@@ -104,4 +115,14 @@ describe('GcHistoryComponent', () => {
             `${CURRENT_BASE_HREF}/system/gc/1/log`
         );
     });
+    it('stopping GC should work', () => {
+        const sy: jasmine.Spy = spyOn(
+            fakedConfirmationDialogService,
+            'openComfirmDialog'
+        ).and.returnValue(undefined);
+        const stopBtn: HTMLButtonElement =
+            fixture.nativeElement.querySelector('#stop-gc');
+        stopBtn.dispatchEvent(new Event('click'));
+        expect(sy.calls.count()).toEqual(1);
+    });
 });

src/portal/src/app/shared/entities/shared.const.ts

@@ -55,6 +55,7 @@ export const enum ConfirmationTargets {
     ACCESSORY,
     ALL_ACCESSORIES,
     STOP_GC,
+    STOP_AUDIT_LOG_ROTATION,
 }
 
 export const enum ActionType {

src/portal/src/i18n/lang/de-de-lang.json

@@ -1751,6 +1751,7 @@
         "FORWARD_ENDPOINT_TOOLTIP": "Forward audit logs to the syslog endpoint, for example: harbor-log:10514",
         "SKIP_DATABASE": "Skip Audit Log Database",
         "SKIP_DATABASE_TOOLTIP": "Skip to log audit log in the database, only available when audit log forward endpoint is configured",
-        "STOP_GC_SUCCESS": "Trigger stop GC operation successfully"
+        "STOP_GC_SUCCESS": "Trigger stopping GC operation successfully",
+        "STOP_PURGE_SUCCESS": "Trigger stopping purging operation successfully"
     }
 }

src/portal/src/i18n/lang/en-us-lang.json

@@ -1751,6 +1751,7 @@
         "FORWARD_ENDPOINT_TOOLTIP": "Forward audit logs to the syslog endpoint, for example: harbor-log:10514",
         "SKIP_DATABASE": "Skip Audit Log Database",
         "SKIP_DATABASE_TOOLTIP": "Skip to log audit log in the database, only available when audit log forward endpoint is configured",
-        "STOP_GC_SUCCESS": "Trigger stop GC operation successfully"
+        "STOP_GC_SUCCESS": "Trigger stopping GC operation successfully",
+        "STOP_PURGE_SUCCESS": "Trigger stopping purging operation successfully"
     }
 }

src/portal/src/i18n/lang/es-es-lang.json

@@ -1750,6 +1750,7 @@
         "FORWARD_ENDPOINT_TOOLTIP": "Forward audit logs to the syslog endpoint, for example: harbor-log:10514",
         "SKIP_DATABASE": "Skip Audit Log Database",
         "SKIP_DATABASE_TOOLTIP": "Skip to log audit log in the database, only available when audit log forward endpoint is configured",
-        "STOP_GC_SUCCESS": "Trigger stop GC operation successfully"
+        "STOP_GC_SUCCESS": "Trigger stopping GC operation successfully",
+        "STOP_PURGE_SUCCESS": "Trigger stopping purging operation successfully"
     }
 }

src/portal/src/i18n/lang/fr-fr-lang.json

@@ -1720,6 +1720,7 @@
         "FORWARD_ENDPOINT_TOOLTIP": "Forward audit logs to the syslog endpoint, for example: harbor-log:10514",
         "SKIP_DATABASE": "Skip Audit Log Database",
         "SKIP_DATABASE_TOOLTIP": "Skip to log audit log in the database, only available when audit log forward endpoint is configured",
-        "STOP_GC_SUCCESS": "Trigger stop GC operation successfully"
+        "STOP_GC_SUCCESS": "Trigger stopping GC operation successfully",
+        "STOP_PURGE_SUCCESS": "Trigger stopping purging operation successfully"
     }
 }

src/portal/src/i18n/lang/pt-br-lang.json

@@ -1747,6 +1747,7 @@
         "FORWARD_ENDPOINT_TOOLTIP": "Forward audit logs to the syslog endpoint, for example: harbor-log:10514",
         "SKIP_DATABASE": "Skip Audit Log Database",
         "SKIP_DATABASE_TOOLTIP": "Skip to log audit log in the database, only available when audit log forward endpoint is configured",
-        "STOP_GC_SUCCESS": "Trigger stop GC operation successfully"
+        "STOP_GC_SUCCESS": "Trigger stopping GC operation successfully",
+        "STOP_PURGE_SUCCESS": "Trigger stopping purging operation successfully"
     }
 }

src/portal/src/i18n/lang/tr-tr-lang.json

@@ -1751,6 +1751,7 @@
         "FORWARD_ENDPOINT_TOOLTIP": "Forward audit logs to the syslog endpoint, for example: harbor-log:10514",
         "SKIP_DATABASE": "Skip Audit Log Database",
         "SKIP_DATABASE_TOOLTIP": "Skip to log audit log in the database, only available when audit log forward endpoint is configured",
-        "STOP_GC_SUCCESS": "Trigger stop GC operation successfully"
+        "STOP_GC_SUCCESS": "Trigger stopping GC operation successfully",
+        "STOP_PURGE_SUCCESS": "Trigger stopping purging operation successfully"
     }
 }

src/portal/src/i18n/lang/zh-cn-lang.json

@@ -1749,6 +1749,7 @@
         "FORWARD_ENDPOINT_TOOLTIP": "将日志转发到指定的 syslog 端点，例如：harbor-log:10514",
         "SKIP_DATABASE": "跳过日志数据库",
         "SKIP_DATABASE_TOOLTIP": "开启此项将不会在数据库中记录日志，需先配置日志转发端点",
-        "STOP_GC_SUCCESS": "成功触发停止垃圾回收的操作"
+        "STOP_GC_SUCCESS": "成功触发停止垃圾回收的操作",
+        "STOP_PURGE_SUCCESS": "成功触发停止清理日志的操作"
     }
 }

src/portal/src/i18n/lang/zh-tw-lang.json

@@ -1742,6 +1742,7 @@
     "FORWARD_ENDPOINT_TOOLTIP": "Forward audit logs to the syslog endpoint, for example: harbor-log:10514",
     "SKIP_DATABASE": "Skip Audit Log Database",
     "SKIP_DATABASE_TOOLTIP": "Skip to log audit log in the database, only available when audit log forward endpoint is configured",
-    "STOP_GC_SUCCESS": "Trigger stop GC operation successfully"
+    "STOP_GC_SUCCESS": "Trigger stopping GC operation successfully",
+    "STOP_PURGE_SUCCESS": "Trigger stopping purging operation successfully"
   }
 }