feat: allow `runInBand` to be configured at project level #10912

freshollie · 2020-12-03T23:41:38Z

Summary

Lots of feedback from people looking for this feature in #10936

Currently running tests in band has to be configured on a global level through --runInBand arg.

This doesn't take into account some projects (particularly monorepos) which may need to be granular in this setting at a project level, some packages may be able to run tests in parallel, while others, integration tests for example, may require that all tests are run serially.

Because jest already has the mechanism to run tests across multiple projects, it makes sense that this setting is available to be switched on at a per project level, where the overall test strategy will be in parallel, but tests in an individual project will run in serial.

Example

module.exports = {
  "projects": [
    {
      "displayName": "integration",
      "testEnvironment": "node",
      "runInBand": true,
      "testMatch": [ "**/__integration__/**/*.[jt]s?(x)", "**/?(*.)+(integration).[jt]s?(x)" ]
    },
    {
      "displayName": "e2e",
      "testEnvironment": "node",
      "runInBand": true,
      "testMatch": [ "**/__e2e__/**/*.[jt]s?(x)", "**/?(*.)+(e2e).[jt]s?(x)" ]
    },
    {
      "displayName": "unit",
      "testEnvironment": "node"
    }
  ]
}

Test plan

Add unit tests
Fix failing tests
Update snapshots
Create e2e test

facebook-github-bot · 2020-12-03T23:41:48Z

Hi @freshollie!

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 [email protected]. Thanks!

facebook-github-bot · 2020-12-03T23:52:07Z

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

facebook-github-bot · 2020-12-04T00:25:25Z

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

facebook-github-bot · 2020-12-04T09:18:20Z

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

freshollie · 2020-12-04T18:13:42Z

~~@SimenB Looking for feedback before continuing fixing/writing tests. POC works, but is this something you would consider in the main codebase?~~

Splitting this into a runner is possible, but requires mostly duplicating logic already found in jest-runner, and without this change there is no way to use the project config to determine how each individual project should be executed.

codecov-commenter · 2021-07-04T14:43:22Z

Codecov Report

Merging #10912 (eb49789) into main (b89a1bb) will increase coverage by 0.00%.
The diff coverage is 64.00%.

@@           Coverage Diff           @@
##             main   #10912   +/-   ##
=======================================
  Coverage   66.97%   66.98%           
=======================================
  Files         329      329           
  Lines       17341    17355   +14     
  Branches     5066     5070    +4     
=======================================
+ Hits        11615    11625   +10     
- Misses       5694     5698    +4     
  Partials       32       32

Impacted Files	Coverage Δ
packages/jest-config/src/Defaults.ts	`100.00% <ø> (ø)`
packages/jest-config/src/ValidConfig.ts	`100.00% <ø> (ø)`
packages/jest-config/src/index.ts	`20.73% <ø> (ø)`
packages/test-utils/src/config.ts	`0.00% <ø> (ø)`
packages/jest-runner/src/index.ts	`63.44% <52.63%> (-0.85%)`	⬇️
packages/jest-config/src/normalize.ts	`88.92% <100.00%> (+0.02%)`	⬆️
packages/jest-core/src/testSchedulerHelper.ts	`100.00% <100.00%> (ø)`

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 b89a1bb...eb49789. Read the comment docs.

freshollie · 2021-10-17T11:34:24Z

docs/Configuration.md

+### `runInBand` [boolean]
+
+Default: `false`
+
+This option allows the test runner to know how it runs your tests at a project level.
+
+Sometimes it's desirable for a specific package within your repository to run tests in band, such as integration tests, and for other packages in the same repository to run tests in parallel.
+
+When configured in the root jest configuration, all tests will be run in band.
+


I've tried to describe the usage here, but looking for feedback

freshollie · 2021-10-17T11:39:36Z

e2e/__tests__/selectiveRunInBand.test.ts

@@ -0,0 +1,76 @@
+/**


These tests could be moved to multi-project e2es, found it simpler to keep them separate

freshollie · 2021-10-17T11:40:17Z

e2e/selective-run-in-band/package.json

+  "description": "Testing the behaviour of runInBand at project level",
+  "jest": {
+    "projects": ["./*/jest.config.js"],
+    "maxWorkers": 9


Ensure that under normal circumstances, all tests would be run at the same time

revmischa · 2021-10-26T13:53:54Z

This would be extremely useful for me, having integration tests in a monorepo. My life will get better when this is merged.

freshollie · 2022-02-09T12:13:54Z

@SimenB @thymikee any chance I could get some eyes on this please :)

It's got a large amount of traction but no feedback. PR has e2es and Unit tests.

Would be good to know if I should continue to maintain this change.

revmischa · 2022-03-11T10:51:53Z

@SimenB @thymikee can we possibly get this merged? I really need this feature.

freshollie · 2022-03-17T10:54:35Z

@revmischa I'm considering re-opening this PR it seems to have been buried...

github-actions · 2023-03-17T11:02:52Z

This PR is stale because it has been open 1 year with no activity. Remove stale label or comment or this will be closed in 30 days.

revmischa · 2023-03-17T15:58:59Z

It's fine, switching to vitest greatly improved my life

freshollie · 2023-03-22T14:02:40Z

@revmischa same lol

tsa96 · 2023-04-17T08:04:52Z

Still something that'd be useful to me, how has it gone ignored for so long? Bumping to keep alive, don't know why fully fleshed out PR is being closed by a bot after having absolutely no feedback from a maintainer. @SimenB @thymikee

