Merge pull request #88 from Synicix/dev

guzman-raphael · web-flow · commit ad1e3a17b111 · 2025-06-25T07:51:37.000-05:00
Rename parameters to match new spec
diff --git a/src/core/orchestrator/docker.rs b/src/core/orchestrator/docker.rs
@@ -2,7 +2,7 @@ use crate::{
     core::util::get,
     uniffi::{
         error::{Result, selector},
-        model::{Input, PodJob},
+        model::{PathSet, PodJob},
         orchestrator::{RunInfo, Status, docker::LocalDockerOrchestrator},
     },
 };
@@ -50,52 +50,48 @@ impl LocalDockerOrchestrator {
             host_output_directory.to_string_lossy(),
             pod_job.pod.output_dir.to_string_lossy(),
         )];
-        let input_binds = pod_job
-            .pod
-            .input_stream
-            .iter()
-            .try_fold::<_, _, Result<_>>(
-                vec![],
-                |mut flattened_binds, (stream_name, stream_info)| {
-                    flattened_binds.extend(match get(&pod_job.input_stream, stream_name)? {
-                        Input::Unary(blob) => {
-                            vec![format!(
+        let input_binds = pod_job.pod.input_spec.iter().try_fold::<_, _, Result<_>>(
+            vec![],
+            |mut flattened_binds, (stream_name, stream_info)| {
+                flattened_binds.extend(match get(&pod_job.input_packet, stream_name)? {
+                    PathSet::Unary(blob) => {
+                        vec![format!(
+                            "{}:{}:{}",
+                            path::absolute(
+                                get(namespace_lookup, &blob.location.namespace)?
+                                    .join(&blob.location.path)
+                            )?
+                            .to_string_lossy(),
+                            stream_info.path.to_string_lossy(),
+                            "ro"
+                        )]
+                    }
+                    PathSet::Collection(blobs) => blobs
+                        .iter()
+                        .map(|blob| {
+                            Ok(format!(
                                 "{}:{}:{}",
                                 path::absolute(
                                     get(namespace_lookup, &blob.location.namespace)?
                                         .join(&blob.location.path)
                                 )?
                                 .to_string_lossy(),
-                                stream_info.path.to_string_lossy(),
-                                "ro"
-                            )]
-                        }
-                        Input::Collection(blobs) => blobs
-                            .iter()
-                            .map(|blob| {
-                                Ok(format!(
-                                    "{}:{}:{}",
-                                    path::absolute(
-                                        get(namespace_lookup, &blob.location.namespace)?
-                                            .join(&blob.location.path)
-                                    )?
+                                stream_info
+                                    .path
+                                    .join(blob.location.path.file_name().context(
+                                        selector::NoFileName {
+                                            path: blob.location.path.clone()
+                                        }
+                                    )?)
                                     .to_string_lossy(),
-                                    stream_info
-                                        .path
-                                        .join(blob.location.path.file_name().context(
-                                            selector::NoFileName {
-                                                path: blob.location.path.clone()
-                                            }
-                                        )?)
-                                        .to_string_lossy(),
-                                    "ro"
-                                ))
-                            })
-                            .collect::<Result<_>>()?,
-                    });
-                    Ok(flattened_binds)
-                },
-            )?;
+                                "ro"
+                            ))
+                        })
+                        .collect::<Result<_>>()?,
+                });
+                Ok(flattened_binds)
+            },
+        )?;
         Ok((input_binds, output_bind))
     }
     #[expect(
