chore: eslint cleanup and code changes accordingly (#586)

Author: BlankParticle

.eslintrc.js

@@ -4,28 +4,40 @@
 module.exports = {
   root: true,
   parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint', 'prettier', 'drizzle', '@u22n/custom'],
-  extends: ['prettier', 'plugin:drizzle/all'],
+  plugins: ['@typescript-eslint', 'drizzle'],
+  parserOptions: {
+    project: true
+  },
+  extends: [
+    'plugin:drizzle/all',
+    'plugin:@typescript-eslint/recommended-type-checked',
+    'plugin:@typescript-eslint/stylistic-type-checked'
+  ],
   rules: {
-    semi: [2, 'always']
+    '@typescript-eslint/array-type': 'off',
+    '@typescript-eslint/consistent-type-definitions': 'off',
+    '@typescript-eslint/consistent-type-imports': [
+      'warn',
+      { prefer: 'type-imports', fixStyle: 'inline-type-imports' }
+    ],
+    '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
+    '@typescript-eslint/require-await': 'off',
+    '@typescript-eslint/no-misused-promises': [
+      'error',
+      { checksVoidReturn: { attributes: false } }
+    ],
+    'no-console': ['error', { allow: ['info', 'warn', 'trace', 'error'] }]
   },
   overrides: [
     {
-      files: ['*'],
-      rules: {
-        'no-console': [
-          'error',
-          {
-            allow: ['info', 'warn', 'trace', 'error']
-          }
-        ]
-      }
+      files: ['./packages/database/**/*'],
+      plugins: ['@u22n/custom'],
+      rules: { '@u22n/custom/table-needs-org-id': 'error' }
     },
     {
-      files: ['./packages/database/**/*'],
-      rules: {
-        '@u22n/custom/table-needs-org-id': 'error'
-      }
+      files: ['./apps/web/**/*'],
+      extends: ['next/core-web-vitals'],
+      rules: { 'react/no-children-prop': ['warn', { allowFunctions: true }] }
     }
   ]
 };

apps/mail-bridge/app.ts

@@ -1,11 +1,3 @@
-import { env } from './env';
-import { db } from '@u22n/database';
-import { trpcMailBridgeRouter } from './trpc';
-import { eventApi } from './postal-routes/events';
-import { inboundApi } from './postal-routes/inbound';
-import { signatureMiddleware } from './postal-routes/signature-middleware';
-import { opentelemetry } from '@u22n/otel/hono';
-import type { Ctx, TRPCContext } from './ctx';
 import {
   createHonoApp,
   setupErrorHandlers,
@@ -15,6 +7,14 @@ import {
   setupRuntime,
   setupTrpcHandler
 } from '@u22n/hono';
+import { signatureMiddleware } from './postal-routes/signature-middleware';
+import { inboundApi } from './postal-routes/inbound';
+import { eventApi } from './postal-routes/events';
+import { opentelemetry } from '@u22n/otel/hono';
+import { trpcMailBridgeRouter } from './trpc';
+import type { Ctx, TRPCContext } from './ctx';
+import { db } from '@u22n/database';
+import { env } from './env';
 
 const processCleanup: Array<() => Promise<void>> = [];
 

apps/mail-bridge/ctx.ts

@@ -1,7 +1,7 @@
-import type { db } from '@u22n/database';
-import type { env } from './env';
 import type { Context } from '@u22n/hono/helpers';
 import type { HonoContext } from '@u22n/hono';
+import type { db } from '@u22n/database';
+import type { env } from './env';
 
 export type Ctx = HonoContext;
 

apps/mail-bridge/postal-db/functions.ts

@@ -1,4 +1,14 @@
-import { connection as rawMySqlConnection, postalDB } from '.';
+import {
+  lookupCNAME,
+  lookupMX,
+  lookupTXT,
+  buildDkimRecord,
+  buildSpfRecord,
+  parseDkim,
+  parseSpfIncludes,
+  parseDmarc,
+  buildDmarcRecord
+} from '@u22n/utils/dns';
 import {
   organizations,
   domains,
@@ -9,25 +19,15 @@ import {
   httpEndpoints,
   routes
 } from './schema';
-import { randomUUID } from 'node:crypto';
 import {
   generateDKIMKeyPair,
   generatePublicKey,
   getUniqueDKIMSelector,
   randomAlphaNumeric
 } from './generators';
+import { connection as rawMySqlConnection, postalDB } from '.';
 import { and, eq, sql } from 'drizzle-orm';
-import {
-  lookupCNAME,
-  lookupMX,
-  lookupTXT,
-  buildDkimRecord,
-  buildSpfRecord,
-  parseDkim,
-  parseSpfIncludes,
-  parseDmarc,
-  buildDmarcRecord
-} from '@u22n/utils/dns';
+import { randomUUID } from 'node:crypto';
 import { env } from '../env';
 
 export type CreateOrgInput = {
@@ -125,7 +125,7 @@ export type GetDomainDNSRecordsOutput =
 export async function getDomainDNSRecords(
   domainId: string,
   postalServerUrl: string,
-  forceReverify: boolean = false
+  forceReverify = false
 ): Promise<GetDomainDNSRecordsOutput> {
   const domainInfo = await postalDB.query.domains.findFirst({
     where: eq(domains.uuid, domainId)
@@ -204,27 +204,27 @@ export async function getDomainDNSRecords(
 
   const spfDomains = txtRecords.success
     ? parseSpfIncludes(
-        txtRecords.data.find((_) => _.startsWith('v=spf1')) || ''
+        txtRecords.data.find((_) => _.startsWith('v=spf1')) ?? ''
       )
     : null;
   records.spf.name = '@';
   records.spf.extraSenders =
     (spfDomains &&
       spfDomains.includes.filter((x) => x !== `_spf.${dnsRootUrl}`).length >
-        0) ||
+        0) ??
     false;
 
   // We need to resolve duplicate entries incase the spf record is already included, so that we don't have duplicate entries
   const allSenders = Array.from(
     new Set([
       `_spf.${dnsRootUrl}`,
-      ...(records.spf.extraSenders ? spfDomains?.includes || [] : [])
+      ...(records.spf.extraSenders ? spfDomains?.includes ?? [] : [])
     ]).values()
   );
 
   records.spf.value = buildSpfRecord(allSenders, '~all');
   records.spf.valid =
-    (spfDomains && spfDomains.includes.includes(`_spf.${dnsRootUrl}`)) || false;
+    spfDomains?.includes.includes(`_spf.${dnsRootUrl}`) ?? false;
 
   if (!records.spf.valid || domainInfo.spfStatus !== 'OK' || forceReverify) {
     await postalDB
@@ -262,13 +262,9 @@ export async function getDomainDNSRecords(
         .where(eq(domains.uuid, domainId));
     } else {
       const domainKey = parseDkim(
-        domainKeyRecords.data.find((_) => _.startsWith('v=DKIM1')) || ''
+        domainKeyRecords.data.find((_) => _.startsWith('v=DKIM1')) ?? ''
       );
-      if (
-        !domainKey ||
-        domainKey['h'] !== 'sha256' ||
-        domainKey['p'] !== publicKey
-      ) {
+      if (!domainKey || domainKey.h !== 'sha256' || domainKey.p !== publicKey) {
         records.dkim.valid = false;
         await postalDB
           .update(domains)
@@ -350,11 +346,11 @@ export async function getDomainDNSRecords(
   const dmarcRecord = await lookupTXT(`_dmarc.${domainInfo.name}`);
   if (dmarcRecord.success && dmarcRecord.data.length > 0) {
     const dmarcValues = parseDmarc(
-      dmarcRecord.data.find((_) => _.startsWith('v=DMARC1')) || ''
+      dmarcRecord.data.find((_) => _.startsWith('v=DMARC1')) ?? ''
     );
     if (dmarcValues) {
       records.dmarc.policy =
-        (dmarcValues['p'] as 'reject' | 'quarantine' | 'none') || null;
+        (dmarcValues.p as 'reject' | 'quarantine' | 'none') || null;
     }
   }
   records.dmarc.name = '_dmarc';
@@ -524,7 +520,7 @@ export async function setMailServerRouteForDomain(
       id: true
     }
   });
-  if (!domainQuery || !domainQuery.id) {
+  if (!domainQuery?.id) {
     throw new Error('Domain not found');
   }
   const domainId = domainQuery.id;

apps/mail-bridge/postal-db/generators.ts

@@ -3,10 +3,10 @@ import {
   createPublicKey
 } from 'node:crypto';
 import { customAlphabet } from 'nanoid';
+import { domains } from './schema';
+import { eq } from 'drizzle-orm';
 import { promisify } from 'util';
 import { postalDB } from '.';
-import { eq } from 'drizzle-orm';
-import { domains } from './schema';
 
 export const randomAlphaNumeric = customAlphabet(
   '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'

apps/mail-bridge/postal-db/index.ts

@@ -1,7 +1,7 @@
+import { activePostalServer, env } from '../env';
 import { drizzle } from 'drizzle-orm/mysql2';
 import mysql from 'mysql2/promise';
 import * as schema from './schema';
-import { activePostalServer, env } from '../env';
 
 const isLocal = env.MAILBRIDGE_LOCAL_MODE;
 export const connection = mysql.createPool({

apps/mail-bridge/postal-routes/inbound.ts

@@ -2,10 +2,10 @@ import {
   postalMessageSchema,
   mailParamsSchema
 } from '../queue/mail-processor/schemas';
-import type { Ctx } from '../ctx';
 import { mailProcessorQueue } from '../queue/mail-processor';
-import { createHonoApp } from '@u22n/hono';
 import { zValidator } from '@u22n/hono/helpers';
+import { createHonoApp } from '@u22n/hono';
+import type { Ctx } from '../ctx';
 
 export const inboundApi = createHonoApp<Ctx>();
 

apps/mail-bridge/postal-routes/signature-middleware.ts

@@ -1,9 +1,9 @@
-import { env } from '../env';
 import { validatePostalWebhookSignature } from '../utils/validatePostalWebhookSignature';
-import type { Ctx } from '../ctx';
 import { createMiddleware } from '@u22n/hono/helpers';
 import { getTracer } from '@u22n/otel/helpers';
 import { flatten } from '@u22n/otel/exports';
+import type { Ctx } from '../ctx';
+import { env } from '../env';
 
 const middlewareTracer = getTracer('mail-bridge/hono/middleware');
 
@@ -15,7 +15,7 @@ export const signatureMiddleware = createMiddleware<Ctx>(async (c, next) =>
         span?.recordException(new Error(`Method not allowed, ${c.req.method}`));
         return c.json({ message: 'Method not allowed' }, 405);
       }
-      const body = await c.req.json().catch(() => ({}));
+      const body = (await c.req.json().catch(() => ({}))) as unknown;
       const signature = c.req.header('x-postal-signature');
       if (!signature) {
         span?.recordException(new Error('Missing signature'));

apps/mail-bridge/queue/mail-processor/index.ts

@@ -1,6 +1,6 @@
-import { Queue } from 'bullmq';
-import { env } from '../../env';
 import type { MailParamsSchema, PostalMessageSchema } from './schemas';
+import { env } from '../../env';
+import { Queue } from 'bullmq';
 
 const { host, username, password, port } = new URL(
   env.DB_REDIS_CONNECTION_STRING