Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 | 3x 3x 3x 3x 2x 3x 4x 4x 4x 4x 4x 4x 3x 4x 2x 2x 2x 2x 4x 4x 2x 2x 2x 2x 4x 1x 1x 1x 4x 3x 1x 1x 1x 1x 1x 1x 3x | const { logger } = require('./logger');
const { memo } = require('./global');
/**
* Return a 401 specific example.
*
* @param {Array} errorObjects
* @returns {{type: string, status: number, content: string}}
*/
const parseAuthExample = memo((errorObjects = []) => {
const authExample = errorObjects.filter(val => val.status === 401);
return (authExample && authExample[Math.floor(Math.random() * authExample.length)]) || {};
});
/**
* Set http status
*
* @param {object} params
* @param {Array} params.examples
* @param {string} params.response
* @param {string} params.type
* @param {string} params.path
* @returns {object}
*/
const parseStatus = memo(({ examples, response = null, type = null, path = null } = {}) =>
(examples || []).map(example => {
const status = Number.parseInt(example?.content?.split(/\s/)?.[1], 10) || 200;
const route = type && path ? `mismatch for "${type}" route ${path}` : '';
// ToDo: ApiDoc currently has no "information" or "redirect" distinction, consider plugin
Iif (response === 'success' && status >= 400) {
logger.warn(`example\t:${status} :success :${route}`);
}
Iif (response === 'error' && status < 400) {
logger.warn(`example\t:${status} :error :${route}`);
}
return {
status,
...example
};
})
);
/**
* Return forced response, or a general example.
*
* @param {object} params
* @param {object} params.mockSettings
* @param {Array} params.exampleObjects
* @param {Array} params.successObjects
* @param {Array} params.errorObjects
* @returns {{type: string, status: number, content: string}}
*/
const exampleResponse = ({ mockSettings = {}, exampleObjects, successObjects, errorObjects } = {}) => {
let example;
let tempObjects;
switch (mockSettings.response) {
case 'response':
tempObjects = exampleObjects;
break;
case 'error':
tempObjects = errorObjects;
break;
case 'success':
default:
tempObjects = successObjects;
break;
}
if (/\d/.test(mockSettings.forceStatus)) {
example = exampleObjects.filter(val => val.status === mockSettings.forceStatus);
if (example.length) {
example = example[Math.floor(Math.random() * example.length)];
} else E{
example = {
type: 'text',
status: mockSettings.forceStatus,
content: `Missing example for ${mockSettings.forceStatus} status`
};
}
} else Eif (tempObjects) {
example = tempObjects[Math.floor(Math.random() * tempObjects.length)];
}
if (!example) {
switch (mockSettings.response) {
case 'error':
example = {
type: 'text',
status: 404,
content: 'Error'
};
break;
case 'response':
case 'success':
default:
example = {
type: 'text',
status: 200,
content: 'Success'
};
break;
}
}
return example;
};
/**
* Aggregate ApiDoc example responses
*
* @param {object} params
* @param {object} params.mockSettings
* @param {Array} params.successExamples
* @param {Array} params.errorExamples
* @param {string} params.type
* @param {string} params.url
* @returns {{authExample: {type: string, status: number, content: string},
* example: {type: string, status: number, content: string}}}
*/
const exampleApiDocResponse = ({ mockSettings, successExamples, errorExamples, type, url } = {}) => {
const successObjects = parseStatus({ examples: successExamples, response: 'success', type, url });
const errorObjects = parseStatus({ examples: errorExamples, response: 'error', type, url });
const exampleObjects = successObjects.concat(errorObjects);
const authExample = parseAuthExample(errorObjects);
const example = exampleResponse({ mockSettings, exampleObjects, successObjects, errorObjects });
return {
authExample,
example
};
};
module.exports = {
exampleApiDocResponse,
exampleResponse,
parseAuthExample,
parseStatus
};
|