feat(common): add hit_local_cache field to Download message

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "dragonfly-api"
-version = "2.2.31"
+version = "2.2.32"
 authors = ["Gaius <gaius.qi@gmail.com>"]
 edition = "2021"
 license = "Apache-2.0"

pkg/apis/common/v2/common.proto

@@ -721,6 +721,10 @@ message Download {
   optional HuggingFace hugging_face = 31;
   // ModelScope protocol information.
   optional ModelScope model_scope = 32;
+  // Hit local cache indicates whether the download hits the local cache completely.
+  // If hit_local_cache is true, the peer registers with the scheduler only to report
+  // the metadata of the task, no need to be scheduled for downloading pieces.
+  bool hit_local_cache = 33;
 
   reserved 21;
   reserved "load_to_cache";

pkg/apis/scheduler/v2/scheduler.proto

@@ -172,6 +172,11 @@ message NeedBackToSourceResponse {
   }];
 }
 
+// HitLocalCacheResponse represents hit local cache response of AnnouncePeerResponse,
+// used when the download hits the local cache completely and the peer only reports
+// the metadata to the scheduler, no need to be scheduled for downloading pieces.
+message HitLocalCacheResponse {}
+
 // AnnouncePeerResponse represents response of AnnouncePeer.
 message AnnouncePeerResponse {
   oneof response {
@@ -180,6 +185,7 @@ message AnnouncePeerResponse {
     EmptyTaskResponse empty_task_response = 1;
     NormalTaskResponse normal_task_response = 2;
     NeedBackToSourceResponse need_back_to_source_response = 3;
+    HitLocalCacheResponse hit_local_cache_response = 4;
   }
 }
 

proto/common.proto

@@ -663,6 +663,10 @@ message Download {
   optional HuggingFace hugging_face = 31;
   // ModelScope protocol information.
   optional ModelScope model_scope = 32;
+  // Hit local cache indicates whether the download hits the local cache completely.
+  // If hit_local_cache is true, the peer registers with the scheduler only to report
+  // the metadata of the task, no need to be scheduled for downloading pieces.
+  bool hit_local_cache = 33;
 
   reserved 21;
   reserved "load_to_cache";

proto/scheduler.proto

@@ -150,12 +150,18 @@ message NeedBackToSourceResponse {
   optional string description = 1;
 }
 
+// HitLocalCacheResponse represents hit local cache response of AnnouncePeerResponse,
+// used when the download hits the local cache completely and the peer only reports
+// the metadata to the scheduler, no need to be scheduled for downloading pieces.
+message HitLocalCacheResponse {}
+
 // AnnouncePeerResponse represents response of AnnouncePeer.
 message AnnouncePeerResponse {
   oneof response {
     EmptyTaskResponse empty_task_response = 1;
     NormalTaskResponse normal_task_response = 2;
     NeedBackToSourceResponse need_back_to_source_response = 3;
+    HitLocalCacheResponse hit_local_cache_response = 4;
   }
 }
 

src/common.v2.rs

@@ -776,6 +776,11 @@ pub struct Download {
     /// ModelScope protocol information.
     #[prost(message, optional, tag = "32")]
     pub model_scope: ::core::option::Option<ModelScope>,
+    /// Hit local cache indicates whether the download hits the local cache completely.
+    /// If hit_local_cache is true, the peer registers with the scheduler only to report
+    /// the metadata of the task, no need to be scheduled for downloading pieces.
+    #[prost(bool, tag = "33")]
+    pub hit_local_cache: bool,
 }
 /// Object Storage related information.
 #[derive(serde::Serialize, serde::Deserialize)]

src/scheduler.v2.rs

@@ -191,11 +191,17 @@ pub struct NeedBackToSourceResponse {
     #[prost(string, optional, tag = "1")]
     pub description: ::core::option::Option<::prost::alloc::string::String>,
 }
+/// HitLocalCacheResponse represents hit local cache response of AnnouncePeerResponse,
+/// used when the download hits the local cache completely and the peer only reports
+/// the metadata to the scheduler, no need to be scheduled for downloading pieces.
+#[derive(serde::Serialize, serde::Deserialize)]
+#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
+pub struct HitLocalCacheResponse {}
 /// AnnouncePeerResponse represents response of AnnouncePeer.
 #[derive(serde::Serialize, serde::Deserialize)]
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct AnnouncePeerResponse {
-    #[prost(oneof = "announce_peer_response::Response", tags = "1, 2, 3")]
+    #[prost(oneof = "announce_peer_response::Response", tags = "1, 2, 3, 4")]
     pub response: ::core::option::Option<announce_peer_response::Response>,
 }
 /// Nested message and enum types in `AnnouncePeerResponse`.
@@ -209,6 +215,8 @@ pub mod announce_peer_response {
         NormalTaskResponse(super::NormalTaskResponse),
         #[prost(message, tag = "3")]
         NeedBackToSourceResponse(super::NeedBackToSourceResponse),
+        #[prost(message, tag = "4")]
+        HitLocalCacheResponse(super::HitLocalCacheResponse),
     }
 }
 /// StatPeerRequest represents request of StatPeer.