Implement new release file notifications.yaml

packages/dappmanager/src/api/routes/packageManifest.ts

@@ -54,7 +54,8 @@ export const packageManifest = wrapHandler<Params>(async (req, res) => {
     "links",
     "repository",
     "bugs",
-    "license"
+    "license",
+    "notifications"
   ]);
 
   res.status(200).send(filteredManifest);

packages/installer/src/dappnodeInstaller.ts

@@ -11,7 +11,8 @@ import {
   PackageRequest,
   SetupWizard,
   GrafanaDashboard,
-  PrometheusTarget
+  PrometheusTarget,
+  GatusConfig
 } from "@dappnode/types";
 import { DappGetState, DappgetOptions, dappGet } from "./dappGet/index.js";
 import { validateDappnodeCompose, validateManifestSchema } from "@dappnode/schemas";
@@ -72,7 +73,8 @@ export class DappnodeInstaller extends DappnodeRepository {
       disclaimer: pkgRelease.disclaimer,
       gettingStarted: pkgRelease.gettingStarted,
       grafanaDashboards: pkgRelease.grafanaDashboards,
-      prometheusTargets: pkgRelease.prometheusTargets
+      prometheusTargets: pkgRelease.prometheusTargets,
+      notifications: pkgRelease.notifications
     });
 
     // set compose to custom dappnode compose in release
@@ -107,7 +109,8 @@ export class DappnodeInstaller extends DappnodeRepository {
         disclaimer: pkgRelease.disclaimer,
         gettingStarted: pkgRelease.gettingStarted,
         grafanaDashboards: pkgRelease.grafanaDashboards,
-        prometheusTargets: pkgRelease.prometheusTargets
+        prometheusTargets: pkgRelease.prometheusTargets,
+        notifications: pkgRelease.notifications
       });
     });
 
@@ -151,20 +154,23 @@ export class DappnodeInstaller extends DappnodeRepository {
     disclaimer,
     gettingStarted,
     prometheusTargets,
-    grafanaDashboards
+    grafanaDashboards,
+    notifications
   }: {
     manifest: Manifest;
     SetupWizard?: SetupWizard;
     disclaimer?: string;
     gettingStarted?: string;
     prometheusTargets?: PrometheusTarget[];
     grafanaDashboards?: GrafanaDashboard[];
+    notifications?: GatusConfig;
   }): Manifest {
     if (SetupWizard) manifest.setupWizard = SetupWizard;
     if (disclaimer) manifest.disclaimer = { message: disclaimer };
     if (gettingStarted) manifest.gettingStarted = gettingStarted;
     if (prometheusTargets) manifest.prometheusTargets = prometheusTargets;
     if (grafanaDashboards && grafanaDashboards.length > 0) manifest.grafanaDashboards = grafanaDashboards;
+    if (notifications) manifest.notifications = notifications;
 
     return manifest;
   }

packages/installer/test/unit/release/findEntries.test.ts

