refactor: Makes profiles collection the canon source for notificationFrequency and nextDigestAt. Moves updates to these fields to point to the profiles collection. Deprecates old scripts that reference these fields in users. Includes backfill script for nextDigestAt that will need to be run to fully enable the email notification sending flow with these changes.

Author: Mephistic

components/db/profile/types.ts

@@ -23,7 +23,7 @@ export const SOCIAL_NETWORKS = [
 ] as const
 
 export type SocialLinks = Partial<
-  Record<(typeof SOCIAL_NETWORKS)[number], string>
+  Record<typeof SOCIAL_NETWORKS[number], string>
 >
 
 export type Profile = {
@@ -35,6 +35,7 @@ export type Profile = {
   senator?: ProfileMember
   public?: boolean
   notificationFrequency?: Frequency
+  nextDigestAt?: FirebaseFirestore.Timestamp
   about?: string
   social?: SocialLinks
   profileImage?: string

functions/src/notifications/deliverNotifications.ts

@@ -5,7 +5,7 @@ import * as fs from "fs"
 import { Timestamp } from "../firebase"
 import { getNextDigestAt, getNotificationStartDate } from "./helpers"
 import { startOfDay } from "date-fns"
-import { TestimonySubmissionNotificationFields, User } from "./types"
+import { TestimonySubmissionNotificationFields } from "./types"
 import {
   BillDigest,
   NotificationEmailDigest,
@@ -15,6 +15,7 @@ import {
 import { prepareHandlebars } from "../email/handlebarsHelpers"
 import { getAuth } from "firebase-admin/auth"
 import { Frequency } from "../auth/types"
+import { Profile } from "../../../components/db/profile/types"
 
 const NUM_BILLS_TO_DISPLAY = 4
 const NUM_USERS_TO_DISPLAY = 4
@@ -44,28 +45,30 @@ const deliverEmailNotifications = async () => {
   prepareHandlebars()
   console.log("Handlebars helpers and partials prepared")
 
-  const usersSnapshot = await db
-    .collection("users")
+  const profilesSnapshot = await db
+    .collection("profiles")
     .where("nextDigestAt", "<=", now)
     .get()
 
-  const emailPromises = usersSnapshot.docs.map(async userDoc => {
-    const user = userDoc.data() as User
+  const emailPromises = profilesSnapshot.docs.map(async profileDoc => {
+    const user = profileDoc.data() as Profile
     if (!user || !user.notificationFrequency) {
-      console.log(`User ${userDoc.id} has no notificationFrequency - skipping`)
+      console.log(
+        `User ${profileDoc.id} has no notificationFrequency - skipping`
+      )
       return
     }
 
-    const verifiedEmail = await getVerifiedUserEmail(userDoc.id)
+    const verifiedEmail = await getVerifiedUserEmail(profileDoc.id)
     if (!verifiedEmail) {
       console.log(
-        `Skipping user ${userDoc.id} because they have no verified email address`
+        `Skipping user ${profileDoc.id} because they have no verified email address`
       )
       return
     }
 
     const digestData = await buildDigestData(
-      userDoc.id,
+      profileDoc.id,
       now,
       user.notificationFrequency
     )
@@ -75,7 +78,9 @@ const deliverEmailNotifications = async () => {
       digestData.numBillsWithNewTestimony === 0 &&
       digestData.numUsersWithNewTestimony === 0
     ) {
-      console.log(`No new notifications for ${userDoc.id} - not sending email`)
+      console.log(
+        `No new notifications for ${profileDoc.id} - not sending email`
+      )
     } else {
       const htmlString = renderToHtmlString(digestData)
 
@@ -90,13 +95,13 @@ const deliverEmailNotifications = async () => {
         createdAt: Timestamp.now()
       })
 
-      console.log(`Saved email message to user ${userDoc.id}`)
+      console.log(`Saved email message to user ${profileDoc.id}`)
     }
 
     const nextDigestAt = getNextDigestAt(user.notificationFrequency)
-    await userDoc.ref.update({ nextDigestAt })
+    await profileDoc.ref.update({ nextDigestAt })
 
-    console.log(`Updated nextDigestAt for ${userDoc.id} to ${nextDigestAt}`)
+    console.log(`Updated nextDigestAt for ${profileDoc.id} to ${nextDigestAt}`)
   })
 
   // Wait for all email documents to be created

functions/src/notifications/types.ts

@@ -1,14 +1,6 @@
-import { Frequency } from "../auth/types"
 import { BillHistory } from "../bills/types"
 import { Timestamp } from "../firebase"
 
-// This should probably live somewhere else once other code starts caring about this
-export interface User {
-  email?: string
-  notificationFrequency?: Frequency
-  nextDigestAt?: Timestamp
-}
-
 export interface Notification {
   type: string
   updateTime: Timestamp

functions/src/notifications/updateUserNotificationFrequency.ts

@@ -35,14 +35,13 @@ export const updateUserNotificationFrequency = functions.firestore
         return null
       }
 
-      // Update user document in the 'users' collection
+      // Update the profile document to include the computed `nextDigestAt`
       await admin
         .firestore()
-        .collection("users")
+        .collection("profiles")
         .doc(userId)
         .set(
           {
-            notificationFrequency: notificationFrequency,
             nextDigestAt: getNextDigestAt(notificationFrequency)
           },
           { merge: true }

scripts/firebase-admin/backfillNextDigestAt.ts

@@ -0,0 +1,49 @@
+/*
+    This script is intended to backfill the `nextDigestAt` field
+    into the `profiles` collection. This field is used to determine
+    when the next notifications digest email should be sent to a user
+    based on their set `notificationFrequency`.
+
+    This script can be safely removed after the `nextDigestAt` field
+    has been added to the profiles collection.
+*/
+
+import { getNextDigestAt } from "../../functions/src/notifications/helpers"
+import { Profile } from "../../components/db/profile/types"
+import { Script } from "./types"
+import { Boolean, Record } from "runtypes"
+
+// todo - actually move nextDigestAt into profiles
+// - no reason not to do it now, we have the backfill and the rules
+//  don't protect any collection
+// I'll need to fix the rules so that writes to the `profiles::nextDigestAt` field can only be made by admins
+//  - e.g. this script, the deliverNotifcaitons script, or theupdateNotifiaciotn script
+const Args = Record({
+  dryRun: Boolean
+})
+
+export const script: Script = async ({ db, auth, args }) => {
+  const profilesSnapshot = await db.collection("profiles").get()
+
+  const updatePromises = profilesSnapshot.docs.map(async profileDoc => {
+    const profile = profileDoc.data() as Profile
+
+    if (profile.notificationFrequency) {
+      const nextDigestAt = getNextDigestAt(profile.notificationFrequency)
+
+      if (!args.dryRun) {
+        await profileDoc.ref.update({ nextDigestAt })
+      }
+      console.log(
+        `Updated nextDigestAt for ${profileDoc.id} to ${nextDigestAt}`
+      )
+    } else {
+      console.log(
+        `Profile ${profileDoc.id} does not have notificationFrequency - skipping`
+      )
+    }
+  })
+
+  await Promise.all(updatePromises)
+  console.log("Backfill complete")
+}

scripts/firebase-admin/backfillNotificationFrequency.ts

@@ -1,3 +1,6 @@
+// DEPRECATED - This will no longer be useful after we've moved notificationFrequency to profiles
+// This should no longer be run and will be removed in a future update
+
 import { Script } from "./types"
 import { listAllUsers } from "./list-all-users"
 
@@ -9,7 +12,7 @@ export const script: Script = async ({ db, auth }) => {
 
   for (const user of allUsers) {
     // Get user document from Firestore
-    const userDoc = db.collection("users").doc(user.uid)
+    const userDoc = db.collection("profiles").doc(user.uid)
     const doc = await userDoc.get()
 
     // If the user document exists in Firestore

scripts/firebase-admin/backfillUserEmails.ts

@@ -1,3 +1,8 @@
+// DEPRECATED - This will no longer be useful going forward
+//              We plan to rely on the `profiles` collection for casual email use
+//              and the firebase-auth API where we need verified email addresses
+// This should no longer be run and will be removed in a future update
+
 import { UserRecord } from "firebase-admin/auth"
 import { Auth } from "functions/src/types"
 import { Script } from "./types"