Update to use new node v10 firebase-admin syntax

kiminkim724 · kiminkim724 · commit 2a30f8af8310 · 2025-07-15T20:46:33.000-04:00
diff --git a/components/db/useUpcoming.test.ts b/components/db/useUpcoming.test.ts
@@ -1,7 +1,3 @@
-/**
- * @jest-environment node
- */
-
 import { renderHook, waitFor } from "@testing-library/react"
 import { terminateFirebase, testDb, testTimestamp } from "../../tests/testUtils"
 import { useUpcomingBills } from "./useUpcomingBills"
diff --git a/functions/src/auth/setRole.ts b/functions/src/auth/setRole.ts
@@ -1,4 +1,4 @@
-import type { UserRecord } from "firebase-admin/lib/auth/user-record"
+import { UserRecord } from "firebase-admin/auth"
 import { Undefined } from "runtypes"
 import { Profile } from "../profile/types"
 import { Auth, Database } from "../types"
diff --git a/functions/src/events/scrapeEvents.ts b/functions/src/events/scrapeEvents.ts
@@ -3,7 +3,7 @@ import { DateTime } from "luxon"
 import { JSDOM } from "jsdom"
 import { AssemblyAI } from "assemblyai"
 import { logFetchError } from "../common"
-import { admin, db, Timestamp } from "../firebase"
+import { db, storage, Timestamp } from "../firebase"
 import * as api from "../malegislature"
 import {
   BaseEvent,
@@ -176,7 +176,7 @@ const extractAudioFromVideo = async (
   })
 
   // Upload the audio file
-  const bucket = admin.storage().bucket()
+  const bucket = storage.bucket()
   const audioFileName = `hearing-${EventId}-${Date.now()}.m4a`
   const file = bucket.file(audioFileName)
 
diff --git a/functions/src/firebase.ts b/functions/src/firebase.ts
@@ -1,25 +1,32 @@
-import * as admin from "firebase-admin"
+import { initializeApp, App } from "firebase-admin/app"
+import { getAuth } from "firebase-admin/auth"
+import {
+  getFirestore,
+  Timestamp,
+  FieldValue,
+  FieldPath,
+  DocumentData,
+  QueryDocumentSnapshot,
+  DocumentSnapshot,
+  QuerySnapshot
+} from "firebase-admin/firestore"
+import { getStorage } from "firebase-admin/storage"
+
+export const app: App = initializeApp()
+export const db = getFirestore(app)
+export const storage = getStorage(app)
+export const auth = getAuth(app)
 
-admin.initializeApp()
-export const db = admin.firestore()
-export const storage = admin.storage()
-export const auth = admin.auth()
-export { admin }
 // Gotta use the same Timestamp class as the admin package.
-export const Timestamp = admin.firestore.Timestamp
-export type Timestamp = admin.firestore.Timestamp
-export const FieldValue = admin.firestore.FieldValue
-export type FieldValue = admin.firestore.FieldValue
-export const FieldPath = admin.firestore.FieldPath
-export type FieldPath = admin.firestore.FieldPath
-export type DocumentData = admin.firestore.DocumentData
-export type QueryDocumentSnapshot = admin.firestore.QueryDocumentSnapshot
-export type DocumentSnapshot = admin.firestore.DocumentSnapshot
-export type QuerySnapshot = admin.firestore.QuerySnapshot
+export { Timestamp, FieldValue, FieldPath }
+export type {
+  DocumentData,
+  QueryDocumentSnapshot,
+  DocumentSnapshot,
+  QuerySnapshot
+}
 
-// Extreme hack to extract the File type from the admin storage package. For
-// some reason admin.storage does not resolve the storage namespace, as
-// admin.firestore does.
+// Extreme hack to extract the File type from the admin storage package.
 export type File = ReturnType<
-  ReturnType<ReturnType<typeof admin.storage>["bucket"]>["file"]
+  ReturnType<ReturnType<typeof getStorage>["bucket"]>["file"]
 >
diff --git a/functions/src/notifications/cleanupNotifications.ts b/functions/src/notifications/cleanupNotifications.ts
@@ -1,11 +1,11 @@
 import * as functions from "firebase-functions"
-import * as admin from "firebase-admin"
+import { getFirestore } from "firebase-admin/firestore"
 import { Timestamp } from "../firebase"
 
 const RETENTION_PERIOD_DAYS = 60
 
 // Get a reference to the Firestore database