github-actions · 2024-04-16T08:04:55Z

This PR is stale because it has been open 1 year with no activity. Remove stale label or comment or this will be closed in 30 days.

freshollie · 2024-04-25T09:59:58Z

Sorry all, got no feedback on this and I'm no longer interested in using Jest. We've found vitest fits all our use cases.

github-actions · 2024-05-26T00:09:34Z

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.

freshollie marked this pull request as draft December 3, 2020 23:48

facebook-github-bot added the cla signed label Dec 3, 2020

freshollie changed the title ~~feat: allow runInBand to be configured at a per project level [WIP]~~ feat: allow runInBand to be configured on a project level [WIP] Dec 4, 2020

freshollie changed the title ~~feat: allow runInBand to be configured on a project level [WIP]~~ feat: allow runInBand to be configured on a per project level [WIP] Dec 4, 2020

freshollie changed the title ~~feat: allow runInBand to be configured on a per project level [WIP]~~ feat: allow runInBand to be configured per project [WIP] Dec 4, 2020

freshollie changed the title ~~feat: allow runInBand to be configured per project [WIP]~~ feat: allow runInBand to be configured per project [RFC] Dec 13, 2020

freshollie mentioned this pull request Jun 28, 2021

Support maxWorkers or runInBand when using 'projects' #10936

Open

freshollie force-pushed the project-level-run-in-band branch from 46e7472 to cf43b72 Compare July 1, 2021 14:46

freshollie changed the title ~~feat: allow runInBand to be configured per project [RFC]~~ feat: allow runInBand to be configured at project level Oct 17, 2021

freshollie force-pushed the project-level-run-in-band branch from 8255af9 to 8accf67 Compare October 17, 2021 11:32

freshollie commented Oct 17, 2021

View reviewed changes

freshollie marked this pull request as ready for review October 17, 2021 12:02

freshollie force-pushed the project-level-run-in-band branch from 289dce7 to 867b596 Compare February 9, 2022 10:24

freshollie added 7 commits February 9, 2022 14:18

feat: allow runInBand to be configured per project

0a76b46

minor issues

4f9772f

prettier

5a65383

chore: update snapshots

09d3876

fix tests

8ea49a8

update snapshots

9e45076

fix snapshot

5c6f592

freshollie added 6 commits February 9, 2022 14:18

add e2es and new tests

8189c4b

better explanation

d241a69

updates

66e7591

more e2es

072171e

update changelog

40ce71e

fix snapshot

eb49789

freshollie force-pushed the project-level-run-in-band branch from 867b596 to eb49789 Compare February 9, 2022 14:19

github-actions bot added the Stale label Mar 17, 2023

github-actions bot removed the Stale label Mar 17, 2023

github-actions bot added the Stale label Apr 16, 2024

freshollie closed this Apr 25, 2024

github-actions bot locked as resolved and limited conversation to collaborators May 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: allow `runInBand` to be configured at project level #10912

feat: allow `runInBand` to be configured at project level #10912

freshollie commented Dec 3, 2020 •

edited

Loading

facebook-github-bot commented Dec 3, 2020

facebook-github-bot commented Dec 3, 2020

facebook-github-bot commented Dec 4, 2020

facebook-github-bot commented Dec 4, 2020

freshollie commented Dec 4, 2020 •

edited

Loading

codecov-commenter commented Jul 4, 2021 •

edited

Loading

freshollie Oct 17, 2021

freshollie Oct 17, 2021

freshollie Oct 17, 2021

revmischa commented Oct 26, 2021 •

edited

Loading

freshollie commented Feb 9, 2022

revmischa commented Mar 11, 2022

freshollie commented Mar 17, 2022

github-actions bot commented Mar 17, 2023

revmischa commented Mar 17, 2023

freshollie commented Mar 22, 2023

tsa96 commented Apr 17, 2023

github-actions bot commented Apr 16, 2024

freshollie commented Apr 25, 2024

github-actions bot commented May 26, 2024

feat: allow runInBand to be configured at project level #10912

feat: allow runInBand to be configured at project level #10912

Conversation

freshollie commented Dec 3, 2020 • edited Loading

Summary

Test plan

facebook-github-bot commented Dec 3, 2020

facebook-github-bot commented Dec 3, 2020

facebook-github-bot commented Dec 4, 2020

facebook-github-bot commented Dec 4, 2020

freshollie commented Dec 4, 2020 • edited Loading

codecov-commenter commented Jul 4, 2021 • edited Loading

Codecov Report

freshollie Oct 17, 2021

Choose a reason for hiding this comment

freshollie Oct 17, 2021

Choose a reason for hiding this comment

freshollie Oct 17, 2021

Choose a reason for hiding this comment

revmischa commented Oct 26, 2021 • edited Loading

freshollie commented Feb 9, 2022

revmischa commented Mar 11, 2022

freshollie commented Mar 17, 2022

github-actions bot commented Mar 17, 2023

revmischa commented Mar 17, 2023

freshollie commented Mar 22, 2023

tsa96 commented Apr 17, 2023

github-actions bot commented Apr 16, 2024

freshollie commented Apr 25, 2024

github-actions bot commented May 26, 2024

feat: allow `runInBand` to be configured at project level #10912

feat: allow `runInBand` to be configured at project level #10912

freshollie commented Dec 3, 2020 •

edited

Loading

freshollie commented Dec 4, 2020 •

edited

Loading

codecov-commenter commented Jul 4, 2021 •

edited

Loading

revmischa commented Oct 26, 2021 •

edited

Loading