[DSC-2764] Add configuration to define lucky search redirect codes

(cherry picked from commit bb6bed556693e518da4b4e444f8868d177bb057f)

Author: atarix83

src/app/lucky-search/search/lucky-search.component.spec.ts

@@ -52,6 +52,34 @@ import { TruncatablePartComponent } from '../../shared/truncatable/truncatable-p
 import { FileSizePipe } from '../../shared/utils/file-size-pipe';
 import { LuckySearchService } from '../lucky-search.service';
 import { LuckySearchComponent } from './lucky-search.component';
+import {ComponentFixture, TestBed} from '@angular/core/testing';
+
+import {LuckySearchComponent} from './lucky-search.component';
+import {LuckySearchService} from '../lucky-search.service';
+import {SearchConfigurationService} from '../../core/shared/search/search-configuration.service';
+import {Router, UrlTree} from '@angular/router';
+import {createSuccessfulRemoteDataObject, createSuccessfulRemoteDataObject$} from '../../shared/remote-data.utils';
+import {createPaginatedList} from '../../shared/testing/utils.test';
+import {Item} from '../../core/shared/item.model';
+import {of as observableOf} from 'rxjs';
+import {PaginatedSearchOptions} from '../../shared/search/models/paginated-search-options.model';
+import {PaginationComponentOptions} from '../../shared/pagination/pagination-component-options.model';
+import {SortDirection, SortOptions} from '../../core/cache/models/sort-options.model';
+import {TranslateModule} from '@ngx-translate/core';
+import {By} from '@angular/platform-browser';
+import {SearchResult} from '../../shared/search/models/search-result.model';
+import {DSpaceObject} from '../../core/shared/dspace-object.model';
+import {BitstreamDataService, MetadataFilter} from '../../core/data/bitstream-data.service';
+import {Bitstream} from '../../core/shared/bitstream.model';
+import {RouterMock} from '../../shared/mocks/router.mock';
+import {MetadataMap, MetadataValue} from '../../core/shared/metadata.models';
+import {FileSizePipe} from '../../shared/utils/file-size-pipe';
+import {HardRedirectService} from '../../core/services/hard-redirect.service';
+import {getBitstreamDownloadRoute} from '../../app-routing-paths';
+import {PLATFORM_ID} from '@angular/core';
+import {NotificationsService} from '../../shared/notifications/notifications.service';
+import {NotificationsServiceStub} from '../../shared/testing/notifications-service.stub';
+import {APP_CONFIG} from '../../../config/app-config.interface';
 
 describe('LuckySearchComponent', () => {
   let fixture: ComponentFixture<LuckySearchComponent>;
@@ -131,6 +159,7 @@ describe('LuckySearchComponent', () => {
         { provide: HardRedirectService, useValue: hardRedirectService },
         { provide: PLATFORM_ID, useValue: 'browser' },
         { provide: NotificationsService, useValue: new NotificationsServiceStub() },
+        {provide: APP_CONFIG, useValue: {}},
       ],
     }).overrideComponent(LuckySearchComponent, {
       remove: {
@@ -355,4 +384,57 @@ describe('LuckySearchComponent', () => {
     });
 
   });
+
+  describe('', () => {
+    beforeEach(() => {
+      fixture = TestBed.createComponent(LuckySearchComponent);
+      component = fixture.componentInstance;
+    });
+
+    it('should return default code when no specific identifier is found', () => {
+      // @ts-ignore: Accessing private method for testing
+      component.appConfig = {
+        luckySearchRedirects: {
+          default: 301
+        }
+      } as any;
+      // @ts-ignore: Accessing private method for testing
+      component.currentFilter = {identifier: 'unknown'};
+
+      // @ts-ignore: Accessing private method for testing
+      const result = component.getRedirectCode();
+
+      expect(result).toBe(301);
+    });
+
+    it('should return 302 when default is not set and identifier is not found', () => {
+      // @ts-ignore: Accessing private method for testing
+      component.appConfig = {
+        luckySearchRedirects: {}
+      } as any;
+      // @ts-ignore: Accessing private method for testing
+      component.currentFilter = {identifier: 'unknown'};
+
+      // @ts-ignore: Accessing private method for testing
+      const result = component.getRedirectCode();
+      expect(result).toBe(302);
+    });
+
+    it('should return specific code for known identifier', () => {
+      // @ts-ignore: Accessing private method for testing
+      component.appConfig = {
+        luckySearchRedirects: {
+          default: 302,
+          'legacy-id': 301
+        }
+      };
+      // @ts-ignore: Accessing private method for testing
+      component.currentFilter = {identifier: 'legacy-id'};
+
+      // @ts-ignore: Accessing private method for testing
+      const result = component.getRedirectCode();
+      expect(result).toBe(301);
+    });
+
+  });
 });

src/app/lucky-search/search/lucky-search.component.ts

@@ -64,6 +64,7 @@ import { TruncatableComponent } from '../../shared/truncatable/truncatable.compo
 import { TruncatablePartComponent } from '../../shared/truncatable/truncatable-part/truncatable-part.component';
 import { FileSizePipe } from '../../shared/utils/file-size-pipe';
 import { LuckySearchService } from '../lucky-search.service';
