jest-firestore

Jest preset to run Firestore emulator automatically within your Jest Tests

This package is created to help people who are using Firestore in their projects to write tests without mocking Firestore.

Motivation

The firebase itself provides emulators suite with a emulators:exec command which helps to use emulator suite in testing scenarios. However, using emulators:exec command brings some drawbacks.

First, you are no longer able to run tests directly using Jest runner or from your IDE. You need to run it using firebase emulators:exec "npx jest" --only firestore command.

The other way would be to always have emulators running in the background while development to be able to run tests from IDE or Jest CLI. This is not a big deal, but it's inconvenient and might not be transparent for other team members.

The second and probably more important drawback is that emulators:exec doesn't work well in monorepo scenarios when you have multiple functions codebases.

Firebase CLI allows you to run only one emulator per project and doesn't allow to set port dynamically.

This package is created to solve these problems. It is heavily inspired by jest-mongodb and allows you to run Firestore emulator automatically within your Jest tests.

It uses native firebase-tools under the hood, so it's exactly the same emulator as you would expect with Firebase CLI.

Usage

0. Install

1yarn add jest-firestore --dev

Make sure firebase-tools is installed in the project as well, as it's required as a peer dependency.

1. Create jest.config.js

1module.exports = {
2  preset: 'jest-firestore',
3};

If you have a custom jest.config.js make sure you remove testEnvironment property, otherwise it will conflict with the preset.

By default, one emulator instance would be created for all Jest workers. You can achieve parallelism by leveraging emulator's multi database support.

2. Configure firebase-admin

Library sets the process.env.FIRESTORE_EMULATOR_HOST for your convenience so firebase-admin and other firebase tools will pick it up automatically.

1import { type Firestore, getFirestore } from 'firebase-admin/firestore';
2import { initializeApp } from 'firebase-admin/app';
3
4describe('insert', () => {
5  let firestore: Firestore;
6
7  beforeAll(() => {
8    // setup deffiernet database for each jest worker
9    const databaseName = 'test-' + process.pid;
10
11    // `firebase-admin` automatically discover FIRESTORE_EMULATOR_HOST.
12    const app = initializeApp();
13    firestore = getFirestore(app, databaseName);
14  });
15});

3. PROFIT! Write tests

1it('should insert a doc into collection', async () => {
2  const users = firestore.collection('users');
3
4  const mockUser = { _id: 'some-user-id', name: 'John' };
5  const { id } = await users.add(mockUser);
6
7  const insertedUser = await users.doc(id).get();
8
9  expect(insertedUser.data()).toEqual(mockUser);
10});

(optional) Configure Firestore emulator with jest-firebase-config.js

You can change some Firestore emulator options by creating jest-firebase-config.js file next to the jest.config.js file.

1module.exports = {
2  // full list of available options available here src/types.ts#Options
3  firestoreEmulatorOptions: {
4    project_id: 'demo-test-project',
5    // todo: didn't tested yet, need to figure out is it relative or absolute path
6    rules: 'firestore.rules', // optional path to rules file
7  },
8};

If you want to have a separate emulator instance for each Jest worker, create the following configuration:

1module.exports = {
2  firestoreEmulatorOptions: {
3    // ...
4  },
5  useSharedDBForAllJestWorkers: false,
6};

However, this is not recommended as it will slow down your tests.

5. Clean database before each test (optional)

See the firebase docs

1beforeEach(async () => {
2  await fetch(
3    `http://${process.env.FIRESTORE_EMULATOR_HOST}/emulator/v1/projects/${process.env.GCLOUD_PROJECT}/databases/${databaseName}/documents`,
4    { method: 'DELETE' },
5  );
6});

Bypassing starting emulator

You may want to bypass starting emulator during tests and connect to the external running emulator instead. Pass FIRESTORE_EMULATOR_HOST environment variable to your tests to achieve this.

1FIRESTORE_EMULATOR_HOST=localhost:8080 jest

Firebase's emulators:exec command sets this variable automatically, so you can run tests using it as well:

1firebase emulators:exec "jest"

Misc

Cache Firebase Emulators binary in CI by putting this folder to the list of cached paths: ~/.cache/firebase/emulators.

You can enable debug logs by setting environment variable DEBUG=jest-firestore:*

See Also

• jest-dynamodb
• jest-mongodb

Publish

Run release workflow from GitHub Actions.

Or run manually:

1npx release-it