WIP: feature: stronger types for jobs and functions

functions/send-email-link/src/index.ts

@@ -1,4 +1,5 @@
 import app from '@constructive-io/knative-job-fn';
+import type { Request, Response, NextFunction } from 'express';
 import { GraphQLClient } from 'graphql-request';
 import gql from 'graphql-tag';
 import { generate } from '@launchql/mjml';
@@ -46,6 +47,60 @@ const GetDatabaseInfo = gql`
   }
 `;
 
+type GetUserResult = {
+  user: {
+    username: string | null;
+    displayName: string | null;
+    profilePicture: string | null;
+  } | null;
+};
+
+type LegalTermsCompany = {
+  website: string;
+  nick: string;
+  name: string;
+};
+
+type LegalTermsEmails = {
+  support: string;
+};
+
+type LegalTermsData = {
+  emails: LegalTermsEmails;
+  company: LegalTermsCompany;
+};
+
+type SiteTheme = {
+  theme: {
+    primary: string;
+  };
+};
+
+type SiteDomain = {
+  subdomain: string | null;
+  domain: string;
+};
+
+type SiteLogo = {
+  url?: string | null;
+} | null;
+
+type DatabaseInfoResult = {
+  database?:
+    | {
+        sites?: {
+          nodes?: Array<{
+            domains?: { nodes?: SiteDomain[] };
+            logo?: SiteLogo;
+            title?: string;
+            siteThemes?: { nodes?: SiteTheme[] };
+            siteModules?: { nodes?: Array<{ data: LegalTermsData }> };
+          }>;
+        };
+      }
+    | null;
+};
+
 type SendEmailParams = {
   email_type: 'invite_email' | 'forgot_password' | 'email_verification';
   email: string;
@@ -64,6 +119,10 @@ type GraphQLContext = {
   databaseId: string;
 };
 
+type SendEmailLinkMissing = { missing: string };
+type SendEmailLinkSuccess = { complete: true; dryRun?: true };
+export type SendEmailLinkResult = SendEmailLinkMissing | SendEmailLinkSuccess;
+
 const getRequiredEnv = (name: string): string => {
   const value = process.env[name];
   if (!value) {
@@ -94,10 +153,10 @@ const createGraphQLClient = (
 export const sendEmailLink = async (
   params: SendEmailParams,
   context: GraphQLContext
-) => {
+): Promise<SendEmailLinkResult> => {
   const { client, meta, databaseId } = context;
 
-  const validateForType = (): { missing?: string } | null => {
+  const validateForType = (): SendEmailLinkMissing | null => {
     switch (params.email_type) {
       case 'invite_email':
         if (!params.invite_token || !params.sender_id) {
@@ -131,7 +190,7 @@ export const sendEmailLink = async (
     return typeValidation;
   }
 
-  const databaseInfo = await meta.request<any>(GetDatabaseInfo, {
+  const databaseInfo = await meta.request<DatabaseInfoResult>(GetDatabaseInfo, {
     databaseId
   });
 
@@ -199,7 +258,7 @@ export const sendEmailLink = async (
       const scope = Number(params.invite_type) === 2 ? 'org' : 'app';
       url.searchParams.append('type', scope);
 
-      const inviter = await client.request<any>(GetUser, {
+      const inviter = await client.request<GetUserResult>(GetUser, {
         userId: params.sender_id
       });
       inviterName = inviter?.user?.displayName;
@@ -239,7 +298,7 @@ export const sendEmailLink = async (
       break;
     }
     default:
-      return false;
+      return { missing: 'email_type' };
   }
 
   const link = url.href;
@@ -295,7 +354,11 @@ export const sendEmailLink = async (
 };
 
 // HTTP/Knative entrypoint (used by @constructive-io/knative-job-fn wrapper)
-app.post('/', async (req: any, res: any, next: any) => {
+type SendEmailLinkRequestBody = Partial<SendEmailParams>;
+type SendEmailLinkRequest = Request<{}, SendEmailLinkResult, SendEmailLinkRequestBody>;
+type SendEmailLinkResponse = Response<SendEmailLinkResult>;
+
+app.post('/', async (req: SendEmailLinkRequest, res: SendEmailLinkResponse, next: NextFunction) => {
   try {
     const params = (req.body || {}) as SendEmailParams;
 
@@ -329,7 +392,7 @@ export default app;
 if (require.main === module) {
   const port = Number(process.env.PORT ?? 8080);
   // @constructive-io/knative-job-fn exposes a .listen method that delegates to the Express app
-  (app as any).listen(port, () => {
+  app.listen(port, () => {
     // eslint-disable-next-line no-console
     console.log(`[send-email-link] listening on port ${port}`);
   });

functions/simple-email/src/index.ts

@@ -1,4 +1,5 @@
 import app from '@constructive-io/knative-job-fn';
+import type { Request, Response, NextFunction } from 'express';
 import { parseEnvBoolean } from '@pgpmjs/env';
 import { send as sendEmail } from '@launchql/postmaster';
 
@@ -27,7 +28,11 @@ const getRequiredField = (
 
 const isDryRun = parseEnvBoolean(process.env.SIMPLE_EMAIL_DRY_RUN) ?? false;
 
-app.post('/', async (req: any, res: any, next: any) => {
+type SimpleEmailResponseBody = { complete: true };
+type SimpleEmailRequest = Request<{}, SimpleEmailResponseBody, Partial<SimpleEmailPayload>>;
+type SimpleEmailResponse = Response<SimpleEmailResponseBody>;
+
+app.post('/', async (req: SimpleEmailRequest, res: SimpleEmailResponse, next: NextFunction) => {
   try {
     const payload = (req.body || {}) as SimpleEmailPayload;
 
@@ -92,7 +97,7 @@ export default app;
 if (require.main === module) {
   const port = Number(process.env.PORT ?? 8080);
   // @constructive-io/knative-job-fn exposes a .listen method that delegates to the underlying Express app
-  (app as any).listen(port, () => {
+  app.listen(port, () => {
     // eslint-disable-next-line no-console
     console.log(`[simple-email] listening on port ${port}`);
   });

jobs/job-pg/src/index.ts

@@ -55,11 +55,11 @@ const end = (pool: Pool): void => {
 
 // Callbacks registered for pool close events can accept arbitrary arguments
 // (we forward whatever was passed to `onClose`).
-type PoolCloseCallback = (...args: any[]) => Promise<void> | void;
+type PoolCloseCallback = (...args: unknown[]) => Promise<void> | void;
 
 class PoolManager {
   private pgPool: Pool;
-  private callbacks: Array<[PoolCloseCallback, any, any[]]>;
+  private callbacks: Array<[PoolCloseCallback, unknown, unknown[]]>;
   private _closed: boolean;
 
   constructor({ pgPool = new Pool(pgPoolConfig) }: { pgPool?: Pool } = {}) {
@@ -77,7 +77,11 @@ class PoolManager {
     });
   }
 
-  onClose(fn: PoolCloseCallback, context?: any, args: any[] = []): void {
+  onClose(
+    fn: PoolCloseCallback,
+    context?: unknown,
+    args: unknown[] = []
+  ): void {
     this.callbacks.push([fn, context, args]);
   }
 

jobs/job-utils/src/index.ts

@@ -28,8 +28,13 @@ import { Logger } from '@pgpmjs/logger';
 
 const log = new Logger('jobs:core');
 
+export type QueryParams = readonly unknown[] | undefined;
+
 export type PgClientLike = {
-  query<T = any>(text: string, params?: any[]): Promise<{ rows: T[] }>;
+  query<T = unknown>(
+    text: string,
+    params?: QueryParams
+  ): Promise<{ rows: T[] }>;
 };
 
 export {
@@ -72,7 +77,7 @@ export const completeJob = async (
   );
 };
 
-export const getJob = async <T = any>(
+export const getJob = async <T = unknown>(
   client: PgClientLike,
   { workerId, supportedTaskNames }: GetJobParams
 ): Promise<T | null> => {
@@ -86,7 +91,7 @@ export const getJob = async <T = any>(
   return (job as T) ?? null;
 };
 
-export const getScheduledJob = async <T = any>(
+export const getScheduledJob = async <T = unknown>(
   client: PgClientLike,
   { workerId, supportedTaskNames }: GetScheduledJobParams
 ): Promise<T | null> => {
@@ -100,10 +105,10 @@ export const getScheduledJob = async <T = any>(
   return (job as T) ?? null;
 };
 
-export const runScheduledJob = async (
+export const runScheduledJob = async <T = unknown>(
   client: PgClientLike,
   { jobId }: RunScheduledJobParams
-): Promise<any | null> => {
+): Promise<T | null> => {
   log.info(`runScheduledJob job[${jobId}]`);
   try {
     const {
@@ -112,9 +117,14 @@ export const runScheduledJob = async (
       `SELECT * FROM "${JOBS_SCHEMA}".run_scheduled_job($1);`,
       [jobId]
     );
-    return job ?? null;
-  } catch (e: any) {
-    if (e?.message === 'ALREADY_SCHEDULED') {
+    return (job as T) ?? null;
+  } catch (e: unknown) {
+    if (
+      e &&
+      typeof e === 'object' &&
+      'message' in e &&
+      (e as { message?: unknown }).message === 'ALREADY_SCHEDULED'
+    ) {
       return null;
     }
     throw e;

jobs/knative-job-example/src/index.ts

@@ -1,6 +1,7 @@
 import app from '@constructive-io/knative-job-fn';
+import type { Request, Response, NextFunction } from 'express';
 
-app.post('/', async (req: any, res: any, next: any) => {
+app.post('/', async (req: Request, res: Response, next: NextFunction) => {
   if (req.body.throw) {
     next(new Error('THROWN_ERROR'));
   } else {