fix: listen to user doc changes instead of fetching doc to check if exists

packages/actions/src/helpers/database.ts

@@ -6,6 +6,7 @@ import {
     Firestore,
     getDoc,
     getDocs,
+    onSnapshot,
     query,
     QueryConstraint,
     QueryDocumentSnapshot,
@@ -123,6 +124,26 @@ export const getDocumentById = async (
     return getDoc(docRef)
 }
 
+export const waitForUserDocumentToExist = (firestoreDatabase: Firestore, collection: string, documentId: string) => {
+    return new Promise<void>((resolve, reject) => {
+        const docRef = doc(firestoreDatabase, collection, documentId)
+
+        const unsubscribe = onSnapshot(
+            docRef,
+            (docSnapshot) => {
+                if (docSnapshot.exists()) {
+                    unsubscribe()
+                    resolve()
+                }
+            },
+            (error) => {
+                unsubscribe()
+                reject(error)
+            }
+        )
+    })
+}
+
 /**
  * Query for opened ceremonies.
  * @param firestoreDatabase <Firestore> - the Firestore service instance associated to the current Firebase application.

packages/actions/src/index.ts

@@ -23,7 +23,8 @@ export {
     getContributionsCollectionPath,
     getTimeoutsCollectionPath,
     getOpenedCeremonies,
-    getCeremonyCircuits
+    getCeremonyCircuits,
+    waitForUserDocumentToExist
 } from "./helpers/database"
 export {
     compareCeremonyArtifacts,

packages/actions/test/unit/database.test.ts

@@ -1,7 +1,9 @@
+import { expect as jestExpect } from "@jest/globals"
 import chai, { expect } from "chai"
 import chaiAsPromised from "chai-as-promised"
 import { getAuth, signInWithEmailAndPassword, signOut } from "firebase/auth"
-import { where } from "firebase/firestore"
+import { onSnapshot, where } from "firebase/firestore"
+import * as firestore from "firebase/firestore"
 import { fakeCeremoniesData, fakeCircuitsData, fakeParticipantsData, fakeUsersData } from "../data/samples"
 import {
     getCurrentFirebaseAuthUser,
@@ -16,7 +18,8 @@ import {
     getCircuitsCollectionPath,
     getContributionsCollectionPath,
     getTimeoutsCollectionPath,
-    commonTerms
+    commonTerms,
+    waitForUserDocumentToExist
 } from "../../src/index"
 import {
     deleteAdminApp,
@@ -32,6 +35,11 @@ import {
 } from "../utils/index"
 import { CeremonyState } from "../../src/types/enums"
 
+jest.mock("firebase/firestore", () => ({
+    __esModule: true,
+    ...jest.requireActual("firebase/firestore")
+}))
+
 chai.use(chaiAsPromised)
 
 /**
@@ -150,6 +158,29 @@ describe("Database", () => {
         })
     })
 
+    describe("waitForUserDocumentToExist", () => {
+        it("should wait for a user document to exist", async () => {
+            await signInWithEmailAndPassword(userAuth, users[0].data.email, passwords[0])
+
+            let handleSnapshot: any
+            jest.spyOn(firestore, "onSnapshot").mockImplementationOnce((...args) => {
+                ;[, handleSnapshot] = args
+                return jest.fn()
+            })
+
+            const promise = waitForUserDocumentToExist(
+                userFirestore,
+                commonTerms.collections.ceremonies.name,
+                fakeCeremoniesData.fakeCeremonyOpenedFixed.uid
+            )
+
+            handleSnapshot({ exists: () => true }) // Simulate document creation
+            await expect(promise).to.be.fulfilled
+            jestExpect(onSnapshot).toHaveBeenCalledTimes(1)
+        })
+        jest.clearAllMocks()
+    })
+
     describe("getCircuitContributionsFromContributor", () => {
         it("should return an empty array when a ceremony has not participants", async () => {
             const contributions = await getCircuitContributionsFromContributor(

packages/phase2cli/src/commands/contribute.ts

@@ -21,7 +21,8 @@ import {
     FirebaseDocumentInfo,
     generateValidContributionsAttestation,
     commonTerms,
-    convertToDoubleDigits
+    convertToDoubleDigits,
+    waitForUserDocumentToExist
 } from "@p0tion/actions"
 import { DocumentSnapshot, DocumentData, Firestore, onSnapshot, Timestamp } from "firebase/firestore"
 import { Functions } from "firebase/functions"
@@ -947,15 +948,7 @@ const contribute = async (opt: any) => {
     const spinner = customSpinner(`Verifying your participant status...`, `clock`)
     spinner.start()
 
-    // Check that the user's document is created
-    const userDoc = await getDocumentById(firestoreDatabase, commonTerms.collections.users.name, user.uid)
-    const userData = userDoc.data()
-    if (!userData) {
-        spinner.fail(
-            `Unfortunately we could not find a user document with your information. This likely means that you did not pass the GitHub reputation checks and therefore are not elegible to contribute to any ceremony. If you believe you pass the requirements, it might be possible that your profile is private and we were not able to fetch your real statistics, in this case please consider making your profile public for the duration of the contribution. Please contact the coordinator if you believe this to be an error.`
-        )
-        process.exit(0)
-    }
+    await waitForUserDocumentToExist(firestoreDatabase, commonTerms.collections.users.name, user.uid)
 
     // Check the user's current participant readiness for contribution status (eligible, already contributed, timed out).
     const canParticipantContributeToCeremony = await checkParticipantForCeremony(firebaseFunctions, selectedCeremony.id)