diff --git a/src/uniffi/model.rs b/src/uniffi/model.rs
@@ -46,12 +46,12 @@ pub struct Pod {
     pub command: String,
     /// Exposed, internal input streams.
     #[serde(serialize_with = "serialize_hashmap")]
-    pub input_stream: HashMap<String, StreamInfo>,
+    pub input_spec: HashMap<String, PathInfo>,
     /// Exposed, internal output directory.
     pub output_dir: PathBuf,
     /// Exposed, internal output streams.
     #[serde(serialize_with = "serialize_hashmap")]
-    pub output_stream: HashMap<String, StreamInfo>,
+    pub output_spec: HashMap<String, PathInfo>,
     /// Link to source associated with image binary.
     pub source_commit_url: String,
     /// Recommendation for CPU in fractional cores.
@@ -74,9 +74,9 @@ impl Pod {
         annotation: Option<Annotation>,
         image: String,
         command: String,
-        input_stream: HashMap<String, StreamInfo>,
+        input_spec: HashMap<String, PathInfo>,
         output_dir: PathBuf,
-        output_stream: HashMap<String, StreamInfo>,
+        output_spec: HashMap<String, PathInfo>,
         source_commit_url: String,
         recommended_cpus: f32,
         recommended_memory: u64,
@@ -87,9 +87,9 @@ impl Pod {
             hash: String::new(),
             image,
             command,
-            input_stream,
+            input_spec,
             output_dir,
-            output_stream,
+            output_spec,
             source_commit_url,
             recommended_cpus,
             recommended_memory,
@@ -120,9 +120,9 @@ pub struct PodJob {
     pub pod: Arc<Pod>,
     /// Attached, external input streams.
     #[serde(serialize_with = "serialize_hashmap")]
-    pub input_stream: HashMap<String, Input>,
+    pub input_packet: HashMap<String, PathSet>,
     /// Attached, external output directory.
-    pub output_dir: OrcaPath,
+    pub output_dir: URI,
     /// Maximum allowable cores in fractional cores for the computation.
     pub cpu_limit: f32,
     /// Maximum allowable memory in bytes for the computation.
@@ -143,23 +143,23 @@ impl PodJob {
     pub fn new(
         annotation: Option<Annotation>,
         pod: Arc<Pod>,
-        mut input_stream: HashMap<String, Input>,
-        output_dir: OrcaPath,
+        mut input_packet: HashMap<String, PathSet>,
+        output_dir: URI,
         cpu_limit: f32,
         memory_limit: u64,
         env_vars: Option<HashMap<String, String>>,
         namespace_lookup: &HashMap<String, PathBuf>,
     ) -> Result<Self> {
-        input_stream = input_stream
+        input_packet = input_packet
             .into_iter()
             .map(|(stream_name, stream_input)| match stream_input {
-                Input::Unary(blob) => Ok((
+                PathSet::Unary(blob) => Ok((
                     stream_name,
-                    Input::Unary(hash_blob(namespace_lookup, blob)?),
+                    PathSet::Unary(hash_blob(namespace_lookup, blob)?),
                 )),
-                Input::Collection(blobs) => Ok((
+                PathSet::Collection(blobs) => Ok((
                     stream_name,
-                    Input::Collection(
+                    PathSet::Collection(
                         blobs
                             .into_iter()
                             .map(|blob| hash_blob(namespace_lookup, blob))
@@ -172,7 +172,7 @@ impl PodJob {
             annotation,
             hash: String::new(),
             pod,
-            input_stream,
+            input_packet,
             output_dir,
             cpu_limit,
             memory_limit,
@@ -269,24 +269,25 @@ pub enum GPUModel {
 /// Streams are named and represent an abstraction for the file(s) that represent some particular
 /// data.
 #[derive(uniffi::Record, Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
-pub struct StreamInfo {
+pub struct PathInfo {
     /// Path to stream file or directory.
     pub path: PathBuf,
     /// Naming pattern for the stream.
     pub match_pattern: String,
 }
-/// Input options.
+/// A set of BLOBs, either a single BLOB or a collection of BLOBs.
+/// Mainly use for input
 #[derive(uniffi::Enum, Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
 #[serde(untagged)]
-pub enum Input {
+pub enum PathSet {
     /// A single BLOB.
     Unary(Blob),
     /// A series of BLOBs.
     Collection(Vec<Blob>),
 }
 /// Location of BLOB data.
 #[derive(uniffi::Record, Serialize, Deserialize, Debug, Clone, PartialEq, Eq, Default)]
-pub struct OrcaPath {
+pub struct URI {
     /// Namespace alias.
     pub namespace: String,
     /// Path within namespace.
@@ -299,7 +300,7 @@ pub struct Blob {
     /// BLOB available options.
     pub kind: BlobKind,
     /// BLOB location.
-    pub location: OrcaPath,
+    pub location: URI,
     /// BLOB contents checksum.
     pub checksum: String,
 }
diff --git a/src/uniffi/orchestrator/mod.rs b/src/uniffi/orchestrator/mod.rs
@@ -1,6 +1,6 @@
 use crate::uniffi::{
     error::Result,
-    model::{OrcaPath, PodJob, PodResult},
+    model::{PodJob, PodResult, URI},
 };
 use serde::{Deserialize, Serialize};
 use std::{collections::HashMap, path::PathBuf, sync::Arc};
@@ -12,7 +12,7 @@ pub enum ImageKind {
     /// `{server.com/}{name}:{tag}`. Server is optional e.g. (`alpine:latest`).
     Published(String),
     /// A packaged compute environment of image+tag as a tarball.
-    Tarball(OrcaPath),
+    Tarball(URI),
 }
 /// Status of a particular compute run.
 #[derive(uniffi::Enum, Serialize, Deserialize, Debug, PartialEq, Eq, Clone, Default)]
diff --git a/tests/extra/python/smoke_test.py b/tests/extra/python/smoke_test.py
@@ -11,7 +11,7 @@
     Pod,
     PodJob,
     Annotation,
-    OrcaPath,
+    Uri,
     LocalDockerOrchestrator,
     LocalFileStore,
     ModelId,
@@ -29,9 +29,9 @@ def create_pod(data, _):
         ),
         image="alpine:3.14",
         command="sleep 1",
-        input_stream={},
+        input_spec={},
         output_dir="/tmp/output",
-        output_stream={},
+        output_spec={},
         source_commit_url="https://github.com/user/simple",
         recommended_cpus=0.1,
         recommended_memory=10 << 20,
@@ -48,8 +48,8 @@ def create_pod_job(data, config):
             version="0.1.0",
         ),
         pod=data["pod"],
-        input_stream={},
-        output_dir=OrcaPath(
+        input_packet={},
+        output_dir=Uri(
             namespace="default",
             path=".",
         ),
diff --git a/tests/fixture/mod.rs b/tests/fixture/mod.rs
@@ -10,7 +10,7 @@
 use names::{Generator, Name};
 use orcapod::uniffi::{
     error::Result,
-    model::{Annotation, Blob, BlobKind, Input, OrcaPath, Pod, PodJob, PodResult, StreamInfo},
+    model::{Annotation, Blob, BlobKind, PathInfo, PathSet, Pod, PodJob, PodResult, URI},
     orchestrator::Status,
     store::{ModelID, ModelInfo, Store},
 };
@@ -41,14 +41,14 @@ pub fn pod_style() -> Result<Pod> {
         HashMap::from([
             (
                 "extra-style".to_owned(),
-                StreamInfo {
+                PathInfo {
                     path: PathBuf::from("/extra_styles/style2.t7"),
                     match_pattern: r".*\.t7".to_owned(),
                 },
             ),
             (
                 "base-input".to_owned(),
-                StreamInfo {
+                PathInfo {
                     path: PathBuf::from("/input"),
                     match_pattern: "input/.*".to_owned(),
                 },
@@ -57,7 +57,7 @@ pub fn pod_style() -> Result<Pod> {
         PathBuf::from("/output"),
         HashMap::from([(
             "result".to_owned(),
-            StreamInfo {
+            PathInfo {
                 path: PathBuf::from("./result.jpeg"),
                 match_pattern: r".*\.jpeg".to_owned(),
             },
@@ -80,9 +80,9 @@ pub fn pod_job_style(namespace_lookup: &HashMap<String, PathBuf, RandomState>) -
         HashMap::from([
             (
                 "extra-style".to_owned(),
-                Input::Unary(Blob {
+                PathSet::Unary(Blob {
                     kind: BlobKind::File,
-                    location: OrcaPath {
+                    location: URI {
                         namespace: "default".to_owned(),
                         path: PathBuf::from("styles/mosaic.t7"),
                     },
@@ -91,18 +91,18 @@ pub fn pod_job_style(namespace_lookup: &HashMap<String, PathBuf, RandomState>) -
             ),
             (
                 "base-input".to_owned(),
-                Input::Collection(vec![
+                PathSet::Collection(vec![
                     Blob {
                         kind: BlobKind::File,
-                        location: OrcaPath {
+                        location: URI {
                             namespace: "default".to_owned(),
                             path: PathBuf::from("styles/style1.t7"),
                         },
                         checksum: String::new(),
                     },
                     Blob {
                         kind: BlobKind::File,
-                        location: OrcaPath {
+                        location: URI {
                             namespace: "default".to_owned(),
                             path: PathBuf::from("images/subject.jpeg"),
                         },
@@ -111,7 +111,7 @@ pub fn pod_job_style(namespace_lookup: &HashMap<String, PathBuf, RandomState>) -
                 ]),
             ),
         ]),
-        OrcaPath {
+        URI {
             namespace: "default".to_owned(),
             path: PathBuf::from("output"),
         },
diff --git a/tests/model.rs b/tests/model.rs
diff --git a/tests/orchestrator.rs b/tests/orchestrator.rs
