mirror of
https://github.com/only-cli/oc.git
synced 2026-09-15 10:40:56 +02:00
only-cli
5706aab2a1
MDN renders its search results client-side, so 'oc mdn search' has gone through DuckDuckGo with a site: filter. But the page it renders gets its results from a public JSON endpoint, /api/v1/search, which returns the site's own ranking with a summary per result in one ~11KB response. A new 'api' shortcut shape names such an endpoint and which response fields hold the list, title, URL, and snippet; the response becomes the same synthetic results page a Sphinx search produces and rides the normal render path, so 'do <n>' follows a result. First view is ~520 tokens and works for any site whose search answers as JSON.
56 lines
2.6 KiB
JavaScript
56 lines
2.6 KiB
JavaScript
import test from 'node:test';
|
|
import assert from 'node:assert/strict';
|
|
|
|
const { resultsToHTML } = await import('../src/apisearch.js');
|
|
|
|
// The MDN-shaped definition oc ships, minus the endpoint itself: which
|
|
// response fields hold the list, and what each result calls its parts.
|
|
const DEF = {
|
|
results: 'documents',
|
|
fields: { title: 'title', url: 'mdn_url', text: 'summary' },
|
|
total: 'metadata.total.value',
|
|
};
|
|
const API = 'https://developer.mozilla.org/api/v1/search?q=map';
|
|
|
|
// A miniature /api/v1/search answer: a relative URL, a nested total, and a
|
|
// title that would be markup if it were ever trusted.
|
|
const DATA = {
|
|
documents: [
|
|
{ mdn_url: '/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map', title: 'Array.prototype.map()', summary: 'Creates a new array from results of a callback.' },
|
|
{ mdn_url: '/en-US/docs/Web/API/Map', title: 'Map <script>alert(1)</script>', summary: 'Holds key-value pairs.' },
|
|
],
|
|
metadata: { total: { value: 2696 } },
|
|
};
|
|
|
|
test('results map through the named fields and resolve against the endpoint', () => {
|
|
const html = resultsToHTML(DEF, 'map', DATA, API);
|
|
assert.match(html, /href="https:\/\/developer\.mozilla\.org\/en-US\/docs\/Web\/JavaScript\/Reference\/Global_Objects\/Array\/map"/);
|
|
assert.match(html, /Array\.prototype\.map\(\)/);
|
|
assert.match(html, /Creates a new array/);
|
|
});
|
|
|
|
test('the site total is reported, and result count is what the page shows', () => {
|
|
assert.match(resultsToHTML(DEF, 'map', DATA, API), /2696 pages match, ranked by the site's own search, top 2 shown:/);
|
|
});
|
|
|
|
test('a title is response data, never markup on the results page', () => {
|
|
const html = resultsToHTML(DEF, 'map', DATA, API);
|
|
assert.doesNotMatch(html, /<script/);
|
|
assert.match(html, /Map <script>/);
|
|
});
|
|
|
|
test('a response with nothing in it renders an honest empty page, not an error', () => {
|
|
const html = resultsToHTML(DEF, 'zzqqxx', { documents: [], metadata: { total: { value: 0 } } }, API);
|
|
assert.match(html, /nothing in the site's own search matches/);
|
|
assert.doesNotMatch(html, /<ol>/);
|
|
});
|
|
|
|
test('a response missing the fields a definition names still renders a page', () => {
|
|
// A site that reshapes its API answer should cost a bad result list, not a
|
|
// crash: no list means the empty page, a result with no title falls back
|
|
// to its URL.
|
|
assert.match(resultsToHTML(DEF, 'map', { unrelated: true }, API), /nothing in the site's own search/);
|
|
const html = resultsToHTML(DEF, 'map', { documents: [{ mdn_url: '/en-US/docs/Web/API/Map' }], metadata: {} }, API);
|
|
assert.match(html, />https:\/\/developer\.mozilla\.org\/en-US\/docs\/Web\/API\/Map</);
|
|
});
|