Merged in task/dspace-cris-2023_02_x/DSC-1665 (pull request DSpace#1640)

Task/dspace cris 2023 02 x/DSC-1665

Approved-by: Francesco Molinaro

Author: Andrea Barbasso

src/app/shared/loading/loading.component.spec.ts

@@ -7,6 +7,8 @@ import { TranslateLoader, TranslateModule, TranslateService } from '@ngx-transla
 import { TranslateLoaderMock } from '../mocks/translate-loader.mock';
 
 import { LoadingComponent } from './loading.component';
+import { Router } from '@angular/router';
+import { RouterMock } from '../mocks/router.mock';
 
 describe('LoadingComponent (inline template)', () => {
 
@@ -26,8 +28,12 @@ describe('LoadingComponent (inline template)', () => {
         }),
       ],
       declarations: [LoadingComponent], // declare the test component
-      providers: [TranslateService]
+      providers: [
+        TranslateService,
+        {provide: Router, useValue: new RouterMock()},
+      ]
     }).compileComponents();  // compile template and css
+
   }));
 
   beforeEach(() => {
@@ -75,4 +81,14 @@ describe('LoadingComponent (inline template)', () => {
     expect(de).toBeTruthy();
   });
 
+  it('should add time if the page has been automatically reloaded', () => {
+    comp.pageReloadCount = 1;
+    comp.errorMessageDelay = 1000;
+    comp.warningMessageDelay = 500;
+    comp.numberOfAutomaticPageReloads = 2;
+    comp.ngOnInit();
+
+    expect(comp.errorTimeoutWithRetriesDelay).toBe(1500);
+  });
+
 });

src/app/shared/loading/loading.component.ts

@@ -5,6 +5,8 @@ import { TranslateService } from '@ngx-translate/core';
 import { hasValue } from '../empty.util';
 import { environment } from '../../../environments/environment';
 import { AlertType } from '../alert/alert-type';
