Fix linting issues and type safety checks (google#2366)

Author: rfontanarosa

functions/src/common/auth.ts

@@ -16,7 +16,7 @@
 
 import { DecodedIdToken, getAuth } from 'firebase-admin/auth';
 import { DocumentSnapshot } from 'firebase-admin/firestore';
-import { https, Response } from 'firebase-functions/v1';
+import { Response, https } from 'firebase-functions/v1';
 import { EmulatorIdToken } from '../handlers';
 import { GroundProtos } from '@ground/proto';
 import { registry } from '@ground/lib';

functions/src/common/context.ts

@@ -16,7 +16,7 @@
 
 import { Datastore } from './datastore';
 import { MailService } from './mail-service';
-import { initializeApp, getApp } from 'firebase-admin/app';
+import { getApp, initializeApp } from 'firebase-admin/app';
 import { getFirestore } from 'firebase-admin/firestore';
 
 let datastore: Datastore | undefined;
@@ -25,7 +25,7 @@ let mailService: MailService | undefined;
 export function initializeFirebaseApp() {
   try {
     getApp();
-  } catch (e) {
+  } catch {
     initializeApp();
   }
 }
@@ -39,9 +39,8 @@ export function getDatastore(): Datastore {
 
 export async function getMailService(): Promise<MailService | undefined> {
   if (mailService) return mailService;
-  const mailServerConfig = await MailService.getMailServerConfig(
-    getDatastore()
-  );
+  const mailServerConfig =
+    await MailService.getMailServerConfig(getDatastore());
   if (!mailServerConfig) return;
   mailService = new MailService(mailServerConfig);
   return mailService;

functions/src/common/datastore.ts

@@ -21,7 +21,7 @@ import { registry } from '@ground/lib';
 import { GroundProtos } from '@ground/proto';
 
 import Pb = GroundProtos.ground.v1beta1;
-import { leftOuterJoinSorted, QueryIterator } from './query-iterator';
+import { QueryIterator, leftOuterJoinSorted } from './query-iterator';
 
 const l = registry.getFieldIds(Pb.LocationOfInterest);
 const sb = registry.getFieldIds(Pb.Submission);

functions/src/common/query-iterator.ts

@@ -34,7 +34,10 @@ export class QueryIterator implements AsyncIterator<QueryDocumentSnapshot> {
    * @param query The Firestore query to iterate over.
    * @param pageSize The number of documents to fetch in each batch.
    */
-  constructor(private query: Query, private pageSize: number) {}
+  constructor(
+    private query: Query,
+    private pageSize: number
+  ) {}
 
   /**
    * Fetches the next batch of documents and returns the next document in the iterator.

functions/src/handlers.ts

@@ -16,7 +16,7 @@
 
 import cors from 'cors';
 import { DecodedIdToken } from 'firebase-admin/auth';
-import { https, Response } from 'firebase-functions';
+import { Response, https } from 'firebase-functions';
 import { getDecodedIdToken } from './common/auth';
 import { INTERNAL_SERVER_ERROR, UNAUTHORIZED } from 'http-status-codes';
 import cookieParser from 'cookie-parser';

functions/src/import-geojson.ts

@@ -22,7 +22,7 @@ import JSONStream from 'jsonstream-ts';
 import { canImport } from './common/auth';
 import { DecodedIdToken } from 'firebase-admin/auth';
 import { GroundProtos } from '@ground/proto';
-import { toDocumentData, toGeometryPb, isGeometryValid } from '@ground/lib';
+import { isGeometryValid, toDocumentData, toGeometryPb } from '@ground/lib';
 import { Feature, GeoJsonProperties } from 'geojson';
 import { ErrorHandler } from './handlers';
 

functions/src/on-create-loi.ts

@@ -120,7 +120,6 @@ async function fetchWhispProperties(
   headers: Headers,
   body: Body
 ): Promise<Properties> {
-  // eslint-disable-next-line n/no-unsupported-features/node-builtins
   const response = await fetch(url, {
     method: 'POST',
     headers,

functions/src/on-create-passlist-entry.spec.ts

@@ -21,12 +21,13 @@ import {
   stubAdminApi,
 } from '@ground/lib/testing/firestore';
 import { resetDatastore } from './common/context';
-import { Firestore } from 'firebase-admin/firestore';
+import { Firestore, QueryDocumentSnapshot } from 'firebase-admin/firestore';
+import firebaseFunctionsTest from 'firebase-functions-test';
 import * as functions from './index';
 import * as context from './common/context';
 import { MailService } from './common/mail-service';
 
-const test = require('firebase-functions-test')();
+const test = firebaseFunctionsTest();
 
 describe('onCreatePasslistEntry()', () => {
   let mockFirestore: Firestore;
@@ -65,7 +66,9 @@ describe('onCreatePasslistEntry()', () => {
 
   it('passlist notification email template exists', async () => {
     await mockFirestore.collection('passlists').add({});
-    await test.wrap(functions.onCreatePasslistEntry)(newDocumentSnapshot({}));
+    await test.wrap(functions.onCreatePasslistEntry)(
+      newDocumentSnapshot({}) as QueryDocumentSnapshot
+    );
     expect(getMailServiceMock).not.toHaveBeenCalled();
   });
 
@@ -84,7 +87,7 @@ describe('onCreatePasslistEntry()', () => {
     mockFirestore.doc('config/mail/templates/passlisted').set(mail);
     mockFirestore.doc(`passlists/${mail.to}`).set({});
     await test.wrap(functions.onCreatePasslistEntry)(
-      newDocumentSnapshot({}),
+      newDocumentSnapshot({}) as QueryDocumentSnapshot,
       newEventContext({ entryId: mail.to })
     );
     expect(getMailServiceMock).toHaveBeenCalled();

functions/src/on-write-submission.spec.ts

@@ -15,20 +15,21 @@
  */
 
 import {
-  stubAdminApi,
-  newEventContext,
-  newDocumentSnapshot,
-  newCountQuery,
   createMockFirestore,
+  newCountQuery,
+  newDocumentSnapshot,
+  newEventContext,
+  stubAdminApi,
 } from '@ground/lib/testing/firestore';
 import * as functions from './index';
 import { loi } from './common/datastore';
-import { Firestore } from 'firebase-admin/firestore';
+import { DocumentSnapshot, Firestore } from 'firebase-admin/firestore';
+import firebaseFunctionsTest from 'firebase-functions-test';
 import { resetDatastore } from './common/context';
 import { registry } from '@ground/lib';
 import { GroundProtos } from '@ground/proto';
 
-const test = require('firebase-functions-test')();
+const test = firebaseFunctionsTest();
 
 import Pb = GroundProtos.ground.v1beta1;
 const l = registry.getFieldIds(Pb.LocationOfInterest);
@@ -77,7 +78,7 @@ describe('onWriteSubmission()', () => {
     installSubmissionCountSpy(SUBMISSIONS_PATH, LOI_ID, 2);
 
     await test.wrap(functions.onWriteSubmission)(
-      { before: undefined, after: SUBMISSION },
+      { before: null as unknown as DocumentSnapshot, after: SUBMISSION },
       CONTEXT
     );
 
@@ -89,7 +90,7 @@ describe('onWriteSubmission()', () => {
     installSubmissionCountSpy(SUBMISSIONS_PATH, LOI_ID, 1);
 
     await test.wrap(functions.onWriteSubmission)(
-      { before: SUBMISSION, after: undefined },
+      { before: SUBMISSION, after: null as unknown as DocumentSnapshot },
       CONTEXT
     );
 
@@ -101,7 +102,10 @@ describe('onWriteSubmission()', () => {
     installSubmissionCountSpy(SUBMISSIONS_PATH, LOI_ID, 1);
 
     await test.wrap(functions.onWriteSubmission)(
-      { before: undefined, after: undefined },
+      {
+        before: null as unknown as DocumentSnapshot,
+        after: null as unknown as DocumentSnapshot,
+      },
       CONTEXT
     );
 
@@ -119,7 +123,7 @@ describe('onWriteSubmission()', () => {
 
     await expectAsync(
       test.wrap(functions.onWriteSubmission)(
-        { before: undefined, after: SUBMISSION },
+        { before: null as unknown as DocumentSnapshot, after: SUBMISSION },
         CONTEXT
       )
     ).toBeRejected();

functions/src/profile-refresh.ts

@@ -18,7 +18,7 @@ import { getDatastore } from './common/context';
 import { CallableRequest, HttpsError } from 'firebase-functions/v2/https';
 import { getAuth } from 'firebase-admin/auth';
 
-type ProfileRefreshResponse = String | HttpsError;
+type ProfileRefreshResponse = string | HttpsError;
 type ProfileRefreshRequest = CallableRequest<ProfileRefreshResponse>;
 
 /**