fix(jest-resolve-dependencies): resolve mocks as dependencies #8952

petevdp · 2019-09-12T23:25:37Z

Summary

Fixes issue #8907
dependencyResolver.resolve does not take the mocks of functional dependencies into account, meaning that, as layed out in the above issue, changes to a mock will not register as an affecting change when resolving related tests.

My changes include the mocks of any dependencies found by the resolver, based on having the same name as a given dependency.

Test plan

Here's the output of running the dependency resolver tests after my changes:

 PASS  packages/jest-resolve-dependencies/src/__tests__/dependency_resolver.test.ts
  ✓ resolves no dependencies for non-existent path (225ms)
  ✓ resolves dependencies for existing path (13ms)
  ✓ includes the mocks of dependencies as dependencies (8ms)
  ✓ resolves dependencies for scoped packages (9ms)
  ✓ resolves no inverse dependencies for empty paths set (8ms)
  ✓ resolves no inverse dependencies for set of non-existent paths (12ms)
  ✓ resolves inverse dependencies for existing path (10ms)
  ✓ resolves inverse dependencies from available snapshot (10ms)

Test Suites: 1 passed, 1 total
Tests:       8 passed, 8 total
Snapshots:   0 total
Time:        0.753s, estimated 2s
Ran all test suites matching /\/home\/pete\/Code\/contributions\/jest\/jest\/packages\/jest-resolve-dependencies\/src\/__tests__\/dependency_resolver.test.ts/i

I also tested this change against the example repo from the issue referenced above, and it appears to fix the problem.

This is my first contribution, so apologies for any missteps!

codecov-io · 2019-09-13T00:13:09Z

Codecov Report

Merging #8952 into master will increase coverage by 0.02%.
The diff coverage is 61.53%.

@@            Coverage Diff             @@
##           master    #8952      +/-   ##
==========================================
+ Coverage   64.25%   64.27%   +0.02%     
==========================================
  Files         276      276              
  Lines       11706    11716      +10     
  Branches     2865     2868       +3     
==========================================
+ Hits         7522     7531       +9     
- Misses       3552     3554       +2     
+ Partials      632      631       -1

Impacted Files	Coverage Δ
packages/jest-resolve-dependencies/src/index.ts	`89.83% <61.53%> (+0.03%)`	⬆️

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 aa10c19...8137d38. Read the comment docs.

jeysal

Awesome work @petevdp!

packages/jest-resolve-dependencies/src/__tests__/dependency_resolver.test.ts

jeysal · 2019-09-13T05:54:43Z

