@firestore-emulator/jest

This package contains a Jest environment for setup @firestore-emulator/server.

Installation

1npm install @firestore-emulator/jest

Usage

configure your jest.config.js:

1module.exports = {
2  testEnvironment: '@firestore-emulator/jest/environment/node',
3  // or "@firestore-emulator/jest/environment/quramy__jest-prisma" if you use prisma. you should install "@quramy/jest-prisma" too.
4}

currently, other environments like jsdom are not supported yet. if you need them, please open an issue.

if you use TypeScript you can also load types of your tsconfig.json from this package:

1{
2  "compilerOptions": {
3    "types": ["@firestore-emulator/jest"]
4  }
5}

then, you can use the emulator global in your tests:

1import { initializeApp, App } from 'firebase-admin/app'
2import { Firestore, initializeFirestore } from 'firebase-admin/firestore'
3
4let firestore: Firestore
5process.env['GCLOUD_PROJECT'] = 'test-project'
6beforeAll(() => {
7  // for firebase-admin, you need to set the environment variable `FIRESTORE_EMULATOR_HOST`
8  process.env['FIRESTORE_EMULATOR_HOST'] = emulator.host
9  const app = initializeApp()
10  firestore = initializeFirestore(firestoreEmulator)
11})
12
13// you can clear the state of the emulator before each test
14beforeEach(() => {
15  emulator.state.clear()
16})
17
18it('something test you want', async () => {
19  await firestore.collection('users').doc('alice').create({ name: 'Alice' })
20
21  // you can snapshot test the state of the emulator
22  expect(emulator.state.toJSON()).toMatchSnapshot()
23})