chore: make logging good

docker-compose.yml

@@ -10,6 +10,5 @@ services:
     - 4001-4008:4001-4008
     volumes:
     - ./functions:/app/functions
-    - ./functions/data/emulator/:/seed
+    - ./functions/data/emulator:/seed
-
+    - ./functions/logs:/app/logs
-    # - ./functions/logs/firestore-debug.log:/app/firestore-debug.log

functions/emulator/Dockerfile

@@ -20,7 +20,7 @@
 #   docker run -v ./functions/data/emulator:/seed -v ./functions:/app/functions -p 4001-4008:4001-4008 -it emulator
 #
 #   EXPORT (while the container is running)
-#   docker exec -it <conatiner_name> /app/easy-export.sh
+#   docker exec -it <conatiner_name> /app/export.js
 #   docker cp <conatiner_name>:/app/dump ./whatever
 #
 # HOW TO DEBUG THE CONTAINER WHILE IT IS RUNNING:
@@ -71,12 +71,14 @@ RUN \
   firebase setup:emulators:storage && \
   firebase setup:emulators:pubsub
 
-COPY ./firebase.json                      ./firebase.json
+COPY ./firebase.json                    ./firebase.json
-COPY ./firebase.storage.rules             ./firebase.storage.rules
+COPY ./firebase.storage.rules           ./firebase.storage.rules
-COPY ./firestore.indexes.json             ./firestore.indexes.json
+COPY ./firestore.indexes.json           ./firestore.indexes.json
-COPY ./firestore.rules                    ./firestore.rules
+COPY ./firestore.rules                  ./firestore.rules
 
-COPY ./functions/emulator/easy-export.sh  ./easy-export.sh
+COPY ./functions/emulator/export.js     ./export.js
+
+COPY ./functions/emulator/link-logs.js  ./link-logs.js
 
 # This folder needs to exist because otherwise
 # the emulators error if the user did not mount
@@ -86,8 +88,9 @@ RUN mkdir /seed
 # These should be the ports specified in firebase.json
 EXPOSE 4001 4002 4003 4004 4005 4006 4007 4008
 
-# Do firebase emulators:start --help for details
 CMD \
+  ./link-logs.js & \
+  # Do firebase emulators:start --help for details
   firebase emulators:start \
   --project demo-community-platform-emulated \
   --only auth,functions,firestore,pubsub,storage,hosting,database \

functions/emulator/easy-export.sh

@@ -1,5 +0,0 @@
-#!/bin/bash
-firebase \
-  emulators:export \
-  --project demo-community-platform-emulated \
-  --force ./dump

functions/emulator/export.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+
+const { exec } = require('child_process')
+
+const command = 'firebase emulators:export --project demo-community-platform-emulated --force ./dump'
+
+exec(command, (error, stdout, stderr) => {
+  if (error) {
+    console.error(`exec error: ${error}`)
+    return
+  }
+  console.log(`stdout: ${stdout}`)
+  console.error(`stderr: ${stderr}`)
+})

functions/emulator/link-logs.js

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+
+// Continuously copy the log files into a common folder
+// making it easier to export them.
+//
+// This script knows the folder structure of the container.
+//
+// Symbolic links did not work.
+
+const fs = require('fs')
+
+const isDebug = false
+
+log('setup...')
+
+const files = [
+  'database-debug.log',
+  'firebase-debug.log',
+  'firestore-debug.log',
+  'pubsub-debug.log',
+  'ui-debug.log'
+]
+
+// clear the files so the they are also cleared on the host.
+files.forEach((filename) => {
+  fs.writeFileSync('/app/' + filename, '')
+})
+
+fs.watch('/app', {}, (event, filename) => {
+  log('event: ' + event)
+  log('filename: ' + filename)
+
+  if (files.includes(filename)) {
+    log('updating... ' + filename)
+    fs.copyFileSync('/app/' + filename, '/app/logs/' + filename)
+  }
+})
+
+function log(statement) {
+  if (isDebug) {
+    console.log('[LINK-LOGS] ' + statement)
+  }
+}

functions/logs/.gitignore

@@ -0,0 +1 @@
+*.log

packages/documentation/docs/Backend Development/firebase-emulator.md

@@ -109,7 +109,7 @@ You can improve the seed data by making changes via the application or Firebase
 2. Run the export script:
 
 ```
-docker exec -it <name> /app/easy-export.sh
+docker exec -it <name> /app/export.js
 ```
 
 3. Transfer the data from the container to your machine: