versatiles_core 4.0.0

A toolbox for converting, checking and serving map tiles in various formats.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
use super::DataWriterTrait;
use crate::{Blob, ByteRange};
use anyhow::{Context, Result, bail};
use std::{thread, time::Duration};

const MAX_RETRIES: u32 = 2;

/// Exponential backoff unit for retry waits.
///
/// In production this is one second so retries wait 1 s, 2 s, … In tests the
/// unit shrinks to a few milliseconds to keep the retry-path tests fast while
/// still exercising the `thread::sleep` call itself.
#[cfg(not(test))]
const BACKOFF: fn(u32) -> Duration = |exp| Duration::from_secs(1 << exp);
#[cfg(test)]
const BACKOFF: fn(u32) -> Duration = |exp| Duration::from_millis(1 << exp);

/// Trait for network-based data writers (SFTP, cloud storage, etc.)
/// that need retry logic with reconnection.
///
/// Implementors provide single-attempt operations and reconnection logic.
/// The default `network_*` methods handle retry loops with exponential backoff.
pub(crate) trait NetworkWriter: DataWriterTrait {
	/// Single-attempt write at current position.
	fn try_append(&mut self, blob: &Blob) -> Result<ByteRange>;

	/// Single-attempt: seek to `offset`, write `blob`, seek back to `restore_pos`.
	fn try_write_at(&mut self, offset: u64, blob: &Blob, restore_pos: u64) -> Result<()>;

	/// Single-attempt seek to `position`.
	fn try_seek(&mut self, position: u64) -> Result<()>;

	/// Re-establish the connection (new session, reopen file, seek to tracked position).
	fn reconnect(&mut self) -> Result<()>;

	/// Display name for log messages.
	fn writer_name(&self) -> &str;

	/// Current tracked write position (no I/O).
	fn tracked_position(&self) -> u64;

	/// Append with retry and reconnect on failure.
	fn network_append(&mut self, blob: &Blob) -> Result<ByteRange> {
		let name = self.writer_name().to_string();
		let pos = self.tracked_position();
		let blob_len = blob.len();
		let total_attempts = MAX_RETRIES + 1;

		for attempt in 0..=MAX_RETRIES {
			if attempt > 0 {
				let backoff = BACKOFF(attempt - 1);
				log::warn!(
					"write to '{name}' at position {pos}: retrying (attempt {}/{total_attempts}, waiting {backoff:?})",
					attempt + 1
				);
				thread::sleep(backoff);

				if let Err(e) = self.reconnect() {
					log::warn!(
						"write to '{name}' at position {pos}: reconnect failed (attempt {}/{total_attempts}): {e}",
						attempt + 1
					);
					if attempt >= MAX_RETRIES {
						return Err(e).with_context(|| {
							format!("could not write {blob_len} bytes at position {pos} to '{name}': reconnect failed — gave up after {total_attempts} attempts")
						});
					}
					continue;
				}
			}

			match self.try_append(blob) {
				Ok(range) => return Ok(range),
				Err(e) if attempt < MAX_RETRIES => {
					log::warn!(
						"write to '{name}' at position {pos}: {e} (attempt {}/{total_attempts}), will retry",
						attempt + 1
					);
				}
				Err(e) => {
					return Err(e).with_context(|| {
						format!(
							"could not write {blob_len} bytes at position {pos} to '{name}' — gave up after {total_attempts} attempts"
						)
					});
				}
			}
		}

		bail!("retry loop exited without returning — MAX_RETRIES invariant violated")
	}

