Skip to content

Commit dabddf9

Browse files
committed
fix(cli): read full pages when filtering, cap pages only there
Co-authored-by: Will Pfleger <[email protected]> Signed-off-by: Will Pfleger <[email protected]>
1 parent acd945f commit dabddf9

2 files changed

Lines changed: 54 additions & 26 deletions

File tree

‎crates/buzz-cli/src/client.rs‎

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -450,7 +450,7 @@ mod media_download_tests {
450450
}
451451
}
452452

453-
const QUERY_PAGE_SIZE: u32 = 500;
453+
pub(crate) const QUERY_PAGE_SIZE: u32 = 500;
454454

455455
/// The most pages one limited query reads before failing, so a relay that
456456
/// never runs out of events to skip cannot keep a command running forever.
@@ -826,30 +826,34 @@ impl BuzzClient {
826826
filter: serde_json::Value,
827827
limit: Option<u32>,
828828
) -> Result<Vec<serde_json::Value>, CliError> {
829-
self.query_pages_keeping(filter, limit, |_| true).await
829+
self.query_pages_keeping(filter, limit, None).await
830830
}
831831

832-
/// Like `query_pages`, but only events `keep` accepts count toward
833-
/// `limit`, so paging continues past the ones it drops.
832+
/// Like `query_pages`, but with `keep`, only events it accepts count
833+
/// toward `limit`: paging continues past the ones it drops, always in
834+
/// full pages, for at most `MAX_QUERY_PAGES` pages.
834835
async fn query_pages_keeping(
835836
&self,
836837
mut filter: serde_json::Value,
837838
limit: Option<u32>,
838-
keep: impl Fn(&serde_json::Value) -> bool,
839+
keep: Option<&dyn Fn(&serde_json::Value) -> bool>,
839840
) -> Result<Vec<serde_json::Value>, CliError> {
840841
let mut events = Vec::new();
841842
let mut pages = 0;
842843

843844
while limit.is_none_or(|limit| events.len() < limit as usize) {
844-
if limit.is_some() && pages == MAX_QUERY_PAGES {
845+
if keep.is_some() && pages == MAX_QUERY_PAGES {
845846
return Err(stalled_query(&format!(
846847
"read {MAX_QUERY_PAGES} pages without reaching the end of the results"
847848
)));
848849
}
849850
pages += 1;
850-
let page_limit = limit
851-
.map(|limit| (limit as usize - events.len()).min(QUERY_PAGE_SIZE as usize))
852-
.unwrap_or(QUERY_PAGE_SIZE as usize);
851+
let page_limit = match (limit, keep) {
852+
(Some(limit), None) => {
853+
(limit as usize - events.len()).min(QUERY_PAGE_SIZE as usize)
854+
}
855+
_ => QUERY_PAGE_SIZE as usize,
856+
};
853857
filter["limit"] = serde_json::json!(page_limit);
854858

855859
let raw = self.query(&filter).await?;
@@ -860,12 +864,15 @@ impl BuzzClient {
860864
if !done {
861865
advance_query_cursor(&mut filter, &page)?;
862866
}
863-
events.extend(page.into_iter().filter(|e| keep(e)));
867+
events.extend(page.into_iter().filter(|e| keep.is_none_or(|keep| keep(e))));
864868
if done {
865869
break;
866870
}
867871
}
868872

873+
if let Some(limit) = limit {
874+
events.truncate(limit as usize);
875+
}
869876
Ok(events)
870877
}
871878

@@ -877,7 +884,8 @@ impl BuzzClient {
877884
limit: u32,
878885
keep: impl Fn(&serde_json::Value) -> bool,
879886
) -> Result<Vec<serde_json::Value>, CliError> {
880-
self.query_pages_keeping(filter, Some(limit), keep).await
887+
self.query_pages_keeping(filter, Some(limit), Some(&keep))
888+
.await
881889
}
882890

883891
/// Query up to `limit` historical events, following the relay bridge's

‎crates/buzz-cli/src/commands/dms.rs‎

Lines changed: 35 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ mod tests {
225225
events.push(serde_json::json!({
226226
"id": "f".repeat(64), "kind": 30622, "created_at": 5_000, "tags": hidden,
227227
}));
228-
let (base, log) = relay(events).await;
228+
let (base, _) = relay(events).await;
229229
let client = BuzzClient::new(
230230
base,
231231
crate::credentials::Credentials::from_keys(nostr::Keys::generate()),
@@ -236,11 +236,29 @@ mod tests {
236236

237237
assert_eq!(dms.len(), 1, "{dms:?}");
238238
assert_eq!(dms[0]["dm_id"], "dm-0");
239-
assert!(log
240-
.lock()
241-
.unwrap()
242-
.iter()
243-
.any(|f| f["before_id"].is_string()));
239+
}
240+
241+
#[tokio::test]
242+
async fn a_small_limit_still_reads_full_pages_past_hidden_dms() {
243+
// 150 newer hidden DMs, then one older visible DM, with limit 1.
244+
let mut events: Vec<_> = (1..=150).rev().map(dm).collect();
245+
events.push(dm(0));
246+
let hidden: Vec<_> = (1..=150)
247+
.map(|n| serde_json::json!(["h", format!("dm-{n}")]))
248+
.collect();
249+
events.push(serde_json::json!({
250+
"id": "f".repeat(64), "kind": 30622, "created_at": 5_000, "tags": hidden,
251+
}));
252+
let (base, log) = relay(events).await;
253+
254+
let dms = list_dms(&client(base), 1).await.unwrap();
255+
256+
assert_eq!(dms.len(), 1, "{dms:?}");
257+
assert_eq!(dms[0]["dm_id"], "dm-0");
258+
let log = log.lock().unwrap();
259+
let dm_pages: Vec<_> = log.iter().filter(|f| f["kinds"][0] == 39000).collect();
260+
assert_eq!(dm_pages.len(), 1, "{dm_pages:?}");
261+
assert_eq!(dm_pages[0]["limit"], crate::client::QUERY_PAGE_SIZE);
244262
}
245263

246264
#[tokio::test]
@@ -251,20 +269,22 @@ mod tests {
251269
e["created_at"] = serde_json::json!(1_000);
252270
e
253271
};
254-
let events = vec![
255-
same(1),
256-
same(2),
257-
serde_json::json!({
258-
"id": "f".repeat(64), "kind": 30622, "created_at": 5_000,
259-
"tags": [["h", "dm-1"]],
260-
}),
261-
];
272+
// A full page of hidden DMs, then a visible one with the same
273+
// timestamp and a larger id, so the cursor must stay on that second.
274+
let page = crate::client::QUERY_PAGE_SIZE as u64;
275+
let mut events: Vec<_> = (1..=page + 1).map(same).collect();
276+
let hidden: Vec<_> = (1..=page)
277+
.map(|n| serde_json::json!(["h", format!("dm-{n}")]))
278+
.collect();
279+
events.push(serde_json::json!({
280+
"id": "f".repeat(64), "kind": 30622, "created_at": 5_000, "tags": hidden,
281+
}));
262282
let (base, log) = relay(events).await;
263283

264284
let dms = list_dms(&client(base), 1).await.unwrap();
265285

266286
assert_eq!(dms.len(), 1, "{dms:?}");
267-
assert_eq!(dms[0]["dm_id"], "dm-2");
287+
assert_eq!(dms[0]["dm_id"], format!("dm-{}", page + 1));
268288
assert!(log
269289
.lock()
270290
.unwrap()

0 commit comments

Comments
 (0)