Merge pull request #958 from mapswipe/fix/project-draft-topic

Fix project draft topic save

Author: tnagorra

firebase/database.rules.json

@@ -36,7 +36,10 @@
           "
         },
         ".indexOn": [
-            "status", "isFeatured", "teamId"
+            "status",
+            "isFeatured",
+            "teamId",
+            "projectTopicKey"
         ]
       },
       "projectDrafts": {
@@ -138,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 = {};
 
@@ -349,28 +350,28 @@ exports.addProjectTopicKey = functions.https.onRequest(async (_, res) => {
         const projectRef = await admin.database().ref('v2/projects').once('value');
         const data = projectRef.val();
 
-        if (data) {
+        const isEmptyProject = Object.keys(data).length === 0;
+        if (isEmptyProject) {
+            res.status(404).send('No projects found');
+        }
+
+        if (!isEmptyProject && data) {
             const newProjectData: {[key: string]: string} = {};
 
             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);
 
-            // Fetch updated data
-            const updatedSnapshot = await admin.database().ref('v2/projects').once('value');
-            const updatedProjectData = updatedSnapshot.val();
-
-            res.status(200).send(updatedProjectData);
-        } else {
-            res.status(404).send('No projects found');
+            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 fetching projects data');
+        console.log(error);
+        res.status(500).send('Some error occurred');
     }
 });
 
@@ -379,27 +380,27 @@ exports.addUserNameLowercase = functions.https.onRequest(async (_, res) => {
         const userRef = await admin.database().ref('v2/users').once('value');
         const data = userRef.val();
 
-        if (data) {
+        const isEmptyUser = Object.keys(data).length === 0;
+        if (isEmptyUser) {
+            res.status(404).send('No user found');
+        }
+
+        if (!isEmptyUser && data) {
             const newUserData: {[key: string]: string} = {};
 
             Object.keys(data).forEach((id) => {
                 if (data[id]?.username) {
-                    const newUserNameKey = data[id].username?.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);
 
-            // Fetch updated data
-            const updatedSnapshot = await admin.database().ref('v2/users').once('value');
-            const updatedUsersData = updatedSnapshot.val();
-
-            res.status(200).send(updatedUsersData);
-        } else {
-            res.status(404).send('No user found');
+            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 fetching user data');
+        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';
 
@@ -278,68 +279,7 @@ function NewProject(props: Props) {
                 ...valuesToCopy
             } = finalValues;
 
-            try {
-                const db = getDatabase();
-                const projectRef = databaseRef(db, 'v2/projects/');
-                const projectTopicKey = projectTopic?.toLowerCase() as string;
-
-                const prevProjectNameQuery = query(
-                    projectRef,
-                    orderByChild('projectTopicKey'),
-                    equalTo(projectTopicKey),
-                );
-
-                const snapshot = await getValueFromFirebase(prevProjectNameQuery);
-
-                if (snapshot.exists()) {
-                    setError((prevErr) => ({
-                        ...getErrorObject(prevErr),
-                        [nonFieldError]: 'A project with this name already exists, please use a different project name (Please note that the name comparision is not case sensitive)',
-                        projectTopic: 'A project with this name already exists, please use a different project name (Please note that the name comparision is not case sensitive)',
-                    }));
-                    setProjectSubmissionStatus(undefined);
-                    return;
-                }
-
-                const newProjectRef = await pushToDatabase(projectRef);
-                const newKey = newProjectRef.key;
-
-                if (!mountedRef.current) {
-                    return;
-                }
-
-                if (!newKey) {
-                    setError((err) => ({
-                        ...getErrorObject(err),
-                        [nonFieldError]: 'Failed to push new key for the project',
-                    }));
-                    setProjectSubmissionStatus('failed');
-                    return;
-                }
-
-                const uploadData = {
-                    ...finalValues,
-                    projectTopicKey,
-                    createdAt: (new Date()).getTime(),
-                };
-
-                const putProjectRef = databaseRef(db, `v2/projects/${newKey}`);
-                await setToDatabase(putProjectRef, uploadData);
-            } catch (submissionError: unknown) {
-                if (!mountedRef.current) {
-                    return;
-                }
-                // eslint-disable-next-line no-console
-                console.error(submissionError);
-                setError((err) => ({
-                    ...getErrorObject(err),
-                    [nonFieldError]: 'Some error occurred',
-                }));
-            }
-
-            const finalFilter = filter === FILTER_OTHERS
-                ? filterText
-                : filter;
+            const finalFilter = filter === FILTER_OTHERS ? filterText : filter;
 
             if (valuesToCopy.projectType === PROJECT_TYPE_FOOTPRINT && valuesToCopy.inputType === 'aoi_file') {
                 const res = await validateAoiOnOhsome(valuesToCopy.geometry, finalFilter);
@@ -388,7 +328,34 @@ 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();
+                const projectTopicKeyLowercase = (projectTopic?.trim())?.toLowerCase() as string;
+                const projectTopicKey = formatProjectTopic(projectTopicKeyLowercase);
+                const projectRef = databaseRef(database, 'v2/projects/');
+
+                const prevProjectNameQuery = query(
+                    projectRef,
+                    orderByChild('projectTopicKey'),
+                    equalTo(projectTopicKey),
+                );
+
+                const snapshot = await getValueFromFirebase(prevProjectNameQuery);
+                if (!mountedRef.current) {
+                    return;
+                }
+
+                if (snapshot.exists()) {
+                    setError((prevErr) => ({
+                        ...getErrorObject(prevErr),
+                        [nonFieldError]: 'A project with this name already exists, please use a different project name (Please note that the name comparison is not case sensitive)',
+                        projectTopic: 'A project with this name already exists',
+                    }));
+                    setProjectSubmissionStatus(undefined);
+                    return;
+                }
+
                 const projectDraftsRef = databaseRef(database, 'v2/projectDrafts/');
                 const newProjectDraftsRef = await pushToDatabase(projectDraftsRef);
                 if (!mountedRef.current) {
@@ -402,11 +369,14 @@ function NewProject(props: Props) {
 
                     const uploadData = {
                         ...valuesToCopy,
+                        projectTopic,
+                        projectTopicKey,
                         filter: finalFilter,
                         image: downloadUrl,
                         createdBy: userId,
                         teamId: visibility === 'public' ? null : visibility,
                     };
+
                     await setToDatabase(newProjectRef, uploadData);
                     if (!mountedRef.current) {
                         return;

manager-dashboard/app/views/NewProject/utils.ts

@@ -50,6 +50,7 @@ export type CustomOptionsForProject = {
 }[];
 
 export interface ProjectFormType {
+    projectTopicKey: string;
     projectTopic: string;
     projectType: ProjectType;
     projectRegion: string;

mapswipe_workers/mapswipe_workers/project_types/project.py

@@ -54,6 +54,7 @@ def __init__(self, project_draft):
         self.projectNumber = project_draft.get("projectNumber", None)
         self.projectRegion = project_draft.get("projectRegion", None)
         self.projectTopic = project_draft.get("projectTopic", None)
+        self.projectTopicKey = project_draft.get("projectTopicKey", None)
         self.projectType = int(project_draft["projectType"])
         self.requestingOrganisation = project_draft.get("requestingOrganisation", None)
         self.requiredResults = 0