Skip to content

Commit d1f94b3

Browse files
committed
Use fetched views for opt-in metadata
Fetched patch views now override search metadata in get and scan JSON, including changed or cleared instructions. Reused detached vendor records consume the same prefetched view and persist activation metadata even when artifacts and wiring need no work. Make the manifest schema-key test populate both records so its assertion is not HashMap-order dependent. Assisted-by: Claude Code:kimi-k3p1-pro
1 parent 5178ef8 commit d1f94b3

6 files changed

Lines changed: 290 additions & 7 deletions

File tree

‎crates/socket-patch-cli/src/commands/agent_download.rs‎

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ use socket_patch_core::vendor::refusals::{
2424
vendor_refusals, LedgerLoad, RefusalScope, VendorRefusal, VendorRefusals,
2525
};
2626
use socket_patch_core::vendor::{load_state, lookup_entry, VendorEntry, VendorState};
27-
use std::collections::HashMap;
27+
use std::collections::{HashMap, HashSet};
2828
use std::path::{Path, PathBuf};
2929
use std::time::Duration;
3030

@@ -974,7 +974,12 @@ pub(crate) async fn fetch_selected_patches(
974974

975975
// Idempotency (ledger store): a detached entry already at this uuid
976976
// carries its own record — no view fetch needed.
977-
if let Some(record) = detached_ledger_record(store, purl, uuid).cloned() {
977+
if let Some(mut record) = detached_ledger_record(store, purl, uuid).cloned() {
978+
if let Some(patch) = prefetched.get(uuid) {
979+
record.requires_opt_in = patch.requires_opt_in;
980+
record.opt_in_note = patch.opt_in_note.clone();
981+
batch.metadata_refreshes.push(patch.clone());
982+
}
978983
if !quiet {
979984
eprintln!("{}", format_record_skip(purl, "already vendored"));
980985
}
@@ -1153,6 +1158,7 @@ pub(crate) async fn fetch_selected_patches(
11531158
/// envelope, how many patches failed, and the records the vendor step
11541159
/// consumes.
11551160
pub(crate) struct DetachedDownload {
1161+
authoritative: HashSet<String>,
11561162
pub(crate) code: i32,
11571163
pub(crate) events: Vec<PatchEvent>,
11581164
pub(crate) warnings: Vec<RunWarning>,
@@ -1168,6 +1174,16 @@ impl DetachedDownload {
11681174
self,
11691175
env: &mut Envelope,
11701176
) -> (i32, usize, HashMap<String, PatchRecord>) {
1177+
for (purl, record) in &self.records {
1178+
if self.authoritative.contains(&record.uuid) {
1179+
env.register_view_opt_in(
1180+
purl,
1181+
&record.uuid,
1182+
record.requires_opt_in,
1183+
record.opt_in_note.as_deref(),
1184+
);
1185+
}
1186+
}
11711187
for event in self.events {
11721188
env.record(event);
11731189
}
@@ -1251,11 +1267,18 @@ pub(crate) async fn download_patch_records_preflighted(
12511267
)
12521268
.await;
12531269

1270+
let mut authoritative: HashSet<String> = batch
1271+
.metadata_refreshes
1272+
.iter()
1273+
.map(|patch| patch.uuid.clone())
1274+
.collect();
12541275
let mut records: HashMap<String, PatchRecord> = batch.reused.into_iter().collect();
12551276
for FetchedPatch { patch, files, .. } in batch.fetched {
1277+
authoritative.insert(patch.uuid.clone());
12561278
records.insert(patch.purl.clone(), build_patch_record(&patch, files));
12571279
}
12581280
DetachedDownload {
1281+
authoritative,
12591282
code: i32::from(batch.failed > 0),
12601283
events: batch.events,
12611284
warnings: release_warnings(batch.warnings),
@@ -1722,6 +1745,23 @@ pub async fn download_and_apply_patches_into(
17221745
// matching the per-patch event (`downloaded` / `updated`) and the
17231746
// single-uuid flow's summary in `save_and_apply_patch`; their sum gates
17241747
// the apply step.
1748+
for fetched in &batch.fetched {
1749+
env.register_view_opt_in(
1750+
&fetched.patch.purl,
1751+
&fetched.patch.uuid,
1752+
fetched.patch.requires_opt_in,
1753+
fetched.patch.opt_in_note.as_deref(),
1754+
);
1755+
}
1756+
for patch in &batch.metadata_refreshes {
1757+
env.register_view_opt_in(
1758+
&patch.purl,
1759+
&patch.uuid,
1760+
patch.requires_opt_in,
1761+
patch.opt_in_note.as_deref(),
1762+
);
1763+
}
1764+
17251765
let mut metadata_changed = false;
17261766
for patch in &batch.metadata_refreshes {
17271767
if let Some(record) = manifest.patches.get_mut(&patch.purl) {

‎crates/socket-patch-cli/src/commands/scan/vendor_flow.rs‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -581,6 +581,13 @@ async fn vendor_under_lock(
581581
)
582582
.await;
583583
let has_errors = applied;
584+
if let Err(e) = synchronize_embedded_opt_in_metadata(common, &manifest.patches).await {
585+
return Err((
586+
"vendor_state_write_failed",
587+
format!("could not persist the vendor records' activation metadata: {e}"),
588+
Some(Box::new(env)),
589+
));
590+
}
584591
migrate_legacy_manifest_records(common, &manifest_path, &manifest.patches, &mut env).await;
585592
if has_errors {
586593
env.mark_partial_failure();
@@ -595,6 +602,41 @@ fn ledger_key_for(state: &VendorState, purl: &str) -> Option<String> {
595602
socket_patch_core::vendor::state::lookup_entry_kv(&state.entries, purl).map(|(k, _)| k.clone())
596603
}
597604

605+
async fn synchronize_embedded_opt_in_metadata(
606+
common: &GlobalArgs,
607+
records: &HashMap<String, PatchRecord>,
608+
) -> std::io::Result<()> {
609+
if common.dry_run {
610+
return Ok(());
611+
}
612+
let mut state = load_state(&common.cwd).await?;
613+
let mut changed = false;
614+
for (purl, record) in records {
615+
let Some(key) = ledger_key_for(&state, purl) else {
616+
continue;
617+
};
618+
let entry = state.entries.get_mut(&key).expect("ledger key was present");
619+
if entry.uuid != record.uuid {
620+
continue;
621+
}
622+
let Some(existing) = entry.record.as_mut() else {
623+
continue;
624+
};
625+
if existing.requires_opt_in == record.requires_opt_in
626+
&& existing.opt_in_note == record.opt_in_note
627+
{
628+
continue;
629+
}
630+
existing.requires_opt_in = record.requires_opt_in;
631+
existing.opt_in_note = record.opt_in_note.clone();
632+
changed = true;
633+
}
634+
if changed {
635+
save_state(&common.cwd, &state).await?;
636+
}
637+
Ok(())
638+
}
639+
598640
/// Migrate a project vendored by an older, manifest-mode CLI. For the purls
599641
/// THIS run vendored (`records`, in-sync `already_vendored` skips included):
600642
/// (1) a legacy entry in sync at a record's uuid is upgraded in place

‎crates/socket-patch-cli/src/json_envelope.rs‎

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,26 @@ impl Envelope {
216216
if requires_opt_in.is_none() && opt_in_note.is_none() {
217217
return;
218218
}
219+
self.insert_opt_in(purl, uuid, requires_opt_in, opt_in_note);
220+
}
221+
222+
pub(crate) fn register_view_opt_in(
223+
&mut self,
224+
purl: &str,
225+
uuid: &str,
226+
requires_opt_in: Option<bool>,
227+
opt_in_note: Option<&str>,
228+
) {
229+
self.insert_opt_in(purl, uuid, requires_opt_in, opt_in_note);
230+
}
231+
232+
fn insert_opt_in(
233+
&mut self,
234+
purl: &str,
235+
uuid: &str,
236+
requires_opt_in: Option<bool>,
237+
opt_in_note: Option<&str>,
238+
) {
219239
let metadata = OptInMetadata {
220240
requires_opt_in,
221241
opt_in_note: opt_in_note.map(str::to_string),
@@ -257,10 +277,14 @@ impl Envelope {
257277
.filter(serde_json::Value::is_object)
258278
.unwrap_or_else(|| serde_json::json!({}));
259279
if let Some(requires_opt_in) = metadata.requires_opt_in {
260-
details["requiresOptIn"] = serde_json::json!(requires_opt_in);
280+
if details.get("requiresOptIn").is_none() {
281+
details["requiresOptIn"] = serde_json::json!(requires_opt_in);
282+
}
261283
}
262284
if let Some(opt_in_note) = &metadata.opt_in_note {
263-
details["optInNote"] = serde_json::json!(opt_in_note);
285+
if details.get("optInNote").is_none() {
286+
details["optInNote"] = serde_json::json!(opt_in_note);
287+
}
264288
}
265289
event.details = Some(details);
266290
}

‎crates/socket-patch-cli/tests/get/get_render.rs‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -439,6 +439,53 @@ async fn opt_in_note_renders_and_persists_in_human_and_json_get() {
439439
assert_eq!(event["details"]["optInNote"], NOTE);
440440
}
441441

442+
#[tokio::test]
443+
async fn get_json_uses_fetched_view_instead_of_stale_search_opt_in_metadata() {
444+
const STALE: &str = "Stale search instruction.";
445+
const LATEST: &str = "Latest view instruction.";
446+
let server = MockServer::start().await;
447+
let cve = "CVE-2024-4246";
448+
Mock::given(method("GET"))
449+
.and(path(format!("/v0/orgs/{ORG}/patches/by-cve/{cve}")))
450+
.respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({
451+
"patches": [{
452+
"uuid": UUID, "purl": PURL,
453+
"publishedAt": "2024-01-01T00:00:00Z",
454+
"description": "View metadata is authoritative",
455+
"license": "MIT", "tier": "free", "vulnerabilities": {},
456+
"requiresOptIn": false, "optInNote": STALE,
457+
}],
458+
"canAccessPaidPatches": false,
459+
})))
460+
.mount(&server)
461+
.await;
462+
let mut view = view_json(UUID, PURL, good_files());
463+
view["requiresOptIn"] = serde_json::json!(true);
464+
view["optInNote"] = serde_json::json!(LATEST);
465+
Mock::given(method("GET"))
466+
.and(path(format!("/v0/orgs/{ORG}/patches/view/{UUID}")))
467+
.respond_with(ResponseTemplate::new(200).set_body_json(view))
468+
.mount(&server)
469+
.await;
470+
let tmp = tempfile::tempdir().unwrap();
471+
472+
let (code, stdout, stderr) =
473+
run_get_bin(tmp.path(), &server.uri(), &[cve, "--save-only", "--json"]);
474+
assert_eq!(code, 0, "stdout={stdout}\nstderr={stderr}");
475+
let envelope: serde_json::Value = serde_json::from_str(&stdout).unwrap();
476+
let event = envelope["events"]
477+
.as_array()
478+
.unwrap()
479+
.iter()
480+
.find(|event| event["uuid"] == UUID)
481+
.unwrap();
482+
assert_eq!(event["details"]["requiresOptIn"], true, "{event}");
483+
assert_eq!(event["details"]["optInNote"], LATEST, "{event}");
484+
let record = &manifest_json(tmp.path())["patches"][PURL];
485+
assert_eq!(record["requiresOptIn"], true);
486+
assert_eq!(record["optInNote"], LATEST);
487+
}
488+
442489
#[tokio::test]
443490
async fn changed_view_opt_in_note_is_not_suppressed_in_nested_apply() {
444491
const PREVIEW_NOTE: &str = "Preview configuration instruction.";
@@ -846,6 +893,104 @@ async fn human_vendored_uuid_rerun_prints_already_vendored_skip() {
846893
assert!(artifact.is_file(), "stdout={stdout}\nstderr={stderr}");
847894
}
848895

896+
#[tokio::test]
897+
async fn vendored_same_uuid_view_refresh_updates_state_list_and_vex() {
898+
const NOTE: &str = "Set `safeMode` to `true`; defaults remain vulnerable.";
899+
let server = MockServer::start().await;
900+
let files = serde_json::json!({
901+
"package/index.js": {
902+
"beforeHash": git_hash(BEFORE_BYTES),
903+
"afterHash": git_hash(AFTER_BYTES),
904+
"blobContent": b64(AFTER_BYTES),
905+
}
906+
});
907+
let mut view = view_json(UUID, PURL, files);
908+
view["vulnerabilities"] = serde_json::json!({
909+
GHSA: {
910+
"cves": ["CVE-2024-4247"],
911+
"summary": "Activation metadata refresh",
912+
"severity": "high",
913+
"description": "d",
914+
}
915+
});
916+
Mock::given(method("GET"))
917+
.and(path(format!("/v0/orgs/{ORG}/patches/view/{UUID}")))
918+
.respond_with(ResponseTemplate::new(200).set_body_json(view.clone()))
919+
.mount(&server)
920+
.await;
921+
crate::prebuilt_common::mount_view(&server, &view, None).await;
922+
let tmp = tempfile::tempdir().unwrap();
923+
write_project(tmp.path());
924+
925+
let (code, stdout, stderr) = run_get_bin(
926+
tmp.path(),
927+
&server.uri(),
928+
&[
929+
UUID,
930+
"--mode",
931+
"vendored",
932+
"--vendor-source",
933+
"service",
934+
"--json",
935+
],
936+
);
937+
assert_eq!(code, 0, "initial vendor: stdout={stdout}\nstderr={stderr}");
938+
let entry = &vendor_state(tmp.path())["entries"][PURL];
939+
assert!(entry["record"].get("requiresOptIn").is_none());
940+
assert!(entry["record"].get("optInNote").is_none());
941+
let artifact = tmp
942+
.path()
943+
.join(".socket/vendor/npm")
944+
.join(UUID)
945+
.join(format!("{NAME}-1.0.0.tgz"));
946+
let artifact_before = std::fs::read(&artifact).unwrap();
947+
948+
server.reset().await;
949+
view["requiresOptIn"] = serde_json::json!(true);
950+
view["optInNote"] = serde_json::json!(NOTE);
951+
Mock::given(method("GET"))
952+
.and(path(format!("/v0/orgs/{ORG}/patches/view/{UUID}")))
953+
.respond_with(ResponseTemplate::new(200).set_body_json(view))
954+
.mount(&server)
955+
.await;
956+
let (code, stdout, stderr) = run_get_bin(
957+
tmp.path(),
958+
&server.uri(),
959+
&[UUID, "--mode", "vendored", "--vendor-source", "service"],
960+
);
961+
assert_eq!(code, 0, "reused vendor: stdout={stdout}\nstderr={stderr}");
962+
let entry = &vendor_state(tmp.path())["entries"][PURL];
963+
assert_eq!(entry["record"]["requiresOptIn"], true, "{entry}");
964+
assert_eq!(entry["record"]["optInNote"], NOTE, "{entry}");
965+
assert_eq!(std::fs::read(&artifact).unwrap(), artifact_before);
966+
967+
let (code, stdout, stderr) = crate::common::run_with_env(
968+
tmp.path(),
969+
&["list", "--offline"],
970+
&[("SOCKET_TELEMETRY_DISABLED", "1")],
971+
);
972+
assert_eq!(code, 0, "list: stdout={stdout}\nstderr={stderr}");
973+
assert!(
974+
stdout.contains(&format!("Opt-in required: {NOTE}")),
975+
"{stdout}"
976+
);
977+
978+
let (code, stdout, stderr) = crate::common::run_with_env(
979+
tmp.path(),
980+
&["vex", "--no-verify"],
981+
&[("SOCKET_TELEMETRY_DISABLED", "1")],
982+
);
983+
assert_eq!(code, 0, "vex: stdout={stdout}\nstderr={stderr}");
984+
let document: serde_json::Value = serde_json::from_str(&stdout).unwrap();
985+
let impact = document["statements"][0]["impact_statement"]
986+
.as_str()
987+
.unwrap();
988+
assert!(
989+
impact.contains(&format!("opt-in required: {NOTE}")),
990+
"{document}"
991+
);
992+
}
993+
849994
/// Agent-mode `--dry-run` (search path) previews and writes NOTHING: no
850995
/// `.socket/`, no view fetch, no prompt, exit 0.
851996
#[tokio::test]

‎crates/socket-patch-cli/tests/scan/scan_render.rs‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,37 @@ async fn repeated_agent_scan_prints_opt_in_note_once() {
408408
);
409409
}
410410

411+
#[tokio::test]
412+
async fn agent_scan_json_uses_fetched_view_over_stale_search_metadata() {
413+
let mock = MockServer::start().await;
414+
mount_batch_free(&mock, &[(MINIMIST, UUID)]).await;
415+
mount_by_package_body(
416+
&mock,
417+
MINIMIST,
418+
serde_json::json!({
419+
"patches": [{
420+
"uuid": UUID, "purl": MINIMIST,
421+
"publishedAt": "2024-01-01T00:00:00Z",
422+
"description": "Stale search metadata",
423+
"license": "MIT", "tier": "free", "vulnerabilities": {},
424+
"requiresOptIn": false,
425+
"optInNote": "Stale search instruction.",
426+
}],
427+
"canAccessPaidPatches": false,
428+
}),
429+
)
430+
.await;
431+
mount_view_with_opt_in(&mock, MINIMIST, UUID, b"before\n", Some(OPT_IN_NOTE)).await;
432+
let tmp = minimist_project(b"before\n");
433+
434+
let (code, stdout, stderr) = run_scan_agent(tmp.path(), &mock.uri(), &["--json"]);
435+
assert_eq!(code, 0, "stdout={stdout}; stderr={stderr}");
436+
assert_opt_in_event(&serde_json::from_str(&stdout).unwrap());
437+
let record = &read_manifest(tmp.path())["patches"][MINIMIST];
438+
assert_eq!(record["requiresOptIn"], true);
439+
assert_eq!(record["optInNote"], OPT_IN_NOTE);
440+
}
441+
411442
#[tokio::test]
412443
async fn scan_json_events_carry_opt_in_fields_in_hosted_and_repeated_agent_runs() {
413444
let hosted_mock = MockServer::start().await;

0 commit comments

Comments
 (0)