cargo_lambda_metadata/
config.rs

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
use std::{collections::HashMap, path::PathBuf};

use crate::cargo::{
    build::Build, deploy::Deploy, watch::Watch, CargoMetadata, Metadata, PackageMetadata,
};
use cargo_metadata::{Package, Target};
use figment::{
    providers::{Env, Format, Serialized, Toml},
    Figment,
};
use miette::{IntoDiagnostic, Result};
use serde::{Deserialize, Serialize};

#[derive(Debug, Default)]
pub struct ConfigOptions {
    pub name: Option<String>,
    pub context: Option<String>,
    pub global: Option<PathBuf>,
    pub admerge: bool,
}

#[derive(Debug, Default, Deserialize, Serialize)]
pub struct Config {
    #[serde(default, skip_serializing_if = "HashMap::is_empty")]
    pub env: HashMap<String, String>,
    pub build: Build,
    pub deploy: Deploy,
    pub watch: Watch,
}

impl From<PackageMetadata> for Config {
    fn from(meta: PackageMetadata) -> Self {
        Config {
            env: meta.env,
            build: meta.build.unwrap_or_default(),
            watch: meta.watch.unwrap_or_default(),
            deploy: meta.deploy.unwrap_or_default(),
        }
    }
}

pub fn load_config(
    args_config: &Config,
    metadata: &CargoMetadata,
    options: &ConfigOptions,
) -> Result<Config> {
    let mut figment = figment_from_metadata(metadata, options)?;

    let mut args_serialized = Serialized::defaults(args_config);
    if let Some(context) = &options.context {
        args_serialized = args_serialized.profile(context);
    }

    figment = if options.admerge {
        figment.admerge(args_serialized)
    } else {
        figment.merge(args_serialized)
    };

    figment.extract().into_diagnostic()
}

pub fn load_config_without_cli_flags(
    metadata: &CargoMetadata,
    options: &ConfigOptions,
) -> Result<Config> {
    let figment = figment_from_metadata(metadata, options)?;
    figment.extract().into_diagnostic()
}

fn figment_from_metadata(metadata: &CargoMetadata, options: &ConfigOptions) -> Result<Figment> {
    let (ws_metadata, bin_metadata) = workspace_metadata(metadata, options.name.as_deref())?;
    let package_metadata = package_metadata(metadata, options.name.as_deref())?;

    let mut config_file = options
        .global
        .as_ref()
        .map(Toml::file)
        .unwrap_or_else(|| Toml::file("CargoLambda.toml"));
    if options.context.is_some() {
        config_file = config_file.nested()
    }

    let mut figment = Figment::new();
    if let Some(context) = &options.context {
        figment = figment.select(context)
    }

    let mut env_serialized = Env::prefixed("CARGO_LAMBDA_");
    if let Some(context) = &options.context {
        env_serialized = env_serialized.profile(context);
    }
    figment = figment.merge(env_serialized);

    figment = if options.admerge {
        figment.admerge(config_file)
    } else {
        figment.merge(config_file)
    };

    let mut ws_serialized = Serialized::defaults(ws_metadata);
    if let Some(context) = &options.context {
        ws_serialized = ws_serialized.profile(context);
    }
    if options.admerge {
        figment = figment.admerge(ws_serialized);
    } else {
        figment = figment.merge(ws_serialized);
    }

    if let Some(bin_metadata) = bin_metadata {
        let mut bin_serialized = Serialized::defaults(bin_metadata);
        if let Some(context) = &options.context {
            bin_serialized = bin_serialized.profile(context);
        }

        if options.admerge {
            figment = figment.admerge(bin_serialized);
        } else {
            figment = figment.merge(bin_serialized);
        }
    }

    if let Some(package_metadata) = package_metadata {
        let mut package_serialized = Serialized::defaults(package_metadata);
        if let Some(context) = &options.context {
            package_serialized = package_serialized.profile(context);
        }

        if options.admerge {
            figment = figment.admerge(package_serialized);
        } else {
            figment = figment.merge(package_serialized);
        }
    }

    Ok(figment)
}

