I read that the --runInBand flag speeds up Jest test duration by 50% on CI servers. I can't really find an explanation online on what that flag does except that it lets tests run in the same thread and sequentially.
Why does running the test in the same thread and sequentially make it faster? Intuitively, shouldn't that make it slower?
Reading your linked page and some other related sources (like this github issue) some users have found that:
...using the --runInBand helps in an environment with limited resources.
and
... --runInBand took our tests from >1.5 hours (actually I don't know how long because Jenkins timed out at 1.5 hours) to around 4 minutes. (Note: we have really poor resources for our build server)
As we can see, those users had improvements in their performances on their machines even though they had limited resources on them. If we read what does the --runInBand flag does from the docs it says:
Alias: -i. Run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.
Therefore, taking into consideration these comments and the docs, I believe the improvement in performance is due to the fact that now the process runs in a single thread. This greatly helps a limited-resource-computer because it does not have to spend memory and time dealing and handling multiple threads in a thread pool, a task that could prove to be too expensive for its limited resources.
However, I believe this is the case only if the machine you are using also has limited resources. If you used a more "powerful" machine (i.e.: several cores, decent RAM, SSD, etc.) using multiple threads probably will be better than running a single one.
When you run tests in multi-threads, jest creates a cache for every thread. When you run with --runInBand jest uses one cache storage for all tests.
I found it after runs 20 identical tests files, first with key --runInBand, a first test takes 25 seconds and next identical tests take 2-3s each.
When I run tests without --runInBand key, each identical test file executes in 25 seconds.
--runInBand when running tests locally to speed up the test run? We are using jest --coverage --runInBand --no-cache for Continuous Integration.
--ci flag to codeepic's command. jestjs.io/docs/en/cli#ci
Follow WeChat
Success story sharing
--runInBand- It's not a state of the art computer, but I'm not sure I would call it a limited resource computer. Just doesn't make any sense to me why runInBand is faster.--runInBandmight also slow down runs, eg. if you have many test suites it might be better to use--maxWorkersor--maxParalleland set it to the number of cores/threads. In our Jenkins CI (4 cores, 8Gb) we had unit tests 50 mins with--runInBandwhich went down to 20 mins after setting it to--maxParallel=4. Without any of those settings, it just died out of memory (OOM) because it spawend to many threads (which both methods prevented).