Line data Source code
1 : /// Reasons for downloads or listings to fail.
2 0 : #[derive(Debug)]
3 : pub enum DownloadError {
4 : /// Validation or other error happened due to user input.
5 : BadInput(anyhow::Error),
6 : /// The file was not found in the remote storage.
7 : NotFound,
8 : /// A cancellation token aborted the download, typically during
9 : /// tenant detach or process shutdown.
10 : Cancelled,
11 : /// A timeout happened while executing the request. Possible reasons:
12 : /// - stuck tcp connection
13 : ///
14 : /// Concurrency control is not timed within timeout.
15 : Timeout,
16 : /// The file was found in the remote storage, but the download failed.
17 : Other(anyhow::Error),
18 : }
19 :
20 : impl std::fmt::Display for DownloadError {
21 5 : fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
22 5 : match self {
23 0 : DownloadError::BadInput(e) => {
24 0 : write!(f, "Failed to download a remote file due to user input: {e}")
25 : }
26 0 : DownloadError::NotFound => write!(f, "No file found for the remote object id given"),
27 0 : DownloadError::Cancelled => write!(f, "Cancelled, shutting down"),
28 0 : DownloadError::Timeout => write!(f, "timeout"),
29 5 : DownloadError::Other(e) => write!(f, "Failed to download a remote file: {e:?}"),
30 : }
31 5 : }
32 : }
33 :
34 : impl std::error::Error for DownloadError {}
35 :
36 : impl DownloadError {
37 : /// Returns true if the error should not be retried with backoff
38 14 : pub fn is_permanent(&self) -> bool {
39 14 : use DownloadError::*;
40 14 : match self {
41 14 : BadInput(_) | NotFound | Cancelled => true,
42 0 : Timeout | Other(_) => false,
43 : }
44 14 : }
45 : }
46 :
47 : impl From<std::io::Error> for DownloadError {
48 4 : fn from(value: std::io::Error) -> Self {
49 4 : let needs_unwrap = value.kind() == std::io::ErrorKind::Other
50 4 : && value
51 4 : .get_ref()
52 4 : .and_then(|x| x.downcast_ref::<DownloadError>())
53 4 : .is_some();
54 :
55 4 : if needs_unwrap {
56 4 : *value
57 4 : .into_inner()
58 4 : .expect("just checked")
59 4 : .downcast::<DownloadError>()
60 4 : .expect("just checked")
61 : } else {
62 0 : DownloadError::Other(value.into())
63 : }
64 4 : }
65 : }
66 :
67 0 : #[derive(Debug)]
68 : pub enum TimeTravelError {
69 : /// Validation or other error happened due to user input.
70 : BadInput(anyhow::Error),
71 : /// The used remote storage does not have time travel recovery implemented
72 : Unimplemented,
73 : /// The number of versions/deletion markers is above our limit.
74 : TooManyVersions,
75 : /// A cancellation token aborted the process, typically during
76 : /// request closure or process shutdown.
77 : Cancelled,
78 : /// Other errors
79 : Other(anyhow::Error),
80 : }
81 :
82 : impl std::fmt::Display for TimeTravelError {
83 0 : fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
84 0 : match self {
85 0 : TimeTravelError::BadInput(e) => {
86 0 : write!(
87 0 : f,
88 0 : "Failed to time travel recover a prefix due to user input: {e}"
89 0 : )
90 : }
91 0 : TimeTravelError::Unimplemented => write!(
92 0 : f,
93 0 : "time travel recovery is not implemented for the current storage backend"
94 0 : ),
95 0 : TimeTravelError::Cancelled => write!(f, "Cancelled, shutting down"),
96 : TimeTravelError::TooManyVersions => {
97 0 : write!(f, "Number of versions/delete markers above limit")
98 : }
99 0 : TimeTravelError::Other(e) => write!(f, "Failed to time travel recover a prefix: {e:?}"),
100 : }
101 0 : }
102 : }
103 :
104 : impl std::error::Error for TimeTravelError {}
105 :
106 : /// Plain cancelled error.
107 : ///
108 : /// By design this type does not not implement `std::error::Error` so it cannot be put as the root
109 : /// cause of `std::io::Error` or `anyhow::Error`. It should never need to be exposed out of this
110 : /// crate.
111 : ///
112 : /// It exists to implement permit acquiring in `{Download,TimeTravel}Error` and `anyhow::Error` returning
113 : /// operations and ensuring that those get converted to proper versions with just `?`.
114 0 : #[derive(Debug)]
115 : pub(crate) struct Cancelled;
116 :
117 : impl From<Cancelled> for anyhow::Error {
118 0 : fn from(_: Cancelled) -> Self {
119 0 : anyhow::Error::new(TimeoutOrCancel::Cancel)
120 0 : }
121 : }
122 :
123 : impl From<Cancelled> for TimeTravelError {
124 0 : fn from(_: Cancelled) -> Self {
125 0 : TimeTravelError::Cancelled
126 0 : }
127 : }
128 :
129 : impl From<Cancelled> for TimeoutOrCancel {
130 0 : fn from(_: Cancelled) -> Self {
131 0 : TimeoutOrCancel::Cancel
132 0 : }
133 : }
134 :
135 : impl From<Cancelled> for DownloadError {
136 0 : fn from(_: Cancelled) -> Self {
137 0 : DownloadError::Cancelled
138 0 : }
139 : }
140 :
141 : /// This type is used at as the root cause for timeouts and cancellations with `anyhow::Error` returning
142 : /// RemoteStorage methods.
143 : ///
144 : /// For use with `utils::backoff::retry` and `anyhow::Error` returning operations there is
145 : /// `TimeoutOrCancel::caused_by_cancel` method to query "proper form" errors.
146 0 : #[derive(Debug)]
147 : pub enum TimeoutOrCancel {
148 : Timeout,
149 : Cancel,
150 : }
151 :
152 : impl std::fmt::Display for TimeoutOrCancel {
153 0 : fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
154 0 : use TimeoutOrCancel::*;
155 0 : match self {
156 0 : Timeout => write!(f, "timeout"),
157 0 : Cancel => write!(f, "cancel"),
158 : }
159 0 : }
160 : }
161 :
162 : impl std::error::Error for TimeoutOrCancel {}
163 :
164 : impl TimeoutOrCancel {
165 : /// Returns true if the error was caused by [`TimeoutOrCancel::Cancel`].
166 26 : pub fn caused_by_cancel(error: &anyhow::Error) -> bool {
167 26 : error
168 26 : .root_cause()
169 26 : .downcast_ref::<Self>()
170 26 : .is_some_and(Self::is_cancel)
171 26 : }
172 :
173 2 : pub fn is_cancel(&self) -> bool {
174 2 : matches!(self, TimeoutOrCancel::Cancel)
175 2 : }
176 :
177 0 : pub fn is_timeout(&self) -> bool {
178 0 : matches!(self, TimeoutOrCancel::Timeout)
179 0 : }
180 : }
181 :
182 : /// This conversion is used when [`crate::support::DownloadStream`] notices a cancellation or
183 : /// timeout to wrap it in an `std::io::Error`.
184 : impl From<TimeoutOrCancel> for std::io::Error {
185 8 : fn from(value: TimeoutOrCancel) -> Self {
186 8 : let e = DownloadError::from(value);
187 8 : std::io::Error::other(e)
188 8 : }
189 : }
190 :
191 : impl From<TimeoutOrCancel> for DownloadError {
192 8 : fn from(value: TimeoutOrCancel) -> Self {
193 8 : use TimeoutOrCancel::*;
194 8 :
195 8 : match value {
196 4 : Timeout => DownloadError::Timeout,
197 4 : Cancel => DownloadError::Cancelled,
198 : }
199 8 : }
200 : }
|
