From e01a22136ebda8896d6700abe8d3ca709619cf47 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E1=B4=80=E1=B4=8D=E1=B4=9B=E1=B4=8F=E1=B4=80=E1=B4=87?= =?UTF-8?q?=CA=80?= Date: Thu, 13 Feb 2025 21:41:05 +0800 Subject: [PATCH] =?UTF-8?q?refactor:=20=E4=BD=BF=E7=94=A8=20const=20?= =?UTF-8?q?=E6=B3=9B=E5=9E=8B=E7=BA=A6=E6=9D=9F=20status=20(#250)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- crates/bili_sync/src/utils/status.rs | 177 ++++++++++++++------------- crates/bili_sync/src/workflow.rs | 6 +- 2 files changed, 93 insertions(+), 90 deletions(-) diff --git a/crates/bili_sync/src/utils/status.rs b/crates/bili_sync/src/utils/status.rs index 4ab1ba5..0a3e860 100644 --- a/crates/bili_sync/src/utils/status.rs +++ b/crates/bili_sync/src/utils/status.rs @@ -10,12 +10,35 @@ pub static STATUS_COMPLETED: u32 = 1 << 31; /// 如果子任务执行成功，将状态设置为 0b111，该值定义为 STATUS_OK。 /// 子任务达到最大失败次数或者执行成功时，认为该子任务已经完成。 /// 当所有子任务都已经完成时，为最高位打上标记 1，表示整个下载任务已经完成。 -#[derive(Clone)] -pub struct Status(u32); +#[derive(Clone, Copy, Default)] +pub struct Status(u32); -impl Status { - fn new(status: u32) -> Self { - Self(status) +impl Status { + // 获取最高位的完成标记 + pub fn get_completed(&self) -> bool { + self.0 >> 31 == 1 + } + + /// 依次检查所有子任务是否还应该继续执行，返回一个 bool 数组 + pub fn should_run(&self) -> [bool; N] { + let mut result = [false; N]; + for (i, item) in result.iter_mut().enumerate() { + *item = self.check_continue(i); + } + result + } + + /// 根据任务结果更新状态，任务结果是一个 Result 数组，需要与子任务一一对应 + /// 如果所有子任务都已经完成，那么打上最高位的完成标记 + pub fn update_status(&mut self, result: &[Result<()>]) { + assert!(result.len() == N, "result length should be equal to N"); + for (i, res) in result.iter().enumerate() { + self.set_result(res, i); + } + if self.should_run().iter().all(|x| !x) { + // 所有任务都成功或者由于尝试次数过多失败，为 status 最高位打上标记，将来不再重试 + self.set_completed(true) + } } /// 设置最高位的完成标记 @@ -27,15 +50,14 @@ impl Status { } } - // 获取最高位的完成标记 - fn get_completed(&self) -> bool { - self.0 >> 31 == 1 - } - /// 获取某个子任务的状态 fn get_status(&self, offset: usize) -> u32 { - let helper = !0u32; - (self.0 & (helper << (offset * 3)) & (helper >> (32 - 3 * offset - 3))) >> (offset * 3) + (self.0 >> (offset * 3)) & 0b111 + } + + /// 设置某个子任务的状态 + fn set_status(&mut self, offset: usize, status: u32) { + self.0 = (self.0 & !(0b111 << (offset * 3))) | (status << (offset * 3)); } // 将某个子任务的状态加一（在任务失败时使用） @@ -53,11 +75,6 @@ impl Status { self.get_status(offset) < STATUS_MAX_RETRY } - /// 依次检查所有子任务是否还应该继续执行，返回一个 bool 数组 - fn should_run(&self, size: usize) -> Vec { - (0..size).map(|x| self.check_continue(x)).collect() - } - /// 根据子任务执行结果更新子任务的状态 /// 如果 Result 是 Ok，那么认为任务执行成功，将状态设置为 STATUS_OK /// 如果 Result 是 Err，那么认为任务执行失败，将状态加一 @@ -69,79 +86,48 @@ impl Status { } } } +} - /// 根据任务结果更新状态，任务结果是一个 Result 数组，需要与子任务一一对应 - /// 如果所有子任务都已经完成，那么打上最高位的完成标记 - fn update_status(&mut self, result: &[Result<()>]) { - for (i, res) in result.iter().enumerate() { - self.set_result(res, i); - } - if self.should_run(result.len()).iter().all(|x| !x) { - // 所有任务都成功或者由于尝试次数过多失败，为 status 最高位打上标记，将来不再重试 - self.set_completed(true) - } +impl From for Status { + fn from(status: u32) -> Self { + Status(status) } } -impl From for u32 { - fn from(status: Status) -> Self { +impl From> for u32 { + fn from(status: Status) -> Self { status.0 } } +impl From> for [u32; N] { + fn from(status: Status) -> Self { + let mut result = [0; N]; + for (i, item) in result.iter_mut().enumerate() { + *item = status.get_status(i); + } + result + } +} + +impl From<[u32; N]> for Status { + fn from(status: [u32; N]) -> Self { + let mut result = Status::::default(); + for (i, item) in status.iter().enumerate() { + result.set_status(i, *item); + } + if result.should_run().iter().all(|x| !x) { + result.set_completed(true); + } + result + } +} + /// 包含五个子任务，从前到后依次是：视频封面、视频信息、Up 主头像、Up 主信息、分 P 下载 -#[derive(Clone)] -pub struct VideoStatus(Status); - -impl VideoStatus { - pub fn new(status: u32) -> Self { - Self(Status::new(status)) - } - - pub fn should_run(&self) -> Vec { - self.0.should_run(5) - } - - pub fn update_status(&mut self, result: &[Result<()>]) { - assert!(result.len() == 5, "VideoStatus should have 5 status"); - self.0.update_status(result) - } -} - -impl From for u32 { - fn from(status: VideoStatus) -> Self { - status.0.into() - } -} +pub type VideoStatus = Status<5>; /// 包含五个子任务，从前到后分别是：视频封面、视频内容、视频信息、视频弹幕、视频字幕 -#[derive(Clone)] -pub struct PageStatus(Status); - -impl PageStatus { - pub fn new(status: u32) -> Self { - Self(Status::new(status)) - } - - pub fn should_run(&self) -> Vec { - self.0.should_run(5) - } - - pub fn update_status(&mut self, result: &[Result<()>]) { - assert!(result.len() == 5, "PageStatus should have 5 status"); - self.0.update_status(result) - } - - pub fn get_completed(&self) -> bool { - self.0.get_completed() - } -} - -impl From for u32 { - fn from(status: PageStatus) -> Self { - status.0.into() - } -} +pub type PageStatus = Status<5>; #[cfg(test)] mod test { @@ -150,16 +136,33 @@ mod test { use super::*; #[test] - fn test_status() { - let mut status = Status::new(0); - assert_eq!(status.should_run(3), vec![true, true, true]); - for count in 1..=3 { + fn test_status_update() { + let mut status = Status::<3>::default(); + assert_eq!(status.should_run(), [true, true, true]); + for _ in 0..3 { status.update_status(&[Err(anyhow!("")), Ok(()), Ok(())]); - assert_eq!(status.should_run(3), vec![true, false, false]); - assert_eq!(u32::from(status.clone()), 0b111_111_000 + count); + assert_eq!(status.should_run(), [true, false, false]); } status.update_status(&[Err(anyhow!("")), Ok(()), Ok(())]); - assert_eq!(status.should_run(3), vec![false, false, false]); - assert_eq!(u32::from(status), 0b111_111_100 | STATUS_COMPLETED); + assert_eq!(status.should_run(), [false, false, false]); + } + + #[test] + fn test_status_convert() { + let testcases = [[0, 0, 1], [1, 2, 3], [3, 1, 2], [3, 0, 7]]; + for testcase in testcases.iter() { + let status = Status::<3>::from(testcase.clone()); + assert_eq!(<[u32; 3]>::from(status), *testcase); + } + } + + #[test] + fn test_status_convert_and_update() { + let testcases = [([0, 0, 1], [1, 7, 7]), ([3, 4, 3], [4, 4, 7]), ([3, 1, 7], [4, 7, 7])]; + for (before, after) in testcases.iter() { + let mut status = Status::<3>::from(before.clone()); + status.update_status(&[Err(anyhow!("")), Ok(()), Ok(())]); + assert_eq!(<[u32; 3]>::from(status), *after); + } } } diff --git a/crates/bili_sync/src/workflow.rs b/crates/bili_sync/src/workflow.rs index 5669fa4..85f90cc 100644 --- a/crates/bili_sync/src/workflow.rs +++ b/crates/bili_sync/src/workflow.rs @@ -206,7 +206,7 @@ pub async fn download_video_pages( should_download_upper: bool, ) -> Result { let _permit = semaphore.acquire().await.context("acquire semaphore failed")?; - let mut status = VideoStatus::new(video_model.download_status); + let mut status = VideoStatus::from(video_model.download_status); let seprate_status = status.should_run(); let base_path = video_list_model .path() @@ -316,7 +316,7 @@ pub async fn dispatch_download_page( if model .download_status .try_as_ref() - .is_none_or(|status| !PageStatus::new(*status).get_completed()) + .is_none_or(|status| !PageStatus::from(*status).get_completed()) { error_occurred = true; } @@ -359,7 +359,7 @@ pub async fn download_page( base_path: &Path, ) -> Result { let _permit = semaphore.acquire().await.context("acquire semaphore failed")?; - let mut status = PageStatus::new(page_model.download_status); + let mut status = PageStatus::from(page_model.download_status); let seprate_status = status.should_run(); let is_single_page = video_model.single_page.context("single_page is null")?; let base_name = TEMPLATE.path_safe_render("page", &page_format_args(video_model, &page_model))?;