Merge remote-tracking branch 'origin/main' into DSC-287-Show-an-error-page-if-the-REST-API-is-not-available

# Conflicts: # src/app/app-routing.module.ts
2025-10-07 01:54:15 +00:00 · 2021-12-15 15:00:47 +01:00
parent d426f5f179 4ace07156f
commit 8f4379f3b4
28 changed files with 100 additions and 39 deletions
--- a/docker/docker-compose-ci.yml
+++ b/docker/docker-compose-ci.yml
@@ -64,7 +64,7 @@ services:
  dspacesolr:
    container_name: dspacesolr
    # Uses official Solr image at https://hub.docker.com/_/solr/
-    image: solr:8.8
+    image: solr:8.11-slim
    # Needs main 'dspace' container to start first to guarantee access to solr_configs
    depends_on:
    - dspace
--- a/docker/docker-compose-rest.yml
+++ b/docker/docker-compose-rest.yml
@@ -62,7 +62,7 @@ services:
  dspacesolr:
    container_name: dspacesolr
    # Uses official Solr image at https://hub.docker.com/_/solr/
-    image: solr:8.8
+    image: solr:8.11-slim
    # Needs main 'dspace' container to start first to guarantee access to solr_configs
    depends_on:
    - dspace
--- a/src/app/admin/admin-search-page/admin-search.module.ts
+++ b/src/app/admin/admin-search-page/admin-search.module.ts
@@ -36,7 +36,7 @@ const ENTRY_COMPONENTS = [
 export class AdminSearchModule {
  /**
   * NOTE: this method allows to resolve issue with components that using a custom decorator
-   * which are not loaded during CSR otherwise
+   * which are not loaded during SSR otherwise
   */
  static withEntryComponents() {
    return {
--- a/src/app/admin/admin-workflow-page/admin-workflow.module.ts
+++ b/src/app/admin/admin-workflow-page/admin-workflow.module.ts
@@ -28,7 +28,7 @@ const ENTRY_COMPONENTS = [
 export class AdminWorkflowModuleModule {
  /**
   * NOTE: this method allows to resolve issue with components that using a custom decorator
-   * which are not loaded during CSR otherwise
+   * which are not loaded during SSR otherwise
   */
  static withEntryComponents() {
    return {
--- a/src/app/admin/admin.module.ts
+++ b/src/app/admin/admin.module.ts
@@ -34,7 +34,7 @@ const ENTRY_COMPONENTS = [
 export class AdminModule {
  /**
   * NOTE: this method allows to resolve issue with components that using a custom decorator
-   * which are not loaded during CSR otherwise
+   * which are not loaded during SSR otherwise
   */
  static withEntryComponents() {
    return {
--- a/src/app/app-routing.module.ts
+++ b/src/app/app-routing.module.ts
@@ -218,7 +218,6 @@ import { ServerCheckGuard } from './core/server-check/server-check.guard';
      }
    ], {
      onSameUrlNavigation: 'reload',
-    relativeLinkResolution: 'legacy'
 })
  ],
  exports: [RouterModule],
--- a/src/app/browse-by/browse-by.module.ts
+++ b/src/app/browse-by/browse-by.module.ts
@@ -31,7 +31,7 @@ const ENTRY_COMPONENTS = [
 export class BrowseByModule {
  /**
   * NOTE: this method allows to resolve issue with components that using a custom decorator
-   * which are not loaded during CSR otherwise
+   * which are not loaded during SSR otherwise
   */
  static withEntryComponents() {
    return {
--- a/src/app/entity-groups/journal-entities/journal-entities.module.ts
+++ b/src/app/entity-groups/journal-entities/journal-entities.module.ts
@@ -54,7 +54,7 @@ const ENTRY_COMPONENTS = [
 export class JournalEntitiesModule {
  /**
   * NOTE: this method allows to resolve issue with components that using a custom decorator
-   * which are not loaded during CSR otherwise
+   * which are not loaded during SSR otherwise
   */
  static withEntryComponents() {
    return {
--- a/src/app/entity-groups/research-entities/research-entities.module.ts
+++ b/src/app/entity-groups/research-entities/research-entities.module.ts
@@ -74,7 +74,7 @@ const COMPONENTS = [
 export class ResearchEntitiesModule {
  /**
   * NOTE: this method allows to resolve issue with components that using a custom decorator
-   * which are not loaded during CSR otherwise
+   * which are not loaded during SSR otherwise
   */
  static withEntryComponents() {
    return {
--- a/src/app/item-page/item-page.module.ts
+++ b/src/app/item-page/item-page.module.ts
@@ -33,7 +33,7 @@ import { NgxGalleryModule } from '@kolkov/ngx-gallery';
 import { MiradorViewerComponent } from './mirador-viewer/mirador-viewer.component';
 import { VersionPageComponent } from './version-page/version-page/version-page.component';
 import { VersionedItemComponent } from './simple/item-types/versioned-item/versioned-item.component';
-import { ThemedFileSectionComponent} from './simple/field-components/file-section/themed-file-section.component';
+import { ThemedFileSectionComponent } from './simple/field-components/file-section/themed-file-section.component';


 const ENTRY_COMPONENTS = [
@@ -91,7 +91,7 @@ const DECLARATIONS = [
 export class ItemPageModule {
  /**
   * NOTE: this method allows to resolve issue with components that using a custom decorator
-   * which are not loaded during CSR otherwise
+   * which are not loaded during SSR otherwise
   */
  static withEntryComponents() {
    return {
--- a/src/app/my-dspace-page/my-dspace-page.component.html
+++ b/src/app/my-dspace-page/my-dspace-page.component.html
@@ -4,7 +4,7 @@
      <ds-search-sidebar *ngIf="!(isXsOrSm$ | async)" class="col-3 sidebar-md-sticky"
                         id="search-sidebar"
                         [configurationList]="(configurationList$ | async)"
-                         [resultCount]="(resultsRD$ | async)?.payload.totalElements"
+                         [resultCount]="(resultsRD$ | async)?.payload?.totalElements"
                         [viewModeList]="viewModeList"
                         [searchOptions]="(searchOptions$ | async)"
                         [sortOptions]="(sortOptions$ | async)"
@@ -27,7 +27,7 @@
                  <ds-search-sidebar *ngIf="(isXsOrSm$ | async)" class="col-12"
                                     id="search-sidebar-sm"
                                     [configurationList]="(configurationList$ | async)"
-                                     [resultCount]="(resultsRD$ | async)?.payload.totalElements"
+                                     [resultCount]="(resultsRD$ | async)?.payload?.totalElements"
                                     (toggleSidebar)="closeSidebar()"
                                     [ngClass]="{'active': !(isSidebarCollapsed() | async)}"
                                     [searchOptions]="(searchOptions$ | async)"
--- a/src/app/my-dspace-page/my-dspace-page.component.ts
+++ b/src/app/my-dspace-page/my-dspace-page.component.ts
@@ -19,7 +19,7 @@ import { PaginatedSearchOptions } from '../shared/search/paginated-search-option
 import { SearchService } from '../core/shared/search/search.service';
 import { SidebarService } from '../shared/sidebar/sidebar.service';
 import { hasValue } from '../shared/empty.util';
-import { getFirstSucceededRemoteData } from '../core/shared/operators';
+import { getFirstCompletedRemoteData } from '../core/shared/operators';
 import { MyDSpaceResponseParsingService } from '../core/data/mydspace-response-parsing.service';
 import { SearchConfigurationOption } from '../shared/search/search-switch-configuration/search-configuration-option.model';
 import { RoleType } from '../core/roles/role-types';
@@ -30,7 +30,7 @@ import { MyDSpaceRequest } from '../core/data/request.models';
 import { SearchResult } from '../shared/search/search-result.model';
 import { Context } from '../core/shared/context.model';
 import { SortOptions } from '../core/cache/models/sort-options.model';
-import { RouteService } from '../core/services/route.service';
+import { SearchObjects } from '../shared/search/search-objects.model';

 export const MYDSPACE_ROUTE = '/mydspace';
 export const SEARCH_CONFIG_SERVICE: InjectionToken<SearchConfigurationService> = new InjectionToken<SearchConfigurationService>('searchConfigurationService');
@@ -111,8 +111,7 @@ export class MyDSpacePageComponent implements OnInit {
  constructor(private service: SearchService,
              private sidebarService: SidebarService,
              private windowService: HostWindowService,
-              @Inject(SEARCH_CONFIG_SERVICE) public searchConfigService: MyDSpaceConfigurationService,
-              private routeService: RouteService) {
+              @Inject(SEARCH_CONFIG_SERVICE) public searchConfigService: MyDSpaceConfigurationService) {
    this.isXsOrSm$ = this.windowService.isXsOrSm();
    this.service.setServiceOptions(MyDSpaceResponseParsingService, MyDSpaceRequest);
  }
@@ -134,8 +133,8 @@ export class MyDSpacePageComponent implements OnInit {
    this.searchOptions$ = this.searchConfigService.paginatedSearchOptions;
    this.sub = this.searchOptions$.pipe(
      tap(() => this.resultsRD$.next(null)),
-      switchMap((options: PaginatedSearchOptions) => this.service.search(options).pipe(getFirstSucceededRemoteData())))
-      .subscribe((results) => {
+      switchMap((options: PaginatedSearchOptions) => this.service.search(options).pipe(getFirstCompletedRemoteData())))
+      .subscribe((results: RemoteData<SearchObjects<DSpaceObject>>) => {
        this.resultsRD$.next(results);
      });

--- a/src/app/my-dspace-page/my-dspace-results/my-dspace-results.component.html
+++ b/src/app/my-dspace-page/my-dspace-results/my-dspace-results.component.html
@@ -10,5 +10,5 @@
  </ds-viewable-collection>
 </div>
 <ds-loading *ngIf="isLoading()" message="{{'loading.mydspace-results' | translate}}"></ds-loading>
-<ds-error *ngIf="searchResults?.hasFailed && (!searchResults?.errorMessage || searchResults?.statusCode != 400)" message="{{'error.search-results' | translate}}"></ds-error>
+<ds-error *ngIf="showError()" message="{{errorMessageLabel() | translate}}"></ds-error>
 <h3 *ngIf="searchResults?.payload?.page.length == 0" class="text-center text-muted" ><span>{{'mydspace.results.no-results' | translate}}</span></h3>
--- a/src/app/my-dspace-page/my-dspace-results/my-dspace-results.component.spec.ts
+++ b/src/app/my-dspace-page/my-dspace-results/my-dspace-results.component.spec.ts
@@ -40,9 +40,19 @@ describe('MyDSpaceResultsComponent', () => {
    expect(fixture.debugElement.query(By.css('a'))).toBeNull();
  });

-  it('should display error message if error is != 400', () => {
-    (comp as any).searchResults = { hasFailed: true, error: { statusCode: 500 } };
+  it('should display error message if error is 500', () => {
+    (comp as any).searchResults = { hasFailed: true, statusCode: 500 };
    fixture.detectChanges();
+    expect(comp.showError()).toBeTrue();
+    expect(comp.errorMessageLabel()).toBe('error.search-results');
+    expect(fixture.debugElement.query(By.css('ds-error'))).not.toBeNull();
+  });
+
+  it('should display error message if error is 422', () => {
+    (comp as any).searchResults = { hasFailed: true, statusCode: 422 };
+    fixture.detectChanges();
+    expect(comp.showError()).toBeTrue();
+    expect(comp.errorMessageLabel()).toBe('error.invalid-search-query');
    expect(fixture.debugElement.query(By.css('ds-error'))).not.toBeNull();
  });

--- a/src/app/my-dspace-page/my-dspace-results/my-dspace-results.component.ts
+++ b/src/app/my-dspace-page/my-dspace-results/my-dspace-results.component.ts
@@ -58,4 +58,12 @@ export class MyDSpaceResultsComponent {
  isLoading() {
    return !this.searchResults || isEmpty(this.searchResults) || this.searchResults.isLoading;
  }
+
+  showError(): boolean {
+    return this.searchResults?.hasFailed && (!this.searchResults?.errorMessage || this.searchResults?.statusCode !== 400);
+  }
+
+  errorMessageLabel(): string {
+    return (this.searchResults?.statusCode  === 422) ? 'error.invalid-search-query' : 'error.search-results';
+  }
 }
--- a/src/app/my-dspace-page/my-dspace-search.module.ts
+++ b/src/app/my-dspace-page/my-dspace-search.module.ts
@@ -50,7 +50,7 @@ const ENTRY_COMPONENTS = [
 export class MyDspaceSearchModule {
  /**
   * NOTE: this method allows to resolve issue with components that using a custom decorator
-   * which are not loaded during CSR otherwise
+   * which are not loaded during SSR otherwise
   */
  static withEntryComponents() {
    return {
--- a/src/app/navbar/navbar.module.ts
+++ b/src/app/navbar/navbar.module.ts
@@ -58,7 +58,7 @@ const ENTRY_COMPONENTS = [
 export class NavbarModule {
  /**
   * NOTE: this method allows to resolve issue with components that using a custom decorator
-   * which are not loaded during CSR otherwise
+   * which are not loaded during SSR otherwise
   */
  static withEntryComponents() {
    return {
--- a/src/app/search-page/search.component.ts
+++ b/src/app/search-page/search.component.ts
@@ -8,7 +8,7 @@ import { pushInOut } from '../shared/animations/push';
 import { HostWindowService } from '../shared/host-window.service';
 import { SidebarService } from '../shared/sidebar/sidebar.service';
 import { hasValue, isEmpty } from '../shared/empty.util';
-import { getFirstSucceededRemoteData } from '../core/shared/operators';
+import { getFirstCompletedRemoteData } from '../core/shared/operators';
 import { RouteService } from '../core/services/route.service';
 import { SEARCH_CONFIG_SERVICE } from '../my-dspace-page/my-dspace-page.component';
 import { PaginatedSearchOptions } from '../shared/search/paginated-search-options.model';
@@ -126,8 +126,8 @@ export class SearchComponent implements OnInit {
    this.searchOptions$ = this.getSearchOptions();
    this.sub = this.searchOptions$.pipe(
      switchMap((options) => this.service.search(
-          options, undefined, true, true, followLink<Item>('thumbnail', { isOptional: true })
-        ).pipe(getFirstSucceededRemoteData(), startWith(undefined))
+          options, undefined, false, true, followLink<Item>('thumbnail', { isOptional: true })
+        ).pipe(getFirstCompletedRemoteData(), startWith(undefined))
      )
    ).subscribe((results) => {
      this.resultsRD$.next(results);
--- a/src/app/shared/error/error.component.html
+++ b/src/app/shared/error/error.component.html
@@ -1,3 +1,4 @@
-<div>
-  <label>{{ message }}</label>
-</div>
+<ds-alert [type]="AlertTypeEnum.Error" [dismissible]="false">
+  <!-- Using [innerHTML] instead of {{message}} allows to render HTML code -->
+  <span [innerHTML]="message"></span>
+</ds-alert>
--- a/src/app/shared/error/error.component.spec.ts
+++ b/src/app/shared/error/error.component.spec.ts
@@ -36,7 +36,7 @@ describe('ErrorComponent (inline template)', () => {
    comp = fixture.componentInstance; // ErrorComponent test instance

    // query for the message <label> by CSS element selector
-    de = fixture.debugElement.query(By.css('label'));
+    de = fixture.debugElement.query(By.css('ds-alert'));
    el = de.nativeElement;
  });

--- a/src/app/shared/error/error.component.ts
+++ b/src/app/shared/error/error.component.ts
@@ -3,6 +3,7 @@ import { Component, Input } from '@angular/core';
 import { TranslateService } from '@ngx-translate/core';

 import { Subscription } from 'rxjs';
+import { AlertType } from '../alert/aletr-type';

@Component({
  selector: 'ds-error',
@@ -13,6 +14,12 @@ export class ErrorComponent {

  @Input() message = 'Error...';

+  /**
+   * The AlertType enumeration
+   * @type {AlertType}
+   */
+  public AlertTypeEnum = AlertType;
+
  private subscription: Subscription;

  constructor(private translate: TranslateService) {
--- a/src/app/shared/search/search-filters/search-filter/search-filter.component.ts
+++ b/src/app/shared/search/search-filters/search-filter/search-filter.component.ts
@@ -169,7 +169,7 @@ export class SearchFilterComponent implements OnInit {
                return this.searchService.getFacetValuesFor(this.filter, 1, options).pipe(
                  filter((RD) => !RD.isLoading),
                  map((valuesRD) => {
-                    return valuesRD.payload.totalElements > 0;
+                    return valuesRD.payload?.totalElements > 0;
                  }),);
              }
            ));
--- a/src/app/shared/search/search-results/search-results.component.html
+++ b/src/app/shared/search/search-results/search-results.component.html
@@ -16,11 +16,11 @@
    </ds-viewable-collection>
 </div>
 <ds-loading
-        *ngIf="hasNoValue(searchResults) || hasNoValue(searchResults.payload) || searchResults.isLoading"
+        *ngIf="!showError() && (hasNoValue(searchResults) || hasNoValue(searchResults.payload) || searchResults.isLoading)"
        message="{{'loading.search-results' | translate}}"></ds-loading>
 <ds-error
-        *ngIf="searchResults?.hasFailed && (!searchResults?.errorMessage || searchResults?.statusCode != 400)"
-        message="{{'error.search-results' | translate}}"></ds-error>
+        *ngIf="showError()"
+        message="{{errorMessageLabel() | translate}}"></ds-error>
 <div *ngIf="searchResults?.payload?.page.length == 0 || searchResults?.statusCode == 400">
    {{ 'search.results.no-results' | translate }}
    <a [routerLink]="['/search']"
--- a/src/app/shared/search/search-results/search-results.component.spec.ts
+++ b/src/app/shared/search/search-results/search-results.component.spec.ts
@@ -45,9 +45,19 @@ describe('SearchResultsComponent', () => {
    expect(fixture.debugElement.query(By.css('a'))).toBeNull();
  });

-  it('should display error message if error is != 400', () => {
+  it('should display error message if error is 500', () => {
    (comp as any).searchResults = createFailedRemoteDataObject('Error', 500);
    fixture.detectChanges();
+    expect(comp.showError()).toBeTrue();
+    expect(comp.errorMessageLabel()).toBe('error.search-results');
+    expect(fixture.debugElement.query(By.css('ds-error'))).not.toBeNull();
+  });
+
+  it('should display error message if error is 422', () => {
+    (comp as any).searchResults = createFailedRemoteDataObject('Error', 422);
+    fixture.detectChanges();
+    expect(comp.showError()).toBeTrue();
+    expect(comp.errorMessageLabel()).toBe('error.invalid-search-query');
    expect(fixture.debugElement.query(By.css('ds-error'))).not.toBeNull();
  });

--- a/src/app/shared/search/search-results/search-results.component.ts
+++ b/src/app/shared/search/search-results/search-results.component.ts
@@ -78,6 +78,14 @@ export class SearchResultsComponent {

  @Output() selectObject: EventEmitter<ListableObject> = new EventEmitter<ListableObject>();

+  showError(): boolean {
+    return this.searchResults?.hasFailed && (!this.searchResults?.errorMessage || this.searchResults?.statusCode !== 400);
+  }
+
+  errorMessageLabel(): string {
+    return (this.searchResults?.statusCode  === 422) ? 'error.invalid-search-query' : 'error.search-results';
+  }
+
  /**
   * Method to change the given string by surrounding it by quotes if not already present.
   */
--- a/src/app/shared/shared.module.ts
+++ b/src/app/shared/shared.module.ts
@@ -623,7 +623,7 @@ const DIRECTIVES = [
 export class SharedModule {
  /**
   * NOTE: this method allows to resolve issue with components that using a custom decorator
-   * which are not loaded during CSR otherwise
+   * which are not loaded during SSR otherwise
   */
  static withEntryComponents() {
    return {
--- a/src/app/submission/submission.module.ts
+++ b/src/app/submission/submission.module.ts
@@ -65,6 +65,13 @@ const DECLARATIONS = [
  SubmissionImportExternalCollectionComponent
 ];

+const ENTRY_COMPONENTS = [
+  SubmissionSectionUploadComponent,
+  SubmissionSectionformComponent,
+  SubmissionSectionLicenseComponent,
+  SubmissionSectionCcLicensesComponent
+];
+
@NgModule({
  imports: [
    CommonModule,
@@ -88,4 +95,14 @@ const DECLARATIONS = [
 * This module handles all components that are necessary for the submission process
 */
 export class SubmissionModule {
+  /**
+   * NOTE: this method allows to resolve issue with components that using a custom decorator
+   * which are not loaded during SSR otherwise
+   */
+  static withEntryComponents() {
+    return {
+      ngModule: SubmissionModule,
+      providers: ENTRY_COMPONENTS.map((component) => ({provide: component}))
+    };
+  }
 }
--- a/src/assets/i18n/en.json5
+++ b/src/assets/i18n/en.json5
@@ -1336,6 +1336,8 @@

  "error.search-results": "Error fetching search results",

+  "error.invalid-search-query": "Search query is not valid. Please check <a href=\"https://solr.apache.org/guide/query-syntax-and-parsing.html\" target=\"_blank\">Solr query syntax</a> best practices for further information about this error.",
+
  "error.sub-collections": "Error fetching sub-collections",

  "error.sub-communities": "Error fetching sub-communities",