@certik/skynet 0.10.4 → 0.10.7

package/monitor.js

@@ -1,192 +1,191 @@
-const meow = require("meow");
-const fetch = require("node-fetch");
-const { getSelectorFlags, getSelectorDesc, toSelectorString } = require("./selector");
-const { getBinaryName } = require("./cli");
-const { exponentialRetry } = require("./availability");
-const { getIndexerLatestId, getIndexerValidatedId, getIndexerState } = require("./indexer");
-const { postGenieMessage } = require("./opsgenie");
-const { getJobName } = require("./deploy");
-
-const ERROR_LEVEL = {
-  INFO: "Info",
-  CRITICAL: "Critical",
-  WARNING: "Warning",
-};
-
-const LEVEL_EMOJI = {
-  Critical: ":exclamation:",
-  Warning: ":warning:",
-  Info: "",
-};
-
-const LEVEL_PRIORITY = {
-  Critical: 3,
-  Warning: 2,
-  Info: 1,
-};
-
-function sortErrors(errors) {
-  return errors.sort((e1, e2) => (LEVEL_PRIORITY[e2.type] || 0) - (LEVEL_PRIORITY[e1.type] || 0));
-}
-
-async function getMostRecentJobLaunch(name) {
-  try {
-    const jobsRes = await fetch(`http://localhost:4646/v1/jobs?prefix=${name}`);
-
-    if (!jobsRes.ok) {
-      console.log(`[MONITOR] request local nomad API failed`);
-
-      return null;
-    }
-
-    const jobs = await jobsRes.json();
-
-    if (jobs.length === 0) {
-      console.log(`[MONITOR] did not see any jobs prefixed with ${name}`);
-
-      return null;
-    }
-
-    const recentFinishedJob = jobs.reverse().find((job) => {
-      // filter out monitor job
-      return job.ID.indexOf("-monitor") === -1 && job.Status === "dead";
-    });
-
-    if (!recentFinishedJob) {
-      console.log(`[MONITOR] did not see any dead jobs`);
-
-      return null;
-    }
-
-    console.log("[MONITOR]", "most recent job info", recentFinishedJob.ID, recentFinishedJob.JobSummary.Summary);
-
-    return recentFinishedJob;
-  } catch (getJobError) {
-    console.log("[MONITOR]", "cannot get most recent job", getJobError.message);
-    return null;
-  }
-}
-
-function createMonitor({ binaryName, name, type = "stateless", mode = false, selector = {}, check, maxRetry = 2 }) {
-  function monitor() {
-    if (!binaryName) {
-      binaryName = getBinaryName();
-    }
-
-    const cli = meow(
-      `
-        Usage
-
-          $ ${binaryName} <options>
-
-        Options
-${
-  mode ? "          --mode          could be delta/rebuild/resume-rebuild/validate/one/range/reset\n" : ""
-}${getSelectorDesc(selector)}
-          --production    run in production mode
-          --verbose       Output debug messages
-      `,
-      {
-        description: false,
-        version: false,
-        flags: {
-          ...getSelectorFlags(selector),
-          ...(mode && {
-            mode: {
-              type: "string",
-              default: "delta",
-            },
-          }),
-          verbose: {
-            type: "boolean",
-            default: false,
-          },
-        },
-      }
-    );
-
-    async function runCheck({ verbose, production, mode, ...selectorFlags }) {
-      const startTime = Date.now();
-      console.log(`[MONITOR] starting check, ${toSelectorString(selectorFlags, ", ")}`);
-
-      const state = {};
-
-      if (type === "stateful") {
-        state.latestId = await getIndexerLatestId(name, selectorFlags);
-        state.validatedId = await getIndexerValidatedId(name, selectorFlags);
-        state.buildState = await getIndexerState(name, selectorFlags);
-      }
-
-      let result = await exponentialRetry(
-        async () => {
-          try {
-            const errors = await check({ verbose, state, mode, ...selectorFlags });
-
-            if (!Array.isArray(errors)) {
-              throw new Error(`check function must return array of error messages`);
-            }
-
-            return errors;
-          } catch (err) {
-            console.log(`[MONITOR] got error in check`, err);
-
-            return [`${err.message}`];
-          }
-        },
-        {
-          maxRetry,
-          initialDuration: 10000,
-          growFactor: 3,
-          test: (r) => r.length === 0,
-          verbose,
-        }
-      );
-
-      const jobName = getJobName(name, selectorFlags, mode);
-      const mostRecentJob = await getMostRecentJobLaunch(jobName);
-
-      if (result.length > 0) {
-        console.log("Found Errors", result);
-
-        if (production) {
-          const nomadAddr = process.env.SKYNET_NOMAD_PRODUCTION_ADDR;
-
-          // alert on opsgenie
-          await postGenieMessage(
-            `Failed Service Check: ${jobName}`,
-            `<p><b>Service:</b><a href="${nomadAddr}/ui/jobs/${jobName}" target="_blank">${jobName}</a></p><p><b>Issues</b></p><ul>${sortErrors(
-              result
-            )
-              .map((m) => `<li><b>${m.type}:</b> ${m.message}</li>`)
-              .join("")}</ul>`,
-            verbose
-          );
-        } else {
-          console.log("skip sending messages to opsgenie in dev env");
-        }
-      }
-
-      console.log(`[MONITOR] check successfully in ${Date.now() - startTime}ms`);
-
-      if (mostRecentJob && mostRecentJob.ParentID === "" && mostRecentJob.Periodic === false) {
-        // stop monitor job if the main job was a one time job and completed
-        const stopRes = await fetch(`http://localhost:4646/v1/job/${jobName}-monitor`, { method: "DELETE" });
-
-        if (stopRes.ok) {
-          console.log(`[MONITOR] monitor job stopped since the completed main job was a one time job`);
-        } else {
-          console.log(`[MONITOR] error stopping monitor job`);
-        }
-      }
-    }
-
-    runCheck(cli.flags).catch((err) => {
-      console.log("[MONITOR]", err);
-      process.exit(1);
-    });
-  }
-
-  return { monitor };
-}
-
-module.exports = { createMonitor, ERROR_LEVEL, LEVEL_EMOJI };
+const meow = require("meow");
+const fetch = require("node-fetch");
+const { getSelectorFlags, getSelectorDesc, toSelectorString } = require("./selector");
+const { getBinaryName } = require("./cli");
+const { exponentialRetry } = require("./availability");
+const { postGenieMessage } = require("./opsgenie");
+const { getJobName } = require("./deploy");
+
+const ERROR_LEVEL = {
+  INFO: "Info",
+  CRITICAL: "Critical",
+  WARNING: "Warning",
+};
+
+const LEVEL_EMOJI = {
+  Critical: ":exclamation:",
+  Warning: ":warning:",
+  Info: "",
+};
+
+const LEVEL_PRIORITY = {
+  Critical: 3,
+  Warning: 2,
+  Info: 1,
+};
+
+function sortErrors(errors) {
+  return errors.sort((e1, e2) => (LEVEL_PRIORITY[e2.type] || 0) - (LEVEL_PRIORITY[e1.type] || 0));
+}
+
+async function getMostRecentJobLaunch(name) {
+  try {
+    const jobsRes = await fetch(`http://localhost:4646/v1/jobs?prefix=${name}`);
+
+    if (!jobsRes.ok) {
+      console.log(`[MONITOR] request local nomad API failed`);
+
+      return null;
+    }
+
+    const jobs = await jobsRes.json();
+
+    if (jobs.length === 0) {
+      console.log(`[MONITOR] did not see any jobs prefixed with ${name}`);
+
+      return null;
+    }
+
+    const recentFinishedJob = jobs.reverse().find((job) => {
+      // filter out monitor job
+      return job.ID.indexOf("-monitor") === -1 && job.Status === "dead";
+    });
+
+    if (!recentFinishedJob) {
+      console.log(`[MONITOR] did not see any dead jobs`);
+
+      return null;
+    }
+
+    console.log("[MONITOR]", "most recent job info", recentFinishedJob.ID, recentFinishedJob.JobSummary.Summary);
+
+    return recentFinishedJob;
+  } catch (getJobError) {
+    console.log("[MONITOR]", "cannot get most recent job", getJobError.message);
+    return null;
+  }
+}
+
+function createMonitor({ binaryName, name, getState = null, mode = false, selector = {}, check, maxRetry = 2 }) {
+  function monitor() {
+    if (!binaryName) {
+      binaryName = getBinaryName();
+    }
+
+    const cli = meow(
+      `
+        Usage
+
+          $ ${binaryName} <options>
+
+        Options
+${
+  mode ? "          --mode          could be delta/rebuild/resume-rebuild/validate/one/range/reset\n" : ""
+}${getSelectorDesc(selector)}
+          --production    run in production mode
+          --verbose       Output debug messages
+      `,
+      {
+        description: false,
+        version: false,
+        flags: {
+          ...getSelectorFlags(selector),
+          ...(mode && {
+            mode: {
+              type: "string",
+              default: "delta",
+            },
+          }),
+          verbose: {
+            type: "boolean",
+            default: false,
+          },
+        },
+      }
+    );
+
+    async function runCheck({ verbose, production, mode, ...selectorFlags }) {
+      const startTime = Date.now();
+      console.log(`[MONITOR] starting check, ${toSelectorString(selectorFlags, ", ")}`);
+
+      let checkState = {};
+
+      if (getState) {
+        checkState = await getState(name, selectorFlags);
+      }
+
+      let result = await exponentialRetry(
+        async () => {
+          try {
+            const errors = await check({ verbose, state: checkState, mode, ...selectorFlags });
+
+            if (!Array.isArray(errors)) {
+              throw new Error(`check function must return array of error messages`);
+            }
+
+            return errors;
+          } catch (err) {
+            console.log(`[MONITOR] got error in check`, err);
+
+            return [`${err.message}`];
+          }
+        },
+        {
+          maxRetry,
+          initialDuration: 10000,
+          growFactor: 3,
+          test: (r) => r.length === 0,
+          verbose,
+        }
+      );
+
+      const jobName = getJobName(name, selectorFlags, mode);
+      const mostRecentJob = await getMostRecentJobLaunch(jobName);
+
+      if (result.length > 0) {
+        console.log("Found Errors", result);
+
+        if (production) {
+          const nomadAddr = process.env.SKYNET_NOMAD_PRODUCTION_ADDR;
+
+          // alert on opsgenie
+          await postGenieMessage(
+            {
+              message: `Failed Service Check: ${jobName}`,
+              description: `<p><b>Service:</b><a href="${nomadAddr}/ui/jobs/${jobName}" target="_blank">${jobName}</a></p><p><b>Issues</b></p><ul>${sortErrors(
+                result
+              )
+                .map((m) => `<li><b>${m.type}:</b> ${m.message}</li>`)
+                .join("")}</ul>`,
+            },
+            verbose
+          );
+        } else {
+          console.log("skip sending messages to opsgenie in dev env");
+        }
+      }
+
+      console.log(`[MONITOR] check successfully in ${Date.now() - startTime}ms`);
+
+      if (mostRecentJob && mostRecentJob.ParentID === "" && mostRecentJob.Periodic === false) {
+        // stop monitor job if the main job was a one time job and completed
+        const stopRes = await fetch(`http://localhost:4646/v1/job/${jobName}-monitor`, { method: "DELETE" });
+
+        if (stopRes.ok) {
+          console.log(`[MONITOR] monitor job stopped since the completed main job was a one time job`);
+        } else {
+          console.log(`[MONITOR] error stopping monitor job`);
+        }
+      }
+    }
+
+    runCheck(cli.flags).catch((err) => {
+      console.log("[MONITOR]", err);
+      process.exit(1);
+    });
+  }
+
+  return { monitor };
+}
+
+module.exports = { createMonitor, ERROR_LEVEL, LEVEL_EMOJI };

