Release 2.24.0 (#3141)

Signed-off-by: naveen <[email protected]>
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Karsten Hassel <[email protected]>
Co-authored-by: Malte Hallström <[email protected]>
Co-authored-by: Veeck <[email protected]>
Co-authored-by: veeck <[email protected]>
Co-authored-by: dWoolridge <[email protected]>
Co-authored-by: Johan <[email protected]>
Co-authored-by: Dario Mratovich <[email protected]>
Co-authored-by: Dario Mratovich <[email protected]>
Co-authored-by: Magnus <[email protected]>
Co-authored-by: Naveen <[email protected]>
Co-authored-by: buxxi <[email protected]>
Co-authored-by: Thomas Hirschberger <[email protected]>
Co-authored-by: Kristjan ESPERANTO <[email protected]>
Co-authored-by: Andrés Vanegas Jiménez <[email protected]>
Co-authored-by: Dave Child <[email protected]>
Co-authored-by: grenagit <[email protected]>
Co-authored-by: Grena <[email protected]>
Co-authored-by: Magnus Marthinsen <[email protected]>
Co-authored-by: Patrick <[email protected]>
Co-authored-by: Piotr Rajnisz <[email protected]>
Co-authored-by: Suthep Yonphimai <[email protected]>
Co-authored-by: CarJem Generations (Carter Wallace) <[email protected]>
Co-authored-by: Nicholas Fogal <[email protected]>
Co-authored-by: JakeBinney <[email protected]>
Co-authored-by: OWL4C <[email protected]>
Co-authored-by: Oscar Björkman <[email protected]>
Co-authored-by: Ismar Slomic <[email protected]>
Co-authored-by: Jørgen Veum-Wahlberg <[email protected]>
Co-authored-by: Eddie Hung <[email protected]>
Co-authored-by: Bugsounet - Cédric <[email protected]>
Co-authored-by: bugsounet <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Author: 32 people

.eslintrc.json

@@ -24,6 +24,7 @@
 	"rules": {
 		"eqeqeq": "error",
 		"import/order": "error",
+		"no-param-reassign": "error",
 		"no-prototype-builtins": "off",
 		"no-throw-literal": "error",
 		"no-unused-vars": "off",

.gitattributes

@@ -0,0 +1,56 @@
+# .gitattributes snippet to force users to use same line endings for project.
+# 
+# Handle line endings automatically for files detected as text
+# and leave all files detected as binary untouched.
+* text=auto
+
+#
+# The above will handle all files NOT found below
+# https://help.github.com/articles/dealing-with-line-endings/
+# https://github.com/Danimoth/gitattributes/blob/master/Web.gitattributes
+
+
+
+# These files are text and should be normalized (Convert crlf => lf)
+*.php text
+*.css text
+*.scss text
+*.js text
+*.json text
+*.htm text
+*.html text
+*.xml text
+*.txt text
+*.ini text
+*.inc text
+*.pl text
+*.rb text
+*.py text
+*.scm text
+*.sql text
+.htaccess text
+*.sh text
+Dockerfile* text
+*.yml text
+*.yaml text
+*.md text
+*.markdown text
+
+# These files are binary and should be left untouched
+# (binary is a macro for -text -diff)
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.ico binary
+*.mov binary
+*.mp4 binary
+*.mp3 binary
+*.flv binary
+*.fla binary
+*.swf binary
+*.gz binary
+*.zip binary
+*.7z binary
+*.ttf binary
+*.pyc binary

.github/CONTRIBUTING.md

@@ -43,7 +43,7 @@ When submitting a new issue, please supply the following information:
 
 **Platform**: Place your platform here... give us your web browser/Electron version _and_ your hardware (Raspberry Pi 2/3/4, Windows, Mac, Linux, System V UNIX).
 
-**Node Version**: Make sure it's version 14 or later (recommended is 16).
+**Node Version**: Make sure it's version 16 or later (recommended is 18).
 
 **MagicMirror² Version**: Please let us know which version of MagicMirror² you are running. It can be found in the `package.json` file.
 

.github/ISSUE_TEMPLATE/custom.md

@@ -31,7 +31,7 @@ When submitting a new issue, please supply the following information:
 
 **Platform**: Place your platform here... give us your web browser/Electron version _and_ your hardware (Raspberry Pi 2/3/4, Windows, Mac, Linux, System V UNIX).
 
-**Node Version**: Make sure it's version 14 or later (recommended is 16).
+**Node Version**: Make sure it's version 16 or later (recommended is 18).
 
 **MagicMirror² Version**: Please let us know which version of MagicMirror² you are running. It can be found in the `package.json` file.
 

.github/workflows/automated-tests.yaml

@@ -18,7 +18,7 @@ jobs:
     timeout-minutes: 30
     strategy:
       matrix:
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [16.x, 18.x, 20.x]
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v3
@@ -27,11 +27,13 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
           cache: "npm"
-      - name: "Install dependencies and run tests"
+      - name: "Install dependencies"
+        run: |
+          npm run install-mm:dev
+      - name: "Run tests"
         run: |
           Xvfb :99 -screen 0 1024x768x16 &
           export DISPLAY=:99
-          npm run install-mm:dev
           touch css/custom.css
           npm run test:prettier
           npm run test:js

.github/workflows/codecov-test-suites.yaml

@@ -19,11 +19,13 @@ jobs:
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v3
-      - name: "Install dependencies and run coverage"
+      - name: "Install dependencies"
+        run: |
+          npm ci
+      - name: "Run coverage"
         run: |
           Xvfb :99 -screen 0 1024x768x16 &
           export DISPLAY=:99
-          npm ci
           touch css/custom.css
           npm run test:coverage
       - name: "Upload coverage results to codecov"

CHANGELOG.md

@@ -5,6 +5,48 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ❤️ **Donate:** Enjoying MagicMirror²? [Please consider a donation!](https://magicmirror.builders/donate) With your help we can continue to improve the MagicMirror².
 
+## [2.24.0] - 2023-07-01
+
+Thanks to: @angeldeejay, @bugsounet, @buxxi, @CarJem, @dariom, @DaveChild, @dWoolridge, @eddiehung, @grenagit, @Hirschberger, @ismarslomic, @JakeBinney, @KristjanESPERANTO, @MagMar94, @naveensrinivasan, @nfogal, @oscarb, @OWL4C, @psieg, @rajniszp, @retroflex, @SkySails and @tomzt
+
+Special thanks to @khassel, @rejas and @sdetweil for taking over most (if not all) of the work on this release as project collaborators. This version would not be there without their effort. Thank you guys! You are awesome!
+
+### Added
+
+- Added UV Index to hourly and current Weather, with support for Openmeteo
+- Added tests for serveronly
+- Set Timezone `Europe/Berlin` in unit tests (needed for new formatTime tests)
+- Added no-param-reassign eslint rule and fix warnings
+- updatenotification: Added `sendUpdatesNotifications` feature. Broadcast update with `UPDATES` notification to other modules
+- updatenotification: allow force scanning with `SCAN_UPDATES` notification from other modules
+- Added per-calendar fetchInterval
+
+### Removed
+
+- Removed unneeded (and unwanted) '.' after the year in calendar repeatingCountTitle (#2896, second attempt ...)
+
+### Updated
+
+- Added support for precipitation probability with openmeteo weather-provider
+- Update electron to v25.2 and other dependencies
+- Use node v20 in github workflow (replacing v14)
+- Refactor formatTime into common util function for default modules
+- Refactor some calendar methods into own class and added tests for them
+- Split install and run commands in github actions
+- Changed `fetchInterval` of calendar in `config.js.sample` to 7 days so we not to request example calendar too frequently
+- Changed default calendar fetchInterval to one hour
+- Changed calendar url in sample config
+
+### Fixed
+
+- Fix envcanada hourly forecast time (#3080)
+- Fix electron not running under windows after async changes (#3083)
+- Fix style issues after eslint-plugin-jsdoc update
+- Fix don't filter out ongoing full day events (#3095)
+- Fix date not shown when clock in analog mode (#3100)
+- Fix envcanada today percentage-of-precipitation (#3106)
+- Fix updatenotification where no branch is checked out but e.g. a version tag (#3130)
+
 ## [2.23.0] - 2023-04-04
 
 Thanks to: @angeldeejay, @buxxi, @CarJem, @dariom, @DaveChild, @dWoolridge, @grenagit, @Hirschberger, @KristjanESPERANTO, @MagMar94, @naveensrinivasan, @nfogal, @psieg, @rajniszp, @retroflex, @SkySails and @tomzt.
@@ -16,17 +58,18 @@ Special thanks to @khassel, @rejas and @sdetweil for taking over most (if not al
 - Added increments for hourly forecasts in weather module (#2996)
 - Added tests for hourly weather forecast
 - Added possibility to ignore MagicMirror repo in updatenotification module
-- Added Pirate Weather as new weather provider (#3005)
+- Added Pirate Weather as new weather-provider (#3005)
 - Added possibility to use your own templates in Alert module
 - Added error message if `<modulename>.js` file is missing in module folder to get a hint in the logs (#2403)
 - Added possibility to use environment variables in `config.js` (#1756)
 - Added option `pastDaysCount` to default calendar module to control of how many days past events should be displayed
 - Added thai language to alert module
 - Added option `sendNotifications` in clock module (#3056)
+- Added tests for some weather utils
 
 ### Removed
 
-- Removed darksky weather provider
+- Removed darksky weather-provider
 - Removed unneeded (and unwanted) '.' after the year in calendar repeatingCountTitle (#2896)
 
 ### Updated
@@ -43,6 +86,7 @@ Special thanks to @khassel, @rejas and @sdetweil for taking over most (if not al
 - Update Eslint config, add new rule and handle issue
 - Convert lots of callbacks to async/await
 - Revise require imports (#3071 and #3072)
+- Use `config.js-old` instead of file with timestamp suffix when backing up config with a `config.template` in use (#3104)
 
 ### Fixed
 
@@ -73,12 +117,12 @@ Special thanks to @khassel, @rejas and @sdetweil for taking over most (if not al
 
 - Added new calendar options for colored entries and improved styling (#3033)
 - Added test for remoteFile option in compliments module
-- Added hourlyWeather functionality to Weather.gov weather provider
+- Added hourlyWeather functionality to Weather.gov weather-provider
 - Added css class names "today" and "tomorrow" for default calendar
 - Added Collaboration.md
 - Added new github action for dependency review (#2862)
 - Added a WeatherProvider for Open-Meteo
-- Added Yr as a weather provider
+- Added Yr as a weather-provider
 - Added config options "ignoreXOriginHeader" and "ignoreContentSecurityPolicy"
 - Added thai language
 - Added workflow rule to make sure PRs are based against develop
@@ -96,8 +140,8 @@ Special thanks to @khassel, @rejas and @sdetweil for taking over most (if not al
 - Updated da translation
 - Rework weather module
   - Make sure smhi provider api only gets a maximum of 6 digits coordinates (#2955)
-  - Use fetch instead of XMLHttpRequest in weatherprovider (#2935)
-  - Reworked how weatherproviders handle units (#2849)
+  - Use fetch instead of XMLHttpRequest in weather-provider (#2935)
+  - Reworked how weather-providers handle units (#2849)
   - Use unix() method for parsing times, fix suntimes on the way (#2950)
   - Refactor conversion functions into utils class (#2958)
 - The `cors`-method in `server.js` now supports sending and receiving HTTP headers
@@ -107,7 +151,7 @@ Special thanks to @khassel, @rejas and @sdetweil for taking over most (if not al
 
 ### Fixed
 
-- Correctly show apparent temperature in SMHI weather provider
+- Correctly show apparent temperature in SMHI weather-provider
 - Ensure updatenotification module isn't shown when local is _ahead_ of remote
 - Handle node_helper errors during startup (#2944)
 - Possibility to change FontAwesome class in calendar, so icons like `fab fa-facebook-square` works.
@@ -126,7 +170,7 @@ Special thanks to: @BKeyport, @buxxi, @davide125, @khassel, @kolbyjack, @krukle,
 - Added possibility to fetch calendars through socket notifications.
 - New scripts `install-mm` (and `install-mm:dev`) for simplifying mm installation (now: `npm run install-mm`) and adding params `--no-audit --no-fund --no-update-notifier` for less noise.
 - New `showTimeToday` option in calendar module shows time for current-day events even if `timeFormat` is `"relative"`.
-- Added hourly forecasts, apparent temperature & custom location name to SMHI weather provider.
+- Added hourly forecasts, apparent temperature & custom location name to SMHI weather-provider.
 - Added new electron tests for calendar and moved some compliments tests from `e2e` to `electron` because of date mocking, removed mock stuff from compliments module.
 
 ### Removed
@@ -182,7 +226,7 @@ Special thanks to the following contributors: @10bias, @CFenner, @JHWelch, @k1rd
 - Added test for new weather forecast `absoluteDates` property.
 - The modules get a class hidden added/removed if they get hidden/shown which will also toggle pointer-events.
 - Added new config option `showTitleAsUrl` to newsfeed module. If set, the displayed title is a link to the article which is useful when running in a browser and you want to read this article.
-- Added internal cors proxy to get weather providers working without public proxies (fixes #2714). The new url `http(s)://address:port/cors?url=https://whatever-to-proxy` can be used in other modules too.
+- Added internal cors proxy to get weather-providers working without public proxies (fixes #2714). The new url `http(s)://address:port/cors?url=https://whatever-to-proxy` can be used in other modules too.
 - Added a WeatherProvider for Weatherflow.
 - Added new env var `ELECTRON_DISABLE_GPU` which disable gpu under electron if set (fixes #2831).
 - Added missing Czech translations.
@@ -276,7 +320,7 @@ Special thanks to the following contributors: @apiontek, @eouia, @jupadin, @khas
 - Updated jsdocs and print warnings during testing too.
 - Updated weathergov provider to try fetching not just current, but also foreacst, when API URLs available.
 - Refactored clock layout.
-- Refactored methods from weatherproviders into weatherobject (isDaytime, updateSunTime).
+- Refactored methods from weather-providers into weatherobject (isDaytime, updateSunTime).
 - Use of `logger.js` in jest tests.
 - Run prettier over all relevant files.
 - Move tests needing electron in new category `electron`, use `server only` mode in `e2e` tests.
@@ -374,7 +418,7 @@ Special thanks to the following contributors: @EdgardosReis, @MystaraTheGreat, @
 - Code cleanup for FEELS like and added {DEGREE} placeholder for FEELSLIKE for each language.
 - Converted newsfeed module to use templates.
 - Updated documentation and help screen about invalid config files.
-- Moving weather provider specific code and configuration into each provider and making hourly part of the interface.
+- Moving weather-provider specific code and configuration into each provider and making hourly part of the interface.
 - Bump electron to v11 and enable contextIsolation.
 - Don't update the DOM when a module is not displayed.
 - Cleaned up jsdoc and tests.
@@ -456,7 +500,7 @@ Special thanks to the following contributors: @Alvinger, @AndyPoms, @ashishtank,
 - Rename Greek translation to correct ISO 639-1 alpha-2 code (gr > el). (#2155)
 - Add a space after icons of sunrise and sunset. (#2169)
 - Fix calendar when no DTEND record found in event, startDate overlay when endDate set. (#2177)
-- Fix windspeed conversion error in ukmetoffice weather provider. (#2189)
+- Fix windspeed conversion error in ukmetoffice weather-provider. (#2189)
 - Fix console.debug not having timestamps. (#2199)
 - Fix calendar full day event east of UTC start time. (#2200)
 - Fix non-fullday recurring rule processing. (#2216)
@@ -685,7 +729,7 @@ Special thanks to @sdetweil for all his great contributions!
 - Use Feels Like temp from feed if present
 - Optionally display probability of precipitation (PoP) in current weather (UK Met Office data)
 - Automatically try to fix eslint errors by passing `--fix` option to it
-- Added sunrise and sunset times to weathergov weather provider [#1705](https://github.com/MichMich/MagicMirror/issues/1705)
+- Added sunrise and sunset times to weathergov weather-provider [#1705](https://github.com/MichMich/MagicMirror/issues/1705)
 - Added "useLocationAsHeader" to display "location" in `config.js` as header when location name is not returned
 - Added to `newsfeed.js`: in order to design the news article better with css, three more class-names were introduced: newsfeed-desc, newsfeed-desc, newsfeed-desc
 
@@ -696,7 +740,7 @@ Special thanks to @sdetweil for all his great contributions!
 - Updated `ical.js` to solve various calendar issues.
 - Updated weather city list url [#1676](https://github.com/MichMich/MagicMirror/issues/1676)
 - Only update clock once per minute when seconds aren't shown
-- Updated weatherprovider documentation.
+- Updated weather-provider documentation.
 
 ### Fixed
 
@@ -778,7 +822,7 @@ Fixed `package.json` version number.
 - Added fade, fadePoint and maxNumberOfDays properties to the forecast mode [#1516](https://github.com/MichMich/MagicMirror/issues/1516)
 - Fixed Loading string and decimalSymbol string replace [#1538](https://github.com/MichMich/MagicMirror/issues/1538)
 - Show Snow amounts in new weather module [#1545](https://github.com/MichMich/MagicMirror/issues/1545)
-- Added weather.gov as a new weather provider for US locations
+- Added weather.gov as a new weather-provider for US locations
 
 ## [2.6.0] - 2019-01-01
 

clientonly/index.js

@@ -11,7 +11,6 @@
 		/**
 		 * Get command line parameters
 		 * Assumes that a cmdline parameter is defined with `--key [value]`
-		 *
 		 * @param {string} key key to look for at the command line
 		 * @param {string} defaultValue value if no key is given at the command line
 		 * @returns {string} the value of the parameter
@@ -33,7 +32,6 @@
 
 	/**
 	 * Gets the config from the specified server url
-	 *
 	 * @param {string} url location where the server is running.
 	 * @returns {Promise} the config
 	 */
@@ -63,7 +61,6 @@
 
 	/**
 	 * Print a message to the console in case of errors
-	 *
 	 * @param {string} message error message to print
 	 * @param {number} code error code for the exit call
 	 */

config/config.js.sample

@@ -55,8 +55,9 @@ let config = {
 			config: {
 				calendars: [
 					{
+						fetchInterval: 7 * 24 * 60 * 60 * 1000,
 						symbol: "calendar-check",
-						url: "webcal://www.calendarlabs.com/ical-calendar/ics/76/US_Holidays.ics"
+						url: "https://ics.calendarlabs.com/76/mm3137/US_Holidays.ics"
 					}
 				]
 			}

jest.config.js

@@ -6,23 +6,24 @@ module.exports = async () => {
 		projects: [
 			{
 				displayName: "unit",
+				globalSetup: "<rootDir>/tests/unit/helpers/global-setup.js",
 				moduleNameMapper: {
 					logger: "<rootDir>/js/logger.js"
 				},
 				testMatch: ["**/tests/unit/**/*.[jt]s?(x)"],
-				testPathIgnorePatterns: ["<rootDir>/tests/unit/mocks"]
+				testPathIgnorePatterns: ["<rootDir>/tests/unit/mocks", "<rootDir>/tests/unit/helpers"]
 			},
 			{
 				displayName: "electron",
 				testMatch: ["**/tests/electron/**/*.[jt]s?(x)"],
-				testPathIgnorePatterns: ["<rootDir>/tests/electron/helpers/"]
+				testPathIgnorePatterns: ["<rootDir>/tests/electron/helpers"]
 			},
 			{
 				displayName: "e2e",
 				setupFilesAfterEnv: ["<rootDir>/tests/e2e/helpers/mock-console.js"],
 				testMatch: ["**/tests/e2e/**/*.[jt]s?(x)"],
 				modulePaths: ["<rootDir>/js/"],
-				testPathIgnorePatterns: ["<rootDir>/tests/e2e/helpers/", "<rootDir>/tests/e2e/mocks"]
+				testPathIgnorePatterns: ["<rootDir>/tests/e2e/helpers", "<rootDir>/tests/e2e/mocks"]
 			}
 		],
 		collectCoverageFrom: ["./clientonly/**/*.js", "./js/**/*.js", "./modules/default/**/*.js", "./serveronly/**/*.js"],