mirrors/shlink-web-client
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink-web-client.git synced 2025-01-11 10:47:27 +03:00
Code Issues Projects Releases Packages Wiki Activity

Updated ShlinkApiClient so that it retries API version when v2 is not supported

Browse source
This commit is contained in:
Alejandro Celaya 2020-01-11 13:55:37 +01:00
parent ba8cade6fc
commit 0f51bf95e3
2 changed files with 35 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
src/utils/services/ShlinkApiClient.js
View file

@ -2,8 +2,6 @@ import qs from 'qs';
import { isEmpty, isNil, reject } from 'ramda'; import { isEmpty, isNil, reject } from 'ramda';
import PropTypes from 'prop-types'; import PropTypes from 'prop-types';
const API_VERSION = '1';
export const apiErrorType = PropTypes.shape({ export const apiErrorType = PropTypes.shape({
type: PropTypes.string, type: PropTypes.string,
detail: PropTypes.string, detail: PropTypes.string,
@ -13,12 +11,13 @@ export const apiErrorType = PropTypes.shape({
message: PropTypes.string, // Deprecated message: PropTypes.string, // Deprecated
}); });
export const buildShlinkBaseUrl = (url) => url ? `${url}/rest/v${API_VERSION}` : ''; const buildShlinkBaseUrl = (url, apiVersion) => url ? `${url}/rest/v${apiVersion}` : '';
export default class ShlinkApiClient { export default class ShlinkApiClient {
constructor(axios, baseUrl, apiKey) { constructor(axios, baseUrl, apiKey) {
this.axios = axios; this.axios = axios;
this._baseUrl = buildShlinkBaseUrl(baseUrl); this._apiVersion = 2;
this._baseUrl = baseUrl;
this._apiKey = apiKey || ''; this._apiKey = apiKey || '';
} }
@ -63,13 +62,35 @@ export default class ShlinkApiClient {
health = () => this._performRequest('/health', 'GET').then((resp) => resp.data); health = () => this._performRequest('/health', 'GET').then((resp) => resp.data);
_performRequest = async (url, method = 'GET', query = {}, body = {}) => _performRequest = async (url, method = 'GET', query = {}, body = {}) => {
await this.axios({ try {
return await this.axios({
method, method,
url: `${this._baseUrl}${url}`, url: `${buildShlinkBaseUrl(this._baseUrl, this._apiVersion)}${url}`,
headers: { 'X-Api-Key': this._apiKey }, headers: { 'X-Api-Key': this._apiKey },
params: query, params: query,
data: body, data: body,
paramsSerializer: (params) => qs.stringify(params, { arrayFormat: 'brackets' }), paramsSerializer: (params) => qs.stringify(params, { arrayFormat: 'brackets' }),
}); });
} catch (e) {
const { response } = e;
// Due to a bug on all previous Shlink versions, requests to non-matching URLs will always result on a CORS error
// when performed from the browser (due to the preflight request not returning a 2xx status.
// See https://github.com/shlinkio/shlink/issues/614), which will make the "response" prop not to be set here.
// The bug will be fixed on upcoming Shlink patches, but for other versions, we can consider this situation as
// if a request has been performed to a not supported API version.
const apiVersionIsNotSupported = !response;
// When the request is not invalid or we have already tried both API versions, throw the error and let the
// caller handle it
if (!apiVersionIsNotSupported || this._apiVersion === 1) {
throw e;
}
this._apiVersion = 1;
return await this._performRequest(url, method, query, body);
}
}
} }

3
test/utils/services/ShlinkApiClientBuilder.test.js
View file

@ -1,5 +1,4 @@
import buildShlinkApiClient from '../../../src/utils/services/ShlinkApiClientBuilder'; import buildShlinkApiClient from '../../../src/utils/services/ShlinkApiClientBuilder';
import { buildShlinkBaseUrl } from '../../../src/utils/services/ShlinkApiClient';
describe('ShlinkApiClientBuilder', () => { describe('ShlinkApiClientBuilder', () => {
const createBuilder = () => { const createBuilder = () => {
@ -40,7 +39,7 @@ describe('ShlinkApiClientBuilder', () => {
const apiKey = 'apiKey'; const apiKey = 'apiKey';
const apiClient = await buildShlinkApiClient({})({ url, apiKey }); const apiClient = await buildShlinkApiClient({})({ url, apiKey });
expect(apiClient._baseUrl).toEqual(buildShlinkBaseUrl(url)); expect(apiClient._baseUrl).toEqual(url);
expect(apiClient._apiKey).toEqual(apiKey); expect(apiClient._apiKey).toEqual(apiKey);
}); });
}); });