Feat: add utility function to format project and other improvements

Author: puranban

firebase/database.rules.json

@@ -141,7 +141,8 @@
         },
         ".indexOn": [
           "created",
-          "teamId"
+          "teamId",
+          "usernameKey"
         ]
       },
       "OSMAccessToken": {

firebase/functions/src/index.ts

@@ -9,6 +9,7 @@ admin.initializeApp();
 // seem possible to split them using the split system for multiple sites from
 // https://firebase.google.com/docs/hosting/multisites
 import {redirect, token} from './osm_auth';
+import { formatProjectTopic, formatUserName } from './utils';
 
 exports.osmAuth = {};
 
@@ -359,21 +360,18 @@ exports.addProjectTopicKey = functions.https.onRequest(async (_, res) => {
 
             Object.keys(data).forEach((id) => {
                 if (data[id]?.projectTopic) {
-                    const newProjectTopicKey = data[id].projectTopic?.toLowerCase() as string;
+                    const newProjectTopicKey = formatProjectTopic(data[id].projectTopic);
                     newProjectData[`v2/projects/${id}/projectTopicKey`] = newProjectTopicKey;
                 }
             });
-            // NOTE: Update database with the new topic key
-            await admin.database().ref().update(newProjectData);
 
-            await admin.database().ref().update(newProjectData).then(() => {
-                const updatedProjectsCount = Object.keys(newProjectData).length;
-                res.status(200).send(`Updated ${updatedProjectsCount} projects.`);
-                return;
-            });
+            await admin.database().ref().update(newProjectData);
+            const updatedProjectsCount = Object.keys(newProjectData).length;
+            res.status(200).send(`Updated ${updatedProjectsCount} projects.`);
         }
     } catch (error) {
-        res.status(500).send(error);
+        console.log(error);
+        res.status(500).send('Some error occurred');
     }
 });
 
@@ -392,18 +390,17 @@ exports.addUserNameLowercase = functions.https.onRequest(async (_, res) => {
 
             Object.keys(data).forEach((id) => {
                 if (data[id]?.username) {
-                    const newUserNameKey = (data[id].username.trim()).toLowerCase() as string;
-                    newUserData[`v2/users/${id}/userNameKey`] = newUserNameKey;
+                    const newUsernameKey = formatUserName(data[id].username);
+                    newUserData[`v2/users/${id}/usernameKey`] = newUsernameKey;
                 }
             });
-            // NOTE: Update database with the new username lowercase
-            await admin.database().ref().update(newUserData).then(() => {
-                const updatedUserCount = Object.keys(newUserData).length;
-                res.status(200).send(`Updated ${updatedUserCount} users.`);
-                return;
-            });
+
+            await admin.database().ref().update(newUserData);
+            const updatedUserCount = Object.keys(newUserData).length;
+            res.status(200).send(`Updated ${updatedUserCount} users.`);
         }
     } catch (error) {
-        res.status(500).send(error);
+        console.log(error);
+        res.status(500).send('Some error occurred');
     }
 });

firebase/functions/src/utils/index.ts

@@ -0,0 +1,22 @@
+// NOTE: We have a similar function in manager-dashbaord
+// manager-dashbaord/app/utills/common.tsx
+
+export const formatProjectTopic = (projectTopic: string) => {
+    // Note: this will remove start and end space
+    const projectWithoutStartAndEndSpace = projectTopic.trim();
+
+    // Note: this will change multi space to single space
+    const removeMultiSpaceToSingle = projectWithoutStartAndEndSpace.replace(/\s+/g, ' ');
+    const newProjectTopic = removeMultiSpaceToSingle.toLowerCase();
+
+    return newProjectTopic;
+};
+
+// NOTE: this validation mirrors feature from the app on signup
+export const formatUserName = (name: string) => {
+    // Note: remove all space
+    const removeUserNameSpace = name.replace(/\s+/g, '');
+    const userNameLowercase = removeUserNameSpace.toLowerCase();
+
+    return userNameLowercase;
+};

manager-dashboard/app/utils/common.tsx

@@ -308,3 +308,16 @@ export const iconMap = listToMap(
     (icon) => icon.key,
     (icon) => icon.component,
 );
+
+// NOTE: We have a similar function in firebase function utils
+// firebase/functions/src/utils/index.ts
+export const formatProjectTopic = (projectTopic: string) => {
+    // Note: this will remove start and end space
+    const projectWithoutStartAndEndSpace = projectTopic.trim();
+
+    // Note: this will change multi space to single space
+    const removeMultiSpaceToSingle = projectWithoutStartAndEndSpace.replace(/\s+/g, ' ');
+    const newProjectTopic = removeMultiSpaceToSingle.toLowerCase();
+
+    return newProjectTopic;
+};

manager-dashboard/app/views/NewProject/index.tsx

@@ -59,6 +59,7 @@ import {
     PROJECT_TYPE_FOOTPRINT,
     PROJECT_TYPE_COMPLETENESS,
     PROJECT_TYPE_CHANGE_DETECTION,
+    formatProjectTopic,
 } from '#utils/common';
 import { getValueFromFirebase } from '#utils/firebase';
 
@@ -327,11 +328,13 @@ function NewProject(props: Props) {
                     return;
                 }
 
+                // NOTE: All the user don't have permission to access draft project
+                // FIXME: The firebase rules need to be changed to perform this on draft project
                 const database = getDatabase();
-                // Note: remove start and end space
-                const projectTopicKey = (projectTopic?.trim())?.toLowerCase() as string;
-
+                const projectTopicKeyLowercase = (projectTopic?.trim())?.toLowerCase() as string;
+                const projectTopicKey = formatProjectTopic(projectTopicKeyLowercase);
                 const projectRef = databaseRef(database, 'v2/projects/');
+
                 const prevProjectNameQuery = query(
                     projectRef,
                     orderByChild('projectTopicKey'),