@@ -54,7 +54,8 @@ describe("validateTarImage", () => {
       "host-grafana-dashboard.json",
       "prometheus-targets.json",
       "setup-wizard.json",
-      "signature.json"
+      "signature.json",
+      "notifications.yaml"
     ].map((name) => ({
       name,
       path: `Qm-root/${name}`,
@@ -70,6 +71,7 @@ describe("validateTarImage", () => {
       disclaimer: "disclaimer.md",
       gettingStarted: "getting-started.md",
       prometheusTargets: "prometheus-targets.json",
+      notifications: "notifications.yaml",
       grafanaDashboards: ["docker-grafana-dashboard.json", "host-grafana-dashboard.json"]
     };
 

packages/toolkit/src/repository/repository.ts

@@ -70,7 +70,6 @@ export class DappnodeRepository extends ApmRepository {
   private async pinAddNoThrow(hash: any): Promise<void> {
     try {
       await this.ipfs.pin.add(hash);
-
     } catch (e) {
       // Do not spam the terminal
       // console.error(`Error pinning ${hash}`, e);
@@ -205,7 +204,8 @@ export class DappnodeRepository extends ApmRepository {
       disclaimer: await this.getPkgAsset(releaseFilesToDownload.disclaimer, ipfsEntries),
       gettingStarted: await this.getPkgAsset(releaseFilesToDownload.gettingStarted, ipfsEntries),
       prometheusTargets: await this.getPkgAsset(releaseFilesToDownload.prometheusTargets, ipfsEntries),
-      grafanaDashboards: await this.getPkgAsset(releaseFilesToDownload.grafanaDashboards, ipfsEntries)
+      grafanaDashboards: await this.getPkgAsset(releaseFilesToDownload.grafanaDashboards, ipfsEntries),
+      notifications: await this.getPkgAsset(releaseFilesToDownload.notifications, ipfsEntries)
     };
   }
 

packages/types/src/index.ts

@@ -10,6 +10,7 @@ export * from "./releaseFiles.js";
 export * from "./errors.js";
 export * from "./routes.js";
 export * from "./subscriptions.js";
+export * from "./notifications.js";
 
 // utils
 export * from "./utils/index.js";

packages/types/src/manifest.ts

@@ -1,3 +1,4 @@
+import { GatusConfig } from "./notifications.js";
 import { SetupSchema, SetupTarget, SetupUiJson, SetupWizard } from "./setupWizard.js";
 
 export interface Manifest {
@@ -98,6 +99,9 @@ export interface Manifest {
 
   // setupWizard for compacted manifests in core packages
   setupWizard?: SetupWizard;
+
+  // notifications
+  notifications?: GatusConfig;
 }
 
 export interface UpstreamItem {

packages/types/src/notifications.ts

@@ -0,0 +1,47 @@
+export interface Notification {
+  title: string;
+  body: string;
+  dnpName: string;
+  timestamp: string;
+  category: string;
+  seen: boolean;
+  callToAction?: {
+    title: string;
+    url: string;
+  };
+}
+
+export interface GatusConfig {
+  endpoints: Endpoint[];
+}
+
+export interface Endpoint {
+  name: string;
+  enabled: boolean;
+  url: string;
+  method: string;
+  conditions: string[];
+  interval: string; // e.g., "1m"
+  group: string;
+  alerts: Alert[];
+  definition: {
+    // dappnode specific
+    title: string;
+    description: string;
+  };
+  metric?: {
+    // dappnode specific
+    min: number;
+    max: number;
+    unit: string; // e.g ºC
+  };
+}
+
+interface Alert {
+  type: string;
+  "failure-threshold": number;
+  "success-threshold": number;
+  "send-on-resolved": boolean;
+  description: string;
+  enabled: boolean;
+}

packages/types/src/pkg.ts

@@ -1,5 +1,6 @@
 import { Compose } from "./compose.js";
 import { Manifest, PrometheusTarget, GrafanaDashboard } from "./manifest.js";
+import { GatusConfig } from "./notifications.js";
 import { SetupWizard } from "./setupWizard.js";
 
 /**
@@ -97,6 +98,7 @@ export type DirectoryFiles = {
   gettingStarted?: string;
   prometheusTargets?: PrometheusTarget[];
   grafanaDashboards?: GrafanaDashboard[];
+  notifications?: GatusConfig;
 };
 
 export interface FileConfig {

packages/types/src/releaseFiles.ts

@@ -84,6 +84,13 @@ export const releaseFiles = Object.freeze({
     maxSize: 10e6, // ~ 10MB
     required: false as const,
     multiple: true as const
+  }),
+  notifications: Object.freeze({
+    regex: /^.*notifications\.yaml$/,
+    format: FileFormat.YAML,
+    maxSize: 10e3,
+    required: false as const,
+    multiple: false as const
   })
 } as const);
 
@@ -95,5 +102,6 @@ export const releaseFilesToDownload = {
   disclaimer: releaseFiles.disclaimer,
   gettingStarted: releaseFiles.gettingStarted,
   prometheusTargets: releaseFiles.prometheusTargets,
-  grafanaDashboards: releaseFiles.grafanaDashboards
+  grafanaDashboards: releaseFiles.grafanaDashboards,
+  notifications: releaseFiles.notifications
 };