packages/jest-resolve-dependencies/src/index.ts

      try {
        resolvedDependency = this._resolver.resolveModule(
          file,
          dependency,
          options,
        );
      } catch (e) {
-        resolvedDependency = this._resolver.getMockModule(file, dependency);
+        resolvedMockDependency = this._resolver.getMockModule(file, dependency);


I'm wondering if we still need two code paths to resolve a mock. I'm unsure what this line is even for, maybe virtual mocks that do not have a real module counterpart?

I'm not entirely sure but I assumed so, as the case where an error is thrown there expects the name to exist in (i think) the metadata but not be in the filesystem.

I left a note for prosterity in this commit: 8137d38

I could try to get to the bottom of this in this PR since it's pretty related, would that be a good idea?

If you do, is there a way I could figure out if this code is exercised in the test suite?

SimenB

Such a nice, clean solution! Thanks

CHANGELOG.md

packages/jest-resolve-dependencies/src/__tests__/dependency_resolver.test.ts

thymikee

LGTM

Co-Authored-By: Simen Bekkhus <sbekkhus91@gmail.com>

petevdp · 2019-09-13T14:49:59Z

Thanks guys!

…tory

jeysal · 2019-09-15T11:23:43Z

packages/jest-resolve-dependencies/src/index.ts

+      // If we resolve a dependency, then look for a mock dependency
+      // of the same name in that dependency's directory.
+      resolvedMockDependency = this._resolver.getMockModule(
+        path.dirname(resolvedDependency),


Is there a reason why it's not file, dependency like above? Would be nice if we could just try to resolve, ignoring failure, and then look for a mock in a single call regardless of whether the resolution failed, to simplify the logic here

getMockModule(file, dependency) actually does not work as expected.

Taking another look at it though, what does work with the tests that I added is this:

resolvedMockDependency = this._resolver.getMockModule( dependency path.basename(dependency), );

Which is definitely better than what I had before.

Unfortunately, this will fail for the case where the dependency is in a different directory from the dependent, and there's still the existing issue of mocks of the same name from different directories.

If this isn't good enough, I'm thinking we'll have to introduce a new method into jest-resolve which mirrors the functionality resolveModule, or expand the functionality of resolveModule, or change what information is collected about mocks to handle these cases. This would also serve to avoid some of the hackyness of the rest of my solution.

I do feel as though I'm slightly out of my depth here since it seems like some fairly important changes need to happen to pick up those cases, so if anyone has any guidance that would be appreciated.

I don't understand, sorry. I would expect that getMockModule does no more than look for a __mocks__/file.js next to the file.js. Why does it matter where the dependent is, it's not being passed to getMockModule?

SimenB · 2020-02-13T22:12:29Z

@petevdp thoughts on @jeysal's comment above? This also needs a rebase as it conflicts with #9303, sorry about that 😬

petevdp · 2020-02-17T00:48:23Z

@SimenB No worries, I've been sitting on this PR for a while so it makes sense. Sorry about that, and thanks for reminding me haha. I'll give this another look to see if I can get this resolved.

SimenB · 2020-03-29T19:36:36Z

ping 🙂

jeysal

Would be cool to get this clean contribution over the line - not sure I understand the unresolved comment, maybe a failing test case would help visualize it?

jeysal · 2020-05-25T17:58:39Z

packages/jest-resolve-dependencies/src/index.ts

+      );
+
+      if (resolvedMockDependency) {
+        const dependencyMockDir = path.join(


Should probably also resolve this like the one it's being compared with, in case of symlinks or something

jeysal · 2020-05-25T18:11:30Z

packages/jest-resolve-dependencies/src/index.ts

+      // If we resolve a dependency, then look for a mock dependency
+      // of the same name in that dependency's directory.
+      resolvedMockDependency = this._resolver.getMockModule(
+        path.dirname(resolvedDependency),


I don't understand, sorry. I would expect that getMockModule does no more than look for a __mocks__/file.js next to the file.js. Why does it matter where the dependent is, it's not being passed to getMockModule?

brapifra · 2020-08-17T09:29:35Z

Merging this would make me sooooo happy... 😄
Let me know if you guys need a hand!

SimenB · 2020-08-18T06:28:46Z

I'm not 100% sure about the state of this. @jeysal @petevdp?

jeysal · 2020-08-21T20:16:10Z

Seems there's still some unresolved questions. If someone else wants to create a PR based on this and take over further development that'd be great, we're definitely accepting a fix for this.

petevdp · 2020-08-21T23:23:10Z

Yeah, if someone else could open up a pr for this that would be great. Apologies for any wasted effort.

…

On Fri, Aug 21, 2020 at 1:16 PM Tim Seckinger ***@***.***> wrote: Seems there's still some unresolved questions. If someone else wants to create a PR based on this and take over further development that'd be great, we're definitely accepting a fix for this. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#8952 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACDAAU4MSCFSE3JANR37QQLSB3IZPANCNFSM4IWKSWNQ> .

SimenB · 2020-10-19T10:42:50Z

@petevdp no wasted effort at all, I think this is great work and pretty close to landing 🙂

brapifra · 2020-10-22T12:38:47Z

Great! I'll look into this soon @SimenB

SimenB · 2020-10-27T09:09:22Z

Landed in #10713, thanks!

github-actions · 2021-05-11T02:25:54Z

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.

petevdp added 2 commits September 12, 2019 15:49

add test for including the mocks of dependencies when resolving

6da2875

include mocks when resolving dependencies

5cce42e

facebook-github-bot added the cla signed label Sep 12, 2019

petevdp added 2 commits September 12, 2019 16:27

add changelog entry

014d4de

put changelog entry in correct category

4cebe1b

jeysal reviewed Sep 13, 2019

View reviewed changes

jeysal requested review from SimenB, thymikee and scotthovestadt September 13, 2019 05:55

SimenB approved these changes Sep 13, 2019

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

packages/jest-resolve-dependencies/src/__tests__/dependency_resolver.test.ts Outdated Show resolved Hide resolved

thymikee approved these changes Sep 13, 2019

View reviewed changes

petevdp and others added 2 commits September 13, 2019 07:32

Use explicit path delimiters when resolving path to fixture file.

d7e327c

Co-Authored-By: Simen Bekkhus <sbekkhus91@gmail.com>

sort changelog entries alphabetically

39cb1ad

petevdp added 2 commits September 13, 2019 09:04

add test for resolving inverse dependencies of mock (#8952)

651b27c

when resolving mocks of dependencies, ensure mock is in correct direc…

8137d38

…tory

jeysal reviewed Sep 15, 2019

View reviewed changes

jeysal reviewed May 25, 2020

View reviewed changes

SimenB added the Help Wanted label Oct 19, 2020

brapifra mentioned this pull request Oct 26, 2020

fix(jest-resolve-dependencies): resolve mocks as dependencies #10713

Merged

SimenB closed this Oct 27, 2020

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

fix(jest-resolve-dependencies): resolve mocks as dependencies #8952

fix(jest-resolve-dependencies): resolve mocks as dependencies #8952

petevdp commented Sep 12, 2019

codecov-io commented Sep 13, 2019 •

edited

jeysal left a comment

jeysal Sep 13, 2019

petevdp Sep 13, 2019 •

edited

SimenB left a comment

thymikee left a comment

petevdp commented Sep 13, 2019

jeysal Sep 15, 2019

petevdp Feb 21, 2020 •

edited

jeysal May 25, 2020

SimenB commented Feb 13, 2020 •

edited

petevdp commented Feb 17, 2020

SimenB commented Mar 29, 2020

jeysal left a comment

jeysal May 25, 2020

jeysal May 25, 2020

brapifra commented Aug 17, 2020

SimenB commented Aug 18, 2020

jeysal commented Aug 21, 2020

petevdp commented Aug 21, 2020 via email

SimenB commented Oct 19, 2020

brapifra commented Oct 22, 2020

SimenB commented Oct 27, 2020

github-actions bot commented May 11, 2021

fix(jest-resolve-dependencies): resolve mocks as dependencies #8952

fix(jest-resolve-dependencies): resolve mocks as dependencies #8952

Conversation

petevdp commented Sep 12, 2019

Summary

Test plan

codecov-io commented Sep 13, 2019 • edited

Codecov Report

jeysal left a comment

Choose a reason for hiding this comment

jeysal Sep 13, 2019

Choose a reason for hiding this comment

petevdp Sep 13, 2019 • edited

Choose a reason for hiding this comment

SimenB left a comment

Choose a reason for hiding this comment

thymikee left a comment

Choose a reason for hiding this comment

petevdp commented Sep 13, 2019

jeysal Sep 15, 2019

Choose a reason for hiding this comment

petevdp Feb 21, 2020 • edited

Choose a reason for hiding this comment

jeysal May 25, 2020

Choose a reason for hiding this comment

SimenB commented Feb 13, 2020 • edited

petevdp commented Feb 17, 2020

SimenB commented Mar 29, 2020

jeysal left a comment

Choose a reason for hiding this comment

jeysal May 25, 2020

Choose a reason for hiding this comment

jeysal May 25, 2020

Choose a reason for hiding this comment

brapifra commented Aug 17, 2020

SimenB commented Aug 18, 2020

jeysal commented Aug 21, 2020

petevdp commented Aug 21, 2020 via email

SimenB commented Oct 19, 2020

brapifra commented Oct 22, 2020

SimenB commented Oct 27, 2020

github-actions bot commented May 11, 2021

codecov-io commented Sep 13, 2019 •

edited

petevdp Sep 13, 2019 •

edited

petevdp Feb 21, 2020 •

edited

SimenB commented Feb 13, 2020 •

edited