cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(platform-server): Resolve absolute URL from baseUrl (#39334)

Browse Source 
This commit fixes a bug when `useAbsoluteUrl` is set to true and
`ServerPlatformLocation` infers the base url from the supplied
`url`. User should explicitly set the `baseUrl` when they turn on
`useAbsoluteUrl`.

Breaking change:
If you use `useAbsoluteUrl` to setup `platform-server`, you now need to
also specify `baseUrl`.
We are intentionally making this a breaking change in a minor release,
because if `useAbsoluteUrl` is set to `true` then the behavior of the
application could be unpredictable, resulting in issues that are hard to
discover but could be affecting production environments.

PR Close #39334
This commit is contained in:
Keen Yee Liau
2020-10-19 15:23:37 -07:00
committed by Andrew Kushnir
parent d33eaa64a2
commit 7768aeb62f
4 changed files with 119 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
packages/platform-server/test/integration_spec.ts
View File

@ -794,10 +794,62 @@ describe('platform-server integration', () => {
}));
describe('relative requests', () => {
it('will throw if "useAbsoluteUrl" is true but "baseUrl" is not provided', async () => {
const platform = platformDynamicServer([{
provide: INITIAL_CONFIG,
useValue: {
document: '<app></app>',
url: 'http://localhost',
useAbsoluteUrl: true,
},
}]);
const appRef = await platform.bootstrapModule(HttpClientExampleModule);
expect(() => appRef.injector.get(PlatformLocation))
.toThrowError(/"PlatformConfig\.baseUrl" must be set if "useAbsoluteUrl" is true/);
});
it('will resolve absolute url using "baseUrl"', async () => {
const platform = platformDynamicServer([{
provide: INITIAL_CONFIG,
useValue: {
document: '<app></app>',
url: 'http://localhost',
useAbsoluteUrl: true,
baseUrl: 'https://angular.io:8080',
},
}]);
const appRef = await platform.bootstrapModule(HttpClientExampleModule);
const location = appRef.injector.get(PlatformLocation);
expect(location.protocol).toBe('https:');
expect(location.hostname).toBe('angular.io');
expect(location.port).toBe('8080');
});
it('"baseUrl" has no effect if "useAbsoluteUrl" is not enabled', async () => {
const platform = platformDynamicServer([{
provide: INITIAL_CONFIG,
useValue: {
document: '<app></app>',
url: 'http://localhost',
baseUrl: 'https://angular.io:8080',
},
}]);
const appRef = await platform.bootstrapModule(HttpClientExampleModule);
const location = appRef.injector.get(PlatformLocation);
expect(location.protocol).toBe('http:');
expect(location.hostname).toBe('localhost');
expect(location.port).toBe('');
});
it('correctly maps to absolute URL request with base config', async () => {
const platform = platformDynamicServer([{
provide: INITIAL_CONFIG,
useValue: {document: '<app></app>', url: 'http://localhost', useAbsoluteUrl: true}
useValue: {
document: '<app></app>',
url: 'http://localhost',
baseUrl: 'http://localhost',
useAbsoluteUrl: true,
}
}]);
const ref = await platform.bootstrapModule(HttpClientExampleModule);
const mock = ref.injector.get(HttpTestingController) as HttpTestingController;
@ -831,7 +883,12 @@ describe('platform-server integration', () => {
it('correctly maps to absolute URL request with port', async () => {
const platform = platformDynamicServer([{
provide: INITIAL_CONFIG,
useValue: {document: '<app></app>', url: 'http://localhost:5000', useAbsoluteUrl: true}
useValue: {
document: '<app></app>',
url: 'http://localhost:5000',
baseUrl: 'http://localhost',
useAbsoluteUrl: true,
}
}]);
const ref = await platform.bootstrapModule(HttpClientExampleModule);
const mock = ref.injector.get(HttpTestingController) as HttpTestingController;
@ -848,7 +905,12 @@ describe('platform-server integration', () => {
it('correctly maps to absolute URL request with two slashes', async () => {
const platform = platformDynamicServer([{
provide: INITIAL_CONFIG,
useValue: {document: '<app></app>', url: 'http://localhost/', useAbsoluteUrl: true}
useValue: {
document: '<app></app>',
url: 'http://localhost/',
baseUrl: 'http://localhost',
useAbsoluteUrl: true,
}
}]);
const ref = await platform.bootstrapModule(HttpClientExampleModule);
const mock = ref.injector.get(HttpTestingController) as HttpTestingController;
@ -865,7 +927,12 @@ describe('platform-server integration', () => {
it('correctly maps to absolute URL request with no slashes', async () => {
const platform = platformDynamicServer([{
provide: INITIAL_CONFIG,
useValue: {document: '<app></app>', url: 'http://localhost', useAbsoluteUrl: true}
useValue: {
document: '<app></app>',
url: 'http://localhost',
baseUrl: 'http://localhost',
useAbsoluteUrl: true,
}
}]);
const ref = await platform.bootstrapModule(HttpClientExampleModule);
const mock = ref.injector.get(HttpTestingController) as HttpTestingController;
@ -882,8 +949,12 @@ describe('platform-server integration', () => {
it('correctly maps to absolute URL request with longer url and no slashes', async () => {
const platform = platformDynamicServer([{
provide: INITIAL_CONFIG,
useValue:
{document: '<app></app>', url: 'http://localhost/path/page', useAbsoluteUrl: true}
useValue: {
document: '<app></app>',
url: 'http://localhost/path/page',
baseUrl: 'http://localhost',
useAbsoluteUrl: true,
}
}]);
const ref = await platform.bootstrapModule(HttpClientExampleModule);
const mock = ref.injector.get(HttpTestingController) as HttpTestingController;
@ -900,8 +971,12 @@ describe('platform-server integration', () => {
it('correctly maps to absolute URL request with longer url and slashes', async () => {
const platform = platformDynamicServer([{
provide: INITIAL_CONFIG,
useValue:
{document: '<app></app>', url: 'http://localhost/path/page', useAbsoluteUrl: true}
useValue: {
document: '<app></app>',
url: 'http://localhost/path/page',
baseUrl: 'http://localhost',
useAbsoluteUrl: true,
}
}]);
const ref = await platform.bootstrapModule(HttpClientExampleModule);
const mock = ref.injector.get(HttpTestingController) as HttpTestingController;
@ -922,7 +997,8 @@ describe('platform-server integration', () => {
useValue: {
document: '<base href="http://other"><app></app>',
url: 'http://localhost/path/page',
useAbsoluteUrl: true
baseUrl: 'http://localhost',
useAbsoluteUrl: true,
}
}]);
const ref = await platform.bootstrapModule(HttpClientExampleModule);