Emulator shutdowns are not "clean" when using executors

WhatsThatItsPat commented 2 years ago

After using firebase emulators:start in the terminal and entering ctrl-c to end the process, I get lengthy output telling me about the shutdown process:

i  emulators: Received SIGINT (Ctrl-C) for the first time. Starting a clean shutdown.
i  emulators: Please wait for a clean shutdown or send the SIGINT (Ctrl-C) signal again to stop right now.

# ...and another dozen or more lines about shutting down the various emulators and exporting data

But after running nx serve functions or nx emulate functions, ending the process with ctrl-c doesn't show any of the output and I don't think everything is being shut down properly.

When I restart the emulators I get warnings about "multiple instances" or specific ports that are still in use:

emulators: It seems that you are running multiple instances of the emulator suite for project demo-local. This may result in unexpected behavior.

# or

firestore: Port 8080 is not open on localhost, could not start Firestore Emulator.

# or

ui: Emulator UI unable to start on port 4000, starting on 4001 instead.

Additionally, when I try to import & export emulator data, the data isn't exported to the correct place and extra firebase-export-{something} directories are created.

I've adjusted the command in the emulate executor to look like this:

firebase emulators:start --project=demo-local --import=./seed/demo-local --export-on-exit

When I run this directly in the terminal, everything shuts down fine and works as expected.

I'm on macOS, my firebase tools version is 9.16.6, and node is 16.8.0.

jBernavaPrah commented 2 years ago

Hi @WhatsThatItsPat,

What is your current workaround on this?

WhatsThatItsPat commented 2 years ago

I've just been running the firebase emulators:start... command directly while trying to remember to build things beforehand.

I've also added this to my package.json and use it if any ports are still running:

"scripts": {
  ...
  "kill-all": "npx kill-port 4000 5000 5001 8080 8085 9099 9199"
},

LaysDragon commented 1 year ago

Every time I terminate the emulator from nx serve firebase,there always a java process stuck at background and block me to restart the emulator. It seems the problem is @nrwl/workspace:run-commands unable to terminate emulator's multi process.

~~I end up using the concurrently to wrap up firebase emulate executor command. Because I accidentally founds out its can terminate emulator correctly,while I'm trying to use this cli tool to run my ng server and firebase emulator at the sametime. Its seems silly to run only one command with this multiple-commands tool but its works :D~~ No,concurrently didn't really solve the problem. Its at least can terminated all emulator process,but still not gracefully shutdown the emulator.

    "emulate": {
      "executor": "@nrwl/workspace:run-commands",
      "options": {
        "command": "concurrently --raw \"firebase emulators:start --config firebase.json --only firestore,auth,storage,functions --import=emulator --export-on-exit=emulator\""
      }
    },

LaysDragon commented 1 year ago

I'm working under windows 10 with node v16.15.1. Under nx 13,I have spend whole day on why emulator processes don't terminate gracefully. Have hard time to doing export-on-exit ,and have emulator process stuck in background. The problem is come from nx itself. I not really familiar how process and signal working under different platform. But I manage to patch up nx 13 to make its able to gracefully shutdown the emulator under windows. D:

The nx cli have some weird design to exit itself immediately under SIGINT. Including duplicated signal pass to executor process and child process,cause executor process exit immediately for unknown reason. (The similar bug also happened to concurrently #283 cli tool too,why everyone doing this?)

Here is my nx patch up file if anyone need its. Its solve my problem and making everything working great, but I don't know if it will cause other problem D: I may need find time to to fire issue about this to nx repo.

nx+13.10.6.patch

diff --git a/node_modules/nx/src/tasks-runner/forked-process-task-runner.js b/node_modules/nx/src/tasks-runner/forked-process-task-runner.js
index 5cbc819..eb42bff 100644
--- a/node_modules/nx/src/tasks-runner/forked-process-task-runner.js
+++ b/node_modules/nx/src/tasks-runner/forked-process-task-runner.js
@@ -226,21 +226,21 @@ class ForkedProcessTaskRunner {
     setupOnProcessExitListener() {
         process.on('SIGINT', () => {
             this.processes.forEach((p) => {
-                p.kill('SIGTERM');
+                // p.kill('SIGTERM');
             });
             // we exit here because we don't need to write anything to cache.
-            process.exit();
+            // process.exit();
         });
         process.on('SIGTERM', () => {
             this.processes.forEach((p) => {
-                p.kill('SIGTERM');
+                // p.kill('SIGTERM');
             });
             // no exit here because we expect child processes to terminate which
             // will store results to the cache and will terminate this process
         });
         process.on('SIGHUP', () => {
             this.processes.forEach((p) => {
-                p.kill('SIGTERM');
+                // p.kill('SIGTERM');
             });
             // no exit here because we expect child processes to terminate which
             // will store results to the cache and will terminate this process

@nrwl+workspace+13.10.6.patch

diff --git a/node_modules/@nrwl/workspace/src/executors/run-commands/run-commands.impl.js b/node_modules/@nrwl/workspace/src/executors/run-commands/run-commands.impl.js
index 77fa9c9..7e7d380 100644
--- a/node_modules/@nrwl/workspace/src/executors/run-commands/run-commands.impl.js
+++ b/node_modules/@nrwl/workspace/src/executors/run-commands/run-commands.impl.js
@@ -35,6 +35,7 @@ const propKeys = [
     'outputPath',
 ];
 function default_1(options, context) {
+    ['exit','SIGTERM','SIGINT','SIGHUP'].forEach(signal=>process.once(signal, ()=>{}));
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         yield loadEnvVars(options.envFile);
         const normalized = normalizeOptions(options);
@@ -120,9 +121,11 @@ function createProcess(command, readyWhen, color, cwd) {
         /**
          * Ensure the child process is killed when the parent exits
          */
-        const processExitListener = () => childProcess.kill();
-        process.on('exit', processExitListener);
-        process.on('SIGTERM', processExitListener);
+        // const processExitListener = () => childProcess.kill();
+        // process.on('exit', processExitListener);
+        // process.on('SIGTERM', processExitListener);
+        // process.on('SIGINT', processExitListener);
+        // process.on('SIGHUP', processExitListener);
         childProcess.stdout.on('data', (data) => {
             process.stdout.write(data);
             if (readyWhen && data.toString().indexOf(readyWhen) > -1) {