Skip to content

Commit 32c7bcc

Browse files
GethosTheWalrusryanlawsonjasonsaayman
authored
feat: Add config for ignoring absolute URLs (#5902) (#6192)
* fix: prevent request url override prevent request URL from overriding preconfigured base URL BREAKING CHANGE: code relying on the above will now combine the URLs instead of prefer request URL * feat: add config option for allowing absolute URLs * fix: add default value for allowAbsoluteUrls in buildFullPath * fix: typo in flow control when setting allowAbsoluteUrls * feat: update tests supporting issue #5902 functionality * feat: update README.md with allowAbsoluteUrls * fix: properly group conditions in buildFullPath.js to avoid undefined error when baseUrl undefined * Update README.md fix typo * fix: update build full path logic to address failing test case * fix: update base URL test * fix: remove problem test (works locally, will not work in the pipeline) * fix: update https test to use github.com instead of google.com * fix: revert previous commit * fix: add back problem test * chore: remove un-needed passed var to URL class instanciation --------- Co-authored-by: Austin Ryan Lawson <[email protected]> Co-authored-by: Jay <[email protected]>
1 parent 4a3e26c commit 32c7bcc

File tree

5 files changed

+42
-8
lines changed

5 files changed

+42
-8
lines changed

‎README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -375,11 +375,16 @@ These are the available config options for making requests. Only the `url` is re
375375
// `method` is the request method to be used when making the request
376376
method: 'get', // default
377377

378-
// `baseURL` will be prepended to `url` unless `url` is absolute.
378+
// `baseURL` will be prepended to `url` unless `url` is absolute and option `allowAbsoluteUrls` is set to true.
379379
// It can be convenient to set `baseURL` for an instance of axios to pass relative URLs
380380
// to methods of that instance.
381381
baseURL: 'https://some-domain.com/api/',
382382

383+
// `allowAbsoluteUrls` determines whether or not absolute URLs will override a configured `baseUrl`.
384+
// When set to true (default), absolute values for `url` will override `baseUrl`.
385+
// When set to false, absolute values for `url` will always be prepended by `baseUrl`.
386+
allowAbsoluteUrls: true,
387+
383388
// `transformRequest` allows changes to the request data before it is sent to the server
384389
// This is only applicable for request methods 'PUT', 'POST', 'PATCH' and 'DELETE'
385390
// The last function in the array must return a string or an instance of Buffer, ArrayBuffer,

‎lib/core/Axios.js

+10-1
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,15 @@ class Axios {
9797
}
9898
}
9999

100+
// Set config.allowAbsoluteUrls
101+
if (config.allowAbsoluteUrls !== undefined) {
102+
// do nothing
103+
} else if (this.defaults.allowAbsoluteUrls !== undefined) {
104+
config.allowAbsoluteUrls = this.defaults.allowAbsoluteUrls;
105+
} else {
106+
config.allowAbsoluteUrls = true;
107+
}
108+
100109
validator.assertOptions(config, {
101110
baseUrl: validators.spelling('baseURL'),
102111
withXsrfToken: validators.spelling('withXSRFToken')
@@ -192,7 +201,7 @@ class Axios {
192201

193202
getUri(config) {
194203
config = mergeConfig(this.defaults, config);
195-
const fullPath = buildFullPath(config.baseURL, config.url);
204+
const fullPath = buildFullPath(config.baseURL, config.url, config.allowAbsoluteUrls);
196205
return buildURL(fullPath, config.params, config.paramsSerializer);
197206
}
198207
}

‎lib/core/buildFullPath.js

+3-2
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ import combineURLs from '../helpers/combineURLs.js';
1313
*
1414
* @returns {string} The combined full path
1515
*/
16-
export default function buildFullPath(baseURL, requestedURL) {
17-
if (baseURL && !isAbsoluteURL(requestedURL)) {
16+
export default function buildFullPath(baseURL, requestedURL, allowAbsoluteUrls) {
17+
let isRelativeUrl = !isAbsoluteURL(requestedURL);
18+
if (baseURL && isRelativeUrl || allowAbsoluteUrls == false) {
1819
return combineURLs(baseURL, requestedURL);
1920
}
2021
return requestedURL;

‎test/specs/core/buildFullPath.spec.js

+5-1
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,14 @@ describe('helpers::buildFullPath', function () {
55
expect(buildFullPath('https://api.github.com', '/users')).toBe('https://api.github.com/users');
66
});
77

8-
it('should return the requestedURL when it is absolute', function () {
8+
it('should not combine the URLs when the requestedURL is absolute', function () {
99
expect(buildFullPath('https://api.github.com', 'https://api.example.com/users')).toBe('https://api.example.com/users');
1010
});
1111

12+
it('should combine the URLs when the requestedURL is absolute and allowAbsoluteUrls is false', function () {
13+
expect(buildFullPath('https://api.github.com', 'https://api.example.com/users', false)).toBe('https://api.github.com/https://api.example.com/users');
14+
});
15+
1216
it('should not combine URLs when the baseURL is not configured', function () {
1317
expect(buildFullPath(undefined, '/users')).toBe('/users');
1418
});

‎test/specs/options.spec.js

+18-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
import AxiosHeaders from "../../lib/core/AxiosHeaders.js";
1+
// import AxiosHeaders from "../../lib/core/AxiosHeaders.js";
2+
// import isAbsoluteURL from '../../lib/helpers/isAbsoluteURL.js';
23

34
describe('options', function () {
45
beforeEach(function () {
@@ -63,8 +64,7 @@ describe('options', function () {
6364
baseURL: 'http://test.com/'
6465
});
6566

66-
instance.get('/foo');
67-
67+
instance.get('/foo')
6868
getAjaxRequest().then(function (request) {
6969
expect(request.url).toBe('http://test.com/foo');
7070
done();
@@ -100,6 +100,21 @@ describe('options', function () {
100100
});
101101
});
102102

103+
it('should combine the URLs if base url and request url exist and allowAbsoluteUrls is false', function (done) {
104+
const instance = axios.create({
105+
baseURL: 'http://someurl.com/',
106+
allowAbsoluteUrls: false
107+
});
108+
109+
instance.get('http://someotherurl.com/');
110+
111+
getAjaxRequest().then(function (request) {
112+
expect(request.url).toBe('http://someotherurl.com/');
113+
done();
114+
});
115+
116+
});
117+
103118
it('should change only the baseURL of the specified instance', function() {
104119
const instance1 = axios.create();
105120
const instance2 = axios.create();

0 commit comments

Comments
 (0)