	/// Write at start of file with retry and reconnect on failure.
	fn network_write_start(&mut self, blob: &Blob) -> Result<()> {
		let name = self.writer_name().to_string();
		let blob_len = blob.len();
		let total_attempts = MAX_RETRIES + 1;

		for attempt in 0..=MAX_RETRIES {
			let restore_pos = self.tracked_position();

			if attempt > 0 {
				let backoff = BACKOFF(attempt - 1);
				log::warn!(
					"write_start to '{name}': retrying (attempt {}/{total_attempts}, waiting {backoff:?})",
					attempt + 1
				);
				thread::sleep(backoff);

				if let Err(e) = self.reconnect() {
					log::warn!(
						"write_start to '{name}': reconnect failed (attempt {}/{total_attempts}): {e}",
						attempt + 1
					);
					if attempt >= MAX_RETRIES {
						return Err(e).with_context(|| {
							format!("could not write {blob_len} bytes at start of '{name}': reconnect failed — gave up after {total_attempts} attempts")
						});
					}
					continue;
				}
			}

			match self.try_write_at(0, blob, restore_pos) {
				Ok(()) => return Ok(()),
				Err(e) if attempt < MAX_RETRIES => {
					log::warn!(
						"write_start to '{name}': {e} (attempt {}/{total_attempts}), will retry",
						attempt + 1
					);
				}
				Err(e) => {
					return Err(e).with_context(|| {
						format!(
							"could not write {blob_len} bytes at start of '{name}' — gave up after {total_attempts} attempts"
						)
					});
				}
			}
		}

		bail!("retry loop exited without returning — MAX_RETRIES invariant violated")
	}

	/// Seek with retry and reconnect on failure.
	fn network_set_position(&mut self, position: u64) -> Result<()> {
		let name = self.writer_name().to_string();
		let total_attempts = MAX_RETRIES + 1;

		for attempt in 0..=MAX_RETRIES {
			if attempt > 0 {
				let backoff = BACKOFF(attempt - 1);
				log::warn!(
					"seek in '{name}' to position {position}: retrying (attempt {}/{total_attempts}, waiting {backoff:?})",
					attempt + 1
				);
				thread::sleep(backoff);

				if let Err(e) = self.reconnect() {
					log::warn!(
						"seek in '{name}' to position {position}: reconnect failed (attempt {}/{total_attempts}): {e}",
						attempt + 1
					);
					if attempt >= MAX_RETRIES {
						return Err(e).with_context(|| {
							format!(
								"could not seek to position {position} in '{name}': reconnect failed — gave up after {total_attempts} attempts"
							)
						});
					}
					continue;
				}
			}

			match self.try_seek(position) {
				Ok(()) => return Ok(()),
				Err(e) if attempt < MAX_RETRIES => {
					log::warn!(
						"seek in '{name}' to position {position}: {e} (attempt {}/{total_attempts}), will retry",
						attempt + 1
					);
				}
				Err(e) => {
					return Err(e).with_context(|| {
						format!("could not seek to position {position} in '{name}' — gave up after {total_attempts} attempts")
					});
				}
			}
		}

		bail!("retry loop exited without returning — MAX_RETRIES invariant violated")
	}
}

#[cfg(test)]
mod tests {
	use super::*;
	use anyhow::anyhow;
	use std::collections::VecDeque;

	/// In-memory NetworkWriter stub. Each `try_*` / `reconnect` call pops the
	/// next programmed outcome from its queue; `()` means success.
	struct FakeWriter {
		name: String,
		position: u64,
		appended: Vec<u8>,
		written_at_start: Option<Vec<u8>>,
		append_outcomes: VecDeque<Result<()>>,
		write_at_outcomes: VecDeque<Result<()>>,
		seek_outcomes: VecDeque<Result<()>>,
		reconnect_outcomes: VecDeque<Result<()>>,
		append_calls: u32,
		write_at_calls: u32,
		seek_calls: u32,
		reconnect_calls: u32,
	}

	impl FakeWriter {
		fn new() -> Self {
			Self {
				name: "fake".to_string(),
				position: 0,
				appended: Vec::new(),
				written_at_start: None,
				append_outcomes: VecDeque::new(),
				write_at_outcomes: VecDeque::new(),
				seek_outcomes: VecDeque::new(),
				reconnect_outcomes: VecDeque::new(),
				append_calls: 0,
				write_at_calls: 0,
				seek_calls: 0,
				reconnect_calls: 0,
			}
		}
	}

