Skip to content

[go_router] Avoid logging when debugLogDiagnostics is false - #4875

Merged
auto-submit[bot] merged 7 commits into
flutter:mainfrom
ValentinVignal:go-router/do-not-log-when-it-is-disabled
Sep 28, 2023
Merged

[go_router] Avoid logging when debugLogDiagnostics is false#4875
auto-submit[bot] merged 7 commits into
flutter:mainfrom
ValentinVignal:go-router/do-not-log-when-it-is-disabled

Conversation

@ValentinVignal

Copy link
Copy Markdown
Contributor

Fixesflutter/flutter#134187

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the relevant style guides and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use dart format.)
  • I signed the CLA.
  • The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
  • I listed at least one issue that this PR fixes in the description above.
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or this PR is exempt from version changes.
  • I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

bool _enabled = false;

/// Logs the message if logging is enabled.
void log(String message) {

@chunhtaichunhtaiSep 15, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

use log may be ambiguous if we later add other level for some reason.

should this just set logger.level = Level.OFF when set enabled = false?

@ValentinVignalValentinVignalSep 18, 2023

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

use log may be ambiguous if we later add other level for some reason.

We could later on change the signature to

voidlog(String message, [Level level =Level.INFO]);

should this just set logger.level = Level.OFF when set enabled = false?

This works too.
Unfortunately, doing so would force the user to set hierarchicalLoggingEnabled to true. If not, logging throws:

══╡ EXCEPTION CAUGHT BY WIDGETS LIBRARY ╞═══════════════════════════════════════════════════════════
The following UnsupportedError was thrown building MyApp(dirty):
Unsupported operation: Please set "hierarchicalLoggingEnabled" to true if you want to change the
level on a non-root logger.

I'm not sure that's acceptable to force the user to do that?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I see, yeah this is fine

@chunhtai
chunhtai self-requested a review September 21, 2023 21:35
…g-when-it-is-disabled
# Conflicts:
#	packages/go_router/CHANGELOG.md
#	packages/go_router/pubspec.yaml

@chunhtaichunhtai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

bool _enabled = false;

/// Logs the message if logging is enabled.
void log(String message) {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I see, yeah this is fine

@hannah-hyjhannah-hyj left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@chunhtaichunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 26, 2023
@auto-submit
auto-submitBot merged commit 79461c2 into flutter:mainSep 28, 2023
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Sep 28, 2023
auto-submitBot pushed a commit to flutter/flutter that referenced this pull request Sep 28, 2023
flutter/packages@21c2ebb...c070b0a
2023-09-28 stuartmorgan@google.com [video_player] Add macOS support (flutter/packages#4982)
2023-09-28 32538273+ValentinVignal@users.noreply.github.com [go_router] Avoid logging when `debugLogDiagnostics` is `false` (flutter/packages#4875)
2023-09-28 stuartmorgan@google.com [tool] Don't lint Flutter shim podspecs (flutter/packages#5007)
If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC flutter-ecosystem@google.com,rmistry@google.com on the revert to ensure that a human
is aware of the problem.
To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose
To report a problem with the AutoRoller itself, please file a bug:
https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug
Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Mairramer pushed a commit to Mairramer/flutter that referenced this pull request Oct 10, 2023
flutter/packages@21c2ebb...c070b0a
2023-09-28 stuartmorgan@google.com [video_player] Add macOS support (flutter/packages#4982)
2023-09-28 32538273+ValentinVignal@users.noreply.github.com [go_router] Avoid logging when `debugLogDiagnostics` is `false` (flutter/packages#4875)
2023-09-28 stuartmorgan@google.com [tool] Don't lint Flutter shim podspecs (flutter/packages#5007)
If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-packages-flutter-autoroll
Please CC flutter-ecosystem@google.com,rmistry@google.com on the revert to ensure that a human
is aware of the problem.
To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose
To report a problem with the AutoRoller itself, please file a bug:
https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug
Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
creatorpiyush pushed a commit to creatorpiyush/packages that referenced this pull request Jun 10, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autosubmitMerge PR when tree becomes green via auto submit Appp: go_router

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[go_router] Initial Routes are being logged even if debugLogDiagnostics == false

3 participants

@ValentinVignal@chunhtai@hannah-hyj