From 2a3565e3b6359851ce6f53e2d25e277f9bd88dfe Mon Sep 17 00:00:00 2001
From: Daniel Szoke <daniel.szoke@sentry.io>
Date: Wed, 4 Dec 2024 12:26:52 +0100
Subject: [PATCH] ref(chunks): Make `ChunkedDifRequest` take `Cow<'_, str>` for
 `name`

Also, update the `Assemblable` trait, so the `name` function returns `Cow<'_, str>`

This refactor will allow `ChunkedDifRequest` to also store owned types for the `name`, making the type more flexible. We will use this ability when implementing `Assemblable` for `ProguardMapping`
---
 src/api/data_types/chunking/dif.rs | 5 +++--
 src/utils/chunks/types.rs          | 5 +++--
 src/utils/dif_upload.rs            | 5 +++--
 src/utils/proguard/upload.rs       | 3 ++-
 4 files changed, 11 insertions(+), 7 deletions(-)

diff --git a/src/api/data_types/chunking/dif.rs b/src/api/data_types/chunking/dif.rs
index 7c4c758781..43a6977460 100644
--- a/src/api/data_types/chunking/dif.rs
+++ b/src/api/data_types/chunking/dif.rs
@@ -1,3 +1,4 @@
+use std::borrow::Cow;
 use std::collections::HashMap;
 
 use serde::{Deserialize, Serialize};
@@ -10,7 +11,7 @@ use super::ChunkedFileState;
 
 #[derive(Debug, Serialize)]
 pub struct ChunkedDifRequest<'a> {
-    pub name: &'a str,
+    pub name: Cow<'a, str>,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub debug_id: Option<DebugId>,
     pub chunks: &'a [Digest],
@@ -21,7 +22,7 @@ pub struct ChunkedDifRequest<'a> {
 impl<'a> ChunkedDifRequest<'a> {
     /// Create a new ChunkedDifRequest with the given name, chunk hashes,
     /// and total hash for the entire file.
-    pub fn new(name: &'a str, chunks: &'a [Digest], hash: Digest) -> Self {
+    pub fn new(name: Cow<'a, str>, chunks: &'a [Digest], hash: Digest) -> Self {
         Self {
             name,
             chunks,
diff --git a/src/utils/chunks/types.rs b/src/utils/chunks/types.rs
index 323c3afd12..cbd56e5926 100644
--- a/src/utils/chunks/types.rs
+++ b/src/utils/chunks/types.rs
@@ -1,5 +1,6 @@
 //! Contains data types used in the chunk upload process.
 
+use std::borrow::Cow;
 use std::fmt::{Display, Formatter, Result as FmtResult};
 
 use anyhow::Result;
@@ -17,7 +18,7 @@ pub type MissingObjectsInfo<'m, T> = (Vec<&'m Chunked<T>>, Vec<Chunk<'m>>);
 /// A trait for objects that can be assembled via the `assemble_difs` endpoint.
 pub trait Assemblable {
     /// Returns the name of the object.
-    fn name(&self) -> &str;
+    fn name(&self) -> Cow<'_, str>;
 
     /// Returns the debug ID of the object.
     /// Types which do not have a debug ID should return `None`.
@@ -97,7 +98,7 @@ impl<T> Assemblable for Chunked<T>
 where
     T: Assemblable,
 {
-    fn name(&self) -> &str {
+    fn name(&self) -> Cow<'_, str> {
         self.object().name()
     }
 
diff --git a/src/utils/dif_upload.rs b/src/utils/dif_upload.rs
index 7fe919edd4..097d231638 100644
--- a/src/utils/dif_upload.rs
+++ b/src/utils/dif_upload.rs
@@ -1,6 +1,7 @@
 //! Searches, processes and uploads debug information files (DIFs). See
 //! `DifUpload` for more information.
 
+use std::borrow::Cow;
 use std::collections::{BTreeMap, BTreeSet};
 use std::convert::TryInto;
 use std::ffi::{OsStr, OsString};
@@ -306,8 +307,8 @@ impl Display for DifMatch<'_> {
 
 impl Assemblable for DifMatch<'_> {
     /// A DIF's name is its file name.
-    fn name(&self) -> &str {
-        self.file_name()
+    fn name(&self) -> Cow<str> {
+        self.file_name().into()
     }
 
     fn debug_id(&self) -> Option<DebugId> {
diff --git a/src/utils/proguard/upload.rs b/src/utils/proguard/upload.rs
index 694048dea4..d62073e0a8 100644
--- a/src/utils/proguard/upload.rs
+++ b/src/utils/proguard/upload.rs
@@ -4,6 +4,7 @@
 //! Proguard mappings, while we work on a more permanent solution, which will
 //! work for all different types of debug files.
 
+use std::borrow::Cow;
 use std::thread;
 use std::time::{Duration, Instant};
 
@@ -57,7 +58,7 @@ impl ChunkedMapping {
 
 impl<'a> From<&'a ChunkedMapping> for ChunkedDifRequest<'a> {
     fn from(value: &'a ChunkedMapping) -> Self {
-        ChunkedDifRequest::new(&value.file_name, &value.chunk_hashes, value.hash)
+        ChunkedDifRequest::new(Cow::from(&value.file_name), &value.chunk_hashes, value.hash)
     }
 }