(toolkit): Warning/Errors added using constructs.ConstructMetadata keys type are ignored

[NetaNir]

Warning/error/info messages that are collected during synth will only be printed out by the toolkit if their type in the metadata array is prefixed with aws:cdk: (see code). Since metadata added via constructs uses the ConstructMetadata keys which does not include the aws:cdk: prefix:

/**
 * Metadata keys used by constructs.
 */
export class ConstructMetadata {
  /**
   * If set in the construct's context, omits stack traces from metadata entries.
   */
  public static readonly DISABLE_STACK_TRACE_IN_METADATA = 'disable-stack-trace';

  /**
   * Context type for info level messages.
   */
  public static readonly INFO_METADATA_KEY = 'info';

  /**
   * Context type for warning level messages.
   */
  public static readonly WARNING_METADATA_KEY = 'warning';

  /**
   * Context type for error level messages.
   */
  public static readonly ERROR_METADATA_KEY = 'error';

  private constructor() { }
}

will not be printed out by the toolkit.

To give more debug context, this happens since renderMessage method in CloudArtifact use the cxschema.ArtifactMetadataEntryType keys to collect the messages from the metadata array which all includes the aws:cdk: prefix, meaning other types will be ignored (e,g warning will be ignored but aws:cdk:warning will be added).

Is this by design? From the docs in constructs it does not seem like it:

  /**
   * Adds a { "info": <message> } metadata entry to this construct.
   * The toolkit will display the info message when apps are synthesized.
   * @param message The info message.

code

Environment

• CDK CLI Version:
• Module Version:
• Node.js Version:
• OS:
• Language (Version):

[iliapolo]

@NetaNir It looks like an oversight, definitely not intended.

We should take this into account if the constructs-compat removal RFC: aws/aws-cdk-rfcs#195

[iliapolo]

See aws/aws-cdk-rfcs#195 (comment)

[github-actions]

This issue has not received any attention in 1 year. If you want to keep this issue open, please leave a comment below and auto-close will be canceled.