-const db = admin.firestore()
+const db = getFirestore()
 
 // TODO
 // 1.) Do we actually want to delete old notifications? (check with Matt V)
diff --git a/functions/src/notifications/populateBillHistoryNotificationEvents.ts b/functions/src/notifications/populateBillHistoryNotificationEvents.ts
@@ -5,12 +5,12 @@
 
 // Import necessary Firebase modules
 import * as functions from "firebase-functions"
-import * as admin from "firebase-admin"
+import { getFirestore } from "firebase-admin/firestore"
 import { Timestamp } from "../firebase"
 import { BillHistoryUpdateNotification } from "./types"
 
 // Get a reference to the Firestore database
-const db = admin.firestore()
+const db = getFirestore()
 
 // Define the populateBillNotificationEvents function
 export const populateBillHistoryNotificationEvents = functions.firestore
diff --git a/functions/src/notifications/populateTestimonySubmissionNotificationEvents.ts b/functions/src/notifications/populateTestimonySubmissionNotificationEvents.ts
@@ -5,12 +5,12 @@
 
 // Import necessary Firebase modules
 import * as functions from "firebase-functions"
-import * as admin from "firebase-admin"
+import { getFirestore } from "firebase-admin/firestore"
 import { Timestamp } from "../firebase"
 import { TestimonySubmissionNotification } from "./types"
 
 // Get a reference to the Firestore database
-const db = admin.firestore()
+const db = getFirestore()
 
 // Define the populateOrgNotificationEvents function
 export const populateTestimonySubmissionNotificationEvents = functions.firestore
diff --git a/functions/src/notifications/publishNotifications.ts b/functions/src/notifications/publishNotifications.ts
@@ -5,7 +5,7 @@
 
 // Import necessary Firebase modules
 import * as functions from "firebase-functions"
