mirror of
https://github.com/Kong/insomnia
synced 2024-11-08 14:49:53 +00:00
208aec6ec8
This adds a new trigger condition for re-sending a request for the `response` plugin called "When Expired". This condition allows specifying a maximum age of a response to use. This is very useful when configuring a hierarchy of environment variables that ultimately depend on an auth token that needs to be refreshed periodically. Previous workarounds are: 1. Use "always refresh". This fails in cases where you must use the same auth token since it is refreshed for every request. 2. Use "no history" or "never" and manually refresh the token. This is inconvenient and requires pinning the token. Alternative solutions are: 1. Add more sophisticated logic to determine when the token needs to be refreshed (e.g. refresh if the current request returns a `401` status code) 2. Write a custom response plugin to time out the token. I believe this functionality is small enough and general enough to be contributed back generally. Fixes #1972
641 lines
18 KiB
JavaScript
641 lines
18 KiB
JavaScript
const tag = require('..').templateTags[0];
|
|
const iconv = require('iconv-lite');
|
|
|
|
describe('Response tag', () => {
|
|
describe('General', () => {
|
|
it('fails on no responses', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const context = _genTestContext(requests);
|
|
|
|
try {
|
|
await tag.run(context, 'body', 'req_1', '$.foo');
|
|
fail('JSON should have failed');
|
|
} catch (err) {
|
|
expect(err.message).toContain('No responses for request');
|
|
}
|
|
});
|
|
|
|
it('fails on no request', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
_body: '{"foo": "bar"}',
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
try {
|
|
await tag.run(context, 'body', 'req_test', '$.foo');
|
|
fail('JSON should have failed');
|
|
} catch (err) {
|
|
expect(err.message).toContain('Could not find request req_test');
|
|
}
|
|
});
|
|
|
|
it('fails on empty filter', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
_body: '{"foo": "bar"}',
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
try {
|
|
await tag.run(context, 'body', 'req_1', '');
|
|
fail('JSON should have failed');
|
|
} catch (err) {
|
|
expect(err.message).toContain('No body filter specified');
|
|
}
|
|
});
|
|
});
|
|
|
|
describe('JSONPath', () => {
|
|
it('basic query', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'application/json',
|
|
_body: '{"foo": "bar"}',
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
const result = await tag.run(context, 'body', 'req_1', '$.foo');
|
|
|
|
expect(result).toBe('bar');
|
|
});
|
|
|
|
it('fails on invalid JSON', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'application/json',
|
|
_body: '{"foo": "',
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
try {
|
|
await tag.run(context, 'body', 'req_1', '$.foo');
|
|
fail('JSON should have failed');
|
|
} catch (err) {
|
|
expect(err.message).toContain('Invalid JSON: Unexpected end of JSON input');
|
|
}
|
|
});
|
|
|
|
it('fails on invalid query', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'application/json',
|
|
_body: '{"foo": "bar"}',
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
try {
|
|
await tag.run(context, 'body', 'req_1', '$$');
|
|
fail('JSON should have failed');
|
|
} catch (err) {
|
|
expect(err.message).toContain('Invalid JSONPath query: $$');
|
|
}
|
|
});
|
|
|
|
it('fails on no results', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'application/json',
|
|
_body: '{"foo": "bar"}',
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
try {
|
|
await tag.run(context, 'body', 'req_1', '$.missing');
|
|
fail('JSON should have failed');
|
|
} catch (err) {
|
|
expect(err.message).toContain('Returned no results: $.missing');
|
|
}
|
|
});
|
|
|
|
it('fails on more than 1 result', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'application/json',
|
|
_body: '{"array": ["bar", "baz"]}',
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
try {
|
|
await tag.run(context, 'body', 'req_1', '$.array.*');
|
|
fail('JSON should have failed to parse');
|
|
} catch (err) {
|
|
expect(err.message).toContain('Returned more than one result: $.array.*');
|
|
}
|
|
});
|
|
|
|
it('works with utf-16 encoding', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'application/json; charset=UTF-16',
|
|
_body: iconv.encode('{"array": ["bar", "baz"]}', 'UTF-16'),
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
expect(await tag.run(context, 'body', 'req_1', '$.array[0]')).toBe('bar');
|
|
});
|
|
});
|
|
|
|
describe('XPath', () => {
|
|
it('renders basic response "body" query', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'application/xml',
|
|
_body: '<foo><bar>Hello World!</bar></foo>',
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
const result = await tag.run(context, 'body', 'req_1', '/foo/bar');
|
|
|
|
expect(result).toBe('Hello World!');
|
|
});
|
|
|
|
it('renders basic response "body" attribute query', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'application/xml',
|
|
_body: '<foo><bar hello="World">Hello World!</bar></foo>',
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
const result = await tag.run(context, 'body', 'req_1', '/foo/bar/@hello');
|
|
|
|
expect(result).toBe('World');
|
|
});
|
|
|
|
it('renders query that does not start with slash', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'application/xml',
|
|
_body: '<foo><bar hello="World">Hello World!</bar></foo>',
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
const result = await tag.run(context, 'body', 'req_1', 'substring(/foo/bar, 7)');
|
|
|
|
expect(result).toBe('World!');
|
|
});
|
|
|
|
it('no results on invalid XML', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'application/xml',
|
|
_body: '<hi></hi></sstr>',
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
try {
|
|
await tag.run(context, 'body', 'req_1', '/foo');
|
|
fail('Should have failed');
|
|
} catch (err) {
|
|
expect(err.message).toContain('Returned no results: /foo');
|
|
}
|
|
});
|
|
|
|
it('fails on invalid query', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'application/xml',
|
|
_body: '<foo></foo>',
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
try {
|
|
await tag.run(context, 'body', 'req_1', '//');
|
|
fail('Should have failed');
|
|
} catch (err) {
|
|
expect(err.message).toContain('Invalid XPath query: //');
|
|
}
|
|
});
|
|
|
|
it('fails on no results', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'application/xml',
|
|
_body: '<foo></foo>',
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
try {
|
|
await tag.run(context, 'body', 'req_1', '/missing');
|
|
fail('Should have failed');
|
|
} catch (err) {
|
|
expect(err.message).toContain('Returned no results: /missing');
|
|
}
|
|
});
|
|
|
|
it('fails on more than 1 result', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'application/xml',
|
|
_body: '<foo><bar>Hello World!</bar><bar>And again!</bar></foo>',
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
try {
|
|
await tag.run(context, 'body', 'req_1', '/foo/*');
|
|
fail('Should have failed');
|
|
} catch (err) {
|
|
expect(err.message).toContain('Returned more than one result: /foo/*');
|
|
}
|
|
});
|
|
});
|
|
|
|
describe('ResponseExtension Header', () => {
|
|
it('renders basic response "header"', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: '',
|
|
headers: [
|
|
{ name: 'Content-Type', value: 'application/json' },
|
|
{ name: 'Content-Length', value: '20' },
|
|
],
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
expect(await tag.run(context, 'header', 'req_1', 'content-type')).toBe('application/json');
|
|
expect(await tag.run(context, 'header', 'req_1', 'Content-Type')).toBe('application/json');
|
|
expect(await tag.run(context, 'header', 'req_1', 'CONTENT-type')).toBe('application/json');
|
|
expect(await tag.run(context, 'header', 'req_1', 'CONTENT-type ')).toBe(
|
|
'application/json',
|
|
);
|
|
});
|
|
|
|
it('no results on missing header', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
headers: [
|
|
{ name: 'Content-Type', value: 'application/json' },
|
|
{ name: 'Content-Length', value: '20' },
|
|
],
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
try {
|
|
await tag.run(context, 'header', 'req_1', 'missing');
|
|
fail('should have failed');
|
|
} catch (err) {
|
|
expect(err.message).toBe(
|
|
'No header with name "missing".\n' +
|
|
'Choices are [\n\t"Content-Type",\n\t"Content-Length"\n]',
|
|
);
|
|
}
|
|
});
|
|
});
|
|
|
|
describe('Raw', () => {
|
|
it('renders basic response', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'text/plain',
|
|
_body: 'Hello World!',
|
|
},
|
|
];
|
|
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
expect(await tag.run(context, 'raw', 'req_1')).toBe('Hello World!');
|
|
});
|
|
});
|
|
|
|
describe('Dependency sending', () => {
|
|
it('sends when behavior=always and no responses', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
const responses = [];
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
expect(await tag.run(context, 'raw', 'req_1', '', 'always')).toBe('Response res_1');
|
|
});
|
|
|
|
it('sends when behavior=always and some responses', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
const responses = [
|
|
{
|
|
_id: 'res_1',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'text/plain',
|
|
_body: 'Hello World!',
|
|
},
|
|
];
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
expect(await tag.run(context, 'raw', 'req_1', '', 'always')).toBe('Response res_2');
|
|
});
|
|
|
|
it('sends when behavior=no-history and no responses', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
const responses = [];
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
expect(await tag.run(context, 'raw', 'req_1', '', 'no-history')).toBe('Response res_1');
|
|
});
|
|
|
|
it('does not send when behavior=no-history and some responses', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
const responses = [
|
|
{
|
|
_id: 'res_existing',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'text/plain',
|
|
_body: 'Response res_existing',
|
|
},
|
|
];
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
expect(await tag.run(context, 'raw', 'req_1', '', 'no-history')).toBe(
|
|
'Response res_existing',
|
|
);
|
|
});
|
|
|
|
it('sends when behavior=when-expired and no responses', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
const responses = [];
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
expect(await tag.run(context, 'raw', 'req_1', '', 'when-expired', 60)).toBe('Response res_1');
|
|
});
|
|
|
|
it('sends when behavior=when-expired and response is old', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
const responses = [
|
|
{
|
|
created: Date.now() - 60000,
|
|
},
|
|
];
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
expect(await tag.run(context, 'raw', 'req_1', '', 'when-expired', 30)).toBe('Response res_2');
|
|
});
|
|
|
|
it('does not send when behavior=when-expired and response is new', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
const responses = [
|
|
{
|
|
_id: 'res_existing',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'text/plain',
|
|
_body: 'Response res_existing',
|
|
created: Date.now() - 60000,
|
|
},
|
|
];
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
expect(await tag.run(context, 'raw', 'req_1', '', 'when-expired', 90)).toBe(
|
|
'Response res_existing',
|
|
);
|
|
});
|
|
|
|
it('does not send when behavior=never and no responses', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
const responses = [];
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
try {
|
|
expect(await tag.run(context, 'raw', 'req_1', '', 'never')).toBe('Response res_1');
|
|
} catch (err) {
|
|
expect(err.message).toBe('No responses for request');
|
|
return;
|
|
}
|
|
|
|
throw new Error('Running tag should have thrown exception');
|
|
});
|
|
|
|
it('does not send when behavior=never and some responses', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
const responses = [
|
|
{
|
|
_id: 'res_existing',
|
|
parentId: 'req_1',
|
|
statusCode: 200,
|
|
contentType: 'text/plain',
|
|
_body: 'Response res_existing',
|
|
},
|
|
];
|
|
const context = _genTestContext(requests, responses);
|
|
|
|
expect(await tag.run(context, 'raw', 'req_1', '', 'never')).toBe('Response res_existing');
|
|
});
|
|
|
|
it('does not resend recursive', async () => {
|
|
const requests = [{ _id: 'req_1', parentId: 'wrk_1' }];
|
|
|
|
const responses = [];
|
|
|
|
const context = _genTestContext(requests, responses, { fromResponseTag: true });
|
|
|
|
try {
|
|
await tag.run(context, 'raw', 'req_1', '', 'always');
|
|
} catch (err) {
|
|
expect(err.message).toBe('No responses for request');
|
|
return;
|
|
}
|
|
|
|
throw new Error('Running tag should have thrown exception');
|
|
});
|
|
});
|
|
});
|
|
|
|
function _genTestContext(requests, responses, extraInfoRoot) {
|
|
let _extraInfo = extraInfoRoot || {};
|
|
requests = requests || [];
|
|
responses = responses || [];
|
|
const bodies = {};
|
|
for (const res of responses) {
|
|
bodies[res._id] = res._body || null;
|
|
delete res._body;
|
|
}
|
|
const store = {};
|
|
return {
|
|
renderPurpose: 'send',
|
|
context: {
|
|
getEnvironmentId() {
|
|
return null;
|
|
},
|
|
getExtraInfo(key) {
|
|
if (_extraInfo) {
|
|
return _extraInfo[key] || null;
|
|
} else {
|
|
return null;
|
|
}
|
|
},
|
|
},
|
|
network: {
|
|
sendRequest(request, extraInfo) {
|
|
_extraInfo = { ..._extraInfo, ...extraInfo };
|
|
const id = `res_${responses.length + 1}`;
|
|
const res = {
|
|
_id: id,
|
|
parentId: request._id,
|
|
statusCode: 200,
|
|
contentType: 'text/plain',
|
|
};
|
|
|
|
bodies[res._id] = `Response ${id}`;
|
|
responses.push(res);
|
|
return res;
|
|
},
|
|
},
|
|
store: {
|
|
hasItem: key => Object.prototype.hasOwnProperty.call(store, key),
|
|
getItem: key => store[key],
|
|
removeItem: key => {
|
|
delete store[key];
|
|
},
|
|
setItem: (key, value) => {
|
|
store[key] = value;
|
|
},
|
|
},
|
|
util: {
|
|
models: {
|
|
request: {
|
|
getById(requestId) {
|
|
return requests.find(r => r._id === requestId) || null;
|
|
},
|
|
},
|
|
response: {
|
|
getLatestForRequestId(requestId, environmentId) {
|
|
return responses.find(r => r.parentId === requestId) || null;
|
|
},
|
|
getBodyBuffer(response) {
|
|
const strOrBuffer = bodies[response._id];
|
|
|
|
if (typeof strOrBuffer === 'string') {
|
|
return Buffer.from(strOrBuffer);
|
|
}
|
|
|
|
if (!strOrBuffer) {
|
|
return null;
|
|
}
|
|
|
|
return strOrBuffer;
|
|
},
|
|
},
|
|
},
|
|
},
|
|
};
|
|
}
|