fix(scraper): emit JSON errors from run under --json / --pretty#18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
danishashko wants to merge 1 commit into
base:main
Choose a base branch
from
Open

fix(scraper): emit JSON errors from run under --json / --pretty #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 33 additions & 17 deletions src/__tests__/commands/scraper.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -88,6 +88,7 @@ import {
format_heal_summary,
resume_and_poll,
handle_approve_scraper,
format_run_error,
} from '../../commands/scraper';

describe('commands/scraper', ()=>{
Expand DownExpand Up@@ -771,16 +772,11 @@ describe('commands/scraper', ()=>{

it('exits when trigger returns no response_id', async()=>{
mocks.post.mockResolvedValueOnce({});
const exit = vi.spyOn(process, 'exit')
.mockImplementation(()=>undefined as never);
const error = vi.spyOn(console, 'error')
.mockImplementation(()=>{});
await handle_run_scraper('c_abc', 'https://x.com', {});
const msg = error.mock.calls.map(c=>String(c[0])).join('\n');
await expect(handle_run_scraper('c_abc', 'https://x.com', {}))
.rejects.toThrow();
const msg = String(mocks.fail.mock.calls[0][0]);
expect(msg).toContain('response_id');
expect(msg).toContain('c_abc');
exit.mockRestore();
error.mockRestore();
});
});

Expand DownExpand Up@@ -820,17 +816,11 @@ describe('commands/scraper', ()=>{
stub_fetch(202,
JSON.stringify({error: 'crawl_results_timeout',
response_id: 'r_late'}));
const exit = vi.spyOn(process, 'exit')
.mockImplementation(()=>undefined as never);
const error = vi.spyOn(console, 'error')
.mockImplementation(()=>{});
await handle_run_scraper('c_abc', 'https://x.com',
{sync: true});
const msg = error.mock.calls.map(c=>String(c[0])).join('\n');
await expect(handle_run_scraper('c_abc', 'https://x.com',
{sync: true})).rejects.toThrow();
const msg = String(mocks.fail.mock.calls[0][0]);
expect(msg).toContain('r_late');
expect(msg).toContain('Re-run without --sync');
exit.mockRestore();
error.mockRestore();
});

it('honors --sync-timeout', async()=>{
Expand DownExpand Up@@ -2195,3 +2185,29 @@ describe('commands/scraper', ()=>{
});
});
});

