Lint no floating promises 2 (#370)

alexfarrill · web-flow · commit 4fe6211ac72d · 2022-12-01T14:01:29.000-08:00
* await creating the default list * for completeness: also assert organization * lint for await * ooops - put the eslint config for ts in the right place * eslint should ignore .mailing directories * add tsconfig's to parserOptions.project in @typescript-eslint/parser block * await async functions * don't ignore __test__ from tsconfig in core * linter says that this expect must be awaited * tsconfig covers all the .ts files in the root directory: jest.config.ts testSetup.integration.ts testUtilIntegration.ts jest.integration.config.ts testSetup.ts * tsconfig should include e2e/**/* * src/cli/generator_templates/**/* is not a directory in packages/cli * await some async functions * we're using plain js in e2e/mailing_tests so don't need a tsconfig * fix typo * await analytics calls * eslintignore these 2 files: packages/cli/src/generator_templates packages/cli/src/emails because they are ignored in tsconfig.json * update files attribute in package.json * don't actually want to ignore those * this is my workaround for typescript-eslint/typescript-eslint#2987 * noop? * simplify tsconfigs? * fix all the lints * oops * try void * async await * smaller change * fix server build * Revert "fix server build" This reverts commit e24e0ed. * await -> void in init * remove trailing comma in json * cypress does not actually need to reset the web db, so remove * server: try cd into .mailing and then npx next build with the current directory * pull posthog api key into its own file so it does not bloat the next build by pulling in posthog-node * import from the righ tplaÿce
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -35,13 +35,23 @@
     {
       "files": ["**/*.ts", "**/*.tsx"],
       "parser": "@typescript-eslint/parser",
+      "parserOptions": {
+        "project": [
+          "./tsconfig.json",
+          "./packages/cli/tsconfig.json",
+          "./packages/core/tsconfig.json",
+          "./packages/web/tsconfig.json",
+          "./packages/cli/cypress/tsconfig.json"
+        ]
+      },
       "plugins": ["@typescript-eslint"],
       "extends": [
         "eslint:recommended",
         "plugin:@typescript-eslint/recommended"
       ],
       "rules": {
         "no-unused-vars": "off",
+        "@typescript-eslint/no-floating-promises": "error",
         "@typescript-eslint/no-explicit-any": "off",
         "@typescript-eslint/no-unused-vars": [
           "error",
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,4 +1,6 @@
 #!/usr/bin/env sh
 . "$(dirname "$0")/_/husky.sh"
 
+yarn lint:unlink
 yarn lint-staged
+yarn lint:link
diff --git a/.lintstagedrc b/.lintstagedrc
@@ -3,4 +3,3 @@
   "*.rb": "rubocop --autocorrect",
   "packages/cli/src/generator_templates/ts/**/*.{ts,tsx}": "scripts/build-js-templates"
 }
-
diff --git a/e2e/mailing_tests/cypress/tsconfig.json b/e2e/mailing_tests/cypress/tsconfig.json
diff --git a/package.json b/package.json
@@ -9,7 +9,9 @@
     "packages/*"
   ],
   "scripts": {
-    "lint": "eslint .",
+    "lint": "yarn lint:unlink; eslint .; yarn lint:link",
+    "lint:unlink": "rm packages/cli/src/emails",
+    "lint:link": "ln -s 'generator_templates/ts/emails/' packages/cli/src/emails",
     "dev": "cd packages/cli && yarn dev",
     "dev:js": "yarn link:emails:js && yarn dev",
     "dev:init": "cd packages/cli && rm -rf previews_html; rm -rf .mailing emails mailing.config.json; src/dev.js",
diff --git a/packages/cli/cypressIntegration.config.ts b/packages/cli/cypressIntegration.config.ts
@@ -1,7 +1,9 @@
 import { defineConfig } from "cypress";
 import cliPrisma from "./prisma";
-import webPrisma from "../../packages/web/prisma";
-import type { PrismaTableName } from "../../testUtilIntegration";
+
+interface PrismaTableName {
+  table_name: string;
+}
 
 const resetDb = async () => {
   await truncateDatabases();
@@ -31,12 +33,8 @@ export async function truncateCliDatabase() {
   await truncateTables(cliPrisma);
 }
 
-export async function truncateWebDatabase() {
-  await truncateTables(webPrisma);
-}
-
 export async function truncateDatabases() {
-  return Promise.all([truncateCliDatabase(), truncateWebDatabase()]);
+  await truncateCliDatabase();
 }
 
 async function truncateTables(client: any) {
diff --git a/packages/cli/src/commands/init.ts b/packages/cli/src/commands/init.ts
@@ -86,7 +86,7 @@ export const handler = buildHandler(
           try {
             const url = `${getMailingAPIBaseURL()}/api/newsletterSubscribers`;
 
-            fetch(url, {
+            void fetch(url, {
               method: "POST",
               headers: { "Content-Type": "application/json" },
               body: JSON.stringify({ email }),
@@ -109,7 +109,7 @@ export const handler = buildHandler(
       _: argv._,
     };
 
-    previewHandler(previewHandlerArgv);
+    await previewHandler(previewHandlerArgv);
   },
   {
     captureOptions: () => {
diff --git a/packages/cli/src/commands/preview/server/__integration__/livereload.test.ts b/packages/cli/src/commands/preview/server/__integration__/livereload.test.ts
@@ -34,7 +34,7 @@ describe("livereload", () => {
         done();
       });
 
-      touchTemplate();
+      void touchTemplate();
     });
   });
 });
diff --git a/packages/cli/src/commands/preview/server/livereload.ts b/packages/cli/src/commands/preview/server/livereload.ts
@@ -50,7 +50,7 @@ export function startChangeWatcher(server: Server, emailsDir: string) {
         if (WATCH_IGNORE.test(filename)) return;
         log(`detected ${eventType} on ${filename}, reloading`);
         delete require.cache[resolve(changeWatchPath, filename)];
-        reload();
+        void reload();
       }
     );
 
diff --git a/packages/cli/src/commands/server.ts b/packages/cli/src/commands/server.ts
@@ -66,7 +66,7 @@ export const handler = buildHandler(
           stdio: "inherit",
         });
 
-      execSync("npx next build .mailing", {
+      execSync("cd .mailing && npx next build", {
         stdio: "inherit",
       });
     }
diff --git a/packages/cli/src/components/IndexPane/hooks/usePreviewTree.ts b/packages/cli/src/components/IndexPane/hooks/usePreviewTree.ts
@@ -13,7 +13,7 @@ export type TreeRoute = {
 
 const safeReplaceState = debounce((router: NextRouter | null, path: string) => {
   try {
-    router?.replace(path, undefined, { shallow: true });
+    void router?.replace(path, undefined, { shallow: true });
   } catch (e) {
     // Debounce should be avoiding this error, but catch just in case:
     // SecurityError: Attempt to use history.replaceState() more than 100 times per 30 seconds
diff --git a/packages/cli/src/components/PosthogScript.tsx b/packages/cli/src/components/PosthogScript.tsx
@@ -1,4 +1,4 @@
-import { POSTHOG_API_KEY } from "../util/postHog/client";
+import { POSTHOG_API_KEY } from "../util/postHog/posthogApiKey";
 
 export default function PosthogScript() {
   if (process.env.NODE_ENV !== "production") {
diff --git a/packages/cli/src/components/PreviewViewer.tsx b/packages/cli/src/components/PreviewViewer.tsx
@@ -49,7 +49,7 @@ const PreviewViewer: React.FC<PreviewViewerProps> = ({ initialData }) => {
 
   const fetchData = useCallback(async () => {
     // fire this one async, no loader
-    fetchPreviews();
+    await fetchPreviews();
 
     if (!(previewClass && previewFunction)) {
       setData((data: Data) => ({
diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts
@@ -13,7 +13,7 @@ const config = existsSync(MAILING_CONFIG_FILE)
   : {};
 
 // prettier-ignore
-yargs(process.argv.slice(2))
+void yargs(process.argv.slice(2))
   .config(config)
   .command(init)
   .command(preview)
diff --git a/packages/cli/src/pages/api/lists/index.ts b/packages/cli/src/pages/api/lists/index.ts
@@ -71,10 +71,10 @@ const ApiLists = withSessionAPIRoute(async function (
 
   switch (req.method) {
     case "GET":
-      handleGetLists(user, req, res);
+      await handleGetLists(user, req, res);
       break;
     case "POST":
-      handleCreateList(user, req, res);
+      await handleCreateList(user, req, res);
       break;
     default:
       return res.status(404).end();
diff --git a/packages/cli/src/pages/api/pageSnap.ts b/packages/cli/src/pages/api/pageSnap.ts
@@ -24,7 +24,7 @@ export default async function PageSnap(
 
     // Create a page with the Open Graph image size best practice
     const page = await context.newPage();
-    page.setViewportSize({ width: 1200, height: 630 });
+    await page.setViewportSize({ width: 1200, height: 630 });
     await page.goto(url, { timeout: 15 * 1000, waitUntil: "networkidle" });
     // Press Command+Period to go full screen
     await page.keyboard.press("Meta+.");
diff --git a/packages/cli/src/pages/intercepts/[interceptId].tsx b/packages/cli/src/pages/intercepts/[interceptId].tsx
@@ -10,7 +10,7 @@ const ShowIntercept = () => {
     setData(await res.json());
   }, [query.interceptId]);
   useEffect(() => {
-    if (query.interceptId) fetchData();
+    if (query.interceptId) void fetchData();
   }, [query.interceptId, fetchData]);
 
   return <Intercept data={data} />;
diff --git a/packages/cli/src/pages/unsubscribe/[memberId].tsx b/packages/cli/src/pages/unsubscribe/[memberId].tsx
@@ -221,11 +221,11 @@ const Unsubscribe = (props: UnsubscribeProps) => {
 
   // the "Subscribe" or "Unsubscribe" button was clicked on the form with only the default list
   const subscribeUnsubscribeButtonClick = useCallback(
-    (e: React.MouseEvent<HTMLElement>) => {
+    async (e: React.MouseEvent<HTMLElement>) => {
       e.preventDefault();
       setFormSaving(true);
       const newFormState = onChange(defaultList.id, true)();
-      serializeAndSubmitForm(newFormState);
+      await serializeAndSubmitForm(newFormState);
     },
     [defaultList.id, onChange, serializeAndSubmitForm]
   );
diff --git a/packages/cli/src/util/analytics/__test__/analytics.test.ts b/packages/cli/src/util/analytics/__test__/analytics.test.ts
@@ -22,8 +22,8 @@ describe("analytics", () => {
   });
 
   describe("#trackMany", () => {
-    it("should call fetch with the correct arguments", () => {
-      analytics.trackMany([
+    it("should call fetch with the correct arguments", async () => {
+      await analytics.trackMany([
         { event: "test.event.one", properties: { foo: "bar.one" } },
         { event: "test.event.two", properties: { foo: "bar.two" } },
       ]);
@@ -75,8 +75,11 @@ describe("analytics", () => {
   });
 
   describe("#track", () => {
-    it("should call fetch with the correct arguments", () => {
-      analytics.track({ event: "test.event", properties: { foo: "bar" } });
+    it("should call fetch with the correct arguments", async () => {
+      await analytics.track({
+        event: "test.event",
+        properties: { foo: "bar" },
+      });
       expect(fetch).toHaveBeenCalledTimes(2);
 
       // Axiom call
diff --git a/packages/cli/src/util/analytics/providers/__test__/Axiom.test.ts b/packages/cli/src/util/analytics/providers/__test__/Axiom.test.ts
@@ -10,8 +10,8 @@ describe("Axiom", () => {
   });
 
   describe("#trackMany", () => {
-    it("should call fetch with the correct arguments", () => {
-      axiom.trackMany([
+    it("should call fetch with the correct arguments", async () => {
+      await axiom.trackMany([
         { event: "test.event.one", properties: { foo: "bar.one" } },
         { event: "test.event.two", properties: { foo: "bar.two" } },
       ]);
@@ -40,8 +40,8 @@ describe("Axiom", () => {
   });
 
   describe("#track", () => {
-    it("should call fetch with the correct arguments", () => {
-      axiom.track({ event: "test.event", properties: { foo: "bar" } });
+    it("should call fetch with the correct arguments", async () => {
+      await axiom.track({ event: "test.event", properties: { foo: "bar" } });
       expect(fetch).toHaveBeenCalledTimes(1);
       expect(fetch).toHaveBeenCalledWith(
         "https://cloud.axiom.co/api/v1/datasets/datasetName/ingest",
diff --git a/packages/cli/src/util/analytics/providers/__test__/Posthog.test.ts b/packages/cli/src/util/analytics/providers/__test__/Posthog.test.ts
@@ -10,8 +10,8 @@ describe("Posthog", () => {
   });
 
   describe("#trackMany", () => {
-    it("should call fetch with the correct arguments", () => {
-      posthog.trackMany([
+    it("should call fetch with the correct arguments", async () => {
+      await posthog.trackMany([
         { event: "test.event.one", properties: { foo: "bar.one" } },
         { event: "test.event.two", properties: { foo: "bar.two" } },
       ]);
@@ -39,8 +39,8 @@ describe("Posthog", () => {
   });
 
   describe("#track", () => {
-    it("should call fetch with the correct arguments", () => {
-      posthog.track({ event: "test.event", properties: { foo: "bar" } });
+    it("should call fetch with the correct arguments", async () => {
+      await posthog.track({ event: "test.event", properties: { foo: "bar" } });
       expect(fetch).toHaveBeenCalledTimes(1);
       expect(fetch).toHaveBeenCalledWith("https://app.posthog.com/capture/", {
         method: "POST",
diff --git a/packages/cli/src/util/buildHandler.ts b/packages/cli/src/util/buildHandler.ts
@@ -16,7 +16,7 @@ type BuildHandlerOptions = {
 };
 
 export function buildHandler(
-  handler: (argv: any) => void,
+  handler: (argv: any) => Promise<void>,
   options: BuildHandlerOptions
 ) {
   return async (argv: any) => {
@@ -51,7 +51,7 @@ export function buildHandler(
 
       await handler(argv);
     } finally {
-      shutdownAnalytics();
+      await shutdownAnalytics();
     }
   };
 }
diff --git a/packages/cli/src/util/postHog/client.ts b/packages/cli/src/util/postHog/client.ts
@@ -1,6 +1,5 @@
 import { PostHog } from "posthog-node";
-
-export const POSTHOG_API_KEY = process.env.POSTHOG_API_KEY;
+import { POSTHOG_API_KEY } from "./posthogApiKey";
 
 let client: PostHog | undefined;
 
diff --git a/packages/cli/src/util/postHog/posthogApiKey.ts b/packages/cli/src/util/postHog/posthogApiKey.ts
@@ -0,0 +1 @@
+export const POSTHOG_API_KEY = process.env.POSTHOG_API_KEY;
diff --git a/packages/cli/tsconfig.json b/packages/cli/tsconfig.json
@@ -21,11 +21,9 @@
     "baseUrl": "./"
   },
   "$schema": "https://json.schemastore.org/tsconfig",
-  "include": ["src/**/*.ts", "src/**/*.tsx", "prisma/**/*.ts"],
+  "include": ["./*.ts", "src/**/*.ts", "src/**/*.tsx", "prisma/**/*.ts"],
   "exclude": [
-    "src/emails/**/*",
     "dist/**/*",
-    "src/cli/generator_templates/**/*",
     "node_modules"
   ]
 }
diff --git a/packages/core/src/__test__/index.test.tsx b/packages/core/src/__test__/index.test.tsx
@@ -34,7 +34,7 @@ describe("index", () => {
   });
 
   describe("subject", () => {
-    it("throws an error if missing subject", () => {
+    it("throws an error if missing subject", async () => {
       const sendMail = buildSendMail({
         transport,
         defaultFrom: "replace@me.with.your.com",
@@ -50,7 +50,7 @@ describe("index", () => {
           html: "ok",
         });
 
-      expect(callSendMail()).rejects.toThrowError(
+      await expect(callSendMail()).rejects.toThrowError(
         "sendMail couldn't find a subject for your email"
       );
     });
@@ -500,7 +500,7 @@ describe("index", () => {
             subject: "hello",
           });
 
-        expect(callSendMail).rejects.toThrowError(
+        await expect(callSendMail).rejects.toThrowError(
           "Templates sent to a list must include an unsubscribe link. Add an unsubscribe link or remove the list parameter from your sendMail call."
         );
       });
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -173,7 +173,7 @@ export function buildSendMail<T>(options: BuildSendMailOptions<T>) {
         });
         if (response.status === 201) {
           const { id } = (await response.json()) as { id: string };
-          open(`${PREVIEW_SERVER_URL}/${id}`);
+          await open(`${PREVIEW_SERVER_URL}/${id}`);
         } else {
           error(`Error hitting ${PREVIEW_SERVER_URL}`);
           error(response);
diff --git a/packages/core/tsconfig.json b/packages/core/tsconfig.json
@@ -21,5 +21,5 @@
   },
   "$schema": "https://json.schemastore.org/tsconfig",
   "include": ["src/**/*"],
-  "exclude": ["src/**/__test__/*", "dist/**/*"]
+  "exclude": ["dist", "node_modules"]
 }
diff --git a/packages/web/tsconfig.json b/packages/web/tsconfig.json
@@ -16,5 +16,5 @@
     "incremental": true
   },
   "include": ["global.d.ts", "next-env.d.ts", "**/*.ts", "**/*.tsx"],
-  "exclude": ["node_modules"]
+  "exclude": ["dist", "node_modules"]
 }
diff --git a/tsconfig.json b/tsconfig.json
@@ -17,17 +17,17 @@
   },
   "$schema": "https://json.schemastore.org/tsconfig",
   "include": [
+    "./*.ts",
     "packages/*/src/**/*",
     "packages/web/**/*",
     "testSetup.ts",
-    "emails/**/*"
+    "emails/**/*",
+    "e2e"
   ],
   "exclude": [
     "packages/**/__test__/*",
     "packages/**/__integration__/*",
-    "packages/*/src/emails/**/*",
-    "packages/*/dist/**/*",
-    "packages/cli/src/generator_templates/**/*"
+    "packages/*/dist/**/*"
   ],
   "ts-node": {
     "files": true

Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,3 @@`
`3`	`3`	`"*.rb": "rubocop --autocorrect",`
`4`	`4`	`"packages/cli/src/generator_templates/ts/*/.{ts,tsx}": "scripts/build-js-templates"`
`5`	`5`	`}`
`6`		`-`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ export function startChangeWatcher(server: Server, emailsDir: string) {`
`50`	`50`	`if (WATCH_IGNORE.test(filename)) return;`
`51`	`51`	log(`detected ${eventType} on ${filename}, reloading`);
`52`	`52`	`delete require.cache[resolve(changeWatchPath, filename)];`
`53`		`- reload();`
	`53`	`+ void reload();`
`54`	`54`	`}`
`55`	`55`	`);`
`56`	`56`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ export const handler = buildHandler(`
`66`	`66`	`stdio: "inherit",`
`67`	`67`	`});`
`68`	`68`
`69`		`- execSync("npx next build .mailing", {`
	`69`	`+ execSync("cd .mailing && npx next build", {`
`70`	`70`	`stdio: "inherit",`
`71`	`71`	`});`
`72`	`72`	`}`