[go_router] Don't log if hierarchicalLoggingEnabled is true

[ValentinVignal]

Fixes flutter/flutter#139667

If you had to change anything in the flutter/tests repo, include a link to the migration guide as per the breaking change policy.

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 linked to 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.

[flutter-dashboard]

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact "@test-exemption-reviewer" in the #hackers channel in Chat (don't just cc them here, they won't see it! Use Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

[ValentinVignal]

I would like to ask for some help with the tests here.

Here is the setLogging method:

packages/packages/go_router/lib/src/logging.dart

Lines 27 to 62 in 5b48c44

	/// Forwards diagnostic messages to the dart:developer log() API.
	void setLogging({bool enabled = false}) {
	_subscription?.cancel();
	_enabled = enabled;
	if (!enabled) {
	return;
	}
	_subscription = logger.onRecord.listen((LogRecord e) {
	// use `dumpErrorToConsole` for severe messages to ensure that severe
	// exceptions are formatted consistently with other Flutter examples and
	// avoids printing duplicate exceptions
	if (e.level >= Level.SEVERE) {
	final Object? error = e.error;
	FlutterError.dumpErrorToConsole(
	FlutterErrorDetails(
	exception: error is Exception ? error : Exception(error),
	stack: e.stackTrace,
	library: e.loggerName,
	context: ErrorDescription(e.message),
	),
	);
	} else {
	developer.log(
	e.message,
	time: e.time,
	sequenceNumber: e.sequenceNumber,
	level: e.level.value,
	name: e.loggerName,
	zone: e.zone,
	error: e.error,
	stackTrace: e.stackTrace,
	);
	}
	});
	}

My idea was to write 2 tests (both with _enabled set to true):

• 1 with hierarchicalLoggingEnabled set to false and verify that developer.log is called or something is logged in the console.
• 1 with hierarchicalLoggingEnabled set to true and verify that developer.log is not called or nothing is logged in the console.

I first wrote this test:

  testWidgets(
    'It should log the known routes and the initial route if debugLogDiagnostics is false',
    (WidgetTester tester) async {
      final _FakeStdout stdout = _FakeStdout();
      IOOverrides.runZoned(
        () {
          final List<String> logs = <String>[];
          Logger.root.onRecord.listen(
            (LogRecord event) => logs.add(event.message),
          );
          GoRouter(
            debugLogDiagnostics: true,
            routes: <RouteBase>[
              GoRoute(
                path: '/',
                builder: (_, GoRouterState state) => const Text('home'),
              ),
            ],
          );

          expect(
            logs,
            const <String>[
              'Full paths for routes:\n  => /\n',
              'setting initial location null'
            ],
          );
          expect(stdout.writtenObjects, isNotEmpty);
        },
        stdout: () => stdout,
      );
    },
  );

But stdout.writtenObjects is empty. I cannot find a way to verify that developer.log is called.

Do you have any suggestion?

[ValentinVignal]

@chunhtai Any idea how I can write a test for that?

[ValentinVignal]

Hello @chunhtai, do you have any thoughts on this?

[ValentinVignal]

Hello @chunhtai @johnpryan @hangyujin , do you have any idea/feedback for the tests?

[cedvdb]

I think you have to get someone on discord for the review

[ValentinVignal]

@cedvdb Would you know which channel I should use ? I tried hackers-routing-🛤️ , but no one answered

[hangyujin]

@ValentinVignal I will take a look at this PR, also @chunhtai will be back in a week

[chunhtai]

is this from other patch? we should probably separate this out

[ValentinVignal]

Oops yeah, that's a mistake. I reverted it

[chunhtai]

This seems unrelated?

[ValentinVignal]

@chunhtai I refactored logging to be able to mock developer.log in refactor: Add mockable developerLog method and added some tests in test: Update the tests. Is that what you were expecting?

[chunhtai]

LGTM

[hangyujin]

LGTM

[hangyujin]

Hi @ValentinVignal, can you bump version?

[chunhtai]

@ValentinVignal looks like the ci is still not happy

[ValentinVignal]

@chunhtai It should be good now