	impl DataWriterTrait for FakeWriter {
		fn append(&mut self, _blob: &Blob) -> Result<ByteRange> {
			unreachable!("FakeWriter uses try_append via NetworkWriter default impl")
		}
		fn write_start(&mut self, _blob: &Blob) -> Result<()> {
			unreachable!("FakeWriter uses try_write_at via NetworkWriter default impl")
		}
		fn position(&mut self) -> Result<u64> {
			Ok(self.position)
		}
		fn set_position(&mut self, p: u64) -> Result<()> {
			self.position = p;
			Ok(())
		}
	}

	impl NetworkWriter for FakeWriter {
		fn try_append(&mut self, blob: &Blob) -> Result<ByteRange> {
			self.append_calls += 1;
			let outcome = self.append_outcomes.pop_front().unwrap_or(Ok(()));
			outcome?;
			let pos = self.position;
			self.appended.extend_from_slice(blob.as_slice());
			self.position += blob.len();
			Ok(ByteRange::new(pos, blob.len()))
		}
		fn try_write_at(&mut self, offset: u64, blob: &Blob, restore_pos: u64) -> Result<()> {
			self.write_at_calls += 1;
			let outcome = self.write_at_outcomes.pop_front().unwrap_or(Ok(()));
			outcome?;
			assert_eq!(offset, 0);
			self.written_at_start = Some(blob.as_slice().to_vec());
			self.position = restore_pos;
			Ok(())
		}
		fn try_seek(&mut self, position: u64) -> Result<()> {
			self.seek_calls += 1;
			let outcome = self.seek_outcomes.pop_front().unwrap_or(Ok(()));
			outcome?;
			self.position = position;
			Ok(())
		}
		fn reconnect(&mut self) -> Result<()> {
			self.reconnect_calls += 1;
			self.reconnect_outcomes.pop_front().unwrap_or(Ok(()))
		}
		fn writer_name(&self) -> &str {
			&self.name
		}
		fn tracked_position(&self) -> u64 {
			self.position
		}
	}

	// ── network_append ────────────────────────────────────────────────────────

	#[test]
	fn network_append_succeeds_on_first_attempt() {
		let mut w = FakeWriter::new();
		let range = w.network_append(&Blob::from(vec![1, 2, 3])).unwrap();
		assert_eq!(range, ByteRange::new(0, 3));
		assert_eq!(w.append_calls, 1);
		assert_eq!(w.reconnect_calls, 0);
		assert_eq!(w.appended, vec![1, 2, 3]);
	}

	#[test]
	fn network_append_recovers_on_retry() {
		let mut w = FakeWriter::new();
		w.append_outcomes.push_back(Err(anyhow!("transient")));
		let range = w.network_append(&Blob::from(vec![7, 8])).unwrap();
		assert_eq!(range, ByteRange::new(0, 2));
		assert_eq!(w.append_calls, 2);
		assert_eq!(w.reconnect_calls, 1); // one reconnect before attempt 1
	}

	#[test]
	fn network_append_gives_up_after_max_retries() {
		let mut w = FakeWriter::new();
		for _ in 0..=MAX_RETRIES {
			w.append_outcomes.push_back(Err(anyhow!("disk full")));
		}
		let err = w.network_append(&Blob::from(vec![1])).unwrap_err();
		let msg = format!("{err:#}");
		assert!(msg.contains("gave up"));
		assert!(msg.contains("disk full"));
		assert_eq!(w.append_calls, MAX_RETRIES + 1);
	}

	#[test]
	fn network_append_reconnect_failure_retries_until_exhaustion() {
		let mut w = FakeWriter::new();
		// Fail first attempt, then fail all reconnects.
		w.append_outcomes.push_back(Err(anyhow!("boom")));
		for _ in 0..=MAX_RETRIES {
			w.reconnect_outcomes.push_back(Err(anyhow!("link down")));
		}
		let err = w.network_append(&Blob::from(vec![1])).unwrap_err();
		let msg = format!("{err:#}");
		assert!(msg.contains("reconnect failed"));
		assert!(msg.contains("link down"));
	}

