Merge pull request DSpace#5288 from tdonohue/port_5276_to_7_x

tdonohue · web-flow · commit 19df01385671 · 2026-04-06T12:02:31.000-05:00
[Port dspace-7_x] Remove reliance on `Host` HTTP Header
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -24,6 +24,7 @@ jobs:
       # Spin up UI on 127.0.0.1 to avoid host resolution issues in e2e tests with Node 18+
       DSPACE_UI_HOST: 127.0.0.1
       DSPACE_UI_PORT: 4000
+      DSPACE_UI_BASEURL: http://127.0.0.1:4000
       # Ensure all SSR caching is disabled in test environment
       DSPACE_CACHE_SERVERSIDE_BOTCACHE_MAX: 0
       DSPACE_CACHE_SERVERSIDE_ANONYMOUSCACHE_MAX: 0
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
@@ -74,6 +74,8 @@ jobs:
       DSPACE_REST_HOST: 127.0.0.1
       # Override default dspace.ui.url to also use 127.0.0.1.
       dspace__P__ui__P__url: http://127.0.0.1:4000
+      # Override default ui.baseUrl to also use 127.0.0.1. This should match 'dspace.ui.url'.
+      DSPACE_UI_BASEURL: http://127.0.0.1:4000
     steps:
       # Checkout our codebase (to get access to Docker Compose scripts)
       - name: Checkout codebase
diff --git a/config/config.example.yml b/config/config.example.yml
@@ -8,6 +8,9 @@ ui:
   ssl: false
   host: localhost
   port: 4000
+  # Specify the public URL that this user interface responds to. This corresponds to the "dspace.ui.url" property in your backend's local.cfg.
+  # The baseUrl is used for redirects and SEO links (in robots.txt).
+  baseUrl: http://localhost:4000
   # NOTE: Space is capitalized because 'namespace' is a reserved string in TypeScript
   nameSpace: /
   # The rateLimiter settings limit each IP to a 'max' of 500 requests per 'windowMs' (1 minute).
diff --git a/docker/docker-compose-dist.yml b/docker/docker-compose-dist.yml
@@ -22,6 +22,7 @@ services:
       DSPACE_UI_HOST: ${DSPACE_UI_HOST:-dspace-angular}
       DSPACE_UI_PORT: ${DSPACE_UI_PORT:-4000}
       DSPACE_UI_NAMESPACE: ${DSPACE_UI_NAMESPACE:-/}
+      DSPACE_UI_BASEURL: ${DSPACE_UI_BASEURL:-http://localhost:4000}
       DSPACE_REST_SSL: ${DSPACE_REST_SSL:-false}
       DSPACE_REST_HOST: ${DSPACE_REST_HOST:-localhost}
       DSPACE_REST_PORT: ${DSPACE_REST_PORT:-8080}
diff --git a/server.ts b/server.ts
@@ -166,7 +166,7 @@ export function app() {
   server.get('/robots.txt', (req, res) => {
     res.setHeader('content-type', 'text/plain');
     res.render('assets/robots.txt.ejs', {
-      'origin': req.protocol + '://' + req.headers.host
+      'origin': environment.ui.baseUrl,
     });
   });
 
diff --git a/src/app/bitstream-page/legacy-bitstream-url-redirect.guard.spec.ts b/src/app/bitstream-page/legacy-bitstream-url-redirect.guard.spec.ts
@@ -1,6 +1,7 @@
 import { cold } from 'jasmine-marbles';
 import { EMPTY } from 'rxjs';
 
+import { environment } from '../../environments/environment';
 import { PAGE_NOT_FOUND_PATH } from '../app-routing-paths';
 import { BitstreamDataService } from '../core/data/bitstream-data.service';
 import { RemoteData } from '../core/data/remote-data';
@@ -150,7 +151,7 @@ describe('legacyBitstreamURLRedirectGuard', () => {
         }));
         resolver(route, state, bitstreamDataService, hardRedirectService, router).subscribe(() => {
           expect(bitstreamDataService.findByItemHandle).toHaveBeenCalled();
-          expect(hardRedirectService.redirect).toHaveBeenCalledWith(new URL(`/bitstreams/${bitstream.uuid}/download`, window.location.origin).href, 301);
+          expect(hardRedirectService.redirect).toHaveBeenCalledWith(new URL(`/bitstreams/${bitstream.uuid}/download`, environment.ui.baseUrl).href, 301);
         });
       });
     });
