Fixes from code review. Docs on database backup/restore

.github/workflows/main.yml

@@ -81,12 +81,6 @@ jobs:
       - name: Deploy to Firebase
         uses: w9jds/firebase-action@v13.10.2
         with:
-          args: deploy
-        env:
-          GCP_SA_KEY: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_UNITY_CI_VERSIONS }}'
-      - name: Cleanup Firebase Test
-        uses: w9jds/firebase-action@v13.10.2
-        with:
-          args: functions:delete testFunction --force
+          args: deploy --except functions:testFunction
         env:
           GCP_SA_KEY: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_UNITY_CI_VERSIONS }}'

README.md

@@ -34,3 +34,14 @@ Completed CiJobs are reported to Discord.
 ## Ingeminator
 
 TODO - Describe how it works
+
+## Database Backup
+
+The firestore database can be backed up with the following command:
+`yarn run backfire export ./export/versioningBackendBackup --project unity-ci-versions --keyFile <PATH_TO_GOOGLE_CLOUD_SERVICE_ACCOUNT_KEYFILE.json>`
+
+Similarly, it can be used to restore a backup with:
+`yarn run backfire import ./export/versioningBackendBackup --project unity-ci-versions --keyFile <PATH_TO_GOOGLE_CLOUD_SERVICE_ACCOUNT_KEYFILE.json>`
+
+You likely would want to empty the database before restoring but you can also use flags like overwrite, merge, etc to control the restoration
+rules.

functions/src/service/discord.ts

@@ -15,7 +15,16 @@ export class Discord {
     });
 
     await this.instance.connect();
-    await this.becomeReady();
+
+    let secondsWaited = 0;
+    while (!this.instance?.startTime) {
+      await new Promise((resolve) => setTimeout(resolve, 1000));
+      secondsWaited += 1;
+
+      if (secondsWaited >= 15) {
+        throw new Error('Bot never became ready');
+      }
+    }
   }
 
   public async sendDebugLine(message: 'begin' | 'end') {
@@ -92,18 +101,6 @@ export class Discord {
     return isSent;
   }
 
-  async becomeReady(): Promise<void> {
-    let secondsWaited = 0;
-    while (!this.instance?.startTime) {
-      await new Promise((resolve) => setTimeout(resolve, 1000));
-      secondsWaited += 1;
-
-      if (secondsWaited >= 15) {
-        throw new Error('Bot never became ready');
-      }
-    }
-  }
-
   public async disconnect(): Promise<void> {
     if (!this.instance) return;
 

package.json

@@ -26,9 +26,9 @@
   },
   "homepage": "https://github.com/game-ci/versioning-backend#readme",
   "dependencies": {
+    "@google-cloud/firestore": "^7.8.0",
+    "firebase-tools": "^13.10.2",
+    "firestore-backfire": "^2.5.3",
     "prettier": "^2.8.7"
-  },
-  "devDependencies": {
-    "firebase-tools": "^13.10.2"
   }
 }