Skip to content

Commit

Permalink
feat(superset-ui-connection): Allow PUT and PATCH in call API
Browse files Browse the repository at this point in the history
  • Loading branch information
fabiomendescom authored and zhaoyongjie committed Nov 26, 2021
1 parent 9454aed commit 3c53885
Show file tree
Hide file tree
Showing 2 changed files with 156 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,10 @@ export default function callApi({
signal,
};

if (method === 'POST' && typeof postPayload === 'object') {
if (
(method === 'POST' || method === 'PATCH' || method === 'PUT') &&
typeof postPayload === 'object'
) {
// using FormData has the effect that Content-Type header is set to `multipart/form-data`,
// not e.g., 'application/x-www-form-urlencoded'
const formData: FormData = new FormData();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,35 @@ describe('callApi()', () => {

const mockGetUrl = '/mock/get/url';
const mockPostUrl = '/mock/post/url';
const mockPutUrl = '/mock/put/url';
const mockPatchUrl = '/mock/patch/url';

const mockGetPayload = { get: 'payload' };
const mockPostPayload = { post: 'payload' };
const mockPutPayload = { post: 'payload' };
const mockPatchPayload = { post: 'payload' };

fetchMock.get(mockGetUrl, mockGetPayload);
fetchMock.post(mockPostUrl, mockPostPayload);
fetchMock.put(mockPutUrl, mockPutPayload);
fetchMock.patch(mockPatchUrl, mockPatchPayload);

afterEach(fetchMock.reset);

describe('request config', () => {
it('calls the right url with the specified method', () => {
expect.assertions(2);
expect.assertions(4);

return Promise.all([
callApi({ url: mockGetUrl, method: 'GET' }),
callApi({ url: mockPostUrl, method: 'POST' }),
callApi({ url: mockPutUrl, method: 'PUT' }),
callApi({ url: mockPatchUrl, method: 'PATCH' }),
]).then(() => {
expect(fetchMock.calls(mockGetUrl)).toHaveLength(1);
expect(fetchMock.calls(mockPostUrl)).toHaveLength(1);
expect(fetchMock.calls(mockPutUrl)).toHaveLength(1);
expect(fetchMock.calls(mockPatchUrl)).toHaveLength(1);

return Promise.resolve();
});
Expand Down Expand Up @@ -93,7 +103,7 @@ describe('callApi()', () => {
});

// the reason for this is to omit strings like 'undefined' from making their way to the backend
it('omits key,value pairs from postPayload that have undefined values', () => {
it('omits key,value pairs from postPayload that have undefined values (POST)', () => {
expect.assertions(3);
const postPayload = { key: 'value', noValue: undefined };

Expand Down Expand Up @@ -142,6 +152,146 @@ describe('callApi()', () => {
});
});

describe('PUT requests', () => {
it('encodes key,value pairs from postPayload', () => {
expect.assertions(3);
const postPayload = { key: 'value', anotherKey: 1237 } as any;

return callApi({ url: mockPutUrl, method: 'PUT', postPayload }).then(() => {
const calls = fetchMock.calls(mockPutUrl);
expect(calls).toHaveLength(1);

const fetchParams = calls[0][1];
const body = fetchParams.body as FormData;

Object.keys(postPayload).forEach(key => {
expect(body.get(key)).toBe(JSON.stringify(postPayload[key]));
});

return Promise.resolve();
});
});

// the reason for this is to omit strings like 'undefined' from making their way to the backend
it('omits key,value pairs from postPayload that have undefined values (PUT)', () => {
expect.assertions(3);
const postPayload = { key: 'value', noValue: undefined };

return callApi({ url: mockPutUrl, method: 'PUT', postPayload }).then(() => {
const calls = fetchMock.calls(mockPutUrl);
expect(calls).toHaveLength(1);

const fetchParams = calls[0][1];
const body = fetchParams.body as FormData;
expect(body.get('key')).toBe(JSON.stringify(postPayload.key));
expect(body.get('noValue')).toBeNull();

return Promise.resolve();
});
});

it('respects the stringify flag in PUT requests', () => {
const postPayload = {
string: 'value',
number: 1237,
array: [1, 2, 3],
object: { a: 'a', 1: 1 },
null: null,
emptyString: '',
} as any;

expect.assertions(1 + 2 * Object.keys(postPayload).length);

return Promise.all([
callApi({ url: mockPutUrl, method: 'PUT', postPayload }),
callApi({ url: mockPutUrl, method: 'PUT', postPayload, stringify: false }),
]).then(() => {
const calls = fetchMock.calls(mockPutUrl);
expect(calls).toHaveLength(2);

const stringified = calls[0][1].body as FormData;
const unstringified = calls[1][1].body as FormData;

Object.keys(postPayload).forEach(key => {
expect(stringified.get(key)).toBe(JSON.stringify(postPayload[key]));
expect(unstringified.get(key)).toBe(String(postPayload[key]));
});

return Promise.resolve();
});
});
});

describe('PATCH requests', () => {
it('encodes key,value pairs from postPayload', () => {
expect.assertions(3);
const postPayload = { key: 'value', anotherKey: 1237 } as any;

return callApi({ url: mockPatchUrl, method: 'PATCH', postPayload }).then(() => {
const calls = fetchMock.calls(mockPatchUrl);
expect(calls).toHaveLength(1);

const fetchParams = calls[0][1];
const body = fetchParams.body as FormData;

Object.keys(postPayload).forEach(key => {
expect(body.get(key)).toBe(JSON.stringify(postPayload[key]));
});

return Promise.resolve();
});
});

// the reason for this is to omit strings like 'undefined' from making their way to the backend
it('omits key,value pairs from postPayload that have undefined values (PATCH)', () => {
expect.assertions(3);
const postPayload = { key: 'value', noValue: undefined };

return callApi({ url: mockPatchUrl, method: 'PATCH', postPayload }).then(() => {
const calls = fetchMock.calls(mockPatchUrl);
expect(calls).toHaveLength(1);

const fetchParams = calls[0][1];
const body = fetchParams.body as FormData;
expect(body.get('key')).toBe(JSON.stringify(postPayload.key));
expect(body.get('noValue')).toBeNull();

return Promise.resolve();
});
});

it('respects the stringify flag in PATCH requests', () => {
const postPayload = {
string: 'value',
number: 1237,
array: [1, 2, 3],
object: { a: 'a', 1: 1 },
null: null,
emptyString: '',
} as any;

expect.assertions(1 + 2 * Object.keys(postPayload).length);

return Promise.all([
callApi({ url: mockPatchUrl, method: 'PATCH', postPayload }),
callApi({ url: mockPatchUrl, method: 'PATCH', postPayload, stringify: false }),
]).then(() => {
const calls = fetchMock.calls(mockPatchUrl);
expect(calls).toHaveLength(2);

const stringified = calls[0][1].body as FormData;
const unstringified = calls[1][1].body as FormData;

Object.keys(postPayload).forEach(key => {
expect(stringified.get(key)).toBe(JSON.stringify(postPayload[key]));
expect(unstringified.get(key)).toBe(String(postPayload[key]));
});

return Promise.resolve();
});
});
});

it('rejects if the request throws', () => {
const mockErrorUrl = '/mock/error/url';
const mockErrorPayload = { status: 500, statusText: 'Internal error' };
Expand Down

0 comments on commit 3c53885

Please sign in to comment.