ai-igniter 1.1.0

Lightning-fast standalone workspace & service orchestrator for AI worktrees and parallel development
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
use anyhow::{Context, Result, bail};
use serde::{Deserialize, Serialize};
use std::collections::{BTreeMap, HashMap, HashSet};
use std::path::{Component, Path, PathBuf};

use crate::services::BUILTIN_SERVICES;
use crate::services::all_reserved_names;
pub use crate::services::garage::GarageConfig;
#[allow(unused_imports)]
pub use crate::services::postgres::NeonProxyConfig;
pub use crate::services::postgres::PostgresConfig;

pub const CONFIG_FILE_NAME: &str = "ai-igniter.toml";

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Config {
    pub name: String,
    /// Fixed base port. When unset and no orchestrator port is provided, it is derived from the workspace path.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub base_port: Option<u16>,

    /// Existing compose file used instead of the generated one (relative to the workspace, then the root).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub compose_file: Option<PathBuf>,

    /// Command to execute during dev mode after services are healthy (e.g. "bun run dev").
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub dev_command: Option<String>,

    /// File in the workspace which receives the ai-igniter managed environment block.
    pub env_file: PathBuf,

    /// Files seeded from the root checkout when a worktree file is absent.
    pub copy_files: Vec<CopyFileRule>,

    #[serde(default)]
    pub orchestrator: OrchestratorConfig,

    #[serde(default)]
    pub services: ServicesConfig,

    #[serde(default)]
    pub env_template: BTreeMap<String, String>,
}

/// A file copied from the root checkout to a worktree on first use.
///
/// TOML accepts either `".env"` (same source and destination) or
/// `{ from = ".env", to = ".env.local" }`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub struct CopyFileRule {
    pub from: PathBuf,
    pub to: PathBuf,
}

impl<'de> Deserialize<'de> for CopyFileRule {
    fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        #[derive(Deserialize)]
        #[serde(untagged)]
        enum Rule {
            SamePath(PathBuf),
            Rename { from: PathBuf, to: PathBuf },
        }