+import {APP_CONFIG, AppConfig} from '../../../config/app-config.interface';
 
 @Component({
   selector: 'ds-lucky-search',
@@ -127,6 +128,7 @@ export class LuckySearchComponent implements OnInit {
     private hardRedirectService: HardRedirectService,
     private notificationService: NotificationsService,
     private translateService: TranslateService,
+    @Inject(APP_CONFIG) private appConfig: AppConfig,
   ) {}
 
   ngOnInit(): void {
@@ -236,12 +238,21 @@ export class LuckySearchComponent implements OnInit {
 
   public redirect(url: string): void {
     if (isPlatformServer(this.platformId)) {
-      this.hardRedirectService.redirect(url, 302);
+      this.hardRedirectService.redirect(url, this.getRedirectCode());
     } else {
       this.router.navigateByUrl(url, { replaceUrl: true });
     }
   }
 
+  private getRedirectCode(): number {
+    let code: number = this.appConfig?.luckySearchRedirects?.default || 302;
+    if (Object.keys(this.appConfig?.luckySearchRedirects).includes(this.currentFilter.identifier)) {
+      code = this.appConfig.luckySearchRedirects[this.currentFilter.identifier];
+    }
+
+    return code;
+  }
+
   private parseBitstreamFilters(queryParams: Params): MetadataFilter[] {
     const metadataName = queryParams?.bitstreamMetadata;
     const metadataValue = queryParams?.bitstreamValue;

src/config/app-config.interface.ts

@@ -56,6 +56,7 @@ import { SubmissionConfig } from './submission-config.interface';
 import { SuggestionConfig } from './suggestion-config.interfaces';
 import { ThemeConfig } from './theme.config';
 import { UIServerConfig } from './ui-server-config.interface';
+import {LuckySearchRedirectConfig} from './lucky-search-redirect-config';
 
 interface AppConfig extends Config {
   ui: UIServerConfig;
@@ -109,6 +110,11 @@ interface AppConfig extends Config {
   metadataLinkViewPopoverData: MetadataLinkViewPopoverDataConfig;
   identifierSubtypes: IdentifierSubtypesConfig[];
   datadogRum?: DatadogRumConfig;
+  location: LocationConfig;
+  epflUnpaywallMetadata: EpflUnpaywallMetadata;
+  loader: LoaderConfig;
+  permanentRedirectPaths?: string[];
+  luckySearchRedirects?: LuckySearchRedirectConfig;
 }
 
 /**

src/config/default-app-config.ts

@@ -55,6 +55,36 @@ import { ServerConfig } from './server-config.interface';
 import { SubmissionConfig } from './submission-config.interface';
 import { ThemeConfig } from './theme.config';
 import { UIServerConfig } from './ui-server-config.interface';
+import { BundleConfig } from './bundle-config.interface';
+import { ActuatorsConfig } from './actuators.config';
+import { InfoConfig } from './info-config.interface';
+import { CommunityListConfig } from './community-list-config.interface';
+import { HomeConfig } from './homepage-config.interface';
+import { MarkdownConfig } from './markdown-config.interface';
+import { FilterVocabularyConfig } from './filter-vocabulary-config';
+import { DiscoverySortConfig } from './discovery-sort.config';
+import { AddToAnyPluginConfig } from './add-to-any-plugin-config';
+import { CmsMetadata } from './cms-metadata';
+import { CrisLayoutConfig, LayoutConfig, SuggestionConfig } from './layout-config.interfaces';
+import { MetadataSecurityConfig } from './metadata-security-config';
+import { FollowAuthorityMetadata } from './search-follow-metadata.interface';
+import { MetricVisualizationConfig } from './metric-visualization-config.interfaces';
+import {
+  AdvancedAttachmentElementType,
+  AdvancedAttachmentRenderingConfig
+} from './advanced-attachment-rendering.config';
+import { AttachmentRenderingConfig } from './attachment-rendering.config';
+import { SearchResultConfig } from './search-result-config.interface';
+import { VirtualCollectionConfig } from './virtual-collection-config.interface';
+import { EpflUnpaywallMetadata } from './epfl-unpaywall-metadata';
+import { MiradorConfig } from './mirador-config.interfaces';
+import { LoaderConfig } from './loader-config.interfaces';
+import { MetaTagsConfig } from './meta-tags.config';
+import { MetadataLinkViewPopoverDataConfig } from './metadata-link-view-popoverdata-config.interface';
+import { IdentifierSubtypesConfig, IdentifierSubtypesIconPositionEnum } from './identifier-subtypes-config.interface';
+import { DatadogRumConfig } from './datadog-rum-config.interfaces';
+import { LocationConfig } from './location-config.interface';
+import {LuckySearchRedirectConfig} from './lucky-search-redirect-config';
 
 export class DefaultAppConfig implements AppConfig {
   production = false;
@@ -1054,4 +1084,17 @@ export class DefaultAppConfig implements AppConfig {
     trackLongTasks: true,
     defaultPrivacyLevel: 'mask-user-input',
   };
+
+  location: LocationConfig = {
+    nominatimApi: {
+      searchEndpoint: 'https://nominatim.openstreetmap.org/search',
+      reverseSearchEndpoint: 'https://nominatim.openstreetmap.org/reverse',
+      statusEndpoint: 'https://nominatim.openstreetmap.org/status',
+    }
+  };
+
+  luckySearchRedirects: LuckySearchRedirectConfig = {
+    'legacy-id': 301,
+    default: 302
+  };
 }

src/config/lucky-search-redirect-config.ts

@@ -0,0 +1,6 @@
+import {Config} from './config.interface';
+
+export interface LuckySearchRedirectConfig extends Config {
+  [indexName: string]: number;
+  default: number;
+}