Make it possible to merge `transform` option with preset #5505

gziolo · 2018-02-09T10:07:59Z

Summary

I discovered that transform option set in Jest preset is completely overridden when the same option is provided in the Jest config that extends such preset. I run into this issue when working on the preset for WordPress core: WordPress/gutenberg#4705. It turned out that behavior differs from another option that uses object as data representations: moduleNameMapper. This PR tries to introduce consistency in the code and allow to merge values from transform option set in both config and preset.

Example

@wordpress/jest-preset-default:

{
  "transform": {
    "^.+\\.jsx?$": "babel-jest",
    "\\.pegjs$": "<rootDir>/node_modules/@wordpress/jest-preset-default/scripts/pegjs-transform.js
  } 
}

jest.config.js:

{
  "preset": "@wordpress/jest-preset-default",
  "transform": {
    "\\.pegjs$": "<rootDir>/test/unit/pegjs-transform.js"
  }
}

Expected output:

{
  "transform": {
    "^.+\\.jsx?$": "babel-jest",
    "\\.pegjs$": "<rootDir>/test/unit/pegjs-transform.js"
  }
}

Test plan

This change is limited to `jest-config. This is how it was tested:

yarn test packages/jest-config

thymikee · 2018-02-09T10:15:46Z

Can you add a test for that? Merging transforms may cause unexpected issues though, like we had with moduleNameMapper (hence this weird merging logic as you can see in a block above your code)

gziolo · 2018-02-09T10:31:31Z

Sure thing, I wanted to have PR to reference in the PR I'm working on. I have to override this option to make it work which is pretty unexpected when using preset. Well, it might be not that confusing if some options wouldn't work this way :)

I must admit that moduleNameMapper is handled in a very unexpected way. Why is there needed 1st options.moduleNameMapper occurrence? It's always replaced by the 2nd occurrence of the same object.

I think we can also provide some helper functions to make this easier to maintain:

const mergeOptionWithPreset = (options, preset, optionName) => {
  if (options[optionName] && preset[optionName]) {
    options[optionName] = Object.assign(
      {},
      preset[optionName],
      options[optionName],
    );
  }
}

It can be expressed also in a more functional way if you prefer.

thymikee · 2018-02-09T10:33:37Z

See #3689

gziolo · 2018-02-09T10:36:17Z

So it's only about the order. It makes sense then. I will follow the same pattern. It still makes sense to do some refactoring, should I include it in this PR or open another one?

thymikee · 2018-02-09T10:37:30Z

This is the same logic, so feel free to refactor it as a part of this PR, it's small enough to fit in.

gziolo · 2018-02-11T20:01:24Z

packages/jest-config/src/__tests__/normalize.test.js

@@ -964,7 +995,7 @@ describe('preset without setupFiles', () => {

  beforeAll(() => {
    jest.mock(
-      '/node_modules/react-native/jest-preset.json',
+      '/node_modules/react-foo/jest-preset.json',


It seems to be some kind of bug here. When it mocks the same file name as in the other describe block, it doesn't reload the config but uses what was previously set. I updated this name to ensure that setupFiles is configured properly, i.e. babel-jest is enabled which triggers prepend of regenerator-runtime.

We could switch to jest.doMock here to avoid this, since it's already placed before the require call and we don't need to hoist it.

Let me try it. This was my guess that jest.mock calls get hoisted and this flow doesn't work as expected.

gziolo · 2018-02-11T20:02:00Z

packages/jest-config/src/normalize.js

@@ -46,6 +46,21 @@ const PRESET_NAME = 'jest-preset' + JSON_EXTENSION;
 const createConfigError = message =>
  new ValidationError(ERROR, message, DOCUMENTATION_NOTE);

+const mergeOptionWithPreset = (
+  options: InitialOptions,


I hope it is fine. This is the first time I update code that uses Flow :)

gziolo · 2018-02-11T20:02:53Z

packages/jest-config/src/__tests__/normalize.test.js

@@ -922,7 +924,10 @@ describe('preset', () => {
    expect(options.setupFiles.sort()).toEqual([
      '/node_modules/a',
      '/node_modules/b',
-      '/node_modules/regenerator-runtime/runtime',
+    ]);


babel-jest isn't explicitly set, so it doesn't append regenerator-runtime anymore.

gziolo · 2018-02-11T20:06:54Z

@thymikee - I refactored code, added a new test and updated existing tests to better reflect the current behavior. There are some issues with cache on CircleCi, but I don't have permissions to reset them. Let me know if there is anything else to fix or add.

thymikee · 2018-02-11T21:11:26Z

packages/jest-config/src/__tests__/normalize.test.js

+    // Object initializer not used for properties as a workaround for
+    //  sort-keys eslint rule while specifying properties in
+    //  non-alphabetical order for a better test
+    const transform = {};


You can just disable the rule for this object / line

I shamelessly copied from the other test, but it makes sense what you said. I will update.

Updated 👍

thymikee

This looks good already 👍I wasn't able to rerun all the jobs without cache, just a couple (not sure why)

gziolo · 2018-02-12T07:45:39Z

I tried with 757bc3b .doMock & dontMock pair, but it didn't help much. I left them to make it more obvious that they should be used only for those specific describe blocks, thus shouldn't be hoisted.

thymikee · 2018-02-12T07:57:51Z

normalize.test.js passes on Appveyor, so that should be ok.

SimenB · 2018-02-17T11:44:00Z

@gziolo mind updating the changelog?

gziolo · 2018-02-17T12:14:16Z

Yes, I wasn’t aware of that. I will do it by Monday 👍

TBD

gziolo · 2018-02-17T18:42:24Z

@SimenB done ✅

SimenB · 2018-02-17T19:00:02Z

I can confirm the full test suite passes on my machine (a mac), so no issues from the skipped windows tests either

SimenB · 2018-02-17T23:03:46Z

packages/jest-config/src/normalize.js

+      {},
+      options[optionName],
+      preset[optionName],
+      options[optionName],


why do we have options[optionName] twice? I realise it was the same before this patch

To preserve the order of keys in the config that is overriding preset. I had the same question initially 😃 Maybe an inline comment with explanation would help?

Yeah, I think so.

github-actions · 2021-05-12T20:06:48Z

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 Feb 9, 2018

gziolo changed the title ~~Make it possible to merge transform options and preset~~ Make it possible to merge transform option and preset Feb 9, 2018

gziolo mentioned this pull request Feb 9, 2018

Tooling: Integrate dependencies from WordPress packages WordPress/gutenberg#4705

Merged

3 tasks

gziolo commented Feb 11, 2018

View reviewed changes

thymikee reviewed Feb 11, 2018

View reviewed changes

thymikee approved these changes Feb 11, 2018

View reviewed changes

gziolo added 3 commits February 17, 2018 19:36

Make it possible to merge transform options and preset

da33c1e

TBD

Tests: Refactor tests for normalize module from jest-config

ecde7d8

Changelog: Add entry for #5505 PR for jest-config

5cb28ad

gziolo changed the title ~~Make it possible to merge transform option and preset~~ Make it possible to merge transform option with preset Feb 17, 2018

lint changelog

07efa3e

SimenB approved these changes Feb 17, 2018

View reviewed changes

cpojer merged commit e89de4e into jestjs:master Feb 17, 2018

SimenB reviewed Feb 17, 2018

View reviewed changes

This was referenced Feb 20, 2018

Update jest in / from 22.3.0 to 22.4.0 opencomponents/storage-adapters#48

Closed

Update 14 dependencies from npm storybookjs/storybook#3041

Merged

gziolo deleted the patch-1 branch February 21, 2018 08:41

gziolo mentioned this pull request Feb 21, 2018

Chore: Update Jest dependencies WordPress/packages#87

Merged

This was referenced Mar 5, 2018

Update jest-environment-jsdom in / from 22.2.0 to 22.4.1 opencomponents/base-templates#271

Closed

Update jest in / from 22.2.1 to 22.4.2 opencomponents/base-templates#272

Merged

dimitropoulos mentioned this pull request May 12, 2021

Support an "extends" option within config #3564

Closed

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make it possible to merge `transform` option with preset #5505

Make it possible to merge `transform` option with preset #5505

gziolo commented Feb 9, 2018 •

edited

Loading

thymikee commented Feb 9, 2018

gziolo commented Feb 9, 2018

thymikee commented Feb 9, 2018

gziolo commented Feb 9, 2018

thymikee commented Feb 9, 2018

gziolo Feb 11, 2018

thymikee Feb 11, 2018

gziolo Feb 12, 2018

gziolo Feb 11, 2018

gziolo Feb 11, 2018

gziolo commented Feb 11, 2018

thymikee Feb 11, 2018 •

edited

Loading

gziolo Feb 12, 2018

gziolo Feb 12, 2018

thymikee left a comment

gziolo commented Feb 12, 2018

thymikee commented Feb 12, 2018

SimenB commented Feb 17, 2018

gziolo commented Feb 17, 2018

gziolo commented Feb 17, 2018

SimenB commented Feb 17, 2018

SimenB Feb 17, 2018

gziolo Feb 18, 2018

SimenB Feb 18, 2018

github-actions bot commented May 12, 2021

Make it possible to merge transform option with preset #5505

Make it possible to merge transform option with preset #5505

Conversation

gziolo commented Feb 9, 2018 • edited Loading

Summary

Example

Test plan

thymikee commented Feb 9, 2018

gziolo commented Feb 9, 2018

thymikee commented Feb 9, 2018

gziolo commented Feb 9, 2018

thymikee commented Feb 9, 2018

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

gziolo commented Feb 11, 2018

thymikee Feb 11, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thymikee left a comment

Choose a reason for hiding this comment

gziolo commented Feb 12, 2018

thymikee commented Feb 12, 2018

SimenB commented Feb 17, 2018

gziolo commented Feb 17, 2018

gziolo commented Feb 17, 2018

SimenB commented Feb 17, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented May 12, 2021

Make it possible to merge `transform` option with preset #5505

Make it possible to merge `transform` option with preset #5505

gziolo commented Feb 9, 2018 •

edited

Loading

thymikee Feb 11, 2018 •

edited

Loading