aws_cdk.assertions.Annotations.find_error: Instead of emitting none, shows KeyError: 'aws-cdk-lib.cloud_assembly_schema.MetadataEntry

[pwrmiller]

Describe the bug

In previous versions of CDK, aws_cdk.assertions.Annotations.from_stack worked, in newer versions of CDK it is broken (in Python 3.12)

Calls to Annotations similar to

    Annotations.from_stack(mystack).find_error(
        "*",
        "some-error",
    )

Now, the find_error raises:

Traceback (most recent call last):

  File "aws_cdk/assertions/__init__.py", line 725, in find_error
    return typing.cast(typing.List[_SynthesisMessage_b3ae3c62], jsii.invoke(self, "findError", [construct_path, message]))
                                                                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "jsii/_kernel/__init__.py", line 149, in wrapped
    return _recursize_dereference(kernel, fn(kernel, *args, **kwargs))
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "jsii/_kernel/__init__.py", line 137, in _recursize_dereference
    return [_recursize_dereference(kernel, i) for i in d]
            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "jsii/_kernel/__init__.py", line 139, in _recursize_dereference
    return _reference_map.resolve_reference(kernel, d)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "jsii/_reference_map.py", line 122, in resolve
    python_name: kernel.get(remote_struct, jsii_name)
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "jsii/_kernel/__init__.py", line 149, in wrapped
    return _recursize_dereference(kernel, fn(kernel, *args, **kwargs))
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "jsii/_kernel/__init__.py", line 139, in _recursize_dereference
    return _reference_map.resolve_reference(kernel, d)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "jsii/_reference_map.py", line 129, in resolve
    return InterfaceDynamicProxy(self.build_interface_proxies_for_ref(ref))
                                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "jsii/_reference_map.py", line 137, in build_interface_proxies_for_ref
    ifaces = [_interfaces[fqn] for fqn in ref.interfaces or []]
              ~~~~~~~~~~~^^^^^
KeyError: 'aws-cdk-lib.cloud_assembly_schema.MetadataEntry'

I suspect that this is broken after #32998 since this is a relatively recent change impacting MetadataEntry.

Running the find_error on a message that does not exist succeeds (returns an empty array). It is interesting that has_error works correctly, but find_error appears to be broken.

Regression Issue

• Select this option if this issue appears to be a regression.

Last Known Working CDK Version

No response

Expected Behavior

I expect both find_error and has_error to work correctly.

Current Behavior

find_error now raises a KeyError related to MetadataEntry, see above

Reproduction Steps

from aws_cdk import App, Stack, Annotations
import aws_cdk.assertions

if __name__ == "__main__":
    app = App()
    stack = Stack(app, "MyStack")
    Annotations.of(stack).add_error("oh no")

    assertions = aws_cdk.assertions.Annotations.from_stack(stack).find_error(
        "*",
        "oh no"
    )
   # raises KeyError: 'aws-cdk-lib.cloud_assembly_schema.MetadataEntry', but we expect this to not raise anything.

Possible Solution

No response

Additional Information/Context

No response

CDK CLI Version

2.177.0

Framework Version

aws-cdk-lib 2.177.0

Node.js Version

v20.18.1

OS

Darwin DYFXL2QQK9 24.3.0 Darwin Kernel Version 24.3.0: Thu Jan 2 20:24:16 PST 2025; root:xnu-11215.81.4~3/RELEASE_ARM64_T6000 arm64

Language

Python

Language Version

3.12

Other information

No response

[pahud]

Hi

I was not able to reproduce this issue.

My code app.py

from aws_cdk import App, Stack, Annotations
import aws_cdk.assertions

if __name__ == "__main__":
    app = App()
    stack = Stack(app, "MyStack")
    Annotations.of(stack).add_error("oh no")

    assertions = aws_cdk.assertions.Annotations.from_stack(stack).find_error(
        "*",
        "oh no"
    )

% npx cdk synth
[Error at /MyStack] oh no
Found errors

% npx cdk --version
2.177.0 (build b396961)
% grep cdk requirements.txt 
aws-cdk-lib==2.177.0

Can you init a fresh environment and let me know if the issue persists?

[pwrmiller]

Blame cosmic rays, I guess. A fresh virtual environment resolved the issue. Thanks for the prompt response.

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.