rusty-cat 0.2.4

Async HTTP client for resumable file upload and download.
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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
use std::sync::Arc;

use async_trait::async_trait;
use reqwest::header::{CONTENT_LENGTH, CONTENT_TYPE, ETAG};
use reqwest::{Method, Url};
use tokio::sync::Mutex;

use super::constants::{
    DEFAULT_UPLOAD_CONTENT_TYPE, MAX_OSS_PART_NUMBER, OSS_COMPLETE_ADDITIONAL_HEADERS,
    OSS_COMPLETE_ALL_HEADER, OSS_COMPLETE_ALL_VALUE, OSS_LIST_MAX_PARTS, OSS_LIST_MAX_UPLOADS,
};
use super::multipart_session::MultipartSession;
use super::signing::{header_value, param_error, signed_headers};
use super::xml::{extract_part_numbers, extract_upload_ids_for_key, extract_xml_tag};
use crate::http_breakpoint::UploadResumeInfo;
use crate::upload_trait::{UploadChunkCtx, UploadPrepareCtx};
use crate::{BreakpointUpload, InnerErrorCode, MeowError, TransferTask};

/// Aliyun OSS direct multipart upload protocol using AccessKey signing.
#[derive(Clone)]
pub struct AliOssDirectUpload {
    bucket: String,
    access_key_id: String,
    access_key_secret: String,
    region: String,
    session: Arc<Mutex<MultipartSession>>,
}

impl AliOssDirectUpload {
    pub fn new(
        bucket: impl Into<String>,
        access_key_id: impl Into<String>,
        access_key_secret: impl Into<String>,
        region: impl Into<String>,
    ) -> Self {
        Self {
            bucket: bucket.into(),
            access_key_id: access_key_id.into(),
            access_key_secret: access_key_secret.into(),
            region: region.into(),
            session: Arc::new(Mutex::new(MultipartSession::default())),
        }
    }

    fn bucket_canonical_uri(&self) -> String {
        format!("/{}/", self.bucket)
    }

    fn object_key_from_task_url(&self, task: &TransferTask) -> Result<String, MeowError> {
        let url = Url::parse(task.url()).map_err(param_error)?;
        Ok(url.path().trim_start_matches('/').to_string())
    }

    fn object_canonical_uri_from_task_url(&self, task: &TransferTask) -> Result<String, MeowError> {
        let url = Url::parse(task.url()).map_err(param_error)?;
        Ok(format!("/{}{}", self.bucket, url.path()))
    }

    fn build_signed_headers(
        &self,
        method: &str,
        canonical_uri: &str,
        raw_query: Option<&str>,
        sign_pairs: &[(&str, &str)],
        additional_headers: Option<&str>,
    ) -> Result<reqwest::header::HeaderMap, MeowError> {
        signed_headers(
            method,
            canonical_uri,
            raw_query,
            sign_pairs,
            additional_headers,
            self.access_key_id.as_str(),
            self.access_key_secret.as_str(),
            self.region.as_str(),
        )
    }

    async fn initiate_multipart_upload(
        &self,
        client: &reqwest::Client,
        task: &TransferTask,
    ) -> Result<String, MeowError> {
        let canonical_uri = self.object_canonical_uri_from_task_url(task)?;
        let mut url = Url::parse(task.url()).map_err(param_error)?;
        url.set_query(Some("uploads"));
        let raw_query = url.query().unwrap_or("uploads");
        let headers =
            self.build_signed_headers("POST", &canonical_uri, Some(raw_query), &[], None)?;
        let resp = client
            .request(Method::POST, url)
            .headers(headers)
            .send()
            .await
            .map_err(|e| {
                MeowError::from_source(
                    InnerErrorCode::HttpError,
                    "oss initiate multipart failed",
                    e,
                )
            })?;
        let status = resp.status();
        let body = resp.text().await.unwrap_or_default();
        if !status.is_success() {
            return Err(MeowError::from_code(
                InnerErrorCode::ResponseStatusError,
                format!("oss initiate multipart failed: {status}, body: {body}"),
            ));
        }
        extract_xml_tag(&body, "UploadId").ok_or_else(|| {
            MeowError::from_code(
                InnerErrorCode::ResponseParseError,
                format!("oss initiate multipart missing UploadId: {body}"),
            )
        })
    }

