SyntaxError: The requested module '@firebase/rules-unit-testing' does not provide an export named 'RulesTestEnvironment'.

[asaadjaber]

Operating System

MacOS 14.3.

Browser Version

Firefox/122.0.

Firebase SDK Version

13.0.3

Firebase SDK Product:

Firestore

Describe your project's tooling

iOS app with Mocha v10.2.0 and node v20.9.0.

Describe the problem

I was trying to run a unit test locally to test writes to my database which is in Cloud Firestore. I wrote a test which I called 'test.js' that imports RulesTestEnvironment from the @firebase/rules-unit-testing module. The test uses an import from @firebase/rules-unit testing and another from "firebase/firestore".

import {
  assertFails,
  assertSucceeds,
  initializeTestEnvironment,
  RulesTestEnvironment,
} from "@firebase/rules-unit-testing"

When I tried to run the unit test from the command line, I ran into an error that said 'SyntaxError: The requested module '@firebase/rules-unit-testing' does not provide an export named 'RulesTestEnvironment'.

The error that appeared:

Steps and code to reproduce issue

After I started the emulator, I ran the test in this file https://github.com/asaadjaber/special-parakeet-fork/blob/cloud-firestore-unit-tests-using-mocha/Special%20Parakeet/test/test.js from the command line using npm test and I encountered the error saying 'SyntaxError: The requested module '@firebase/rules-unit-testing' does not provide an export named 'RulesTestEnvironment'.

[ehsannas]

Thanks for reporting @asaadjaber. Have you installed the @firebase/rules-unit testing package in addition to the firebase package? I see the RulesTestEnvironment exported.

[asaadjaber]

Hi, no I have added the import to import RulesTestEnvironment using the sample code that was provided in the guide https://firebase.google.com/docs/firestore/security/test-rules-emulator which is here.

[asaadjaber]

Hi @ehsannas upon installing the firebase rules unit testing package and the firebase package I reran the test and I ran into the same error:

[hsubox76]

RulesTestEnvironment is a TypeScript type, and it's not in the actual JS file (index.cjs.js) but in the typescript definitions file (index.d.ts), which would only be read by a TypeScript compiler. Since you have a minimal JS setup (using Node directly) and are not using TypeScript, you can just ignore that and not import it.

It happens to be the type returned by initializeTestEnvironment (assigned to testEnv in the docs and in your file), which doesn't matter at all if you're not using TypeScript.

[asaadjaber]

Hi, I have tried commenting out the import and running the test using the initializeTestEnvironment,

let testEnv = await initializeTestEnvironment({
  projectId: "special-parakeet",
  firestore: {
    rules: fs.readFileSync("special-parakeet-firestore.rules", "utf8"),
  },
});

That resulted in this error: