aws/aws-cdk

(cdk synth): incorrect and confused message about `spawnSync docker ENOENT`

Open

#22997 opened on Nov 20, 2022

View on GitHub
 (7 comments) (0 reactions) (0 assignees)TypeScript (10,710 stars) (3,530 forks)batch import
clidocumentationeffort/smallfeature-requestgood first issueos/windowsp2package/tools

Description

Describe the issue

About incorrect and confused error meesage in aws-cdk

I think, spawnSync docker ENOENT is very confused message to some developer.

When I use aws synth, aws destory and aws deploy, I encounter that error. IT feels HEY! Your docker or docker image have some error! to developer, using AWS CDK LIB(node.js).

And when search about this error, I can't find any solution to me, except DOCKER in aws/aws-cdk repo.

  • #8707
  • #9348

But, actually this error is occured by esbuild is not installed in local computer.

After install esbuild in project, I should fix this error. So, I think aws-cdk changes this error message for all node.js developer, please.

Links

MY clone project and issue.

Contributor guide

Tech stack
typescriptnodejsaws
Domain
clideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
AWS CDKNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
First, locate where the 'spawnSync docker ENOENT' error is thrown in the AWS CDK codebase (likely in the synth or deploy commands). Review linked issues #8707 and #9348 for context. Then, determine if a check for esbuild can be added before the Docker error to provide a clearer message, or modify the existing error to indicate possible missing esbuild. Ensure the change aligns with the existing error handling patterns.