package/opsgenie.js

@@ -1,60 +1,55 @@
-const fetch = require("node-fetch");
-const hash = require("object-hash");
-
-function getGenieKey() {
-  return process.env.OPSGENIE_API_KEY;
-}
-
-function getGenieEndPoint() {
-  const key = getGenieKey();
-
-  if (!key) {
-    throw new Error("Cannot communicate with opsgenie due to missing API key: process.env.OPSGENIE_API_KEY");
-  }
-
-  return process.env.OPSGENIE_END_POINT;
-}
-
-async function postGenieMessage(msg, desc, verbose) {
-  try {
-    const genieKey = getGenieKey();
-    const genieEndPoint = getGenieEndPoint();
-
-    const body = {
-      message: msg,
-      description: desc
-    };
-
-    // Prevents duplicate alerts (See Opsgenie doc about alias)
-    const bodyHash = hash(body);
-    body.alias = bodyHash;
-
-    if (verbose) {
-      console.log(`Making API call to Opsgenie ${msg} (${desc}):`, JSON.stringify(body, null, 2));
-    }
-
-    // Makes the call using fetch and ENV variables
-    const response = await fetch(genieEndPoint, {
-      method: "POST",
-      headers: {
-          "Content-Type": "application/json",
-          "Authorization": "GenieKey " + genieKey
-      },
-      body: JSON.stringify(body)
-    });
-
-    const result = await response.json();
-    if (verbose) {
-      console.log(`Result of API call to Opsgenie... ${result}`);
-    }
-
-    return result
-
-  } catch (error) {
-    console.error("Failed to make opsgenie API call", error);
-
-    throw error;
-  }
-}
-
-module.exports = { postGenieMessage };
+const fetch = require("node-fetch");
+const md5 = require("md5");
+
+function getGenieKey() {
+  return process.env.OPSGENIE_API_KEY;
+}
+
+function getGenieEndPoint() {
+  const key = getGenieKey();
+
+  if (!key) {
+    throw new Error("Cannot communicate with opsgenie due to missing API key: process.env.OPSGENIE_API_KEY");
+  }
+
+  return process.env.OPSGENIE_END_POINT;
+}
+
+async function postGenieMessage(body, verbose) {
+  try {
+    const genieKey = getGenieKey();
+    const genieEndPoint = getGenieEndPoint();
+
+    // Prevents duplicate alerts (See Opsgenie doc about alias)
+    if (!body.alias) {
+      body.alias = md5(body.message);
+    }
+
+    if (verbose) {
+      console.log(`Making API call to Opsgenie`, JSON.stringify(body, null, 2));
+    }
+
+    // Makes the call using fetch and ENV variables
+    const response = await fetch(genieEndPoint, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `GenieKey ${genieKey}`,
+      },
+      body: JSON.stringify(body),
+    });
+
+    const result = await response.json();
+    if (verbose) {
+      console.log(`Result of API call to Opsgenie... ${result}`);
+    }
+
+    return result;
+  } catch (error) {
+    console.error("Failed to make opsgenie API call", error);
+
+    throw error;
+  }
+}
+
+module.exports = { postGenieMessage };

