rolled back usage of /users/{userId}/last-connection/self document as this is impossible to create a firestore sub-collection when the parent collection (/users/{userId}) doesn't exist yet

Reverted to a /users/{userId} doc upsert creation at client authentication time, providing last connection date
+ creating the whole user doc entry serverside when it doesn't exist, so that user entry can be cleant and re-created after

Author: fcamblor

cloud/firestore/firestore.default.rules

@@ -168,23 +168,14 @@ service cloud.firestore {
     }
 
     match /users/{userId} {
-      allow list, create, delete: if false;
-    	allow get: if iAm(userId);
-    	/* TODO: update this to false after DVBE25
-    	  (user should have had time to update to the new version of the app which, now, populates
-    	  /users/{userId}/last-connection/self node which, in turn, copies userLastConnection to this document)
-    	*/
+      allow list, delete: if false;
+    	allow get, create: if iAm(userId);
     	allow update: if iAm(userId) && onlyAllowedUpdatedFields(["userLastConnection"]);
 
       match /preferences/self {
         allow get, create, update: if iAm(userId);
         allow delete, list: if false;
       }
-      match /last-connection/self {
-        /* Don't know why, but we need to allow update in order to be able to create (at least in unit tests) */
-        allow create, update: if iAm(userId);
-        allow get, delete, list: if false;
-      }
       /* Legacy node: but kept for backward compatibility until every users have migrated their tokens-wallet
          (this can take a lot of time)
        */

cloud/firestore/firestore.default.rules.spec.ts

@@ -80,24 +80,6 @@ const FIREBASE_MANAGED_COLLECTIONS = [
       data: () => ({pinnedEventIds: []}),
       updatedData: () => ({pinnedEventIds: ['42']})
     }]
