LukeParke/arbiter
1
0
Fork 0
mirror of https://github.com/LukeHagar/arbiter.git synced 2025-12-06 04:19:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

cleaning and formatting

Browse Source
This commit is contained in:
Luke Hagar
2025-04-01 11:06:03 -05:00
parent 6de97e7b88
commit 234791eacf
26 changed files with 390 additions and 4910 deletions
Download Patch File Download Diff File Expand all files Collapse all files

224
coverage/base.css
View File

@@ -1,224 +0,0 @@
body, html {
margin:0; padding: 0;
height: 100%;
}
body {
font-family: Helvetica Neue, Helvetica, Arial;
font-size: 14px;
color:#333;
}
.small { font-size: 12px; }
*, *:after, *:before {
-webkit-box-sizing:border-box;
-moz-box-sizing:border-box;
box-sizing:border-box;
}
h1 { font-size: 20px; margin: 0;}
h2 { font-size: 14px; }
pre {
font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
margin: 0;
padding: 0;
-moz-tab-size: 2;
-o-tab-size: 2;
tab-size: 2;
}
a { color:#0074D9; text-decoration:none; }
a:hover { text-decoration:underline; }
.strong { font-weight: bold; }
.space-top1 { padding: 10px 0 0 0; }
.pad2y { padding: 20px 0; }
.pad1y { padding: 10px 0; }
.pad2x { padding: 0 20px; }
.pad2 { padding: 20px; }
.pad1 { padding: 10px; }
.space-left2 { padding-left:55px; }
.space-right2 { padding-right:20px; }
.center { text-align:center; }
.clearfix { display:block; }
.clearfix:after {
content:'';
display:block;
height:0;
clear:both;
visibility:hidden;
}
.fl { float: left; }
@media only screen and (max-width:640px) {
.col3 { width:100%; max-width:100%; }
.hide-mobile { display:none!important; }
}
.quiet {
color: #7f7f7f;
color: rgba(0,0,0,0.5);
}
.quiet a { opacity: 0.7; }
.fraction {
font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
font-size: 10px;
color: #555;
background: #E8E8E8;
padding: 4px 5px;
border-radius: 3px;
vertical-align: middle;
}
div.path a:link, div.path a:visited { color: #333; }
table.coverage {
border-collapse: collapse;
margin: 10px 0 0 0;
padding: 0;
}
table.coverage td {
margin: 0;
padding: 0;
vertical-align: top;
}
table.coverage td.line-count {
text-align: right;
padding: 0 5px 0 20px;
}
table.coverage td.line-coverage {
text-align: right;
padding-right: 10px;
min-width:20px;
}
table.coverage td span.cline-any {
display: inline-block;
padding: 0 5px;
width: 100%;
}
.missing-if-branch {
display: inline-block;
margin-right: 5px;
border-radius: 3px;
position: relative;
padding: 0 4px;
background: #333;
color: yellow;
}
.skip-if-branch {
display: none;
margin-right: 10px;
position: relative;
padding: 0 4px;
background: #ccc;
color: white;
}
.missing-if-branch .typ, .skip-if-branch .typ {
color: inherit !important;
}
.coverage-summary {
border-collapse: collapse;
width: 100%;
}
.coverage-summary tr { border-bottom: 1px solid #bbb; }
.keyline-all { border: 1px solid #ddd; }
.coverage-summary td, .coverage-summary th { padding: 10px; }
.coverage-summary tbody { border: 1px solid #bbb; }
.coverage-summary td { border-right: 1px solid #bbb; }
.coverage-summary td:last-child { border-right: none; }
.coverage-summary th {
text-align: left;
font-weight: normal;
white-space: nowrap;
}
.coverage-summary th.file { border-right: none !important; }
.coverage-summary th.pct { }
.coverage-summary th.pic,
.coverage-summary th.abs,
.coverage-summary td.pct,
.coverage-summary td.abs { text-align: right; }
.coverage-summary td.file { white-space: nowrap; }
.coverage-summary td.pic { min-width: 120px !important; }
.coverage-summary tfoot td { }
.coverage-summary .sorter {
height: 10px;
width: 7px;
display: inline-block;
margin-left: 0.5em;
background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
}
.coverage-summary .sorted .sorter {
background-position: 0 -20px;
}
.coverage-summary .sorted-desc .sorter {
background-position: 0 -10px;
}
.status-line { height: 10px; }
/* yellow */
.cbranch-no { background: yellow !important; color: #111; }
/* dark red */
.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
.low .chart { border:1px solid #C21F39 }
.highlighted,
.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
background: #C21F39 !important;
}
/* medium red */
.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
/* light red */
.low, .cline-no { background:#FCE1E5 }
/* light green */
.high, .cline-yes { background:rgb(230,245,208) }
/* medium green */
.cstat-yes { background:rgb(161,215,106) }
/* dark green */
.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
.high .chart { border:1px solid rgb(77,146,33) }
/* dark yellow (gold) */
.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
.medium .chart { border:1px solid #f9cd0b; }
/* light yellow */
.medium { background: #fff4c2; }
.cstat-skip { background: #ddd; color: #111; }
.fstat-skip { background: #ddd; color: #111 !important; }
.cbranch-skip { background: #ddd !important; color: #111; }
span.cline-neutral { background: #eaeaea; }
.coverage-summary td.empty {
opacity: .5;
padding-top: 4px;
padding-bottom: 4px;
line-height: 1;
color: #888;
}
.cover-fill, .cover-empty {
display:inline-block;
height: 12px;
}
.chart {
line-height: 0;
}
.cover-empty {
background: white;
}
.cover-full {
border-right: none !important;
}
pre.prettyprint {
border: none !important;
padding: 0 !important;
margin: 0 !important;
}
.com { color: #999 !important; }
.ignore-none { color: #999; font-weight: normal; }
.wrapper {
min-height: 100%;
height: auto !important;
height: 100%;
margin: 0 auto -48px;
}
.footer, .push {
height: 48px;
}

87
coverage/block-navigation.js
View File

@@ -1,87 +0,0 @@
/* eslint-disable */
var jumpToCode = (function init() {
// Classes of code we would like to highlight in the file view
var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
// Elements to highlight in the file listing view
var fileListingElements = ['td.pct.low'];
// We don't want to select elements that are direct descendants of another match
var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
// Selecter that finds elements on the page to which we can jump
var selector =
fileListingElements.join(', ') +
', ' +
notSelector +
missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
// The NodeList of matching elements
var missingCoverageElements = document.querySelectorAll(selector);
var currentIndex;
function toggleClass(index) {
missingCoverageElements
.item(currentIndex)
.classList.remove('highlighted');
missingCoverageElements.item(index).classList.add('highlighted');
}
function makeCurrent(index) {
toggleClass(index);
currentIndex = index;
missingCoverageElements.item(index).scrollIntoView({
behavior: 'smooth',
block: 'center',
inline: 'center'
});
}
function goToPrevious() {
var nextIndex = 0;
if (typeof currentIndex !== 'number' || currentIndex === 0) {
nextIndex = missingCoverageElements.length - 1;
} else if (missingCoverageElements.length > 1) {
nextIndex = currentIndex - 1;
}
makeCurrent(nextIndex);
}
function goToNext() {
var nextIndex = 0;
if (
typeof currentIndex === 'number' &&
currentIndex < missingCoverageElements.length - 1
) {
nextIndex = currentIndex + 1;
}
makeCurrent(nextIndex);
}
return function jump(event) {
if (
document.getElementById('fileSearch') === document.activeElement &&
document.activeElement != null
) {
// if we're currently focused on the search input, we don't want to navigate
return;
}
switch (event.which) {
case 78: // n
case 74: // j
goToNext();
break;
case 66: // b
case 75: // k
case 80: // p
goToPrevious();
break;
}
};
})();
window.addEventListener('keydown', jumpToCode);

6
coverage/coverage-final.json
View File

File diff suppressed because one or more lines are too long

BIN
coverage/favicon.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 445 B

146
coverage/index.html
View File

@@ -1,146 +0,0 @@
<!doctype html>
<html lang="en">
<head>
<title>Code coverage report for All files</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="prettify.css" />
<link rel="stylesheet" href="base.css" />
<link rel="shortcut icon" type="image/x-icon" href="favicon.png" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1>All files</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">52.16% </span>
<span class="quiet">Statements</span>
<span class='fraction'>374/717</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">71.42% </span>
<span class="quiet">Branches</span>
<span class='fraction'>60/84</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">94.44% </span>
<span class="quiet">Functions</span>
<span class='fraction'>17/18</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">52.16% </span>
<span class="quiet">Lines</span>
<span class='fraction'>374/717</span>
</div>
</div>
<p class="quiet">
Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
</p>
<template id="filterTemplate">
<div class="quiet">
Filter:
<input type="search" id="fileSearch">
</div>
</template>
</div>
<div class='status-line medium'></div>
<div class="pad1">
<table class="coverage-summary">
<thead>
<tr>
<th data-col="file" data-fmt="html" data-html="true" class="file">File</th>
<th data-col="pic" data-type="number" data-fmt="html" data-html="true" class="pic"></th>
<th data-col="statements" data-type="number" data-fmt="pct" class="pct">Statements</th>
<th data-col="statements_raw" data-type="number" data-fmt="html" class="abs"></th>
<th data-col="branches" data-type="number" data-fmt="pct" class="pct">Branches</th>
<th data-col="branches_raw" data-type="number" data-fmt="html" class="abs"></th>
<th data-col="functions" data-type="number" data-fmt="pct" class="pct">Functions</th>
<th data-col="functions_raw" data-type="number" data-fmt="html" class="abs"></th>
<th data-col="lines" data-type="number" data-fmt="pct" class="pct">Lines</th>
<th data-col="lines_raw" data-type="number" data-fmt="html" class="abs"></th>
</tr>
</thead>
<tbody><tr>
<td class="file low" data-value="src"><a href="src/index.html">src</a></td>
<td data-value="0" class="pic low">
<div class="chart"><div class="cover-fill" style="width: 0%"></div><div class="cover-empty" style="width: 100%"></div></div>
</td>
<td data-value="0" class="pct low">0%</td>
<td data-value="264" class="abs low">0/264</td>
<td data-value="100" class="pct high">100%</td>
<td data-value="2" class="abs high">2/2</td>
<td data-value="100" class="pct high">100%</td>
<td data-value="2" class="abs high">2/2</td>
<td data-value="0" class="pct low">0%</td>
<td data-value="264" class="abs low">0/264</td>
</tr>
<tr>
<td class="file medium" data-value="src/middleware"><a href="src/middleware/index.html">src/middleware</a></td>
<td data-value="60.6" class="pic medium">
<div class="chart"><div class="cover-fill" style="width: 60%"></div><div class="cover-empty" style="width: 40%"></div></div>
</td>
<td data-value="60.6" class="pct medium">60.6%</td>
<td data-value="66" class="abs medium">40/66</td>
<td data-value="44.44" class="pct low">44.44%</td>
<td data-value="9" class="abs low">4/9</td>
<td data-value="100" class="pct high">100%</td>
<td data-value="2" class="abs high">2/2</td>
<td data-value="60.6" class="pct medium">60.6%</td>
<td data-value="66" class="abs medium">40/66</td>
</tr>
<tr>
<td class="file high" data-value="src/store"><a href="src/store/index.html">src/store</a></td>
<td data-value="86.3" class="pic high">
<div class="chart"><div class="cover-fill" style="width: 86%"></div><div class="cover-empty" style="width: 14%"></div></div>
</td>
<td data-value="86.3" class="pct high">86.3%</td>
<td data-value="387" class="abs high">334/387</td>
<td data-value="73.97" class="pct medium">73.97%</td>
<td data-value="73" class="abs medium">54/73</td>
<td data-value="92.85" class="pct high">92.85%</td>
<td data-value="14" class="abs high">13/14</td>
<td data-value="86.3" class="pct high">86.3%</td>
<td data-value="387" class="abs high">334/387</td>
</tr>
</tbody>
</table>
</div>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2025-03-19T22:40:14.575Z
</div>
<script src="prettify.js"></script>
<script>
window.onload = function () {
prettyPrint();
};
</script>
<script src="sorter.js"></script>
<script src="block-navigation.js"></script>
</body>
</html>

1
coverage/prettify.css
View File

@@ -1 +0,0 @@
.pln{color:#000}@media screen{.str{color:#080}.kwd{color:#008}.com{color:#800}.typ{color:#606}.lit{color:#066}.pun,.opn,.clo{color:#660}.tag{color:#008}.atn{color:#606}.atv{color:#080}.dec,.var{color:#606}.fun{color:red}}@media print,projection{.str{color:#060}.kwd{color:#006;font-weight:bold}.com{color:#600;font-style:italic}.typ{color:#404;font-weight:bold}.lit{color:#044}.pun,.opn,.clo{color:#440}.tag{color:#006;font-weight:bold}.atn{color:#404}.atv{color:#060}}pre.prettyprint{padding:2px;border:1px solid #888}ol.linenums{margin-top:0;margin-bottom:0}li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8{list-style-type:none}li.L1,li.L3,li.L5,li.L7,li.L9{background:#eee}

2
coverage/prettify.js
View File

File diff suppressed because one or more lines are too long

BIN
coverage/sort-arrow-sprite.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 138 B

196
coverage/sorter.js
View File

@@ -1,196 +0,0 @@
/* eslint-disable */
var addSorting = (function() {
'use strict';
var cols,
currentSort = {
index: 0,
desc: false
};
// returns the summary table element
function getTable() {
return document.querySelector('.coverage-summary');
}
// returns the thead element of the summary table
function getTableHeader() {
return getTable().querySelector('thead tr');
}
// returns the tbody element of the summary table
function getTableBody() {
return getTable().querySelector('tbody');
}
// returns the th element for nth column
function getNthColumn(n) {
return getTableHeader().querySelectorAll('th')[n];
}
function onFilterInput() {
const searchValue = document.getElementById('fileSearch').value;
const rows = document.getElementsByTagName('tbody')[0].children;
for (let i = 0; i < rows.length; i++) {
const row = rows[i];
if (
row.textContent
.toLowerCase()
.includes(searchValue.toLowerCase())
) {
row.style.display = '';
} else {
row.style.display = 'none';
}
}
}
// loads the search box
function addSearchBox() {
var template = document.getElementById('filterTemplate');
var templateClone = template.content.cloneNode(true);
templateClone.getElementById('fileSearch').oninput = onFilterInput;
template.parentElement.appendChild(templateClone);
}
// loads all columns
function loadColumns() {
var colNodes = getTableHeader().querySelectorAll('th'),
colNode,
cols = [],
col,
i;
for (i = 0; i < colNodes.length; i += 1) {
colNode = colNodes[i];
col = {
key: colNode.getAttribute('data-col'),
sortable: !colNode.getAttribute('data-nosort'),
type: colNode.getAttribute('data-type') || 'string'
};
cols.push(col);
if (col.sortable) {
col.defaultDescSort = col.type === 'number';
colNode.innerHTML =
colNode.innerHTML + '<span class="sorter"></span>';
}
}
return cols;
}
// attaches a data attribute to every tr element with an object
// of data values keyed by column name
function loadRowData(tableRow) {
var tableCols = tableRow.querySelectorAll('td'),
colNode,
col,
data = {},
i,
val;
for (i = 0; i < tableCols.length; i += 1) {
colNode = tableCols[i];
col = cols[i];
val = colNode.getAttribute('data-value');
if (col.type === 'number') {
val = Number(val);
}
data[col.key] = val;
}
return data;
}
// loads all row data
function loadData() {
var rows = getTableBody().querySelectorAll('tr'),
i;
for (i = 0; i < rows.length; i += 1) {
rows[i].data = loadRowData(rows[i]);
}
}
// sorts the table using the data for the ith column
function sortByIndex(index, desc) {
var key = cols[index].key,
sorter = function(a, b) {
a = a.data[key];
b = b.data[key];
return a < b ? -1 : a > b ? 1 : 0;
},
finalSorter = sorter,
tableBody = document.querySelector('.coverage-summary tbody'),
rowNodes = tableBody.querySelectorAll('tr'),
rows = [],
i;
if (desc) {
finalSorter = function(a, b) {
return -1 * sorter(a, b);
};
}
for (i = 0; i < rowNodes.length; i += 1) {
rows.push(rowNodes[i]);
tableBody.removeChild(rowNodes[i]);
}
rows.sort(finalSorter);
for (i = 0; i < rows.length; i += 1) {
tableBody.appendChild(rows[i]);
}
}
// removes sort indicators for current column being sorted
function removeSortIndicators() {
var col = getNthColumn(currentSort.index),
cls = col.className;
cls = cls.replace(/ sorted$/, '').replace(/ sorted-desc$/, '');
col.className = cls;
}
// adds sort indicators for current column being sorted
function addSortIndicators() {
getNthColumn(currentSort.index).className += currentSort.desc
? ' sorted-desc'
: ' sorted';
}
// adds event listeners for all sorter widgets
function enableUI() {
var i,
el,
ithSorter = function ithSorter(i) {
var col = cols[i];
return function() {
var desc = col.defaultDescSort;
if (currentSort.index === i) {
desc = !currentSort.desc;
}
sortByIndex(i, desc);
removeSortIndicators();
currentSort.index = i;
currentSort.desc = desc;
addSortIndicators();
};
};
for (i = 0; i < cols.length; i += 1) {
if (cols[i].sortable) {
// add the click event handler on the th so users
// dont have to click on those tiny arrows
el = getNthColumn(i).querySelector('.sorter').parentElement;
if (el.addEventListener) {
el.addEventListener('click', ithSorter(i));
} else {
el.attachEvent('onclick', ithSorter(i));
}
}
}
}
// adds sorting functionality to the UI
return function() {
if (!getTable()) {
return;
}
cols = loadColumns();
loadData();
addSearchBox();
addSortIndicators();
enableUI();
};
})();
window.addEventListener('load', addSorting);

190
coverage/src/cli.ts.html
View File

@@ -1,190 +0,0 @@
<!doctype html>
<html lang="en">
<head>
<title>Code coverage report for src/cli.ts</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="../prettify.css" />
<link rel="stylesheet" href="../base.css" />
<link rel="shortcut icon" type="image/x-icon" href="../favicon.png" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(../sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1><a href="../index.html">All files</a> / <a href="index.html">src</a> cli.ts</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">0% </span>
<span class="quiet">Statements</span>
<span class='fraction'>0/28</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Branches</span>
<span class='fraction'>1/1</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Functions</span>
<span class='fraction'>1/1</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">0% </span>
<span class="quiet">Lines</span>
<span class='fraction'>0/28</span>
</div>
</div>
<p class="quiet">
Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
</p>
<template id="filterTemplate">
<div class="quiet">
Filter:
<input type="search" id="fileSearch">
</div>
</template>
</div>
<div class='status-line low'></div>
<pre><table class="coverage">
<tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
<a name='L2'></a><a href='#L2'>2</a>
<a name='L3'></a><a href='#L3'>3</a>
<a name='L4'></a><a href='#L4'>4</a>
<a name='L5'></a><a href='#L5'>5</a>
<a name='L6'></a><a href='#L6'>6</a>
<a name='L7'></a><a href='#L7'>7</a>
<a name='L8'></a><a href='#L8'>8</a>
<a name='L9'></a><a href='#L9'>9</a>
<a name='L10'></a><a href='#L10'>10</a>
<a name='L11'></a><a href='#L11'>11</a>
<a name='L12'></a><a href='#L12'>12</a>
<a name='L13'></a><a href='#L13'>13</a>
<a name='L14'></a><a href='#L14'>14</a>
<a name='L15'></a><a href='#L15'>15</a>
<a name='L16'></a><a href='#L16'>16</a>
<a name='L17'></a><a href='#L17'>17</a>
<a name='L18'></a><a href='#L18'>18</a>
<a name='L19'></a><a href='#L19'>19</a>
<a name='L20'></a><a href='#L20'>20</a>
<a name='L21'></a><a href='#L21'>21</a>
<a name='L22'></a><a href='#L22'>22</a>
<a name='L23'></a><a href='#L23'>23</a>
<a name='L24'></a><a href='#L24'>24</a>
<a name='L25'></a><a href='#L25'>25</a>
<a name='L26'></a><a href='#L26'>26</a>
<a name='L27'></a><a href='#L27'>27</a>
<a name='L28'></a><a href='#L28'>28</a>
<a name='L29'></a><a href='#L29'>29</a>
<a name='L30'></a><a href='#L30'>30</a>
<a name='L31'></a><a href='#L31'>31</a>
<a name='L32'></a><a href='#L32'>32</a>
<a name='L33'></a><a href='#L33'>33</a>
<a name='L34'></a><a href='#L34'>34</a>
<a name='L35'></a><a href='#L35'>35</a>
<a name='L36'></a><a href='#L36'>36</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">#!/usr/bin/env node
&nbsp;
<span class="cstat-no" title="statement not covered" >import { Command } from 'commander';</span>
<span class="cstat-no" title="statement not covered" >import chalk from 'chalk';</span>
<span class="cstat-no" title="statement not covered" >import { startServers } from './server.js';</span>
&nbsp;
<span class="cstat-no" title="statement not covered" >const program = new Command();</span>
&nbsp;
<span class="cstat-no" title="statement not covered" >console.log('Starting Arbiter...');</span>
&nbsp;
<span class="cstat-no" title="statement not covered" >program</span>
<span class="cstat-no" title="statement not covered" > .name('arbiter')</span>
<span class="cstat-no" title="statement not covered" > .description('API proxy with OpenAPI generation and HAR export capabilities')</span>
<span class="cstat-no" title="statement not covered" > .version('1.0.0')</span>
<span class="cstat-no" title="statement not covered" > .requiredOption('-t, --target &lt;url&gt;', 'target API URL to proxy to')</span>
<span class="cstat-no" title="statement not covered" > .option('-p, --port &lt;number&gt;', 'port to run the proxy server on', '8080')</span>
<span class="cstat-no" title="statement not covered" > .option('-d, --docs-port &lt;number&gt;', 'port to run the documentation server on', '9000')</span>
<span class="cstat-no" title="statement not covered" > .option('-k, --key &lt;string&gt;', 'API key to add to proxied requests')</span>
<span class="cstat-no" title="statement not covered" > .option('--docs-only', 'run only the documentation server')</span>
<span class="cstat-no" title="statement not covered" > .option('--proxy-only', 'run only the proxy server')</span>
<span class="cstat-no" title="statement not covered" > .option('-v, --verbose', 'enable verbose logging')</span>
<span class="cstat-no" title="statement not covered" > .parse(process.argv);</span>
&nbsp;
<span class="cstat-no" title="statement not covered" >const options = program.opts();</span>
&nbsp;
// Start the servers
<span class="cstat-no" title="statement not covered" >startServers({</span>
<span class="cstat-no" title="statement not covered" > target: options.target,</span>
<span class="cstat-no" title="statement not covered" > proxyPort: parseInt(options.port),</span>
<span class="cstat-no" title="statement not covered" > docsPort: parseInt(options.docsPort),</span>
<span class="cstat-no" title="statement not covered" > apiKey: options.key,</span>
<span class="cstat-no" title="statement not covered" > verbose: options.verbose</span>
<span class="cstat-no" title="statement not covered" >}).catch((error) =&gt; {</span>
<span class="cstat-no" title="statement not covered" > console.error(chalk.red('Failed to start servers:'), error);</span>
<span class="cstat-no" title="statement not covered" > process.exit(1);</span>
<span class="cstat-no" title="statement not covered" >});</span></pre></td></tr></table></pre>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2025-03-19T22:40:14.575Z
</div>
<script src="../prettify.js"></script>
<script>
window.onload = function () {
prettyPrint();
};
</script>
<script src="../sorter.js"></script>
<script src="../block-navigation.js"></script>
</body>
</html>

131
coverage/src/index.html
View File

@@ -1,131 +0,0 @@
<!doctype html>
<html lang="en">
<head>
<title>Code coverage report for src</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="../prettify.css" />
<link rel="stylesheet" href="../base.css" />
<link rel="shortcut icon" type="image/x-icon" href="../favicon.png" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(../sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1><a href="../index.html">All files</a> src</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">0% </span>
<span class="quiet">Statements</span>
<span class='fraction'>0/264</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Branches</span>
<span class='fraction'>2/2</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Functions</span>
<span class='fraction'>2/2</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">0% </span>
<span class="quiet">Lines</span>
<span class='fraction'>0/264</span>
</div>
</div>
<p class="quiet">
Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
</p>
<template id="filterTemplate">
<div class="quiet">
Filter:
<input type="search" id="fileSearch">
</div>
</template>
</div>
<div class='status-line low'></div>
<div class="pad1">
<table class="coverage-summary">
<thead>
<tr>
<th data-col="file" data-fmt="html" data-html="true" class="file">File</th>
<th data-col="pic" data-type="number" data-fmt="html" data-html="true" class="pic"></th>
<th data-col="statements" data-type="number" data-fmt="pct" class="pct">Statements</th>
<th data-col="statements_raw" data-type="number" data-fmt="html" class="abs"></th>
<th data-col="branches" data-type="number" data-fmt="pct" class="pct">Branches</th>
<th data-col="branches_raw" data-type="number" data-fmt="html" class="abs"></th>
<th data-col="functions" data-type="number" data-fmt="pct" class="pct">Functions</th>
<th data-col="functions_raw" data-type="number" data-fmt="html" class="abs"></th>
<th data-col="lines" data-type="number" data-fmt="pct" class="pct">Lines</th>
<th data-col="lines_raw" data-type="number" data-fmt="html" class="abs"></th>
</tr>
</thead>
<tbody><tr>
<td class="file low" data-value="cli.ts"><a href="cli.ts.html">cli.ts</a></td>
<td data-value="0" class="pic low">
<div class="chart"><div class="cover-fill" style="width: 0%"></div><div class="cover-empty" style="width: 100%"></div></div>
</td>
<td data-value="0" class="pct low">0%</td>
<td data-value="28" class="abs low">0/28</td>
<td data-value="100" class="pct high">100%</td>
<td data-value="1" class="abs high">1/1</td>
<td data-value="100" class="pct high">100%</td>
<td data-value="1" class="abs high">1/1</td>
<td data-value="0" class="pct low">0%</td>
<td data-value="28" class="abs low">0/28</td>
</tr>
<tr>
<td class="file low" data-value="server.ts"><a href="server.ts.html">server.ts</a></td>
<td data-value="0" class="pic low">
<div class="chart"><div class="cover-fill" style="width: 0%"></div><div class="cover-empty" style="width: 100%"></div></div>
</td>
<td data-value="0" class="pct low">0%</td>
<td data-value="236" class="abs low">0/236</td>
<td data-value="100" class="pct high">100%</td>
<td data-value="1" class="abs high">1/1</td>
<td data-value="100" class="pct high">100%</td>
<td data-value="1" class="abs high">1/1</td>
<td data-value="0" class="pct low">0%</td>
<td data-value="236" class="abs low">0/236</td>
</tr>
</tbody>
</table>
</div>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2025-03-19T22:40:14.575Z
</div>
<script src="../prettify.js"></script>
<script>
window.onload = function () {
prettyPrint();
};
</script>
<script src="../sorter.js"></script>
<script src="../block-navigation.js"></script>
</body>
</html>

148
coverage/src/middleware/apiDocGenerator.ts.html
View File

@@ -1,148 +0,0 @@
<!doctype html>
<html lang="en">
<head>
<title>Code coverage report for src/middleware/apiDocGenerator.ts</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="../../prettify.css" />
<link rel="stylesheet" href="../../base.css" />
<link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(../../sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1><a href="../../index.html">All files</a> / <a href="index.html">src/middleware</a> apiDocGenerator.ts</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">0% </span>
<span class="quiet">Statements</span>
<span class='fraction'>0/18</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Branches</span>
<span class='fraction'>1/1</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Functions</span>
<span class='fraction'>1/1</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">0% </span>
<span class="quiet">Lines</span>
<span class='fraction'>0/18</span>
</div>
</div>
<p class="quiet">
Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
</p>
<template id="filterTemplate">
<div class="quiet">
Filter:
<input type="search" id="fileSearch">
</div>
</template>
</div>
<div class='status-line low'></div>
<pre><table class="coverage">
<tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
<a name='L2'></a><a href='#L2'>2</a>
<a name='L3'></a><a href='#L3'>3</a>
<a name='L4'></a><a href='#L4'>4</a>
<a name='L5'></a><a href='#L5'>5</a>
<a name='L6'></a><a href='#L6'>6</a>
<a name='L7'></a><a href='#L7'>7</a>
<a name='L8'></a><a href='#L8'>8</a>
<a name='L9'></a><a href='#L9'>9</a>
<a name='L10'></a><a href='#L10'>10</a>
<a name='L11'></a><a href='#L11'>11</a>
<a name='L12'></a><a href='#L12'>12</a>
<a name='L13'></a><a href='#L13'>13</a>
<a name='L14'></a><a href='#L14'>14</a>
<a name='L15'></a><a href='#L15'>15</a>
<a name='L16'></a><a href='#L16'>16</a>
<a name='L17'></a><a href='#L17'>17</a>
<a name='L18'></a><a href='#L18'>18</a>
<a name='L19'></a><a href='#L19'>19</a>
<a name='L20'></a><a href='#L20'>20</a>
<a name='L21'></a><a href='#L21'>21</a>
<a name='L22'></a><a href='#L22'>22</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import { Context } from 'hono';
<span class="cstat-no" title="statement not covered" >import { openApiStore } from '../store/openApiStore.js';</span>
&nbsp;
<span class="cstat-no" title="statement not covered" >export const apiDocGenerator = async (c: Context, next: () =&gt; Promise&lt;void&gt;) =&gt; {</span>
<span class="cstat-no" title="statement not covered" > await next();</span>
&nbsp;
// Record the API call in OpenAPI format
<span class="cstat-no" title="statement not covered" > openApiStore.recordEndpoint(</span>
<span class="cstat-no" title="statement not covered" > c.req.path,</span>
<span class="cstat-no" title="statement not covered" > c.req.method.toLowerCase(),</span>
<span class="cstat-no" title="statement not covered" > {</span>
<span class="cstat-no" title="statement not covered" > query: Object.fromEntries(new URL(c.req.url).searchParams),</span>
<span class="cstat-no" title="statement not covered" > body: await c.req.json().catch(() =&gt; null),</span>
<span class="cstat-no" title="statement not covered" > contentType: c.req.header('content-type') || 'application/json',</span>
<span class="cstat-no" title="statement not covered" > },</span>
<span class="cstat-no" title="statement not covered" > {</span>
<span class="cstat-no" title="statement not covered" > status: c.res.status,</span>
<span class="cstat-no" title="statement not covered" > body: await c.res.clone().json().catch(() =&gt; null),</span>
<span class="cstat-no" title="statement not covered" > contentType: c.res.headers.get('content-type') || 'application/json',</span>
<span class="cstat-no" title="statement not covered" > }</span>
<span class="cstat-no" title="statement not covered" > );</span>
<span class="cstat-no" title="statement not covered" >}; </span></pre></td></tr></table></pre>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2025-03-19T22:40:14.575Z
</div>
<script src="../../prettify.js"></script>
<script>
window.onload = function () {
prettyPrint();
};
</script>
<script src="../../sorter.js"></script>
<script src="../../block-navigation.js"></script>
</body>
</html>

364
coverage/src/middleware/harRecorder.ts.html
View File

@@ -1,364 +0,0 @@
<!doctype html>
<html lang="en">
<head>
<title>Code coverage report for src/middleware/harRecorder.ts</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="../../prettify.css" />
<link rel="stylesheet" href="../../base.css" />
<link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(../../sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1><a href="../../index.html">All files</a> / <a href="index.html">src/middleware</a> harRecorder.ts</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">83.33% </span>
<span class="quiet">Statements</span>
<span class='fraction'>40/48</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">37.5% </span>
<span class="quiet">Branches</span>
<span class='fraction'>3/8</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Functions</span>
<span class='fraction'>1/1</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">83.33% </span>
<span class="quiet">Lines</span>
<span class='fraction'>40/48</span>
</div>
</div>
<p class="quiet">
Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
</p>
<template id="filterTemplate">
<div class="quiet">
Filter:
<input type="search" id="fileSearch">
</div>
</template>
</div>
<div class='status-line high'></div>
<pre><table class="coverage">
<tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
<a name='L2'></a><a href='#L2'>2</a>
<a name='L3'></a><a href='#L3'>3</a>
<a name='L4'></a><a href='#L4'>4</a>
<a name='L5'></a><a href='#L5'>5</a>
<a name='L6'></a><a href='#L6'>6</a>
<a name='L7'></a><a href='#L7'>7</a>
<a name='L8'></a><a href='#L8'>8</a>
<a name='L9'></a><a href='#L9'>9</a>
<a name='L10'></a><a href='#L10'>10</a>
<a name='L11'></a><a href='#L11'>11</a>
<a name='L12'></a><a href='#L12'>12</a>
<a name='L13'></a><a href='#L13'>13</a>
<a name='L14'></a><a href='#L14'>14</a>
<a name='L15'></a><a href='#L15'>15</a>
<a name='L16'></a><a href='#L16'>16</a>
<a name='L17'></a><a href='#L17'>17</a>
<a name='L18'></a><a href='#L18'>18</a>
<a name='L19'></a><a href='#L19'>19</a>
<a name='L20'></a><a href='#L20'>20</a>
<a name='L21'></a><a href='#L21'>21</a>
<a name='L22'></a><a href='#L22'>22</a>
<a name='L23'></a><a href='#L23'>23</a>
<a name='L24'></a><a href='#L24'>24</a>
<a name='L25'></a><a href='#L25'>25</a>
<a name='L26'></a><a href='#L26'>26</a>
<a name='L27'></a><a href='#L27'>27</a>
<a name='L28'></a><a href='#L28'>28</a>
<a name='L29'></a><a href='#L29'>29</a>
<a name='L30'></a><a href='#L30'>30</a>
<a name='L31'></a><a href='#L31'>31</a>
<a name='L32'></a><a href='#L32'>32</a>
<a name='L33'></a><a href='#L33'>33</a>
<a name='L34'></a><a href='#L34'>34</a>
<a name='L35'></a><a href='#L35'>35</a>
<a name='L36'></a><a href='#L36'>36</a>
<a name='L37'></a><a href='#L37'>37</a>
<a name='L38'></a><a href='#L38'>38</a>
<a name='L39'></a><a href='#L39'>39</a>
<a name='L40'></a><a href='#L40'>40</a>
<a name='L41'></a><a href='#L41'>41</a>
<a name='L42'></a><a href='#L42'>42</a>
<a name='L43'></a><a href='#L43'>43</a>
<a name='L44'></a><a href='#L44'>44</a>
<a name='L45'></a><a href='#L45'>45</a>
<a name='L46'></a><a href='#L46'>46</a>
<a name='L47'></a><a href='#L47'>47</a>
<a name='L48'></a><a href='#L48'>48</a>
<a name='L49'></a><a href='#L49'>49</a>
<a name='L50'></a><a href='#L50'>50</a>
<a name='L51'></a><a href='#L51'>51</a>
<a name='L52'></a><a href='#L52'>52</a>
<a name='L53'></a><a href='#L53'>53</a>
<a name='L54'></a><a href='#L54'>54</a>
<a name='L55'></a><a href='#L55'>55</a>
<a name='L56'></a><a href='#L56'>56</a>
<a name='L57'></a><a href='#L57'>57</a>
<a name='L58'></a><a href='#L58'>58</a>
<a name='L59'></a><a href='#L59'>59</a>
<a name='L60'></a><a href='#L60'>60</a>
<a name='L61'></a><a href='#L61'>61</a>
<a name='L62'></a><a href='#L62'>62</a>
<a name='L63'></a><a href='#L63'>63</a>
<a name='L64'></a><a href='#L64'>64</a>
<a name='L65'></a><a href='#L65'>65</a>
<a name='L66'></a><a href='#L66'>66</a>
<a name='L67'></a><a href='#L67'>67</a>
<a name='L68'></a><a href='#L68'>68</a>
<a name='L69'></a><a href='#L69'>69</a>
<a name='L70'></a><a href='#L70'>70</a>
<a name='L71'></a><a href='#L71'>71</a>
<a name='L72'></a><a href='#L72'>72</a>
<a name='L73'></a><a href='#L73'>73</a>
<a name='L74'></a><a href='#L74'>74</a>
<a name='L75'></a><a href='#L75'>75</a>
<a name='L76'></a><a href='#L76'>76</a>
<a name='L77'></a><a href='#L77'>77</a>
<a name='L78'></a><a href='#L78'>78</a>
<a name='L79'></a><a href='#L79'>79</a>
<a name='L80'></a><a href='#L80'>80</a>
<a name='L81'></a><a href='#L81'>81</a>
<a name='L82'></a><a href='#L82'>82</a>
<a name='L83'></a><a href='#L83'>83</a>
<a name='L84'></a><a href='#L84'>84</a>
<a name='L85'></a><a href='#L85'>85</a>
<a name='L86'></a><a href='#L86'>86</a>
<a name='L87'></a><a href='#L87'>87</a>
<a name='L88'></a><a href='#L88'>88</a>
<a name='L89'></a><a href='#L89'>89</a>
<a name='L90'></a><a href='#L90'>90</a>
<a name='L91'></a><a href='#L91'>91</a>
<a name='L92'></a><a href='#L92'>92</a>
<a name='L93'></a><a href='#L93'>93</a>
<a name='L94'></a><a href='#L94'>94</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-no">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-neutral">&nbsp;</span>
<span class="cline-any cline-yes">4x</span>
<span class="cline-any cline-yes">4x</span></td><td class="text"><pre class="prettyprint lang-js">import { Context, Next } from 'hono';
import { openApiStore } from '../store/openApiStore.js';
&nbsp;
interface HAREntry {
startedDateTime: string;
time: number;
request: {
method: string;
url: string;
httpVersion: string;
headers: Array&lt;{ name: string; value: string }&gt;;
queryString: Array&lt;{ name: string; value: string }&gt;;
postData?: {
mimeType: string;
text: string;
};
};
response: {
status: number;
statusText: string;
httpVersion: string;
headers: Array&lt;{ name: string; value: string }&gt;;
content: {
size: number;
mimeType: string;
text: string;
};
};
}
&nbsp;
export async function harRecorder(c: Context, next: Next) {
const startTime = Date.now();
&nbsp;
// Get request body if present
let requestBody: any;
if (c.req.method !== <span class="branch-0 cbranch-no" title="branch not covered" >'GET' &amp;&amp; c.req.method !== 'HEAD') <span class="branch-0 cbranch-no" title="branch not covered" >{</span></span>
<span class="cstat-no" title="statement not covered" > try {</span>
<span class="cstat-no" title="statement not covered" > requestBody = await c.req.json();</span>
<span class="cstat-no" title="statement not covered" > } catch (e) {</span>
// Body might not be JSON
<span class="cstat-no" title="statement not covered" > requestBody = await c.req.text();</span>
<span class="cstat-no" title="statement not covered" > }</span>
<span class="cstat-no" title="statement not covered" > }</span>
&nbsp;
// Get query parameters from URL
const url = new URL(c.req.url);
const queryParams: Record&lt;string, string&gt; = {};
for (const [key, value] of url.searchParams.entries()) {
queryParams[key] = value;
}
&nbsp;
// Get all request headers
const requestHeaders: Record&lt;string, string&gt; = {};
Object.entries(c.req.header()).forEach(([key, value]) =&gt; {
if (typeof value === 'string') {
requestHeaders[key] = value;
}
});
&nbsp;
// Call next middleware
await next();
&nbsp;
// Calculate response time
const responseTime = Date.now() - startTime;
&nbsp;
// Get response body
let responseBody: any;
try {
responseBody = await c.res.clone().json();
<span class="branch-0 cbranch-no" title="branch not covered" > } catch (e) {</span>
<span class="cstat-no" title="statement not covered" > responseBody = await c.res.clone().text();</span>
<span class="cstat-no" title="statement not covered" > }</span>
&nbsp;
// Record the request/response in OpenAPI format
openApiStore.recordEndpoint(
c.req.path,
c.req.method.toLowerCase(),
{
query: queryParams,
body: requestBody,
contentType: c.req.header('content-type'<span class="branch-0 cbranch-no" title="branch not covered" >) || 'application/json',</span>
headers: requestHeaders
},
{
status: c.res.status,
body: responseBody,
contentType: c.res.headers.get('content-type'<span class="branch-0 cbranch-no" title="branch not covered" >) || 'application/json',</span>
headers: Object.fromEntries(c.res.headers.entries())
}
);
&nbsp;
// Set HAR data in context
c.set('har', openApiStore.generateHAR());
} </pre></td></tr></table></pre>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2025-03-19T22:40:14.575Z
</div>
<script src="../../prettify.js"></script>
<script>
window.onload = function () {
prettyPrint();
};
</script>
<script src="../../sorter.js"></script>
<script src="../../block-navigation.js"></script>
</body>
</html>

131
coverage/src/middleware/index.html
View File

@@ -1,131 +0,0 @@
<!doctype html>
<html lang="en">
<head>
<title>Code coverage report for src/middleware</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="../../prettify.css" />
<link rel="stylesheet" href="../../base.css" />
<link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(../../sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1><a href="../../index.html">All files</a> src/middleware</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">60.6% </span>
<span class="quiet">Statements</span>
<span class='fraction'>40/66</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">44.44% </span>
<span class="quiet">Branches</span>
<span class='fraction'>4/9</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">100% </span>
<span class="quiet">Functions</span>
<span class='fraction'>2/2</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">60.6% </span>
<span class="quiet">Lines</span>
<span class='fraction'>40/66</span>
</div>
</div>
<p class="quiet">
Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
</p>
<template id="filterTemplate">
<div class="quiet">
Filter:
<input type="search" id="fileSearch">
</div>
</template>
</div>
<div class='status-line medium'></div>
<div class="pad1">
<table class="coverage-summary">
<thead>
<tr>
<th data-col="file" data-fmt="html" data-html="true" class="file">File</th>
<th data-col="pic" data-type="number" data-fmt="html" data-html="true" class="pic"></th>
<th data-col="statements" data-type="number" data-fmt="pct" class="pct">Statements</th>
<th data-col="statements_raw" data-type="number" data-fmt="html" class="abs"></th>
<th data-col="branches" data-type="number" data-fmt="pct" class="pct">Branches</th>
<th data-col="branches_raw" data-type="number" data-fmt="html" class="abs"></th>
<th data-col="functions" data-type="number" data-fmt="pct" class="pct">Functions</th>
<th data-col="functions_raw" data-type="number" data-fmt="html" class="abs"></th>
<th data-col="lines" data-type="number" data-fmt="pct" class="pct">Lines</th>
<th data-col="lines_raw" data-type="number" data-fmt="html" class="abs"></th>
</tr>
</thead>
<tbody><tr>
<td class="file low" data-value="apiDocGenerator.ts"><a href="apiDocGenerator.ts.html">apiDocGenerator.ts</a></td>
<td data-value="0" class="pic low">
<div class="chart"><div class="cover-fill" style="width: 0%"></div><div class="cover-empty" style="width: 100%"></div></div>
</td>
<td data-value="0" class="pct low">0%</td>
<td data-value="18" class="abs low">0/18</td>
<td data-value="100" class="pct high">100%</td>
<td data-value="1" class="abs high">1/1</td>
<td data-value="100" class="pct high">100%</td>
<td data-value="1" class="abs high">1/1</td>
<td data-value="0" class="pct low">0%</td>
<td data-value="18" class="abs low">0/18</td>
</tr>
<tr>
<td class="file high" data-value="harRecorder.ts"><a href="harRecorder.ts.html">harRecorder.ts</a></td>
<td data-value="83.33" class="pic high">
<div class="chart"><div class="cover-fill" style="width: 83%"></div><div class="cover-empty" style="width: 17%"></div></div>
</td>
<td data-value="83.33" class="pct high">83.33%</td>
<td data-value="48" class="abs high">40/48</td>
<td data-value="37.5" class="pct low">37.5%</td>
<td data-value="8" class="abs low">3/8</td>
<td data-value="100" class="pct high">100%</td>
<td data-value="1" class="abs high">1/1</td>
<td data-value="83.33" class="pct high">83.33%</td>
<td data-value="48" class="abs high">40/48</td>
</tr>
</tbody>
</table>
</div>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2025-03-19T22:40:14.575Z
</div>
<script src="../../prettify.js"></script>
<script>
window.onload = function () {
prettyPrint();
};
</script>
<script src="../../sorter.js"></script>
<script src="../../block-navigation.js"></script>
</body>
</html>

1066
coverage/src/server.ts.html
View File

File diff suppressed because it is too large Load Diff

116
coverage/src/store/index.html
View File

@@ -1,116 +0,0 @@
<!doctype html>
<html lang="en">
<head>
<title>Code coverage report for src/store</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="../../prettify.css" />
<link rel="stylesheet" href="../../base.css" />
<link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(../../sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1><a href="../../index.html">All files</a> src/store</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">86.3% </span>
<span class="quiet">Statements</span>
<span class='fraction'>334/387</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">73.97% </span>
<span class="quiet">Branches</span>
<span class='fraction'>54/73</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">92.85% </span>
<span class="quiet">Functions</span>
<span class='fraction'>13/14</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">86.3% </span>
<span class="quiet">Lines</span>
<span class='fraction'>334/387</span>
</div>
</div>
<p class="quiet">
Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
</p>
<template id="filterTemplate">
<div class="quiet">
Filter:
<input type="search" id="fileSearch">
</div>
</template>
</div>
<div class='status-line high'></div>
<div class="pad1">
<table class="coverage-summary">
<thead>
<tr>
<th data-col="file" data-fmt="html" data-html="true" class="file">File</th>
<th data-col="pic" data-type="number" data-fmt="html" data-html="true" class="pic"></th>
<th data-col="statements" data-type="number" data-fmt="pct" class="pct">Statements</th>
<th data-col="statements_raw" data-type="number" data-fmt="html" class="abs"></th>
<th data-col="branches" data-type="number" data-fmt="pct" class="pct">Branches</th>
<th data-col="branches_raw" data-type="number" data-fmt="html" class="abs"></th>
<th data-col="functions" data-type="number" data-fmt="pct" class="pct">Functions</th>
<th data-col="functions_raw" data-type="number" data-fmt="html" class="abs"></th>
<th data-col="lines" data-type="number" data-fmt="pct" class="pct">Lines</th>
<th data-col="lines_raw" data-type="number" data-fmt="html" class="abs"></th>
</tr>
</thead>
<tbody><tr>
<td class="file high" data-value="openApiStore.ts"><a href="openApiStore.ts.html">openApiStore.ts</a></td>
<td data-value="86.3" class="pic high">
<div class="chart"><div class="cover-fill" style="width: 86%"></div><div class="cover-empty" style="width: 14%"></div></div>
</td>
<td data-value="86.3" class="pct high">86.3%</td>
<td data-value="387" class="abs high">334/387</td>
<td data-value="73.97" class="pct medium">73.97%</td>
<td data-value="73" class="abs medium">54/73</td>
<td data-value="92.85" class="pct high">92.85%</td>
<td data-value="14" class="abs high">13/14</td>
<td data-value="86.3" class="pct high">86.3%</td>
<td data-value="387" class="abs high">334/387</td>
</tr>
</tbody>
</table>
</div>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2025-03-19T22:40:14.575Z
</div>
<script src="../../prettify.js"></script>
<script>
window.onload = function () {
prettyPrint();
};
</script>
<script src="../../sorter.js"></script>
<script src="../../block-navigation.js"></script>
</body>
</html>

1789
coverage/src/store/openApiStore.ts.html
View File

File diff suppressed because it is too large Load Diff

10
integration/__tests__/proxy.test.ts
View File

@@ -82,10 +82,10 @@ describe('Arbiter Integration Tests', () => {
targetApi.get('/users/search', (c) => {
const limit = c.req.query('limit');
const sort = c.req.query('sort');
return c.json({
return c.json({
results: [{ id: 1, name: 'John Doe' }],
limit: limit ? parseInt(limit) : 10,
sort: sort || 'asc'
sort: sort || 'asc',
});
});
@@ -101,9 +101,9 @@ describe('Arbiter Integration Tests', () => {
target: `http://localhost:${targetPort}`,
proxyPort: proxyPort,
docsPort: docsPort,
verbose: false
verbose: false,
});
proxyServer = proxy;
docsServer = docs;
});
@@ -180,7 +180,7 @@ describe('Arbiter Integration Tests', () => {
const requestBody = spec.paths?.['/users']?.post?.requestBody as OpenAPIV3_1.RequestBodyObject;
expect(requestBody.content?.['application/json']).toBeDefined();
expect(requestBody.content?.['application/json'].schema).toBeDefined();
// Validate schema properties based on what we sent in the POST request
const schema = requestBody.content?.['application/json'].schema as OpenAPIV3_1.SchemaObject;
expect(schema).toBeDefined();

61
integration/__tests__/server.test.ts
View File

@@ -17,26 +17,26 @@ import bodyParser from 'body-parser';
describe('Server Integration Tests', () => {
const TARGET_PORT = 3000;
const PROXY_PORT = 3005; // Changed to avoid conflicts with other tests
const DOCS_PORT = 3006; // Changed to avoid conflicts with other tests
const PROXY_PORT = 3005; // Changed to avoid conflicts with other tests
const DOCS_PORT = 3006; // Changed to avoid conflicts with other tests
const TARGET_URL = `http://localhost:${TARGET_PORT}`;
const PROXY_URL = `http://localhost:${PROXY_PORT}`;
const DOCS_URL = `http://localhost:${DOCS_PORT}`;
let targetServer: any;
let proxyServer: Server;
let docsServer: Server;
beforeAll(async () => {
// Create a mock target API server
const targetApp = new Hono();
// Basic GET endpoint
targetApp.get('/api/test', (c) => {
return c.json({ message: 'Test successful' });
});
// POST endpoint for users
targetApp.post('/api/users', async (c) => {
try {
@@ -48,84 +48,85 @@ describe('Server Integration Tests', () => {
return c.json({ error: 'Invalid JSON', message: (e as Error).message });
}
});
// Start the target server
targetServer = serve({ port: TARGET_PORT, fetch: targetApp.fetch });
// Clear the OpenAPI store
openApiStore.clear();
// Start the real proxy and docs servers
const servers = await startServers({
target: TARGET_URL,
proxyPort: PROXY_PORT,
docsPort: DOCS_PORT,
verbose: false
verbose: false,
});
proxyServer = servers.proxyServer;
docsServer = servers.docsServer;
});
afterAll(async () => {
// Shutdown servers
targetServer?.close();
proxyServer?.close();
docsServer?.close();
});
it('should respond to GET requests and record them', async () => {
const response = await fetch(`${PROXY_URL}/api/test`);
expect(response.status).toBe(200);
const body = await response.json();
expect(body).toEqual({ message: 'Test successful' });
// Verify that the endpoint was recorded in OpenAPI spec
const specResponse = await fetch(`${DOCS_URL}/openapi.json`);
const spec = await specResponse.json() as OpenAPIV3_1.Document;
const spec = (await specResponse.json()) as OpenAPIV3_1.Document;
expect(spec.paths?.['/api/test']?.get).toBeDefined();
// Verify that the endpoint was recorded in HAR format
const harResponse = await fetch(`${DOCS_URL}/har`);
const har = await harResponse.json() as { log: { entries: any[] } };
const har = (await harResponse.json()) as { log: { entries: any[] } };
expect(har.log.entries.length).toBeGreaterThan(0);
expect(har.log.entries).toContainEqual(
expect.objectContaining({
request: expect.objectContaining({
method: 'GET',
url: expect.stringContaining('/api/test')
})
url: expect.stringContaining('/api/test'),
}),
})
);
});
it('should handle POST requests with JSON bodies', async () => {
const payload = { name: 'Test User', email: 'test@example.com' };
const response = await fetch(`${PROXY_URL}/api/users`, {
method: 'POST',
headers: {
'Content-Type': 'application/json'
'Content-Type': 'application/json',
},
body: JSON.stringify(payload)
body: JSON.stringify(payload),
});
expect(response.status).toBe(201);
const body = await response.json();
expect(body).toEqual({ id: 1, name: 'Test User', email: 'test@example.com' });
// Verify that the endpoint and request body were recorded
const specResponse = await fetch(`${DOCS_URL}/openapi.json`);
const spec = await specResponse.json() as OpenAPIV3_1.Document;
const spec = (await specResponse.json()) as OpenAPIV3_1.Document;
expect(spec.paths?.['/api/users']?.post?.requestBody).toBeDefined();
// Check that the request schema was generated
if (spec.paths?.['/api/users']?.post?.requestBody) {
const requestBody = spec.paths['/api/users'].post.requestBody as OpenAPIV3_1.RequestBodyObject;
const requestBody = spec.paths['/api/users'].post
.requestBody as OpenAPIV3_1.RequestBodyObject;
if (requestBody.content) {
expect(requestBody.content['application/json']).toBeDefined();
expect(requestBody.content['application/json'].schema).toBeDefined();
}
}
});
});
});

2
node_modules/.vite/results.json generated vendored
View File

@@ -1 +1 @@
{"version":"3.0.9","results":[[":src/store/__tests__/openApiStore.test.ts",{"duration":18.337797000000023,"failed":false}],[":src/middleware/__tests__/harRecorder.test.ts",{"duration":17.202578000000017,"failed":false}],[":integration/__tests__/proxy.test.ts",{"duration":71.735096,"failed":false}],[":integration/__tests__/server.test.ts",{"duration":47.88281499999994,"failed":false}],[":src/__tests__/cli.test.ts",{"duration":4.6258020000000215,"failed":false}]]}
{"version":"3.0.9","results":[[":src/store/__tests__/openApiStore.test.ts",{"duration":17.177212999999995,"failed":false}],[":src/middleware/__tests__/harRecorder.test.ts",{"duration":16.706658000000004,"failed":false}],[":integration/__tests__/proxy.test.ts",{"duration":72.56247300000007,"failed":false}],[":integration/__tests__/server.test.ts",{"duration":47.499804999999924,"failed":false}],[":src/__tests__/cli.test.ts",{"duration":4.407485999999949,"failed":false}]]}

1
package.json
View File

@@ -13,7 +13,6 @@
"dev": "ts-node-dev --respawn --transpile-only src/cli.ts",
"cli": "ts-node-dev --respawn --transpile-only src/cli.ts",
"test": "vitest run",
"test:coverage": "vitest run --coverage",
"test:unit": "vitest src/**/__tests__/*.test.ts",
"test:integration": "vitest integration/__tests__/*.test.ts",
"test:ci": "vitest run",

78
src/middleware/__tests__/harRecorder.test.ts
View File

@@ -58,7 +58,7 @@ describe('HAR Recorder Middleware', () => {
it('should handle POST requests with JSON body', async () => {
const requestBody = { name: 'Test User', email: 'test@example.com' };
const jsonBody = JSON.stringify(requestBody);
const store = new Map<string, any>();
const ctx = {
req: {
@@ -99,12 +99,12 @@ describe('HAR Recorder Middleware', () => {
expect(har.log.entries).toHaveLength(1);
expect(har.log.entries[0].request.method).toBe('POST');
expect(har.log.entries[0].request.url).toBe('http://localhost:8080/users');
// Check request body was properly captured
const entry = openApiStore.getOpenAPISpec().paths?.['/users']?.post;
expect(entry).toBeDefined();
expect(entry?.requestBody).toBeDefined();
// Check response body and status
expect(har.log.entries[0].response.status).toBe(201);
expect(har.log.entries[0].response.content.text).toEqual(expect.stringContaining('Test User'));
@@ -113,7 +113,7 @@ describe('HAR Recorder Middleware', () => {
it('should handle PUT requests with JSON body', async () => {
const requestBody = { name: 'Updated User', email: 'updated@example.com' };
const jsonBody = JSON.stringify(requestBody);
const store = new Map<string, any>();
const ctx = {
req: {
@@ -153,7 +153,7 @@ describe('HAR Recorder Middleware', () => {
const har = openApiStore.generateHAR();
expect(har.log.entries).toHaveLength(1);
expect(har.log.entries[0].request.method).toBe('PUT');
// Check request body was properly captured
const entry = openApiStore.getOpenAPISpec().paths?.['/users/{id}']?.put;
expect(entry).toBeDefined();
@@ -163,7 +163,7 @@ describe('HAR Recorder Middleware', () => {
it('should handle PATCH requests with JSON body', async () => {
const requestBody = { name: 'Partially Updated User' };
const jsonBody = JSON.stringify(requestBody);
const store = new Map<string, any>();
const ctx = {
req: {
@@ -188,12 +188,15 @@ describe('HAR Recorder Middleware', () => {
} as unknown as Context;
const next = async () => {
ctx.res = new Response(JSON.stringify({ id: 1, name: 'Partially Updated User', email: 'existing@example.com' }), {
status: 200,
headers: new Headers({
'content-type': 'application/json',
}),
});
ctx.res = new Response(
JSON.stringify({ id: 1, name: 'Partially Updated User', email: 'existing@example.com' }),
{
status: 200,
headers: new Headers({
'content-type': 'application/json',
}),
}
);
};
// Get the middleware function and call it
@@ -203,7 +206,7 @@ describe('HAR Recorder Middleware', () => {
const har = openApiStore.generateHAR();
expect(har.log.entries).toHaveLength(1);
expect(har.log.entries[0].request.method).toBe('PATCH');
// Check request body was properly captured
const entry = openApiStore.getOpenAPISpec().paths?.['/users/{id}']?.patch;
expect(entry).toBeDefined();
@@ -213,9 +216,9 @@ describe('HAR Recorder Middleware', () => {
it('should handle form data in requests', async () => {
const formData = new Map([
['username', 'testuser'],
['email', 'test@example.com']
['email', 'test@example.com'],
]);
const store = new Map<string, any>();
const ctx = {
req: {
@@ -254,7 +257,7 @@ describe('HAR Recorder Middleware', () => {
const har = openApiStore.generateHAR();
expect(har.log.entries).toHaveLength(1);
// Check form data was captured
const entry = openApiStore.getOpenAPISpec().paths?.['/form']?.post;
expect(entry).toBeDefined();
@@ -263,7 +266,7 @@ describe('HAR Recorder Middleware', () => {
it('should handle text content in requests', async () => {
const textContent = 'This is a plain text content';
const store = new Map<string, any>();
const ctx = {
req: {
@@ -302,7 +305,7 @@ describe('HAR Recorder Middleware', () => {
const har = openApiStore.generateHAR();
expect(har.log.entries).toHaveLength(1);
// Check text content was captured
const entry = openApiStore.getOpenAPISpec().paths?.['/text']?.post;
expect(entry).toBeDefined();
@@ -351,20 +354,20 @@ describe('HAR Recorder Middleware', () => {
{ name: 'foo', value: 'bar' },
{ name: 'baz', value: 'qux' },
]);
// Check query parameters in OpenAPI spec
const parameters = openApiStore.getOpenAPISpec().paths?.['/test']?.get?.parameters;
expect(parameters).toBeDefined();
expect(parameters).toContainEqual(
expect.objectContaining({
name: 'foo',
in: 'query'
in: 'query',
})
);
expect(parameters).toContainEqual(
expect.objectContaining({
name: 'baz',
in: 'query'
in: 'query',
})
);
});
@@ -374,7 +377,7 @@ describe('HAR Recorder Middleware', () => {
const customHeaders: Record<string, string> = {
'content-type': 'application/json',
'x-custom-header': 'test-value',
'authorization': 'Bearer test-token',
authorization: 'Bearer test-token',
};
const ctx = {
@@ -415,19 +418,19 @@ describe('HAR Recorder Middleware', () => {
'get',
{
query: {},
headers: {
'authorization': 'Bearer test-token',
'x-custom-header': 'test-value'
headers: {
authorization: 'Bearer test-token',
'x-custom-header': 'test-value',
},
contentType: 'application/json',
body: null,
security: [{ type: 'http', scheme: 'bearer' }]
security: [{ type: 'http', scheme: 'bearer' }],
},
{
status: 200,
headers: {},
contentType: 'application/json',
body: { success: true }
body: { success: true },
}
);
@@ -440,17 +443,17 @@ describe('HAR Recorder Middleware', () => {
name: 'x-custom-header',
value: 'test-value',
});
// Check headers in OpenAPI spec
const parameters = openApiStore.getOpenAPISpec().paths?.['/test']?.get?.parameters;
expect(parameters).toBeDefined();
expect(parameters).toContainEqual(
expect.objectContaining({
name: 'x-custom-header',
in: 'header'
in: 'header',
})
);
// Check security schemes for auth header
const spec = openApiStore.getOpenAPISpec();
expect(spec.components?.securitySchemes?.http_).toBeDefined();
@@ -500,11 +503,12 @@ describe('HAR Recorder Middleware', () => {
name: 'x-custom-response',
value: 'test-value',
});
// Check response headers in OpenAPI spec
const responseObj = openApiStore.getOpenAPISpec().paths?.['/test']?.get?.responses?.[200] as OpenAPIV3_1.ResponseObject;
const responseObj = openApiStore.getOpenAPISpec().paths?.['/test']?.get
?.responses?.[200] as OpenAPIV3_1.ResponseObject;
expect(responseObj).toBeDefined();
// Cast to ResponseObject to access headers property
if (responseObj && 'headers' in responseObj && responseObj.headers) {
expect(Object.keys(responseObj.headers).length).toBeGreaterThan(0);
@@ -550,7 +554,7 @@ describe('HAR Recorder Middleware', () => {
const har = openApiStore.generateHAR();
expect(har.log.entries[0].response.status).toBe(500);
// Check error response in OpenAPI spec
const errorResponse = openApiStore.getOpenAPISpec().paths?.['/error']?.get?.responses?.[500];
expect(errorResponse).toBeDefined();
@@ -564,7 +568,9 @@ describe('HAR Recorder Middleware', () => {
url: 'http://localhost:8080/test',
path: '/test',
query: {},
header: () => { throw new Error('Test error'); }, // Deliberately throw an error
header: () => {
throw new Error('Test error');
}, // Deliberately throw an error
raw: {
clone: () => ({
text: async () => '',
@@ -589,7 +595,7 @@ describe('HAR Recorder Middleware', () => {
// Get the middleware function and call it
const middleware = harRecorder(openApiStore);
// Should not throw
await expect(middleware(ctx, next)).resolves.not.toThrow();
});

15
src/middleware/harRecorder.ts
View File

@@ -11,10 +11,10 @@ export function harRecorder(store: OpenAPIStore): (c: Context, next: Next) => Pr
try {
// Clone the request body based on content type
const contentType = c.req.header('content-type') || '';
// Create a copy of the request to avoid consuming the body
const reqClone = c.req.raw.clone();
if (typeof contentType === 'string' && contentType.includes('application/json')) {
const text = await reqClone.text();
try {
@@ -22,7 +22,10 @@ export function harRecorder(store: OpenAPIStore): (c: Context, next: Next) => Pr
} catch (e) {
requestBody = text; // Keep as text if JSON parsing fails
}
} else if (typeof contentType === 'string' && contentType.includes('application/x-www-form-urlencoded')) {
} else if (
typeof contentType === 'string' &&
contentType.includes('application/x-www-form-urlencoded')
) {
const formData = await reqClone.formData();
requestBody = Object.fromEntries(formData);
} else if (typeof contentType === 'string' && contentType.includes('text/')) {
@@ -81,7 +84,7 @@ export function harRecorder(store: OpenAPIStore): (c: Context, next: Next) => Pr
// Clone the response to avoid consuming the body
const resClone = c.res.clone();
const contentType = c.res.headers.get('content-type') || '';
if (typeof contentType === 'string' && contentType.includes('application/json')) {
const text = await resClone.text();
try {
@@ -96,7 +99,7 @@ export function harRecorder(store: OpenAPIStore): (c: Context, next: Next) => Pr
} catch (e) {
console.error('Error getting response body:', e);
}
// Record the endpoint
store.recordEndpoint(
c.req.path,
@@ -111,7 +114,7 @@ export function harRecorder(store: OpenAPIStore): (c: Context, next: Next) => Pr
status: c.res?.status || 500,
headers: responseHeaders,
contentType: c.res?.headers.get('content-type') || 'application/json',
body: responseBody // Now using captured response body
body: responseBody, // Now using captured response body
}
);
} catch (error) {

138
src/server.ts
View File

@@ -51,14 +51,14 @@ class HARStore {
return this.har;
}
public addEntry(entry: typeof this.har.log.entries[0]) {
public addEntry(entry: (typeof this.har.log.entries)[0]) {
this.har.log.entries.push(entry);
}
public clear() {
this.har.log.entries = [];
}
// Process any entries with raw response buffers
private processRawBuffers() {
for (const entry of this.har.log.entries) {
@@ -66,17 +66,18 @@ class HARStore {
try {
const buffer = entry._rawResponseBuffer;
const contentType = entry.response.content.mimeType;
// Process buffer based on content-encoding header
const contentEncoding = entry.response.headers.find(h =>
h.name.toLowerCase() === 'content-encoding')?.value;
const contentEncoding = entry.response.headers.find(
(h) => h.name.toLowerCase() === 'content-encoding'
)?.value;
if (contentEncoding) {
if (contentEncoding.toLowerCase() === 'gzip') {
try {
const decompressed = zlib.gunzipSync(buffer);
const text = decompressed.toString('utf-8');
if (contentType.includes('json')) {
try {
entry.response.content.text = text;
@@ -95,7 +96,7 @@ class HARStore {
} else {
// For non-compressed responses
const text = buffer.toString('utf-8');
if (contentType.includes('json')) {
try {
const json = JSON.parse(text);
@@ -110,7 +111,7 @@ class HARStore {
} catch (e) {
entry.response.content.text = '[Error processing response content]';
}
// Remove the raw buffer to free memory
delete entry._rawResponseBuffer;
}
@@ -184,7 +185,7 @@ export async function startServers({
res.end(JSON.stringify({ error: 'Proxy error', message: err.message }));
}
});
// Handle proxy response
proxyServer.on('proxyReq', (proxyReq, req, res) => {
// Store the request body for later use
@@ -193,7 +194,7 @@ export async function startServers({
requestBodies.set(requestId, req.body);
// Set a custom header to identify the request
proxyReq.setHeader('x-request-id', requestId);
// If the body has been consumed by the body-parser, we need to restream it to the proxy
if (req.body) {
const bodyData = JSON.stringify(req.body);
@@ -211,35 +212,35 @@ export async function startServers({
proxyServer.on('proxyRes', (proxyRes, req, res) => {
const startTime = Date.now();
const chunks: Buffer[] = [];
// Collect response chunks
proxyRes.on('data', (chunk: Buffer) => {
chunks.push(Buffer.from(chunk));
});
// When the response is complete
proxyRes.on('end', () => {
const endTime = Date.now();
const responseTime = endTime - startTime;
// Combine response chunks
const buffer = Buffer.concat(chunks);
// Set status code
res.statusCode = proxyRes.statusCode || 200;
res.statusMessage = proxyRes.statusMessage || '';
// Copy ALL headers exactly as they are
Object.keys(proxyRes.headers).forEach(key => {
Object.keys(proxyRes.headers).forEach((key) => {
const headerValue = proxyRes.headers[key];
if (headerValue) {
res.setHeader(key, headerValue);
}
});
// Send the buffer as the response body without modifying it
res.end(buffer);
// Process HAR and OpenAPI data in the background (next event loop tick)
// to avoid delaying the response to the client
setImmediate(() => {
@@ -247,12 +248,12 @@ export async function startServers({
const method = req.method || 'GET';
const originalUrl = new URL(`http://${req.headers.host}${req.url}`);
const path = originalUrl.pathname;
// Skip web asset requests - don't process JS, CSS, HTML, etc. but keep images and icons
if (
path.endsWith('.js') ||
path.endsWith('.css') ||
path.endsWith('.html') ||
path.endsWith('.js') ||
path.endsWith('.css') ||
path.endsWith('.html') ||
path.endsWith('.htm') ||
path.endsWith('.woff') ||
path.endsWith('.woff2') ||
@@ -265,7 +266,7 @@ export async function startServers({
}
return;
}
// Skip if contentType is related to web assets, but keep images
const contentType = proxyRes.headers['content-type'] || '';
if (
@@ -279,14 +280,14 @@ export async function startServers({
}
return;
}
// Extract query parameters
const queryParams: Record<string, string> = {};
const urlSearchParams = new URLSearchParams(originalUrl.search);
urlSearchParams.forEach((value, key) => {
queryParams[key] = value;
});
// Extract request headers
const requestHeaders: Record<string, string> = {};
for (const [key, value] of Object.entries(req.headers)) {
@@ -296,7 +297,7 @@ export async function startServers({
requestHeaders[key] = value[0];
}
}
// Extract response headers
const responseHeaders: Record<string, string> = {};
for (const [key, value] of Object.entries(proxyRes.headers)) {
@@ -306,7 +307,7 @@ export async function startServers({
responseHeaders[key] = value[0];
}
}
// Get request body from our map if available
let requestBody = undefined;
if (['POST', 'PUT', 'PATCH'].includes(method)) {
@@ -320,10 +321,10 @@ export async function startServers({
requestBody = req.body;
}
}
// Store minimal data for HAR entry - delay expensive processing
const requestUrl = `${target}${path}${originalUrl.search}`;
// Create lighter HAR entry with minimal processing
const harEntry = {
startedDateTime: new Date(startTime).toISOString(),
@@ -335,30 +336,41 @@ export async function startServers({
headers: Object.entries(requestHeaders)
.filter(([key]) => key.toLowerCase() !== 'content-length')
.map(([name, value]) => ({ name, value })),
queryString: Object.entries(queryParams).map(([name, value]) => ({ name, value })),
postData: requestBody ? {
mimeType: requestHeaders['content-type'] || 'application/json',
text: typeof requestBody === 'string' ? requestBody : JSON.stringify(requestBody)
} : undefined,
queryString: Object.entries(queryParams).map(([name, value]) => ({
name,
value,
})),
postData: requestBody
? {
mimeType: requestHeaders['content-type'] || 'application/json',
text:
typeof requestBody === 'string'
? requestBody
: JSON.stringify(requestBody),
}
: undefined,
},
response: {
status: proxyRes.statusCode || 200,
statusText: proxyRes.statusCode === 200 ? 'OK' : 'Error',
httpVersion: 'HTTP/1.1',
headers: Object.entries(responseHeaders).map(([name, value]) => ({ name, value })),
headers: Object.entries(responseHeaders).map(([name, value]) => ({
name,
value,
})),
content: {
size: buffer.length,
mimeType: responseHeaders['content-type'] || 'application/octet-stream',
// Store raw buffer and defer text conversion/parsing until needed
text: '[Response content stored]'
text: '[Response content stored]',
},
},
_rawResponseBuffer: buffer, // Store for later processing if needed
};
// Add the HAR entry to the store
harStore.addEntry(harEntry);
// Extract security schemes from headers - minimal work
const securitySchemes: SecurityInfo[] = [];
if (requestHeaders['x-api-key']) {
@@ -380,7 +392,7 @@ export async function startServers({
scheme: 'basic' as const,
});
}
// Store minimal data in OpenAPI store - just record the endpoint and method
// This defers schema generation until actually requested
openApiStore.recordEndpoint(
@@ -402,39 +414,39 @@ export async function startServers({
rawData: buffer,
}
);
if (verbose) {
console.log(`${method} ${path} -> ${proxyRes.statusCode}`);
}
}); // End of setImmediate
});
});
}
]
},
],
});
proxyApp.use('/', proxyMiddleware);
// Create docs app with Express
const docsApp = express();
docsApp.use(cors());
// Create documentation endpoints
docsApp.get('/har', (req, res) => {
res.setHeader('Content-Type', 'application/json');
res.send(JSON.stringify(harStore.getHAR()));
});
docsApp.get('/openapi.json', (req, res) => {
res.setHeader('Content-Type', 'application/json');
res.send(JSON.stringify(openApiStore.getOpenAPISpec()));
});
docsApp.get('/openapi.yaml', (req, res) => {
res.setHeader('Content-Type', 'text/plain');
res.send(openApiStore.getOpenAPISpecAsYAML());
});
docsApp.get('/docs', (req, res) => {
res.setHeader('Content-Type', 'text/html');
res.send(`
@@ -452,7 +464,7 @@ export async function startServers({
</html>
`);
});
// Home page with links
docsApp.get('/', (req, res) => {
res.setHeader('Content-Type', 'text/html');
@@ -482,7 +494,7 @@ export async function startServers({
</html>
`);
});
// Function to check if a port is available
async function isPortAvailable(port: number): Promise<boolean> {
return new Promise((resolve) => {
@@ -497,7 +509,7 @@ export async function startServers({
.listen(port);
});
}
// Function to find an available port
async function findAvailablePort(startPort: number): Promise<number> {
let port = startPort;
@@ -506,11 +518,11 @@ export async function startServers({
}
return port;
}
// Start servers
const availableProxyPort = await findAvailablePort(proxyPort);
const availableDocsPort = await findAvailablePort(docsPort);
if (availableProxyPort !== proxyPort) {
console.log(
chalk.yellow(`Port ${proxyPort} is in use, using port ${availableProxyPort} instead`)
@@ -521,11 +533,11 @@ export async function startServers({
chalk.yellow(`Port ${docsPort} is in use, using port ${availableDocsPort} instead`)
);
}
// Create HTTP servers
const proxyServer = createServer(proxyApp);
const docsServer = createServer(docsApp);
// Start servers
return new Promise((resolve, reject) => {
try {
@@ -539,10 +551,14 @@ export async function startServers({
console.log(chalk.cyan(` API Reference: http://localhost:${availableDocsPort}/docs`));
console.log('\n' + chalk.bold('Exports:'));
console.log(chalk.cyan(` HAR Export: http://localhost:${availableDocsPort}/har`));
console.log(chalk.cyan(` OpenAPI JSON: http://localhost:${availableDocsPort}/openapi.json`));
console.log(chalk.cyan(` OpenAPI YAML: http://localhost:${availableDocsPort}/openapi.yaml`));
console.log(
chalk.cyan(` OpenAPI JSON: http://localhost:${availableDocsPort}/openapi.json`)
);
console.log(
chalk.cyan(` OpenAPI YAML: http://localhost:${availableDocsPort}/openapi.yaml`)
);
console.log('\n' + chalk.yellow('Press Ctrl+C to stop'));
resolve({ proxyServer, docsServer });
});
});
@@ -550,7 +566,7 @@ export async function startServers({
reject(error);
}
});
// Handle graceful shutdown
const shutdown = (signal: string): void => {
console.info(`Received ${signal}, shutting down...`);
@@ -558,11 +574,11 @@ export async function startServers({
docsServer.close();
process.exit(0);
};
process.on('SIGTERM', () => {
shutdown('SIGTERM');
});
process.on('SIGINT', () => {
shutdown('SIGINT');
});

208
src/store/__tests__/openApiStore.test.ts
View File

@@ -577,7 +577,7 @@ describe('OpenAPI Store', () => {
describe('Basic functionality', () => {
it('should initialize with correct default values', () => {
const spec = openApiStore.getOpenAPISpec();
expect(spec.openapi).toBe('3.1.0');
expect(spec.info.title).toBe('API Documentation');
expect(spec.info.version).toBe('1.0.0');
@@ -588,7 +588,7 @@ describe('OpenAPI Store', () => {
it('should set target URL correctly', () => {
openApiStore.setTargetUrl('https://example.com/api');
const spec = openApiStore.getOpenAPISpec();
expect(spec.servers?.[0]?.url).toBe('https://example.com/api');
});
@@ -600,11 +600,11 @@ describe('OpenAPI Store', () => {
{ query: {}, headers: {}, contentType: 'application/json', body: null },
{ status: 200, headers: {}, contentType: 'application/json', body: { success: true } }
);
// Verify it was added
const spec1 = openApiStore.getOpenAPISpec();
expect(Object.keys(spec1.paths || {})).toHaveLength(1);
// Clear and verify it's gone
openApiStore.clear();
const spec2 = openApiStore.getOpenAPISpec();
@@ -617,79 +617,84 @@ describe('OpenAPI Store', () => {
openApiStore.recordEndpoint(
'/users',
'get',
{
query: { limit: '10', offset: '0' },
headers: { 'accept': 'application/json' },
contentType: 'application/json',
body: null
{
query: { limit: '10', offset: '0' },
headers: { accept: 'application/json' },
contentType: 'application/json',
body: null,
},
{
status: 200,
headers: { 'content-type': 'application/json' },
contentType: 'application/json',
body: [{ id: 1, name: 'John Doe' }, { id: 2, name: 'Jane Smith' }]
{
status: 200,
headers: { 'content-type': 'application/json' },
contentType: 'application/json',
body: [
{ id: 1, name: 'John Doe' },
{ id: 2, name: 'Jane Smith' },
],
}
);
const spec = openApiStore.getOpenAPISpec();
// Check path exists
expect(spec.paths?.['/users']).toBeDefined();
expect(spec.paths?.['/users']?.get).toBeDefined();
// Check query parameters
const params = spec.paths?.['/users']?.get?.parameters;
expect(params).toBeDefined();
expect(params).toContainEqual(
expect.objectContaining({
name: 'limit',
in: 'query'
in: 'query',
})
);
expect(params).toContainEqual(
expect.objectContaining({
name: 'offset',
in: 'query'
in: 'query',
})
);
// Check response
expect(spec.paths?.['/users']?.get?.responses?.[200]).toBeDefined();
const content = (spec.paths?.['/users']?.get?.responses?.[200] as OpenAPIV3_1.ResponseObject)?.content;
const content = (spec.paths?.['/users']?.get?.responses?.[200] as OpenAPIV3_1.ResponseObject)
?.content;
expect(content?.['application/json']).toBeDefined();
});
it('should record a POST endpoint with request body', () => {
const requestBody = { name: 'Test User', email: 'test@example.com' };
openApiStore.recordEndpoint(
'/users',
'post',
{
query: {},
headers: { 'content-type': 'application/json' },
contentType: 'application/json',
body: requestBody
{
query: {},
headers: { 'content-type': 'application/json' },
contentType: 'application/json',
body: requestBody,
},
{
status: 201,
headers: { 'content-type': 'application/json' },
contentType: 'application/json',
body: { id: 1, ...requestBody }
{
status: 201,
headers: { 'content-type': 'application/json' },
contentType: 'application/json',
body: { id: 1, ...requestBody },
}
);
const spec = openApiStore.getOpenAPISpec();
// Check path exists
expect(spec.paths?.['/users']).toBeDefined();
expect(spec.paths?.['/users']?.post).toBeDefined();
// Check request body
expect(spec.paths?.['/users']?.post?.requestBody).toBeDefined();
const content = (spec.paths?.['/users']?.post?.requestBody as OpenAPIV3_1.RequestBodyObject)?.content;
const content = (spec.paths?.['/users']?.post?.requestBody as OpenAPIV3_1.RequestBodyObject)
?.content;
expect(content?.['application/json']).toBeDefined();
// Check response
expect(spec.paths?.['/users']?.post?.responses?.[201]).toBeDefined();
});
@@ -699,28 +704,44 @@ describe('OpenAPI Store', () => {
'/users/123',
'get',
{ query: {}, headers: {}, contentType: 'application/json', body: null },
{ status: 200, headers: {}, contentType: 'application/json', body: { id: 123, name: 'John Doe' } }
{
status: 200,
headers: {},
contentType: 'application/json',
body: { id: 123, name: 'John Doe' },
}
);
// Now record another endpoint with a different ID to help OpenAPI identify the path parameter
openApiStore.recordEndpoint(
'/users/456',
'get',
{ query: {}, headers: {}, contentType: 'application/json', body: null },
{ status: 200, headers: {}, contentType: 'application/json', body: { id: 456, name: 'Jane Smith' } }
{
status: 200,
headers: {},
contentType: 'application/json',
body: { id: 456, name: 'Jane Smith' },
}
);
const spec = openApiStore.getOpenAPISpec();
// Check that the path was correctly parameterized
expect(spec.paths?.['/users/{id}']).toBeDefined();
if (spec.paths?.['/users/{id}']) {
expect(spec.paths['/users/{id}'].get).toBeDefined();
// Check that the path parameter is defined
const params = spec.paths['/users/{id}'].get?.parameters;
expect(params).toBeDefined();
expect(params?.some(p => (p as OpenAPIV3_1.ParameterObject).name === 'id' && (p as OpenAPIV3_1.ParameterObject).in === 'path')).toBe(true);
expect(
params?.some(
(p) =>
(p as OpenAPIV3_1.ParameterObject).name === 'id' &&
(p as OpenAPIV3_1.ParameterObject).in === 'path'
)
).toBe(true);
}
});
@@ -729,48 +750,60 @@ describe('OpenAPI Store', () => {
openApiStore.recordEndpoint(
'/secure',
'get',
{
query: {},
headers: { 'x-api-key': 'test-key' },
contentType: 'application/json',
{
query: {},
headers: { 'x-api-key': 'test-key' },
contentType: 'application/json',
body: null,
security: [{ type: 'apiKey', name: 'x-api-key', in: 'header' }]
security: [{ type: 'apiKey', name: 'x-api-key', in: 'header' }],
},
{ status: 200, headers: {}, contentType: 'application/json', body: { message: 'Secret data' } }
{
status: 200,
headers: {},
contentType: 'application/json',
body: { message: 'Secret data' },
}
);
// Record an endpoint with Bearer token
openApiStore.recordEndpoint(
'/auth/profile',
'get',
{
query: {},
headers: { 'authorization': 'Bearer token123' },
contentType: 'application/json',
{
query: {},
headers: { authorization: 'Bearer token123' },
contentType: 'application/json',
body: null,
security: [{ type: 'http', scheme: 'bearer' }]
security: [{ type: 'http', scheme: 'bearer' }],
},
{ status: 200, headers: {}, contentType: 'application/json', body: { id: 1, username: 'admin' } }
{
status: 200,
headers: {},
contentType: 'application/json',
body: { id: 1, username: 'admin' },
}
);
const spec = openApiStore.getOpenAPISpec();
// Check security schemes are defined
expect(spec.components?.securitySchemes).toBeDefined();
// Check API Key security scheme
const apiKeyScheme = spec.components?.securitySchemes?.apiKey_ as OpenAPIV3_1.ApiKeySecurityScheme;
const apiKeyScheme = spec.components?.securitySchemes
?.apiKey_ as OpenAPIV3_1.ApiKeySecurityScheme;
expect(apiKeyScheme).toBeDefined();
expect(apiKeyScheme.type).toBe('apiKey');
expect(apiKeyScheme.in).toBe('header');
expect(apiKeyScheme.name).toBe('x-api-key');
// Check Bearer token security scheme
const bearerScheme = spec.components?.securitySchemes?.http_ as OpenAPIV3_1.HttpSecurityScheme;
const bearerScheme = spec.components?.securitySchemes
?.http_ as OpenAPIV3_1.HttpSecurityScheme;
expect(bearerScheme).toBeDefined();
expect(bearerScheme.type).toBe('http');
expect(bearerScheme.scheme).toBe('bearer');
// Check security requirements on endpoints
expect(spec.paths?.['/secure']?.get?.security).toBeDefined();
expect(spec.paths?.['/auth/profile']?.get?.security).toBeDefined();
@@ -782,7 +815,7 @@ describe('OpenAPI Store', () => {
const data = { id: 1, name: 'John Doe', active: true, age: 30 };
// @ts-ignore: Testing private method
const schema = openApiStore.generateJsonSchema(data);
expect(schema.type).toBe('object');
expect((schema.properties?.id as OpenAPIV3_1.SchemaObject).type).toBe('integer');
expect((schema.properties?.name as OpenAPIV3_1.SchemaObject).type).toBe('string');
@@ -793,11 +826,11 @@ describe('OpenAPI Store', () => {
it('should generate schema from array', () => {
const data = [
{ id: 1, name: 'John Doe' },
{ id: 2, name: 'Jane Smith' }
{ id: 2, name: 'Jane Smith' },
];
// @ts-ignore: Testing private method
const schema = openApiStore.generateJsonSchema(data);
expect(schema.type).toBe('array');
// Using ts-ignore since we're accessing a property that might not exist on all schema types
// @ts-ignore
@@ -817,16 +850,21 @@ describe('OpenAPI Store', () => {
address: {
street: '123 Main St',
city: 'Anytown',
zipCode: '12345'
zipCode: '12345',
},
tags: ['developer', 'javascript']
tags: ['developer', 'javascript'],
};
// @ts-ignore: Testing private method
const schema = openApiStore.generateJsonSchema(data);
expect(schema.type).toBe('object');
expect((schema.properties?.address as OpenAPIV3_1.SchemaObject).type).toBe('object');
expect(((schema.properties?.address as OpenAPIV3_1.SchemaObject).properties?.street as OpenAPIV3_1.SchemaObject).type).toBe('string');
expect(
(
(schema.properties?.address as OpenAPIV3_1.SchemaObject).properties
?.street as OpenAPIV3_1.SchemaObject
).type
).toBe('string');
expect((schema.properties?.tags as OpenAPIV3_1.SchemaObject).type).toBe('array');
// @ts-ignore
expect((schema.properties?.tags as OpenAPIV3_1.SchemaObject).items?.type).toBe('string');
@@ -836,20 +874,20 @@ describe('OpenAPI Store', () => {
const data = { id: 1, name: 'John Doe', description: null };
// @ts-ignore: Testing private method
const schema = openApiStore.generateJsonSchema(data);
expect((schema.properties?.description as OpenAPIV3_1.SchemaObject).type).toBe('null');
});
it('should detect proper types for numeric values', () => {
const data = {
const data = {
integer: 42,
float: 3.14,
scientific: 1e6,
zero: 0
zero: 0,
};
// @ts-ignore: Testing private method
const schema = openApiStore.generateJsonSchema(data);
expect((schema.properties?.integer as OpenAPIV3_1.SchemaObject).type).toBe('integer');
expect((schema.properties?.float as OpenAPIV3_1.SchemaObject).type).toBe('number');
expect((schema.properties?.scientific as OpenAPIV3_1.SchemaObject).type).toBe('integer');
@@ -861,7 +899,7 @@ describe('OpenAPI Store', () => {
it('should detect and generate schema for array-like structures', () => {
// @ts-ignore: Testing private method
const schema = openApiStore.generateSchemaFromStructure('[{"id":1,"name":"test"},{"id":2}]');
expect(schema.type).toBe('array');
// TypeScript doesn't recognize that an array schema will have items
// @ts-ignore
@@ -870,8 +908,10 @@ describe('OpenAPI Store', () => {
it('should detect and generate schema for object-like structures', () => {
// @ts-ignore: Testing private method
const schema = openApiStore.generateSchemaFromStructure('{"id":1,"name":"test","active":true}');
const schema = openApiStore.generateSchemaFromStructure(
'{"id":1,"name":"test","active":true}'
);
expect(schema.type).toBe('object');
expect(schema.properties).toBeDefined();
expect(schema.properties?.id).toBeDefined();
@@ -882,7 +922,7 @@ describe('OpenAPI Store', () => {
it('should handle unstructured content', () => {
// @ts-ignore: Testing private method
const schema = openApiStore.generateSchemaFromStructure('This is just plain text');
expect(schema.type).toBe('string');
});
});
@@ -896,15 +936,15 @@ describe('OpenAPI Store', () => {
{ query: {}, headers: {}, contentType: 'application/json', body: null },
{ status: 200, headers: {}, contentType: 'application/json', body: { success: true } }
);
const har = openApiStore.generateHAR();
expect(har.log).toBeDefined();
expect(har.log.version).toBe('1.2');
expect(har.log.creator).toBeDefined();
expect(har.log.entries).toBeDefined();
expect(har.log.entries).toHaveLength(1);
const entry = har.log.entries[0];
expect(entry.request.method).toBe('GET');
expect(entry.request.url).toBe('http://localhost:8080/test');
@@ -921,9 +961,9 @@ describe('OpenAPI Store', () => {
{ query: {}, headers: {}, contentType: 'application/json', body: null },
{ status: 200, headers: {}, contentType: 'application/json', body: { success: true } }
);
const yaml = openApiStore.getOpenAPISpecAsYAML();
expect(yaml).toContain('openapi: 3.1.0');
expect(yaml).toContain('paths:');
expect(yaml).toContain('/test:');

190
src/store/openApiStore.ts
View File

@@ -194,12 +194,14 @@ export class OpenAPIStore {
if (obj.length === 0) return { type: 'array', items: { type: 'object' } };
// Check if all items are objects with similar structure
const allObjects = obj.every(item => typeof item === 'object' && item !== null && !Array.isArray(item));
const allObjects = obj.every(
(item) => typeof item === 'object' && item !== null && !Array.isArray(item)
);
if (allObjects) {
// Generate a schema for the first object
const firstObjectSchema = this.generateJsonSchema(obj[0]);
// Use that as a template for all items
return {
type: 'array',
@@ -209,32 +211,35 @@ export class OpenAPIStore {
}
// Check if all items are primitives of the same type
if (obj.length > 0 &&
obj.every(item => typeof item === 'string' ||
typeof item === 'number' ||
typeof item === 'boolean')) {
if (
obj.length > 0 &&
obj.every(
(item) =>
typeof item === 'string' || typeof item === 'number' || typeof item === 'boolean'
)
) {
// Handle arrays of primitives
const firstItemType = typeof obj[0];
if (obj.every(item => typeof item === firstItemType)) {
if (obj.every((item) => typeof item === firstItemType)) {
// For numbers, check if they're all integers
if (firstItemType === 'number') {
const isAllIntegers = obj.every(Number.isInteger);
return {
type: 'array',
items: {
type: isAllIntegers ? 'integer' : 'number'
type: isAllIntegers ? 'integer' : 'number',
},
example: obj
example: obj,
};
}
// For strings and booleans
return {
type: 'array',
items: {
type: firstItemType as OpenAPIV3_1.NonArraySchemaObjectType
type: firstItemType as OpenAPIV3_1.NonArraySchemaObjectType,
},
example: obj
example: obj,
};
}
}
@@ -335,10 +340,12 @@ export class OpenAPIStore {
value: String(value), // Ensure value is a string
})),
// Ensure postData is properly included for all requests with body
postData: request.body ? {
mimeType: request.contentType,
text: typeof request.body === 'string' ? request.body : JSON.stringify(request.body),
} : undefined,
postData: request.body
? {
mimeType: request.contentType,
text: typeof request.body === 'string' ? request.body : JSON.stringify(request.body),
}
: undefined,
},
response: {
status: response.status,
@@ -350,12 +357,18 @@ export class OpenAPIStore {
})),
content: {
// If rawData is available, just store size but defer content processing
size: response.rawData ? response.rawData.length :
response.body ? JSON.stringify(response.body).length : 0,
size: response.rawData
? response.rawData.length
: response.body
? JSON.stringify(response.body).length
: 0,
mimeType: response.contentType || 'application/json',
// Use a placeholder for rawData, or convert body as before
text: response.rawData ? '[Content stored but not processed for performance]' :
typeof response.body === 'string' ? response.body : JSON.stringify(response.body),
text: response.rawData
? '[Content stored but not processed for performance]'
: typeof response.body === 'string'
? response.body
: JSON.stringify(response.body),
},
},
};
@@ -556,17 +569,17 @@ export class OpenAPIStore {
responseObj.content[responseContentType] = {
schema: {
type: 'object',
description: 'Schema generation deferred to improve performance'
description: 'Schema generation deferred to improve performance',
},
};
// Store the raw data for later processing
let pathMap = this.rawDataCache.get(path);
if (!pathMap) {
pathMap = new Map<string, RawResponseData>();
this.rawDataCache.set(path, pathMap);
}
pathMap.set(method, {
rawData: response.rawData ? response.rawData.toString('base64') : '',
status: response.status,
@@ -602,7 +615,7 @@ export class OpenAPIStore {
// For each HAR entry with placeholder text, process the raw data
for (let i = 0; i < this.harEntries.length; i++) {
const entry = this.harEntries[i];
// Check if this entry has deferred processing
if (entry.response.content.text === '[Content stored but not processed for performance]') {
try {
@@ -610,21 +623,22 @@ export class OpenAPIStore {
const url = new URL(entry.request.url);
const path = url.pathname;
const method = entry.request.method.toLowerCase();
// Try to get the raw data from our cache
const pathMap = this.rawDataCache.get(path);
if (!pathMap) continue;
const responseData = pathMap.get(method);
if (!responseData || !responseData.rawData) continue;
// Get content type and encoding info
const contentEncoding = entry.response.headers.find(h =>
h.name.toLowerCase() === 'content-encoding')?.value;
const contentEncoding = entry.response.headers.find(
(h) => h.name.toLowerCase() === 'content-encoding'
)?.value;
// Process based on content type and encoding
let text: string;
// Handle compressed content
if (contentEncoding && contentEncoding.includes('gzip')) {
const buffer = Buffer.from(responseData.rawData, 'base64');
@@ -635,7 +649,7 @@ export class OpenAPIStore {
const buffer = Buffer.from(responseData.rawData, 'base64');
text = buffer.toString('utf-8');
}
// Process based on content type
const contentType = entry.response.content.mimeType;
if (contentType.includes('json')) {
@@ -686,7 +700,7 @@ export class OpenAPIStore {
}
if (!operation.responses[responseKey]) {
operation.responses[responseKey] = {
description: `Response for status code ${responseKey}`
description: `Response for status code ${responseKey}`,
};
}
@@ -697,21 +711,23 @@ export class OpenAPIStore {
// Determine content type from headers
let contentType = 'application/json'; // Default
const contentTypeHeader = Object.keys(headers)
.find(key => key.toLowerCase() === 'content-type');
const contentTypeHeader = Object.keys(headers).find(
(key) => key.toLowerCase() === 'content-type'
);
if (contentTypeHeader && headers[contentTypeHeader]) {
contentType = headers[contentTypeHeader].split(';')[0];
}
// Check if content is compressed
const contentEncodingHeader = Object.keys(headers)
.find(key => key.toLowerCase() === 'content-encoding');
const contentEncodingHeader = Object.keys(headers).find(
(key) => key.toLowerCase() === 'content-encoding'
);
const contentEncoding = contentEncodingHeader ? headers[contentEncodingHeader] : null;
// Process based on encoding and content type
try {
let text: string;
// Handle compressed content
if (contentEncoding && contentEncoding.includes('gzip')) {
const buffer = Buffer.from(rawData, 'base64');
@@ -729,10 +745,10 @@ export class OpenAPIStore {
try {
// First attempt standard JSON parsing
const jsonData = JSON.parse(text);
const schema = this.generateJsonSchema(jsonData);
response.content[contentType] = {
schema
schema,
};
} catch (e) {
// Try cleaning the JSON first
@@ -740,10 +756,10 @@ export class OpenAPIStore {
// Clean the JSON string
const cleanedText = this.cleanJsonString(text);
const jsonData = JSON.parse(cleanedText);
const schema = this.generateJsonSchema(jsonData);
response.content[contentType] = {
schema
schema,
};
} catch (e2) {
// If parsing still fails, try to infer the schema from structure
@@ -751,15 +767,15 @@ export class OpenAPIStore {
// Looks like JSON-like structure, infer schema
const schema = this.generateSchemaFromStructure(text);
response.content[contentType] = {
schema
schema,
};
} else {
// Not JSON-like, treat as string
response.content[contentType] = {
schema: {
type: 'string',
description: 'Non-parseable content'
}
description: 'Non-parseable content',
},
};
}
}
@@ -770,8 +786,8 @@ export class OpenAPIStore {
schema: {
type: 'string',
format: 'xml',
description: 'XML content'
}
description: 'XML content',
},
};
} else if (contentType.includes('image/')) {
// Handle image content
@@ -779,18 +795,16 @@ export class OpenAPIStore {
schema: {
type: 'string',
format: 'binary',
description: 'Image content'
}
description: 'Image content',
},
};
} else {
// Handle other content types
response.content[contentType] = {
schema: {
type: 'string',
description: text.length > 100 ?
`${text.substring(0, 100)}...` :
text
}
description: text.length > 100 ? `${text.substring(0, 100)}...` : text,
},
};
}
} catch (error) {
@@ -799,8 +813,8 @@ export class OpenAPIStore {
response.content['text/plain'] = {
schema: {
type: 'string',
description: 'Error processing content'
}
description: 'Error processing content',
},
};
}
}
@@ -813,7 +827,7 @@ export class OpenAPIStore {
public getOpenAPISpec(): OpenAPIV3_1.Document {
// Process any deferred raw data before generating the spec
this.processRawData();
const paths = Array.from(this.endpoints.entries()).reduce<Required<PathsObject>>(
(acc, [key, info]) => {
const [method, path] = key.split(':');
@@ -939,7 +953,7 @@ export class OpenAPIStore {
public generateHAR(): any {
// Process any raw data before generating HAR
this.processHAREntries();
return {
log: {
version: '1.2',
@@ -956,7 +970,7 @@ export class OpenAPIStore {
private generateSchemaFromStructure(text: string): OpenAPIV3_1.SchemaObject {
// First, try to determine if this is an array or object
const trimmedText = text.trim();
if (trimmedText.startsWith('[') && trimmedText.endsWith(']')) {
// Looks like an array
return {
@@ -964,37 +978,37 @@ export class OpenAPIStore {
description: 'Array-like structure detected',
items: {
type: 'object',
description: 'Array items (structure inferred)'
}
description: 'Array items (structure inferred)',
},
};
}
if (trimmedText.startsWith('{') && trimmedText.endsWith('}')) {
// Looks like an object - try to extract some field names
try {
// Extract property names using a regex that looks for different "key": patterns
// This matcher is more flexible and can handle single quotes, double quotes, and unquoted keys
const propMatches = trimmedText.match(/["']?([a-zA-Z0-9_$]+)["']?\s*:/g) || [];
if (propMatches.length > 0) {
const properties: Record<string, OpenAPIV3_1.SchemaObject> = {};
// Extract property names and create a basic schema
propMatches.forEach(match => {
propMatches.forEach((match) => {
// Clean up the property name by removing quotes and colon
const propName = match.replace(/["']/g, '').replace(':', '').trim();
if (propName && !properties[propName]) {
// Try to guess the type based on what follows the property
const propPattern = new RegExp(`["']?${propName}["']?\\s*:\\s*(.{1,50})`, 'g');
const valueMatch = propPattern.exec(trimmedText);
if (valueMatch && valueMatch[1]) {
const valueStart = valueMatch[1].trim();
if (valueStart.startsWith('{')) {
properties[propName] = {
type: 'object',
description: 'Nested object detected'
description: 'Nested object detected',
};
} else if (valueStart.startsWith('[')) {
properties[propName] = {
@@ -1002,8 +1016,8 @@ export class OpenAPIStore {
description: 'Array value detected',
items: {
type: 'object',
description: 'Array items (structure inferred)'
}
description: 'Array items (structure inferred)',
},
};
} else if (valueStart.startsWith('"') || valueStart.startsWith("'")) {
properties[propName] = {
@@ -1024,39 +1038,39 @@ export class OpenAPIStore {
} else {
properties[propName] = {
type: 'string',
description: 'Property detected by structure analysis'
description: 'Property detected by structure analysis',
};
}
} else {
properties[propName] = {
type: 'string',
description: 'Property detected by structure analysis'
description: 'Property detected by structure analysis',
};
}
}
});
return {
type: 'object',
properties,
description: 'Object structure detected with properties'
description: 'Object structure detected with properties',
};
}
} catch (e) {
// If property extraction fails, fall back to a generic object schema
}
// Generic object
return {
type: 'object',
description: 'Object-like structure detected'
description: 'Object-like structure detected',
};
}
// Not clearly structured as JSON
return {
type: 'string',
description: 'Unstructured content'
description: 'Unstructured content',
};
}
@@ -1067,31 +1081,29 @@ export class OpenAPIStore {
let cleaned = text
.replace(/\/\/.*$/gm, '') // Remove single line comments
.replace(/\/\*[\s\S]*?\*\//g, ''); // Remove multi-line comments
// Handle trailing commas in objects and arrays
cleaned = cleaned
.replace(/,\s*}/g, '}')
.replace(/,\s*\]/g, ']');
cleaned = cleaned.replace(/,\s*}/g, '}').replace(/,\s*\]/g, ']');
// Fix unquoted property names (only basic cases)
cleaned = cleaned.replace(/([{,]\s*)([a-zA-Z0-9_$]+)(\s*:)/g, '$1"$2"$3');
// Fix single quotes used for strings (convert to double quotes)
// This is complex - we need to avoid replacing quotes inside quotes
let inString = false;
let inSingleQuotedString = false;
let result = '';
for (let i = 0; i < cleaned.length; i++) {
const char = cleaned[i];
const prevChar = i > 0 ? cleaned[i-1] : '';
const prevChar = i > 0 ? cleaned[i - 1] : '';
// Handle escape sequences
if (prevChar === '\\') {
result += char;
continue;
}
if (char === '"' && !inSingleQuotedString) {
inString = !inString;
result += char;
@@ -1102,7 +1114,7 @@ export class OpenAPIStore {
result += char;
}
}
return result;
} catch (e) {
// If cleaning fails, return the original text