diff --git a/CHANGELOG.md b/CHANGELOG.md index 0e9d64d1..d8df4b33 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,7 +16,7 @@ _This release is scheduled to be released on 2021-04-01._ - Added CURRENTWEATHER_TYPE notification to currentweather and weather module, use it in compliments module. - Added `start:dev` command to the npm scripts for starting electron with devTools open. - Added logging when using deprecated modules weatherforecast or currentweather. -- Portuguese translations for "MODULE_CONFIG_CHANGED" and PRECIP. +- Added Portuguese translations for "MODULE_CONFIG_CHANGED" and "PRECIP". - Respect parameter ColoredSymbolOnly also for custom events - Added a new parameter to hide time portion on relative times - `module.show` has now the option for a callback on error. @@ -39,6 +39,7 @@ _This release is scheduled to be released on 2021-04-01._ - Exposed logger as node module for easier access for 3rd party modules - Replaced deprecated `request` package with `node-fetch` and `digest-fetch` - Refactored calendar fetcher +- Cleaned up newsfeed module ### Removed diff --git a/modules/default/calendar/calendar.js b/modules/default/calendar/calendar.js index 4a485e4f..292ceab1 100755 --- a/modules/default/calendar/calendar.js +++ b/modules/default/calendar/calendar.js @@ -482,7 +482,6 @@ Module.register("calendar", { for (const calendarUrl in this.calendarData) { const calendar = this.calendarData[calendarUrl]; - console.log(calendar); for (const e in calendar) { const event = JSON.parse(JSON.stringify(calendar[e])); // clone object diff --git a/modules/default/newsfeed/newsfeed.js b/modules/default/newsfeed/newsfeed.js index a94e7269..441984f4 100644 --- a/modules/default/newsfeed/newsfeed.js +++ b/modules/default/newsfeed/newsfeed.js @@ -66,6 +66,7 @@ Module.register("newsfeed", { this.newsItems = []; this.loaded = false; + this.error = null; this.activeItem = 0; this.scrollPosition = 0; @@ -87,8 +88,10 @@ Module.register("newsfeed", { } this.loaded = true; + this.error = null; } else if (notification === "INCORRECT_URL") { - Log.error("Newsfeed Error. Incorrect url: " + payload.url); + this.error = `Incorrect url: ${payload.url}`; + this.scheduleUpdateInterval(); } }, @@ -110,15 +113,20 @@ Module.register("newsfeed", { url: this.getActiveItemURL() }; } + if (this.error) { + return { + error: this.error + }; + } if (this.newsItems.length === 0) { return { loaded: false }; } - if (this.activeItem >= this.newsItems.length) { this.activeItem = 0; } + const item = this.newsItems[this.activeItem]; return { @@ -139,8 +147,7 @@ Module.register("newsfeed", { * Registers the feeds to be used by the backend. */ registerFeeds: function () { - for (var f in this.config.feeds) { - var feed = this.config.feeds[f]; + for (let feed of this.config.feeds) { this.sendSocketNotification("ADD_FEED", { feed: feed, config: this.config @@ -154,12 +161,11 @@ Module.register("newsfeed", { * @param {object} feeds An object with feeds returned by the node helper. */ generateFeed: function (feeds) { - var newsItems = []; - for (var feed in feeds) { - var feedItems = feeds[feed]; + let newsItems = []; + for (let feed in feeds) { + const feedItems = feeds[feed]; if (this.subscribedToFeed(feed)) { - for (var i in feedItems) { - var item = feedItems[i]; + for (let item of feedItems) { item.sourceTitle = this.titleForFeed(feed); if (!(this.config.ignoreOldItems && Date.now() - new Date(item.pubdate) > this.config.ignoreOlderThan)) { newsItems.push(item); @@ -168,8 +174,8 @@ Module.register("newsfeed", { } } newsItems.sort(function (a, b) { - var dateA = new Date(a.pubdate); - var dateB = new Date(b.pubdate); + const dateA = new Date(a.pubdate); + const dateB = new Date(b.pubdate); return dateB - dateA; }); if (this.config.maxNewsItems > 0) { @@ -178,8 +184,8 @@ Module.register("newsfeed", { if (this.config.prohibitedWords.length > 0) { newsItems = newsItems.filter(function (value) { - for (var i = 0; i < this.config.prohibitedWords.length; i++) { - if (value["title"].toLowerCase().indexOf(this.config.prohibitedWords[i].toLowerCase()) > -1) { + for (let word of this.config.prohibitedWords) { + if (value["title"].toLowerCase().indexOf(word.toLowerCase()) > -1) { return false; } } @@ -190,18 +196,18 @@ Module.register("newsfeed", { newsItems.forEach((item) => { //Remove selected tags from the beginning of rss feed items (title or description) if (this.config.removeStartTags === "title" || this.config.removeStartTags === "both") { - for (let f = 0; f < this.config.startTags.length; f++) { - if (item.title.slice(0, this.config.startTags[f].length) === this.config.startTags[f]) { - item.title = item.title.slice(this.config.startTags[f].length, item.title.length); + for (let startTag of this.config.startTags) { + if (item.title.slice(0, startTag.length) === startTag) { + item.title = item.title.slice(startTag.length, item.title.length); } } } if (this.config.removeStartTags === "description" || this.config.removeStartTags === "both") { if (this.isShowingDescription) { - for (let f = 0; f < this.config.startTags.length; f++) { - if (item.description.slice(0, this.config.startTags[f].length) === this.config.startTags[f]) { - item.description = item.description.slice(this.config.startTags[f].length, item.description.length); + for (let startTag of this.config.startTags) { + if (item.description.slice(0, startTag.length) === startTag) { + item.description = item.description.slice(startTag.length, item.description.length); } } } @@ -210,16 +216,16 @@ Module.register("newsfeed", { //Remove selected tags from the end of rss feed items (title or description) if (this.config.removeEndTags) { - for (let f = 0; f < this.config.endTags.length; f++) { - if (item.title.slice(-this.config.endTags[f].length) === this.config.endTags[f]) { - item.title = item.title.slice(0, -this.config.endTags[f].length); + for (let endTag of this.config.endTags) { + if (item.title.slice(-endTag.length) === endTag) { + item.title = item.title.slice(0, -endTag.length); } } if (this.isShowingDescription) { - for (let f = 0; f < this.config.endTags.length; f++) { - if (item.description.slice(-this.config.endTags[f].length) === this.config.endTags[f]) { - item.description = item.description.slice(0, -this.config.endTags[f].length); + for (let endTag of this.config.endTags) { + if (item.description.slice(-endTag.length) === endTag) { + item.description = item.description.slice(0, -endTag.length); } } } @@ -227,7 +233,7 @@ Module.register("newsfeed", { }); // get updated news items and broadcast them - var updatedItems = []; + const updatedItems = []; newsItems.forEach((value) => { if (this.newsItems.findIndex((value1) => value1 === value) === -1) { // Add item to updated items list @@ -250,8 +256,7 @@ Module.register("newsfeed", { * @returns {boolean} True if it is subscribed, false otherwise */ subscribedToFeed: function (feedUrl) { - for (var f in this.config.feeds) { - var feed = this.config.feeds[f]; + for (let feed of this.config.feeds) { if (feed.url === feedUrl) { return true; } @@ -266,8 +271,7 @@ Module.register("newsfeed", { * @returns {string} The title of the feed */ titleForFeed: function (feedUrl) { - for (var f in this.config.feeds) { - var feed = this.config.feeds[f]; + for (let feed of this.config.feeds) { if (feed.url === feedUrl) { return feed.title || ""; } @@ -279,22 +283,20 @@ Module.register("newsfeed", { * Schedule visual update. */ scheduleUpdateInterval: function () { - var self = this; - - self.updateDom(self.config.animationSpeed); + this.updateDom(this.config.animationSpeed); // Broadcast NewsFeed if needed - if (self.config.broadcastNewsFeeds) { - self.sendNotification("NEWS_FEED", { items: self.newsItems }); + if (this.config.broadcastNewsFeeds) { + this.sendNotification("NEWS_FEED", { items: this.newsItems }); } - this.timer = setInterval(function () { - self.activeItem++; - self.updateDom(self.config.animationSpeed); + this.timer = setInterval(() => { + this.activeItem++; + this.updateDom(this.config.animationSpeed); // Broadcast NewsFeed if needed - if (self.config.broadcastNewsFeeds) { - self.sendNotification("NEWS_FEED", { items: self.newsItems }); + if (this.config.broadcastNewsFeeds) { + this.sendNotification("NEWS_FEED", { items: this.newsItems }); } }, this.config.updateInterval); }, diff --git a/modules/default/newsfeed/newsfeed.njk b/modules/default/newsfeed/newsfeed.njk index 3d9ecc0b..551e682c 100644 --- a/modules/default/newsfeed/newsfeed.njk +++ b/modules/default/newsfeed/newsfeed.njk @@ -6,7 +6,7 @@ {{ sourceTitle }}{% if config.showPublishDate %}, {% else %}: {% endif %} {% endif %} {% if config.showPublishDate %} - {{ publishDate }}: + {{ publishDate }}: {% endif %} {% endif %} @@ -21,8 +21,12 @@ {% endif %} +{% elseif error %} +
+ {{ "MODULE_CONFIG_ERROR" | translate({MODULE_NAME: "Newsfeed", ERROR: error}) | safe }} +
{% else %}
{{ "LOADING" | translate | safe }}
-{% endif %} \ No newline at end of file +{% endif %} diff --git a/modules/default/newsfeed/newsfeedfetcher.js b/modules/default/newsfeed/newsfeedfetcher.js index 8fc18a9e..d4db511d 100644 --- a/modules/default/newsfeed/newsfeedfetcher.js +++ b/modules/default/newsfeed/newsfeedfetcher.js @@ -19,8 +19,6 @@ const iconv = require("iconv-lite"); * @class */ const NewsfeedFetcher = function (url, reloadInterval, encoding, logFeedWarnings) { - const self = this; - let reloadTimer = null; let items = []; @@ -36,14 +34,14 @@ const NewsfeedFetcher = function (url, reloadInterval, encoding, logFeedWarnings /** * Request the new items. */ - const fetchNews = function () { + const fetchNews = () => { clearTimeout(reloadTimer); reloadTimer = null; items = []; const parser = new FeedMe(); - parser.on("item", function (item) { + parser.on("item", (item) => { const title = item.title; let description = item.description || item.summary || item.content || ""; const pubdate = item.pubdate || item.published || item.updated || item["dc:date"]; @@ -68,13 +66,13 @@ const NewsfeedFetcher = function (url, reloadInterval, encoding, logFeedWarnings } }); - parser.on("end", function () { - self.broadcastItems(); + parser.on("end", () => { + this.broadcastItems(); scheduleTimer(); }); - parser.on("error", function (error) { - fetchFailedCallback(self, error); + parser.on("error", (error) => { + fetchFailedCallback(this, error); scheduleTimer(); }); @@ -87,7 +85,7 @@ const NewsfeedFetcher = function (url, reloadInterval, encoding, logFeedWarnings fetch(url, { headers: headers }) .catch((error) => { - fetchFailedCallback(self, error); + fetchFailedCallback(this, error); scheduleTimer(); }) .then((res) => { @@ -134,7 +132,7 @@ const NewsfeedFetcher = function (url, reloadInterval, encoding, logFeedWarnings return; } Log.info("Newsfeed-Fetcher: Broadcasting " + items.length + " items."); - itemsReceivedCallback(self); + itemsReceivedCallback(this); }; this.onReceive = function (callback) { diff --git a/modules/default/newsfeed/node_helper.js b/modules/default/newsfeed/node_helper.js index 8d365339..6fd461a1 100644 --- a/modules/default/newsfeed/node_helper.js +++ b/modules/default/newsfeed/node_helper.js @@ -74,8 +74,8 @@ module.exports = NodeHelper.create({ * and broadcasts these using sendSocketNotification. */ broadcastFeeds: function () { - var feeds = {}; - for (var f in this.fetchers) { + const feeds = {}; + for (let f in this.fetchers) { feeds[f] = this.fetchers[f].items(); } this.sendSocketNotification("NEWS_ITEMS", feeds); diff --git a/tests/configs/modules/newsfeed/default.js b/tests/configs/modules/newsfeed/default.js index 4355a2b5..94c9a47f 100644 --- a/tests/configs/modules/newsfeed/default.js +++ b/tests/configs/modules/newsfeed/default.js @@ -3,8 +3,7 @@ * By Rodrigo Ramírez Norambuena https://rodrigoramirez.com * MIT Licensed. */ - -var config = { +let config = { port: 8080, ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"], diff --git a/tests/configs/modules/newsfeed/incorrect_url.js b/tests/configs/modules/newsfeed/incorrect_url.js new file mode 100644 index 00000000..110a1968 --- /dev/null +++ b/tests/configs/modules/newsfeed/incorrect_url.js @@ -0,0 +1,38 @@ +/* Magic Mirror Test config newsfeed module + * + * MIT Licensed. + */ +let config = { + port: 8080, + ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"], + + language: "en", + timeFormat: 12, + units: "metric", + electronOptions: { + webPreferences: { + nodeIntegration: true, + enableRemoteModule: true + } + }, + + modules: [ + { + module: "newsfeed", + position: "bottom_bar", + config: { + feeds: [ + { + title: "Incorrect Url", + url: "this is not a valid url" + } + ] + } + } + ] +}; + +/*************** DO NOT EDIT THE LINE BELOW ***************/ +if (typeof module !== "undefined") { + module.exports = config; +} diff --git a/tests/configs/modules/newsfeed/prohibited_words.js b/tests/configs/modules/newsfeed/prohibited_words.js new file mode 100644 index 00000000..e039385e --- /dev/null +++ b/tests/configs/modules/newsfeed/prohibited_words.js @@ -0,0 +1,39 @@ +/* Magic Mirror Test config newsfeed module + * + * MIT Licensed. + */ +let config = { + port: 8080, + ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"], + + language: "en", + timeFormat: 12, + units: "metric", + electronOptions: { + webPreferences: { + nodeIntegration: true, + enableRemoteModule: true + } + }, + + modules: [ + { + module: "newsfeed", + position: "bottom_bar", + config: { + feeds: [ + { + title: "Rodrigo Ramirez Blog", + url: "http://localhost:8080/tests/configs/data/feed_test_rodrigoramirez.xml" + } + ], + prohibitedWords: ["QPanel"] + } + } + ] +}; + +/*************** DO NOT EDIT THE LINE BELOW ***************/ +if (typeof module !== "undefined") { + module.exports = config; +} diff --git a/tests/e2e/modules/newsfeed_spec.js b/tests/e2e/modules/newsfeed_spec.js index 9c9ee2ca..dae3d86b 100644 --- a/tests/e2e/modules/newsfeed_spec.js +++ b/tests/e2e/modules/newsfeed_spec.js @@ -8,7 +8,7 @@ const afterEach = global.afterEach; describe("Newsfeed module", function () { helpers.setupTimeout(this); - var app = null; + let app = null; beforeEach(function () { return helpers @@ -29,8 +29,32 @@ describe("Newsfeed module", function () { process.env.MM_CONFIG_FILE = "tests/configs/modules/newsfeed/default.js"; }); - it("show title newsfeed", function () { - return app.client.waitUntilTextExists(".newsfeed .small", "Rodrigo Ramirez Blog", 10000).should.be.fulfilled; + it("should show the newsfeed title", function () { + return app.client.waitUntilTextExists(".newsfeed .newsfeed-source", "Rodrigo Ramirez Blog", 10000); + }); + + it("should show the newsfeed article", function () { + return app.client.waitUntilTextExists(".newsfeed .newsfeed-title", "QPanel", 10000); + }); + }); + + describe("Custom configuration", function () { + before(function () { + process.env.MM_CONFIG_FILE = "tests/configs/modules/newsfeed/prohibited_words.js"; + }); + + it("should not show articles with prohibited words", function () { + return app.client.waitUntilTextExists(".newsfeed .newsfeed-title", "Problema VirtualBox", 10000); + }); + }); + + describe("Invalid configuration", function () { + before(function () { + process.env.MM_CONFIG_FILE = "tests/configs/modules/newsfeed/incorrect_url.js"; + }); + + it("should show invalid url warning", function () { + return app.client.waitUntilTextExists(".newsfeed .small", "Error in the Newsfeed module. Incorrect url:", 10000); }); }); }); diff --git a/translations/de.json b/translations/de.json index d023cec8..85ede64e 100644 --- a/translations/de.json +++ b/translations/de.json @@ -27,6 +27,7 @@ "NNW": "NNW", "MODULE_CONFIG_CHANGED": "Die Konfigurationsoptionen für das {MODULE_NAME} Modul haben sich geändert. \nBitte überprüfen Sie die Dokumentation.", + "MODULE_CONFIG_ERROR": "Fehler im {MODULE_NAME} Modul. {ERROR}", "UPDATE_NOTIFICATION": "Aktualisierung für MagicMirror² verfügbar.", "UPDATE_NOTIFICATION_MODULE": "Aktualisierung für das {MODULE_NAME} Modul verfügbar.", diff --git a/translations/en.json b/translations/en.json index bdd784d5..f43bd4b9 100644 --- a/translations/en.json +++ b/translations/en.json @@ -27,6 +27,7 @@ "NNW": "NNW", "MODULE_CONFIG_CHANGED": "The configuration options for the {MODULE_NAME} module have changed.\nPlease check the documentation.", + "MODULE_CONFIG_ERROR": "Error in the {MODULE_NAME} module. {ERROR}", "UPDATE_NOTIFICATION": "MagicMirror² update available.", "UPDATE_NOTIFICATION_MODULE": "Update available for {MODULE_NAME} module.",