chore: fix some lint errors

Author: cabljac

eslint.config.js

@@ -5,5 +5,8 @@ const tseslint = require("typescript-eslint");
 
 module.exports = tseslint.config(
   eslint.configs.recommended,
-  ...tseslint.configs.strict
+  ...tseslint.configs.strict,
+  {
+    ignores: ["node_modules/", "lib/", "**/*.js"],
+  }
 );

src/common/process.ts

@@ -4,7 +4,7 @@ interface ProcessOptions {
   id: string;
   fieldDependencyArray?: string[];
   shouldBackfill?: (data: Record<string, FirestoreField>) => boolean;
-  errorFn?: (e: unknown) => string | void | Promise<string | void>;
+  errorFn?: (e: unknown) => string | undefined | Promise<string | undefined>;
   batchFn?: (
     data: Record<string, FirestoreField>[]
   ) => Promise<Record<string, FirestoreField>[]>;
@@ -18,7 +18,9 @@ type ProcessFunction = (
   data: Record<string, FirestoreField>
 ) => Record<string, FirestoreField> | Promise<Record<string, FirestoreField>>;
 type ShouldBackfillFunction = (data: Record<string, FirestoreField>) => boolean;
-type ErrorFunction = (e: unknown) => string | void | Promise<string | void>;
+type ErrorFunction = (
+  e: unknown
+) => string | undefined | Promise<string | undefined>;
 type BatchFunction = (
   data: Record<string, FirestoreField>[]
 ) => Promise<Record<string, FirestoreField>[]>;

src/distributed-tasks/firestore_backfill/handler_from_process.test.ts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
 import * as admin from "firebase-admin";
 import { Process } from "../../common/process";
 import { getValidDocs } from "./handler_from_process";
@@ -10,7 +12,9 @@ admin.initializeApp({
   projectId: "demo-gcp",
 });
 
-const firestoreObserver = jest.fn((_x: any) => {});
+const firestoreObserver = jest.fn((x: any) => {
+  console.debug("firestoreObserver", x);
+});
 
 describe.skip("getValidDocs", () => {
   let unsubscribe: (() => void) | undefined;
@@ -55,7 +59,10 @@ describe.skip("getValidDocs", () => {
 
     const process = new Process((data) => data, {
       id: "testProcess",
-      shouldBackfill: (data) => true,
+      shouldBackfill: (data) => {
+        console.debug("shouldBackfill", data);
+        return true;
+      },
     });
 
     const documentIds = ["doc1", "doc2", "doc3"];

src/distributed-tasks/firestore_backfill/handler_from_process.ts

@@ -84,7 +84,7 @@ export async function getValidDocs(
     //@ts-ignore
     const docs = await transaction.getAll<DocumentData>(...refs);
 
-    for (let doc of docs) {
+    for (const doc of docs) {
       const data = doc.data();
       if (!process.shouldBackfill || !process.shouldBackfill(data)) {
         functions.logger.warn(

src/distributed-tasks/firestore_backfill/metadata_document.test.ts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
 import * as admin from "firebase-admin";
 import { Timestamp } from "firebase-admin/firestore";
 import fetch from "node-fetch";
@@ -16,8 +18,9 @@ admin.initializeApp({
   projectId: "demo-gcp",
 });
 
-const firestoreObserver = jest.fn((_x: any) => {});
-let collectionName: string;
+const firestoreObserver = jest.fn((x: any) => {
+  console.debug("firestoreObserver", x);
+});
 
 describe("createMetadataDoc", () => {
   let unsubscribe: (() => void) | undefined;
@@ -182,8 +185,8 @@ describe("getMetadataDoc", () => {
     const metadataDoc = await getMetadataDoc(metadataDocumentPath, metadata);
 
     expect(metadataDoc).not.toBeNull();
-    expect(metadataDoc!.exists).toBeTruthy();
-    expect(metadataDoc!.data()).toEqual(metadata);
+    expect(metadataDoc?.exists).toBeTruthy();
+    expect(metadataDoc?.data()).toEqual(metadata);
   });
 
   test("should return null if metadata doc does not exist", async () => {

src/distributed-tasks/firestore_backfill/metadata_document.ts

@@ -71,7 +71,5 @@ export const updateOrCreateMetadataDoc = async (
 
   const doc = await createMetadataDoc(metadataDocumentPath, metadata);
 
-  shouldBackfill = shouldBackfill;
-
   return { path: doc.path, shouldBackfill };
 };

src/distributed-tasks/firestore_backfill/types.ts

@@ -1,9 +1,12 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
 import { FirestoreField } from "../../common/types";
 
 export interface FirestoreBackfillOptions {
   queueName: string;
   metadataDocumentPath: string;
   collectionName: string;
+  // TODO: remove any
   shouldDoBackfill: (data: Record<string, any>) => Promise<boolean>;
   extensionInstanceId?: string;
   metadata?: Record<string, FirestoreField>;

src/distributed-tasks/handler.ts

@@ -56,8 +56,11 @@ export function taskThreadTaskHandler<P>(
     );
 
     const tasksDocSnap = await admin.firestore().doc(tasksDoc).get();
-    const { totalLength } = tasksDocSnap.data() as any;
-    let { processedLength } = tasksDocSnap.data() as any;
+    // TODO: validate this
+    const { totalLength } = tasksDocSnap.data() as { totalLength: number };
+    let { processedLength } = tasksDocSnap.data() as {
+      processedLength: number;
+    };
 
     processedLength += success;
 

src/distributed-tasks/trigger.ts

@@ -43,7 +43,7 @@ export async function taskThreadTrigger<P>({
   extensionInstanceId,
   taskParams,
 }: BackfillTrigger<P>) {
-  let runtime = extensionInstanceId ? getExtensions().runtime() : undefined;
+  const runtime = extensionInstanceId ? getExtensions().runtime() : undefined;
 
   const queue = getFunctions().taskQueue(queueName, extensionInstanceId);