	#[test]
	fn network_append_reconnect_recovers_before_exhaustion() {
		let mut w = FakeWriter::new();
		// Attempt 0 fails; reconnect before attempt 1 fails too; reconnect before
		// attempt 2 succeeds and try_append then succeeds.
		w.append_outcomes.push_back(Err(anyhow!("boom")));
		w.reconnect_outcomes.push_back(Err(anyhow!("still down")));
		w.reconnect_outcomes.push_back(Ok(()));
		let range = w.network_append(&Blob::from(vec![9])).unwrap();
		assert_eq!(range.length, 1);
		assert_eq!(w.reconnect_calls, 2);
		// attempt 0: try_append (err); attempt 1: reconnect (err, continue) — no try_append;
		// attempt 2: reconnect (ok); try_append (ok) → 2 append calls total.
		assert_eq!(w.append_calls, 2);
	}

	// ── network_write_start ───────────────────────────────────────────────────

	#[test]
	fn network_write_start_succeeds_on_first_attempt() {
		let mut w = FakeWriter::new();
		w.position = 42; // should be restored after
		w.network_write_start(&Blob::from(vec![0xAA, 0xBB])).unwrap();
		assert_eq!(w.write_at_calls, 1);
		assert_eq!(w.written_at_start.unwrap(), vec![0xAA, 0xBB]);
		assert_eq!(w.position, 42);
	}

	#[test]
	fn network_write_start_recovers_on_retry() {
		let mut w = FakeWriter::new();
		w.write_at_outcomes.push_back(Err(anyhow!("transient")));
		w.network_write_start(&Blob::from(vec![1])).unwrap();
		assert_eq!(w.write_at_calls, 2);
	}

	#[test]
	fn network_write_start_gives_up_after_max_retries() {
		let mut w = FakeWriter::new();
		for _ in 0..=MAX_RETRIES {
			w.write_at_outcomes.push_back(Err(anyhow!("nope")));
		}
		let err = w.network_write_start(&Blob::from(vec![1])).unwrap_err();
		assert!(format!("{err:#}").contains("gave up"));
	}

	#[test]
	fn network_write_start_reconnect_failure_surfaces() {
		let mut w = FakeWriter::new();
		w.write_at_outcomes.push_back(Err(anyhow!("boom")));
		for _ in 0..=MAX_RETRIES {
			w.reconnect_outcomes.push_back(Err(anyhow!("link down")));
		}
		let err = w.network_write_start(&Blob::from(vec![1])).unwrap_err();
		let msg = format!("{err:#}");
		assert!(msg.contains("reconnect failed"));
	}

	// ── network_set_position ──────────────────────────────────────────────────

	#[test]
	fn network_set_position_succeeds_on_first_attempt() {
		let mut w = FakeWriter::new();
		w.network_set_position(123).unwrap();
		assert_eq!(w.position, 123);
		assert_eq!(w.seek_calls, 1);
		assert_eq!(w.reconnect_calls, 0);
	}

	#[test]
	fn network_set_position_recovers_on_retry() {
		let mut w = FakeWriter::new();
		w.seek_outcomes.push_back(Err(anyhow!("transient")));
		w.network_set_position(77).unwrap();
		assert_eq!(w.position, 77);
		assert_eq!(w.seek_calls, 2);
		assert_eq!(w.reconnect_calls, 1);
	}

	#[test]
	fn network_set_position_gives_up_after_max_retries() {
		let mut w = FakeWriter::new();
		for _ in 0..=MAX_RETRIES {
			w.seek_outcomes.push_back(Err(anyhow!("eof")));
		}
		let err = w.network_set_position(1).unwrap_err();
		let msg = format!("{err:#}");
		assert!(msg.contains("gave up"));
		assert!(msg.contains("eof"));
	}

	#[test]
	fn network_set_position_reconnect_failure_surfaces() {
		let mut w = FakeWriter::new();
		w.seek_outcomes.push_back(Err(anyhow!("boom")));
		for _ in 0..=MAX_RETRIES {
			w.reconnect_outcomes.push_back(Err(anyhow!("link down")));
		}
		let err = w.network_set_position(9).unwrap_err();
		assert!(format!("{err:#}").contains("reconnect failed"));
	}
}