chore(aws-cdk-lib): prevent deep imports #17707
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sometimes, IDEs like VSCode will autocomplete deep imports into the CDK
library. For example, they may generate the following:
```ts
import { Bucket } from 'aws-cdk-lib/aws-s3/lib/bucket';
```
Whereas the correct import should have been:
```ts
import { Bucket } from 'aws-cdk-lib/aws-s3';
```
If we allow people to write the former, they will be broken every time
we change the internal file layout of our module (or conversely, we
will not be allowed to change the file layout at all).
Use the `package.json` `"exports"` mechanism to advertise the select
paths that users are allowed to import from, and disallow the rest.
|
|
nija-at
reviewed
Nov 25, 2021
There was a problem hiding this comment.
Why can I not find this documented here? https://docs.npmjs.com/cli/v8/configuring-npm/package-json
|
Because it's a Node.js feature: https://nodejs.org/api/packages.html#subpath-exports |
eladb
reviewed
Nov 25, 2021
| @@ -361,5 +362,217 @@ | |||
| "ubergen": { | |||
| "exclude": true, | |||
| "excludeExperimentalModules": true | |||
| }, | |||
| "exports": { | |||
nija-at
approved these changes
Nov 25, 2021
…k into huijbers/prevent-deep-imports
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
beezly
pushed a commit
to beezly/aws-cdk
that referenced
this pull request
Nov 29, 2021
Sometimes, IDEs like VSCode will autocomplete deep imports into the CDK
library. For example, they may generate the following:
```ts
import { Bucket } from 'aws-cdk-lib/aws-s3/lib/bucket';
```
Whereas the correct import should have been:
```ts
import { Bucket } from 'aws-cdk-lib/aws-s3';
```
If we allow people to write the former, they will be broken every time
we change the internal file layout of our module (or conversely, we
will not be allowed to change the file layout at all).
Use the `package.json` `"exports"` mechanism to advertise the select
paths that users are allowed to import from, and disallow the rest.
----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
pedrosola
pushed a commit
to pedrosola/aws-cdk
that referenced
this pull request
Dec 1, 2021
Sometimes, IDEs like VSCode will autocomplete deep imports into the CDK
library. For example, they may generate the following:
```ts
import { Bucket } from 'aws-cdk-lib/aws-s3/lib/bucket';
```
Whereas the correct import should have been:
```ts
import { Bucket } from 'aws-cdk-lib/aws-s3';
```
If we allow people to write the former, they will be broken every time
we change the internal file layout of our module (or conversely, we
will not be allowed to change the file layout at all).
Use the `package.json` `"exports"` mechanism to advertise the select
paths that users are allowed to import from, and disallow the rest.
----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
eladb
pushed a commit
that referenced
this pull request
Dec 1, 2021
#17707 added an `exports` section to the `package.json` files of `aws-cdk-lib` and `monocdk` in order to prevent users from accidentally "deep importing" modules. This broke a large number of `monocdk` users. Since these teams are going to migrate to v2 (`aws-cdk-lib`) soon anyway, we decided to revert this change for `monocdk` so they are unblocked in the meantime. To do this, we introduced two new configuration options for `ubergen`: `libRoot`, which can be used to control where submodules are going to be collected (defaults to the root of the uber package) and `explicitExports` which controls whether the `exports` section is added or not (defaults to true).
mergify bot
pushed a commit
that referenced
this pull request
Dec 1, 2021
#17707 added an `exports` section to the `package.json` files of `aws-cdk-lib` and `monocdk` in order to prevent users from accidentally "deep importing" modules. This broke a large number of `monocdk` users. Since these teams are going to migrate to v2 (`aws-cdk-lib`) soon anyway, we decided to revert this change for `monocdk` so they are unblocked in the meantime. To do this, we introduced two new configuration options for `ubergen`: `libRoot`, which can be used to control where submodules are going to be collected (defaults to the root of the uber package) and `explicitExports` which controls whether the `exports` section is added or not (defaults to true). ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
This was referenced Dec 21, 2021
This was referenced Dec 29, 2021
TikiTDO
pushed a commit
to TikiTDO/aws-cdk
that referenced
this pull request
Feb 21, 2022
Sometimes, IDEs like VSCode will autocomplete deep imports into the CDK
library. For example, they may generate the following:
```ts
import { Bucket } from 'aws-cdk-lib/aws-s3/lib/bucket';
```
Whereas the correct import should have been:
```ts
import { Bucket } from 'aws-cdk-lib/aws-s3';
```
If we allow people to write the former, they will be broken every time
we change the internal file layout of our module (or conversely, we
will not be allowed to change the file layout at all).
Use the `package.json` `"exports"` mechanism to advertise the select
paths that users are allowed to import from, and disallow the rest.
----
*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
TikiTDO
pushed a commit
to TikiTDO/aws-cdk
that referenced
this pull request
Feb 21, 2022
aws#17707 added an `exports` section to the `package.json` files of `aws-cdk-lib` and `monocdk` in order to prevent users from accidentally "deep importing" modules. This broke a large number of `monocdk` users. Since these teams are going to migrate to v2 (`aws-cdk-lib`) soon anyway, we decided to revert this change for `monocdk` so they are unblocked in the meantime. To do this, we introduced two new configuration options for `ubergen`: `libRoot`, which can be used to control where submodules are going to be collected (defaults to the root of the uber package) and `explicitExports` which controls whether the `exports` section is added or not (defaults to true). ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sometimes, IDEs like VSCode will autocomplete deep imports into the CDK
library. For example, they may generate the following:
Whereas the correct import should have been:
If we allow people to write the former, they will be broken every time
we change the internal file layout of our module (or conversely, we
will not be allowed to change the file layout at all).
Use the
package.json"exports"mechanism to advertise the selectpaths that users are allowed to import from, and disallow the rest.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license