Skip to content

Explain request and attempt IDs in downloaded run YAML #1549

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
Naveen Chatlapalli (1aifanatic) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Explain request and attempt IDs in downloaded run YAML #1549

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
7 changes: 6 additions & 1 deletion apps/api/src/archive-har.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,12 @@ export async function packRunIntoTar(
archiveResource.codebase.archiveBlobUrl = codebaseBlobUrl;
archiveResource.codebase.archiveUrl = "codebase.tar.gz";
}
const yamlContent = yamlStringify(archiveResource, { lineWidth: 120 });
// Ponytail: YAML comments clarify IDs without changing the importable schema.
const yamlContent =
"# _id is the request ID (the archive folder and Portal run URL).\n" +
"# run._id is this execution attempt's ID; retries keep the request ID.\n" +
"# submissionId groups requests created by one submission.\n" +
yamlStringify(archiveResource, { lineWidth: 120 });
const yamlBuf = Buffer.from(yamlContent, "utf-8");
pack.entry({ name: `${id}/run.yaml`, size: yamlBuf.length }, yamlBuf);

Expand Down
1 change: 1 addition & 0 deletions apps/api/src/routes/requests/archive.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -614,6 +614,7 @@ describe("run import/export — round-trip (export → import)", () => {
if (srcKey === "<yaml>") continue;
expect(entries[entryName]).toEqual(blobStore.get(srcKey));
}
expect(entries[`${id}/run.yaml`].toString()).toContain("# run._id is this execution attempt's ID");

// 2. Re-import into a fresh blob store + Mongo. Importer ingests every
// bundled artifact: HAR, chat-export, tool-calls, chat-result and
Expand Down
6 changes: 6 additions & 0 deletions docs/architecture/app-design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,12 @@ erDiagram
- **ResourceRevision** — Immutable lifecycle snapshot in `resource-revisions` containing normalized setup/teardown scripts, exported names, parameter declarations, `contentSha256`, and canonical `{slug}@r{N}` ref. Revisions deduplicate against the latest revision only. See [resources](resources.md).
- **ProfileVersion.resources** — Immutable resource binding specs (`{ref, params}`) stored with a profile version. Submit resolves them to pinned request `resources[]` and merges profile preset parameters with run-supplied values using profile-wins precedence.

Downloaded run archives retain the importable `run.yaml` schema: the archive
folder and top-level `_id` identify the stable request, `run._id` identifies
the execution attempt (which changes on retry), and `submissionId` groups
requests submitted together. Every exported request folder includes a
`run.yaml` header explaining these IDs; YAML comments preserve import compatibility.

### Typed prompts, AGENTS.md, and size-based storage

Task prompts live in a single `task-prompts` collection that is now **typed** and
Expand Down