aws-runtime 1.9.0

Runtime support code for the AWS SDK. This crate isn't intended to be used directly.
Documentation
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
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

use std::borrow::Cow;
use std::fmt;

use http_1x::header::{HeaderName, HeaderValue, InvalidHeaderValue, USER_AGENT};

use aws_credential_types::credential_feature::AwsCredentialFeature;
use aws_smithy_runtime::client::sdk_feature::SmithySdkFeature;
use aws_smithy_runtime_api::box_error::BoxError;
use aws_smithy_runtime_api::client::http::HttpClient;
use aws_smithy_runtime_api::client::interceptors::context::{
    BeforeTransmitInterceptorContextMut, BeforeTransmitInterceptorContextRef,
};
use aws_smithy_runtime_api::client::interceptors::{dyn_dispatch_hint, Intercept};
use aws_smithy_runtime_api::client::runtime_components::RuntimeComponents;
use aws_smithy_types::config_bag::ConfigBag;
use aws_types::app_name::AppName;
use aws_types::os_shim_internal::Env;

use crate::sdk_feature::AwsSdkFeature;
use crate::user_agent::metrics::ProvideBusinessMetric;
use crate::user_agent::{AdditionalMetadata, ApiMetadata, AwsUserAgent, InvalidMetadataValue};

macro_rules! add_metrics_unique {
    ($features:expr, $ua:expr, $added:expr) => {
        for feature in $features {
            if let Some(m) = feature.provide_business_metric() {
                if !$added.contains(&m) {
                    $added.insert(m.clone());
                    $ua.add_business_metric(m);
                }
            }
        }
    };
}

macro_rules! add_metrics_unique_reverse {
    ($features:expr, $ua:expr, $added:expr) => {
        let mut unique_metrics = Vec::new();
        for feature in $features {
            if let Some(m) = feature.provide_business_metric() {
                if !$added.contains(&m) {
                    $added.insert(m.clone());
                    unique_metrics.push(m);
                }
            }
        }
        for m in unique_metrics.into_iter().rev() {
            $ua.add_business_metric(m);
        }
    };
}

#[allow(clippy::declare_interior_mutable_const)] // we will never mutate this
const X_AMZ_USER_AGENT: HeaderName = HeaderName::from_static("x-amz-user-agent");

#[derive(Debug)]
enum UserAgentInterceptorError {
    MissingApiMetadata,
    InvalidHeaderValue(InvalidHeaderValue),
    InvalidMetadataValue(InvalidMetadataValue),
}

impl std::error::Error for UserAgentInterceptorError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Self::InvalidHeaderValue(source) => Some(source),
            Self::InvalidMetadataValue(source) => Some(source),
            Self::MissingApiMetadata => None,
        }
    }
}

impl fmt::Display for UserAgentInterceptorError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(match self {
            Self::InvalidHeaderValue(_) => "AwsUserAgent generated an invalid HTTP header value. This is a bug. Please file an issue.",
            Self::InvalidMetadataValue(_) => "AwsUserAgent generated an invalid metadata value. This is a bug. Please file an issue.",
            Self::MissingApiMetadata => "The UserAgentInterceptor requires ApiMetadata to be set before the request is made. This is a bug. Please file an issue.",
        })
    }
}

impl From<InvalidHeaderValue> for UserAgentInterceptorError {
    fn from(err: InvalidHeaderValue) -> Self {
        UserAgentInterceptorError::InvalidHeaderValue(err)
    }
}

impl From<InvalidMetadataValue> for UserAgentInterceptorError {
    fn from(err: InvalidMetadataValue) -> Self {
        UserAgentInterceptorError::InvalidMetadataValue(err)
    }
}

/// Generates and attaches the AWS SDK's user agent to a HTTP request
#[non_exhaustive]
#[derive(Debug, Default)]
pub struct UserAgentInterceptor;

impl UserAgentInterceptor {
    /// Creates a new `UserAgentInterceptor`
    pub fn new() -> Self {
        UserAgentInterceptor
    }
}

fn header_values(
    ua: &AwsUserAgent,
) -> Result<(HeaderValue, HeaderValue), UserAgentInterceptorError> {
    // Pay attention to the extremely subtle difference between ua_header and aws_ua_header below...
    Ok((
        HeaderValue::try_from(ua.ua_header())?,
        HeaderValue::try_from(ua.aws_ua_header())?,
    ))
}

