feat(downloads): Added Download Manager

Signed-off-by: quexeky <git@quexeky.dev>
This commit is contained in:
quexeky
2024-11-13 20:38:00 +11:00
parent 3dbf5ab573
commit a1ada07690
7 changed files with 206 additions and 47 deletions

View File

@ -66,7 +66,7 @@ impl GameDownloadAgent {
// Blocking // Blocking
// Requires mutable self // Requires mutable self
pub fn setup_download(&mut self) -> Result<(), GameDownloadError> { pub fn setup_download(&self) -> Result<(), GameDownloadError> {
self.ensure_manifest_exists()?; self.ensure_manifest_exists()?;
info!("Ensured manifest exists"); info!("Ensured manifest exists");
@ -79,23 +79,22 @@ impl GameDownloadAgent {
} }
// Blocking // Blocking
pub fn download(&mut self) -> Result<(), GameDownloadError> { pub fn download(&self) -> Result<(), GameDownloadError> {
self.setup_download()?; self.setup_download()?;
self.run(); self.run();
Ok(()) Ok(())
} }
pub fn ensure_manifest_exists(&mut self) -> Result<(), GameDownloadError> { pub fn ensure_manifest_exists(&self) -> Result<(), GameDownloadError> {
if self.manifest.lock().unwrap().is_some() { if self.manifest.lock().unwrap().is_some() {
return Ok(()); return Ok(());
} }
// Explicitly propagate error
self.download_manifest() self.download_manifest()
} }
fn download_manifest(&mut self) -> Result<(), GameDownloadError> { fn download_manifest(&self) -> Result<(), GameDownloadError> {
let base_url = DB.fetch_base_url(); let base_url = DB.fetch_base_url();
let manifest_url = base_url let manifest_url = base_url
.join( .join(
@ -138,7 +137,8 @@ impl GameDownloadAgent {
.values() .values()
.map(|chunk| chunk.lengths.len()) .map(|chunk| chunk.lengths.len())
.sum(); .sum();
self.progress = ProgressObject::new(length.try_into().unwrap(), chunk_count); self.progress.set_max(length.try_into().unwrap());
self.progress.set_size(chunk_count);
if let Ok(mut manifest) = self.manifest.lock() { if let Ok(mut manifest) = self.manifest.lock() {
*manifest = Some(manifest_download); *manifest = Some(manifest_download);

View File

@ -3,7 +3,7 @@ use std::sync::{Arc, Mutex};
use log::info; use log::info;
use rayon::spawn; use rayon::spawn;
use crate::{downloads::download_agent::GameDownloadAgent, AppState}; use crate::{AppState};
#[tauri::command] #[tauri::command]
pub fn download_game( pub fn download_game(
@ -29,7 +29,7 @@ pub fn download_game(
download_agent_ref.clone().run(); download_agent_ref.clone().run();
}); });
*/ */
state.lock().unwrap().download_manager.queue_game(game_id, game_version, 0).unwrap();
Ok(()) Ok(())
} }
@ -45,8 +45,12 @@ pub fn get_game_download_progress(
Ok(progress.get_progress()) Ok(progress.get_progress())
*/ */
let progress = match state.lock().unwrap().download_manager.get_current_game_download_progress() {
Some(progress) => progress,
None => 0.0
};
Ok(0.0) Ok(progress)
} }
/* /*
fn use_download_agent( fn use_download_agent(

View File

@ -3,6 +3,7 @@ use crate::db::DatabaseImpls;
use crate::downloads::manifest::DropDownloadContext; use crate::downloads::manifest::DropDownloadContext;
use crate::remote::RemoteAccessError; use crate::remote::RemoteAccessError;
use crate::DB; use crate::DB;
use log::info;
use md5::{Context, Digest}; use md5::{Context, Digest};
use reqwest::blocking::Response; use reqwest::blocking::Response;
@ -123,6 +124,7 @@ pub fn download_game_chunk(
) -> Result<bool, GameDownloadError> { ) -> Result<bool, GameDownloadError> {
// If we're paused // If we're paused
if control_flag.get() == DownloadThreadControlFlag::Stop { if control_flag.get() == DownloadThreadControlFlag::Stop {
info!("Control flag is Stop");
return Ok(false); return Ok(false);
} }

View File

@ -1,40 +1,182 @@
use std::{ use std::{
collections::HashMap, collections::{HashMap, VecDeque}, sync::{mpsc::{channel, Receiver, SendError, Sender}, Arc, Mutex, MutexGuard}, thread::{spawn, JoinHandle},
sync::{Arc, Mutex},
thread::JoinHandle,
}; };
use super::{download_agent::GameDownloadAgent, download_thread_control_flag::DownloadThreadControlFlag}; use log::info;
use super::{download_agent::GameDownloadAgent, download_thread_control_flag::{DownloadThreadControl, DownloadThreadControlFlag}, progress_object::ProgressObject};
pub struct DownloadManager { pub struct DownloadManager {
download_agent_registry: HashMap<String, Arc<Mutex<GameDownloadAgent>>>, download_agent_registry: HashMap<String, Arc<GameDownloadAgent>>,
download_queue: Vec<String>, download_queue: Arc<Mutex<VecDeque<String>>>,
receiver: Receiver<DownloadManagerSignal>,
sender: Sender<DownloadManagerSignal>,
progress: Arc<Mutex<Option<ProgressObject>>>,
current_thread: Option<JoinHandle<()>>,
current_game_id: Option<String>, // Should be the only game download agent in the map with the "Go" flag current_game_id: Option<String>, // Should be the only game download agent in the map with the "Go" flag
active_control_flag: Option<DownloadThreadControl>
}
pub struct DownloadManagerInterface {
terminator: JoinHandle<Result<(),()>>,
download_queue: Arc<Mutex<VecDeque<String>>>,
progress: Arc<Mutex<Option<ProgressObject>>>,
sender: Sender<DownloadManagerSignal>,
}
pub enum DownloadManagerSignal {
Go,
Stop,
Completed(String),
Queue(String, String, usize)
} }
impl DownloadManager { impl DownloadManagerInterface {
pub fn new() -> Self { pub fn queue_game(&self, game_id: String, version: String, target_download_dir: usize) -> Result<(), SendError<DownloadManagerSignal>> {
return Self { info!("Adding game id {}", game_id);
download_agent_registry: HashMap::new(), self.sender.send(DownloadManagerSignal::Queue(game_id, version, target_download_dir))?;
download_queue: Vec::new(), self.sender.send(DownloadManagerSignal::Go)
current_thread: None,
current_game_id: None,
};
} }
pub fn edit(&self) -> MutexGuard<'_, VecDeque<String>> {
pub fn queue_game(&mut self, game_id: String, version_name: String) { self.download_queue.lock().unwrap()
let existing_da = self.download_agent_registry.get(&game_id); }
pub fn get_current_game_download_progress(&self) -> Option<f64> {
if let Some(da_mutex) = existing_da { let progress_object = (*self.progress.lock().unwrap()).clone()?;
let da = da_mutex.lock().unwrap(); Some(progress_object.get_progress())
if da.version == version_name { }
return; // We're already queued pub fn rearrange_string(&self, id: String, new_index: usize) {
} let mut queue = self.edit();
let current_index = get_index_from_id(&mut queue, id).unwrap();
da.control_flag.set(DownloadThreadControlFlag::Stop); let to_move = queue.remove(current_index).unwrap();
queue.insert(new_index, to_move);
}
pub fn rearrange(&self, current_index: usize, new_index: usize) {
let mut queue = self.edit();
let to_move = queue.remove(current_index).unwrap();
queue.insert(new_index, to_move);
}
pub fn remove_from_queue(&self, index: usize) {
self.edit().remove(index);
}
pub fn remove_from_queue_string(&self, game_id: String) {
let mut queue = self.edit();
let current_index = get_index_from_id(&mut queue, game_id).unwrap();
queue.remove(current_index);
}
pub fn pause_downloads(&self) -> Result<(), SendError<DownloadManagerSignal>> {
self.sender.send(DownloadManagerSignal::Stop)
}
pub fn resume_downloads(&self) -> Result<(), SendError<DownloadManagerSignal>> {
self.sender.send(DownloadManagerSignal::Go)
}
pub fn ensure_terminated(self) -> Result<(), ()> {
match self.terminator.join() {
Ok(o) => o,
Err(_) => Err(()),
} }
} }
} }
impl DownloadManager {
pub fn generate() -> DownloadManagerInterface {
let queue = Arc::new(Mutex::new(VecDeque::new()));
let (sender, receiver) = channel();
let active_progress = Arc::new(Mutex::new(None));
let manager = Self {
download_agent_registry: HashMap::new(),
download_queue: queue.clone(),
receiver,
current_game_id: None,
active_control_flag: None,
sender: sender.clone(),
progress: active_progress.clone(),
};
let terminator = spawn(|| {manager.manage_queue()});
let interface = DownloadManagerInterface {
terminator,
download_queue: queue,
sender,
progress: active_progress
};
return interface;
}
fn manage_queue(mut self) -> Result<(), ()> {
loop {
let signal = match self.receiver.recv() {
Ok(signal) => signal,
Err(e) => {
return Err(())
},
};
match signal {
DownloadManagerSignal::Go => {
info!("Got signal 'Go'");
if self.active_control_flag.is_none() && !self.download_agent_registry.is_empty() {
info!("Starting download agent");
let download_agent = {
let lock = self.download_queue.lock().unwrap();
self.download_agent_registry.get(&lock.front().unwrap().clone()).unwrap().clone()
};
self.current_game_id = Some(download_agent.id.clone());
let progress_object = download_agent.progress.clone();
*self.progress.lock().unwrap() = Some(progress_object);
let active_control_flag = download_agent.control_flag.clone();
self.active_control_flag = Some(active_control_flag.clone());
let sender = self.sender.clone();
info!("Spawning download");
spawn(move || {
download_agent.download().unwrap();
sender.send(DownloadManagerSignal::Completed(download_agent.id.clone())).unwrap();
});
info!("Finished spawning Download");
active_control_flag.set(DownloadThreadControlFlag::Go);
}
else if let Some(active_control_flag) = self.active_control_flag.clone() {
info!("Restarting current download");
active_control_flag.set(DownloadThreadControlFlag::Go);
}
else {
info!("Nothing was set");
}
},
DownloadManagerSignal::Stop => {
info!("Got signal 'Stop'");
if let Some(active_control_flag) = self.active_control_flag.clone() {
active_control_flag.set(DownloadThreadControlFlag::Stop);
}
},
DownloadManagerSignal::Completed(game_id) => {
info!("Got signal 'Completed'");
if self.current_game_id == Some(game_id.clone()) {
info!("Popping consumed data");
self.download_queue.lock().unwrap().pop_front();
self.download_agent_registry.remove(&game_id);
self.active_control_flag = None;
*self.progress.lock().unwrap() = None;
}
self.sender.send(DownloadManagerSignal::Go).unwrap();
}
DownloadManagerSignal::Queue(game_id, version, target_download_dir) => {
info!("Got signal Queue");
let download_agent = Arc::new(GameDownloadAgent::new(game_id.clone(), version, target_download_dir));
self.download_agent_registry.insert(game_id.clone(), download_agent);
self.download_queue.lock().unwrap().push_back(game_id);
},
};
}
}
}
pub fn get_index_from_id(queue: &mut MutexGuard<'_, VecDeque<String>>, id: String) -> Option<usize> {
queue.iter().position(|download_agent| {
download_agent == &id
})
}

View File

@ -1,33 +1,44 @@
use std::sync::{ use std::sync::{
atomic::{AtomicUsize, Ordering}, atomic::{AtomicUsize, Ordering},
Arc, Arc, Mutex,
}; };
#[derive(Clone)] #[derive(Clone)]
pub struct ProgressObject { pub struct ProgressObject {
max: usize, max: Arc<Mutex<usize>>,
progress_instances: Arc<Vec<Arc<AtomicUsize>>>, progress_instances: Arc<Mutex<Vec<Arc<AtomicUsize>>>>,
} }
impl ProgressObject { impl ProgressObject {
pub fn new(max: usize, length: usize) -> Self { pub fn new(max: usize, length: usize) -> Self {
let arr = (0..length).map(|_| Arc::new(AtomicUsize::new(0))).collect(); let arr = Mutex::new((0..length).map(|_| Arc::new(AtomicUsize::new(0))).collect());
Self { Self {
max, max: Arc::new(Mutex::new(max)),
progress_instances: Arc::new(arr), progress_instances: Arc::new(arr),
} }
} }
pub fn sum(&self) -> usize { pub fn sum(&self) -> usize {
self.progress_instances self.progress_instances
.lock()
.unwrap()
.iter() .iter()
.map(|instance| instance.load(Ordering::Relaxed)) .map(|instance| instance.load(Ordering::Relaxed))
.sum() .sum()
} }
pub fn get_max(&self) -> usize {
self.max.lock().unwrap().clone()
}
pub fn set_max(&self, new_max: usize) {
*self.max.lock().unwrap() = new_max
}
pub fn set_size(&self, length: usize) {
*self.progress_instances.lock().unwrap() = (0..length).map(|_| Arc::new(AtomicUsize::new(0))).collect();
}
pub fn get_progress(&self) -> f64 { pub fn get_progress(&self) -> f64 {
self.sum() as f64 / self.max as f64 self.sum() as f64 / self.get_max() as f64
} }
pub fn get(&self, index: usize) -> Arc<AtomicUsize> { pub fn get(&self, index: usize) -> Arc<AtomicUsize> {
self.progress_instances[index].clone() self.progress_instances.lock().unwrap()[index].clone()
} }
} }

View File

@ -13,7 +13,7 @@ use crate::downloads::download_agent::GameDownloadAgent;
use auth::{auth_initiate, generate_authorization_header, recieve_handshake}; use auth::{auth_initiate, generate_authorization_header, recieve_handshake};
use db::{add_new_download_dir, DatabaseInterface, DATA_ROOT_DIR}; use db::{add_new_download_dir, DatabaseInterface, DATA_ROOT_DIR};
use downloads::download_commands::*; use downloads::download_commands::*;
use downloads::download_manager::DownloadManager; use downloads::download_manager::{DownloadManager, DownloadManagerInterface};
use env_logger::Env; use env_logger::Env;
use http::{header::*, response::Builder as ResponseBuilder}; use http::{header::*, response::Builder as ResponseBuilder};
use library::{fetch_game, fetch_library, Game}; use library::{fetch_game, fetch_library, Game};
@ -54,7 +54,7 @@ pub struct AppState {
games: HashMap<String, Game>, games: HashMap<String, Game>,
#[serde(skip_serializing)] #[serde(skip_serializing)]
download_manager: Arc<DownloadManager>, download_manager: Arc<DownloadManagerInterface>,
} }
#[tauri::command] #[tauri::command]
@ -69,7 +69,7 @@ fn setup() -> AppState {
env_logger::Builder::from_env(Env::default().default_filter_or("info")).init(); env_logger::Builder::from_env(Env::default().default_filter_or("info")).init();
let games = HashMap::new(); let games = HashMap::new();
let download_manager = Arc::new(DownloadManager::new()); let download_manager = Arc::new(DownloadManager::generate());
let is_set_up = DB.database_is_set_up(); let is_set_up = DB.database_is_set_up();
if !is_set_up { if !is_set_up {