fix(env): make errors from environment clearer (#115)

Author: potb

src/core/createEnvForModule.ts

@@ -1,6 +1,6 @@
 import { constantCase } from 'constant-case';
 
-import type { CreatedModule, ModuleFactory } from './createModule';
+import type { CreatedModule, ModuleCreator } from './createModule';
 
 const createEnvForModule = (constantName: string) =>
   Object.entries(process.env)
@@ -18,14 +18,14 @@ const createEnvForModule = (constantName: string) =>
     }, {});
 
 export const createAllModules = async (
-  modules: Record<string, ModuleFactory>,
+  modules: Record<string, ModuleCreator>,
 ): Promise<CreatedModule[]> => {
   const createdModules: CreatedModule[] = [];
 
-  for (const [name, factory] of Object.entries(modules)) {
+  for (const { name, factory } of Object.values(modules)) {
     const moduleConstantName = constantCase(name);
-    const moduleEnv = createEnvForModule(moduleConstantName);
-    const module = await factory({ env: moduleEnv });
+    const env = createEnvForModule(moduleConstantName);
+    const module = await factory({ env });
 
     createdModules.push(module);
   }

src/core/createModule.ts

@@ -1,3 +1,4 @@
+import { constantCase } from 'constant-case';
 import type { ClientEvents, ClientOptions } from 'discord.js';
 import type { ZodTypeAny } from 'zod';
 import { z } from 'zod';
@@ -21,6 +22,7 @@ type EventHandlers = {
 };
 
 type BotModule<Env extends Record<string, ZodTypeAny>> = {
+  name: string;
   env?: Env;
   intents?: ClientOptions['intents'];
   slashCommands?: ModuleFunction<Env, Array<BotCommand>>;
@@ -31,28 +33,56 @@ interface CreatedModuleInput {
   env: unknown;
 }
 
+type ModuleFactory = (input: CreatedModuleInput) => Promise<CreatedModule>;
+
 export interface CreatedModule {
   intents: ClientOptions['intents'];
   slashCommands: Array<BotCommand>;
   eventHandlers: EventHandlers;
 }
 
-export type ModuleFactory = (input: CreatedModuleInput) => Promise<CreatedModule>;
+export interface ModuleCreator {
+  name: string;
+  factory: ModuleFactory;
+}
 
 export const createModule = <Env extends Record<string, ZodTypeAny>>(
   module: BotModule<Env>,
-): ModuleFactory => {
-  return async (input) => {
-    const env = await z.object(module.env ?? ({} as Env)).parseAsync(input.env);
+): ModuleCreator => ({
+  name: module.name,
+  factory: async (input) => {
+    const result = await z.object(module.env ?? ({} as Env)).safeParseAsync(input.env);
+
+    if (!result.success) {
+      const constantName = constantCase(module.name);
+      const zodErrors = result.error.flatten().fieldErrors;
+
+      const errors = Object.entries(zodErrors).reduce<Record<string, string[]>>(
+        (acc, [key, value]) => ({
+          ...acc,
+          ...(Array.isArray(value) ? { [`${constantName}_${key}`]: value } : {}),
+        }),
+        {},
+      );
+
+      const formattedErrors = Object.entries(errors).reduce(
+        (acc, [key, values]) => values.reduce((acc, value) => `${acc}\n\t- ${key}: ${value}`, acc),
+        '',
+      );
+
+      throw new Error(
+        `Encountered errors while validating environment variables for module ${module.name}:${formattedErrors}`,
+      );
+    }
 
     const context = {
-      env,
+      env: result.data,
     };
 
     return {
       intents: module.intents ?? [],
       slashCommands: module.slashCommands?.(context) ?? [],
       eventHandlers: module.eventHandlers?.(context) ?? {},
     };
-  };
-};
+  },
+});

src/modules/coolLinksManagement/coolLinksManagement.module.ts

@@ -34,6 +34,7 @@ const getThreadNameFromOpenGraph = async (url: string): Promise<string | null> =
 const youtubeUrlRegex = new RegExp('^(https?)?(://)?(www.)?(m.)?((youtube.com)|(youtu.be))');
 
 export const coolLinksManagement = createModule({
+  name: 'coolLinksManagement',
   env: {
     CHANNEL_ID: z.string().nonempty(),
     PAGE_SUMMARIZER_BASE_URL: z.string().url(),

src/modules/fart/fart.module.ts

@@ -3,6 +3,7 @@ import { PermissionFlagsBits, SlashCommandBuilder } from 'discord.js';
 import { createModule } from '../../core/createModule';
 
 export const fart = createModule({
+  name: 'fart',
   slashCommands: () => [
     {
       schema: new SlashCommandBuilder()

src/modules/fixEmbedTwitterVideo/fixEmbedTwitterVideo.module.ts

@@ -88,6 +88,7 @@ const isTwitterVideo = async (tweetURL: string): Promise<boolean> => {
 };
 
 export const fixEmbedTwitterVideo = createModule({
+  name: 'fixEmbedTwitterVideo',
   env: {
     EXCLUDED_CHANNEL_ID: z.string().nonempty(),
   },

src/modules/quoiFeur/quoiFeur.module.ts

@@ -9,6 +9,7 @@ import {
 } from './quoiFeur.helpers';
 
 export const quoiFeur = createModule({
+  name: 'quoiFeur',
   slashCommands: () => [
     {
       schema: new SlashCommandBuilder()

src/modules/recurringMessage/recurringMessage.module.ts

@@ -11,6 +11,7 @@ import {
 } from './recurringMessage.helpers';
 
 export const recurringMessage = createModule({
+  name: 'recurringMessage',
   slashCommands: () => [
     {
       schema: new SlashCommandBuilder()

src/modules/voiceOnDemand/voiceOnDemand.module.ts

@@ -10,6 +10,7 @@ import {
 } from './voiceOnDemand.helpers';
 
 export const voiceOnDemand = createModule({
+  name: 'voiceOnDemand',
   slashCommands: () => [
     {
       schema: new SlashCommandBuilder()

tsconfig.json

@@ -13,6 +13,7 @@
     "noUncheckedIndexedAccess": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
+    "noEmit": true,
     "resolveJsonModule": true,
     "skipDefaultLibCheck": true,
     "skipLibCheck": true,