Skip to content

Save trace in snapshot #48

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

Merged
rcholic merged 2 commits into from
Dec 25, 2025
Merged

Save trace in snapshot #48

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00d9af9
Save trace in snapshot
rcholic Dec 25, 2025
a2bc86f
Merge branch 'improve_agent3' into improve_agent5
rcholic Dec 25, 2025
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
36 changes: 36 additions & 0 deletions src/snapshot.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

import { SentienceBrowser } from './browser';
import { Snapshot } from './types';
import * as fs from 'fs';
import * as path from 'path';

export interface SnapshotOptions {
screenshot?: boolean | { format: 'png' | 'jpeg'; quality?: number };
Expand All @@ -14,6 +16,30 @@ export interface SnapshotOptions {
min_z_index?: number;
};
use_api?: boolean; // Force use of server-side API if True, local extension if False
save_trace?: boolean; // Save raw_elements to JSON for benchmarking/training
trace_path?: string; // Path to save trace file (default: "trace_{timestamp}.json")
}

/**
* Save raw_elements to a JSON file for benchmarking/training
*
* @param rawElements Raw elements data from snapshot
* @param tracePath Path to save trace file. If undefined, uses "trace_{timestamp}.json"
*/
function _saveTraceToFile(rawElements: any[], tracePath?: string): void {
// Default filename if none provided
const filename = tracePath || `trace_${Date.now()}.json`;

// Ensure directory exists
const dir = path.dirname(filename);
if (dir !== '.') {
fs.mkdirSync(dir, { recursive: true });
}

// Save the raw elements to JSON
fs.writeFileSync(filename, JSON.stringify(rawElements, null, 2));

console.log(`[SDK] Trace saved to: ${filename}`);
}

export async function snapshot(
Expand Down Expand Up @@ -83,6 +109,11 @@ async function snapshotViaExtension(
return window.sentience.snapshot(opts);
}, opts);

// Save trace if requested
if (options.save_trace && result.raw_elements) {
_saveTraceToFile(result.raw_elements, options.trace_path);
}

// Basic validation
if (result.status !== 'success' && result.status !== 'error') {
throw new Error(`Invalid snapshot status: ${result.status}`);
Expand Down Expand Up @@ -122,6 +153,11 @@ async function snapshotViaApi(
return (window as any).sentience.snapshot(opts);
}, rawOpts);

// Save trace if requested (save raw data before API processing)
if (options.save_trace && rawResult.raw_elements) {
_saveTraceToFile(rawResult.raw_elements, options.trace_path);
}

// Step 2: Send to server for smart ranking/filtering
// Use raw_elements (raw data) instead of elements (processed data)
// Server validates API key and applies proprietary ranking logic
Expand Down