+import { Router } from '@angular/router';
+import { Location } from '@angular/common';
 
 enum MessageType {
   LOADING = 'loading',
@@ -19,6 +21,8 @@ enum MessageType {
 })
 export class LoadingComponent implements OnDestroy, OnInit {
 
+  readonly QUERY_PARAM_RELOAD_COUNT = 'reloadCount';
+
   @Input() message: string;
   @Input() showMessage = true;
 
@@ -27,6 +31,10 @@ export class LoadingComponent implements OnDestroy, OnInit {
   @Input() warningMessageDelay = environment.loader.warningMessageDelay;
   @Input() errorMessage: string;
   @Input() errorMessageDelay = environment.loader.errorMessageDelay;
+  errorTimeoutWithRetriesDelay = environment.loader.errorMessageDelay;
+
+
+  @Input() numberOfAutomaticPageReloads = environment.loader.numberOfAutomaticPageReloads || 0;
 
   /**
    * Show a more compact spinner animation instead of the default one
@@ -39,30 +47,70 @@ export class LoadingComponent implements OnDestroy, OnInit {
   warningTimeout: any;
   errorTimeout: any;
 
+  pageReloadCount = 0;
+
   readonly AlertTypeEnum = AlertType;
 
-  constructor(private translate: TranslateService, private changeDetectorRef: ChangeDetectorRef) {
+  constructor(
+    private router: Router,
+    private location: Location,
+    private translate: TranslateService,
+    private changeDetectorRef: ChangeDetectorRef) {
 
   }
 
   ngOnInit() {
+    // saving current url and query params for the upcoming router trick
+    let currentUrl = this.router.url.split('?')[0];
+    const queryParams = new URLSearchParams(this.router.url.split('?')[1]);
+
+    // get reload count from state
+    const reloadCount = (this.location.getState() as any)?.[this.QUERY_PARAM_RELOAD_COUNT];
+    if (hasValue(reloadCount)) {
+      this.pageReloadCount = +reloadCount;
+    }
+
+    // calculate the delay for the error message with retries
+    this.errorTimeoutWithRetriesDelay = this.errorMessageDelay + this.pageReloadCount * (this.errorMessageDelay - this.warningMessageDelay);
+
     if (this.showMessage) {
       this.message = this.message || this.translate.instant('loading.default');
     }
+
     if (this.showFallbackMessages) {
       this.warningMessage = this.warningMessage || this.translate.instant('loading.warning');
       this.errorMessage = this.errorMessage || this.translate.instant('loading.error');
+
       if (this.warningMessageDelay > 0) {
         this.warningTimeout = setTimeout(() => {
           this.messageToShow = MessageType.WARNING;
           this.changeDetectorRef.detectChanges();
         }, this.warningMessageDelay);
       }
+
       if (this.errorMessageDelay > 0) {
         this.errorTimeout = setTimeout(() => {
-          this.messageToShow = MessageType.ERROR;
-          this.changeDetectorRef.detectChanges();
-        }, this.errorMessageDelay);
+          // if the page has been reloaded less than the maximum number of retries
+          if (this.pageReloadCount < this.numberOfAutomaticPageReloads) {
+            this.pageReloadCount++;
+            // navigate to a fake url to trigger a reload of the current page
+            // this is needed because the router does not reload the page if the url is the same,
+            // even if the state changes and the onSameUrlNavigation property is set to 'reload'
+            this.router.navigate(['/fake-url'], {queryParams, queryParamsHandling: 'merge', skipLocationChange: true}).then(() => {
+              // navigate back to the current url
+              this.router.navigate([currentUrl], {
+                queryParams,
+                queryParamsHandling: 'merge',
+                onSameUrlNavigation: 'reload',
+                state: {[this.QUERY_PARAM_RELOAD_COUNT]: this.pageReloadCount}
+              });
+            });
+          } else {
+            // if the page has been reloaded the maximum number of retries
+            this.messageToShow = MessageType.ERROR;
+            this.changeDetectorRef.detectChanges();
+          }
+        }, this.errorTimeoutWithRetriesDelay);
       }
     }
   }

src/app/shared/loading/themed-loading.component.ts

@@ -17,6 +17,7 @@ export class ThemedLoadingComponent extends ThemedComponent<LoadingComponent> {
   @Input() showMessage: boolean;
   @Input() spinner: boolean;
   @Input() showFallbackMessages: boolean;
+  @Input() numberOfAutomaticPageReloads: number;
   @Input() warningMessage: string;
   @Input() warningMessageDelay: number;
   @Input() errorMessage: string;
@@ -27,6 +28,7 @@ export class ThemedLoadingComponent extends ThemedComponent<LoadingComponent> {
     'showMessage',
     'spinner',
     'showFallbackMessages',
+    'numberOfAutomaticPageReloads',
     'warningMessage',
     'warningMessageDelay',
     'errorMessage',

src/config/default-app-config.ts

@@ -795,6 +795,7 @@ export class DefaultAppConfig implements AppConfig {
     showFallbackMessagesByDefault: false,
     warningMessageDelay: 5000, // 5 seconds
     errorMessageDelay: 15000, // 15 seconds
+    numberOfAutomaticPageReloads: 2,
   };
 
   metaTags: MetaTagsConfig = {

src/config/loader-config.interfaces.ts

@@ -4,4 +4,5 @@ export interface LoaderConfig extends Config {
   showFallbackMessagesByDefault: boolean;
   warningMessageDelay: number;
   errorMessageDelay: number;
+  numberOfAutomaticPageReloads: number;
 }

src/environments/environment.test.ts

@@ -582,6 +582,7 @@ export const environment: BuildConfig = {
     showFallbackMessagesByDefault: true,
     warningMessageDelay: 1000,
     errorMessageDelay: 2000,
+    numberOfAutomaticPageReloads: 2,
   },
 
   metaTags: {