refactor: streamline request body validation and Slack message formatting

Author: jeromehardaway

src/pages/api/apply.ts

@@ -24,80 +24,102 @@ interface ParsedBody {
     preworkRepo?: string;
 }
 
+function getRequiredParams(): (keyof ParsedBody)[] {
+    return [
+        "firstName",
+        "lastName",
+        "email",
+        "city",
+        "state",
+        "zipCode",
+        "country",
+        "branchOfService",
+        "yearJoined",
+        "yearSeparated",
+        "hasAttendedPreviousCourse",
+        "willAttendAnotherCourse",
+        "linkedInAccountName",
+        "githubAccountName",
+        "preworkLink",
+        "preworkRepo",
+    ];
+}
+
+function validateBody(parsedBody: ParsedBody): boolean {
+    const requiredParams = getRequiredParams();
+    return checkParams(parsedBody, requiredParams);
+}
+
+function formatPreviousCourses(parsedBody: ParsedBody): string | null {
+    if (parsedBody.hasAttendedPreviousCourse && parsedBody.previousCourses !== "") {
+        return `\`\`\`${parsedBody.previousCourses}\`\`\``;
+    }
+    return null;
+}
+
+function formatOtherCourses(parsedBody: ParsedBody): string | null {
+    if (parsedBody.willAttendAnotherCourse && parsedBody.otherCourses !== "") {
+        return `\`\`\`${parsedBody.otherCourses}\`\`\``;
+    }
+    return null;
+}
+
+function formatField(label: string, value: string | number | undefined): string {
+    return `${label}: \`${value ?? ""}\``;
+}
+
+function formatBooleanField(label: string, value: boolean | undefined): string {
+    return `${label}: \`${value ? "Yes" : "No"}\``;
+}
+
+function buildSlackMessage(parsedBody: ParsedBody): string {
+    const items = [
+        formatField("First Name", parsedBody.firstName),
+        formatField("Last Name", parsedBody.lastName),
+        formatField("Email", parsedBody.email),
+        formatField("City", parsedBody.city),
+        formatField("State", parsedBody.state),
+        formatField("Zip Code", parsedBody.zipCode),
+        formatField("Country", parsedBody.country),
+        formatField("Branch of Service", parsedBody.branchOfService),
+        formatField("Year Joined", parsedBody.yearJoined),
+        formatField("Year Separated", parsedBody.yearSeparated),
+        formatBooleanField("Has attended previous bootcamp/programs", parsedBody.hasAttendedPreviousCourse),
+        formatPreviousCourses(parsedBody),
+        formatBooleanField("Will do other courses/programs concurrently", parsedBody.willAttendAnotherCourse),
+        formatOtherCourses(parsedBody),
+        formatField("LinkedIn Account Name", parsedBody.linkedInAccountName),
+        formatField("GitHub Account Name", parsedBody.githubAccountName),
+        formatField("Prework Link", parsedBody.preworkLink),
+        formatField("Prework Repository", parsedBody.preworkRepo),
+    ].filter(Boolean);
+
+    return items.join("\n");
+}
+
+async function postToSlack(text: string): Promise<void> {
+    await axios.post(
+        `https://hooks.slack.com/services/${process.env.APPLY_WEBHOOK_ID ?? ""}`,
+        JSON.stringify({ text })
+    );
+}
+
 export default async function handler(req: Request, res: Response) {
     try {
-        const parsedBody = req.body as ParsedBody; // Ensure body matches ParsedBody interface
-        const requiredParams: (keyof ParsedBody)[] = [
-            "firstName",
-            "lastName",
-            "email",
-            "city",
-            "state",
-            "zipCode",
-            "country",
-            "branchOfService",
-            "yearJoined",
-            "yearSeparated",
-            "hasAttendedPreviousCourse",
-            "willAttendAnotherCourse",
-            "linkedInAccountName",
-            "githubAccountName",
-            "preworkLink",
-            "preworkRepo",
-        ];
-
-        // Validate required fields in the parsed body
-        const hasErrors = checkParams(parsedBody, requiredParams);
+        const parsedBody = req.body as ParsedBody;
+
+        const hasErrors = validateBody(parsedBody);
 
         if (hasErrors) {
             return res.status(422).json({ error: "Missing or incorrect required property" });
         }
 
-        // Construct the text message to be sent
-        const items = [
-            `First Name: \`${parsedBody.firstName ?? ""}\``,
-            `Last Name: \`${parsedBody.lastName ?? ""}\``,
-            `Email: \`${parsedBody.email ?? ""}\``,
-            `City: \`${parsedBody.city ?? ""}\``,
-            `State: \`${parsedBody.state ?? ""}\``,
-            `Zip Code: \`${parsedBody.zipCode ?? ""}\``,
-            `Country: \`${parsedBody.country ?? ""}\``,
-            `Branch of Service: \`${parsedBody.branchOfService ?? ""}\``,
-            `Year Joined: \`${parsedBody.yearJoined ?? ""}\``,
-            `Year Separated: \`${parsedBody.yearSeparated ?? ""}\``,
-            `Has attended previous bootcamp/programs: \`${
-                parsedBody.hasAttendedPreviousCourse ? "Yes" : "No"
-            }\``,
-            `Will do other courses/programs concurrently: \`${
-                parsedBody.willAttendAnotherCourse ? "Yes" : "No"
-            }\``,
-            `LinkedIn Account Name: \`${parsedBody.linkedInAccountName ?? ""}\``,
-            `GitHub Account Name: \`${parsedBody.githubAccountName ?? ""}\``,
-            `Prework Link: \`${parsedBody.preworkLink ?? ""}\``,
-            `Prework Repository: \`${parsedBody.preworkRepo ?? ""}\``,
-        ];
-
-        if (parsedBody.willAttendAnotherCourse && parsedBody.otherCourses !== "") {
-            items.splice(12, 0, `\`\`\`${parsedBody.otherCourses}\`\`\``);
-        }
-
-        if (parsedBody.hasAttendedPreviousCourse && parsedBody.previousCourses !== "") {
-            items.splice(11, 0, `\`\`\`${parsedBody.previousCourses}\`\`\``);
-        }
-
-        const text = items.join("\n");
+        const text = buildSlackMessage(parsedBody);
 
-        // Send the payload to the configured Slack webhook URL
-        await axios.post(
-            `https://hooks.slack.com/services/${process.env.APPLY_WEBHOOK_ID ?? ""}`,
-            JSON.stringify({ text })
-        );
+        await postToSlack(text);
 
-        // Respond with success message
         return res.status(200).json({ message: "SUCCESS" });
     } catch (err) {
-        // Log the error for debugging and respond with an error message
-        // console.error("Failed to post to #mentor channel:", err);
         return res.status(500).json({ message: "Failed to post to #apply channel" });
     }
 }