    async fn try_adopt_upload_id_from_list(
        &self,
        client: &reqwest::Client,
        task: &TransferTask,
    ) -> Result<Option<String>, MeowError> {
        let object_key = self.object_key_from_task_url(task)?;
        let mut url = Url::parse(task.url()).map_err(param_error)?;
        url.set_path("/");
        {
            let mut pairs = url.query_pairs_mut();
            pairs.append_pair("uploads", "");
            pairs.append_pair("prefix", &object_key);
            pairs.append_pair("max-uploads", OSS_LIST_MAX_UPLOADS);
        }
        let raw_query = url.query().ok_or_else(|| {
            MeowError::from_code_str(
                InnerErrorCode::ParameterEmpty,
                "build list multipart query failed",
            )
        })?;
        let headers = self.build_signed_headers(
            "GET",
            self.bucket_canonical_uri().as_str(),
            Some(raw_query),
            &[],
            None,
        )?;
        let resp = client
            .request(Method::GET, url)
            .headers(headers)
            .send()
            .await
            .map_err(|e| {
                MeowError::from_source(
                    InnerErrorCode::HttpError,
                    "oss list multipart uploads failed",
                    e,
                )
            })?;
        let status = resp.status();
        let body = resp.text().await.unwrap_or_default();
        if !status.is_success() {
            return Err(MeowError::from_code(
                InnerErrorCode::ResponseStatusError,
                format!("oss list multipart uploads failed: {status}, body: {body}"),
            ));
        }
        let ids = extract_upload_ids_for_key(&body, &object_key);
        if ids.len() > 1 {
            return Err(MeowError::from_code(
                InnerErrorCode::InvalidTaskState,
                format!("found multiple multipart sessions for object '{object_key}'"),
            ));
        }
        Ok(ids.into_iter().next())
    }

    async fn list_uploaded_part_numbers(
        &self,
        client: &reqwest::Client,
        task: &TransferTask,
        upload_id: &str,
    ) -> Result<Vec<u64>, MeowError> {
        let canonical_uri = self.object_canonical_uri_from_task_url(task)?;
        let (url, raw_query) = Self::build_query_url(
            task,
            &[
                ("uploadId", upload_id.to_string()),
                ("max-parts", OSS_LIST_MAX_PARTS.to_string()),
            ],
        )?;
        let headers =
            self.build_signed_headers("GET", &canonical_uri, Some(raw_query.as_str()), &[], None)?;
        let resp = client
            .request(Method::GET, url)
            .headers(headers)
            .send()
            .await
            .map_err(|e| {
                MeowError::from_source(InnerErrorCode::HttpError, "oss list parts failed", e)
            })?;
        let status = resp.status();
        let body = resp.text().await.unwrap_or_default();
        if !status.is_success() {
            return Err(MeowError::from_code(
                InnerErrorCode::ResponseStatusError,
                format!("oss list parts failed: {status}, body: {body}"),
            ));
        }
        Ok(extract_part_numbers(&body))
    }

    fn build_query_url(
        task: &TransferTask,
        query_pairs: &[(&str, String)],
    ) -> Result<(Url, String), MeowError> {
        let mut url = Url::parse(task.url()).map_err(param_error)?;
        {
            let mut pairs = url.query_pairs_mut();
            for (k, v) in query_pairs {
                pairs.append_pair(k, v.as_str());
            }
        }
        let query = url.query().map(|q| q.to_string()).ok_or_else(|| {
            MeowError::from_code_str(InnerErrorCode::ParameterEmpty, "build query url failed")
        })?;
        Ok((url, query))
    }

    /// Returns the active multipart `UploadId` for the current session, if any.
    ///
    /// Callers can persist this id (it is not a credential) so that an orphaned
    /// multipart upload — for example one left behind by a process crash — can be
    /// aborted later via [`AliOssDirectUpload::abort_multipart`], stopping the
    /// uncommitted parts from accruing OSS storage cost. Returns `None` before
    /// `prepare` has initiated/adopted a session, or after a successful
    /// complete/abort.
    pub async fn current_upload_id(&self) -> Option<String> {
        self.session.lock().await.upload_id.clone()
    }

