How do I set a timezone in my Jest config?
This does not work on windows prior to node 16.2.0 (and prior to 17.0.1 in node 17) - see https://github.com/nodejs/node/issues/4230
The problem with process.env.TZ = 'UTC';
is, that if something runs before this line and uses Date
, the value will be cached in Date
. Therefore process.env
is in general not suitable for setting the timezone. See https://github.com/nodejs/node/issues/3449
So a better way is to use an actual env variable, but for tests this will work:
1. Add this to your package.json
"jest": {
...
// depending on your paths it can also be './global-setup.js'
"globalSetup": "../global-setup.js"
}
}
2. Put this file besides package.json as global-setup.js
module.exports = async () => {
process.env.TZ = 'UTC';
};
3. Optional: Add a test that ensures UTC execution
describe('Timezones', () => {
it('should always be UTC', () => {
expect(new Date().getTimezoneOffset()).toBe(0);
});
});
The normal setupFiles
did not work for me, since they run too late (jest: ^23.5.0). So it is mandatory to use the globalSetup file.
If you are running tests with npm scripts, ie: npm run test
, you can pass in the timezone like so:
"scripts": {
"test": "TZ=UTC jest"
},
I also personally feel that this (vs the process.env
methods) is cleaner and easier to identify the timezone when debugging issues on remote CI servers.