migrate taf cmd to zod

Author: ExampleWasTaken

src/commands/utils/taf.ts

@@ -1,6 +1,7 @@
 import { ApplicationCommandOptionType, ApplicationCommandType, Colors } from 'discord.js';
-import fetch from 'node-fetch';
-import { constantsConfig, slashCommand, slashCommandStructure, makeEmbed, makeLines, Logger } from '../../lib';
+import { Request } from 'node-fetch';
+import { ZodError } from 'zod';
+import { Logger, TAF, TafSchema, fetchData, makeEmbed, makeLines, slashCommand, slashCommandStructure } from '../../lib';
 
 const data = slashCommandStructure({
     name: 'taf',
@@ -22,6 +23,12 @@ const noQueryEmbed = makeEmbed({
     color: Colors.Red,
 });
 
+const errorEmbed = (error: string) => makeEmbed({
+    title: 'TAF Error',
+    description: error,
+    color: Colors.Red,
+});
+
 export default slashCommand(data, async ({ interaction }) => {
     await interaction.deferReply();
 
@@ -42,47 +49,32 @@ export default slashCommand(data, async ({ interaction }) => {
         return interaction.editReply({ embeds: [noQueryEmbed] });
     }
 
+    let taf: TAF;
     try {
-        const tafReport: any = await fetch(`https://avwx.rest/api/taf/${icao}`, {
+        taf = await fetchData<TAF>(new Request(`https://avwx.rest/api/taf/${icao}`, {
             method: 'GET',
             headers: { Authorization: tafToken },
-        }).then((res) => res.json());
-
-        if (tafReport.error) {
-            const invalidEmbed = makeEmbed({
-                title: `TAF Error | ${icao.toUpperCase()}`,
-                description: tafReport.error,
-                color: Colors.Red,
-            });
-            return interaction.editReply({ embeds: [invalidEmbed] });
+        }), TafSchema);
+    } catch (e) {
+        if (e instanceof ZodError) {
+            return interaction.editReply({ embeds: [errorEmbed('The API returned unknown data.')] });
         }
-        const getClouds = (clouds: any) => {
-            const retClouds = [];
-            for (const cloud of clouds) {
-                retClouds.push(cloud.repr);
-            }
-            return retClouds.join(', ');
-        };
-        const tafEmbed = makeEmbed({
-            title: `TAF Report | ${tafReport.station}`,
-            description: makeLines([
-                '**Raw Report**',
-                tafReport.raw,
+        return interaction.editReply({ embeds: [errorEmbed(`An error occurred while fetching the latest TAF for ${icao.toUpperCase()}.`)] });
+    }
 
-                '',
-                '**Basic Report:**',
-                `**Time Forecasted:** ${tafReport.time.dt}`,
-                `**Forecast Start Time:** ${tafReport.start_time.dt}`,
-                `**Forecast End Time:** ${tafReport.end_time.dt}`,
-                `**Visibility:** ${tafReport.forecast[0].visibility.repr} ${Number.isNaN(+tafReport.forecast[0].visibility.repr) ? '' : tafReport.units.visibility}`,
-                `**Wind:** ${tafReport.forecast[0].wind_direction.repr}${tafReport.forecast[0].wind_direction.repr === 'VRB' ? '' : constantsConfig.units.DEGREES} at ${tafReport.forecast[0].wind_speed.repr} ${tafReport.units.wind_speed}`,
-                `**Clouds:** ${getClouds(tafReport.forecast[0].clouds)}`,
-                `**Flight Rules:** ${tafReport.forecast[0].flight_rules}`,
-            ]),
+    try {
+        const tafEmbed = makeEmbed({
+            title: `TAF Report | ${taf.station}`,
+            description: makeLines(['**Raw Report**', ...taf.forecast.map((forecast, i) => {
+                if (i === 0) {
+                    return `${taf.station} ${forecast.raw}`;
+                }
+                return forecast.raw;
+            })]),
             fields: [
                 {
-                    name: 'Unsure of how to read the raw report?',
-                    value: 'Please refer to our guide [here.](https://docs.flybywiresim.com/pilots-corner/airliner-flying-guide/weather/#taf-example-decoded)',
+                    name: 'Unsure of how to read the report?',
+                    value: `Please refer to our guide [here](https://docs.flybywiresim.com/pilots-corner/airliner-flying-guide/weather/#taf-example-decoded) or see above report decoded [here](https://e6bx.com/weather/${taf.station}/?showDecoded=1&focuspoint=tafdecoder).`,
                     inline: false,
                 },
             ],

src/lib/apis/fetchData.ts

@@ -1,5 +1,6 @@
 import fetch, { Request } from 'node-fetch';
 import { ZodSchema } from 'zod';
+import { Logger } from '../logger';
 
 /**
  * Fetch data from any API endpoint that returns JSON formatted data.
@@ -26,6 +27,8 @@ export const fetchData = async <ReturnType = unknown>(request: Request, zodSchem
         const result = zodSchema.safeParse(data);
 
         if (!result.success) {
+            Logger.error('[zod] Data validation failed:');
+            result.error.issues.forEach((issue) => Logger.error(`Code: ${issue.code}, Path: ${issue.path.join('.')}, Message: ${issue.message}`));
             throw result.error;
         }
 

src/lib/apis/zodSchemas/tafSchemas.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+
+export const ForecastSchema = z.object({ raw: z.string() });
+
+export const TafSchema = z.object({
+    raw: z.string(),
+    station: z.string(),
+    forecast: z.array(ForecastSchema),
+});
+
+export type Forecast = z.infer<typeof ForecastSchema>;
+export type TAF = z.infer<typeof TafSchema>;

src/lib/apis/zodSchemas/vatsimData.ts src/lib/apis/zodSchemas/vatsimDataSchemas.ts

@@ -24,5 +24,6 @@ export * from './schedulerJobs/postBirthdays';
 
 // API Wrapper
 export * from './apis/fetchData';
-export * from './apis/zodSchemas/vatsimEvents';
-export * from './apis/zodSchemas/vatsimData';
+export * from './apis/zodSchemas/vatsimEventsSchemas';
+export * from './apis/zodSchemas/vatsimDataSchemas';
+export * from './apis/zodSchemas/tafSchemas';