Merge pull request #220 from Theodo-UK/feature/58-push-notifications

Feature/58 push notifications

Author: DotGav

README.md

@@ -59,10 +59,11 @@ sls-dev-tools is currently being actively maintained. If you find a problem with
 - [Shortcuts to AWS Console](#shortcuts-to-aws-console)
 - [Changing region using the map](#changing-region-using-the-map)
 - [Shortcuts](#shortcuts)
+- [Error Notifications](#error-notifications)
 
 [A note on AWS API calls and pricing](#a-note-on-aws-api-calls-and-pricing)\
 [Libs](#libs)\
-[Contributors ✨](#contributors-✨)
+[Contributors ✨](#contributors-)
 
 ## Installation
 
@@ -196,6 +197,12 @@ Shortcuts
 - Pressing "l" will display a box with more statistics on the selected lambda
 ```
 
+## Error notifications
+
+The tool will notify you when the Lambda you're monitoring errors.
+
+![pushNotification](./img/pushNotification.gif)
+
 # A note on AWS API calls and pricing
 
 This tool does make use of the AWS API to get metrics. Authentication is handled implicitly via the AWS NodeJS SDK. Pricing around Cloudwatch is designed for scale, but be warned that this tool is making calls to AWS.

docs/README.md

@@ -135,6 +135,12 @@ Shortcuts
 - Pressing "l" will display a box with more statistics on the selected lambda
 ```
 
+## Error notifications
+
+The tool will notify you when the Lambda you're monitoring errors.
+
+![pushNotification](./assets/pushNotification.gif)
+
 # A note on AWS API calls and pricing
 
 This tool does make use of the AWS API to get metrics. Authentication is handled implicitly via the AWS NodeJS SDK. Pricing around Cloudwatch is designed for scale, but be warned that this tool is making calls to AWS.

docs/assets/pushNotification.gif

@@ -11,6 +11,7 @@
     "js-yaml": "^3.13.1",
     "moment": "^2.24.0",
     "node-emoji": "^1.10.0",
+    "node-notifier": "^7.0.0",
     "open": "^7.0.3",
     "prop-types": "^15.7.2",
     "update-notifier": "^4.1.0"

img/pushNotification.gif

@@ -276,9 +276,7 @@ class Main {
     this.prevError = {};
     // Store events from cloudwatchLogs
     this.events = [];
-    // Allows use of .bell() function for notifications
-    this.notifier = new blessed.Program();
-
+    // Check if there's an npm update available
     checkForUpdates();
   }
 
@@ -377,7 +375,6 @@ class Main {
 
   async render() {
     setInterval(() => {
-      console.log(process.memoryUsage());
       this.map.updateMap();
       this.updateResourcesInformation();
       this.updateGraphs();

package.json

@@ -5,9 +5,9 @@ function invokeLambda(awsLambdaApi, functionName, payload) {
     Payload: payload,
   };
   awsLambdaApi.invoke(params, (err, data) => {
-    if (err) console.log(err, err.stack);
+    if (err) console.error(err, err.stack);
     // an error occurred
-    else console.log(data); // successful response
+    else console.log(data.Payload); // successful response
   });
 }
 

src/index.js

@@ -1,3 +1,5 @@
+const notifier = require("node-notifier");
+
 function updateLogContentsFromEvents(log, events) {
   if (!events || events.length === 0) {
     log.setContent("ERROR: No log streams found for this function.");
@@ -30,8 +32,11 @@ function checkLogsForErrors(events, application) {
     latestError.errorId !== application.prevError.errorId &&
     latestError.logId === application.prevError.logId
   ) {
-    application.notifier.bell();
-    console.log("Recent lambda error. Check logs for details");
+    notifier.notify({
+      title: "sls-dev-tools: Recent lambda error",
+      message: "Check the dashboard logs for details",
+      sound: true,
+    });
   }
 
   application.setPrevError(latestError);

src/services/invoke.js

@@ -2456,6 +2456,11 @@ graceful-fs@^4.1.11, graceful-fs@^4.1.2:
   resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.3.tgz#4a12ff1b60376ef09862c2093edd908328be8423"
   integrity sha512-a30VEBm4PEdx1dRB7MFK7BejejvCvBronbLjht+sHuGYj8PHs7M/5Z+rt5lw551vZ7yfTCj4Vuyy3mSJytDWRQ==
 
+growly@^1.3.0:
+  version "1.3.0"
+  resolved "https://registry.yarnpkg.com/growly/-/growly-1.3.0.tgz#f10748cbe76af964b7c96c93c6bcc28af120c081"
+  integrity sha1-8QdIy+dq+WS3yWyTxrzCivEgwIE=
+
 has-ansi@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/has-ansi/-/has-ansi-2.0.0.tgz#34f5049ce1ecdf2b0649af3ef24e45ed35416d91"
@@ -3353,6 +3358,18 @@ node-fetch@^2.3.0:
   resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.0.tgz#e633456386d4aa55863f676a7ab0daa8fdecb0fd"
   integrity sha512-8dG4H5ujfvFiqDmVu9fQ5bOHUC15JMjMY/Zumv26oOvvVJjM67KF8koCWIabKQ1GJIa9r2mMZscBq/TbdOcmNA==
 
+node-notifier@^7.0.0:
+  version "7.0.0"
+  resolved "https://registry.yarnpkg.com/node-notifier/-/node-notifier-7.0.0.tgz#513bc42f2aa3a49fce1980a7ff375957c71f718a"
+  integrity sha512-y8ThJESxsHcak81PGpzWwQKxzk+5YtP3IxR8AYdpXQ1IB6FmcVzFdZXrkPin49F/DKUCfeeiziB8ptY9npzGuA==
+  dependencies:
+    growly "^1.3.0"
+    is-wsl "^2.1.1"
+    semver "^7.2.1"
+    shellwords "^0.1.1"
+    uuid "^7.0.3"
+    which "^2.0.2"
+
 node-releases@^1.1.53:
   version "1.1.53"
   resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-1.1.53.tgz#2d821bfa499ed7c5dffc5e2f28c88e78a08ee3f4"
@@ -4188,7 +4205,7 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/semver/-/semver-7.0.0.tgz#5f3ca35761e47e05b206c6daff2cf814f0316b8e"
   integrity sha512-+GB6zVA9LWh6zovYQLALHwv5rb2PHGlJi3lfiqIHxR0uuwCgefcOJc59v9fv1w8GbStwxuuqqAjI9NMAOOgq1A==
 
-[email protected]:
+[email protected], semver@^7.2.1:
   version "7.3.2"
   resolved "https://registry.yarnpkg.com/semver/-/semver-7.3.2.tgz#604962b052b81ed0786aae84389ffba70ffd3938"
   integrity sha512-OrOb32TeeambH6UrhtShmF7CRDqhL6/5XpPNp2DuRH6+9QLw/orhp72j87v8Qa1ScDkvrrBNpZcDejAirJmfXQ==
@@ -4241,6 +4258,11 @@ [email protected]:
     interpret "^1.0.0"
     rechoir "^0.6.2"
 
+shellwords@^0.1.1:
+  version "0.1.1"
+  resolved "https://registry.yarnpkg.com/shellwords/-/shellwords-0.1.1.tgz#d6b9181c1a48d397324c84871efbcfc73fc0654b"
+  integrity sha512-vFwSUfQvqybiICwZY5+DAWIPLKsWO31Q91JSKl3UYv+K5c2QRPzn0qzec6QPu1Qc9eHYItiP3NdJqNVqetYAww==
+
 signal-exit@^3.0.0:
   version "3.0.3"
   resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.3.tgz#a1410c2edd8f077b08b4e253c8eacfcaf057461c"
@@ -4740,6 +4762,11 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/uuid/-/uuid-8.0.0.tgz#bc6ccf91b5ff0ac07bbcdbf1c7c4e150db4dbb6c"
   integrity sha512-jOXGuXZAWdsTH7eZLtyXMqUb9EcWMGZNbL9YcGBJl4MH4nrxHmZJhEHvyLFrkxo+28uLb/NYRcStH48fnD0Vzw==
 
+uuid@^7.0.3:
+  version "7.0.3"
+  resolved "https://registry.yarnpkg.com/uuid/-/uuid-7.0.3.tgz#c5c9f2c8cf25dc0a372c4df1441c41f5bd0c680b"
+  integrity sha512-DPSke0pXhTZgoF/d+WSt2QaKMCFSfx7QegxEWT+JOuHF5aWrKEn0G+ztjuJg/gG8/ItK+rbPCD/yNv8yyih6Cg==
+
 v8-compile-cache@^2.0.3:
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/v8-compile-cache/-/v8-compile-cache-2.1.0.tgz#e14de37b31a6d194f5690d67efc4e7f6fc6ab30e"
@@ -4767,7 +4794,7 @@ which@^1.2.9:
   dependencies:
     isexe "^2.0.0"
 
-which@^2.0.1:
+which@^2.0.1, which@^2.0.2:
   version "2.0.2"
   resolved "https://registry.yarnpkg.com/which/-/which-2.0.2.tgz#7c6a8dd0a636a0327e10b59c9286eee93f3f51b1"
   integrity sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==