-import * as admin from "firebase-admin"
+import { getFirestore } from "firebase-admin/firestore"
 import { Timestamp } from "../firebase"
 import {
   BillHistoryUpdateNotification,
@@ -16,7 +16,7 @@ import {
 import { cloneDeep } from "lodash"
 
 // Get a reference to the Firestore database
-const db = admin.firestore()
+const db = getFirestore()
 
 const createNotificationFields = (
   entity: BillHistoryUpdateNotification | TestimonySubmissionNotification
diff --git a/functions/src/types.ts b/functions/src/types.ts
@@ -1,10 +1,11 @@
-import type * as firebase from "./firebase"
+import { auth, db } from "./firebase"
 import type * as api from "./malegislature"
+import { app } from "./firebase"
 
-export type Database = typeof firebase.db
-export type Admin = typeof firebase.admin
-export type Auth = typeof firebase.auth
-export type Firebase = typeof firebase
+export type Database = typeof db
+export type Admin = typeof auth
+export type Auth = typeof auth
+export type Firebase = typeof app
 export type Api = typeof api
 
 export type Context = {
diff --git a/package.json b/package.json
@@ -91,6 +91,7 @@
     "dompurify": "^2.3.10",
     "express": "^4.18.2",
     "firebase": "9.6.10",
+    "firebase-admin": "^11.11.1",
     "fuse.js": "6.5.3",
     "handlebars": "^4.7.8",
     "i18next": "^23.5.1",
@@ -176,7 +177,6 @@
     "eslint-plugin-i18next": "^6.0.3",
     "eslint-plugin-jsx-a11y": "^6.9.0",
     "file-loader": "^6.2.0",
-    "firebase-admin": "^11.11.1",
     "firebase-tools": "^13.23.0",
     "ini": "^1.3.5",
     "inquirer": "^6.5.1",
@@ -200,4 +200,4 @@
   "resolutions": {
     "jackspeak": "2.1.1"
   }
-}
+}
diff --git a/tests/integration/backfillTestimonyCounts.test.ts b/tests/integration/backfillTestimonyCounts.test.ts
@@ -1,6 +1,3 @@
-/**
- * @jest-environment node
- */
 import { waitFor } from "@testing-library/react"
 import axios from "axios"
 import { currentGeneralCourt } from "functions/src/shared"
diff --git a/tests/integration/profile.test.ts b/tests/integration/profile.test.ts
@@ -1,6 +1,3 @@
-/**
- * @jest-environment node
- */
 import { waitFor } from "@testing-library/react"
 import { signInWithEmailAndPassword } from "firebase/auth"
 import { deleteDoc, doc, getDoc, setDoc, updateDoc } from "firebase/firestore"
diff --git a/tests/integration/search.test.ts b/tests/integration/search.test.ts
@@ -1,6 +1,3 @@
-/**
- * @jest-environment node
- */
 import { DocumentSnapshot } from "@google-cloud/firestore"
 import { waitFor } from "@testing-library/react"
 import axios from "axios"
diff --git a/tests/integration/testimony.test.ts b/tests/integration/testimony.test.ts
@@ -1,14 +1,11 @@
-/**
- * @jest-environment node
- */
 import { currentGeneralCourt } from "functions/src/shared"
-import { getAuth, signOut, User } from "firebase/auth"
+import { signOut, User } from "firebase/auth"
 import { doc, getDoc, setDoc, Timestamp, updateDoc } from "firebase/firestore"
 import { httpsCallable } from "firebase/functions"
 import { ref, uploadBytes } from "firebase/storage"
 import { nanoid } from "nanoid"
 import { auth, firestore, functions, storage } from "../../components/firebase"
-import { terminateFirebase, testAuth, testDb, testStorage } from "../testUtils"
+import { terminateFirebase, testDb, testStorage } from "../testUtils"
 import {
   createFakeBill,
   expectPermissionDenied,
diff --git a/tests/jest.integration.config.ts b/tests/jest.integration.config.ts
@@ -14,6 +14,14 @@ const config: Config.InitialOptions = {
     "<rootDir>/tests/seed",
     "<rootDir>/functions"
   ],
+  moduleNameMapper: {
+    // This maps firebase-admin/auth to the correct location within node_modules
+    "^firebase-admin/auth$":
+      "<rootDir>/node_modules/firebase-admin/lib/auth/index.js",
+    "^firebase-admin/app$":
+      "<rootDir>/node_modules/firebase-admin/lib/app/index.js",
+    "^firebase-admin/(.*)$": "<rootDir>/node_modules/firebase-admin/lib/$1"
+  },
   setupFilesAfterEnv: ["<rootDir>/tests/setup.integration.ts"],
   modulePaths: ["<rootDir>"],
   reporters: ["default", ["jest-summary-reporter", { failuresOnly: false }]]
diff --git a/tests/setup.integration.ts b/tests/setup.integration.ts
@@ -1,5 +1,7 @@
 export {}
+import { TextEncoder, TextDecoder } from "util"
 
+Object.assign(global, { TextDecoder, TextEncoder })
 jest.mock("../components/db/common", () => {
   const actualModule = jest.requireActual("../components/db/common")
   return {
diff --git a/tests/testUtils.ts b/tests/testUtils.ts
@@ -1,18 +1,24 @@
-import * as admin from "firebase-admin"
+import { initializeApp } from "firebase-admin/app"
+import { getFirestore } from "firebase-admin/firestore"
+import { getStorage } from "firebase-admin/storage"
+import { getAuth } from "firebase-admin/auth"
 import { deleteApp } from "firebase/app"
 import { clearIndexedDbPersistence, terminate } from "firebase/firestore"
 import { app, firestore } from "../components/firebase"
+import { Timestamp } from "functions/src/firebase"
 
-admin.initializeApp({
-  storageBucket: `${process.env.GCLOUD_PROJECT}.appspot.com`
-})
+const testApp = initializeApp(
+  {
+    storageBucket: `${process.env.GCLOUD_PROJECT}.appspot.com`
+  },
+  "testApp"
+)
 
-export const testDb = admin.firestore()
-export const testStorage = admin.storage()
-export const testAuth = admin.auth()
+export const testDb = getFirestore(testApp)
+export const testStorage = getStorage(testApp)
+export const testAuth = getAuth(testApp)
 
-export const testTimestamp = admin.firestore.Timestamp
-export { admin as testAdmin }
+export const testTimestamp = Timestamp
 
 export async function terminateFirebase() {
   await deleteApp(app)
@@ -28,5 +34,4 @@ export async function terminateFirebase() {
 
   // Clean up the admin interface
   await testDb.terminate()
-  await admin.firestore().terminate()
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import type { UserRecord } from "firebase-admin/lib/auth/user-record"`
	`1`	`+import { UserRecord } from "firebase-admin/auth"`
`2`	`2`	`import { Undefined } from "runtypes"`
`3`	`3`	`import { Profile } from "../profile/types"`
`4`	`4`	`import { Auth, Database } from "../types"`