    /// Sends `AbortMultipartUpload` (`DELETE ?uploadId=...`) for an explicit
    /// upload id without reading or mutating the in-memory session state.
    ///
    /// Use this to clean up an orphaned multipart session recovered from durable
    /// storage (see [`AliOssDirectUpload::current_upload_id`]) after the original
    /// task or process is gone. A `404 Not Found` is treated as success because
    /// the session may already have expired or been aborted.
    ///
    /// # Errors
    ///
    /// Returns [`MeowError`] when signing, the network request, or the server
    /// response indicates the abort did not succeed.
    pub async fn abort_multipart(
        &self,
        client: &reqwest::Client,
        task: &TransferTask,
        upload_id: &str,
    ) -> Result<(), MeowError> {
        self.send_abort_multipart(client, task, upload_id).await
    }

    /// Shared `AbortMultipartUpload` request used by both the cancel hook and the
    /// out-of-band [`AliOssDirectUpload::abort_multipart`] cleanup path.
    ///
    /// The `upload_id` is an OSS multipart session id, not a credential, so it is
    /// safe to surface in error messages to make abort failures actionable.
    async fn send_abort_multipart(
        &self,
        client: &reqwest::Client,
        task: &TransferTask,
        upload_id: &str,
    ) -> Result<(), MeowError> {
        let canonical_uri = self.object_canonical_uri_from_task_url(task)?;
        let (url, raw_query) = Self::build_query_url(task, &[("uploadId", upload_id.to_string())])?;
        let headers = self.build_signed_headers(
            "DELETE",
            &canonical_uri,
            Some(raw_query.as_str()),
            &[],
            None,
        )?;
        let resp = client
            .request(Method::DELETE, url)
            .headers(headers)
            .send()
            .await
            .map_err(|e| {
                MeowError::from_source(
                    InnerErrorCode::HttpError,
                    format!("oss abort multipart upload failed (uploadId={upload_id})"),
                    e,
                )
            })?;
        let status = resp.status();
        if !(status.is_success() || status == reqwest::StatusCode::NOT_FOUND) {
            let body = resp.text().await.unwrap_or_default();
            return Err(MeowError::from_code(
                InnerErrorCode::ResponseStatusError,
                format!(
                    "oss abort multipart upload failed: {status}, uploadId={upload_id}, body: {body}"
                ),
            ));
        }
        Ok(())
    }
}

#[async_trait]
impl BreakpointUpload for AliOssDirectUpload {
    async fn prepare(&self, ctx: UploadPrepareCtx<'_>) -> Result<UploadResumeInfo, MeowError> {
        validate_oss_task(ctx.task)?;
        {
            let mut state = self.session.lock().await;
            if state.target_url.as_deref() != Some(ctx.task.url()) {
                *state = MultipartSession {
                    target_url: Some(ctx.task.url().to_string()),
                    upload_id: None,
                };
            }
            if let Some(upload_id) = state.upload_id.clone() {
                validate_resume_offset(ctx.task, ctx.local_offset)?;
                return Ok(UploadResumeInfo {
                    completed_file_id: None,
                    next_byte: Some(ctx.local_offset),
                    provider_upload_id: Some(upload_id),
                });
            }
        }
        if ctx.local_offset > 0 {
            validate_resume_offset(ctx.task, ctx.local_offset)?;
            if let Some(upload_id) = self
                .try_adopt_upload_id_from_list(ctx.client, ctx.task)
                .await?
            {
                let uploaded_parts = self
                    .list_uploaded_part_numbers(ctx.client, ctx.task, &upload_id)
                    .await?;
                validate_remote_parts_for_resume(ctx.task, ctx.local_offset, &uploaded_parts)?;
                let mut state = self.session.lock().await;
                state.target_url = Some(ctx.task.url().to_string());
                state.upload_id = Some(upload_id.clone());
                return Ok(UploadResumeInfo {
                    completed_file_id: None,
                    next_byte: Some(ctx.local_offset),
                    provider_upload_id: Some(upload_id),
                });
            }
            return Err(MeowError::from_code_str(
                InnerErrorCode::InvalidTaskState,
                "local offset > 0 but no OSS multipart session found; cannot safely resume",
            ));
        }
        let upload_id = self.initiate_multipart_upload(ctx.client, ctx.task).await?;
        let mut state = self.session.lock().await;
        state.target_url = Some(ctx.task.url().to_string());
        state.upload_id = Some(upload_id.clone());
        Ok(UploadResumeInfo {
            completed_file_id: None,
            next_byte: Some(0),
            provider_upload_id: Some(upload_id),
        })
    }

