@devtion/backend 0.0.0-5d170d3 → 0.0.0-7cfaa5d

package/src/functions/user.ts

@@ -2,7 +2,7 @@ import * as functions from "firebase-functions"
 import { UserRecord } from "firebase-functions/v1/auth"
 import admin from "firebase-admin"
 import dotenv from "dotenv"
-import { commonTerms, githubReputation } from "@p0tion/actions"
+import { commonTerms, githubReputation } from "@devtion/actions"
 import { encode } from "html-entities"
 import { getGitHubVariables, getCurrentServerTimestampInMillis } from "../lib/utils"
 import { logAndThrowError, makeError, printLog, SPECIFIC_ERRORS } from "../lib/errors"
@@ -40,8 +40,12 @@ export const registerAuthUser = functions
         const { uid } = user
         // Reference to a document using uid.
         const userRef = firestore.collection(commonTerms.collections.users.name).doc(uid)
-        // html encode the display name
-        const encodedDisplayName = encode(displayName)
+        // html encode the display name (or put the ID if the name is not displayed)
+        const encodedDisplayName =
+            user.displayName === "Null" || user.displayName === null ? user.uid : encode(displayName)
+
+        // store the avatar URL of a contributor
+        let avatarUrl: string = ""
         // we only do reputation check if the user is not a coordinator
         if (
             !(
@@ -56,13 +60,13 @@ export const registerAuthUser = functions
 
                 // this return true or false
                 try {
-                    const res = await githubReputation(
+                    const { reputable, avatarUrl: avatarURL } = await githubReputation(
                         user.providerData[0].uid,
                         vars.minimumFollowing,
                         vars.minimumFollowers,
                         vars.minimumPublicRepos
                     )
-                    if (!res) {
+                    if (!reputable) {
                         // Delete user
                         await auth.deleteUser(user.uid)
                         // Throw error
@@ -70,11 +74,22 @@ export const registerAuthUser = functions
                             makeError(
                                 "permission-denied",
                                 "The user is not allowed to sign up because their Github reputation is not high enough.",
-                                `The user ${user.displayName} is not allowed to sign up because their Github reputation is not high enough. Please contact the administrator if you think this is a mistake.`
+                                `The user ${
+                                    user.displayName === "Null" || user.displayName === null
+                                        ? user.uid
+                                        : user.displayName
+                                } is not allowed to sign up because their Github reputation is not high enough. Please contact the administrator if you think this is a mistake.`
                             )
                         )
                     }
-                    printLog(`Github reputation check passed for user ${user.displayName}`, LogLevel.DEBUG)
+                    // store locally
+                    avatarUrl = avatarURL
+                    printLog(
+                        `Github reputation check passed for user ${
+                            user.displayName === "Null" || user.displayName === null ? user.uid : user.displayName
+                        }`,
+                        LogLevel.DEBUG
+                    )
                 } catch (error: any) {
                     // Delete user
                     await auth.deleteUser(user.uid)
@@ -89,6 +104,8 @@ export const registerAuthUser = functions
             }
         }
         // Set document (nb. we refer to providerData[0] because we use Github OAuth provider only).
+        // In future releases we might want to loop through the providerData array as we support
+        // more providers.
         await userRef.set({
             name: encodedDisplayName,
             encodedDisplayName,
@@ -101,7 +118,14 @@ export const registerAuthUser = functions
             photoURL: photoURL || "",
             lastUpdated: getCurrentServerTimestampInMillis()
         })
+
+        // we want to create a new collection for the users to store the avatars
+        const avatarRef = firestore.collection(commonTerms.collections.avatars.name).doc(uid)
+        await avatarRef.set({
+            avatarUrl: avatarUrl || ""
+        })
         printLog(`Authenticated user document with identifier ${uid} has been correctly stored`, LogLevel.DEBUG)
+        printLog(`Authenticated user avatar with identifier ${uid} has been correctly stored`, LogLevel.DEBUG)
     })
 /**
  * Set custom claims for role-based access control on the newly created user.

package/src/lib/errors.ts

@@ -184,6 +184,11 @@ export const SPECIFIC_ERRORS = {
         "unavailable",
         "VM command execution has been delayed since there were no available instance at the moment",
         "Please, contact the coordinator if this error persists."
+    ),
+    SE_VM_UNKNOWN_COMMAND_STATUS: makeError(
+        "unavailable",
+        "VM command execution has failed due to an unknown status code",
+        "Please, contact the coordinator if this error persists."
     )
 }
 

package/src/lib/utils.ts

@@ -25,7 +25,7 @@ import {
     CeremonyState,
     finalContributionIndex,
     CircuitDocument
-} from "@p0tion/actions"
+} from "@devtion/actions"
 import fetch from "@adobe/node-fetch-retry"
 import path from "path"
 import os from "os"
@@ -217,7 +217,7 @@ export const downloadArtifactFromS3Bucket = async (bucketName: string, objectKey
     const streamPipeline = promisify(pipeline)
     await streamPipeline(response.body, writeStream)
 
-    writeStream.on('finish', () => {
+    writeStream.on("finish", () => {
         writeStream.end()
     })
 }
@@ -305,7 +305,7 @@ export const deleteObject = async (bucketName: string, objectKey: string) => {
 
     // Prepare command.
     const command = new DeleteObjectCommand({ Bucket: bucketName, Key: objectKey })
-    
+
     // Execute command.
     const data = await client.send(command)
 

package/src/types/index.ts

@@ -1,4 +1,4 @@
-import { CeremonyInputData, CircuitDocument, ETagWithPartNumber } from "@p0tion/actions"
+import { CeremonyInputData, CircuitDocument, ETagWithPartNumber } from "@devtion/actions"
 
 /**
  * Group all the necessary data needed for running the `setupCeremony` cloud function.