diff --git a/src/app/bitstream-page/legacy-bitstream-url-redirect.guard.ts b/src/app/bitstream-page/legacy-bitstream-url-redirect.guard.ts
@@ -9,7 +9,10 @@ import {
 import { Observable } from 'rxjs';
 import { map } from 'rxjs/operators';
 
-import { PAGE_NOT_FOUND_PATH } from '../app-routing-paths';
+import {
+  getBitstreamDownloadRoute,
+  PAGE_NOT_FOUND_PATH,
+} from '../app-routing-paths';
 import { BitstreamDataService } from '../core/data/bitstream-data.service';
 import { RemoteData } from '../core/data/remote-data';
 import { HardRedirectService } from '../core/services/hard-redirect.service';
@@ -46,7 +49,7 @@ export const legacyBitstreamURLRedirectGuard: CanActivateFn = (
     getFirstCompletedRemoteData(),
     map((rd: RemoteData<Bitstream>) => {
       if (rd.hasSucceeded && !rd.hasNoContent) {
-        serverHardRedirectService.redirect(new URL(`/bitstreams/${rd.payload.uuid}/download`, serverHardRedirectService.getCurrentOrigin()).href, 301);
+        serverHardRedirectService.redirect(new URL(getBitstreamDownloadRoute(rd.payload), serverHardRedirectService.getBaseUrl()).href, 301);
         return false;
       } else {
         return router.createUrlTree([PAGE_NOT_FOUND_PATH]);
diff --git a/src/app/core/metadata/metadata.service.spec.ts b/src/app/core/metadata/metadata.service.spec.ts
@@ -84,7 +84,7 @@ describe('MetadataService', () => {
       }
     } as any as Router;
     hardRedirectService = jasmine.createSpyObj( {
-      getCurrentOrigin: 'https://request.org',
+      getBaseUrl: 'https://request.org',
     });
     authorizationService = jasmine.createSpyObj('authorizationService', {
       isAuthorized: observableOf(true)
diff --git a/src/app/core/metadata/metadata.service.ts b/src/app/core/metadata/metadata.service.ts
@@ -299,7 +299,7 @@ export class MetadataService {
     if (this.currentObject.value instanceof Item) {
       let url = this.getMetaTagValue('dc.identifier.uri');
       if (hasNoValue(url)) {
-        url = new URLCombiner(this.hardRedirectService.getCurrentOrigin(), this.router.url).toString();
+        url = new URLCombiner(this.hardRedirectService.getBaseUrl(), this.router.url).toString();
       }
       this.addMetaTag('citation_abstract_html_url', url);
     }
@@ -382,7 +382,7 @@ export class MetadataService {
         // Use the found link to set the <meta> tag
         this.addMetaTag(
           'citation_pdf_url',
-          new URLCombiner(this.hardRedirectService.getCurrentOrigin(), link).toString()
+          new URLCombiner(this.hardRedirectService.getBaseUrl(), link).toString()
         );
       });
     }
diff --git a/src/app/core/services/browser-hard-redirect.service.spec.ts b/src/app/core/services/browser-hard-redirect.service.spec.ts
@@ -1,10 +1,13 @@
 import { TestBed } from '@angular/core/testing';
+
+import { environment } from '../../../environments/environment';
 import { BrowserHardRedirectService } from './browser-hard-redirect.service';
 
 describe('BrowserHardRedirectService', () => {
   let origin: string;
   let mockLocation: Location;
   let service: BrowserHardRedirectService;
+  let originalBaseUrl;
 
   beforeEach(() => {
     origin = 'https://test-host.com:4000';
@@ -19,11 +22,22 @@ describe('BrowserHardRedirectService', () => {
     } as Location;
     spyOn(mockLocation, 'replace');
 
+    // Store original environment variable to restore after tests
+    originalBaseUrl = environment.ui.baseUrl;
+
+    // Set environment variable to match our mock location origin for testing
+    environment.ui.baseUrl = origin;
+
     service = new BrowserHardRedirectService(mockLocation);
 
     TestBed.configureTestingModule({});
   });
 
+  afterEach(() => {
+    // Restore original environment variable after tests
+    environment.ui.baseUrl = originalBaseUrl;
+  });
+
   it('should be created', () => {
     expect(service).toBeTruthy();
   });
@@ -51,7 +65,7 @@ describe('BrowserHardRedirectService', () => {
   describe('when requesting the origin', () => {
 
     it('should return the location origin', () => {
-      expect(service.getCurrentOrigin()).toEqual(origin);
+      expect(service.getBaseUrl()).toEqual(origin);
     });
   });
 
diff --git a/src/app/core/services/browser-hard-redirect.service.ts b/src/app/core/services/browser-hard-redirect.service.ts
@@ -1,4 +1,5 @@
 import { Inject, Injectable, InjectionToken } from '@angular/core';
+import { environment } from '../../../environments/environment';
 import { HardRedirectService } from './hard-redirect.service';
 
 export const LocationToken = new InjectionToken('Location');
@@ -36,12 +37,11 @@ export class BrowserHardRedirectService extends HardRedirectService {
   }
 
   /**
-   * Get the origin of the current URL
+   * Get the base public URL of our application.
+   * This is used as the base URL for redirects, and should be in the format of
    * i.e. <scheme> "://" <hostname> [ ":" <port> ]
-   * e.g. if the URL is https://demo.dspace.org/search?query=test,
-   * the origin would be https://demo.dspace.org
    */
-  getCurrentOrigin(): string {
-    return this.location.origin;
+  getBaseUrl(): string {
+    return environment.ui.baseUrl;
   }
 }
diff --git a/src/app/core/services/browser.referrer.service.spec.ts b/src/app/core/services/browser.referrer.service.spec.ts
@@ -15,7 +15,7 @@ describe(`BrowserReferrerService`, () => {
     service = new BrowserReferrerService(
       { referrer: documentReferrer },
       routeService,
-      { getCurrentOrigin: () => origin } as any
+      { getBaseUrl: () => origin } as any,
     );
   });
 
diff --git a/src/app/core/services/browser.referrer.service.ts b/src/app/core/services/browser.referrer.service.ts
@@ -46,7 +46,7 @@ export class BrowserReferrerService extends ReferrerService {
           const reversedHistory = [...history].reverse();
           // and find the first URL that differs from the current one
           const prevUrl = reversedHistory.find((url: string) => url !== currentURL);
-          return new URLCombiner(this.hardRedirectService.getCurrentOrigin(), prevUrl).toString();
+          return new URLCombiner(this.hardRedirectService.getBaseUrl(), prevUrl).toString();
         }
       })
     );
diff --git a/src/app/core/services/hard-redirect.service.ts b/src/app/core/services/hard-redirect.service.ts
@@ -23,10 +23,9 @@ export abstract class HardRedirectService {
   abstract getCurrentRoute(): string;
 
   /**
-   * Get the origin of the current URL
+   * Get the base public URL of our application.
+   * This is used as the base URL for redirects, and should be in the format of
    * i.e. <scheme> "://" <hostname> [ ":" <port> ]
-   * e.g. if the URL is https://demo.dspace.org/search?query=test,
-   * the origin would be https://demo.dspace.org
    */
-  abstract getCurrentOrigin(): string;
+  abstract getBaseUrl(): string;
 }
diff --git a/src/app/core/services/server-hard-redirect.service.spec.ts b/src/app/core/services/server-hard-redirect.service.spec.ts
@@ -1,25 +1,50 @@
 import { TestBed } from '@angular/core/testing';
 
-import { environment } from '../../../environments/environment.test';
+import { AppConfig } from '../../../config/app-config.interface';
+import { environment } from '../../../environments/environment';
 import { ServerHardRedirectService } from './server-hard-redirect.service';
 
+
 describe('ServerHardRedirectService', () => {
 
   const mockRequest = jasmine.createSpyObj(['get']);
   const mockResponse = jasmine.createSpyObj(['redirect', 'end']);
 
-  let service: ServerHardRedirectService = new ServerHardRedirectService(environment, mockRequest, mockResponse);
+  const envConfig = {
+    rest: {
+      ssl: true,
+      host: 'rest.com',
+      port: 443,
+      // NOTE: Space is capitalized because 'namespace' is a reserved string in TypeScript
+      nameSpace: '/api',
+      baseUrl: 'https://rest.com/server',
+    },
+  } as AppConfig;
+
+  let service: ServerHardRedirectService = new ServerHardRedirectService(envConfig, mockRequest, mockResponse);
   const origin = 'https://test-host.com:4000';
+  let originalBaseUrl;
 
   beforeEach(() => {
     mockRequest.protocol = 'https';
     mockRequest.headers = {
       host: 'test-host.com:4000',
     };
 
+    // Store original environment variable to restore after tests
+    originalBaseUrl = environment.ui.baseUrl;
+
+    // Set environment variable to match our mock location origin for testing
+    environment.ui.baseUrl = origin;
+
     TestBed.configureTestingModule({});
   });
 
+  afterEach(() => {
+    // Restore original environment variable after tests
+    environment.ui.baseUrl = originalBaseUrl;
+  });
+
   it('should be created', () => {
     expect(service).toBeTruthy();
   });
@@ -65,14 +90,14 @@ describe('ServerHardRedirectService', () => {
   describe('when requesting the origin', () => {
 
     it('should return the location origin', () => {
-      expect(service.getCurrentOrigin()).toEqual(origin);
+      expect(service.getBaseUrl()).toEqual(origin);
     });
   });
 
   describe('when SSR base url is set', () => {
     const redirect = 'https://private-url:4000/server/api/bitstreams/uuid';
     const replacedUrl = 'https://public-url/server/api/bitstreams/uuid';
-    const environmentWithSSRUrl: any = { ...environment, ...{ ...environment.rest, rest: {
+    const environmentWithSSRUrl: any = { ...envConfig, ...{ ...envConfig.rest, rest: {
       ssrBaseUrl: 'https://private-url:4000/server',
       baseUrl: 'https://public-url/server',
     } } };
diff --git a/src/app/core/services/server-hard-redirect.service.ts b/src/app/core/services/server-hard-redirect.service.ts
@@ -1,10 +1,12 @@
 import { Inject, Injectable } from '@angular/core';
 import { Request, Response } from 'express';
 import { REQUEST, RESPONSE } from '@nguniversal/express-engine/tokens';
+import { environment } from '../../../environments/environment';
 import { HardRedirectService } from './hard-redirect.service';
 import { APP_CONFIG, AppConfig } from '../../../config/app-config.interface';
 import { isNotEmpty } from '../../shared/empty.util';
 
+
 /**
  * Service for performing hard redirects within the server app module
  */
@@ -75,12 +77,11 @@ export class ServerHardRedirectService extends HardRedirectService {
   }
 
   /**
-   * Get the origin of the current URL
+   * Get the base public URL of our application.
+   * This is used as the base URL for redirects, and should be in the format of
    * i.e. <scheme> "://" <hostname> [ ":" <port> ]
-   * e.g. if the URL is https://demo.dspace.org/search?query=test,
-   * the origin would be https://demo.dspace.org
    */
-  getCurrentOrigin(): string {
-    return this.req.protocol + '://' + this.req.headers.host;
+  getBaseUrl(): string {
+    return environment.ui.baseUrl;
   }
 }
diff --git a/src/config/config.server.ts b/src/config/config.server.ts
@@ -8,7 +8,7 @@ import { Config } from './config.interface';
 import { DefaultAppConfig } from './default-app-config';
 import { ServerConfig } from './server-config.interface';
 import { mergeConfig } from './config.util';
-import { isNotEmpty } from '../app/shared/empty.util';
+import { isEmpty, isNotEmpty } from '../app/shared/empty.util';
 
 const CONFIG_PATH = join(process.cwd(), 'config');
 
@@ -149,14 +149,20 @@ const overrideWithEnvironment = (config: Config, key: string = '') => {
 };
 
 
-
+/**
+ * Construct the "baseUrl" property for a given config object (if it doesn't already exist),
+ * using the "host", "port", "nameSpace", and "ssl" properties of the config.
+ * @param config the config to build the baseUrl for
+ */
 const buildBaseUrl = (config: ServerConfig): void => {
-  config.baseUrl = [
-    config.ssl ? 'https://' : 'http://',
-    config.host,
-    config.port && config.port !== 80 && config.port !== 443 ? `:${config.port}` : '',
-    config.nameSpace && config.nameSpace.startsWith('/') ? config.nameSpace : `/${config.nameSpace}`
-  ].join('');
+  if (isEmpty(config.baseUrl)) {
+    config.baseUrl = [
+      config.ssl ? 'https://' : 'http://',
+      config.host,
+      config.port && config.port !== 80 && config.port !== 443 ? `:${config.port}` : '',
+      config.nameSpace && config.nameSpace.startsWith('/') ? config.nameSpace : `/${config.nameSpace}`,
+    ].join('');
+  }
 };
 
 /**
@@ -232,7 +238,7 @@ export const buildAppConfig = (destConfigPath?: string): AppConfig => {
   // apply build defined production
   appConfig.production = env === 'production';
 
-  // build base URLs
+  // Build base URLs if not already specified via configuration or environment variables.
   buildBaseUrl(appConfig.ui);
   buildBaseUrl(appConfig.rest);
 
diff --git a/src/config/default-app-config.ts b/src/config/default-app-config.ts
@@ -40,6 +40,9 @@ export class DefaultAppConfig implements AppConfig {
     port: 4000,
     // NOTE: Space is capitalized because 'namespace' is a reserved string in TypeScript
     nameSpace: '/',
+    // Specify the public URL that this user interface responds to. This corresponds to the "dspace.ui.url" property in your backend's local.cfg.
+    // The baseUrl is used for redirects and SEO links (in robots.txt).
+    baseUrl: 'http://localhost:4000',
 
     // The rateLimiter settings limit each IP to a 'max' of 500 requests per 'windowMs' (1 minute).
     rateLimiter: {

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ describe('MetadataService', () => {`
`84`	`84`	`}`
`85`	`85`	`} as any as Router;`
`86`	`86`	`hardRedirectService = jasmine.createSpyObj( {`
`87`		`- getCurrentOrigin: 'https://request.org',`
	`87`	`+ getBaseUrl: 'https://request.org',`
`88`	`88`	`});`
`89`	`89`	`authorizationService = jasmine.createSpyObj('authorizationService', {`
`90`	`90`	`isAuthorized: observableOf(true)`
Original file line number	Diff line number	Diff line change
`@@ -299,7 +299,7 @@ export class MetadataService {`
`299`	`299`	`if (this.currentObject.value instanceof Item) {`
`300`	`300`	`let url = this.getMetaTagValue('dc.identifier.uri');`
`301`	`301`	`if (hasNoValue(url)) {`
`302`		`- url = new URLCombiner(this.hardRedirectService.getCurrentOrigin(), this.router.url).toString();`
	`302`	`+ url = new URLCombiner(this.hardRedirectService.getBaseUrl(), this.router.url).toString();`
`303`	`303`	`}`
`304`	`304`	`this.addMetaTag('citation_abstract_html_url', url);`
`305`	`305`	`}`
`@@ -382,7 +382,7 @@ export class MetadataService {`
`382`	`382`	`// Use the found link to set the <meta> tag`
`383`	`383`	`this.addMetaTag(`
`384`	`384`	`'citation_pdf_url',`
`385`		`- new URLCombiner(this.hardRedirectService.getCurrentOrigin(), link).toString()`
	`385`	`+ new URLCombiner(this.hardRedirectService.getBaseUrl(), link).toString()`
`386`	`386`	`);`
`387`	`387`	`});`
`388`	`388`	`}`