package/package.json

@@ -1,34 +1,37 @@
-{
-  "name": "@certik/skynet",
-  "version": "0.10.4",
-  "description": "Skynet Shared JS library",
-  "main": "index.js",
-  "author": "CertiK Engineering",
-  "scripts": {
-    "lint": "eslint . test",
-    "test": "ava"
-  },
-  "engines": {
-    "node": ">= 14"
-  },
-  "dependencies": {
-    "@slack/web-api": "^6.4.0",
-    "aws-sdk": "^2.932.0",
-    "chalk": "^4.1.1",
-    "execa": "^5.0.0",
-    "express": "^4.18.1",
-    "kafkajs": "^1.15.0",
-    "meow": "^7.0.1",
-    "node-fetch": "^2.6.1",
-    "object-hash": "^2.2.0",
-    "snowflake-sdk": "^1.6.3",
-    "web3": "^1.3.5",
-    "which": "^2.0.2"
-  },
-  "devDependencies": {
-    "ava": "^3.13.0",
-    "eslint": "^7.22.0",
-    "sinon": "^11.1.2"
-  },
-  "license": "MIT"
-}
+{
+  "name": "@certik/skynet",
+  "version": "0.10.7",
+  "description": "Skynet Shared JS library",
+  "main": "index.js",
+  "author": "CertiK Engineering",
+  "scripts": {
+    "lint": "eslint *.js test",
+    "test": "ava"
+  },
+  "engines": {
+    "node": ">= 14"
+  },
+  "dependencies": {
+    "@slack/web-api": "^6.4.0",
+    "ably": "^1.2.22",
+    "aws-sdk": "^2.932.0",
+    "bottleneck": "^2.19.5",
+    "chalk": "^4.1.1",
+    "execa": "^5.0.0",
+    "express": "^4.18.1",
+    "kafkajs": "^1.15.0",
+    "md5": "^2.3.0",
+    "meow": "^7.0.1",
+    "node-fetch": "^2.6.1",
+    "snowflake-sdk": "^1.6.3",
+    "web3": "^1.3.5",
+    "which": "^2.0.2"
+  },
+  "devDependencies": {
+    "ava": "^3.13.0",
+    "eslint": "^7.22.0",
+    "eslint-plugin-import": "^2.26.0",
+    "sinon": "^11.1.2"
+  },
+  "license": "MIT"
+}