ref: Introduce non-empty types for UploadContext (#2846)

szokeasaurusrex · web-flow · commit b867302e642e · 2025-10-14T11:35:55.000+02:00
### Description This change helps with #2843 (CLI-189) by making it explicit where we are (potentially) performing an upload with no projects. As artifact bundle uploads require at least one project, we need to make sure we also deprecate projectless uploads. By making it explicit where projectless uploads could occur, we will have an easier time to tell how we should deprecate these. ### Issues - See #2843 (CLI-189)
diff --git a/src/api/mod.rs b/src/api/mod.rs
@@ -50,6 +50,7 @@ use crate::config::{Auth, Config};
 use crate::constants::{ARCH, DEFAULT_URL, EXT, PLATFORM, RELEASE_REGISTRY_LATEST_URL, VERSION};
 use crate::utils::file_upload::LegacyUploadContext;
 use crate::utils::http::{self, is_absolute_url};
+use crate::utils::non_empty::NonEmptySlice;
 use crate::utils::progress::{ProgressBar, ProgressBarMode};
 use crate::utils::retry::{get_default_backoff, DurationAsMilliseconds as _};
 use crate::utils::sourcemaps::get_sourcemap_reference_from_headers;
@@ -1019,7 +1020,7 @@ impl<'a> AuthenticatedApi<'a> {
     pub fn assemble_artifact_bundle(
         &self,
         org: &str,
-        projects: &[String],
+        projects: NonEmptySlice<'_, String>,
         checksum: Digest,
         chunks: &[Digest],
         version: Option<&str>,
@@ -1031,7 +1032,7 @@ impl<'a> AuthenticatedApi<'a> {
             .with_json_body(&ChunkedArtifactRequest {
                 checksum,
                 chunks,
-                projects,
+                projects: projects.into(),
                 version,
                 dist,
             })?
diff --git a/src/commands/debug_files/bundle_jvm.rs b/src/commands/debug_files/bundle_jvm.rs
@@ -59,7 +59,7 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
 
     let context = &UploadContext {
         org: &org,
-        projects: &project.into_iter().collect::<Vec<_>>(),
+        projects: project.as_slice().try_into().ok(),
         release: None,
         dist: None,
         note: None,
diff --git a/src/commands/files/upload.rs b/src/commands/files/upload.rs
@@ -153,7 +153,7 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
 
     let context = &UploadContext {
         org: &org,
-        projects: &project.into_iter().collect::<Vec<_>>(),
+        projects: project.as_slice().try_into().ok(),
         release: Some(&release),
         dist,
         note: None,
diff --git a/src/commands/react_native/appcenter.rs b/src/commands/react_native/appcenter.rs
@@ -196,7 +196,7 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
 
             processor.upload(&UploadContext {
                 org: &org,
-                projects: &projects,
+                projects: Some(projects.as_non_empty_slice()),
                 release: Some(&release),
                 dist: None,
                 note: None,
@@ -215,7 +215,7 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
 
                 processor.upload(&UploadContext {
                     org: &org,
-                    projects: &projects,
+                    projects: Some(projects.as_non_empty_slice()),
                     release: Some(&release),
                     dist: Some(dist),
                     note: None,
diff --git a/src/commands/react_native/gradle.rs b/src/commands/react_native/gradle.rs
@@ -123,7 +123,7 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
 
             processor.upload(&UploadContext {
                 org: &org,
-                projects: &projects,
+                projects: Some(projects.as_non_empty_slice()),
                 release: Some(version),
                 dist: Some(dist),
                 note: None,
@@ -137,7 +137,7 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
         // Debug Id Upload
         processor.upload(&UploadContext {
             org: &org,
-            projects: &projects,
+            projects: Some(projects.as_non_empty_slice()),
             release: None,
             dist: None,
             note: None,
diff --git a/src/commands/react_native/xcode.rs b/src/commands/react_native/xcode.rs
@@ -22,6 +22,7 @@ use crate::utils::args::{validate_distribution, ArgExt as _};
 use crate::utils::file_search::ReleaseFileSearch;
 use crate::utils::file_upload::UploadContext;
 use crate::utils::fs::TempFile;
+use crate::utils::non_empty::NonEmptyVec;
 use crate::utils::sourcemaps::SourceMapProcessor;
 use crate::utils::system::propagate_exit_status;
 use crate::utils::xcode::InfoPlist;
@@ -339,10 +340,12 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
     let wait = matches.get_flag("wait") || wait_for_secs.is_some();
     let max_wait = wait_for_secs.map_or(DEFAULT_MAX_WAIT, std::time::Duration::from_secs);
 
+    let projects = NonEmptyVec::from([project]);
+
     if dist_from_env.is_err() && release_from_env.is_err() && matches.get_flag("no_auto_release") {
         processor.upload(&UploadContext {
             org: &org,
-            projects: &[project],
+            projects: Some(projects.as_non_empty_slice()),
             release: None,
             dist: None,
             note: None,
@@ -378,7 +381,7 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
             None => {
                 processor.upload(&UploadContext {
                     org: &org,
-                    projects: &[project],
+                    projects: Some(projects.as_non_empty_slice()),
                     release: release_name.as_deref(),
                     dist: dist.as_deref(),
                     note: None,
@@ -389,11 +392,10 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
                 })?;
             }
             Some(dists) => {
-                let projects = &[project];
                 for dist in dists {
                     processor.upload(&UploadContext {
                         org: &org,
-                        projects,
+                        projects: Some(projects.as_non_empty_slice()),
                         release: release_name.as_deref(),
                         dist: Some(dist),
                         note: None,
diff --git a/src/commands/releases/finalize.rs b/src/commands/releases/finalize.rs
@@ -51,7 +51,7 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
         &config.get_org(matches)?,
         version,
         &UpdatedRelease {
-            projects: config.get_projects(matches).ok(),
+            projects: config.get_projects(matches).ok().map(Into::into),
             url: matches.get_one::<String>("url").cloned(),
             date_released: Some(
                 matches
diff --git a/src/commands/releases/new.rs b/src/commands/releases/new.rs
@@ -37,7 +37,7 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
         &config.get_org(matches)?,
         &NewRelease {
             version: version.to_owned(),
-            projects: config.get_projects(matches)?,
+            projects: config.get_projects(matches)?.into(),
             url: matches.get_one::<String>("url").cloned(),
             date_started: Some(Utc::now()),
             date_released: if matches.get_flag("finalize") {
diff --git a/src/commands/releases/set_commits.rs b/src/commands/releases/set_commits.rs
@@ -151,7 +151,7 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
             &org,
             &NewRelease {
                 version: version.into(),
-                projects,
+                projects: projects.into(),
                 ..Default::default()
             },
         )?;
diff --git a/src/commands/sourcemaps/upload.rs b/src/commands/sourcemaps/upload.rs
@@ -451,7 +451,7 @@ pub fn execute(matches: &ArgMatches) -> Result<()> {
     let max_wait = wait_for_secs.map_or(DEFAULT_MAX_WAIT, Duration::from_secs);
     let upload_context = UploadContext {
         org: &org,
-        projects: &projects,
+        projects: Some(projects.as_non_empty_slice()),
         release: version.as_deref(),
         dist: matches.get_one::<String>("dist").map(String::as_str),
         note: matches.get_one::<String>("note").map(String::as_str),
diff --git a/src/config.rs b/src/config.rs
@@ -26,6 +26,7 @@ use crate::utils::auth_token::AuthToken;
 use crate::utils::auth_token::AuthTokenPayload;
 use crate::utils::http::is_absolute_url;
 
+use crate::utils::non_empty::NonEmptyVec;
 #[cfg(target_os = "macos")]
 use crate::utils::xcode;
 
@@ -404,12 +405,15 @@ impl Config {
     }
 
     /// Given a match object from clap, this returns the projects from it.
-    pub fn get_projects(&self, matches: &ArgMatches) -> Result<Vec<String>> {
-        if let Some(projects) = matches.get_many::<String>("project") {
-            Ok(projects.cloned().collect())
-        } else {
-            Ok(vec![self.get_project_default()?])
-        }
+    pub fn get_projects(&self, matches: &ArgMatches) -> Result<NonEmptyVec<String>> {
+        Ok(match matches.get_many::<String>("project") {
+            Some(projects) => projects
+                .cloned()
+                .collect::<Vec<_>>()
+                .try_into()
+                .expect("if matches.get_many() is Some, the returned iterator is non-empty"),
+            None => [self.get_project_default()?].into(),
+        })
     }
 
     /// Given a match object from clap, this returns a tuple in the
diff --git a/src/utils/file_upload.rs b/src/utils/file_upload.rs
@@ -29,6 +29,7 @@ use crate::api::{Api, ChunkServerOptions, ChunkUploadCapability};
 use crate::constants::DEFAULT_MAX_WAIT;
 use crate::utils::chunks::{upload_chunks, Chunk, ASSEMBLE_POLL_INTERVAL};
 use crate::utils::fs::{get_sha1_checksum, get_sha1_checksums, TempFile};
+use crate::utils::non_empty::NonEmptySlice;
 use crate::utils::progress::{ProgressBar, ProgressBarMode, ProgressStyle};
 
 use super::file_search::ReleaseFileMatch;
@@ -46,7 +47,7 @@ pub fn initialize_legacy_release_upload(context: &UploadContext) -> Result<()> {
     // need to do anything here.  Artifact bundles will also only work
     // if a project is provided which is technically unnecessary for the
     // legacy upload though it will unlikely to be what users want.
-    if !context.projects.is_empty()
+    if context.projects.is_some()
         && context.chunk_upload_options.is_some_and(|x| {
             x.supports(ChunkUploadCapability::ArtifactBundles)
                 || x.supports(ChunkUploadCapability::ArtifactBundlesV2)
@@ -56,7 +57,7 @@ pub fn initialize_legacy_release_upload(context: &UploadContext) -> Result<()> {
     }
 
     // TODO: make this into an error later down the road
-    if context.projects.is_empty() {
+    if context.projects.is_none() {
         eprintln!(
             "{}",
             style(
@@ -75,7 +76,7 @@ pub fn initialize_legacy_release_upload(context: &UploadContext) -> Result<()> {
             context.org,
             &NewRelease {
                 version: version.to_owned(),
-                projects: context.projects.to_vec(),
+                projects: context.projects.map(Vec::from).unwrap_or_default(),
                 ..Default::default()
             },
         )?;
@@ -88,7 +89,7 @@ pub fn initialize_legacy_release_upload(context: &UploadContext) -> Result<()> {
 #[derive(Debug, Clone)]
 pub struct UploadContext<'a> {
     pub org: &'a str,
-    pub projects: &'a [String],
+    pub projects: Option<NonEmptySlice<'a, String>>,
     pub release: Option<&'a str>,
     pub dist: Option<&'a str>,
     pub note: Option<&'a str>,
@@ -194,11 +195,13 @@ impl<'a> TryFrom<&'a UploadContext<'_>> for LegacyUploadContext<'a> {
             ..
         } = value;
 
-        let project = match projects {
-            [] => None,
-            [project] => Some(project.as_str()),
-            [_, _, ..] => Err(LegacyUploadContextError::ProjectMultiple)?,
-        };
+        let project = projects
+            .map(|projects| match <&[_]>::from(projects) {
+                [] => unreachable!("NonEmptySlice cannot be empty"),
+                [project] => Ok(project.as_str()),
+                [_, _, ..] => Err(LegacyUploadContextError::ProjectMultiple),
+            })
+            .transpose()?;
 
         let release = release.ok_or(LegacyUploadContextError::ReleaseMissing)?;
 
@@ -535,15 +538,18 @@ fn poll_assemble(
 
     let api = Api::current();
     let authenticated_api = api.authenticated()?;
-    let use_artifact_bundle = (options.supports(ChunkUploadCapability::ArtifactBundles)
-        || options.supports(ChunkUploadCapability::ArtifactBundlesV2))
-        && !context.projects.is_empty();
+    let artifact_bundle_projects = {
+        (options.supports(ChunkUploadCapability::ArtifactBundles)
+            || options.supports(ChunkUploadCapability::ArtifactBundlesV2))
+        .then_some(context.projects)
+        .flatten()
+    };
     let response = loop {
         // prefer standalone artifact bundle upload over legacy release based upload
-        let response = if use_artifact_bundle {
+        let response = if let Some(projects) = artifact_bundle_projects {
             authenticated_api.assemble_artifact_bundle(
                 context.org,
-                context.projects,
+                projects,
                 checksum,
                 chunks,
                 context.release,
@@ -629,11 +635,15 @@ fn upload_files_chunked(
 
     // Filter out chunks that are already on the server. This only matters if the server supports
     // `ArtifactBundlesV2`, otherwise the `missing_chunks` field is meaningless.
-    if options.supports(ChunkUploadCapability::ArtifactBundlesV2) && !context.projects.is_empty() {
+    if let Some(projects) = options
+        .supports(ChunkUploadCapability::ArtifactBundlesV2)
+        .then_some(context.projects)
+        .flatten()
+    {
         let api = Api::current();
         let response = api.authenticated()?.assemble_artifact_bundle(
             context.org,
-            context.projects,
+            projects,
             checksum,
             &checksums,
             context.release,
@@ -700,7 +710,7 @@ fn build_artifact_bundle(
     }
 
     bundle.set_attribute("org".to_owned(), context.org.to_owned());
-    if let [project] = context.projects {
+    if let Some([project]) = context.projects.as_deref() {
         // Only set project if there is exactly one project
         bundle.set_attribute("project".to_owned(), project);
     }
@@ -794,7 +804,7 @@ fn print_upload_context_details(context: &UploadContext) {
     println!(
         "{} {}",
         style("> Projects:").dim(),
-        style(context.projects.join(", ")).yellow()
+        style(context.projects.as_deref().unwrap_or_default().join(", ")).yellow()
     );
     println!(
         "{} {}",
@@ -863,9 +873,10 @@ mod tests {
 
     #[test]
     fn build_artifact_bundle_deterministic() {
+        let projects_slice = &["wat-project".into()];
         let context = UploadContext {
             org: "wat-org",
-            projects: &["wat-project".into()],
+            projects: Some(projects_slice.into()),
             release: None,
             dist: None,
             note: None,
diff --git a/src/utils/mod.rs b/src/utils/mod.rs
@@ -16,6 +16,7 @@ pub mod fs;
 pub mod http;
 pub mod logging;
 pub mod metrics;
+pub mod non_empty;
 pub mod progress;
 pub mod proguard;
 pub mod releases;
diff --git a/src/utils/non_empty.rs b/src/utils/non_empty.rs
diff --git a/src/utils/sourcemaps.rs b/src/utils/sourcemaps.rs
