Make UploadableFile::get_data async for AsyncRead (#82)

Author: em-

Cargo.lock

@@ -24,7 +24,7 @@ bytes = "1.9.0"
 zip = "2.2.2"
 pin-project = "1.0.7"
 futures = "0.3.15"
-async-trait = "0.1.50"
+async-trait = "0.1.86"
 tempfile = "3.15.0"
 parking_lot = "0.12.0"
 tracing-subscriber = "0.3.10"

gitlab-runner/Cargo.toml

@@ -141,6 +141,7 @@ enum DemoFile {
     Fact { index: usize, value: String },
 }
 
+#[async_trait::async_trait]
 impl UploadableFile for DemoFile {
     type Data<'a> = Box<dyn AsyncRead + Send + Unpin>;
 
@@ -151,11 +152,11 @@ impl UploadableFile for DemoFile {
         }
     }
 
-    fn get_data(&self) -> Box<dyn AsyncRead + Send + Unpin> {
-        match self {
+    async fn get_data(&self) -> Result<Box<dyn AsyncRead + Send + Unpin>, ()> {
+        Ok(match self {
             DemoFile::ReadMe => Box::new(b"Demo runner artifact\n".as_slice()),
             DemoFile::Fact { value, .. } => Box::new(Cursor::new(value.clone().into_bytes())),
-        }
+        })
     }
 }
 

gitlab-runner/examples/demo-runner.rs

@@ -59,6 +59,7 @@ pub use client::Phase;
 /// generated or downloaded from some other source on demand. The
 /// `get_path` method is required so that the globbing Gitlab expects
 /// can be performed without the handler needing to be involved.
+#[async_trait::async_trait]
 pub trait UploadableFile: Eq {
     /// The type of the data stream returned by
     /// [`get_data`](Self::get_data)
@@ -76,7 +77,7 @@ pub trait UploadableFile: Eq {
     /// Get something that can provide the data for this file.
     ///
     /// This can be any implementor of [`AsyncRead`].
-    fn get_data(&self) -> Self::Data<'_>;
+    async fn get_data(&self) -> Result<Self::Data<'_>, ()>;
 }
 
 /// An [`UploadableFile`] type for JobHandlers that expose no files.
@@ -87,13 +88,14 @@ pub trait UploadableFile: Eq {
 #[derive(Clone, Debug, Eq, PartialEq)]
 pub struct NoFiles {}
 
+#[async_trait::async_trait]
 impl UploadableFile for NoFiles {
     type Data<'a> = &'a [u8];
 
     fn get_path(&self) -> Cow<'_, str> {
         unreachable!("tried to get path of NoFiles")
     }
-    fn get_data(&self) -> Self::Data<'_> {
+    async fn get_data(&self) -> Result<Self::Data<'_>, ()> {
         unreachable!("tried to read data from NoFiles");
     }
 }

gitlab-runner/src/lib.rs

@@ -135,7 +135,7 @@ where
             let path = file.get_path();
             match uploader.file(path.to_string()).await {
                 Ok(mut upload) => {
-                    let mut data = file.get_data();
+                    let mut data = file.get_data().await?;
                     match futures::io::copy(&mut data, &mut upload).await {
                         Ok(_) => {
                             uploaded += 1;

gitlab-runner/src/run.rs

@@ -29,11 +29,11 @@ impl UploadableFile for TestFile {
             TestFile::Test2 => "test2".into(),
         }
     }
-    fn get_data(&self) -> &'_ [u8] {
-        match self {
+    async fn get_data(&self) -> Result<&'_ [u8], ()> {
+        Ok(match self {
             TestFile::Test => b"testdata".as_slice(),
             TestFile::Test2 => b"testdata2".as_slice(),
-        }
+        })
     }
 }