fix(common): Update Location to support base href containing origin (#48327)

constantant · AndrewKushnir · commit bf44dc234a32 · 2022-12-07T09:18:01.000-08:00
In case `APP_BASE_HREF` is set including `origin` the further usage of it might cause failure e.g. If an app is placed on `https://example.com` and bundles are on `https://cdn-example.com` you have to set `APP_BASE_HREF` up as `https://example.com/` and build the app with `--base-href` as `https://cdn-example.com/` but it does not work because of the bug Fixes #48175 PR Close #48327
diff --git a/packages/common/src/location/location.ts b/packages/common/src/location/location.ts
@@ -57,7 +57,7 @@ export class Location implements OnDestroy {
   /** @internal */
   _subject: EventEmitter<any> = new EventEmitter();
   /** @internal */
-  _baseHref: string;
+  _basePath: string;
   /** @internal */
   _locationStrategy: LocationStrategy;
   /** @internal */
@@ -67,8 +67,8 @@ export class Location implements OnDestroy {
 
   constructor(locationStrategy: LocationStrategy) {
     this._locationStrategy = locationStrategy;
-    const browserBaseHref = this._locationStrategy.getBaseHref();
-    this._baseHref = stripTrailingSlash(_stripIndexHtml(browserBaseHref));
+    const baseHref = this._locationStrategy.getBaseHref();
+    this._basePath = _stripOrigin(stripTrailingSlash(_stripIndexHtml(baseHref)));
     this._locationStrategy.onPopState((ev) => {
       this._subject.emit({
         'url': this.path(true),
@@ -127,7 +127,7 @@ export class Location implements OnDestroy {
    * @returns The normalized URL string.
    */
   normalize(url: string): string {
-    return Location.stripTrailingSlash(_stripBaseHref(this._baseHref, _stripIndexHtml(url)));
+    return Location.stripTrailingSlash(_stripBasePath(this._basePath, _stripIndexHtml(url)));
   }
 
   /**
@@ -294,10 +294,18 @@ export function createLocation() {
   return new Location(ɵɵinject(LocationStrategy as any));
 }
 
-function _stripBaseHref(baseHref: string, url: string): string {
-  return baseHref && url.startsWith(baseHref) ? url.substring(baseHref.length) : url;
+function _stripBasePath(basePath: string, url: string): string {
+  return basePath && url.startsWith(basePath) ? url.substring(basePath.length) : url;
 }
 
 function _stripIndexHtml(url: string): string {
   return url.replace(/\/index.html$/, '');
 }
+
+function _stripOrigin(baseHref: string): string {
+  if (/^(https?:)?\/\//.test(baseHref)) {
+    const [, pathname] = baseHref.split(/\/\/[^\/]+/);
+    return pathname;
+  }
+  return baseHref;
+}
diff --git a/packages/common/test/location/location_spec.ts b/packages/common/test/location/location_spec.ts
@@ -6,7 +6,7 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {CommonModule, Location, LocationStrategy, PathLocationStrategy, PlatformLocation} from '@angular/common';
+import {APP_BASE_HREF, CommonModule, Location, LocationStrategy, PathLocationStrategy, PlatformLocation} from '@angular/common';
 import {MockLocationStrategy, MockPlatformLocation} from '@angular/common/testing';
 import {TestBed} from '@angular/core/testing';
 
@@ -55,7 +55,7 @@ describe('Location Class', () => {
               return new MockPlatformLocation();
             }
           },
-          {provide: Location, useClass: Location, deps: [LocationStrategy, PlatformLocation]},
+          {provide: Location, useClass: Location, deps: [LocationStrategy]},
         ]
       });
 
@@ -147,7 +147,7 @@ describe('Location Class', () => {
               return new MockPlatformLocation();
             }
           },
-          {provide: Location, useClass: Location, deps: [LocationStrategy, PlatformLocation]},
+          {provide: Location, useClass: Location, deps: [LocationStrategy]},
         ]
       });
 
@@ -215,4 +215,55 @@ describe('Location Class', () => {
       expect(notificationCount).toBe(1);
     });
   });
+
+  describe('location.normalize(url) should return only route', () => {
+    const basePath = '/en';
+    const route = '/go/to/there';
+    const url = basePath + route;
+    const getBaseHref = (origin: string) => origin + basePath + '/';
+
+    it('in case APP_BASE_HREF starts with http:', () => {
+      const origin = 'http://example.com';
+      const baseHref = getBaseHref(origin);
+
+      TestBed.configureTestingModule({providers: [{provide: APP_BASE_HREF, useValue: baseHref}]});
+
+      const location = TestBed.inject(Location);
+
+      expect(location.normalize(url)).toBe(route);
+    });
+
+    it('in case APP_BASE_HREF starts with https:', () => {
+      const origin = 'https://example.com';
+      const baseHref = getBaseHref(origin);
+
+      TestBed.configureTestingModule({providers: [{provide: APP_BASE_HREF, useValue: baseHref}]});
+
+      const location = TestBed.inject(Location);
+
+      expect(location.normalize(url)).toBe(route);
+    });
+
+    it('in case APP_BASE_HREF starts with no protocol', () => {
+      const origin = '//example.com';
+      const baseHref = getBaseHref(origin);
+
+      TestBed.configureTestingModule({providers: [{provide: APP_BASE_HREF, useValue: baseHref}]});
+
+      const location = TestBed.inject(Location);
+
+      expect(location.normalize(url)).toBe(route);
+    });
+
+    it('in case APP_BASE_HREF starts with no origin', () => {
+      const origin = '';
+      const baseHref = getBaseHref(origin);
+
+      TestBed.configureTestingModule({providers: [{provide: APP_BASE_HREF, useValue: baseHref}]});
+
+      const location = TestBed.inject(Location);
+
+      expect(location.normalize(url)).toBe(route);
+    });
+  });
 });
diff --git a/packages/common/testing/src/location_mock.ts b/packages/common/testing/src/location_mock.ts
@@ -25,7 +25,7 @@ export class SpyLocation implements Location {
   /** @internal */
   _subject: EventEmitter<any> = new EventEmitter();
   /** @internal */
-  _baseHref: string = '';
+  _basePath: string = '';
   /** @internal */
   _locationStrategy: LocationStrategy = null!;
   /** @internal */
@@ -43,7 +43,7 @@ export class SpyLocation implements Location {
   }
 
   setBaseHref(url: string) {
-    this._baseHref = url;
+    this._basePath = url;
   }
 
   path(): string {
@@ -81,7 +81,7 @@ export class SpyLocation implements Location {
     if (url.length > 0 && !url.startsWith('/')) {
       url = '/' + url;
     }
-    return this._baseHref + url;
+    return this._basePath + url;
   }
 
   go(path: string, query: string = '', state: any = null) {

Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ export class SpyLocation implements Location {`
`25`	`25`	`/** @internal */`
`26`	`26`	`_subject: EventEmitter<any> = new EventEmitter();`
`27`	`27`	`/** @internal */`
`28`		`- _baseHref: string = '';`
	`28`	`+ _basePath: string = '';`
`29`	`29`	`/** @internal */`
`30`	`30`	`_locationStrategy: LocationStrategy = null!;`
`31`	`31`	`/** @internal */`
`@@ -43,7 +43,7 @@ export class SpyLocation implements Location {`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`setBaseHref(url: string) {`
`46`		`- this._baseHref = url;`
	`46`	`+ this._basePath = url;`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`path(): string {`
`@@ -81,7 +81,7 @@ export class SpyLocation implements Location {`
`81`	`81`	`if (url.length > 0 && !url.startsWith('/')) {`
`82`	`82`	`url = '/' + url;`
`83`	`83`	`}`
`84`		`- return this._baseHref + url;`
	`84`	`+ return this._basePath + url;`
`85`	`85`	`}`
`86`	`86`
`87`	`87`	`go(path: string, query: string = '', state: any = null) {`