chore: snapshotting transition.

Author: l-monninger

environments/core/box/src/environment/config.rs

@@ -2,6 +2,7 @@ use crate::BoxEnvironment;
 use clap::Parser;
 use serde::{Deserialize, Serialize};
 use std::fmt::Debug;
+use std::path::PathBuf;
 
 /// Errors thrown when working with the [Config].
 #[derive(Debug, thiserror::Error)]
@@ -16,13 +17,24 @@ pub enum EnvironmentConfigError {
 /// This is the frontend for the core API.
 #[derive(Parser, Debug, Serialize, Deserialize, Clone, Default)]
 #[clap(help_expected = true)]
-pub struct Config {}
+pub struct Config {
+	/// The rest api url of the box environment.
+	pub rest_api_url: String,
+	/// The db dir of the box environment.
+	pub db_dir: PathBuf,
+	/// Whether to isolate the box environment by snapshotting the movement runner and where to store the snapshot.
+	pub snapshot_dir: Option<PathBuf>,
+}
 
 impl Config {
 	/// Builds the [BoxEnvironment] struct from the config.
 	///
 	/// Note: preserving faillibility here because we may add debug path configuration to the [BoxEnvironment] soon.
 	pub fn build(&self) -> Result<BoxEnvironment, EnvironmentConfigError> {
-		Ok(BoxEnvironment::new())
+		Ok(BoxEnvironment::new(
+			self.rest_api_url.clone(),
+			self.db_dir.clone(),
+			self.snapshot_dir.clone(),
+		))
 	}
 }

environments/core/box/src/environment/environment.rs

@@ -1,6 +1,11 @@
+use anyhow::Context;
 use mtma_environment_types::{EnvironmentError, Environmentish};
-use mtma_migrator_types::migrator::MovementMigrator;
+use mtma_migrator_types::migrator::{
+	movement_migrator::{LiveMigrator, Runner},
+	MovementMigrator,
+};
 use std::fmt::Debug;
+use std::path::PathBuf;
 
 /// Errors thrown when using the [BoxEnvironment].
 #[derive(Debug, thiserror::Error)]
@@ -15,16 +20,55 @@ impl From<BoxEnvironmentError> for EnvironmentError {
 	}
 }
 
-pub struct BoxEnvironment {}
+pub struct BoxEnvironment {
+	/// The rest api url of the box environment.
+	pub rest_api_url: String,
+	/// The db dir of the box environment.
+	pub db_dir: PathBuf,
+	/// Whether to isolate the box environment by snapshotting the movement runner and where to store the snapshot.
+	pub snapshot_dir: Option<PathBuf>,
+}
 
 impl BoxEnvironment {
-	pub fn new() -> Self {
-		Self {}
+	pub fn new(rest_api_url: String, db_dir: PathBuf, snapshot_dir: Option<PathBuf>) -> Self {
+		Self { rest_api_url, db_dir, snapshot_dir }
 	}
 }
 
 impl Environmentish for BoxEnvironment {
 	async fn build_movement_migrator(&self) -> Result<MovementMigrator, EnvironmentError> {
-		Err(BoxEnvironmentError::Internal(anyhow::anyhow!("not implemented").into()).into())
+		// construct the live migrator
+		let movement_migrator = MovementMigrator::new(Runner::Live(LiveMigrator::new(
+			self.rest_api_url.clone(),
+			self.db_dir.clone(),
+		)));
+
+		// make sure the live migrator is ready
+		let movement_migrator_for_task = movement_migrator.clone();
+		let migrator_task = kestrel::task(async move { movement_migrator_for_task.run().await });
+
+		// wait for the rest api to be ready
+		let _rest_api_url = movement_migrator
+			.wait_for_rest_api_url(tokio::time::Duration::from_secs(300))
+			.await
+			.context("failed to wait for the rest api to be ready")
+			.map_err(|e| BoxEnvironmentError::Internal(e.into()))?;
+
+		// end the migrator task
+		kestrel::end!(migrator_task)
+			.context("failed to end the migrator task")
+			.map_err(|e| BoxEnvironmentError::Internal(e.into()))?;
+
+		// if we're snapshotting the movement_migrator should be a snapshot of the live migrator
+		let movement_migrator = match &self.snapshot_dir {
+			Some(snapshot_dir) => movement_migrator
+				.snapshot(snapshot_dir.clone())
+				.await
+				.context("failed to snapshot the movement migrator")
+				.map_err(|e| BoxEnvironmentError::Internal(e.into()))?,
+			None => movement_migrator,
+		};
+
+		Ok(movement_migrator)
 	}
 }

migration/cli/migrate-node/docs/cli/README.md

@@ -140,7 +140,13 @@ Options:
 **Selection (2/4):** `environment-box`
 The config for the [BoxEnvironment]
 
-Usage: --environment-box.*
+Usage: --environment-box.* <REST_API_URL> <DB_DIR> [SNAPSHOT_DIR]
+
+Arguments:
+  <REST_API_URL>  The rest api url of the box environment
+  <DB_DIR>        The db dir of the box environment
+  [SNAPSHOT_DIR]  Whether to isolate the box environment by snapshotting the movement runner and where to store the
+                  snapshot
 
 Options:
   -h, --help  Print help (see more with '--help')