describe('format_run_error', ()=>{
it('returns the raw message (no JSON) when no machine format is set',
()=>{
expect(format_run_error('boom', {})).toEqual(
{json: false, text: 'boom'});
});

it('returns a compact JSON error object under --json', ()=>{
expect(format_run_error('boom', {json: true})).toEqual(
{json: true, text: '{"error":"boom"}'});
});

it('strips the "Error:" prefix and extra lines in the JSON payload',
()=>{
expect(format_run_error('Error: bad thing\nstack', {json: true}))
.toEqual({json: true, text: '{"error":"bad thing"}'});
});

it('pretty-prints the JSON error under --pretty', ()=>{
expect(format_run_error('boom', {pretty: true})).toEqual({
json: true,
text: JSON.stringify({error: 'boom'}, null, 2),
});
});
});
97 changes: 64 additions & 33 deletions src/commands/scraper.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -231,6 +231,44 @@ const format_create_summary = (
const clean_error_message = (msg: string): string=>
msg.split('\n')[0].replace(/^Error:\s*/, '').trim();

// Error output for the `run` command. When the caller asked for machine
// output (--json / --pretty), a failed run must return a parseable error
// object on stdout, not a plain-text line on stderr, so an agent reading
// stdout still gets something it can JSON.parse. Without those flags the
// behaviour (a red line on stderr) is unchanged.
const format_run_error = (
msg: string,
opts: {json?: boolean; pretty?: boolean}
): {json: boolean; text: string}=>{
if (opts.json || opts.pretty)
{
const payload = {error: clean_error_message(msg)};
return {
json: true,
text: opts.pretty
? JSON.stringify(payload, null, 2)
: JSON.stringify(payload),
};
}
return {json: false, text: msg};
};

const run_fail = (
msg: string,
opts: {json?: boolean; pretty?: boolean}
): void=>{
const out = format_run_error(msg, opts);
if (out.json)
{
process.stdout.write(out.text+'\n');
process.exit(1);
return;
}
// Non-machine output: reuse the shared fail() (red ✗ line on stderr +
// exit 1), so every run error is formatted consistently.
fail(out.text);
};

const build_create_envelope = (params: {
collector_id: string;
name: string;
Expand DownExpand Up@@ -1033,7 +1071,7 @@ const run_batch = async(
try {
timeout = parse_timeout(timeout_raw);
} catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
return;
}
if (reason == 'page_limit_fallback')
Expand All@@ -1060,10 +1098,9 @@ const run_batch = async(
trigger_spinner.stop();
if (!trigger.collection_id)
{
console.error(
run_fail(
`Failed to submit batch job (collector ${collector_id}): `
+'missing collection_id.');
process.exit(1);
+'missing collection_id.', opts);
return;
}
collection_id = trigger.collection_id;
Expand All@@ -1073,10 +1110,9 @@ const run_batch = async(
`Batch job: ${collection_id}${eta}`));
} catch(e) {
trigger_spinner.stop();
console.error(
run_fail(
`Failed to submit batch job (collector ${collector_id}): `
+`${(e as Error).message}`);
process.exit(1);
+`${(e as Error).message}`, opts);
return;
}
const poll_spinner = start_spinner('Collecting (batch)...');
Expand DownExpand Up@@ -1105,8 +1141,7 @@ const run_batch = async(
const msg = (e as Error).message;
const suffix = msg.includes(collection_id)
? '' : ` (collection_id ${collection_id})`;
console.error(`${msg}${suffix}`);
process.exit(1);
run_fail(`${msg}${suffix}`, opts);
return;
}
};
Expand All@@ -1121,17 +1156,18 @@ const handle_run_scraper = async(
try {
urls = resolve_run_inputs(url, opts);
} catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
return;
}
if (urls.length > 1)
{
if (opts.sync)
{
fail(
run_fail(
'--sync cannot be combined with --urls / --input-file. '
+'The /dca/crawl endpoint accepts only a single URL. '
+'Drop --sync to use the batch endpoint (/dca/trigger).');
+'Drop --sync to use the batch endpoint (/dca/trigger).',
opts);
return;
}
await run_batch(api_key, collector_id, urls, opts, 'multi_url');
Expand All@@ -1144,7 +1180,7 @@ const handle_run_scraper = async(
try {
sync_timeout = parse_sync_timeout(opts.syncTimeout);
} catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
return;
}
const query = build_run_query(collector_id, opts,
Expand All@@ -1162,21 +1198,19 @@ const handle_run_scraper = async(
const parsed = parse_result_body(res.body) as
{response_id?: string; message?: string};
const rid = parsed?.response_id ?? '<unknown>';
console.error(
run_fail(
`Sync request timed out server-side after `
+`${sync_timeout}s (response_id: ${rid}). `
+'Re-run without --sync to poll for results.'
);
process.exit(1);
+'Re-run without --sync to poll for results.',
opts);
return;
}
if (res.status < 200 || res.status >= 300)
{
console.error(
run_fail(
`Failed to scrape (collector ${collector_id}): `
+`HTTP ${res.status} ${res.body.slice(0, 200)}`
);
process.exit(1);
+`HTTP ${res.status} ${res.body.slice(0, 200)}`,
opts);
return;
}
const data = parse_result_body(res.body);
Expand All@@ -1190,18 +1224,17 @@ const handle_run_scraper = async(
return;
} catch(e) {
spinner.stop();
console.error(
run_fail(
`Failed to scrape (collector ${collector_id}): `
+`${(e as Error).message}`);
process.exit(1);
+`${(e as Error).message}`, opts);
return;
}
}
let timeout = 600;
try {
timeout = parse_timeout(opts.timeout);
} catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
return;
}
const trigger_spinner = start_spinner('Triggering scrape...');
Expand All@@ -1217,20 +1250,18 @@ const handle_run_scraper = async(
trigger_spinner.stop();
if (!trigger.response_id)
{
console.error(
run_fail(
`Failed to trigger scraper (collector ${collector_id}): `
+'missing response_id in trigger response.');
process.exit(1);
+'missing response_id in trigger response.', opts);
return;
}
response_id = trigger.response_id;
console.error(dim(`Triggered (response_id: ${response_id})`));
} catch(e) {
trigger_spinner.stop();
console.error(
run_fail(
`Failed to trigger scraper (collector ${collector_id}): `
+`${(e as Error).message}`);
process.exit(1);
+`${(e as Error).message}`, opts);
return;
}
const poll_spinner = start_spinner('Waiting for results...');
Expand DownExpand Up@@ -1263,8 +1294,7 @@ const handle_run_scraper = async(
const msg = (e as Error).message;
const suffix = msg.includes(response_id)
? '' : ` (response_id ${response_id})`;
console.error(`${msg}${suffix}`);
process.exit(1);
run_fail(`${msg}${suffix}`, opts);
return;
}
};
Expand DownExpand Up@@ -1475,6 +1505,7 @@ export {
build_create_envelope,
emit_create_output,
handle_run_scraper,
format_run_error,
build_run_request,
build_run_query,
classify_result,
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix(scraper): emit JSON errors from run under --json / --pretty#18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

danishashko
wants to merge
1
commit into

base:main
Choose a base branch

from

 Open


fix(scraper): emit JSON errors from run under --json / --pretty
#18
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


50 changes: 33 additions & 17 deletions
src/__tests__/commands/scraper.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,6 +88,7 @@ import {
 format_heal_summary,
 resume_and_poll,
 handle_approve_scraper,
 format_run_error,
} from '../../commands/scraper';

describe('commands/scraper', ()=>{
Expand DownExpand Up@@ -771,16 +772,11 @@ describe('commands/scraper', ()=>{

 it('exits when trigger returns no response_id', async()=>{
 mocks.post.mockResolvedValueOnce({});
 const exit = vi.spyOn(process, 'exit')
 .mockImplementation(()=>undefined as never);
 const error = vi.spyOn(console, 'error')
 .mockImplementation(()=>{});
 await handle_run_scraper('c_abc', 'https://x.com', {});
 const msg = error.mock.calls.map(c=>String(c[0])).join('\n');
 await expect(handle_run_scraper('c_abc', 'https://x.com', {}))
 .rejects.toThrow();
 const msg = String(mocks.fail.mock.calls[0][0]);
 expect(msg).toContain('response_id');
 expect(msg).toContain('c_abc');
 exit.mockRestore();
 error.mockRestore();
 });
 });

Expand DownExpand Up@@ -820,17 +816,11 @@ describe('commands/scraper', ()=>{
 stub_fetch(202,
 JSON.stringify({error: 'crawl_results_timeout',
 response_id: 'r_late'}));
 const exit = vi.spyOn(process, 'exit')
 .mockImplementation(()=>undefined as never);
 const error = vi.spyOn(console, 'error')
 .mockImplementation(()=>{});
 await handle_run_scraper('c_abc', 'https://x.com',
 {sync: true});
 const msg = error.mock.calls.map(c=>String(c[0])).join('\n');
 await expect(handle_run_scraper('c_abc', 'https://x.com',
 {sync: true})).rejects.toThrow();
 const msg = String(mocks.fail.mock.calls[0][0]);
 expect(msg).toContain('r_late');
 expect(msg).toContain('Re-run without --sync');
 exit.mockRestore();
 error.mockRestore();
 });

 it('honors --sync-timeout', async()=>{
Expand DownExpand Up@@ -2195,3 +2185,29 @@ describe('commands/scraper', ()=>{
 });
 });
});

describe('format_run_error', ()=>{
 it('returns the raw message (no JSON) when no machine format is set',
 ()=>{
 expect(format_run_error('boom', {})).toEqual(
 {json: false, text: 'boom'});
 });

 it('returns a compact JSON error object under --json', ()=>{
 expect(format_run_error('boom', {json: true})).toEqual(
 {json: true, text: '{"error":"boom"}'});
 });

 it('strips the "Error:" prefix and extra lines in the JSON payload',
 ()=>{
 expect(format_run_error('Error: bad thing\nstack', {json: true}))
 .toEqual({json: true, text: '{"error":"bad thing"}'});
 });

 it('pretty-prints the JSON error under --pretty', ()=>{
 expect(format_run_error('boom', {pretty: true})).toEqual({
 json: true,
 text: JSON.stringify({error: 'boom'}, null, 2),
 });
 });
});

97 changes: 64 additions & 33 deletions
src/commands/scraper.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -231,6 +231,44 @@ const format_create_summary = (
const clean_error_message = (msg: string): string=>
 msg.split('\n')[0].replace(/^Error:\s*/, '').trim();

// Error output for the `run` command. When the caller asked for machine
// output (--json / --pretty), a failed run must return a parseable error
// object on stdout, not a plain-text line on stderr, so an agent reading
// stdout still gets something it can JSON.parse. Without those flags the
// behaviour (a red line on stderr) is unchanged.
const format_run_error = (
 msg: string,
 opts: {json?: boolean; pretty?: boolean}
): {json: boolean; text: string}=>{
 if (opts.json || opts.pretty)
 {
 const payload = {error: clean_error_message(msg)};
 return {
 json: true,
 text: opts.pretty
 ? JSON.stringify(payload, null, 2)
 : JSON.stringify(payload),
 };
 }
 return {json: false, text: msg};
};

const run_fail = (
 msg: string,
 opts: {json?: boolean; pretty?: boolean}
): void=>{
 const out = format_run_error(msg, opts);
 if (out.json)
 {
 process.stdout.write(out.text+'\n');
 process.exit(1);
 return;
 }
 // Non-machine output: reuse the shared fail() (red ✗ line on stderr +
 // exit 1), so every run error is formatted consistently.
 fail(out.text);
};

const build_create_envelope = (params: {
 collector_id: string;
 name: string;
Expand DownExpand Up@@ -1033,7 +1071,7 @@ const run_batch = async(
 try {
 timeout = parse_timeout(timeout_raw);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 if (reason == 'page_limit_fallback')
Expand All@@ -1060,10 +1098,9 @@ const run_batch = async(
 trigger_spinner.stop();
 if (!trigger.collection_id)
 {
console.error(
run_fail(
 `Failed to submit batch job (collector ${collector_id}): `
 +'missing collection_id.');
 process.exit(1);
 +'missing collection_id.', opts);
 return;
 }
 collection_id = trigger.collection_id;
Expand All@@ -1073,10 +1110,9 @@ const run_batch = async(
 `Batch job: ${collection_id}${eta}`));
 } catch(e) {
 trigger_spinner.stop();
console.error(
run_fail(
 `Failed to submit batch job (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 const poll_spinner = start_spinner('Collecting (batch)...');
Expand DownExpand Up@@ -1105,8 +1141,7 @@ const run_batch = async(
 const msg = (e as Error).message;
 const suffix = msg.includes(collection_id)
 ? '' : ` (collection_id ${collection_id})`;
 console.error(`${msg}${suffix}`);
 process.exit(1);
 run_fail(`${msg}${suffix}`, opts);
 return;
 }
};
Expand All@@ -1121,17 +1156,18 @@ const handle_run_scraper = async(
 try {
 urls = resolve_run_inputs(url, opts);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 if (urls.length > 1)
 {
 if (opts.sync)
 {
fail(
run_fail(
 '--sync cannot be combined with --urls / --input-file. '
 +'The /dca/crawl endpoint accepts only a single URL. '
 +'Drop --sync to use the batch endpoint (/dca/trigger).');
 +'Drop --sync to use the batch endpoint (/dca/trigger).',
 opts);
 return;
 }
 await run_batch(api_key, collector_id, urls, opts, 'multi_url');
Expand All@@ -1144,7 +1180,7 @@ const handle_run_scraper = async(
 try {
 sync_timeout = parse_sync_timeout(opts.syncTimeout);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 const query = build_run_query(collector_id, opts,
Expand All@@ -1162,21 +1198,19 @@ const handle_run_scraper = async(
 const parsed = parse_result_body(res.body) as
 {response_id?: string; message?: string};
 const rid = parsed?.response_id ?? '<unknown>';
console.error(
run_fail(
 `Sync request timed out server-side after `
 +`${sync_timeout}s (response_id: ${rid}). `
 +'Re-run without --sync to poll for results.'
 );
 process.exit(1);
 +'Re-run without --sync to poll for results.',
 opts);
 return;
 }
 if (res.status < 200 || res.status >= 300)
 {
console.error(
run_fail(
 `Failed to scrape (collector ${collector_id}): `
 +`HTTP ${res.status} ${res.body.slice(0, 200)}`
 );
 process.exit(1);
 +`HTTP ${res.status} ${res.body.slice(0, 200)}`,
 opts);
 return;
 }
 const data = parse_result_body(res.body);
Expand All@@ -1190,18 +1224,17 @@ const handle_run_scraper = async(
 return;
 } catch(e) {
 spinner.stop();
console.error(
run_fail(
 `Failed to scrape (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 }
 let timeout = 600;
 try {
 timeout = parse_timeout(opts.timeout);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 const trigger_spinner = start_spinner('Triggering scrape...');
Expand All@@ -1217,20 +1250,18 @@ const handle_run_scraper = async(
 trigger_spinner.stop();
 if (!trigger.response_id)
 {
console.error(
run_fail(
 `Failed to trigger scraper (collector ${collector_id}): `
 +'missing response_id in trigger response.');
 process.exit(1);
 +'missing response_id in trigger response.', opts);
 return;
 }
 response_id = trigger.response_id;
 console.error(dim(`Triggered (response_id: ${response_id})`));
 } catch(e) {
 trigger_spinner.stop();
console.error(
run_fail(
 `Failed to trigger scraper (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 const poll_spinner = start_spinner('Waiting for results...');
Expand DownExpand Up@@ -1263,8 +1294,7 @@ const handle_run_scraper = async(
 const msg = (e as Error).message;
 const suffix = msg.includes(response_id)
 ? '' : ` (response_id ${response_id})`;
 console.error(`${msg}${suffix}`);
 process.exit(1);
 run_fail(`${msg}${suffix}`, opts);
 return;
 }
};
Expand DownExpand Up@@ -1475,6 +1505,7 @@ export {
 build_create_envelope,
 emit_create_output,
 handle_run_scraper,
 format_run_error,
 build_run_request,
 build_run_query,
 classify_result,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(scraper): emit JSON errors from run under --json / --pretty#18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

danishashko
wants to merge
1
commit into

base:main
Choose a base branch

from

 Open


fix(scraper): emit JSON errors from run under --json / --pretty
#18
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


50 changes: 33 additions & 17 deletions
src/__tests__/commands/scraper.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,6 +88,7 @@ import {
 format_heal_summary,
 resume_and_poll,
 handle_approve_scraper,
 format_run_error,
} from '../../commands/scraper';

describe('commands/scraper', ()=>{
Expand DownExpand Up@@ -771,16 +772,11 @@ describe('commands/scraper', ()=>{

 it('exits when trigger returns no response_id', async()=>{
 mocks.post.mockResolvedValueOnce({});
 const exit = vi.spyOn(process, 'exit')
 .mockImplementation(()=>undefined as never);
 const error = vi.spyOn(console, 'error')
 .mockImplementation(()=>{});
 await handle_run_scraper('c_abc', 'https://x.com', {});
 const msg = error.mock.calls.map(c=>String(c[0])).join('\n');
 await expect(handle_run_scraper('c_abc', 'https://x.com', {}))
 .rejects.toThrow();
 const msg = String(mocks.fail.mock.calls[0][0]);
 expect(msg).toContain('response_id');
 expect(msg).toContain('c_abc');
 exit.mockRestore();
 error.mockRestore();
 });
 });

Expand DownExpand Up@@ -820,17 +816,11 @@ describe('commands/scraper', ()=>{
 stub_fetch(202,
 JSON.stringify({error: 'crawl_results_timeout',
 response_id: 'r_late'}));
 const exit = vi.spyOn(process, 'exit')
 .mockImplementation(()=>undefined as never);
 const error = vi.spyOn(console, 'error')
 .mockImplementation(()=>{});
 await handle_run_scraper('c_abc', 'https://x.com',
 {sync: true});
 const msg = error.mock.calls.map(c=>String(c[0])).join('\n');
 await expect(handle_run_scraper('c_abc', 'https://x.com',
 {sync: true})).rejects.toThrow();
 const msg = String(mocks.fail.mock.calls[0][0]);
 expect(msg).toContain('r_late');
 expect(msg).toContain('Re-run without --sync');
 exit.mockRestore();
 error.mockRestore();
 });

 it('honors --sync-timeout', async()=>{
Expand DownExpand Up@@ -2195,3 +2185,29 @@ describe('commands/scraper', ()=>{
 });
 });
});

describe('format_run_error', ()=>{
 it('returns the raw message (no JSON) when no machine format is set',
 ()=>{
 expect(format_run_error('boom', {})).toEqual(
 {json: false, text: 'boom'});
 });

 it('returns a compact JSON error object under --json', ()=>{
 expect(format_run_error('boom', {json: true})).toEqual(
 {json: true, text: '{"error":"boom"}'});
 });

 it('strips the "Error:" prefix and extra lines in the JSON payload',
 ()=>{
 expect(format_run_error('Error: bad thing\nstack', {json: true}))
 .toEqual({json: true, text: '{"error":"bad thing"}'});
 });

 it('pretty-prints the JSON error under --pretty', ()=>{
 expect(format_run_error('boom', {pretty: true})).toEqual({
 json: true,
 text: JSON.stringify({error: 'boom'}, null, 2),
 });
 });
});

97 changes: 64 additions & 33 deletions
src/commands/scraper.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -231,6 +231,44 @@ const format_create_summary = (
const clean_error_message = (msg: string): string=>
 msg.split('\n')[0].replace(/^Error:\s*/, '').trim();

// Error output for the `run` command. When the caller asked for machine
// output (--json / --pretty), a failed run must return a parseable error
// object on stdout, not a plain-text line on stderr, so an agent reading
// stdout still gets something it can JSON.parse. Without those flags the
// behaviour (a red line on stderr) is unchanged.
const format_run_error = (
 msg: string,
 opts: {json?: boolean; pretty?: boolean}
): {json: boolean; text: string}=>{
 if (opts.json || opts.pretty)
 {
 const payload = {error: clean_error_message(msg)};
 return {
 json: true,
 text: opts.pretty
 ? JSON.stringify(payload, null, 2)
 : JSON.stringify(payload),
 };
 }
 return {json: false, text: msg};
};

const run_fail = (
 msg: string,
 opts: {json?: boolean; pretty?: boolean}
): void=>{
 const out = format_run_error(msg, opts);
 if (out.json)
 {
 process.stdout.write(out.text+'\n');
 process.exit(1);
 return;
 }
 // Non-machine output: reuse the shared fail() (red ✗ line on stderr +
 // exit 1), so every run error is formatted consistently.
 fail(out.text);
};

const build_create_envelope = (params: {
 collector_id: string;
 name: string;
Expand DownExpand Up@@ -1033,7 +1071,7 @@ const run_batch = async(
 try {
 timeout = parse_timeout(timeout_raw);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 if (reason == 'page_limit_fallback')
Expand All@@ -1060,10 +1098,9 @@ const run_batch = async(
 trigger_spinner.stop();
 if (!trigger.collection_id)
 {
console.error(
run_fail(
 `Failed to submit batch job (collector ${collector_id}): `
 +'missing collection_id.');
 process.exit(1);
 +'missing collection_id.', opts);
 return;
 }
 collection_id = trigger.collection_id;
Expand All@@ -1073,10 +1110,9 @@ const run_batch = async(
 `Batch job: ${collection_id}${eta}`));
 } catch(e) {
 trigger_spinner.stop();
console.error(
run_fail(
 `Failed to submit batch job (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 const poll_spinner = start_spinner('Collecting (batch)...');
Expand DownExpand Up@@ -1105,8 +1141,7 @@ const run_batch = async(
 const msg = (e as Error).message;
 const suffix = msg.includes(collection_id)
 ? '' : ` (collection_id ${collection_id})`;
 console.error(`${msg}${suffix}`);
 process.exit(1);
 run_fail(`${msg}${suffix}`, opts);
 return;
 }
};
Expand All@@ -1121,17 +1156,18 @@ const handle_run_scraper = async(
 try {
 urls = resolve_run_inputs(url, opts);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 if (urls.length > 1)
 {
 if (opts.sync)
 {
fail(
run_fail(
 '--sync cannot be combined with --urls / --input-file. '
 +'The /dca/crawl endpoint accepts only a single URL. '
 +'Drop --sync to use the batch endpoint (/dca/trigger).');
 +'Drop --sync to use the batch endpoint (/dca/trigger).',
 opts);
 return;
 }
 await run_batch(api_key, collector_id, urls, opts, 'multi_url');
Expand All@@ -1144,7 +1180,7 @@ const handle_run_scraper = async(
 try {
 sync_timeout = parse_sync_timeout(opts.syncTimeout);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 const query = build_run_query(collector_id, opts,
Expand All@@ -1162,21 +1198,19 @@ const handle_run_scraper = async(
 const parsed = parse_result_body(res.body) as
 {response_id?: string; message?: string};
 const rid = parsed?.response_id ?? '<unknown>';
console.error(
run_fail(
 `Sync request timed out server-side after `
 +`${sync_timeout}s (response_id: ${rid}). `
 +'Re-run without --sync to poll for results.'
 );
 process.exit(1);
 +'Re-run without --sync to poll for results.',
 opts);
 return;
 }
 if (res.status < 200 || res.status >= 300)
 {
console.error(
run_fail(
 `Failed to scrape (collector ${collector_id}): `
 +`HTTP ${res.status} ${res.body.slice(0, 200)}`
 );
 process.exit(1);
 +`HTTP ${res.status} ${res.body.slice(0, 200)}`,
 opts);
 return;
 }
 const data = parse_result_body(res.body);
Expand All@@ -1190,18 +1224,17 @@ const handle_run_scraper = async(
 return;
 } catch(e) {
 spinner.stop();
console.error(
run_fail(
 `Failed to scrape (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 }
 let timeout = 600;
 try {
 timeout = parse_timeout(opts.timeout);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 const trigger_spinner = start_spinner('Triggering scrape...');
Expand All@@ -1217,20 +1250,18 @@ const handle_run_scraper = async(
 trigger_spinner.stop();
 if (!trigger.response_id)
 {
console.error(
run_fail(
 `Failed to trigger scraper (collector ${collector_id}): `
 +'missing response_id in trigger response.');
 process.exit(1);
 +'missing response_id in trigger response.', opts);
 return;
 }
 response_id = trigger.response_id;
 console.error(dim(`Triggered (response_id: ${response_id})`));
 } catch(e) {
 trigger_spinner.stop();
console.error(
run_fail(
 `Failed to trigger scraper (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 const poll_spinner = start_spinner('Waiting for results...');
Expand DownExpand Up@@ -1263,8 +1294,7 @@ const handle_run_scraper = async(
 const msg = (e as Error).message;
 const suffix = msg.includes(response_id)
 ? '' : ` (response_id ${response_id})`;
 console.error(`${msg}${suffix}`);
 process.exit(1);
 run_fail(`${msg}${suffix}`, opts);
 return;
 }
};
Expand DownExpand Up@@ -1475,6 +1505,7 @@ export {
 build_create_envelope,
 emit_create_output,
 handle_run_scraper,
 format_run_error,
 build_run_request,
 build_run_query,
 classify_result,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(scraper): emit JSON errors from run under --json / --pretty#18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

danishashko
wants to merge
1
commit into

base:main
Choose a base branch

from

 Open


fix(scraper): emit JSON errors from run under --json / --pretty
#18
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


50 changes: 33 additions & 17 deletions
src/__tests__/commands/scraper.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,6 +88,7 @@ import {
 format_heal_summary,
 resume_and_poll,
 handle_approve_scraper,
 format_run_error,
} from '../../commands/scraper';

describe('commands/scraper', ()=>{
Expand DownExpand Up@@ -771,16 +772,11 @@ describe('commands/scraper', ()=>{

 it('exits when trigger returns no response_id', async()=>{
 mocks.post.mockResolvedValueOnce({});
 const exit = vi.spyOn(process, 'exit')
 .mockImplementation(()=>undefined as never);
 const error = vi.spyOn(console, 'error')
 .mockImplementation(()=>{});
 await handle_run_scraper('c_abc', 'https://x.com', {});
 const msg = error.mock.calls.map(c=>String(c[0])).join('\n');
 await expect(handle_run_scraper('c_abc', 'https://x.com', {}))
 .rejects.toThrow();
 const msg = String(mocks.fail.mock.calls[0][0]);
 expect(msg).toContain('response_id');
 expect(msg).toContain('c_abc');
 exit.mockRestore();
 error.mockRestore();
 });
 });

Expand DownExpand Up@@ -820,17 +816,11 @@ describe('commands/scraper', ()=>{
 stub_fetch(202,
 JSON.stringify({error: 'crawl_results_timeout',
 response_id: 'r_late'}));
 const exit = vi.spyOn(process, 'exit')
 .mockImplementation(()=>undefined as never);
 const error = vi.spyOn(console, 'error')
 .mockImplementation(()=>{});
 await handle_run_scraper('c_abc', 'https://x.com',
 {sync: true});
 const msg = error.mock.calls.map(c=>String(c[0])).join('\n');
 await expect(handle_run_scraper('c_abc', 'https://x.com',
 {sync: true})).rejects.toThrow();
 const msg = String(mocks.fail.mock.calls[0][0]);
 expect(msg).toContain('r_late');
 expect(msg).toContain('Re-run without --sync');
 exit.mockRestore();
 error.mockRestore();
 });

 it('honors --sync-timeout', async()=>{
Expand DownExpand Up@@ -2195,3 +2185,29 @@ describe('commands/scraper', ()=>{
 });
 });
});

describe('format_run_error', ()=>{
 it('returns the raw message (no JSON) when no machine format is set',
 ()=>{
 expect(format_run_error('boom', {})).toEqual(
 {json: false, text: 'boom'});
 });

 it('returns a compact JSON error object under --json', ()=>{
 expect(format_run_error('boom', {json: true})).toEqual(
 {json: true, text: '{"error":"boom"}'});
 });

 it('strips the "Error:" prefix and extra lines in the JSON payload',
 ()=>{
 expect(format_run_error('Error: bad thing\nstack', {json: true}))
 .toEqual({json: true, text: '{"error":"bad thing"}'});
 });

 it('pretty-prints the JSON error under --pretty', ()=>{
 expect(format_run_error('boom', {pretty: true})).toEqual({
 json: true,
 text: JSON.stringify({error: 'boom'}, null, 2),
 });
 });
});

97 changes: 64 additions & 33 deletions
src/commands/scraper.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -231,6 +231,44 @@ const format_create_summary = (
const clean_error_message = (msg: string): string=>
 msg.split('\n')[0].replace(/^Error:\s*/, '').trim();

// Error output for the `run` command. When the caller asked for machine
// output (--json / --pretty), a failed run must return a parseable error
// object on stdout, not a plain-text line on stderr, so an agent reading
// stdout still gets something it can JSON.parse. Without those flags the
// behaviour (a red line on stderr) is unchanged.
const format_run_error = (
 msg: string,
 opts: {json?: boolean; pretty?: boolean}
): {json: boolean; text: string}=>{
 if (opts.json || opts.pretty)
 {
 const payload = {error: clean_error_message(msg)};
 return {
 json: true,
 text: opts.pretty
 ? JSON.stringify(payload, null, 2)
 : JSON.stringify(payload),
 };
 }
 return {json: false, text: msg};
};

const run_fail = (
 msg: string,
 opts: {json?: boolean; pretty?: boolean}
): void=>{
 const out = format_run_error(msg, opts);
 if (out.json)
 {
 process.stdout.write(out.text+'\n');
 process.exit(1);
 return;
 }
 // Non-machine output: reuse the shared fail() (red ✗ line on stderr +
 // exit 1), so every run error is formatted consistently.
 fail(out.text);
};

const build_create_envelope = (params: {
 collector_id: string;
 name: string;
Expand DownExpand Up@@ -1033,7 +1071,7 @@ const run_batch = async(
 try {
 timeout = parse_timeout(timeout_raw);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 if (reason == 'page_limit_fallback')
Expand All@@ -1060,10 +1098,9 @@ const run_batch = async(
 trigger_spinner.stop();
 if (!trigger.collection_id)
 {
console.error(
run_fail(
 `Failed to submit batch job (collector ${collector_id}): `
 +'missing collection_id.');
 process.exit(1);
 +'missing collection_id.', opts);
 return;
 }
 collection_id = trigger.collection_id;
Expand All@@ -1073,10 +1110,9 @@ const run_batch = async(
 `Batch job: ${collection_id}${eta}`));
 } catch(e) {
 trigger_spinner.stop();
console.error(
run_fail(
 `Failed to submit batch job (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 const poll_spinner = start_spinner('Collecting (batch)...');
Expand DownExpand Up@@ -1105,8 +1141,7 @@ const run_batch = async(
 const msg = (e as Error).message;
 const suffix = msg.includes(collection_id)
 ? '' : ` (collection_id ${collection_id})`;
 console.error(`${msg}${suffix}`);
 process.exit(1);
 run_fail(`${msg}${suffix}`, opts);
 return;
 }
};
Expand All@@ -1121,17 +1156,18 @@ const handle_run_scraper = async(
 try {
 urls = resolve_run_inputs(url, opts);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 if (urls.length > 1)
 {
 if (opts.sync)
 {
fail(
run_fail(
 '--sync cannot be combined with --urls / --input-file. '
 +'The /dca/crawl endpoint accepts only a single URL. '
 +'Drop --sync to use the batch endpoint (/dca/trigger).');
 +'Drop --sync to use the batch endpoint (/dca/trigger).',
 opts);
 return;
 }
 await run_batch(api_key, collector_id, urls, opts, 'multi_url');
Expand All@@ -1144,7 +1180,7 @@ const handle_run_scraper = async(
 try {
 sync_timeout = parse_sync_timeout(opts.syncTimeout);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 const query = build_run_query(collector_id, opts,
Expand All@@ -1162,21 +1198,19 @@ const handle_run_scraper = async(
 const parsed = parse_result_body(res.body) as
 {response_id?: string; message?: string};
 const rid = parsed?.response_id ?? '<unknown>';
console.error(
run_fail(
 `Sync request timed out server-side after `
 +`${sync_timeout}s (response_id: ${rid}). `
 +'Re-run without --sync to poll for results.'
 );
 process.exit(1);
 +'Re-run without --sync to poll for results.',
 opts);
 return;
 }
 if (res.status < 200 || res.status >= 300)
 {
console.error(
run_fail(
 `Failed to scrape (collector ${collector_id}): `
 +`HTTP ${res.status} ${res.body.slice(0, 200)}`
 );
 process.exit(1);
 +`HTTP ${res.status} ${res.body.slice(0, 200)}`,
 opts);
 return;
 }
 const data = parse_result_body(res.body);
Expand All@@ -1190,18 +1224,17 @@ const handle_run_scraper = async(
 return;
 } catch(e) {
 spinner.stop();
console.error(
run_fail(
 `Failed to scrape (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 }
 let timeout = 600;
 try {
 timeout = parse_timeout(opts.timeout);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 const trigger_spinner = start_spinner('Triggering scrape...');
Expand All@@ -1217,20 +1250,18 @@ const handle_run_scraper = async(
 trigger_spinner.stop();
 if (!trigger.response_id)
 {
console.error(
run_fail(
 `Failed to trigger scraper (collector ${collector_id}): `
 +'missing response_id in trigger response.');
 process.exit(1);
 +'missing response_id in trigger response.', opts);
 return;
 }
 response_id = trigger.response_id;
 console.error(dim(`Triggered (response_id: ${response_id})`));
 } catch(e) {
 trigger_spinner.stop();
console.error(
run_fail(
 `Failed to trigger scraper (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 const poll_spinner = start_spinner('Waiting for results...');
Expand DownExpand Up@@ -1263,8 +1294,7 @@ const handle_run_scraper = async(
 const msg = (e as Error).message;
 const suffix = msg.includes(response_id)
 ? '' : ` (response_id ${response_id})`;
 console.error(`${msg}${suffix}`);
 process.exit(1);
 run_fail(`${msg}${suffix}`, opts);
 return;
 }
};
Expand DownExpand Up@@ -1475,6 +1505,7 @@ export {
 build_create_envelope,
 emit_create_output,
 handle_run_scraper,
 format_run_error,
 build_run_request,
 build_run_query,
 classify_result,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix(scraper): emit JSON errors from run under --json / --pretty#18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

danishashko
wants to merge
1
commit into

base:main
Choose a base branch

from

 Open


fix(scraper): emit JSON errors from run under --json / --pretty
#18
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


50 changes: 33 additions & 17 deletions
src/__tests__/commands/scraper.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,6 +88,7 @@ import {
 format_heal_summary,
 resume_and_poll,
 handle_approve_scraper,
 format_run_error,
} from '../../commands/scraper';

describe('commands/scraper', ()=>{
Expand DownExpand Up@@ -771,16 +772,11 @@ describe('commands/scraper', ()=>{

 it('exits when trigger returns no response_id', async()=>{
 mocks.post.mockResolvedValueOnce({});
 const exit = vi.spyOn(process, 'exit')
 .mockImplementation(()=>undefined as never);
 const error = vi.spyOn(console, 'error')
 .mockImplementation(()=>{});
 await handle_run_scraper('c_abc', 'https://x.com', {});
 const msg = error.mock.calls.map(c=>String(c[0])).join('\n');
 await expect(handle_run_scraper('c_abc', 'https://x.com', {}))
 .rejects.toThrow();
 const msg = String(mocks.fail.mock.calls[0][0]);
 expect(msg).toContain('response_id');
 expect(msg).toContain('c_abc');
 exit.mockRestore();
 error.mockRestore();
 });
 });

Expand DownExpand Up@@ -820,17 +816,11 @@ describe('commands/scraper', ()=>{
 stub_fetch(202,
 JSON.stringify({error: 'crawl_results_timeout',
 response_id: 'r_late'}));
 const exit = vi.spyOn(process, 'exit')
 .mockImplementation(()=>undefined as never);
 const error = vi.spyOn(console, 'error')
 .mockImplementation(()=>{});
 await handle_run_scraper('c_abc', 'https://x.com',
 {sync: true});
 const msg = error.mock.calls.map(c=>String(c[0])).join('\n');
 await expect(handle_run_scraper('c_abc', 'https://x.com',
 {sync: true})).rejects.toThrow();
 const msg = String(mocks.fail.mock.calls[0][0]);
 expect(msg).toContain('r_late');
 expect(msg).toContain('Re-run without --sync');
 exit.mockRestore();
 error.mockRestore();
 });

 it('honors --sync-timeout', async()=>{
Expand DownExpand Up@@ -2195,3 +2185,29 @@ describe('commands/scraper', ()=>{
 });
 });
});

describe('format_run_error', ()=>{
 it('returns the raw message (no JSON) when no machine format is set',
 ()=>{
 expect(format_run_error('boom', {})).toEqual(
 {json: false, text: 'boom'});
 });

 it('returns a compact JSON error object under --json', ()=>{
 expect(format_run_error('boom', {json: true})).toEqual(
 {json: true, text: '{"error":"boom"}'});
 });

 it('strips the "Error:" prefix and extra lines in the JSON payload',
 ()=>{
 expect(format_run_error('Error: bad thing\nstack', {json: true}))
 .toEqual({json: true, text: '{"error":"bad thing"}'});
 });

 it('pretty-prints the JSON error under --pretty', ()=>{
 expect(format_run_error('boom', {pretty: true})).toEqual({
 json: true,
 text: JSON.stringify({error: 'boom'}, null, 2),
 });
 });
});

97 changes: 64 additions & 33 deletions
src/commands/scraper.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -231,6 +231,44 @@ const format_create_summary = (
const clean_error_message = (msg: string): string=>
 msg.split('\n')[0].replace(/^Error:\s*/, '').trim();

// Error output for the `run` command. When the caller asked for machine
// output (--json / --pretty), a failed run must return a parseable error
// object on stdout, not a plain-text line on stderr, so an agent reading
// stdout still gets something it can JSON.parse. Without those flags the
// behaviour (a red line on stderr) is unchanged.
const format_run_error = (
 msg: string,
 opts: {json?: boolean; pretty?: boolean}
): {json: boolean; text: string}=>{
 if (opts.json || opts.pretty)
 {
 const payload = {error: clean_error_message(msg)};
 return {
 json: true,
 text: opts.pretty
 ? JSON.stringify(payload, null, 2)
 : JSON.stringify(payload),
 };
 }
 return {json: false, text: msg};
};

const run_fail = (
 msg: string,
 opts: {json?: boolean; pretty?: boolean}
): void=>{
 const out = format_run_error(msg, opts);
 if (out.json)
 {
 process.stdout.write(out.text+'\n');
 process.exit(1);
 return;
 }
 // Non-machine output: reuse the shared fail() (red ✗ line on stderr +
 // exit 1), so every run error is formatted consistently.
 fail(out.text);
};

const build_create_envelope = (params: {
 collector_id: string;
 name: string;
Expand DownExpand Up@@ -1033,7 +1071,7 @@ const run_batch = async(
 try {
 timeout = parse_timeout(timeout_raw);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 if (reason == 'page_limit_fallback')
Expand All@@ -1060,10 +1098,9 @@ const run_batch = async(
 trigger_spinner.stop();
 if (!trigger.collection_id)
 {
console.error(
run_fail(
 `Failed to submit batch job (collector ${collector_id}): `
 +'missing collection_id.');
 process.exit(1);
 +'missing collection_id.', opts);
 return;
 }
 collection_id = trigger.collection_id;
Expand All@@ -1073,10 +1110,9 @@ const run_batch = async(
 `Batch job: ${collection_id}${eta}`));
 } catch(e) {
 trigger_spinner.stop();
console.error(
run_fail(
 `Failed to submit batch job (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 const poll_spinner = start_spinner('Collecting (batch)...');
Expand DownExpand Up@@ -1105,8 +1141,7 @@ const run_batch = async(
 const msg = (e as Error).message;
 const suffix = msg.includes(collection_id)
 ? '' : ` (collection_id ${collection_id})`;
 console.error(`${msg}${suffix}`);
 process.exit(1);
 run_fail(`${msg}${suffix}`, opts);
 return;
 }
};
Expand All@@ -1121,17 +1156,18 @@ const handle_run_scraper = async(
 try {
 urls = resolve_run_inputs(url, opts);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 if (urls.length > 1)
 {
 if (opts.sync)
 {
fail(
run_fail(
 '--sync cannot be combined with --urls / --input-file. '
 +'The /dca/crawl endpoint accepts only a single URL. '
 +'Drop --sync to use the batch endpoint (/dca/trigger).');
 +'Drop --sync to use the batch endpoint (/dca/trigger).',
 opts);
 return;
 }
 await run_batch(api_key, collector_id, urls, opts, 'multi_url');
Expand All@@ -1144,7 +1180,7 @@ const handle_run_scraper = async(
 try {
 sync_timeout = parse_sync_timeout(opts.syncTimeout);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 const query = build_run_query(collector_id, opts,
Expand All@@ -1162,21 +1198,19 @@ const handle_run_scraper = async(
 const parsed = parse_result_body(res.body) as
 {response_id?: string; message?: string};
 const rid = parsed?.response_id ?? '<unknown>';
console.error(
run_fail(
 `Sync request timed out server-side after `
 +`${sync_timeout}s (response_id: ${rid}). `
 +'Re-run without --sync to poll for results.'
 );
 process.exit(1);
 +'Re-run without --sync to poll for results.',
 opts);
 return;
 }
 if (res.status < 200 || res.status >= 300)
 {
console.error(
run_fail(
 `Failed to scrape (collector ${collector_id}): `
 +`HTTP ${res.status} ${res.body.slice(0, 200)}`
 );
 process.exit(1);
 +`HTTP ${res.status} ${res.body.slice(0, 200)}`,
 opts);
 return;
 }
 const data = parse_result_body(res.body);
Expand All@@ -1190,18 +1224,17 @@ const handle_run_scraper = async(
 return;
 } catch(e) {
 spinner.stop();
console.error(
run_fail(
 `Failed to scrape (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 }
 let timeout = 600;
 try {
 timeout = parse_timeout(opts.timeout);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 const trigger_spinner = start_spinner('Triggering scrape...');
Expand All@@ -1217,20 +1250,18 @@ const handle_run_scraper = async(
 trigger_spinner.stop();
 if (!trigger.response_id)
 {
console.error(
run_fail(
 `Failed to trigger scraper (collector ${collector_id}): `
 +'missing response_id in trigger response.');
 process.exit(1);
 +'missing response_id in trigger response.', opts);
 return;
 }
 response_id = trigger.response_id;
 console.error(dim(`Triggered (response_id: ${response_id})`));
 } catch(e) {
 trigger_spinner.stop();
console.error(
run_fail(
 `Failed to trigger scraper (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 const poll_spinner = start_spinner('Waiting for results...');
Expand DownExpand Up@@ -1263,8 +1294,7 @@ const handle_run_scraper = async(
 const msg = (e as Error).message;
 const suffix = msg.includes(response_id)
 ? '' : ` (response_id ${response_id})`;
 console.error(`${msg}${suffix}`);
 process.exit(1);
 run_fail(`${msg}${suffix}`, opts);
 return;
 }
};
Expand DownExpand Up@@ -1475,6 +1505,7 @@ export {
 build_create_envelope,
 emit_create_output,
 handle_run_scraper,
 format_run_error,
 build_run_request,
 build_run_query,
 classify_result,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(scraper): emit JSON errors from run under --json / --pretty#18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

danishashko
wants to merge
1
commit into

base:main
Choose a base branch

from

 Open


fix(scraper): emit JSON errors from run under --json / --pretty
#18
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


50 changes: 33 additions & 17 deletions
src/__tests__/commands/scraper.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,6 +88,7 @@ import {
 format_heal_summary,
 resume_and_poll,
 handle_approve_scraper,
 format_run_error,
} from '../../commands/scraper';

describe('commands/scraper', ()=>{
Expand DownExpand Up@@ -771,16 +772,11 @@ describe('commands/scraper', ()=>{

 it('exits when trigger returns no response_id', async()=>{
 mocks.post.mockResolvedValueOnce({});
 const exit = vi.spyOn(process, 'exit')
 .mockImplementation(()=>undefined as never);
 const error = vi.spyOn(console, 'error')
 .mockImplementation(()=>{});
 await handle_run_scraper('c_abc', 'https://x.com', {});
 const msg = error.mock.calls.map(c=>String(c[0])).join('\n');
 await expect(handle_run_scraper('c_abc', 'https://x.com', {}))
 .rejects.toThrow();
 const msg = String(mocks.fail.mock.calls[0][0]);
 expect(msg).toContain('response_id');
 expect(msg).toContain('c_abc');
 exit.mockRestore();
 error.mockRestore();
 });
 });

Expand DownExpand Up@@ -820,17 +816,11 @@ describe('commands/scraper', ()=>{
 stub_fetch(202,
 JSON.stringify({error: 'crawl_results_timeout',
 response_id: 'r_late'}));
 const exit = vi.spyOn(process, 'exit')
 .mockImplementation(()=>undefined as never);
 const error = vi.spyOn(console, 'error')
 .mockImplementation(()=>{});
 await handle_run_scraper('c_abc', 'https://x.com',
 {sync: true});
 const msg = error.mock.calls.map(c=>String(c[0])).join('\n');
 await expect(handle_run_scraper('c_abc', 'https://x.com',
 {sync: true})).rejects.toThrow();
 const msg = String(mocks.fail.mock.calls[0][0]);
 expect(msg).toContain('r_late');
 expect(msg).toContain('Re-run without --sync');
 exit.mockRestore();
 error.mockRestore();
 });

 it('honors --sync-timeout', async()=>{
Expand DownExpand Up@@ -2195,3 +2185,29 @@ describe('commands/scraper', ()=>{
 });
 });
});

describe('format_run_error', ()=>{
 it('returns the raw message (no JSON) when no machine format is set',
 ()=>{
 expect(format_run_error('boom', {})).toEqual(
 {json: false, text: 'boom'});
 });

 it('returns a compact JSON error object under --json', ()=>{
 expect(format_run_error('boom', {json: true})).toEqual(
 {json: true, text: '{"error":"boom"}'});
 });

 it('strips the "Error:" prefix and extra lines in the JSON payload',
 ()=>{
 expect(format_run_error('Error: bad thing\nstack', {json: true}))
 .toEqual({json: true, text: '{"error":"bad thing"}'});
 });

 it('pretty-prints the JSON error under --pretty', ()=>{
 expect(format_run_error('boom', {pretty: true})).toEqual({
 json: true,
 text: JSON.stringify({error: 'boom'}, null, 2),
 });
 });
});

97 changes: 64 additions & 33 deletions
src/commands/scraper.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -231,6 +231,44 @@ const format_create_summary = (
const clean_error_message = (msg: string): string=>
 msg.split('\n')[0].replace(/^Error:\s*/, '').trim();

// Error output for the `run` command. When the caller asked for machine
// output (--json / --pretty), a failed run must return a parseable error
// object on stdout, not a plain-text line on stderr, so an agent reading
// stdout still gets something it can JSON.parse. Without those flags the
// behaviour (a red line on stderr) is unchanged.
const format_run_error = (
 msg: string,
 opts: {json?: boolean; pretty?: boolean}
): {json: boolean; text: string}=>{
 if (opts.json || opts.pretty)
 {
 const payload = {error: clean_error_message(msg)};
 return {
 json: true,
 text: opts.pretty
 ? JSON.stringify(payload, null, 2)
 : JSON.stringify(payload),
 };
 }
 return {json: false, text: msg};
};

const run_fail = (
 msg: string,
 opts: {json?: boolean; pretty?: boolean}
): void=>{
 const out = format_run_error(msg, opts);
 if (out.json)
 {
 process.stdout.write(out.text+'\n');
 process.exit(1);
 return;
 }
 // Non-machine output: reuse the shared fail() (red ✗ line on stderr +
 // exit 1), so every run error is formatted consistently.
 fail(out.text);
};

const build_create_envelope = (params: {
 collector_id: string;
 name: string;
Expand DownExpand Up@@ -1033,7 +1071,7 @@ const run_batch = async(
 try {
 timeout = parse_timeout(timeout_raw);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 if (reason == 'page_limit_fallback')
Expand All@@ -1060,10 +1098,9 @@ const run_batch = async(
 trigger_spinner.stop();
 if (!trigger.collection_id)
 {
console.error(
run_fail(
 `Failed to submit batch job (collector ${collector_id}): `
 +'missing collection_id.');
 process.exit(1);
 +'missing collection_id.', opts);
 return;
 }
 collection_id = trigger.collection_id;
Expand All@@ -1073,10 +1110,9 @@ const run_batch = async(
 `Batch job: ${collection_id}${eta}`));
 } catch(e) {
 trigger_spinner.stop();
console.error(
run_fail(
 `Failed to submit batch job (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 const poll_spinner = start_spinner('Collecting (batch)...');
Expand DownExpand Up@@ -1105,8 +1141,7 @@ const run_batch = async(
 const msg = (e as Error).message;
 const suffix = msg.includes(collection_id)
 ? '' : ` (collection_id ${collection_id})`;
 console.error(`${msg}${suffix}`);
 process.exit(1);
 run_fail(`${msg}${suffix}`, opts);
 return;
 }
};
Expand All@@ -1121,17 +1156,18 @@ const handle_run_scraper = async(
 try {
 urls = resolve_run_inputs(url, opts);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 if (urls.length > 1)
 {
 if (opts.sync)
 {
fail(
run_fail(
 '--sync cannot be combined with --urls / --input-file. '
 +'The /dca/crawl endpoint accepts only a single URL. '
 +'Drop --sync to use the batch endpoint (/dca/trigger).');
 +'Drop --sync to use the batch endpoint (/dca/trigger).',
 opts);
 return;
 }
 await run_batch(api_key, collector_id, urls, opts, 'multi_url');
Expand All@@ -1144,7 +1180,7 @@ const handle_run_scraper = async(
 try {
 sync_timeout = parse_sync_timeout(opts.syncTimeout);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 const query = build_run_query(collector_id, opts,
Expand All@@ -1162,21 +1198,19 @@ const handle_run_scraper = async(
 const parsed = parse_result_body(res.body) as
 {response_id?: string; message?: string};
 const rid = parsed?.response_id ?? '<unknown>';
console.error(
run_fail(
 `Sync request timed out server-side after `
 +`${sync_timeout}s (response_id: ${rid}). `
 +'Re-run without --sync to poll for results.'
 );
 process.exit(1);
 +'Re-run without --sync to poll for results.',
 opts);
 return;
 }
 if (res.status < 200 || res.status >= 300)
 {
console.error(
run_fail(
 `Failed to scrape (collector ${collector_id}): `
 +`HTTP ${res.status} ${res.body.slice(0, 200)}`
 );
 process.exit(1);
 +`HTTP ${res.status} ${res.body.slice(0, 200)}`,
 opts);
 return;
 }
 const data = parse_result_body(res.body);
Expand All@@ -1190,18 +1224,17 @@ const handle_run_scraper = async(
 return;
 } catch(e) {
 spinner.stop();
console.error(
run_fail(
 `Failed to scrape (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 }
 let timeout = 600;
 try {
 timeout = parse_timeout(opts.timeout);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 const trigger_spinner = start_spinner('Triggering scrape...');
Expand All@@ -1217,20 +1250,18 @@ const handle_run_scraper = async(
 trigger_spinner.stop();
 if (!trigger.response_id)
 {
console.error(
run_fail(
 `Failed to trigger scraper (collector ${collector_id}): `
 +'missing response_id in trigger response.');
 process.exit(1);
 +'missing response_id in trigger response.', opts);
 return;
 }
 response_id = trigger.response_id;
 console.error(dim(`Triggered (response_id: ${response_id})`));
 } catch(e) {
 trigger_spinner.stop();
console.error(
run_fail(
 `Failed to trigger scraper (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 const poll_spinner = start_spinner('Waiting for results...');
Expand DownExpand Up@@ -1263,8 +1294,7 @@ const handle_run_scraper = async(
 const msg = (e as Error).message;
 const suffix = msg.includes(response_id)
 ? '' : ` (response_id ${response_id})`;
 console.error(`${msg}${suffix}`);
 process.exit(1);
 run_fail(`${msg}${suffix}`, opts);
 return;
 }
};
Expand DownExpand Up@@ -1475,6 +1505,7 @@ export {
 build_create_envelope,
 emit_create_output,
 handle_run_scraper,
 format_run_error,
 build_run_request,
 build_run_query,
 classify_result,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(scraper): emit JSON errors from run under --json / --pretty#18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

danishashko
wants to merge
1
commit into

base:main
Choose a base branch

from

 Open


fix(scraper): emit JSON errors from run under --json / --pretty
#18
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


50 changes: 33 additions & 17 deletions
src/__tests__/commands/scraper.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,6 +88,7 @@ import {
 format_heal_summary,
 resume_and_poll,
 handle_approve_scraper,
 format_run_error,
} from '../../commands/scraper';

describe('commands/scraper', ()=>{
Expand DownExpand Up@@ -771,16 +772,11 @@ describe('commands/scraper', ()=>{

 it('exits when trigger returns no response_id', async()=>{
 mocks.post.mockResolvedValueOnce({});
 const exit = vi.spyOn(process, 'exit')
 .mockImplementation(()=>undefined as never);
 const error = vi.spyOn(console, 'error')
 .mockImplementation(()=>{});
 await handle_run_scraper('c_abc', 'https://x.com', {});
 const msg = error.mock.calls.map(c=>String(c[0])).join('\n');
 await expect(handle_run_scraper('c_abc', 'https://x.com', {}))
 .rejects.toThrow();
 const msg = String(mocks.fail.mock.calls[0][0]);
 expect(msg).toContain('response_id');
 expect(msg).toContain('c_abc');
 exit.mockRestore();
 error.mockRestore();
 });
 });

Expand DownExpand Up@@ -820,17 +816,11 @@ describe('commands/scraper', ()=>{
 stub_fetch(202,
 JSON.stringify({error: 'crawl_results_timeout',
 response_id: 'r_late'}));
 const exit = vi.spyOn(process, 'exit')
 .mockImplementation(()=>undefined as never);
 const error = vi.spyOn(console, 'error')
 .mockImplementation(()=>{});
 await handle_run_scraper('c_abc', 'https://x.com',
 {sync: true});
 const msg = error.mock.calls.map(c=>String(c[0])).join('\n');
 await expect(handle_run_scraper('c_abc', 'https://x.com',
 {sync: true})).rejects.toThrow();
 const msg = String(mocks.fail.mock.calls[0][0]);
 expect(msg).toContain('r_late');
 expect(msg).toContain('Re-run without --sync');
 exit.mockRestore();
 error.mockRestore();
 });

 it('honors --sync-timeout', async()=>{
Expand DownExpand Up@@ -2195,3 +2185,29 @@ describe('commands/scraper', ()=>{
 });
 });
});

describe('format_run_error', ()=>{
 it('returns the raw message (no JSON) when no machine format is set',
 ()=>{
 expect(format_run_error('boom', {})).toEqual(
 {json: false, text: 'boom'});
 });

 it('returns a compact JSON error object under --json', ()=>{
 expect(format_run_error('boom', {json: true})).toEqual(
 {json: true, text: '{"error":"boom"}'});
 });

 it('strips the "Error:" prefix and extra lines in the JSON payload',
 ()=>{
 expect(format_run_error('Error: bad thing\nstack', {json: true}))
 .toEqual({json: true, text: '{"error":"bad thing"}'});
 });

 it('pretty-prints the JSON error under --pretty', ()=>{
 expect(format_run_error('boom', {pretty: true})).toEqual({
 json: true,
 text: JSON.stringify({error: 'boom'}, null, 2),
 });
 });
});

97 changes: 64 additions & 33 deletions
src/commands/scraper.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -231,6 +231,44 @@ const format_create_summary = (
const clean_error_message = (msg: string): string=>
 msg.split('\n')[0].replace(/^Error:\s*/, '').trim();

// Error output for the `run` command. When the caller asked for machine
// output (--json / --pretty), a failed run must return a parseable error
// object on stdout, not a plain-text line on stderr, so an agent reading
// stdout still gets something it can JSON.parse. Without those flags the
// behaviour (a red line on stderr) is unchanged.
const format_run_error = (
 msg: string,
 opts: {json?: boolean; pretty?: boolean}
): {json: boolean; text: string}=>{
 if (opts.json || opts.pretty)
 {
 const payload = {error: clean_error_message(msg)};
 return {
 json: true,
 text: opts.pretty
 ? JSON.stringify(payload, null, 2)
 : JSON.stringify(payload),
 };
 }
 return {json: false, text: msg};
};

const run_fail = (
 msg: string,
 opts: {json?: boolean; pretty?: boolean}
): void=>{
 const out = format_run_error(msg, opts);
 if (out.json)
 {
 process.stdout.write(out.text+'\n');
 process.exit(1);
 return;
 }
 // Non-machine output: reuse the shared fail() (red ✗ line on stderr +
 // exit 1), so every run error is formatted consistently.
 fail(out.text);
};

const build_create_envelope = (params: {
 collector_id: string;
 name: string;
Expand DownExpand Up@@ -1033,7 +1071,7 @@ const run_batch = async(
 try {
 timeout = parse_timeout(timeout_raw);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 if (reason == 'page_limit_fallback')
Expand All@@ -1060,10 +1098,9 @@ const run_batch = async(
 trigger_spinner.stop();
 if (!trigger.collection_id)
 {
console.error(
run_fail(
 `Failed to submit batch job (collector ${collector_id}): `
 +'missing collection_id.');
 process.exit(1);
 +'missing collection_id.', opts);
 return;
 }
 collection_id = trigger.collection_id;
Expand All@@ -1073,10 +1110,9 @@ const run_batch = async(
 `Batch job: ${collection_id}${eta}`));
 } catch(e) {
 trigger_spinner.stop();
console.error(
run_fail(
 `Failed to submit batch job (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 const poll_spinner = start_spinner('Collecting (batch)...');
Expand DownExpand Up@@ -1105,8 +1141,7 @@ const run_batch = async(
 const msg = (e as Error).message;
 const suffix = msg.includes(collection_id)
 ? '' : ` (collection_id ${collection_id})`;
 console.error(`${msg}${suffix}`);
 process.exit(1);
 run_fail(`${msg}${suffix}`, opts);
 return;
 }
};
Expand All@@ -1121,17 +1156,18 @@ const handle_run_scraper = async(
 try {
 urls = resolve_run_inputs(url, opts);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 if (urls.length > 1)
 {
 if (opts.sync)
 {
fail(
run_fail(
 '--sync cannot be combined with --urls / --input-file. '
 +'The /dca/crawl endpoint accepts only a single URL. '
 +'Drop --sync to use the batch endpoint (/dca/trigger).');
 +'Drop --sync to use the batch endpoint (/dca/trigger).',
 opts);
 return;
 }
 await run_batch(api_key, collector_id, urls, opts, 'multi_url');
Expand All@@ -1144,7 +1180,7 @@ const handle_run_scraper = async(
 try {
 sync_timeout = parse_sync_timeout(opts.syncTimeout);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 const query = build_run_query(collector_id, opts,
Expand All@@ -1162,21 +1198,19 @@ const handle_run_scraper = async(
 const parsed = parse_result_body(res.body) as
 {response_id?: string; message?: string};
 const rid = parsed?.response_id ?? '<unknown>';
console.error(
run_fail(
 `Sync request timed out server-side after `
 +`${sync_timeout}s (response_id: ${rid}). `
 +'Re-run without --sync to poll for results.'
 );
 process.exit(1);
 +'Re-run without --sync to poll for results.',
 opts);
 return;
 }
 if (res.status < 200 || res.status >= 300)
 {
console.error(
run_fail(
 `Failed to scrape (collector ${collector_id}): `
 +`HTTP ${res.status} ${res.body.slice(0, 200)}`
 );
 process.exit(1);
 +`HTTP ${res.status} ${res.body.slice(0, 200)}`,
 opts);
 return;
 }
 const data = parse_result_body(res.body);
Expand All@@ -1190,18 +1224,17 @@ const handle_run_scraper = async(
 return;
 } catch(e) {
 spinner.stop();
console.error(
run_fail(
 `Failed to scrape (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 }
 let timeout = 600;
 try {
 timeout = parse_timeout(opts.timeout);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 const trigger_spinner = start_spinner('Triggering scrape...');
Expand All@@ -1217,20 +1250,18 @@ const handle_run_scraper = async(
 trigger_spinner.stop();
 if (!trigger.response_id)
 {
console.error(
run_fail(
 `Failed to trigger scraper (collector ${collector_id}): `
 +'missing response_id in trigger response.');
 process.exit(1);
 +'missing response_id in trigger response.', opts);
 return;
 }
 response_id = trigger.response_id;
 console.error(dim(`Triggered (response_id: ${response_id})`));
 } catch(e) {
 trigger_spinner.stop();
console.error(
run_fail(
 `Failed to trigger scraper (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 const poll_spinner = start_spinner('Waiting for results...');
Expand DownExpand Up@@ -1263,8 +1294,7 @@ const handle_run_scraper = async(
 const msg = (e as Error).message;
 const suffix = msg.includes(response_id)
 ? '' : ` (response_id ${response_id})`;
 console.error(`${msg}${suffix}`);
 process.exit(1);
 run_fail(`${msg}${suffix}`, opts);
 return;
 }
};
Expand DownExpand Up@@ -1475,6 +1505,7 @@ export {
 build_create_envelope,
 emit_create_output,
 handle_run_scraper,
 format_run_error,
 build_run_request,
 build_run_query,
 classify_result,
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix(scraper): emit JSON errors from run under --json / --pretty#18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

danishashko
wants to merge
1
commit into

base:main
Choose a base branch

from

 Open


fix(scraper): emit JSON errors from run under --json / --pretty
#18
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


50 changes: 33 additions & 17 deletions
src/__tests__/commands/scraper.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -88,6 +88,7 @@ import {
 format_heal_summary,
 resume_and_poll,
 handle_approve_scraper,
 format_run_error,
} from '../../commands/scraper';

describe('commands/scraper', ()=>{
Expand DownExpand Up@@ -771,16 +772,11 @@ describe('commands/scraper', ()=>{

 it('exits when trigger returns no response_id', async()=>{
 mocks.post.mockResolvedValueOnce({});
 const exit = vi.spyOn(process, 'exit')
 .mockImplementation(()=>undefined as never);
 const error = vi.spyOn(console, 'error')
 .mockImplementation(()=>{});
 await handle_run_scraper('c_abc', 'https://x.com', {});
 const msg = error.mock.calls.map(c=>String(c[0])).join('\n');
 await expect(handle_run_scraper('c_abc', 'https://x.com', {}))
 .rejects.toThrow();
 const msg = String(mocks.fail.mock.calls[0][0]);
 expect(msg).toContain('response_id');
 expect(msg).toContain('c_abc');
 exit.mockRestore();
 error.mockRestore();
 });
 });

Expand DownExpand Up@@ -820,17 +816,11 @@ describe('commands/scraper', ()=>{
 stub_fetch(202,
 JSON.stringify({error: 'crawl_results_timeout',
 response_id: 'r_late'}));
 const exit = vi.spyOn(process, 'exit')
 .mockImplementation(()=>undefined as never);
 const error = vi.spyOn(console, 'error')
 .mockImplementation(()=>{});
 await handle_run_scraper('c_abc', 'https://x.com',
 {sync: true});
 const msg = error.mock.calls.map(c=>String(c[0])).join('\n');
 await expect(handle_run_scraper('c_abc', 'https://x.com',
 {sync: true})).rejects.toThrow();
 const msg = String(mocks.fail.mock.calls[0][0]);
 expect(msg).toContain('r_late');
 expect(msg).toContain('Re-run without --sync');
 exit.mockRestore();
 error.mockRestore();
 });

 it('honors --sync-timeout', async()=>{
Expand DownExpand Up@@ -2195,3 +2185,29 @@ describe('commands/scraper', ()=>{
 });
 });
});

describe('format_run_error', ()=>{
 it('returns the raw message (no JSON) when no machine format is set',
 ()=>{
 expect(format_run_error('boom', {})).toEqual(
 {json: false, text: 'boom'});
 });

 it('returns a compact JSON error object under --json', ()=>{
 expect(format_run_error('boom', {json: true})).toEqual(
 {json: true, text: '{"error":"boom"}'});
 });

 it('strips the "Error:" prefix and extra lines in the JSON payload',
 ()=>{
 expect(format_run_error('Error: bad thing\nstack', {json: true}))
 .toEqual({json: true, text: '{"error":"bad thing"}'});
 });

 it('pretty-prints the JSON error under --pretty', ()=>{
 expect(format_run_error('boom', {pretty: true})).toEqual({
 json: true,
 text: JSON.stringify({error: 'boom'}, null, 2),
 });
 });
});

97 changes: 64 additions & 33 deletions
src/commands/scraper.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -231,6 +231,44 @@ const format_create_summary = (
const clean_error_message = (msg: string): string=>
 msg.split('\n')[0].replace(/^Error:\s*/, '').trim();

// Error output for the `run` command. When the caller asked for machine
// output (--json / --pretty), a failed run must return a parseable error
// object on stdout, not a plain-text line on stderr, so an agent reading
// stdout still gets something it can JSON.parse. Without those flags the
// behaviour (a red line on stderr) is unchanged.
const format_run_error = (
 msg: string,
 opts: {json?: boolean; pretty?: boolean}
): {json: boolean; text: string}=>{
 if (opts.json || opts.pretty)
 {
 const payload = {error: clean_error_message(msg)};
 return {
 json: true,
 text: opts.pretty
 ? JSON.stringify(payload, null, 2)
 : JSON.stringify(payload),
 };
 }
 return {json: false, text: msg};
};

const run_fail = (
 msg: string,
 opts: {json?: boolean; pretty?: boolean}
): void=>{
 const out = format_run_error(msg, opts);
 if (out.json)
 {
 process.stdout.write(out.text+'\n');
 process.exit(1);
 return;
 }
 // Non-machine output: reuse the shared fail() (red ✗ line on stderr +
 // exit 1), so every run error is formatted consistently.
 fail(out.text);
};

const build_create_envelope = (params: {
 collector_id: string;
 name: string;
Expand DownExpand Up@@ -1033,7 +1071,7 @@ const run_batch = async(
 try {
 timeout = parse_timeout(timeout_raw);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 if (reason == 'page_limit_fallback')
Expand All@@ -1060,10 +1098,9 @@ const run_batch = async(
 trigger_spinner.stop();
 if (!trigger.collection_id)
 {
console.error(
run_fail(
 `Failed to submit batch job (collector ${collector_id}): `
 +'missing collection_id.');
 process.exit(1);
 +'missing collection_id.', opts);
 return;
 }
 collection_id = trigger.collection_id;
Expand All@@ -1073,10 +1110,9 @@ const run_batch = async(
 `Batch job: ${collection_id}${eta}`));
 } catch(e) {
 trigger_spinner.stop();
console.error(
run_fail(
 `Failed to submit batch job (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 const poll_spinner = start_spinner('Collecting (batch)...');
Expand DownExpand Up@@ -1105,8 +1141,7 @@ const run_batch = async(
 const msg = (e as Error).message;
 const suffix = msg.includes(collection_id)
 ? '' : ` (collection_id ${collection_id})`;
 console.error(`${msg}${suffix}`);
 process.exit(1);
 run_fail(`${msg}${suffix}`, opts);
 return;
 }
};
Expand All@@ -1121,17 +1156,18 @@ const handle_run_scraper = async(
 try {
 urls = resolve_run_inputs(url, opts);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 if (urls.length > 1)
 {
 if (opts.sync)
 {
fail(
run_fail(
 '--sync cannot be combined with --urls / --input-file. '
 +'The /dca/crawl endpoint accepts only a single URL. '
 +'Drop --sync to use the batch endpoint (/dca/trigger).');
 +'Drop --sync to use the batch endpoint (/dca/trigger).',
 opts);
 return;
 }
 await run_batch(api_key, collector_id, urls, opts, 'multi_url');
Expand All@@ -1144,7 +1180,7 @@ const handle_run_scraper = async(
 try {
 sync_timeout = parse_sync_timeout(opts.syncTimeout);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 const query = build_run_query(collector_id, opts,
Expand All@@ -1162,21 +1198,19 @@ const handle_run_scraper = async(
 const parsed = parse_result_body(res.body) as
 {response_id?: string; message?: string};
 const rid = parsed?.response_id ?? '<unknown>';
console.error(
run_fail(
 `Sync request timed out server-side after `
 +`${sync_timeout}s (response_id: ${rid}). `
 +'Re-run without --sync to poll for results.'
 );
 process.exit(1);
 +'Re-run without --sync to poll for results.',
 opts);
 return;
 }
 if (res.status < 200 || res.status >= 300)
 {
console.error(
run_fail(
 `Failed to scrape (collector ${collector_id}): `
 +`HTTP ${res.status} ${res.body.slice(0, 200)}`
 );
 process.exit(1);
 +`HTTP ${res.status} ${res.body.slice(0, 200)}`,
 opts);
 return;
 }
 const data = parse_result_body(res.body);
Expand All@@ -1190,18 +1224,17 @@ const handle_run_scraper = async(
 return;
 } catch(e) {
 spinner.stop();
console.error(
run_fail(
 `Failed to scrape (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 }
 let timeout = 600;
 try {
 timeout = parse_timeout(opts.timeout);
 } catch(e) {
fail((e as Error).message);
run_fail((e as Error).message, opts);
 return;
 }
 const trigger_spinner = start_spinner('Triggering scrape...');
Expand All@@ -1217,20 +1250,18 @@ const handle_run_scraper = async(
 trigger_spinner.stop();
 if (!trigger.response_id)
 {
console.error(
run_fail(
 `Failed to trigger scraper (collector ${collector_id}): `
 +'missing response_id in trigger response.');
 process.exit(1);
 +'missing response_id in trigger response.', opts);
 return;
 }
 response_id = trigger.response_id;
 console.error(dim(`Triggered (response_id: ${response_id})`));
 } catch(e) {
 trigger_spinner.stop();
console.error(
run_fail(
 `Failed to trigger scraper (collector ${collector_id}): `
 +`${(e as Error).message}`);
 process.exit(1);
 +`${(e as Error).message}`, opts);
 return;
 }
 const poll_spinner = start_spinner('Waiting for results...');
Expand DownExpand Up@@ -1263,8 +1294,7 @@ const handle_run_scraper = async(
 const msg = (e as Error).message;
 const suffix = msg.includes(response_id)
 ? '' : ` (response_id ${response_id})`;
 console.error(`${msg}${suffix}`);
 process.exit(1);
 run_fail(`${msg}${suffix}`, opts);
 return;
 }
};
Expand DownExpand Up@@ -1475,6 +1505,7 @@ export {
 build_create_envelope,
 emit_create_output,
 handle_run_scraper,
 format_run_error,
 build_run_request,
 build_run_query,
 classify_result,
Expand Down