fn workspace_metadata(
    metadata: &CargoMetadata,
    name: Option<&str>,
) -> Result<(Config, Option<Config>)> {
    if metadata.workspace_metadata.is_null() || !metadata.workspace_metadata.is_object() {
        return Ok((Config::default(), None));
    }

    let meta: Metadata =
        serde_json::from_value(metadata.workspace_metadata.clone()).into_diagnostic()?;

    let ws_config = meta.lambda.package.into();
    if let Some(name) = name {
        if let Some(bin_config) = meta.lambda.bin.get(name) {
            return Ok((ws_config, Some(bin_config.clone().into())));
        }
    }

    Ok((ws_config, None))
}

fn package_metadata(metadata: &CargoMetadata, name: Option<&str>) -> Result<Option<Config>> {
    let Some(name) = name else {
        let Some(root) = metadata.root_package() else {
            return Ok(None);
        };

        if root.metadata.is_null() || !root.metadata.is_object() {
            return Ok(None);
        }

        let meta: Metadata = serde_json::from_value(root.metadata.clone()).into_diagnostic()?;
        return Ok(Some(meta.lambda.package.into()));
    };

    let kind_condition = |pkg: &Package, target: &Target| {
        target.kind.iter().any(|kind| kind == "bin") && pkg.metadata.is_object()
    };

    for pkg in &metadata.packages {
        for target in &pkg.targets {
            if kind_condition(pkg, target) && target.name == name {
                let meta: Metadata =
                    serde_json::from_value(pkg.metadata.clone()).into_diagnostic()?;

                if let Some(bin_config) = meta.lambda.bin.get(name) {
                    return Ok(Some(bin_config.clone().into()));
                }

                return Ok(Some(meta.lambda.package.into()));
            }
        }
    }

    Ok(None)
}

#[cfg(test)]
mod tests {

    use matchit::MatchError;

    use super::*;
    use crate::{
        cargo::{build::CompilerOptions, load_metadata},
        lambda::{Memory, Tracing},
        tests::fixture_metadata,
    };

    #[test]
    fn test_load_env_from_metadata() {
        let metadata = load_metadata(fixture_metadata("single-binary-package")).unwrap();
        let config = load_config_without_cli_flags(&metadata, &ConfigOptions::default()).unwrap();

        assert_eq!(
            config.deploy.lambda_tags(),
            Some(HashMap::from([
                ("organization".to_string(), "aws".to_string()),
                ("team".to_string(), "lambda".to_string())
            ]))
        );

        assert_eq!(config.env.get("FOO"), Some(&"BAR".to_string()));
        assert_eq!(config.deploy.function_config.memory, Some(Memory::Mb512));
        assert_eq!(config.deploy.function_config.timeout, Some(60.into()));

        assert_eq!(
            config.deploy.function_config.layer,
            Some(vec![
                "arn:aws:lambda:us-east-1:xxxxxxxx:layers:layer1".to_string(),
                "arn:aws:lambda:us-east-1:xxxxxxxx:layers:layer2".to_string()
            ])
        );

        let tracing = config.deploy.function_config.tracing.unwrap();
        assert_eq!(tracing, Tracing::Active);
        assert_eq!(
            config.deploy.function_config.role,
            Some("arn:aws:lambda:us-east-1:xxxxxxxx:iam:role1".to_string())
        );

        let env_options = config.deploy.function_config.env_options.unwrap();
        assert_eq!(env_options.env_var, Some(vec!["VAR1=VAL1".to_string()]));
        assert_eq!(env_options.env_file, Some(".env.production".into()));

        let compiler = config.build.compiler.unwrap();

        let cargo_compiler = match compiler {
            CompilerOptions::Cargo(opts) => opts,
            other => panic!("unexpected compiler: {:?}", other),
        };
        assert_eq!(
            cargo_compiler.subcommand,
            Some(vec!["brazil".to_string(), "build".to_string()])
        );
        assert_eq!(
            cargo_compiler.extra_args,
            Some(vec!["--release".to_string()])
        );
    }

