From af9b4a292e4c289c50fcd96eeabcc49cf3e3045e Mon Sep 17 00:00:00 2001 From: Enea Jahollari Date: Thu, 30 Mar 2023 12:28:48 +0200 Subject: [PATCH 1/6] Fix error message when updating ORCID settings --- .../orcid-sync-settings/orcid-sync-settings.component.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/app/item-page/orcid-page/orcid-sync-settings/orcid-sync-settings.component.ts b/src/app/item-page/orcid-page/orcid-sync-settings/orcid-sync-settings.component.ts index 494075c0f0..1ed8e95616 100644 --- a/src/app/item-page/orcid-page/orcid-sync-settings/orcid-sync-settings.component.ts +++ b/src/app/item-page/orcid-page/orcid-sync-settings/orcid-sync-settings.component.ts @@ -156,7 +156,8 @@ export class OrcidSyncSettingsComponent implements OnInit { } }), ).subscribe((remoteData: RemoteData) => { - if (remoteData.isSuccess) { + // hasSucceeded is true if the response is success or successStale + if (remoteData.hasSucceeded) { this.notificationsService.success(this.translateService.get(this.messagePrefix + '.synchronization-settings-update.success')); this.settingsUpdated.emit(); } else { From 89eb4e3cb2a8a07f45ee939f74387f1624c4e0c5 Mon Sep 17 00:00:00 2001 From: Enea Jahollari Date: Wed, 3 May 2023 15:29:12 +0200 Subject: [PATCH 2/6] [DURACOM-131] Show output files in separate lines --- src/app/process-page/detail/process-detail.component.html | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/app/process-page/detail/process-detail.component.html b/src/app/process-page/detail/process-detail.component.html index 29cbfc113f..8825c71cee 100644 --- a/src/app/process-page/detail/process-detail.component.html +++ b/src/app/process-page/detail/process-detail.component.html @@ -17,10 +17,12 @@
+
- {{getFileName(file)}} - ({{(file?.sizeBytes) | dsFileSize }}) + {{getFileName(file)}} + ({{(file?.sizeBytes) | dsFileSize }}) +
From c066bc9d54e7ea0c9256ffedc7bb02b4ff2ee6b9 Mon Sep 17 00:00:00 2001 From: Enea Jahollari Date: Wed, 3 May 2023 17:22:20 +0200 Subject: [PATCH 3/6] [DURACOM-131] Added automatic refresh every 5 seconds if the status is running --- .../detail/process-detail.component.html | 19 ++-- .../detail/process-detail.component.ts | 102 ++++++++++++++---- 2 files changed, 93 insertions(+), 28 deletions(-) diff --git a/src/app/process-page/detail/process-detail.component.html b/src/app/process-page/detail/process-detail.component.html index 8825c71cee..9e7a24d3af 100644 --- a/src/app/process-page/detail/process-detail.component.html +++ b/src/app/process-page/detail/process-detail.component.html @@ -1,10 +1,15 @@ -
-
-

{{'process.detail.title' | translate:{ - id: process?.processId, - name: process?.scriptName - } }}

+
+
+
+

+ {{ 'process.detail.title' | translate:{ id: process?.processId, name: process?.scriptName } }} +

+
+
+ Refreshing in {{ seconds }}s +
+
{{ process?.scriptName }}
 @@ -72,7 +77,7 @@ -
+
diff --git a/src/app/process-page/detail/process-detail.component.ts b/src/app/process-page/detail/process-detail.component.ts index 2e7dea5def..01ec3df19c 100644 --- a/src/app/process-page/detail/process-detail.component.ts +++ b/src/app/process-page/detail/process-detail.component.ts @@ -1,7 +1,7 @@ import { HttpClient } from '@angular/common/http'; -import { Component, NgZone, OnInit } from '@angular/core'; +import { Component, NgZone, OnDestroy, OnInit } from '@angular/core'; import { ActivatedRoute, Router } from '@angular/router'; -import { BehaviorSubject, Observable } from 'rxjs'; +import { BehaviorSubject, interval, Observable, shareReplay, Subscription } from 'rxjs'; import { finalize, map, switchMap, take, tap } from 'rxjs/operators'; import { AuthService } from '../../core/auth/auth.service'; import { DSONameService } from '../../core/breadcrumbs/dso-name.service'; @@ -26,6 +26,7 @@ import { NgbModal, NgbModalRef } from '@ng-bootstrap/ng-bootstrap'; import { getProcessListRoute } from '../process-page-routing.paths'; import { NotificationsService } from '../../shared/notifications/notifications.service'; import { TranslateService } from '@ngx-translate/core'; +import { followLink } from '../../shared/utils/follow-link-config.model'; @Component({ selector: 'ds-process-detail', @@ -34,7 +35,7 @@ import { TranslateService } from '@ngx-translate/core'; /** * A component displaying detailed information about a DSpace Process */ -export class ProcessDetailComponent implements OnInit { +export class ProcessDetailComponent implements OnInit, OnDestroy { /** * The AlertType enumeration @@ -65,48 +66,55 @@ export class ProcessDetailComponent implements OnInit { /** * Boolean on whether or not to show the output logs */ - showOutputLogs; + showOutputLogs = false; /** * When it's retrieving the output logs from backend, to show loading component */ - retrievingOutputLogs$: BehaviorSubject; + retrievingOutputLogs$ = new BehaviorSubject(false); /** * Date format to use for start and end time of processes */ dateFormat = 'yyyy-MM-dd HH:mm:ss ZZZZ'; + refreshCounter$ = new BehaviorSubject(0); + /** * Reference to NgbModal */ protected modalRef: NgbModalRef; - constructor(protected route: ActivatedRoute, - protected router: Router, - protected processService: ProcessDataService, - protected bitstreamDataService: BitstreamDataService, - protected nameService: DSONameService, - private zone: NgZone, - protected authService: AuthService, - protected http: HttpClient, - protected modalService: NgbModal, - protected notificationsService: NotificationsService, - protected translateService: TranslateService - ) { - } + private refreshTimerSub?: Subscription; + + constructor( + protected route: ActivatedRoute, + protected router: Router, + protected processService: ProcessDataService, + protected bitstreamDataService: BitstreamDataService, + protected nameService: DSONameService, + private zone: NgZone, + protected authService: AuthService, + protected http: HttpClient, + protected modalService: NgbModal, + protected notificationsService: NotificationsService, + protected translateService: TranslateService + ) {} /** * Initialize component properties * Display a 404 if the process doesn't exist */ ngOnInit(): void { - this.showOutputLogs = false; - this.retrievingOutputLogs$ = new BehaviorSubject(false); this.processRD$ = this.route.data.pipe( map((data) => { + if (!this.isProcessFinished(data.process.payload)) { + this.startRefreshTimer(); + } + return data.process as RemoteData; }), - redirectOn4xx(this.router, this.authService) + redirectOn4xx(this.router, this.authService), + shareReplay(1) ); this.filesRD$ = this.processRD$.pipe( @@ -115,6 +123,54 @@ export class ProcessDetailComponent implements OnInit { ); } + refresh() { + this.processRD$ = this.processService.findById( + this.route.snapshot.params.id, + false, + true, + followLink('script') + ).pipe( + getFirstSucceededRemoteData(), + redirectOn4xx(this.router, this.authService), + tap((processRemoteData: RemoteData) => { + console.log('refresh', processRemoteData); + if (!this.isProcessFinished(processRemoteData.payload)) { + this.startRefreshTimer(); + } + }), + shareReplay(1) + ); + + this.filesRD$ = this.processRD$.pipe( + getFirstSucceededRemoteDataPayload(), + switchMap((process: Process) => this.processService.getFiles(process.processId)) + ); + } + + startRefreshTimer() { + this.refreshCounter$.next(0); + + this.refreshTimerSub = interval(1000).subscribe( + value => { + if (value > 5) { + setTimeout(() => { + this.refresh(); + this.stopRefreshTimer(); + this.refreshCounter$.next(0); + }, 1); + } else { + this.refreshCounter$.next(5 - value); + } + }); + } + + stopRefreshTimer() { + if (hasValue(this.refreshTimerSub)) { + this.refreshTimerSub.unsubscribe(); + this.refreshTimerSub = undefined; + } + } + /** * Get the name of a bitstream * @param bitstream @@ -210,6 +266,7 @@ export class ProcessDetailComponent implements OnInit { openDeleteModal(content) { this.modalRef = this.modalService.open(content); } + /** * Close the modal. */ @@ -217,4 +274,7 @@ export class ProcessDetailComponent implements OnInit { this.modalRef.close(); } + ngOnDestroy(): void { + this.stopRefreshTimer(); + } } From efedd10d9c12da1909854d6661d2db264748b9ac Mon Sep 17 00:00:00 2001 From: Enea Jahollari Date: Wed, 3 May 2023 17:25:25 +0200 Subject: [PATCH 4/6] [DURACOM-131] Add check to run the refresh only on browser --- .../process-page/detail/process-detail.component.ts | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/src/app/process-page/detail/process-detail.component.ts b/src/app/process-page/detail/process-detail.component.ts index 01ec3df19c..a379dfe337 100644 --- a/src/app/process-page/detail/process-detail.component.ts +++ b/src/app/process-page/detail/process-detail.component.ts @@ -1,5 +1,5 @@ import { HttpClient } from '@angular/common/http'; -import { Component, NgZone, OnDestroy, OnInit } from '@angular/core'; +import { Component, Inject, NgZone, OnDestroy, OnInit, PLATFORM_ID } from '@angular/core'; import { ActivatedRoute, Router } from '@angular/router'; import { BehaviorSubject, interval, Observable, shareReplay, Subscription } from 'rxjs'; import { finalize, map, switchMap, take, tap } from 'rxjs/operators'; @@ -27,6 +27,7 @@ import { getProcessListRoute } from '../process-page-routing.paths'; import { NotificationsService } from '../../shared/notifications/notifications.service'; import { TranslateService } from '@ngx-translate/core'; import { followLink } from '../../shared/utils/follow-link-config.model'; +import { isPlatformBrowser } from '@angular/common'; @Component({ selector: 'ds-process-detail', @@ -87,6 +88,7 @@ export class ProcessDetailComponent implements OnInit, OnDestroy { private refreshTimerSub?: Subscription; constructor( + @Inject(PLATFORM_ID) protected platformId: object, protected route: ActivatedRoute, protected router: Router, protected processService: ProcessDataService, @@ -107,8 +109,10 @@ export class ProcessDetailComponent implements OnInit, OnDestroy { ngOnInit(): void { this.processRD$ = this.route.data.pipe( map((data) => { - if (!this.isProcessFinished(data.process.payload)) { - this.startRefreshTimer(); + if (isPlatformBrowser(this.platformId)) { + if (!this.isProcessFinished(data.process.payload)) { + this.startRefreshTimer(); + } } return data.process as RemoteData; @@ -133,7 +137,6 @@ export class ProcessDetailComponent implements OnInit, OnDestroy { getFirstSucceededRemoteData(), redirectOn4xx(this.router, this.authService), tap((processRemoteData: RemoteData) => { - console.log('refresh', processRemoteData); if (!this.isProcessFinished(processRemoteData.payload)) { this.startRefreshTimer(); } From dbccda4330eb7ece591cfab4795bfa75e786e958 Mon Sep 17 00:00:00 2001 From: Enea Jahollari Date: Tue, 6 Jun 2023 14:13:13 +0200 Subject: [PATCH 5/6] rollback change for orcid sync settings --- .../orcid-sync-settings/orcid-sync-settings.component.ts | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/app/item-page/orcid-page/orcid-sync-settings/orcid-sync-settings.component.ts b/src/app/item-page/orcid-page/orcid-sync-settings/orcid-sync-settings.component.ts index 1aec416d62..0bcbc295ac 100644 --- a/src/app/item-page/orcid-page/orcid-sync-settings/orcid-sync-settings.component.ts +++ b/src/app/item-page/orcid-page/orcid-sync-settings/orcid-sync-settings.component.ts @@ -156,8 +156,7 @@ export class OrcidSyncSettingsComponent implements OnInit { } }), ).subscribe((remoteData: RemoteData) => { - // hasSucceeded is true if the response is success or successStale - if (remoteData.hasSucceeded) { + if (remoteData.isSuccess) { this.notificationsService.success(this.translateService.get(this.messagePrefix + '.synchronization-settings-update.success')); this.settingsUpdated.emit(); } else { From 3fdef20dc2555d1760e53bdbfe4c37d41055f64e Mon Sep 17 00:00:00 2001 From: Enea Jahollari Date: Tue, 6 Jun 2023 15:54:57 +0200 Subject: [PATCH 6/6] added unit testing --- .../detail/process-detail.component.html | 2 +- .../detail/process-detail.component.spec.ts | 100 +++++++++++++++++- 2 files changed, 100 insertions(+), 2 deletions(-) diff --git a/src/app/process-page/detail/process-detail.component.html b/src/app/process-page/detail/process-detail.component.html index 9e7a24d3af..5f905cbfff 100644 --- a/src/app/process-page/detail/process-detail.component.html +++ b/src/app/process-page/detail/process-detail.component.html @@ -5,7 +5,7 @@ {{ 'process.detail.title' | translate:{ id: process?.processId, name: process?.scriptName } }}
-
+
Refreshing in {{ seconds }}s
diff --git a/src/app/process-page/detail/process-detail.component.spec.ts b/src/app/process-page/detail/process-detail.component.spec.ts index 8749553eae..9552f9a092 100644 --- a/src/app/process-page/detail/process-detail.component.spec.ts +++ b/src/app/process-page/detail/process-detail.component.spec.ts @@ -35,6 +35,7 @@ import { NotificationsServiceStub } from '../../shared/testing/notifications-ser import { NgbModal } from '@ng-bootstrap/ng-bootstrap'; import { NotificationsService } from '../../shared/notifications/notifications.service'; import { getProcessListRoute } from '../process-page-routing.paths'; +import {ProcessStatus} from '../processes/process-status.model'; describe('ProcessDetailComponent', () => { let component: ProcessDetailComponent; @@ -44,6 +45,7 @@ describe('ProcessDetailComponent', () => { let nameService: DSONameService; let bitstreamDataService: BitstreamDataService; let httpClient: HttpClient; + let route: ActivatedRoute; let process: Process; let fileName: string; @@ -106,7 +108,8 @@ describe('ProcessDetailComponent', () => { }); processService = jasmine.createSpyObj('processService', { getFiles: createSuccessfulRemoteDataObject$(createPaginatedList(files)), - delete: createSuccessfulRemoteDataObject$(null) + delete: createSuccessfulRemoteDataObject$(null), + findById: createSuccessfulRemoteDataObject$(process), }); bitstreamDataService = jasmine.createSpyObj('bitstreamDataService', { findByHref: createSuccessfulRemoteDataObject$(logBitstream) @@ -127,6 +130,13 @@ describe('ProcessDetailComponent', () => { router = jasmine.createSpyObj('router', { navigateByUrl:{} }); + + route = jasmine.createSpyObj('route', { + data: observableOf({ process: createSuccessfulRemoteDataObject(process) }), + snapshot: { + params: { id: process.processId } + } + }); } beforeEach(waitForAsync(() => { @@ -263,4 +273,92 @@ describe('ProcessDetailComponent', () => { }); }); + describe('refresh counter', () => { + const queryRefreshCounter = () => fixture.debugElement.query(By.css('.refresh-counter')); + + describe('if process is completed', () => { + beforeEach(() => { + process.processStatus = ProcessStatus.COMPLETED; + route.data = observableOf({process: createSuccessfulRemoteDataObject(process)}); + }); + + it('should not show', () => { + spyOn(component, 'startRefreshTimer'); + + const refreshCounter = queryRefreshCounter(); + expect(refreshCounter).toBeNull(); + + expect(component.startRefreshTimer).not.toHaveBeenCalled(); + }); + }); + + describe('if process is not finished', () => { + beforeEach(() => { + process.processStatus = ProcessStatus.RUNNING; + route.data = observableOf({process: createSuccessfulRemoteDataObject(process)}); + fixture.detectChanges(); + component.stopRefreshTimer(); + }); + + it('should call startRefreshTimer', () => { + spyOn(component, 'startRefreshTimer'); + + component.ngOnInit(); + fixture.detectChanges(); // subscribe to process observable with async pipe + + expect(component.startRefreshTimer).toHaveBeenCalled(); + }); + + it('should call refresh method every 5 seconds, until process is completed', fakeAsync(() => { + spyOn(component, 'refresh'); + spyOn(component, 'stopRefreshTimer'); + + process.processStatus = ProcessStatus.COMPLETED; + // set findbyId to return a completed process + (processService.findById as jasmine.Spy).and.returnValue(observableOf(createSuccessfulRemoteDataObject(process))); + + component.ngOnInit(); + fixture.detectChanges(); // subscribe to process observable with async pipe + + expect(component.refresh).not.toHaveBeenCalled(); + + expect(component.refreshCounter$.value).toBe(0); + + tick(1001); // 1 second + 1 ms by the setTimeout + expect(component.refreshCounter$.value).toBe(5); // 5 - 0 + + tick(2001); // 2 seconds + 1 ms by the setTimeout + expect(component.refreshCounter$.value).toBe(3); // 5 - 2 + + tick(2001); // 2 seconds + 1 ms by the setTimeout + expect(component.refreshCounter$.value).toBe(1); // 3 - 2 + + tick(1001); // 1 second + 1 ms by the setTimeout + expect(component.refreshCounter$.value).toBe(0); // 1 - 1 + + tick(1000); // 1 second + + expect(component.refresh).toHaveBeenCalledTimes(1); + expect(component.stopRefreshTimer).toHaveBeenCalled(); + + expect(component.refreshCounter$.value).toBe(0); + + tick(1001); // 1 second + 1 ms by the setTimeout + // startRefreshTimer not called again + expect(component.refreshCounter$.value).toBe(0); + + discardPeriodicTasks(); // discard any periodic tasks that have not yet executed + })); + + it('should show if refreshCounter is different from 0', () => { + component.refreshCounter$.next(1); + fixture.detectChanges(); + + const refreshCounter = queryRefreshCounter(); + expect(refreshCounter).not.toBeNull(); + }); + + }); + + }); });