aws/aws-cdk

core: configurable ZIP compression level

Open

#22427 opened on Oct 8, 2022

View on GitHub
 (3 comments) (1 reaction) (0 assignees)TypeScript (10,710 stars) (3,530 forks)batch import
@aws-cdk/coreeffort/smallfeature-requestgood first issuep2

Description

Describe the feature

I noticed that the ZIP files produced by CDK are quite a bit larger than those produced, for example, by the "Compress" functionality in macOS Finder for the same content.

The feature request is that the compression level of zlib used in the ZIP compression is made configurable by the user (a speed vs compression ratio trade-off). This could be beneficial, for example, to produce as small packages as possible for Lambda functions.

Use Case

ZIP files produced as CDK assets (e.g., bundled JS Lambda code/sourcemaps) are larger than they could be.

Proposed Solution

Expose the level setting of zlib, which is exposed by the archiver library which seems to be used by CDK for ZIP packages (see https://www.npmjs.com/package/archiver)

Other Information

No response

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

CDK version used

2.43.1

Environment details (OS name and version, etc.)

macOS 12.5.1

Contributor guide

Tech stack
typescriptnodejs
Domain
infrastructurecloudbuild system
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
mostly clear
Prerequisites
basic Node.jsfamiliarity with aws cdk core
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the aws cdk source code to find where ZIP files are created using the 'archiver' library. Look for the compression level setting in zlib (0-9) and how to expose it as a configuration parameter. The issue suggests modifying the archiver options to accept a 'level' property. Start by searching for 'archiver' usage in the codebase, likely in the 'core' module.