fix: multiple breakages due to jest version upgrade #7667
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
iliapolo
added
pr-linter/exempt-test
rix0rrr
previously approved these changes
Apr 29, 2020
iliapolo
dismissed
rix0rrr’s stale review
Many more files were added after the approval
rix0rrr
approved these changes
Apr 29, 2020
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
(This makes sure all the graceful-fs'es dedupe to the right version so there's only one copy of the cached cwd while jest executes)
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
…the hash of the asset" This reverts commit f479074.
iliapolo
changed the title
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
iliapolo
added a commit
that referenced
this pull request
Apr 29, 2020
Couple of things here: **require.cache** In version `v25.5.0`, jest introduced an [implementation](jestjs/jest#9841) of their own to the `require.cache` object. It seems that it doesn't handle caching `json` modules properly, which causes our code to fail because `mod.paths` is `undefined` when we are querying for `json` files that were required (for example `package.json` or `cloud-assembly.schema.json`). https://github.com/aws/aws-cdk/blob/07fe642e38118e24837b492fa182737fc41bb429/packages/%40aws-cdk/core/lib/private/runtime-info.ts#L66 ```console TypeError: Cannot read property 'map' of undefined ``` The "fix" was to add a null check to prevent failure when looking up modules who don't have the `paths` property defined. Note that this was only observed in test environments using `jest > v25.5.0`, not during actual runtime of `cdk synth`. This is because `jest` manipulates the built-in `require` module of `nodejs`. **graceful-fs** In version `v25.5.0`, jest [added](jestjs/jest#9443) a dependency on the `graceful-fs` package. The version they depend on (`4.2.4`) differs from the version that we bring (`4.2.3`). This caused the `graceful-fs` dependency that comes from `jest` no to be deduped by node at installation. In turn, this caused multiple copies of the library to be installed on disk. The `graceful-fs` package monkey patches the `process.chdir` and `process.cwd` functions with a cached version for better performance. For reasons not completely clear to us, the existence of multiple copies of the module, caused `process.cwd()` to return incorrect cached results, essentially always returning the directory that the process was started from, without consideration to calls to `process.chdir`. This broke `decdk` (and possibly many more) tests which rely on `process.chdir`. Fixes #7657
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.
Not ideal, but seems like the most pragmatic thing to do.
The PR also comes with an upgrade to jest so that we won't still use
25.4.0which doesn't have these problems.This essentially replaces this Dependabot PR for jest, which is naturally broken due to the issues described here.
Commit Message
fix: multiple breakages due to jest version upgrade (#7667)
Couple of things here:
require.cache
In version
v25.5.0, jest introduced an implementation of their own to therequire.cacheobject. It seems that it doesn't handle cachingjsonmodules properly, which causes our code to fail becausemod.pathsisundefinedwhen we are querying forjsonfiles that were required (for examplepackage.jsonorcloud-assembly.schema.json).aws-cdk/packages/@aws-cdk/core/lib/private/runtime-info.ts
Line 66 in 07fe642
TypeError: Cannot read property 'map' of undefinedThe "fix" was to add a null check to prevent failure when looking up modules who don't have the
pathsproperty defined.Note that this was only observed in test environments using
jest > v25.5.0, not during actual runtime ofcdk synth. This is becausejestmanipulates the built-inrequiremodule ofnodejs.graceful-fs
In version
v25.5.0, jest added a dependency on thegraceful-fspackage. The version they depend on (4.2.4) differs from the version that we bring (4.2.3). This caused thegraceful-fsdependency that comes fromjestno to be deduped by node at installation. In turn, this caused multiple copies of the library to be installed on disk.The
graceful-fspackage monkey patches theprocess.chdirandprocess.cwdfunctions with a cached version for better performance.For reasons not completely clear to us, the existence of multiple copies of the module, caused
process.cwd()to return incorrect cached results, essentially always returning the directory that the process was started from, without consideration to calls toprocess.chdir. This brokedecdk(and possibly many more) tests which rely onprocess.chdir.Fixes #7657
End Commit Message
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license