validate notifications file

Author: Pablo Mendez

src/files/index.ts

@@ -1,3 +1,4 @@
 export * from "./compose/index.js";
 export * from "./manifest/index.js";
 export * from "./setupWizard/index.js";
+export * from "./notifications/index.js";

src/files/notifications/index.ts

@@ -0,0 +1 @@
+export { readNotificationsIfExists } from "./readNotificationsIfExists.js";

src/files/notifications/readNotificationsIfExists.ts

@@ -0,0 +1,23 @@
+import fs from "fs";
+import path from "path";
+import yaml from "js-yaml";
+import { defaultDir } from "../../params.js";
+import { readFile } from "../../utils/file.js";
+import { NotificationsConfig, releaseFiles} from "@dappnode/types";
+
+export function readNotificationsIfExists(dir?: string): NotificationsConfig | null {
+  const dirPath = dir || defaultDir;
+  const notificationsFileName = fs
+    .readdirSync(dirPath)
+    .find(file => releaseFiles.notifications.regex.test(file));
+
+  if (!notificationsFileName) return null;
+  const data = readFile(path.join(dirPath, notificationsFileName));
+
+  // Parse notifications in try catch block to show a comprehensive error message
+  try {
+    return yaml.load(data);
+  } catch (e) {
+    throw Error(`Error parsing notifications: ${e.message}`);
+  }
+}

src/tasks/buildAndUpload/getFileValidationTask.ts

@@ -4,9 +4,10 @@ import {
   validateComposeSchema,
   validateManifestSchema,
   validateSetupWizardSchema,
-  validateDappnodeCompose
+  validateDappnodeCompose,
+  validateNotificationsSchema
 } from "@dappnode/schemas";
-import { getComposePath, readSetupWizardIfExists } from "../../files/index.js";
+import { getComposePath, readNotificationsIfExists, readSetupWizardIfExists } from "../../files/index.js";
 import { CliError } from "../../params.js";
 
 export function getFileValidationTask({
@@ -30,9 +31,11 @@ async function validatePackageFiles({
   rootDir: string;
 }): Promise<void> {
   const setupWizard = readSetupWizardIfExists(rootDir);
-
   if (setupWizard) validateSetupWizardSchema(setupWizard);
 
+  const notifications = readNotificationsIfExists(rootDir);
+  if (notifications) validateNotificationsSchema(notifications);
+
   for (const pkgProps of packagesToBuildProps)
     await validateVariantFiles(pkgProps);
 }