feat: improved rate of fetching gacha records

src-tauri/Cargo.toml

@@ -20,6 +20,7 @@ tauri-build = { version = "1.5.1", features = [] }
 anyhow = "1.0.79"
 async-trait = "0.1.77"
 byteorder = "1.5.0"
+exponential-backoff = "1.2.0"
 form_urlencoded = "1.2.1"
 futures = { version = "0.3.30", default-features = false, features = ["std", "async-await"] }
 once_cell = "1.19.0"

src-tauri/src/error.rs

@@ -39,6 +39,9 @@ pub enum Error {
   #[error("Timeoutd Gacha Url")]
   TimeoutdGachaUrl,
 
+  #[error("Visit too frequently Gacha Url")]
+  VisitTooFrequentlyGachaUrl,
+
   #[error("Gacha record response: {retcode:?} {message:?}")]
   GachaRecordRetcode { retcode: i32, message: String },
 
@@ -88,6 +91,7 @@ impl_error_identifiers! {
   IllegalGachaUrl               => ILLEGAL_GACHA_URL,
   VacantGachaUrl                => VACANT_GACHA_URL,
   TimeoutdGachaUrl              => TIMEOUTD_GACHA_URL,
+  VisitTooFrequentlyGachaUrl    => VISIT_TOO_FREQUENTLY_GACHA_URL,
   GachaRecordRetcode            => GACHA_RECORD_RETCODE,
   GachaRecordFetcherChannelSend => GACHA_RECORD_FETCHER_CHANNEL_SEND,
   GachaRecordFetcherChannelJoin => GACHA_RECORD_FETCHER_CHANNEL_JOIN,

src-tauri/src/gacha/declare.rs

@@ -101,15 +101,15 @@ pub trait GachaRecordFetcherChannel<T: GachaRecord + Sized + Serialize + Send +
     gacha_type: &str,
     last_end_id: Option<&str>,
   ) -> Result<()> {
-    const SLEEPING: u64 = 3;
+    const SLEEPING_MILLIS: u64 = 500;
 
     sender
       .send(GachaRecordFetcherChannelFragment::Ready(
         gacha_type.to_owned(),
       ))
       .await
       .map_err(|_| Error::GachaRecordFetcherChannelSend)?;
-    tokio::time::sleep(tokio::time::Duration::from_secs(SLEEPING)).await;
+    tokio::time::sleep(tokio::time::Duration::from_millis(SLEEPING_MILLIS)).await;
 
     let mut end_id = String::from("0");
     let mut pagination: u32 = 1;
@@ -120,7 +120,7 @@ pub trait GachaRecordFetcherChannel<T: GachaRecord + Sized + Serialize + Send +
           .send(GachaRecordFetcherChannelFragment::Sleeping)
           .await
           .map_err(|_| Error::GachaRecordFetcherChannelSend)?;
-        tokio::time::sleep(tokio::time::Duration::from_secs(SLEEPING)).await;
+        tokio::time::sleep(tokio::time::Duration::from_millis(SLEEPING_MILLIS)).await;
       }
 
       sender
@@ -159,7 +159,7 @@ pub trait GachaRecordFetcherChannel<T: GachaRecord + Sized + Serialize + Send +
           if should_break {
             break;
           } else {
-            tokio::time::sleep(tokio::time::Duration::from_secs(SLEEPING)).await;
+            tokio::time::sleep(tokio::time::Duration::from_millis(SLEEPING_MILLIS)).await;
             continue;
           }
         }

src-tauri/src/gacha/utilities.rs

@@ -3,6 +3,9 @@ use crate::constants;
 use crate::disk_cache::{BlockFile, EntryStore, IndexFile};
 use crate::error::{Error, Result};
 use crate::storage::entity_account::AccountFacet;
+use exponential_backoff::Backoff;
+use futures::future::BoxFuture;
+use futures::FutureExt;
 use once_cell::sync::Lazy;
 use reqwest::Client as Reqwest;
 use serde::de::DeserializeOwned;
@@ -13,9 +16,11 @@ use std::fs::File;
 use std::io::{prelude::BufRead, BufReader};
 use std::path::{Path, PathBuf};
 use std::str::FromStr;
+use std::time::Duration;
 use time::{OffsetDateTime, UtcOffset};
 use tokio::sync::Mutex;
