Support array of paths for `moduleNameMapper` aliases #9465

OrkhanAlikhanov · 2020-01-24T20:19:41Z

Summary

Test plan

I've added test cases let me know if I should add more.

I have not updated CHANGELOG.md eventhough PR template suggests it, not sure if I should do it or it's autodone

facebook-github-bot · 2020-01-24T20:19:53Z

Hi OrkhanAlikhanov! Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file.In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

OrkhanAlikhanov · 2020-01-24T20:23:18Z

@facebook-github-bot I signed

codecov-io · 2020-01-24T20:35:16Z

Codecov Report

Merging #9465 into master will decrease coverage by <.01%.
The diff coverage is 57.14%.

@@            Coverage Diff             @@
##           master    #9465      +/-   ##
==========================================
- Coverage      65%   64.99%   -0.01%     
==========================================
  Files         283      283              
  Lines       12131    12142      +11     
  Branches     3002     3006       +4     
==========================================
+ Hits         7886     7892       +6     
- Misses       3604     3607       +3     
- Partials      641      643       +2

Impacted Files	Coverage Δ
packages/jest-config/src/Descriptions.ts	`100% <ø> (ø)`	⬆️
packages/jest-resolve/src/index.ts	`45.94% <57.14%> (+0.69%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ffdaa75...5815c08. Read the comment docs.

facebook-github-bot · 2020-01-24T20:39:20Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

OrkhanAlikhanov · 2020-01-24T20:41:09Z

Coverage report shows that packages/jest-resolve/src/index.ts some parts are not covered. e2e tests should cover them actually 🤔. I have no idea how I should cover them in packages/jest-resolve/tests

SimenB · 2020-01-24T21:31:46Z

I have not updated CHANGELOG.md eventhough PR template suggests it, not sure if I should do it or it's autodone

It's manual, please update it 🙂

jeysal

Really solid work, awesome @OrkhanAlikhanov!
Always nice to see that even the low level parts of Jest can be flexible and approachable.

Coverage report shows that packages/jest-resolve/src/index.ts some parts are not covered. e2e tests should cover them actually

coverage does not track e2e tests because of the child processes (that's why our overall coverage metric looks so bad), but don't worry it's not a problem :)

jeysal · 2020-01-25T23:31:37Z

CHANGELOG.md

@@ -2,6 +2,8 @@

 ### Features

+- `[jest-resolve]` Support array of paths for `moduleNameMapper` aliases ([#9465](https://github.com/facebook/jest/pull/9465))


I'd give this a [*] scope perhaps, since it's also e.g. config

jeysal · 2020-01-25T23:35:08Z

packages/jest-cli/src/cli/args.ts

@@ -377,8 +377,8 @@ export const options = {
  moduleNameMapper: {
    description:
      'A JSON string with a map from regular expressions to ' +
-      'module names that allow to stub out resources, like images or ' +
-      'styles with a single module',
+      'module names or an array of module names that allow to stub ' +


Suggested change

'module names or an array of module names that allow to stub ' +

'module names or to arrays of module names that allow to stub ' +

(as in 'map from regular expressions to [...] arrays of module names')

(also in other file)

packages/jest-resolve/src/index.ts

OrkhanAlikhanov · 2020-01-26T17:32:32Z

@jeysal Hey! Thank you for the in depth review! (also for appreciating my work 🙃) I added 2 more commits also rebased + force pushed.

OrkhanAlikhanov · 2020-01-26T17:50:49Z

I force pushed again because I missed bracket misalignment due to my vscode differ having Ignore Trim Whitespace option turned on.

Even if we add prettyFormat, it is only going to replace JSON.stringify as misalignment issue is due to the string being nested in below code as a part of json-like string to create neat json structured error message

OrkhanAlikhanov · 2020-01-29T17:35:04Z

Friendly ping

SimenB

Could you update the documentation as well?

packages/jest-cli/src/cli/args.ts

SimenB · 2020-01-29T18:27:20Z

packages/jest-resolve/src/index.ts

+                )
+            : (moduleName: string) => moduleName;
+
+          const possibleModuleNames = Array.isArray(mappedModuleName)


Can we make it into an array in normalize?

Thinking about it, that might be a breaking change... Hmm

When an error happens we need to properly format error message based on whether it was set as an array or string in configuration. If we normalize it, we will probably lose that information and not be able to properly format error message

Wouldn't be too bad to show [path] even though the user configured path I guess, but probably not worth it also given the breaking change risk. I'd be happy as is - however one thing I do want to verify when I have some time is whether the extra work of Array.isArray, wrapping [mappedModuleName] etc. has a perf impact. I doubt it's significant, but jest-resolve is quite a hot path so better safe than sorry

could normalize to an array in the constructor

@SimenB Not sure I understood that. Is there anything for me to do apart from updating docs?

@jeysal Aren't resolved module paths cached?

this._possibleModuleNames = Array.isArray(mappedModuleName) ? mappedModuleName : [mappedModuleName];

in the constructor of this class

@SimenB The problem is we need both the original config entry for the error message and the array one to iterate over here. As long as we don't want to compromise on the correctness of the error message I think this is as good as it gets 😅

@jeysal Aren't resolved module paths cached?

Even with caching often running a single test will need to resolve a large dependency tree, just want to be on the safe side as far as perf goes 😄

the error message can be passed the original config, but in the happy case it won't have to check if array or not

jeysal

I'd be happy with this as is, but would like to do some simple benchmarking before merge

jeysal · 2020-01-30T00:34:01Z

packages/jest-resolve/src/index.ts

+                )
+            : (moduleName: string) => moduleName;
+
+          const possibleModuleNames = Array.isArray(mappedModuleName)


Wouldn't be too bad to show [path] even though the user configured path I guess, but probably not worth it also given the breaking change risk. I'd be happy as is - however one thing I do want to verify when I have some time is whether the extra work of Array.isArray, wrapping [mappedModuleName] etc. has a perf impact. I doubt it's significant, but jest-resolve is quite a hot path so better safe than sorry

jeysal

Can't find a performance impact - no more open points from my side :)
Thanks a lot @OrkhanAlikhanov!

SimenB · 2020-02-02T00:59:22Z

Just missing documentation update and I'm happy as well 👍

OrkhanAlikhanov · 2020-02-02T14:09:29Z

I updated docs + rebased and force pushed :)

OrkhanAlikhanov · 2020-02-02T18:33:23Z

Thank you guys! It was pleasure collaborating with you on this feature! 🚀

jeysal · 2020-02-02T18:36:00Z

We must thank you! ♥️ This is solid work, don't hesitate to contribute more if you want :)

MrBlenny · 2020-03-21T02:20:37Z

I'm keen to use this feature but it looks like it isnt part of 25.1.0. Would be great to see a release.

github-actions · 2021-05-11T10:06:39Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.

facebook-github-bot added the cla signed label Jan 24, 2020

OrkhanAlikhanov requested a review from SimenB January 25, 2020 07:59

jeysal reviewed Jan 25, 2020

View reviewed changes

SimenB requested changes Jan 29, 2020

View reviewed changes

jeysal reviewed Jan 30, 2020

View reviewed changes

jeysal approved these changes Feb 1, 2020

View reviewed changes

OrkhanAlikhanov and others added 6 commits February 2, 2020 18:00

Support array in moduleNameMapper aliases

60f69e7

Update moduleNameMapper tests types & description

d4fd74f

Add moduleNameMapper array test cases

0a625c3

Update CHANGELOG.md

37ee6d7

chore: update moduleNameMapper description

a51a4bf

Simplify createNoMappedModuleFoundError function

b21ebe3

Update moduleNameMapper docs

f85ab41

SimenB approved these changes Feb 2, 2020

View reviewed changes

SimenB merged commit c9127bf into jestjs:master Feb 2, 2020

snyk-bot mentioned this pull request Apr 16, 2020

[Snyk] Upgrade jest from 25.1.0 to 25.2.0 FabianBravoA/tbk_signer#4

Open

This was referenced Apr 25, 2020

[Snyk] Upgrade jest from 25.2.0 to 25.2.6 mkai/express-absolute-url#6

Merged

[Snyk] Upgrade: jest, jest-cli lwojcik/sc2pte-panel-frontend#118

Closed

snyk-bot mentioned this pull request May 4, 2020

[Snyk] Upgrade: jest, jest-cli lwojcik/sc2pte-panel-frontend#123

Closed

OrkhanAlikhanov mentioned this pull request May 26, 2020

moduleNameMapper doesn't handle multiple paths kulshekhar/ts-jest#1072

Closed

github-actions bot locked as resolved and limited conversation to collaborators May 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support array of paths for `moduleNameMapper` aliases #9465

Support array of paths for `moduleNameMapper` aliases #9465

OrkhanAlikhanov commented Jan 24, 2020 •

edited by SimenB

facebook-github-bot commented Jan 24, 2020

OrkhanAlikhanov commented Jan 24, 2020

codecov-io commented Jan 24, 2020 •

edited

facebook-github-bot commented Jan 24, 2020

OrkhanAlikhanov commented Jan 24, 2020

SimenB commented Jan 24, 2020

jeysal left a comment

jeysal Jan 25, 2020

jeysal Jan 25, 2020

jeysal Jan 25, 2020

OrkhanAlikhanov commented Jan 26, 2020

OrkhanAlikhanov commented Jan 26, 2020

OrkhanAlikhanov commented Jan 29, 2020

SimenB left a comment

SimenB Jan 29, 2020

OrkhanAlikhanov Jan 29, 2020

jeysal Jan 30, 2020

SimenB Jan 30, 2020

OrkhanAlikhanov Jan 30, 2020 •

edited

OrkhanAlikhanov Jan 30, 2020

SimenB Jan 30, 2020

jeysal Jan 30, 2020

jeysal Jan 30, 2020

SimenB Jan 30, 2020

jeysal left a comment

jeysal Jan 30, 2020

jeysal left a comment

SimenB commented Feb 2, 2020

OrkhanAlikhanov commented Feb 2, 2020

OrkhanAlikhanov commented Feb 2, 2020

jeysal commented Feb 2, 2020

MrBlenny commented Mar 21, 2020

github-actions bot commented May 11, 2021

		@@ -2,6 +2,8 @@

		### Features

		- `[jest-resolve]` Support array of paths for `moduleNameMapper` aliases ([#9465](https://github.com/facebook/jest/pull/9465))

	'module names or an array of module names that allow to stub ' +
	'module names or to arrays of module names that allow to stub ' +

Support array of paths for moduleNameMapper aliases #9465

Support array of paths for moduleNameMapper aliases #9465

Conversation

OrkhanAlikhanov commented Jan 24, 2020 • edited by SimenB

Summary

Test plan

facebook-github-bot commented Jan 24, 2020

OrkhanAlikhanov commented Jan 24, 2020

codecov-io commented Jan 24, 2020 • edited

Codecov Report

facebook-github-bot commented Jan 24, 2020

OrkhanAlikhanov commented Jan 24, 2020

SimenB commented Jan 24, 2020

jeysal left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OrkhanAlikhanov commented Jan 26, 2020

OrkhanAlikhanov commented Jan 26, 2020

OrkhanAlikhanov commented Jan 29, 2020

SimenB left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OrkhanAlikhanov Jan 30, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeysal left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeysal left a comment

Choose a reason for hiding this comment

SimenB commented Feb 2, 2020

OrkhanAlikhanov commented Feb 2, 2020

OrkhanAlikhanov commented Feb 2, 2020

jeysal commented Feb 2, 2020

MrBlenny commented Mar 21, 2020

github-actions bot commented May 11, 2021

Support array of paths for `moduleNameMapper` aliases #9465

Support array of paths for `moduleNameMapper` aliases #9465

OrkhanAlikhanov commented Jan 24, 2020 •

edited by SimenB

codecov-io commented Jan 24, 2020 •

edited

OrkhanAlikhanov Jan 30, 2020 •

edited