    #[test]
    fn test_load_router_from_metadata_admerge() {
        let options = ConfigOptions {
            name: Some("crate-3".to_string()),
            admerge: true,
            ..Default::default()
        };

        let metadata = load_metadata(fixture_metadata("workspace-package")).unwrap();
        let config = load_config_without_cli_flags(&metadata, &options).unwrap();

        let router = config.watch.router.unwrap();
        assert_eq!(
            router.at("/foo", "GET"),
            Ok(("crate-1".to_string(), HashMap::new()))
        );
        assert_eq!(
            router.at("/bar", "GET"),
            Ok(("crate-1".to_string(), HashMap::new()))
        );
        assert_eq!(
            router.at("/bar", "POST"),
            Ok(("crate-2".to_string(), HashMap::new()))
        );
        assert_eq!(router.at("/baz", "GET"), Err(MatchError::NotFound));
        assert_eq!(
            router.at("/qux", "GET"),
            Ok(("crate-3".to_string(), HashMap::new()))
        );
    }

    #[test]
    fn test_load_router_from_metadata_strict() {
        let options = ConfigOptions {
            name: Some("crate-3".to_string()),
            ..Default::default()
        };

        let metadata = load_metadata(fixture_metadata("workspace-package")).unwrap();
        let config = load_config_without_cli_flags(&metadata, &options).unwrap();

        let router = config.watch.router.unwrap();
        assert_eq!(router.raw.len(), 1);
        assert_eq!(router.at("/foo", "GET"), Err(MatchError::NotFound));
        assert_eq!(router.at("/bar", "GET"), Err(MatchError::NotFound));
        assert_eq!(router.at("/bar", "POST"), Err(MatchError::NotFound));
        assert_eq!(router.at("/baz", "GET"), Err(MatchError::NotFound));
        assert_eq!(
            router.at("/qux", "GET"),
            Ok(("crate-3".to_string(), HashMap::new()))
        );
    }

    #[test]
    fn test_extend_env_from_workspace() {
        let options = ConfigOptions {
            name: Some("basic-lambda-1".to_string()),
            admerge: true,
            ..Default::default()
        };

        let metadata = load_metadata(fixture_metadata("workspace-package")).unwrap();
        let config = load_config_without_cli_flags(&metadata, &options).unwrap();

        assert_eq!(config.env.get("FOO"), Some(&"BAR".to_string()));
        assert_eq!(config.env.get("EXTRA"), Some(&"TRUE".to_string()));
        assert_eq!(config.env.get("AWS_REGION"), Some(&"us-west-2".to_string()));
    }

    #[test]
    fn test_config_with_context() {
        let manifest = fixture_metadata("config-with-context");
        let global = manifest.parent().unwrap().join("CargoLambda.toml");

        let options = ConfigOptions {
            context: Some("production".to_string()),
            global: Some(global.clone()),
            ..Default::default()
        };

        let metadata = load_metadata(manifest).unwrap();
        let config = load_config_without_cli_flags(&metadata, &options).unwrap();
        assert_eq!(config.deploy.function_config.memory, Some(Memory::Mb1024));

        let options = ConfigOptions {
            context: Some("development".to_string()),
            global: Some(global.clone()),
            ..Default::default()
        };

        let config = load_config_without_cli_flags(&metadata, &options).unwrap();
        assert_eq!(config.deploy.function_config.memory, Some(Memory::Mb512));

        let options = ConfigOptions {
            global: Some(global),
            ..Default::default()
        };

        let config = load_config_without_cli_flags(&metadata, &options).unwrap();
        assert_eq!(config.deploy.function_config.memory, Some(Memory::Mb256));
    }

    #[test]
    fn test_config_with_context_and_cli_flags() {
        let manifest = fixture_metadata("config-with-context");
        let global = manifest.parent().unwrap().join("CargoLambda.toml");

        let options = ConfigOptions {
            context: Some("production".to_string()),
            global: Some(global.clone()),
            ..Default::default()
        };

        let mut deploy = Deploy::default();
        deploy.function_config.memory = Some(Memory::Mb2048);

        let args_config = Config {
            deploy,
            ..Default::default()
        };

        let metadata = load_metadata(manifest).unwrap();
        let config = load_config(&args_config, &metadata, &options).unwrap();
        assert_eq!(config.deploy.function_config.memory, Some(Memory::Mb2048));
    }
}