    async fn upload_chunk(&self, ctx: UploadChunkCtx<'_>) -> Result<UploadResumeInfo, MeowError> {
        validate_oss_task(ctx.task)?;
        let canonical_uri = self.object_canonical_uri_from_task_url(ctx.task)?;
        let upload_id = self.session.lock().await.upload_id.clone().ok_or_else(|| {
            MeowError::from_code_str(
                InnerErrorCode::InvalidTaskState,
                "multipart upload_id missing; call prepare first",
            )
        })?;
        let part_number = (ctx.offset / ctx.task.chunk_size()) + 1;
        if part_number > MAX_OSS_PART_NUMBER {
            return Err(MeowError::from_code(
                InnerErrorCode::InvalidRange,
                format!("partNumber out of range: {part_number}"),
            ));
        }
        let (url, raw_query) = Self::build_query_url(
            ctx.task,
            &[
                ("partNumber", part_number.to_string()),
                ("uploadId", upload_id.clone()),
            ],
        )?;
        let headers =
            self.build_signed_headers("PUT", &canonical_uri, Some(raw_query.as_str()), &[], None)?;
        let resp = ctx
            .client
            .request(Method::PUT, url)
            .headers(headers)
            .body(reqwest::Body::from(ctx.chunk.clone()))
            .send()
            .await
            .map_err(|e| {
                MeowError::from_source(InnerErrorCode::HttpError, "oss upload part failed", e)
            })?;
        let status = resp.status();
        let etag_present = resp.headers().get(ETAG).is_some();
        if !status.is_success() {
            let body = resp.text().await.unwrap_or_default();
            return Err(MeowError::from_code(
                InnerErrorCode::ResponseStatusError,
                format!("oss upload part failed: {status}, body: {body}"),
            ));
        }
        if !etag_present {
            return Err(MeowError::from_code_str(
                InnerErrorCode::ResponseParseError,
                "oss upload part success but missing ETag header",
            ));
        }
        Ok(UploadResumeInfo {
            completed_file_id: None,
            next_byte: Some(ctx.offset + ctx.chunk.len() as u64),
            provider_upload_id: Some(upload_id),
        })
    }

    async fn complete_upload(
        &self,
        client: &reqwest::Client,
        task: &TransferTask,
    ) -> Result<Option<String>, MeowError> {
        validate_oss_task(task)?;
        let canonical_uri = self.object_canonical_uri_from_task_url(task)?;
        let upload_id = self.session.lock().await.upload_id.clone();
        let Some(upload_id) = upload_id else {
            return Ok(None);
        };
        let (url, raw_query) = Self::build_query_url(task, &[("uploadId", upload_id)])?;
        let mut headers = self.build_signed_headers(
            "POST",
            &canonical_uri,
            Some(raw_query.as_str()),
            &[
                ("content-type", DEFAULT_UPLOAD_CONTENT_TYPE),
                (OSS_COMPLETE_ALL_HEADER, OSS_COMPLETE_ALL_VALUE),
            ],
            Some(OSS_COMPLETE_ADDITIONAL_HEADERS),
        )?;
        headers.insert(CONTENT_LENGTH, header_value("0")?);
        headers.insert(CONTENT_TYPE, header_value(DEFAULT_UPLOAD_CONTENT_TYPE)?);
        let resp = client
            .request(Method::POST, url)
            .headers(headers)
            .send()
            .await
            .map_err(|e| {
                MeowError::from_source(
                    InnerErrorCode::HttpError,
                    "oss complete multipart upload failed",
                    e,
                )
            })?;
        let status = resp.status();
        let body = resp.text().await.unwrap_or_default();
        if !status.is_success() {
            return Err(MeowError::from_code(
                InnerErrorCode::ResponseStatusError,
                format!("oss complete multipart upload failed: {status}, body: {body}"),
            ));
        }
        self.session.lock().await.upload_id = None;
        Ok(None)
    }

