simbad_resolver/batch.rs
1// This Source Code Form is subject to the terms of the Mozilla Public
2// License, v. 2.0. If a copy of the MPL was not distributed with this
3// file, You can obtain one at https://mozilla.org/MPL/2.0/.
4
5//! Async batch resolver over a pluggable [`Queue`].
6//!
7//! Drains pending items cache-first then online, distinguishing **transient**
8//! failures (kept pending, retried later, attempt budget preserved) from
9//! **content** misses (marked unresolved). Processing is sequential within a
10//! drain (polite to the upstream service); each pending item is processed at
11//! most once per [`BatchResolver::drain`] call.
12
13use std::collections::HashSet;
14use std::sync::Arc;
15
16use crate::cache::{Cache, Queue};
17use crate::{
18 config::ResolverConfig,
19 error::Error,
20 orchestrate::{resolve_core, Resolution, UnresolvedReason},
21 Resolver,
22};
23
24/// Summary of a [`BatchResolver::drain`] pass.
25#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
26pub struct DrainSummary {
27 /// Items resolved to a canonical target this pass.
28 pub resolved: usize,
29 /// Items marked unresolved (content misses) this pass.
30 pub unresolved: usize,
31 /// Items left pending after a transient failure (to retry later).
32 pub still_pending: usize,
33}
34
35/// The async batch resolver. Generic over any [`Resolver`]; the cache and queue
36/// backends are type-erased so the type does not carry them.
37///
38/// This example seeds the cache before draining, so [`Self::drain`] resolves
39/// `"M31"` from the cache alone — no network call, so it runs without
40/// [`crate::OfflineResolver`] ever reaching a resolver backend.
41///
42/// ```
43/// use simbad_resolver::{
44/// AliasKind, BatchResolver, Cache, ObjectType, OfflineResolver, ResolvedAlias,
45/// ResolvedIdentity, ResolverConfig, Store, TargetSource,
46/// };
47///
48/// # async fn demo() -> Result<(), simbad_resolver::Error> {
49/// let store = Store::in_memory()?;
50/// let config = ResolverConfig::new("guide.example");
51/// let namespace = config.namespace;
52///
53/// let m31 = ResolvedIdentity {
54/// simbad_oid: Some(1_575_544),
55/// primary_designation: "M 31".to_owned(),
56/// common_name: None,
57/// object_type: ObjectType::Galaxy,
58/// otype_raw: "G".to_owned(),
59/// ra_deg: 10.684_708,
60/// dec_deg: 41.268_75,
61/// v_mag: Some(3.44),
62/// aliases: vec![ResolvedAlias::new("M 31", AliasKind::Designation)],
63/// source: TargetSource::Seed,
64/// };
65/// store.cache().upsert(&m31, &namespace).await?;
66///
67/// let batch = BatchResolver::new(OfflineResolver, store.cache(), store.queue(), config)
68/// .with_batch_size(8);
69/// batch.enqueue("job-1", "M31").await?;
70///
71/// let summary = batch.drain().await?;
72/// assert_eq!(summary.resolved, 1, "cache hit, no resolver call needed");
73/// # Ok(()) }
74/// ```
75pub struct BatchResolver<R: Resolver> {
76 resolver: R,
77 cache: Arc<dyn Cache>,
78 queue: Arc<dyn Queue>,
79 config: ResolverConfig,
80 batch_size: usize,
81}
82
83impl<R: Resolver> BatchResolver<R> {
84 /// Construct a batch resolver from caller-supplied cache and queue backends
85 /// — typically a [`Store`](crate::Store)'s `.cache()` and `.queue()` over
86 /// one shared database.
87 ///
88 /// ```
89 /// use simbad_resolver::{BatchResolver, OfflineResolver, ResolverConfig, Store};
90 ///
91 /// # fn run() -> Result<(), simbad_resolver::CacheError> {
92 /// let store = Store::in_memory()?;
93 /// let batch =
94 /// BatchResolver::new(OfflineResolver, store.cache(), store.queue(), ResolverConfig::new("x"));
95 /// # let _ = batch;
96 /// # Ok(()) }
97 /// ```
98 pub fn new(
99 resolver: R,
100 cache: impl Cache + 'static,
101 queue: impl Queue + 'static,
102 config: ResolverConfig,
103 ) -> Self {
104 Self { resolver, cache: Arc::new(cache), queue: Arc::new(queue), config, batch_size: 16 }
105 }
106
107 /// Set how many pending items are claimed per round (min 1).
108 ///
109 /// ```
110 /// use simbad_resolver::{BatchResolver, OfflineResolver, ResolverConfig, Store};
111 ///
112 /// # fn run() -> Result<(), simbad_resolver::CacheError> {
113 /// let store = Store::in_memory()?;
114 /// let batch =
115 /// BatchResolver::new(OfflineResolver, store.cache(), store.queue(), ResolverConfig::new("x"))
116 /// .with_batch_size(0); // clamped to 1
117 /// # let _ = batch;
118 /// # Ok(()) }
119 /// ```
120 #[must_use]
121 pub fn with_batch_size(mut self, n: usize) -> Self {
122 self.batch_size = n.max(1);
123 self
124 }
125
126 /// Borrow the underlying queue.
127 ///
128 /// ```
129 /// use simbad_resolver::{BatchResolver, OfflineResolver, ResolverConfig, Store};
130 ///
131 /// # async fn run() -> Result<(), simbad_resolver::Error> {
132 /// let store = Store::in_memory()?;
133 /// let batch =
134 /// BatchResolver::new(OfflineResolver, store.cache(), store.queue(), ResolverConfig::new("x"));
135 /// assert_eq!(batch.queue().pending_count().await?, 0);
136 /// # Ok(()) }
137 /// ```
138 pub fn queue(&self) -> &dyn Queue {
139 self.queue.as_ref()
140 }
141
142 /// Enqueue an identifier keyed by an opaque caller id (idempotent).
143 ///
144 /// ```
145 /// use simbad_resolver::{BatchResolver, OfflineResolver, ResolverConfig, Store};
146 ///
147 /// # async fn run() -> Result<(), simbad_resolver::Error> {
148 /// let store = Store::in_memory()?;
149 /// let batch =
150 /// BatchResolver::new(OfflineResolver, store.cache(), store.queue(), ResolverConfig::new("x"));
151 /// batch.enqueue("job-1", "M31").await?;
152 /// batch.enqueue("job-1", "M31").await?; // idempotent: still one pending item
153 /// assert_eq!(batch.queue().pending_count().await?, 1);
154 /// # Ok(()) }
155 /// ```
156 pub async fn enqueue(&self, id: &str, query: &str) -> Result<(), Error> {
157 self.queue.enqueue(id, query).await?;
158 Ok(())
159 }
160
161 /// Drain the pending queue once: resolve each pending item cache-first then
162 /// online, marking resolved/unresolved or leaving it pending on a transient
163 /// failure. Returns a [`DrainSummary`]. Terminates once every currently
164 /// pending item has been processed (transiently-failed items are retried on
165 /// a subsequent call).
166 ///
167 /// See the [struct-level example](Self) for a full seed-then-drain walkthrough.
168 ///
169 /// ```
170 /// use simbad_resolver::{BatchResolver, OfflineResolver, ResolverConfig, Store};
171 ///
172 /// # async fn run() -> Result<(), simbad_resolver::Error> {
173 /// let store = Store::in_memory()?;
174 /// let batch =
175 /// BatchResolver::new(OfflineResolver, store.cache(), store.queue(), ResolverConfig::new("x"));
176 /// batch.enqueue("job-1", "does-not-exist").await?;
177 ///
178 /// // OfflineResolver reports `Disabled` (transient), so the item stays pending.
179 /// let summary = batch.drain().await?;
180 /// assert_eq!(summary.still_pending, 1);
181 /// # Ok(()) }
182 /// ```
183 pub async fn drain(&self) -> Result<DrainSummary, Error> {
184 let mut summary = DrainSummary::default();
185 let mut seen: HashSet<String> = HashSet::new();
186 loop {
187 let batch = self.queue.claim_pending(self.batch_size).await?;
188 let fresh: Vec<_> = batch.into_iter().filter(|it| !seen.contains(&it.id)).collect();
189 if fresh.is_empty() {
190 break;
191 }
192 for item in fresh {
193 seen.insert(item.id.clone());
194 match resolve_core(&self.resolver, self.cache.as_ref(), &self.config, &item.query)
195 .await?
196 {
197 Resolution::Resolved(target) => {
198 self.queue.mark_resolved(&item.id, target.id).await?;
199 summary.resolved += 1;
200 }
201 Resolution::Unresolved { reason: UnresolvedReason::Offline, .. } => {
202 self.queue.release(&item.id).await?;
203 summary.still_pending += 1;
204 }
205 Resolution::Unresolved { .. } => {
206 self.queue.mark_unresolved(&item.id).await?;
207 summary.unresolved += 1;
208 }
209 }
210 }
211 }
212 Ok(summary)
213 }
214}