-  }, {
-    name: '/users/{userId}/last-connection/self',
-    docInitializations: [{
-      name: 'alice',
-      collection: '/users/alice/last-connection',
-      path: '/users/alice/last-connection/self',
-      newDocPath: '/users/alice/last-connection/other',
-      data: () => ({userLastConnection: "2024-10-27T12:00:00Z"}),
-      updatedData: () => ({userLastConnection: "2024-10-27T12:42:00Z"})
-    }, {
-      name: 'fred',
-      collection: '/users/fred/last-connection',
-      path: '/users/fred/last-connection/self',
-      newDocPath: '/users/fred/last-connection/other',
-      data: () => ({userLastConnection: "2024-10-27T12:00:00Z"}),
-      updatedData: () => ({userLastConnection: "2024-10-27T12:42:00Z"})
-    }]
-
   }, {
     name: '/users/{userId}/events/{eventId}',
     docInitializations: [{
@@ -820,31 +802,6 @@ const COLLECTIONS: CollectionDescriptor[] = [{
           list: false, createDoc: false, delete: false, get: false, update: false, createNew: false
         }, 'alice')
     }
-}, {
-    name: "/users/{userId}/last-connection",
-    aroundTests: (userContext: UserContext) => match(userContext)
-        .with({ name: "unauthenticated user" },  () => ({
-            beforeEach: [],
-            afterEach: [],
-        }))
-        .with({ name: "fred user" },  () => ({
-            beforeEach: [],
-            afterEach: [],
-        })).run(),
-    tests: (userContext: UserContext) => {
-      ensureCollectionFollowAccessPermissions('/users/{userId}/last-connection/self', userContext,
-        {
-          createDoc: userContext.name === 'fred user',
-          get: false, update: userContext.name === 'fred user',
-          list: false, delete: false, createNew: false,
-        }, 'fred')
-
-      ensureCollectionFollowAccessPermissions('/users/{userId}/last-connection/self', userContext,
-        {
-          get: false, update: false, createDoc: false,
-          list: false, delete: false, createNew: false,
-        }, 'alice')
-    }
 }, {
     name: "/users/{userId}/preferences",
     aroundTests: (userContext: UserContext) => match(userContext)

cloud/functions/src/functions/firestore/onUserCreated.ts

@@ -14,26 +14,32 @@ export const onUserCreated = async (user: UserRecord, context: EventContext<{}>)
     await createUserInfos(user.uid);
 };
 
-export async function createUserInfos(userId: string) {
-    const publicUserToken = uuidv4();
-    const user: User = {
-        privateUserId: userId,
-        publicUserToken,
-        userCreation: new Date().toISOString() as ISODatetime,
-        userLastConnection: new Date().toISOString() as ISODatetime,
-        username: `Anonymous${generateRandom15DigitInteger()}`,
-        totalFavs: {
-          total: 0,
-          perEventTotalFavs: {}
-        },
-        totalFeedbacks: {
-          total: 0,
-          perEventTotalFeedbacks: {}
-        },
-        _modelRemainingMigrations: [],
-        _version: 4
-    }
+export function defaultUserInfos(userId: string) {
+  const publicUserToken = uuidv4();
+  const now = new Date().toISOString() as ISODatetime
+  const user: User = {
+    privateUserId: userId,
+    publicUserToken,
+    userCreation: now,
+    userLastConnection: now,
+    username: `Anonymous${generateRandom15DigitInteger()}`,
+    totalFavs: {
+      total: 0,
+      perEventTotalFavs: {}
+    },
+    totalFeedbacks: {
+      total: 0,
+      perEventTotalFeedbacks: {}
+    },
+    _modelRemainingMigrations: [],
+    _version: 4
+  }
+
+  return user;
+}
 
+export async function createUserInfos(userId: string) {
+    const user = defaultUserInfos(userId);
     await db.collection('users').doc(userId).set(user);
 }
 

cloud/functions/src/functions/firestore/onUserLastConnectionCreated.ts

@@ -0,0 +1,30 @@
+import {DocumentSnapshot} from "firebase-functions/lib/v1/providers/firestore";
+import {EventContext} from "firebase-functions/lib/v1/cloud-functions";
+import {db} from "../../firebase";
+import {defaultUserInfos} from "./onUserCreated";
+import {User} from "../../../../../shared/user.firestore";
+
+
+export const onUserNodeUpserted = async (context: EventContext<{ userId: string }>) => {
+  const userId = context.params.userId;
+  const baseUser = defaultUserInfos(userId);
+
+  // Keeping db user infos and potentially overwriting it with default user info
+  const userDoc = await db.doc(`/users/${userId}`).get() as DocumentSnapshot
+  const dbUser = userDoc.data();
+
+  const mergedUser: User = {
+    // enforcing all default user fields are defined
+    ...baseUser,
+    // keeping db user state
+    ...dbUser,
+    // Enforcing some fields that should never change over time...
+    privateUserId: userId,
+    // 👇Please, don't do this as this will lead to infinite user node-updated loop...
+    // userLastConnection: new Date().toISOString() as ISODatetime,
+  }
+
+  // important note: if mergedUser is the same than dbUser, nothing will be really called
+  // (this is to avoid infinite loop on user node udpates
+  await userDoc.ref.update(mergedUser)
+}

cloud/functions/src/functions/firestore/onUserNodeUpserted.ts

@@ -103,10 +103,17 @@ exports.onUserPrivateSpaceTalkFeedbackCreated = functions.firestore
   .onCreate(async (snapshot, context) => {
     (await import('./functions/firestore/onTalkFeedbackProvided')).onUserTalkFeedbackCreated(snapshot, context)
   });
-exports.onUserLastConnectionCreated = functions.firestore
-  .document(`users/{userId}/last-connection/self`)
+exports.onUserNodeCreated = functions.firestore
+  .document(`users/{userId}`)
   .onCreate(async (snapshot, context) => {
-    (await import('./functions/firestore/onUserLastConnectionCreated')).onUserLastConnectionCreated(snapshot, context)
+    console.log(`onUserNodeCreated called !`)
+    return (await import('./functions/firestore/onUserNodeUpserted')).onUserNodeUpserted(context)
+  });
+exports.onUserNodeUpdated = functions.firestore
+  .document(`users/{userId}`)
+  .onUpdate(async (snapshot, context) => {
+    console.log(`onUserNodeUpdated called !`)
+    return (await import('./functions/firestore/onUserNodeUpserted')).onUserNodeUpserted(context)
   });
 
 // Schedulers

cloud/functions/src/index.ts

@@ -10,7 +10,7 @@ import {db} from "@/state/firebase";
 import {User} from "firebase/auth";
 import {useUserTokensWallet} from "@/state/useUserTokensWallet";
 import {match, P} from "ts-pattern";
-import {UserLastConnection} from "../../../../shared/user-last-connection.firestore";
+import {User as FirestoreUser} from "../../../../shared/user.firestore";
 import {ISODatetime} from "../../../../shared/type-utils";
 
 const props = defineProps({
@@ -22,12 +22,12 @@ const props = defineProps({
 
 migrateData(props.user.uid);
 
-const userLastConnexion: UserLastConnection = {
-  privateUserId: props.user.uid,
+const userLastConnexion: Pick<FirestoreUser, "userLastConnection"> = {
   userLastConnection: new Date().toISOString() as ISODatetime,
 }
+const userDoc = doc(db, `/users/${props.user.uid}`)
 // Creating user last-connection doc with (always) last known user connection in it
-setDoc(doc(db, `/users/${props.user.uid}/last-connexion/self`), userLastConnexion);
+setDoc(userDoc, userLastConnexion, { merge: true })
 
 
 const { registerTalkFeedbacksViewerSecretToken, registerEventOrganizerSecretToken, registerPrivateSpaceSecretToken } = useUserTokensWallet();