    async fn abort_upload(
        &self,
        client: &reqwest::Client,
        task: &TransferTask,
    ) -> Result<(), MeowError> {
        let upload_id = self.session.lock().await.upload_id.clone();
        let Some(upload_id) = upload_id else {
            return Ok(());
        };
        // On failure the session id is intentionally kept so the upper layer can
        // log it (see executor cancel path) and the caller can retry cleanup.
        self.send_abort_multipart(client, task, &upload_id).await?;
        self.session.lock().await.upload_id = None;
        Ok(())
    }
}

fn validate_oss_task(task: &TransferTask) -> Result<(), MeowError> {
    let total_chunks = task.total_size().div_ceil(task.chunk_size());
    if total_chunks > MAX_OSS_PART_NUMBER {
        return Err(MeowError::from_code(
            InnerErrorCode::InvalidRange,
            format!(
                "OSS multipart upload supports at most {MAX_OSS_PART_NUMBER} parts; task requires {total_chunks}"
            ),
        ));
    }
    Ok(())
}

fn validate_resume_offset(task: &TransferTask, local_offset: u64) -> Result<(), MeowError> {
    if local_offset > task.total_size() {
        return Err(MeowError::from_code(
            InnerErrorCode::InvalidRange,
            format!(
                "local offset {local_offset} exceeds total size {}",
                task.total_size()
            ),
        ));
    }
    if local_offset != task.total_size() && local_offset % task.chunk_size() != 0 {
        return Err(MeowError::from_code(
            InnerErrorCode::InvalidTaskState,
            format!(
                "local offset {local_offset} is not aligned to chunk size {}; cannot safely resume OSS multipart upload",
                task.chunk_size()
            ),
        ));
    }
    Ok(())
}

fn validate_remote_parts_for_resume(
    task: &TransferTask,
    local_offset: u64,
    uploaded_parts: &[u64],
) -> Result<(), MeowError> {
    let expected_parts = if local_offset == task.total_size() {
        task.total_size().div_ceil(task.chunk_size())
    } else {
        local_offset / task.chunk_size()
    };
    for part_number in 1..=expected_parts {
        if !uploaded_parts.binary_search(&part_number).is_ok() {
            return Err(MeowError::from_code(
                InnerErrorCode::InvalidTaskState,
                format!(
                    "local offset {local_offset} requires OSS part {part_number}, but remote multipart session is missing it"
                ),
            ));
        }
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;

    fn upload() -> AliOssDirectUpload {
        AliOssDirectUpload::new("bucket", "ak", "sk", "cn-hangzhou")
    }

    #[tokio::test]
    async fn current_upload_id_is_none_before_prepare() {
        // A freshly constructed protocol has no active multipart session yet.
        assert_eq!(upload().current_upload_id().await, None);
    }

    #[tokio::test]
    async fn current_upload_id_reflects_active_session() {
        // The accessor exposes the in-flight UploadId so callers can persist it
        // for later out-of-band abort.
        let u = upload();
        {
            let mut state = u.session.lock().await;
            state.upload_id = Some("test-upload-id".to_string());
        }
        assert_eq!(
            u.current_upload_id().await.as_deref(),
            Some("test-upload-id")
        );
    }

    #[test]
    fn provider_upload_id_round_trips_in_resume_info() {
        // The new field carries the provider session id end to end.
        let info = UploadResumeInfo {
            completed_file_id: None,
            next_byte: Some(0),
            provider_upload_id: Some("uid-42".to_string()),
        };
        assert_eq!(info.provider_upload_id.as_deref(), Some("uid-42"));
        // Default keeps it absent so providers without a session id opt out.
        assert!(UploadResumeInfo::default().provider_upload_id.is_none());
    }
}