Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(babel-jest): add process.version chunk to the cache key #12122

Merged
merged 4 commits into from
Dec 5, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

### Fixes

- `[babel-jest]` Add `process.version` chunk to the cache key ([#12122](https://github.com/facebook/jest/pull/12122))

### Chore & Maintenance

### Performance
Expand Down
211 changes: 211 additions & 0 deletions packages/babel-jest/src/__tests__/getCacheKey.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

import type {TransformOptions as BabelTransformOptions} from '@babel/core';
import type {TransformOptions as JestTransformOptions} from '@jest/transform';
import babelJest from '../index';

const processVersion = process.version;
const nodeEnv = process.env.NODE_ENV;
const babelEnv = process.env.BABEL_ENV;

afterEach(() => {
jest.resetModules();

if (process.version === 'new-node-version') {
process.version = processVersion;
}

if (process.env.NODE_ENV === 'NEW_NODE_ENV') {
process.env.NODE_ENV = nodeEnv;
}

if (process.env.BABEL_ENV === 'NEW_BABEL_ENV') {
process.env.BABEL_ENV = babelEnv;
}
});

describe('getCacheKey', () => {
const sourceText = 'mock source';
const sourcePath = 'mock-source-path.js';

const transformOptions = {
config: {rootDir: 'mock-root-dir'},
configString: 'mock-config-string',
instrument: true,
} as JestTransformOptions;

const oldCacheKey = babelJest.getCacheKey(
sourceText,
sourcePath,
transformOptions,
);

test('returns cache key hash', () => {
expect(oldCacheKey.length).toEqual(32);
});

test('if `THIS_FILE` value is changing', () => {
jest.doMock('graceful-fs', () => ({
readFileSync: () => 'new this file',
}));

const {default: babelJest}: typeof import('../index') = require('../index');

const newCacheKey = babelJest.getCacheKey(
sourceText,
sourcePath,
transformOptions,
);

expect(oldCacheKey).not.toEqual(newCacheKey);
});

test('if `babelOptions.options` value is changing', () => {
jest.doMock('../loadBabelConfig', () => {
const babel: typeof import('@babel/core') = require('@babel/core');

return {
loadPartialConfig: (options: BabelTransformOptions) => ({
...babel.loadPartialConfig(options),
options: 'new-options',
}),
};
});

const {default: babelJest}: typeof import('../index') = require('../index');

const newCacheKey = babelJest.getCacheKey(
sourceText,
sourcePath,
transformOptions,
);

expect(oldCacheKey).not.toEqual(newCacheKey);
});

test('if `sourceText` value is changing', () => {
const newCacheKey = babelJest.getCacheKey(
'new source text',
sourcePath,
transformOptions,
);

expect(oldCacheKey).not.toEqual(newCacheKey);
});

test('if `sourcePath` value is changing', () => {
const newCacheKey = babelJest.getCacheKey(
sourceText,
'new-source-path.js',
transformOptions,
);

expect(oldCacheKey).not.toEqual(newCacheKey);
});

test('if `configString` value is changing', () => {
const newCacheKey = babelJest.getCacheKey(sourceText, sourcePath, {
...transformOptions,
configString: 'new-config-string',
});

expect(oldCacheKey).not.toEqual(newCacheKey);
});

test('if `babelOptions.config` value is changing', () => {
jest.doMock('../loadBabelConfig', () => {
const babel: typeof import('@babel/core') = require('@babel/core');

return {
loadPartialConfig: (options: BabelTransformOptions) => ({
...babel.loadPartialConfig(options),
config: 'new-config',
}),
};
});

const {default: babelJest}: typeof import('../index') = require('../index');

const newCacheKey = babelJest.getCacheKey(
sourceText,
sourcePath,
transformOptions,
);

expect(oldCacheKey).not.toEqual(newCacheKey);
});

test('if `babelOptions.babelrc` value is changing', () => {
jest.doMock('../loadBabelConfig', () => {
const babel: typeof import('@babel/core') = require('@babel/core');

return {
loadPartialConfig: (options: BabelTransformOptions) => ({
...babel.loadPartialConfig(options),
babelrc: 'new-babelrc',
}),
};
});

const {default: babelJest}: typeof import('../index') = require('../index');

const newCacheKey = babelJest.getCacheKey(
sourceText,
sourcePath,
transformOptions,
);

expect(oldCacheKey).not.toEqual(newCacheKey);
});

test('if `instrument` value is changing', () => {
const newCacheKey = babelJest.getCacheKey(sourceText, sourcePath, {
...transformOptions,
instrument: false,
});

expect(oldCacheKey).not.toEqual(newCacheKey);
});

test('if `process.env.NODE_ENV` value is changing', () => {
process.env.NODE_ENV = 'NEW_NODE_ENV';

const newCacheKey = babelJest.getCacheKey(
sourceText,
sourcePath,
transformOptions,
);

expect(oldCacheKey).not.toEqual(newCacheKey);
});

test('if `process.env.BABEL_ENV` value is changing', () => {
process.env.BABEL_ENV = 'NEW_BABEL_ENV';

const newCacheKey = babelJest.getCacheKey(
sourceText,
sourcePath,
transformOptions,
);

expect(oldCacheKey).not.toEqual(newCacheKey);
});

test('if node version is changing', () => {
delete process.version;
process.version = 'new-node-version';

const newCacheKey = babelJest.getCacheKey(
sourceText,
sourcePath,
transformOptions,
);

expect(oldCacheKey).not.toEqual(newCacheKey);
});
});
2 changes: 2 additions & 0 deletions packages/babel-jest/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ function getCacheKeyFromConfig(
.update(process.env.NODE_ENV || '')
.update('\0', 'utf8')
.update(process.env.BABEL_ENV || '')
.update('\0', 'utf8')
.update(process.version)
.digest('hex');
}

Expand Down