        match Rule::deserialize(deserializer)? {
            Rule::SamePath(path) => Ok(Self {
                from: path.clone(),
                to: path,
            }),
            Rule::Rename { from, to } => Ok(Self { from, to }),
        }
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct OrchestratorConfig {
    /// Env var holding the workspace base port (e.g. PASEO_PORT)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub port_env: Option<String>,
    /// Env var holding the source checkout path, used to seed `.env` in new worktrees
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub root_env: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct ServicesConfig {
    pub postgres: Option<PostgresConfig>,
    pub garage: Option<GarageConfig>,
    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
    pub custom: BTreeMap<String, CustomServiceConfig>,
}

impl ServicesConfig {
    #[allow(dead_code)]
    pub fn postgres(&self) -> Option<&PostgresConfig> {
        self.postgres.as_ref().filter(|c| c.enabled)
    }

    #[cfg_attr(not(test), allow(dead_code))]
    pub fn garage(&self) -> Option<&GarageConfig> {
        self.garage.as_ref().filter(|c| c.enabled)
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CustomServiceConfig {
    pub image: String,
    pub port_offset: Option<u16>,
    pub target_port: Option<u16>,
    #[serde(default)]
    pub environment: BTreeMap<String, String>,
    #[serde(default)]
    pub command: Vec<String>,
    #[serde(default)]
    pub volumes: Vec<String>,
}

impl Config {
    pub fn env_file(&self) -> &Path {
        self.env_file.as_path()
    }

    pub fn load_from_file(path: &Path) -> Result<Self> {
        let content = std::fs::read_to_string(path)
            .with_context(|| format!("Failed to read config file at {:?}", path))?;
        let config: Config = toml::from_str(&content)
            .with_context(|| format!("Failed to parse TOML in {:?}", path))?;
        Ok(config)
    }

    pub fn find_config(workspace_path: &Path, root_path: &Path) -> Result<(PathBuf, Self)> {
        let candidates = [
            workspace_path.join(CONFIG_FILE_NAME),
            workspace_path.join(format!(".{}", CONFIG_FILE_NAME)),
            root_path.join(CONFIG_FILE_NAME),
            root_path.join(format!(".{}", CONFIG_FILE_NAME)),
        ];

        for candidate in &candidates {
            if candidate.exists() {
                let cfg = Self::load_from_file(candidate)?;
                return Ok((candidate.clone(), cfg));
            }
        }

        anyhow::bail!(
            "Configuration file '{}' not found in workspace ({:?}) or root ({:?}). Run `ai-igniter init` to create one.",
            CONFIG_FILE_NAME,
            workspace_path,
            root_path
        )
    }

    /// Host port offsets of enabled services, keyed by allocation name.
    pub fn port_offsets(&self) -> Vec<(String, u16)> {
        let mut offsets = Vec::new();
        for provider in BUILTIN_SERVICES {
            offsets.extend(provider.port_offsets(&self.services));
        }
        for (name, custom) in &self.services.custom {
            if let Some(offset) = custom.port_offset {
                offsets.push((name.clone(), offset));
            }
        }
        offsets
    }

    pub fn validate(&self) -> Result<()> {
        if sanitize_name(&self.name).is_empty() {
            bail!("`name` must contain at least one ASCII letter or digit");
        }

        validate_relative_file_path("`env_file`", self.env_file())?;
        let mut destinations = HashSet::new();
        for rule in &self.copy_files {
            validate_relative_file_path("`copy_files.from`", &rule.from)?;
            validate_relative_file_path("`copy_files.to`", &rule.to)?;
            if !destinations.insert(rule.to.clone()) {
                bail!(
                    "`copy_files` contains more than one rule for destination {:?}",
                    rule.to
                );
            }
        }

        let reserved = all_reserved_names();
        for (name, custom) in &self.services.custom {
            let valid = name.starts_with(|c: char| c.is_ascii_lowercase() || c.is_ascii_digit())
                && name
                    .chars()
                    .all(|c| c.is_ascii_lowercase() || c.is_ascii_digit() || c == '_' || c == '-');
            if !valid {
                bail!("Custom service name '{name}' must match [a-z0-9][a-z0-9_-]*");
            }
            if reserved.contains(&name.as_str()) {
                bail!("Custom service name '{name}' is reserved");
            }
            if custom.port_offset.is_some() != custom.target_port.is_some() {
                bail!(
                    "Custom service '{name}': `port_offset` and `target_port` must be set together"
                );
            }
        }

        let offsets = self.port_offsets();
        let mut seen: HashMap<u16, &str> = HashMap::new();
        for (name, offset) in &offsets {
            if *offset == 0 {
                bail!(
                    "Service '{name}' has port offset 0, which collides with the base (app) port"
                );
            }
            if let Some(other) = seen.insert(*offset, name) {
                bail!("Services '{other}' and '{name}' share port offset {offset}");
            }
        }
        Ok(())
    }
}

fn validate_relative_file_path(field: &str, path: &Path) -> Result<()> {
    if path.as_os_str().is_empty() {
        bail!("{field} must not be empty");
    }

    for component in path.components() {
        match component {
            Component::Normal(_) => {}
            Component::CurDir => bail!("{field} must name a file, not the workspace directory"),
            Component::ParentDir => bail!("{field} must not contain `..`: {:?}", path),
            Component::RootDir | Component::Prefix(_) => {
                bail!("{field} must be relative: {:?}", path)
            }
        }
    }
    Ok(())
}

/// Lowercases and replaces characters Docker Compose rejects in project names.
pub fn sanitize_name(raw: &str) -> String {
    raw.to_lowercase()
        .chars()
        .map(|c| {
            if c.is_ascii_alphanumeric() || c == '_' || c == '-' {
                c
            } else {
                '-'
            }
        })
        .collect::<String>()
        .trim_matches(|c| c == '-' || c == '_')
        .to_string()
}

#[cfg(test)]
mod tests {
    use super::*;

    fn parse(toml_str: &str) -> Config {
        let mut prefix = String::new();
        if !toml_str.contains("env_file") {
            prefix.push_str("env_file = \".env\"\n");
        }
        if !toml_str.contains("copy_files") {
            prefix.push_str("copy_files = []\n");
        }
        let doc = format!("{prefix}{toml_str}");
        toml::from_str(&doc).unwrap()
    }

    #[test]
    fn base_port_is_optional() {
        assert_eq!(parse("name = \"my-project\"").base_port, None);
        assert_eq!(
            parse("name = \"my-project\"\nbase_port = 4000").base_port,
            Some(4000)
        );
    }

    #[test]
    fn base_port_serialized_only_when_set() {
        let mut config = parse("name = \"my-project\"");
        assert!(
            !toml::to_string_pretty(&config)
                .unwrap()
                .contains("base_port")
        );
        config.base_port = Some(4500);
        assert!(
            toml::to_string_pretty(&config)
                .unwrap()
                .contains("base_port = 4500")
        );
    }

    #[test]
    fn dev_command_is_optional_and_serializes_when_set() {
        let config = parse("name = \"my-project\"");
        assert_eq!(config.dev_command, None);
        assert!(
            !toml::to_string_pretty(&config)
                .unwrap()
                .contains("dev_command")
        );

        let with_cmd = parse("name = \"my-project\"\ndev_command = \"bun run dev\"");
        assert_eq!(with_cmd.dev_command.as_deref(), Some("bun run dev"));
        assert!(
            toml::to_string_pretty(&with_cmd)
                .unwrap()
                .contains("dev_command = \"bun run dev\"")
        );
    }

    #[test]
    fn parses_copy_file_string_syntax() {
        let config = parse("name = \"p\"\ncopy_files = [\".env\"]");
        assert_eq!(
            config.copy_files,
            vec![CopyFileRule {
                from: PathBuf::from(".env"),
                to: PathBuf::from(".env"),
            }]
        );
    }

    #[test]
    fn parses_copy_file_object_and_mixed_syntax() {
        let config = parse(
            r#"
name = "p"
copy_files = [".env.test", { from = ".env", to = ".env.local" }]
"#,
        );
        assert_eq!(
            config.copy_files,
            vec![
                CopyFileRule {
                    from: PathBuf::from(".env.test"),
                    to: PathBuf::from(".env.test"),
                },
                CopyFileRule {
                    from: PathBuf::from(".env"),
                    to: PathBuf::from(".env.local"),
                },
            ]
        );
    }

    #[test]
    fn copy_files_and_env_file_are_mandatory() {
        assert!(toml::from_str::<Config>("name = \"p\"").is_err());
        assert!(toml::from_str::<Config>("name = \"p\"\nenv_file = \".env\"").is_err());
        assert!(toml::from_str::<Config>("name = \"p\"\ncopy_files = []").is_err());
        assert!(
            toml::from_str::<Config>("name = \"p\"\nenv_file = \".env\"\ncopy_files = []").is_ok()
        );
    }

    #[test]
    fn env_file_serializes_and_reads_correctly() {
        let config = parse("name = \"p\"\nenv_file = \".env.local\"");
        assert_eq!(config.env_file(), Path::new(".env.local"));
        assert!(
            toml::to_string_pretty(&config)
                .unwrap()
                .contains("env_file = \".env.local\"")
        );
    }

    #[test]
    fn rejects_unsafe_file_paths_and_duplicate_destinations() {
        for setting in [
            "env_file = \"../outside\"",
            "env_file = \"/outside\"",
            "env_file = \"\"",
            "copy_files = [{ from = \"../outside\", to = \".env\" }]",
            "copy_files = [{ from = \".env\", to = \"../outside\" }]",
        ] {
            let config = parse(&format!("name = \"p\"\n{setting}"));
            assert!(config.validate().is_err(), "{setting}");
        }

        let duplicate = parse(
            r#"
name = "p"
copy_files = [
  ".env.local",
  { from = ".env", to = ".env.local" },
]
"#,
        );
        assert!(duplicate.validate().is_err());
    }

    #[test]
    fn legacy_workspace_env_is_ignored() {
        let config = parse(
            "name = \"p\"\n[orchestrator]\nport_env = \"PASEO_PORT\"\nworkspace_env = \"PASEO_WORKTREE_PATH\"",
        );
        assert_eq!(config.orchestrator.port_env.as_deref(), Some("PASEO_PORT"));
    }

    #[test]
    fn rejects_duplicate_offsets() {
        let config = parse(
            r#"
name = "p"
[services.postgres]
database = "p"
user = "p"
password = "p"
[services.garage]
access_key = "k"
secret_key = "s"
port_offset = 1
"#,
        );
        let err = config.validate().unwrap_err().to_string();
        assert!(err.contains("share port offset 1"), "{err}");
    }

    #[test]
    fn disabled_services_do_not_reserve_offsets() {
        let config = parse(
            r#"
name = "p"
[services.garage]
enabled = false
access_key = "k"
secret_key = "s"
port_offset = 1
[services.custom.mail]
image = "axllent/mailpit"
port_offset = 1
target_port = 8025
"#,
        );
        config.validate().unwrap();
    }

    #[test]
    fn rejects_zero_offset_and_reserved_custom_names() {
        let zero = parse(
            "name = \"p\"\n[services.postgres]\ndatabase = \"p\"\nuser = \"p\"\npassword = \"p\"\nport_offset = 0",
        );
        assert!(zero.validate().is_err());
        let reserved = parse("name = \"p\"\n[services.custom.postgres]\nimage = \"x\"");
        assert!(reserved.validate().is_err());
        let half_port =
            parse("name = \"p\"\n[services.custom.mail]\nimage = \"x\"\nport_offset = 7");
        assert!(half_port.validate().is_err());
    }

    #[test]
    fn sanitizes_names_for_compose() {
        assert_eq!(sanitize_name("My App"), "my-app");
        assert_eq!(sanitize_name("_ai.tools-"), "ai-tools");
        assert_eq!(sanitize_name("éé"), "");
    }

    #[test]
    fn all_buckets_dedupes_website_buckets() {
        let config = parse(
            r#"
name = "p"
[services.garage]
access_key = "k"
secret_key = "s"
buckets = ["assets", "uploads"]
website_buckets = ["assets", "site"]
"#,
        );
        assert_eq!(
            config.services.garage().unwrap().all_buckets(),
            ["assets", "uploads", "site"]
        );
    }

    #[test]
    fn postgres_neon_proxy_reserves_offset_and_names() {
        let config = parse(
            r#"
name = "p"
[services.postgres]
database = "p"
user = "u"
password = "p"
neon_proxy = true
[services.custom.app2]
image = "myimage"
port_offset = 2
target_port = 8080
"#,
        );
        let err = config.validate().unwrap_err().to_string();
        assert!(err.contains("share port offset 2"), "{err}");

        let reserved_name = parse(
            r#"
name = "p"
[services.custom.neon-proxy]
image = "myimage"
"#,
        );
        assert!(reserved_name.validate().is_err());
    }
}