Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

fix: avoid URL-confusing default pathname in baseUrl #565

Merged
merged 1 commit into from
Feb 15, 2021
Merged

fix: avoid URL-confusing default pathname in baseUrl #565

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions src/resolver/resolver.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

import matchRoute from './matchRoute.js';
import resolveRoute from './resolveRoute.js';
import {toArray, ensureRoutes, isString, getNotFoundError, notFoundResult} from '../utils.js';
import {ensureRoutes, getNotFoundError, isString, notFoundResult, toArray} from '../utils.js';

function isChildRoute(parentRoute, childRoute) {
let route = childRoute;
Expand Down Expand Up @@ -241,7 +241,11 @@ class Resolver {
}

const base = this.__effectiveBaseUrl;
const normalizedUrl = this.constructor.__createUrl(pathname, base).href;
// Convert pathname to a valid URL constructor argument
const url = pathname[0] === '/'
? this.constructor.__createUrl(base).origin + pathname
: './' + pathname;
const normalizedUrl = this.constructor.__createUrl(url, base).href;
if (normalizedUrl.slice(0, base.length) === base) {
return normalizedUrl.slice(base.length);
}
Expand Down
6 changes: 3 additions & 3 deletions src/router.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ export class Router extends Resolver {
const baseHref = baseElement && baseElement.getAttribute('href');
super([], Object.assign({
// Default options
baseUrl: baseHref && Resolver.__createUrl(baseHref, document.URL).pathname.replace(/[^\/]*$/, '')
baseUrl: baseHref && Resolver.__createUrl(baseHref, document.URL).href.replace(/[^\/]*$/, '')
}, options));

this.resolveRoute = context => this.__resolveRoute(context);
Expand All @@ -191,8 +191,8 @@ export class Router extends Resolver {
/**
* The base URL for all routes in the router instance. By default,
* if the base element exists in the `<head>`, vaadin-router
* takes the `<base href>` attribute value, resolves against current `document.URL`
* and gets the `pathname` from the result.
* takes the `<base href>` attribute value, resolved against the current
* `document.URL`.
*
* @public
* @type {string}
Expand Down
14 changes: 12 additions & 2 deletions test/resolver/resolver.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -844,12 +844,22 @@
expect(stub).to.be.called;
});

it('should invoke Resolver.__createUrl(path, base) hook', () => {
it('should invoke Resolver.__createUrl(url, base) hook', () => {
sinon.spy(Resolver, '__createUrl');
try {
// Absolute pathname: prepend origin
new Resolver([], {baseUrl: '/foo/bar'}).__normalizePathname('/baz/');
expect(Resolver.__createUrl).to.be.calledWith(
'/baz/',
location.origin + '/baz/',
location.origin + '/foo/'
);

Resolver.__createUrl.reset();

// Relative pathname: prepend dot path prefix
new Resolver([], {baseUrl: '/foo/bar'}).__normalizePathname('baz');
expect(Resolver.__createUrl).to.be.calledWith(
'./baz',
location.origin + '/foo/'
);
} finally {
Expand Down
47 changes: 27 additions & 20 deletions test/router/router.spec.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,53 +108,48 @@
});

describe('baseUrl', () => {
const baseElement = document.createElement('base');

beforeEach(() => {
baseElement.removeAttribute('href');
document.head.appendChild(baseElement);
});

afterEach(() => {
document.head.removeChild(baseElement);
});

it('should accept baseUrl in options object as the 2nd argument', () => {
router = new Vaadin.Router(null, {baseUrl: '/users/'});
expect(router).to.have.property('baseUrl', '/users/');
});

it('should use <base href> as default baseUrl', () => {
const baseElement = document.createElement('base');
baseElement.setAttribute('href', '/foo/');
document.head.appendChild(baseElement);

router = new Vaadin.Router(null);
expect(router).to.have.property('baseUrl', '/foo/');

document.head.removeChild(baseElement);
expect(router).to.have.property('baseUrl', location.origin + '/foo/');
});

it('should resolve relative base href when setting baseUrl', async() => {
const baseElement = document.createElement('base');
baseElement.setAttribute('href', './foo/../bar/asdf');
document.head.appendChild(baseElement);

router = new Vaadin.Router(null);
expect(router).to.have.property('baseUrl', '/bar/');

document.head.removeChild(baseElement);
expect(router).to.have.property('baseUrl', location.origin + '/bar/');
});

it('should use absolute base href when setting baseUrl', async() => {
const baseElement = document.createElement('base');
baseElement.setAttribute('href', '/my/base/');
document.head.appendChild(baseElement);

router = new Vaadin.Router(null);
expect(router).to.have.property('baseUrl', '/my/base/');

document.head.removeChild(baseElement);
expect(router).to.have.property('baseUrl', location.origin + '/my/base/');
});

it('should use custom base href when setting baseUrl', async() => {
const baseElement = document.createElement('base');
baseElement.setAttribute('href', 'http://localhost:8080/my/custom/base/');
document.head.appendChild(baseElement);

router = new Vaadin.Router(null);
expect(router).to.have.property('baseUrl', '/my/custom/base/');

document.head.removeChild(baseElement);
expect(router).to.have.property('baseUrl', 'http://localhost:8080/my/custom/base/');
});

it('should use baseUrl when matching relative routes', async() => {
Expand Down Expand Up @@ -186,6 +181,18 @@
await router.render('/foo/home');
checkOutlet(['x-home-view']);
});

it('should not throw when base path starts with double slash', async() => {
baseElement.setAttribute('href', location.origin + '//foo');

router = new Vaadin.Router(outlet);
expect(router).to.have.property('baseUrl', location.origin + '//');

router.setRoutes([{path: '(.*)', component: 'x-home-view'}]);

await router.render('//');
checkOutlet(['x-home-view']);
});
});

describe('router.render(pathname)', () => {
Expand Down