fix: added xdebug + linux support - fixes #37

wf2_core/src/context.rs

@@ -1,3 +1,4 @@
+use crate::os::OsInfo;
 use crate::php::PHP;
 use crate::recipes::recipe_kinds::RecipeKinds;
 use crate::scripts::scripts::Scripts;
@@ -97,6 +98,9 @@ pub struct Context {
 
     #[serde(default)]
     pub origin: Option<String>,
+
+    #[serde(skip, default)]
+    pub os: OsInfo,
 }
 
 ///
@@ -135,6 +139,7 @@ impl Default for Context {
             env: None,
             scripts: None,
             origin: None,
+            os: OsInfo::new(),
         }
     }
 }

wf2_core/src/lib.rs

@@ -29,6 +29,7 @@ pub mod dc_tasks;
 pub mod dc_volume;
 pub mod file;
 pub mod file_op;
+pub mod os;
 pub mod output;
 pub mod php;
 pub mod recipes;

wf2_core/src/os.rs

@@ -0,0 +1,40 @@
+///
+/// Relevant OS information that commands
+/// may/may-not care about
+///
+#[derive(Debug, PartialEq, Default, Clone)]
+pub struct OsInfo {
+    pub os_type: OsType,
+}
+
+impl OsInfo {
+    pub fn new() -> OsInfo {
+        OsInfo {
+            #[cfg(target_os = "macos")]
+            os_type: OsType::Mac,
+
+            #[cfg(target_os = "windows")]
+            os_type: OsType::Windows,
+
+            // this wont take effect if either of the above apply
+            ..Default::default()
+        }
+    }
+}
+
+///
+/// Deliberately not an exhaustive list.
+/// If it's not window or mac, assume linux
+///
+#[derive(Debug, PartialEq, Clone)]
+pub enum OsType {
+    Mac,
+    Windows,
+    Linux,
+}
+
+impl Default for OsType {
+    fn default() -> Self {
+        OsType::Linux
+    }
+}

wf2_core/src/recipes/m2/m2_runtime_env_file.rs

@@ -1,5 +1,6 @@
 use crate::context::Context;
 use crate::file::File;
+use crate::os::{OsInfo, OsType};
 use env_proc::env_vars;
 use snailquote::escape;
 use std::collections::HashMap;
@@ -106,6 +107,7 @@ pub fn create_runtime_env(
     merged.insert(EnvVarKeys::HostGid, ctx.gid.to_string());
     merged.insert(EnvVarKeys::MageHost, format!("https://{}", domain));
     merged.insert(EnvVarKeys::PhpIdeConfig, format!("serverName={}", domain));
+    merged.insert(EnvVarKeys::XdebugConfig, docker_host(&ctx.os));
 
     Ok(print(merged))
 }
@@ -126,6 +128,16 @@ fn print(store: HashMap<EnvVarKeys, String>) -> Vec<u8> {
     buffer
 }
 
+fn docker_host(os_info: &OsInfo) -> String {
+    use OsType::*;
+    match os_info.os_type {
+        Mac => "docker.for.mac.host.internal",
+        Windows => "docker.for.windows.host.internal",
+        _ => "host.docker.internal",
+    }
+    .to_string()
+}
+
 #[derive(Deserialize, Default, Debug, Clone)]
 pub struct M2EnvVars(HmEnv);
 
@@ -151,4 +163,5 @@ fn test_env_hash_without_overrides() {
     let as_str = std::str::from_utf8(&env).expect("test");
     assert!(as_str.contains("PHP_IDE_CONFIG=serverName=local.m2"));
     assert!(as_str.contains(r#"MAGE_ROOT_DIR=/var/www"#));
+    assert!(as_str.contains(r#"XDEBUG_CONFIG=docker.for.mac.host.internal"#));
 }