-use tracing::debug;
+use tokio::time::sleep;
+use tracing::{debug, warn};
 use url::Url;
 
 pub(super) fn create_default_reqwest() -> Result<reqwest::Client> {
@@ -246,7 +251,7 @@ pub(super) struct GachaResponse<T> {
   pub data: Option<T>,
 }
 
-pub(super) async fn fetch_gacha_records<T: Sized + DeserializeOwned>(
+pub(super) async fn fetch_gacha_records<T: Sized + DeserializeOwned + Send>(
   reqwest: &Reqwest,
   endpoint: &str,
   gacha_url: &str,
@@ -286,22 +291,71 @@ pub(super) async fn fetch_gacha_records<T: Sized + DeserializeOwned>(
     url.query_pairs_mut().append_pair("end_id", end_id);
   }
 
-  let response: GachaResponse<T> = reqwest.get(url).send().await?.json().await?;
+  let response: GachaResponse<T> = request_gacha_url_with_retry(reqwest, url, None).await?;
+  Ok(response)
+}
 
+async fn request_gacha_url<T: Sized + DeserializeOwned>(
+  reqwest: &Reqwest,
+  url: Url,
+) -> Result<GachaResponse<T>> {
+  let response: GachaResponse<T> = reqwest.get(url).send().await?.json().await?;
   if response.retcode != 0 {
-    if response.retcode == -101 {
-      Err(Error::TimeoutdGachaUrl)
-    } else {
-      Err(Error::GachaRecordRetcode {
+    match response.retcode {
+      -101 => Err(Error::TimeoutdGachaUrl),
+      -110 => Err(Error::VisitTooFrequentlyGachaUrl),
+      _ => Err(Error::GachaRecordRetcode {
         retcode: response.retcode,
         message: response.message,
-      })
+      }),
     }
   } else {
     Ok(response)
   }
 }
 
+fn request_gacha_url_with_retry<T: Sized + DeserializeOwned + Send>(
+  reqwest: &Reqwest,
+  url: Url,
+  retries: Option<u8>,
+) -> BoxFuture<'_, Result<GachaResponse<T>>> {
+  // HACK: Default maximum 5 attempts
+  const RETRIES: u8 = 5;
+
+  let min = Duration::from_millis(200); // Min: 0.2s
+  let max = Duration::from_millis(10_000); // Max: 10s
+
+  let retries = retries.unwrap_or(RETRIES);
+  let backoff = Backoff::new(retries as u32, min, max);
+
+  async move {
+    for duration in &backoff {
+      match request_gacha_url(reqwest, url.clone()).await {
+        // okay
+        Ok(response) => return Ok(response),
+
+        // Wait and retry only if the error is VisitTooFrequently.
+        Err(Error::VisitTooFrequentlyGachaUrl) => {
+          warn!(
+            "Requesting gacha url visit too frequently, wait({}s) and retry...",
+            duration.as_secs_f32()
+          );
+          sleep(duration).await;
+          continue;
+        }
+
+        // Other errors are returned
+        Err(error) => return Err(error),
+      }
+    }
+
+    // Maximum number of retries reached
+    warn!("Maximum number of retries exceeded: {retries}");
+    Err(Error::VisitTooFrequentlyGachaUrl)
+  }
+  .boxed()
+}
+
 //- Find the Gacha url and validate consistency
 //  Hashmap<String, GachaUrl> GACHA_URL_CACHED
 //    key: facet + uid + addr

src/components/gacha/GachaLayout.tsx

@@ -125,6 +125,7 @@ const KnownErrorIdentifiers: Record<string, string> = {
   ILLEGAL_GACHA_URL: '无效的抽卡链接！',
   VACANT_GACHA_URL: '未找到有效的抽卡链接。请尝试在游戏内打开抽卡历史记录界面！',
   TIMEOUTD_GACHA_URL: '抽卡链接已经过期失效。请重新在游戏内打开抽卡历史记录界面！',
+  VISIT_TOO_FREQUENTLY_GACHA_URL: '请求获取抽卡记录 API 速率过快！请稍等几秒后再次重试！',
   UIGF_OR_SRGF_MISMATCHED_UID: '待导入的 UIGF 或 SRGF 数据 UID 与当前账号不匹配！',
   UIGF_OR_SRGF_INVALID_FIELD: '待导入的 UIGF 或 SRGF 数据中存在无效的字段！'
 }