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

[Feat] Improve logging format and styling #1137

Merged
merged 1 commit into from
Nov 21, 2023
Merged

Conversation

jkasten2
Copy link
Member

@jkasten2 jkasten2 commented Nov 16, 2023

Description

1 Line Summary

Make logging easier read in the js console in browsers.

Details

getConsoleStyle was created when browsers did display things like json well. This is no longer the case and its color styles makes it very hard to read in dark mode. Given this removing this custom formatting logging logic.

Validation

Tests

Info

Checklist

  • All the automated tests pass or I explained why that is not possible
  • I have personally tested this on my machine or explained why that is not possible
  • I have included test coverage for these changes or explained why they are not needed

Programming Checklist
Interfaces:

  • Don't use default export
  • New interfaces are in model files

Functions:

  • Don't use default export
  • All function signatures have return types
  • Helpers should not access any data but rather be given the data to operate on.

Typescript:

  • No Typescript warnings
  • Avoid silencing null/undefined warnings with the exclamation point

Other:

  • Iteration: refrain from using elem of array syntax. Prefer forEach or use map
  • Avoid using global OneSignal accessor for context if possible. Instead, we can pass it to function/constructor so that we don't call OneSignal.context

Screenshots

Before:
Screenshot 2023-11-15 224119

After:
Screenshot 2023-11-15 224404

Info

Checklist

  • I have included screenshots/recordings of the intended results or explained why they are not needed

Related Tickets



This change is Reviewable

@jkasten2 jkasten2 requested review from rgomezp and emawby November 16, 2023 04:20
@jkasten2 jkasten2 force-pushed the fix/sw_race_condition branch 3 times, most recently from 42fb865 to 7930f20 Compare November 16, 2023 06:12
@jkasten2 jkasten2 force-pushed the feat/improve_logging_format branch from a2b311f to f0536dc Compare November 16, 2023 07:05
@jkasten2 jkasten2 force-pushed the fix/sw_race_condition branch from 25628d2 to c7a7d45 Compare November 16, 2023 20:40
@jkasten2 jkasten2 force-pushed the feat/improve_logging_format branch 2 times, most recently from 080ed44 to 4c5111f Compare November 17, 2023 17:59
@jkasten2 jkasten2 force-pushed the fix/sw_race_condition branch from c7a7d45 to a3798c5 Compare November 17, 2023 18:03
Base automatically changed from fix/sw_race_condition to main November 17, 2023 18:08
getConsoleStyle was created when browsers did display things like json
well. This is no longer the case and its color styles makes it very
hard to read in dark mode. Given this removing this custom formating
logging logic.
@jkasten2 jkasten2 force-pushed the feat/improve_logging_format branch from 4c5111f to 140ca64 Compare November 17, 2023 18:11
@jkasten2 jkasten2 merged commit f03bb4f into main Nov 21, 2023
4 checks passed
@jkasten2 jkasten2 deleted the feat/improve_logging_format branch November 21, 2023 23:09
@jkasten2 jkasten2 mentioned this pull request Nov 27, 2023
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.

2 participants