Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework logging colors #3350

Merged
merged 4 commits into from
Jan 16, 2024
Merged

Rework logging colors #3350

merged 4 commits into from
Jan 16, 2024

Conversation

KristjanESPERANTO
Copy link
Contributor

@KristjanESPERANTO KristjanESPERANTO commented Jan 14, 2024

  • Replacing old package colors by drop-in replacement ansis
  • Rework console-stamp config to show all Log outputs in same color (errors = red, warnings = yellow, debug = blue background (only for the label), info = blue)
  • This also fixes npm run config:check (broken since 6097547)

Feel free to let me know if the PR is too big and you want me to do individual PRs for the changes.

Before:
before

After:
after

- Replacing old package `colors` by drop-in replacement `ansis`
- Rework `console-stamp` config to show all Log outputs in same color (errors = red, warnings = yellow, debug = blue background (only for the label), info = blue)
- This also fixes `npm run config:check` (broken since 6097547)
Copy link
Collaborator

@rejas rejas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just two small comments (always in favor of updating old stuff :-)

js/utils.js Outdated Show resolved Hide resolved
js/utils.js Show resolved Hide resolved
@sdetweil
Copy link
Collaborator

as we collect these logs by redirection 95% of the time, these ansi colors are not helpful.

show the pm2 logs output
or the output from npm start >somefile.txt 2>&1

@KristjanESPERANTO
Copy link
Contributor Author

I set the PR to draft to check the use of Utils.colors in the 3rd party modules and to check why the tests fail.

@KristjanESPERANTO KristjanESPERANTO marked this pull request as draft January 14, 2024 22:11
@KristjanESPERANTO
Copy link
Contributor Author

KristjanESPERANTO commented Jan 14, 2024

these ansi colors are not helpful

In some cases, I debug directly with the help of the console. That's why I think the colors make sense. They shouldn't do any harm either. And in general, my changes are just a more consistent implementation of the previous approach.

show the pm2 logs output
or the output from npm start >somefile.txt 2>&1

Before:

$ npm start >somefile.txt 2>&1
[14.01.2024 23:17.53.726] [LOG]   This is Log.log.
[14.01.2024 23:17.53.726] [WARN]  This is Log.warn.
[14.01.2024 23:17.53.727] [ERROR] This is Log.error.
[14.01.2024 23:17.53.727] [INFO]  This is Log.info.
[14.01.2024 23:17.53.727] [DEBUG] This is Log.debug.

After:

$ npm start >somefile.txt 2>&11
[2024-01-14 23:16:10.903] [LOG]   This is Log.log. 
[2024-01-14 23:16:10.904] [WARN]  This is Log.warn. 
[2024-01-14 23:16:10.905] [ERROR] This is Log.error. 
[2024-01-14 23:16:10.905] [INFO]  This is Log.info. 
[2024-01-14 23:16:10.905] [DEBUG] This is Log.debug. 

@sdetweil
Copy link
Collaborator

typically there are ansi escape sequences in the output

@KristjanESPERANTO KristjanESPERANTO marked this pull request as ready for review January 16, 2024 07:39
@khassel khassel requested a review from rejas January 16, 2024 18:49
@khassel khassel mentioned this pull request Jan 16, 2024
@rejas rejas merged commit 6dbacbb into MagicMirrorOrg:develop Jan 16, 2024
5 checks passed
@rejas rejas mentioned this pull request Apr 1, 2024
rejas added a commit that referenced this pull request Apr 1, 2024
## [2.27.0] - 2024-04-01

Thanks to: @bugsounet, @crazyscot, @illimarkangur, @jkriegshauser,
@khassel, @KristjanESPERANTO, @Paranoid93, @rejas, @sdetweil and
@vppencilsharpener.

This release marks the first release without Michael Teeuw (@MichMich).
A very special thanks to him for creating MagicMirror and leading the
project for so many years.

For more info, please read the following post: [A New Chapter for
MagicMirror: The Community Takes the
Lead](https://forum.magicmirror.builders/topic/18329/a-new-chapter-for-magicmirror-the-community-takes-the-lead).

### Added

- Output of system information to the console for troubleshooting (#3328
and #3337), ignore errors under aarch64 (#3349)
- [chore] Add `eslint-plugin-package-json` to lint the `package.json`
files (#3368)
- [weather] `showHumidity` config is now a string describing where to
show this element. Supported values: "wind", "temp", "feelslike",
"below", "none". (#3330)
- electron-rebuild test suite for electron and 3rd party modules
compatibility (#3392)
- Create MM² icon and attach it to electron process (#3407)

### Updated

- Update updatenotification (update_helper.js): Recode with pm2 library
(#3332)
- Removing lodash dependency by replacing merge by spread operator
(#3339)
- Use node prefix for build-in modules (#3340)
- Rework logging colors (#3350)
- Update pm2 to v5.3.1 with no allow-ghsas (#3364)
- [chore] Update husky and let lint-staged fix ESLint issues
- [chore] Update dependencies including electron to v29 (#3357) and
node-ical
- Update translations for estonian (#3371)
- Update electron to v29 and update other dependencies
- [calendar] fullDay events over several days now show the left days
from the first day on and 'today' on the last day
- Update layout of current weather indoor values

### Fixed

- Correct apibase of weathergov weatherprovider to match documentation
(#2926)
- Worked around several issues in the RRULE library that were causing
deleted calender events to still show, some
initial and recurring events to not show, and some event times to be off
an hour. (#3291)
- Skip changelog requirement when running tests for dependency updates
(#3320)
- Display precipitation probability when it is 0% instead of blank/empty
(#3345)
- [newsfeed] Suppress unsightly animation cases when there are 0 or 1
active news items (#3336)
- [newsfeed] Always compute the feed item URL using the same helper
function (#3336)
- Ignore all custom css files (#3359)
- [newsfeed] Fix newsfeed stall issue introduced by #3336 (#3361)
- Changed `log.debug` to `log.log` in `app.js` where logLevel is not set
because config is not loaded at this time (#3353)
- [calendar] deny fetch interval < 60000 and set 60000 in this case
(prevent fetch loop failed) (#3382)
- added message in case where config.js is missing the module.export
line PR #3383
- Fixed an issue where recurring events could extend past their
recurrence end date (#3393)
- Don't display any `npm WARN <....>` on install (#3399)
- Fixed move suncalc dependency to production from dev, as it is used by
clock module
- [compliments] Fix mirror not responding anymore when no compliments
are to be shown (#3385)

### Deleted

- Unneeded file headers (#3358)

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Michael Teeuw <michael@xonaymedia.nl>
Co-authored-by: Kristjan ESPERANTO <35647502+KristjanESPERANTO@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Karsten Hassel <hassel@gmx.de>
Co-authored-by: Ross Younger <crazyscot@gmail.com>
Co-authored-by: Bugsounet - Cédric <github@bugsounet.fr>
Co-authored-by: jkriegshauser <joshuakr@nvidia.com>
Co-authored-by: illimarkangur <116028111+illimarkangur@users.noreply.github.com>
Co-authored-by: sam detweiler <sdetweil@gmail.com>
Co-authored-by: vppencilsharpener <tim.pray@gmail.com>
Co-authored-by: Paranoid93 <6515818+Paranoid93@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants