fix(common): adjust MockPlatformLocation to set state to new object (#30055)

jasonaden · benlesh · commit 825efa8721b9 · 2019-04-24T13:49:29.000-07:00
When using the `history` API, setting a new `state` and retrieving it does not pass a `===` test to the object used to set the state. In other words, `history.state` is always a copy. This change makes the `MockPlatformLocation` behave in the same way. PR Close #30055
diff --git a/packages/common/testing/src/mock_platform_location.ts b/packages/common/testing/src/mock_platform_location.ts
@@ -12,10 +12,10 @@ import {Subject} from 'rxjs';
 
 function parseUrl(urlStr: string, baseHref: string) {
   const verifyProtocol = /^((http[s]?|ftp):\/\/)/;
-  let serverBase = '';
+  let serverBase;
 
-  // URL class requires full URL. If the URL string doesn't start with protocol, we need to add an
-  // arbitrary base URL which can be removed afterward.
+  // URL class requires full URL. If the URL string doesn't start with protocol, we need to add
+  // an arbitrary base URL which can be removed afterward.
   if (!verifyProtocol.test(urlStr)) {
     serverBase = 'http://empty.com/';
   }
@@ -62,7 +62,7 @@ export class MockPlatformLocation implements PlatformLocation {
       this.baseHref = config.appBaseHref || '';
 
       const parsedChanges =
-          this.parseChanges(null, config.startUrl || 'http://<empty>', this.baseHref);
+          this.parseChanges(null, config.startUrl || 'http://<empty>/', this.baseHref);
       this.urlChanges[0] = {...parsedChanges};
     }
   }
@@ -86,7 +86,9 @@ export class MockPlatformLocation implements PlatformLocation {
   onHashChange(fn: LocationChangeListener): void { this.hashUpdate.subscribe(fn); }
 
   get href(): string {
-    return `${this.protocol}//${this.hostname}${this.baseHref}${this.pathname === '/' ? '' : this.pathname}${this.search}${this.hash}`;
+    let url = `${this.protocol}//${this.hostname}${this.port ? ':' + this.port : ''}`;
+    url += `${this.pathname === '/' ? '' : this.pathname}${this.search}${this.hash}`
+    return url;
   }
 
   get url(): string { return `${this.pathname}${this.search}${this.hash}`; }
@@ -104,6 +106,8 @@ export class MockPlatformLocation implements PlatformLocation {
   }
 
   private parseChanges(state: unknown, url: string, baseHref: string = '') {
+    // When the `history.state` value is stored, it is always copied.
+    state = JSON.parse(JSON.stringify(state));
     return {...parseUrl(url, baseHref), state};
   }
 
diff --git a/packages/common/testing/tsconfig-build.json b/packages/common/testing/tsconfig-build.json
@@ -1,26 +1,27 @@
 {
   "extends": "../tsconfig-build.json",
-
   "compilerOptions": {
     "baseUrl": ".",
     "rootDir": "../",
     "paths": {
-      "@angular/core": ["../../../dist/packages/core"],
-      "@angular/common": ["../../../dist/packages/common"]
+      "@angular/core": [
+        "../../../dist/packages/core"
+      ],
+      "@angular/common": [
+        "../../../dist/packages/common"
+      ]
     },
     "outDir": "../../../dist/packages/common"
   },
-
   "files": [
     "public_api.ts",
     "../../../node_modules/zone.js/dist/zone.js.d.ts"
   ],
-
   "angularCompilerOptions": {
     "annotateForClosureCompiler": true,
     "strictMetadataEmit": false,
     "skipTemplateCodegen": true,
     "flatModuleOutFile": "testing.js",
     "flatModuleId": "@angular/common/testing"
   }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -12,10 +12,10 @@ import {Subject} from 'rxjs';`
`12`	`12`
`13`	`13`	`function parseUrl(urlStr: string, baseHref: string) {`
`14`	`14`	`const verifyProtocol = /^((http[s]?\|ftp):\/\/)/;`
`15`		`- let serverBase = '';`
	`15`	`+ let serverBase;`
`16`	`16`
`17`		`- // URL class requires full URL. If the URL string doesn't start with protocol, we need to add an`
`18`		`- // arbitrary base URL which can be removed afterward.`
	`17`	`+ // URL class requires full URL. If the URL string doesn't start with protocol, we need to add`
	`18`	`+ // an arbitrary base URL which can be removed afterward.`
`19`	`19`	`if (!verifyProtocol.test(urlStr)) {`
`20`	`20`	`serverBase = 'http://empty.com/';`
`21`	`21`	`}`
`@@ -62,7 +62,7 @@ export class MockPlatformLocation implements PlatformLocation {`
`62`	`62`	`this.baseHref = config.appBaseHref \|\| '';`
`63`	`63`
`64`	`64`	`const parsedChanges =`
`65`		`- this.parseChanges(null, config.startUrl \|\| 'http://<empty>', this.baseHref);`
	`65`	`+ this.parseChanges(null, config.startUrl \|\| 'http://<empty>/', this.baseHref);`
`66`	`66`	`this.urlChanges[0] = {...parsedChanges};`
`67`	`67`	`}`
`68`	`68`	`}`
`@@ -86,7 +86,9 @@ export class MockPlatformLocation implements PlatformLocation {`
`86`	`86`	`onHashChange(fn: LocationChangeListener): void { this.hashUpdate.subscribe(fn); }`
`87`	`87`
`88`	`88`	`get href(): string {`
`89`		- return `${this.protocol}//${this.hostname}${this.baseHref}${this.pathname === '/' ? '' : this.pathname}${this.search}${this.hash}`;
	`89`	+ let url = `${this.protocol}//${this.hostname}${this.port ? ':' + this.port : ''}`;
	`90`	+ url += `${this.pathname === '/' ? '' : this.pathname}${this.search}${this.hash}`
	`91`	`+ return url;`
`90`	`92`	`}`
`91`	`93`
`92`	`94`	get url(): string { return `${this.pathname}${this.search}${this.hash}`; }
`@@ -104,6 +106,8 @@ export class MockPlatformLocation implements PlatformLocation {`
`104`	`106`	`}`
`105`	`107`
`106`	`108`	`private parseChanges(state: unknown, url: string, baseHref: string = '') {`
	`109`	+ // When the `history.state` value is stored, it is always copied.
	`110`	`+ state = JSON.parse(JSON.stringify(state));`
`107`	`111`	`return {...parseUrl(url, baseHref), state};`
`108`	`112`	`}`
`109`	`113`