Skip to content

feat(ecr-assets): throw ValidationErrors instead of untyped Errors #33899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 25, 2025
Merged

feat(ecr-assets): throw ValidationErrors instead of untyped Errors #33899

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1b4a50
use typed error
badmintoncryer Mar 25, 2025
a6f614b
fix
badmintoncryer Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/aws-cdk-lib/.eslintrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ const enableNoThrowDefaultErrorIn = [
'aws-docdb',
'aws-dynamodb',
'aws-ecr',
'aws-ecr-assets',
'aws-efs',
'aws-elasticloadbalancing',
'aws-elasticloadbalancingv2',
Expand Down
10 changes: 5 additions & 5 deletions packages/aws-cdk-lib/aws-ecr-assets/lib/image-asset.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import * as path from 'path';
import { Construct } from 'constructs';
import { FingerprintOptions, FollowMode, IAsset } from '../../assets';
import * as ecr from '../../aws-ecr';
import { Annotations, AssetStaging, FeatureFlags, FileFingerprintOptions, IgnoreMode, Stack, SymlinkFollowMode, Token, Stage, CfnResource } from '../../core';
import { Annotations, AssetStaging, FeatureFlags, FileFingerprintOptions, IgnoreMode, Stack, SymlinkFollowMode, Token, Stage, CfnResource, ValidationError, UnscopedValidationError } from '../../core';
import * as cxapi from '../../cx-api';

/**
Expand Down Expand Up @@ -435,14 +435,14 @@ export class DockerImageAsset extends Construct implements IAsset {
// resolve full path
const dir = path.resolve(props.directory);
if (!fs.existsSync(dir)) {
throw new Error(`Cannot find image directory at ${dir}`);
throw new ValidationError(`Cannot find image directory at ${dir}`, this);
}

// validate the docker file exists
this.dockerfilePath = props.file || 'Dockerfile';
const file = path.join(dir, this.dockerfilePath);
if (!fs.existsSync(file)) {
throw new Error(`Cannot find file at ${file}`);
throw new ValidationError(`Cannot find file at ${file}`, this);
}

const defaultIgnoreMode = FeatureFlags.of(this).isEnabled(cxapi.DOCKER_IGNORE_SUPPORT)
Expand Down Expand Up @@ -582,7 +582,7 @@ export class DockerImageAsset extends Construct implements IAsset {
function validateProps(props: DockerImageAssetProps) {
for (const [key, value] of Object.entries(props)) {
if (Token.isUnresolved(value)) {
throw new Error(`Cannot use Token as value of '${key}': this value is used before deployment starts`);
throw new UnscopedValidationError(`Cannot use Token as value of '${key}': this value is used before deployment starts`);
}
}

Expand All @@ -593,7 +593,7 @@ function validateProps(props: DockerImageAssetProps) {
function validateBuildProps(buildPropName: string, buildProps?: { [key: string]: string }) {
for (const [key, value] of Object.entries(buildProps || {})) {
if (Token.isUnresolved(key) || Token.isUnresolved(value)) {
throw new Error(`Cannot use tokens in keys or values of "${buildPropName}" since they are needed before deployment`);
throw new UnscopedValidationError(`Cannot use tokens in keys or values of "${buildPropName}" since they are needed before deployment`);
}
}
}
Expand Down
Loading