2
0
mirror of https://github.com/tenrok/axios.git synced 2026-06-20 20:00:40 +03:00

fix(adapters): improved adapters loading logic to have clear error messages; (#5919)

This commit is contained in:
Dmitriy Mozgovoy
2023-09-26 19:43:25 +03:00
committed by GitHub
parent bc9af51b18
commit e4107797a7
3 changed files with 82 additions and 16 deletions
+33 -15
View File
@@ -9,7 +9,7 @@ const knownAdapters = {
} }
utils.forEach(knownAdapters, (fn, value) => { utils.forEach(knownAdapters, (fn, value) => {
if(fn) { if (fn) {
try { try {
Object.defineProperty(fn, 'name', {value}); Object.defineProperty(fn, 'name', {value});
} catch (e) { } catch (e) {
@@ -19,6 +19,10 @@ utils.forEach(knownAdapters, (fn, value) => {
} }
}); });
const renderReason = (reason) => `- ${reason}`;
const isResolvedHandle = (adapter) => utils.isFunction(adapter) || adapter === null || adapter === false;
export default { export default {
getAdapter: (adapters) => { getAdapter: (adapters) => {
adapters = utils.isArray(adapters) ? adapters : [adapters]; adapters = utils.isArray(adapters) ? adapters : [adapters];
@@ -27,32 +31,46 @@ export default {
let nameOrAdapter; let nameOrAdapter;
let adapter; let adapter;
const rejectedReasons = {};
for (let i = 0; i < length; i++) { for (let i = 0; i < length; i++) {
nameOrAdapter = adapters[i]; nameOrAdapter = adapters[i];
if((adapter = utils.isString(nameOrAdapter) ? knownAdapters[nameOrAdapter.toLowerCase()] : nameOrAdapter)) { let id;
adapter = nameOrAdapter;
if (!isResolvedHandle(nameOrAdapter)) {
adapter = knownAdapters[(id = String(nameOrAdapter)).toLowerCase()];
if (adapter === undefined) {
throw new AxiosError(`Unknown adapter '${id}'`);
}
}
if (adapter) {
break; break;
} }
rejectedReasons[id || '#' + i] = adapter;
} }
if (!adapter) { if (!adapter) {
if (adapter === false) {
throw new AxiosError( const reasons = Object.entries(rejectedReasons)
`Adapter ${nameOrAdapter} is not supported by the environment`, .map(([id, state]) => `adapter ${id} ` +
'ERR_NOT_SUPPORT' (state === false ? 'is not supported by the environment' : 'is not available in the build')
); );
}
throw new Error( let s = length ?
utils.hasOwnProp(knownAdapters, nameOrAdapter) ? (reasons.length > 1 ? 'since :\n' + reasons.map(renderReason).join('\n') : ' ' + renderReason(reasons[0])) :
`Adapter '${nameOrAdapter}' is not available in the build` : 'as no adapter specified';
`Unknown adapter '${nameOrAdapter}'`
throw new AxiosError(
`There is no suitable adapter to dispatch the request ` + s,
'ERR_NOT_SUPPORT'
); );
} }
if (!utils.isFunction(adapter)) {
throw new TypeError('adapter is not a function');
}
return adapter; return adapter;
}, },
adapters: knownAdapters adapters: knownAdapters
+1 -1
View File
@@ -37,7 +37,7 @@ const defaults = {
transitional: transitionalDefaults, transitional: transitionalDefaults,
adapter: platform.isNode ? 'http' : 'xhr', adapter: ['xhr', 'http'],
transformRequest: [function transformRequest(data, headers) { transformRequest: [function transformRequest(data, headers) {
const contentType = headers.getContentType() || ''; const contentType = headers.getContentType() || '';
+48
View File
@@ -0,0 +1,48 @@
import adapters from '../../../lib/adapters/adapters.js';
import assert from 'assert';
describe('adapters', function () {
const store = {...adapters.adapters};
beforeEach(() => {
Object.keys(adapters.adapters).forEach((name) => {
delete adapters.adapters[name];
});
Object.assign(adapters.adapters, store);
});
it('should support loading by fn handle', function () {
const adapter = () => {};
assert.strictEqual(adapters.getAdapter(adapter), adapter);
});
it('should support loading by name', function () {
const adapter = () => {};
adapters.adapters['testadapter'] = adapter;
assert.strictEqual(adapters.getAdapter('testAdapter'), adapter);
});
it('should detect adapter unavailable status', function () {
adapters.adapters['testadapter'] = null;
assert.throws(()=> adapters.getAdapter('testAdapter'), /is not available in the build/)
});
it('should detect adapter unsupported status', function () {
adapters.adapters['testadapter'] = false;
assert.throws(()=> adapters.getAdapter('testAdapter'), /is not supported by the environment/)
});
it('should pick suitable adapter from the list', function () {
const adapter = () => {};
Object.assign(adapters.adapters, {
foo: false,
bar: null,
baz: adapter
});
assert.strictEqual(adapters.getAdapter(['foo', 'bar', 'baz']), adapter);
});
});