Report a problem

Firenook’s bugs and feature requests live in the GitHub issues. This page says what to put in an issue so the problem can be reproduced and fixed, and where to send a security problem instead.

Search the open and closed issues first: someone may have reported it, and troubleshooting may already have the fix.

What to include

The version

$ npx firenook --version
0.2.0 (engine source 7a9614bea49f8208f96d2126b29ef11ee2f2810b)

Include the whole line: the engine revision says exactly which engine you ran. If you can, say whether the latest release still has the problem.

Your system

Name the operating system and its version, the processor (Apple silicon, Intel or AMD x64, arm64), the Node version (node --version), and the package manager you installed with.

What Firenook read

doctor prints, as JSON, how Firenook reads your project: the Node it runs on, the firebase.json it found, the project id, the services it starts, every port, each Extension with where its source comes from, and any problem that would stop a start. It changes nothing.

npx firenook doctor

It includes your firebase.json and full paths, which contain your user name. Read it before you paste it, and shorten what you want to keep private.

The log

Run the failing command with --debug. Firenook writes the engine’s full log to the run’s folder and prints where:

$ npx firenook emulators:start --plain --debug --only firestore
Firenook 0.2.0; engine 7a9614bea49f8208f96d2126b29ef11ee2f2810b; disk/WAL state ~/demo-shop/.firenook/runs/session-12IyTo/state
Services: firestore; Emulator UI on; host localhost
Demo project demo-shop: no cloud service is contacted, but user Functions can still reach external providers; this CLI is not a network sandbox.
Debug log: ~/demo-shop/.firenook/runs/session-12IyTo/firenook-debug.log

Attach that file, and the output of the same command. --plain prints the plain log instead of the terminal screen, which is easier to paste. The same folder holds launch.json, a record of the version, the arguments and the services of that run.

A small project that shows it

The fastest fix starts from a project anyone can run:

• a firebase.json with only the services involved;
• the rules, indexes and the smallest function that show the problem;
• a demo- project id, such as demo-shop;
• the steps, from npx firenook emulators:start to the wrong result;
• what you expected, and what happened instead.

Use made-up data. If the official emulator behaves differently on the same project, say how: Firenook aims to answer as it does, so a difference is a bug in itself.

What never to include

Do not paste secrets, service account keys, .env or .secret.local files, real user data, or exports of a production project. Logs hold whatever your functions print, the console’s request history can hold document data and decoded sign-in claims, and doctor output holds your paths: check what you share.

Security problems

Do not open a public issue for a security problem. See security for how to report it privately.

Next

To fix it yourself, see build from source.