#[dyn_dispatch_hint]
impl Intercept for UserAgentInterceptor {
    fn name(&self) -> &'static str {
        "UserAgentInterceptor"
    }

    fn read_after_serialization(
        &self,
        _context: &BeforeTransmitInterceptorContextRef<'_>,
        _runtime_components: &RuntimeComponents,
        cfg: &mut ConfigBag,
    ) -> Result<(), BoxError> {
        // Allow for overriding the user agent by an earlier interceptor (so, for example,
        // tests can use `AwsUserAgent::for_tests()`) by attempting to grab one out of the
        // config bag before creating one.
        if cfg.load::<AwsUserAgent>().is_some() {
            return Ok(());
        }

        let api_metadata = cfg
            .load::<ApiMetadata>()
            .ok_or(UserAgentInterceptorError::MissingApiMetadata)?;
        let mut ua = AwsUserAgent::new_from_environment(Env::real(), api_metadata.clone());

        let maybe_app_name = cfg.load::<AppName>();
        if let Some(app_name) = maybe_app_name {
            ua.set_app_name(app_name.clone());
        }

        // Drain customer-supplied framework metadata appended via `StoreAppend`.
        //
        // `ConfigBag::load` over a `StoreAppend` type yields every appended value across ALL config
        // layers in reverse insertion order (newest-first), e.g. entries copied in from `SdkConfig`
        // followed by client-level entries come back last-to-first. To present entries to the
        // customer in deterministic first-seen (insertion) order, we collect and reverse the
        // iterator. We dedup on the exact (name, version) pair, preserving first-seen order, and
        // cap the total number of unique entries at 10.
        const MAX_FRAMEWORK_METADATA: usize = 10;
        let appended: Vec<&aws_types::sdk_ua_metadata::FrameworkMetadata> = cfg
            .load::<aws_types::sdk_ua_metadata::FrameworkMetadata>()
            .collect();
        let mut seen = std::collections::HashSet::new();
        let mut kept = 0usize;
        for md in appended.into_iter().rev() {
            let key = (md.name().to_owned(), md.version().map(|v| v.to_owned()));
            if !seen.insert(key) {
                // Duplicate (name, version) -- skip.
                continue;
            }
            if kept >= MAX_FRAMEWORK_METADATA {
                tracing::warn!(
                    "More than {MAX_FRAMEWORK_METADATA} unique framework metadata entries \
                     were configured; only the first {MAX_FRAMEWORK_METADATA} will be included \
                     in the user agent."
                );
                break;
            }
            // `md` is already the canonical `FrameworkMetadata` type, so no conversion is needed.
            ua.add_framework_metadata(md.clone());
            kept += 1;
        }

        cfg.interceptor_state().store_put(ua);

        Ok(())
    }

    fn modify_before_signing(
        &self,
        context: &mut BeforeTransmitInterceptorContextMut<'_>,
        runtime_components: &RuntimeComponents,
        cfg: &mut ConfigBag,
    ) -> Result<(), BoxError> {
        let mut ua = cfg
            .load::<AwsUserAgent>()
            .expect("`AwsUserAgent should have been created in `read_before_execution`")
            .clone();

        let mut added_metrics = std::collections::HashSet::new();

        add_metrics_unique!(cfg.load::<SmithySdkFeature>(), &mut ua, &mut added_metrics);
        add_metrics_unique!(cfg.load::<AwsSdkFeature>(), &mut ua, &mut added_metrics);
        // The order we emit credential features matters.
        // Reverse to preserve emission order since StoreAppend pops backwards.
        add_metrics_unique_reverse!(
            cfg.load::<AwsCredentialFeature>(),
            &mut ua,
            &mut added_metrics
        );

        let maybe_connector_metadata = runtime_components
            .http_client()
            .and_then(|c| c.connector_metadata());
        if let Some(connector_metadata) = maybe_connector_metadata {
            let am = AdditionalMetadata::new(Cow::Owned(connector_metadata.to_string()))?;
            ua.add_additional_metadata(am);
        }

        let headers = context.request_mut().headers_mut();
        let (user_agent, x_amz_user_agent) = header_values(&ua)?;
        headers.append(USER_AGENT, user_agent);
        headers.append(X_AMZ_USER_AGENT, x_amz_user_agent);
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use aws_smithy_runtime_api::client::interceptors::context::{Input, InterceptorContext};
    use aws_smithy_runtime_api::client::interceptors::Intercept;
    use aws_smithy_runtime_api::client::orchestrator::HttpRequest;
    use aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder;
    use aws_smithy_types::config_bag::{ConfigBag, Layer};
    use aws_smithy_types::error::display::DisplayErrorContext;

    fn expect_header<'a>(context: &'a InterceptorContext, header_name: &str) -> &'a str {
        context
            .request()
            .expect("request is set")
            .headers()
            .get(header_name)
            .unwrap()
    }

    fn context() -> InterceptorContext {
        let mut context = InterceptorContext::new(Input::doesnt_matter());
        context.enter_serialization_phase();
        context.set_request(HttpRequest::empty());
        let _ = context.take_input();
        context.enter_before_transmit_phase();
        context
    }

    #[test]
    fn test_overridden_ua() {
        let rc = RuntimeComponentsBuilder::for_tests().build().unwrap();
        let mut context = context();

        let mut layer = Layer::new("test");
        layer.store_put(AwsUserAgent::for_tests());
        layer.store_put(ApiMetadata::new("unused", "unused"));
        let mut cfg = ConfigBag::of_layers(vec![layer]);

        let interceptor = UserAgentInterceptor::new();
        let mut ctx = Into::into(&mut context);
        interceptor
            .modify_before_signing(&mut ctx, &rc, &mut cfg)
            .unwrap();

        let ua_header = expect_header(&context, "user-agent");
        assert_eq!(AwsUserAgent::for_tests().ua_header(), ua_header);
        assert!(!ua_header.contains("unused"));

        let aws_ua_header = expect_header(&context, "x-amz-user-agent");
        assert_eq!(AwsUserAgent::for_tests().ua_header(), aws_ua_header);
        assert!(!aws_ua_header.contains("unused"));
    }

    #[test]
    fn test_default_ua() {
        let rc = RuntimeComponentsBuilder::for_tests().build().unwrap();
        let mut context = context();

        let api_metadata = ApiMetadata::new("some-service", "some-version");
        let mut layer = Layer::new("test");
        layer.store_put(api_metadata.clone());
        let mut config = ConfigBag::of_layers(vec![layer]);

        let interceptor = UserAgentInterceptor::new();
        let ctx = Into::into(&context);
        interceptor
            .read_after_serialization(&ctx, &rc, &mut config)
            .unwrap();
        let mut ctx = Into::into(&mut context);
        interceptor
            .modify_before_signing(&mut ctx, &rc, &mut config)
            .unwrap();

        let expected_ua = AwsUserAgent::new_from_environment(Env::real(), api_metadata);
        assert!(
            expected_ua.aws_ua_header().contains("some-service"),
            "precondition"
        );
        assert_eq!(
            expected_ua.ua_header(),
            expect_header(&context, "user-agent")
        );
        assert_eq!(
            expected_ua.aws_ua_header(),
            expect_header(&context, "x-amz-user-agent")
        );
    }

    #[test]
    fn test_modify_before_signing_no_duplicate_metrics() {
        let rc = RuntimeComponentsBuilder::for_tests().build().unwrap();
        let mut context = context();

        let api_metadata = ApiMetadata::new("test-service", "1.0");
        let mut layer = Layer::new("test");
        layer.store_put(api_metadata);
        // Duplicate features
        layer.store_append(SmithySdkFeature::Waiter);
        layer.store_append(SmithySdkFeature::Waiter);
        layer.store_append(AwsSdkFeature::S3Transfer);
        layer.store_append(AwsSdkFeature::S3Transfer);
        layer.store_append(AwsCredentialFeature::CredentialsCode);
        layer.store_append(AwsCredentialFeature::CredentialsCode);
        let mut config = ConfigBag::of_layers(vec![layer]);

        let interceptor = UserAgentInterceptor::new();
        let ctx = Into::into(&context);
        interceptor
            .read_after_serialization(&ctx, &rc, &mut config)
            .unwrap();
        let mut ctx = Into::into(&mut context);
        interceptor
            .modify_before_signing(&mut ctx, &rc, &mut config)
            .unwrap();

        let ua_header = expect_header(&context, "x-amz-user-agent");
        let aws_ua_header = expect_header(&context, "x-amz-user-agent");
        let ua_metrics_section = ua_header.split(" m/").nth(1).unwrap();
        let aws_ua_metrics_section = aws_ua_header.split(" m/").nth(1).unwrap();
        assert_eq!(ua_metrics_section, aws_ua_metrics_section);

        let waiter_count = ua_metrics_section.matches("B").count();
        let s3_transfer_count = ua_metrics_section.matches("G").count();
        let credentials_code_count = ua_metrics_section.matches("e").count();
        assert_eq!(
            1, waiter_count,
            "Waiter metric should appear only once, but found {waiter_count} occurrences in: {aws_ua_header}",
        );
        assert_eq!(1, s3_transfer_count, "S3Transfer metric should appear only once, but found {s3_transfer_count} occurrences in metrics section: {aws_ua_header}");
        assert_eq!(1, credentials_code_count, "CredentialsCode metric should appear only once, but found {credentials_code_count} occurrences in metrics section: {aws_ua_header}");
    }

    #[test]
    fn test_metrics_order_preserved() {
        use aws_credential_types::credential_feature::AwsCredentialFeature;

        let rc = RuntimeComponentsBuilder::for_tests().build().unwrap();
        let mut context = context();

        let api_metadata = ApiMetadata::new("test-service", "1.0");
        let mut layer = Layer::new("test");
        layer.store_put(api_metadata);
        layer.store_append(AwsCredentialFeature::CredentialsCode);
        layer.store_append(AwsCredentialFeature::CredentialsEnvVars);
        layer.store_append(AwsCredentialFeature::CredentialsProfile);
        let mut config = ConfigBag::of_layers(vec![layer]);

        let interceptor = UserAgentInterceptor::new();
        let ctx = Into::into(&context);
        interceptor
            .read_after_serialization(&ctx, &rc, &mut config)
            .unwrap();
        let mut ctx = Into::into(&mut context);
        interceptor
            .modify_before_signing(&mut ctx, &rc, &mut config)
            .unwrap();

        let ua_header = expect_header(&context, "user-agent");
        let ua_metrics_section = ua_header.split(" m/").nth(1).unwrap();
        assert_eq!(
            ua_metrics_section, "e,g,n",
            "AwsCredentialFeature metrics should preserve order"
        );

        let aws_ua_header = expect_header(&context, "x-amz-user-agent");
        let aws_ua_metrics_section = aws_ua_header.split(" m/").nth(1).unwrap();
        assert_eq!(
            aws_ua_metrics_section, "e,g,n",
            "AwsCredentialFeature metrics should preserve order"
        );
    }

    #[test]
    fn test_app_name() {
        let rc = RuntimeComponentsBuilder::for_tests().build().unwrap();
        let mut context = context();

        let api_metadata = ApiMetadata::new("some-service", "some-version");
        let mut layer = Layer::new("test");
        layer.store_put(api_metadata);
        layer.store_put(AppName::new("my_awesome_app").unwrap());
        let mut config = ConfigBag::of_layers(vec![layer]);

        let interceptor = UserAgentInterceptor::new();
        let ctx = Into::into(&context);
        interceptor
            .read_after_serialization(&ctx, &rc, &mut config)
            .unwrap();
        let mut ctx = Into::into(&mut context);
        interceptor
            .modify_before_signing(&mut ctx, &rc, &mut config)
            .unwrap();

        let app_value = "app/my_awesome_app";
        let ua_header = expect_header(&context, "user-agent");
        assert!(
            ua_header.contains(app_value),
            "expected `{ua_header}` to contain `{app_value}`"
        );

        let aws_ua_header = expect_header(&context, "x-amz-user-agent");
        assert!(
            aws_ua_header.contains(app_value),
            "expected `{aws_ua_header}` to contain `{app_value}`"
        );
    }

    fn run_interceptor_with_framework_metadata(
        entries: Vec<aws_types::sdk_ua_metadata::FrameworkMetadata>,
    ) -> String {
        let rc = RuntimeComponentsBuilder::for_tests().build().unwrap();
        let mut context = context();

        let api_metadata = ApiMetadata::new("some-service", "some-version");
        let mut layer = Layer::new("test");
        layer.store_put(api_metadata);
        for entry in entries {
            layer.store_append(entry);
        }
        let mut config = ConfigBag::of_layers(vec![layer]);

        let interceptor = UserAgentInterceptor::new();
        let ctx = Into::into(&context);
        interceptor
            .read_after_serialization(&ctx, &rc, &mut config)
            .unwrap();
        let mut ctx = Into::into(&mut context);
        interceptor
            .modify_before_signing(&mut ctx, &rc, &mut config)
            .unwrap();

        expect_header(&context, "x-amz-user-agent").to_string()
    }

    #[test]
    fn test_framework_metadata() {
        use aws_types::sdk_ua_metadata::FrameworkMetadata;

        let header = run_interceptor_with_framework_metadata(vec![
            FrameworkMetadata::new("framework-one", Some("1.0")).unwrap(),
            FrameworkMetadata::new("framework-two", Some("2.0")).unwrap(),
        ]);

        assert!(
            header.contains("lib/framework-one/1.0"),
            "expected `{header}` to contain `lib/framework-one/1.0`"
        );
        assert!(
            header.contains("lib/framework-two/2.0"),
            "expected `{header}` to contain `lib/framework-two/2.0`"
        );
        // First-seen order must be preserved.
        let pos_one = header.find("lib/framework-one/1.0").unwrap();
        let pos_two = header.find("lib/framework-two/2.0").unwrap();
        assert!(
            pos_one < pos_two,
            "expected framework-one before framework-two in `{header}`"
        );
    }

    #[test]
    fn test_framework_metadata_dedup() {
        use aws_types::sdk_ua_metadata::FrameworkMetadata;

        let header = run_interceptor_with_framework_metadata(vec![
            FrameworkMetadata::new("dup-framework", Some("1.0")).unwrap(),
            FrameworkMetadata::new("dup-framework", Some("1.0")).unwrap(),
        ]);

        assert_eq!(
            1,
            header.matches("lib/dup-framework/1.0").count(),
            "expected `lib/dup-framework/1.0` to appear exactly once in `{header}`"
        );
    }

    #[test]
    fn test_framework_metadata_cap() {
        use aws_types::sdk_ua_metadata::FrameworkMetadata;

        let entries = (0..15)
            .map(|i| FrameworkMetadata::new(format!("framework-{i}"), Some("1.0")).unwrap())
            .collect();
        let header = run_interceptor_with_framework_metadata(entries);

        let count = header.matches("lib/framework-").count();
        assert_eq!(
            10, count,
            "expected at most 10 framework metadata entries, found {count} in `{header}`"
        );
    }

    #[test]
    fn test_framework_metadata_cap_boundary() {
        use aws_types::sdk_ua_metadata::FrameworkMetadata;

        // Exactly 10 unique entries: all retained.
        let ten = (0..10)
            .map(|i| FrameworkMetadata::new(format!("fw-{i}"), Some("1.0")).unwrap())
            .collect();
        let header = run_interceptor_with_framework_metadata(ten);
        for i in 0..10 {
            assert!(
                header.contains(&format!("lib/fw-{i}/1.0")),
                "expected `lib/fw-{i}/1.0` in `{header}`"
            );
        }

        // Eleven unique entries: the first 10 (first-seen) are retained, the 11th is dropped.
        let eleven = (0..11)
            .map(|i| FrameworkMetadata::new(format!("gw-{i}"), Some("1.0")).unwrap())
            .collect();
        let header = run_interceptor_with_framework_metadata(eleven);
        assert_eq!(
            10,
            header.matches("lib/gw-").count(),
            "expected exactly 10 entries in `{header}`"
        );
        assert!(
            !header.contains("lib/gw-10/1.0"),
            "the 11th entry should be dropped in `{header}`"
        );
    }

    #[test]
    fn test_framework_metadata_dedup_preserves_first_occurrence_order() {
        use aws_types::sdk_ua_metadata::FrameworkMetadata;

        // A duplicate of an earlier entry must not reorder the surviving entries.
        let header = run_interceptor_with_framework_metadata(vec![
            FrameworkMetadata::new("a", Some("1.0")).unwrap(),
            FrameworkMetadata::new("b", Some("1.0")).unwrap(),
            FrameworkMetadata::new("a", Some("1.0")).unwrap(), // duplicate of the first
            FrameworkMetadata::new("c", Some("1.0")).unwrap(),
        ]);

        let pa = header.find("lib/a/1.0").expect("a present");
        let pb = header.find("lib/b/1.0").expect("b present");
        let pc = header.find("lib/c/1.0").expect("c present");
        assert!(
            pa < pb && pb < pc,
            "expected first-seen order a, b, c in `{header}`"
        );
        assert_eq!(
            1,
            header.matches("lib/a/1.0").count(),
            "duplicate entry should appear once in `{header}`"
        );
    }

    #[test]
    fn test_framework_metadata_no_version() {
        use aws_types::sdk_ua_metadata::FrameworkMetadata;

        let header = run_interceptor_with_framework_metadata(vec![FrameworkMetadata::new(
            "noversion-framework",
            None::<&str>,
        )
        .unwrap()]);

        assert!(
            header.contains("lib/noversion-framework"),
            "expected `lib/noversion-framework` in `{header}`"
        );
        assert!(
            !header.contains("lib/noversion-framework/"),
            "expected no trailing slash for a versionless entry in `{header}`"
        );
    }

    #[test]
    fn test_framework_metadata_across_layers_preserves_first_seen_order() {
        use aws_types::sdk_ua_metadata::FrameworkMetadata;

        let rc = RuntimeComponentsBuilder::for_tests().build().unwrap();
        let mut context = context();

        // Simulate the real flow: entries copied in from `SdkConfig` live in an earlier (base)
        // layer, and client-level entries are appended in a later layer. First-seen order must be
        // preserved across both layers despite `StoreAppend` loading newest-first.
        let mut base_layer = Layer::new("from_sdk_config");
        base_layer.store_put(ApiMetadata::new("some-service", "some-version"));
        base_layer.store_append(FrameworkMetadata::new("from-sdk-config", Some("1.0")).unwrap());

        let mut client_layer = Layer::new("from_client");
        client_layer.store_append(FrameworkMetadata::new("from-client", Some("2.0")).unwrap());

        let mut config = ConfigBag::of_layers(vec![base_layer, client_layer]);

        let interceptor = UserAgentInterceptor::new();
        let ctx = Into::into(&context);
        interceptor
            .read_after_serialization(&ctx, &rc, &mut config)
            .unwrap();
        let mut ctx = Into::into(&mut context);
        interceptor
            .modify_before_signing(&mut ctx, &rc, &mut config)
            .unwrap();
        let header = expect_header(&context, "x-amz-user-agent");

        let pos_sdk = header
            .find("lib/from-sdk-config/1.0")
            .expect("sdk-config entry present");
        let pos_client = header
            .find("lib/from-client/2.0")
            .expect("client entry present");
        assert!(
            pos_sdk < pos_client,
            "expected the SdkConfig entry before the client entry in `{header}`"
        );
    }

    #[test]
    fn test_api_metadata_missing() {
        let rc = RuntimeComponentsBuilder::for_tests().build().unwrap();
        let context = context();
        let mut config = ConfigBag::base();

        let interceptor = UserAgentInterceptor::new();
        let ctx = Into::into(&context);

        let error = format!(
            "{}",
            DisplayErrorContext(
                &*interceptor
                    .read_after_serialization(&ctx, &rc, &mut config)
                    .expect_err("it should error")
            )
        );
        assert!(
            error.contains("This is a bug"),
            "`{error}` should contain message `This is a bug`"
        );
    }

    #[test]
    fn test_api_metadata_missing_with_ua_override() {
        let rc = RuntimeComponentsBuilder::for_tests().build().unwrap();
        let mut context = context();

        let mut layer = Layer::new("test");
        layer.store_put(AwsUserAgent::for_tests());
        let mut config = ConfigBag::of_layers(vec![layer]);

        let interceptor = UserAgentInterceptor::new();
        let mut ctx = Into::into(&mut context);

        interceptor
            .modify_before_signing(&mut ctx, &rc, &mut config)
            .expect("it should succeed");

        let ua_header = expect_header(&context, "user-agent");
        assert_eq!(AwsUserAgent::for_tests().ua_header(), ua_header);
        assert!(!ua_header.contains("unused"));

        let aws_ua_header = expect_header(&context, "x-amz-user-agent");
        assert_eq!(AwsUserAgent::for_tests().ua_header(), aws_ua_header);
        assert!(!aws_ua_header.contains("unused"));
    }
}