Skip to content

[kbnClient] fix basePath handling and export reponse type #97277

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
spalger merged 2 commits into from
Apr 16, 2021
Merged

[kbnClient] fix basePath handling and export reponse type #97277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
25bcb84
[kbnClient] fix basePath handling and export reponse type
spalger Apr 15, 2021
0a63444
Merge branch 'master' into fix/kbn-client/basepath-and-export-reponse…
kibanamachine Apr 15, 2021
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
1 change: 1 addition & 0 deletions packages/kbn-test/src/kbn_client/kbn_client_import_export.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ export class KbnClientImportExport {
excludeExportDetails: true,
includeReferencesDeep: true,
},
responseType: 'text',
});

if (typeof resp.data !== 'string') {
Expand Down
15 changes: 12 additions & 3 deletions packages/kbn-test/src/kbn_client/kbn_client_requester.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import Url from 'url';
import Https from 'https';
import Qs from 'querystring';

import Axios, { AxiosResponse } from 'axios';
import Axios, { AxiosResponse, ResponseType } from 'axios';
import { ToolingLog, isAxiosRequestError, isAxiosResponseError } from '@kbn/dev-utils';

const isConcliftOnGetError = (error: any) => {
Expand Down Expand Up @@ -53,6 +53,7 @@ export interface ReqOptions {
body?: any;
retries?: number;
headers?: Record<string, string>;
responseType?: ResponseType;
}

const delay = (ms: number) =>
Expand Down Expand Up @@ -84,11 +85,16 @@ export class KbnClientRequester {
}

public resolveUrl(relativeUrl: string = '/') {
return Url.resolve(this.pickUrl(), relativeUrl);
let baseUrl = this.pickUrl();
if (!baseUrl.endsWith('/')) {
baseUrl += '/';
}
const relative = relativeUrl.startsWith('/') ? relativeUrl.slice(1) : relativeUrl;
return Url.resolve(baseUrl, relative);
}

async request<T>(options: ReqOptions): Promise<AxiosResponse<T>> {
const url = Url.resolve(this.pickUrl(), options.path);
const url = this.resolveUrl(options.path);
const description = options.description || `${options.method} ${url}`;
let attempt = 0;
const maxAttempts = options.retries ?? DEFAULT_MAX_ATTEMPTS;
Expand All @@ -107,6 +113,9 @@ export class KbnClientRequester {
'kbn-xsrf': 'kbn-client',
},
httpsAgent: this.httpsAgent,
responseType: options.responseType,
// work around https://github.com/axios/axios/issues/2791
transformResponse: options.responseType === 'text' ? [(x) => x] : undefined,
paramsSerializer: (params) => Qs.stringify(params),
});

Expand Down