🔥 Do not format the messages file for `gen-l10n` #119596

AlexV525 · 2023-01-31T04:29:49Z

Resolves #119594.

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 Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
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.

thkim1011 · 2023-01-31T18:44:57Z

packages/flutter_tools/test/commands.shard/hermetic/generate_localizations_test.dart

+    final Directory outputDirectory = fileSystem.directory(fileSystem.path.join('.dart_tool', 'flutter_gen', 'gen_l10n'));
+    expect(outputDirectory.existsSync(), true);
+    expect(outputDirectory.childFile('app_localizations_en.dart').existsSync(), true);
+    expect(outputDirectory.childFile('app_localizations_es.dart').existsSync(), true);
+    expect(outputDirectory.childFile('app_localizations.dart').existsSync(), true);


Can we also check that untranslated.json exists along with the app_localizations_*.dart files?

It actually does exist, but in the MemoryFileSystem, the parsed file URI is incorrect which will cause the generated file does not locate under the correct directory, but instead as a file that contains path separators:

So the expectation is always false on Windows in this case.

The file URI was produced by the below line:

flutter/packages/flutter_tools/lib/src/localizations/gen_l10n.dart

Line 66 in 6f9a896

untranslatedMessagesFile: options.untranslatedMessagesFile?.toFilePath(),

@jonahwilliams might know something about the path issue across host platforms.

I've added a replacement during parsing the file from the path by replacing all \ to the separator from the file system. Let's see if it works on all platforms.

When constructing a MemoryFileSystem, you can pass an optional argument (which defaults to posix, that is using / for path separators) FileSystemStyle style = FileSystemStyle.posix https://pub.dev/documentation/file/latest/memory/MemoryFileSystem/MemoryFileSystem.test.html

When constructing a MemoryFileSystem, you can pass an optional argument

The problem is when the host platform is Windows, Uri.toFilePath will convert the config to lib\l10n\untranslated.json which uses a Windows style. If we do use a Windows style here for the file system, the test will be failed too on platforms other than Windows.

thkim1011

LGTM! Thanks so much for your contributions!

(cherry picked from commit 4ae2d3b)

…tter#119596)

* 254a796 Revert "Reland "Add --serve-observatory flag to run, attach, and test (#118402)" (#119529)" (flutter/flutter#119729) * 1573c12 Marks Mac_android microbenchmarks to be unflaky (flutter/flutter#119727) * 5613ab0 remove unnecessary parens (flutter/flutter#119736) * 1305a50 Roll Flutter Engine from c08a286d60e9 to ba3adb74d952 (5 revisions) (flutter/flutter#119741) * 484d881 [conductor] update console link (flutter/flutter#118338) * 73124dc Fix `ListTileThemeData.copyWith` doesn't override correct properties (flutter/flutter#119738) * bc8927c 2b8dd4e5c Use Windows high contrast black/white theme with `MaterialApp` themes (flutter/engine#39206) (flutter/flutter#119747) * 578edfc Catch errors thrown while handling pointer events (flutter/flutter#119577) * 8fd5d4e Remove deprecated SystemNavigator.routeUpdated method (flutter/flutter#119187) * 7a926dc Deprecate MediaQuery[Data].fromWindow (flutter/flutter#119647) * cd118da Update a test expectation that depended on an SkParagraph fix (flutter/flutter#119756) * 4ae2d3b 🔥 Do not format the messages file for `gen-l10n` (flutter/flutter#119596) * 8f5949e Roll Flutter Engine from 2b8dd4e5c699 to a12d102773dd (2 revisions) (flutter/flutter#119758) * 4c99da6 Avoid printing blank lines between "Another exception was thrown:" messages. (flutter/flutter#119587) * 2ecf4ae Update the counter app to enable Material 3 (flutter/flutter#118835) * 0b8486d 29d09845f Roll Dart SDK from b47964e5d575 to 1c219a91e637 (1 revision) (flutter/engine#39324) (flutter/flutter#119763) * ca7b7e3 Roll Flutter Engine from 29d09845f21e to 97d27ff59459 (2 revisions) (flutter/flutter#119765) * 475fc4a Run Mac hostonly tests on any available arch (flutter/flutter#119762) * 322d10e 18118e10a Add iOS spring animation objc files (flutter/engine#38801) (flutter/flutter#119768) * f767f86 check if directory exists before listing content (flutter/flutter#119748) * 34730c7 Revert "Run Mac hostonly tests on any available arch (#119762)" (flutter/flutter#119784) * f9daa9a Roll Flutter Engine from 18118e10a0a5 to 679c4b42e222 (4 revisions) (flutter/flutter#119783) * fd76ef0 Reland "Add API for discovering assets" (flutter/flutter#119277) * ca0596e Fix `pub get --unknown-flag` (flutter/flutter#119622) * 9abb6d7 Roll Plugins from 9da327c to 9302d87 (11 revisions) (flutter/flutter#119825) * 9eafbcc Roll Flutter Engine from 679c4b42e222 to 388890a98e5b (6 revisions) (flutter/flutter#119830) * 1ee8799 Revert "[Re-land] Exposed tooltip longPress (#118796)" (flutter/flutter#119832) * 07b51a0 Add missing variants and *new* indicators to `useMaterial3` docs (flutter/flutter#119799) * 201380a e9e601c7c [web] Hide autofill overlay (flutter/engine#39294) (flutter/flutter#119833) * 1c0065c 27f55219d Roll Fuchsia Linux SDK from QxkjqmRgowkk_n2NZ... to pWloCaRzjLEAUvQEz... (flutter/engine#39339) (flutter/flutter#119838) * e7d934a Marks Linux_android android_choreographer_do_frame_test to be flaky (flutter/flutter#119721) * 3f986e4 Roll Flutter Engine from 27f55219df79 to ae38c9585a61 (2 revisions) (flutter/flutter#119840) * b0f1714 Make Flex,Row,Column const for real (flutter/flutter#119673) * d4b6898 [web] Put all index.html operations in one place (flutter/flutter#118188) * d63987f Parser machine logs (flutter/flutter#118707) * 22bbdf0 Android defines target update (flutter/flutter#119766) * 8387c23 [flutter_tools] Use base DAP detach and ensure correct output (flutter/flutter#119076) * d820aec Manual pub roll with dwds fix (flutter/flutter#119575) * 72f9cf5 Roll Flutter Engine from ae38c9585a61 to 616ecd8be3de (3 revisions) (flutter/flutter#119859) * cfdc358 roll packages (flutter/flutter#119865) * d875899 Bump test Chrome version for Mac arm support (flutter/flutter#119773) * 9b86a48 Fix gets removedItem instead of its index (flutter/flutter#119638) * 66b2ca6 Roll Flutter Engine from 616ecd8be3de to 2871970337df (3 revisions) (flutter/flutter#119870) * c626460 Make `_focusDebug` not interpolate in debug mode (flutter/flutter#119680) * a27802e flutter_tool: remove explicit length header in HTTP response (flutter/flutter#119869) * 3570cce Remove deprecated kind in GestureRecognizer et al (flutter/flutter#119572) * bc45b18 2696fff87 Roll Skia from c2d81db3ef41 to 4f0166baf5a4 (13 revisions) (flutter/engine#39348) (flutter/flutter#119879) * f3effce Roll Flutter Engine from 2696fff8716d to e3fe6dade964 (3 revisions) (flutter/flutter#119892) * 69421c1 [framework] use shader tiling instead of repeated calls to drawImage (flutter/flutter#119495) * 6b83eff Roll Flutter Engine from e3fe6dade964 to 655530e3fd15 (5 revisions) (flutter/flutter#119905) * a5d8a4a 67d35267c [Impeller] Use minimal coverage for stencil restores after overdraw prevention (flutter/engine#39358) (flutter/flutter#119910) * fc8ea56 0fb48ce5b Roll Dart SDK from 69452c5012d9 to be795cc64bd7 (1 revision) (flutter/engine#39360) (flutter/flutter#119926) * e0b2138 Dispose OverlayEntry in TooltipState. (flutter/flutter#117291) * c5e8757 Add M3 support for iconbuttons in error state in TextFields (flutter/flutter#119925)

Improves #119596. The tests remain valid, so no tests were updated in the request. This does not resolve issue #128932, it's handled by another part of the code.

Improves flutter#119596. The tests remain valid, so no tests were updated in the request. This does not resolve issue flutter#128932, it's handled by another part of the code.

* 254a796 Revert "Reland "Add --serve-observatory flag to run, attach, and test (#118402)" (#119529)" (flutter/flutter#119729) * 1573c12 Marks Mac_android microbenchmarks to be unflaky (flutter/flutter#119727) * 5613ab0 remove unnecessary parens (flutter/flutter#119736) * 1305a50 Roll Flutter Engine from c08a286d60e9 to ba3adb74d952 (5 revisions) (flutter/flutter#119741) * 484d881 [conductor] update console link (flutter/flutter#118338) * 73124dc Fix `ListTileThemeData.copyWith` doesn't override correct properties (flutter/flutter#119738) * bc8927c 2b8dd4e5c Use Windows high contrast black/white theme with `MaterialApp` themes (flutter/engine#39206) (flutter/flutter#119747) * 578edfc Catch errors thrown while handling pointer events (flutter/flutter#119577) * 8fd5d4e Remove deprecated SystemNavigator.routeUpdated method (flutter/flutter#119187) * 7a926dc Deprecate MediaQuery[Data].fromWindow (flutter/flutter#119647) * cd118da Update a test expectation that depended on an SkParagraph fix (flutter/flutter#119756) * 4ae2d3b 🔥 Do not format the messages file for `gen-l10n` (flutter/flutter#119596) * 8f5949e Roll Flutter Engine from 2b8dd4e5c699 to a12d102773dd (2 revisions) (flutter/flutter#119758) * 4c99da6 Avoid printing blank lines between "Another exception was thrown:" messages. (flutter/flutter#119587) * 2ecf4ae Update the counter app to enable Material 3 (flutter/flutter#118835) * 0b8486d 29d09845f Roll Dart SDK from b47964e5d575 to 1c219a91e637 (1 revision) (flutter/engine#39324) (flutter/flutter#119763) * ca7b7e3 Roll Flutter Engine from 29d09845f21e to 97d27ff59459 (2 revisions) (flutter/flutter#119765) * 475fc4a Run Mac hostonly tests on any available arch (flutter/flutter#119762) * 322d10e 18118e10a Add iOS spring animation objc files (flutter/engine#38801) (flutter/flutter#119768) * f767f86 check if directory exists before listing content (flutter/flutter#119748) * 34730c7 Revert "Run Mac hostonly tests on any available arch (#119762)" (flutter/flutter#119784) * f9daa9a Roll Flutter Engine from 18118e10a0a5 to 679c4b42e222 (4 revisions) (flutter/flutter#119783) * fd76ef0 Reland "Add API for discovering assets" (flutter/flutter#119277) * ca0596e Fix `pub get --unknown-flag` (flutter/flutter#119622) * 9abb6d7 Roll Plugins from 9da327c to 9302d87 (11 revisions) (flutter/flutter#119825) * 9eafbcc Roll Flutter Engine from 679c4b42e222 to 388890a98e5b (6 revisions) (flutter/flutter#119830) * 1ee8799 Revert "[Re-land] Exposed tooltip longPress (#118796)" (flutter/flutter#119832) * 07b51a0 Add missing variants and *new* indicators to `useMaterial3` docs (flutter/flutter#119799) * 201380a e9e601c7c [web] Hide autofill overlay (flutter/engine#39294) (flutter/flutter#119833) * 1c0065c 27f55219d Roll Fuchsia Linux SDK from QxkjqmRgowkk_n2NZ... to pWloCaRzjLEAUvQEz... (flutter/engine#39339) (flutter/flutter#119838) * e7d934a Marks Linux_android android_choreographer_do_frame_test to be flaky (flutter/flutter#119721) * 3f986e4 Roll Flutter Engine from 27f55219df79 to ae38c9585a61 (2 revisions) (flutter/flutter#119840) * b0f1714 Make Flex,Row,Column const for real (flutter/flutter#119673) * d4b6898 [web] Put all index.html operations in one place (flutter/flutter#118188) * d63987f Parser machine logs (flutter/flutter#118707) * 22bbdf0 Android defines target update (flutter/flutter#119766) * 8387c23 [flutter_tools] Use base DAP detach and ensure correct output (flutter/flutter#119076) * d820aec Manual pub roll with dwds fix (flutter/flutter#119575) * 72f9cf5 Roll Flutter Engine from ae38c9585a61 to 616ecd8be3de (3 revisions) (flutter/flutter#119859) * cfdc358 roll packages (flutter/flutter#119865) * d875899 Bump test Chrome version for Mac arm support (flutter/flutter#119773) * 9b86a48 Fix gets removedItem instead of its index (flutter/flutter#119638) * 66b2ca6 Roll Flutter Engine from 616ecd8be3de to 2871970337df (3 revisions) (flutter/flutter#119870) * c626460 Make `_focusDebug` not interpolate in debug mode (flutter/flutter#119680) * a27802e flutter_tool: remove explicit length header in HTTP response (flutter/flutter#119869) * 3570cce Remove deprecated kind in GestureRecognizer et al (flutter/flutter#119572) * bc45b18 2696fff87 Roll Skia from c2d81db3ef41 to 4f0166baf5a4 (13 revisions) (flutter/engine#39348) (flutter/flutter#119879) * f3effce Roll Flutter Engine from 2696fff8716d to e3fe6dade964 (3 revisions) (flutter/flutter#119892) * 69421c1 [framework] use shader tiling instead of repeated calls to drawImage (flutter/flutter#119495) * 6b83eff Roll Flutter Engine from e3fe6dade964 to 655530e3fd15 (5 revisions) (flutter/flutter#119905) * a5d8a4a 67d35267c [Impeller] Use minimal coverage for stencil restores after overdraw prevention (flutter/engine#39358) (flutter/flutter#119910) * fc8ea56 0fb48ce5b Roll Dart SDK from 69452c5012d9 to be795cc64bd7 (1 revision) (flutter/engine#39360) (flutter/flutter#119926) * e0b2138 Dispose OverlayEntry in TooltipState. (flutter/flutter#117291) * c5e8757 Add M3 support for iconbuttons in error state in TextFields (flutter/flutter#119925)

flutter-dashboard bot added the tool Affects the "flutter" command-line tool. See also t: labels. label Jan 31, 2023

AlexV525 added 2 commits January 31, 2023 15:50

🔥 Do not format the messages file

f1cae53

✅ Add test

571ab5b

AlexV525 force-pushed the gen-l10n-not-format-messages branch from 8638657 to 571ab5b Compare January 31, 2023 07:51

AlexV525 marked this pull request as ready for review January 31, 2023 08:04

AlexV525 requested review from christopherfujino and thkim1011 January 31, 2023 08:04

✅ Add the link to the test

e2ef2f9

thkim1011 reviewed Jan 31, 2023

View reviewed changes

AlexV525 added 2 commits February 1, 2023 11:25

✅ Respect the path separator from the file system

0866d94

✅ Add the untranslated messages file existence test

b1d8378

thkim1011 approved these changes Feb 1, 2023

View reviewed changes

AlexV525 added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 1, 2023

auto-submit bot merged commit 4ae2d3b into flutter:master Feb 1, 2023

AlexV525 deleted the gen-l10n-not-format-messages branch February 2, 2023 00:59

AlexV525 added a commit to AlexV525/flutter that referenced this pull request Feb 2, 2023

🔥 Do not format the messages file for gen-l10n (flutter#119596)

854ac26

(cherry picked from commit 4ae2d3b)

This was referenced Feb 2, 2023

Roll Flutter from d27880801435 to f9daa9aac4b8 (22 revisions) flutter/plugins#7081

Closed

Roll Flutter from 1573c12963c6 to f9daa9aac4b8 (20 revisions) flutter/packages#3144

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 2, 2023

4ae2d3b 🔥 Do not format the messages file for gen-l10n (flutter/flu…

c59ea25

…tter#119596)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Feb 2, 2023

4ae2d3b 🔥 Do not format the messages file for gen-l10n (flutter/flu…

b5697d4

…tter#119596)

engine-flutter-autoroll mentioned this pull request Feb 2, 2023

Roll Flutter from 1573c12963c6 to fd76ef0f26e2 (21 revisions) flutter/packages#3145

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 2, 2023

4ae2d3b 🔥 Do not format the messages file for gen-l10n (flutter/flu…

ea76c8d

…tter#119596)

engine-flutter-autoroll mentioned this pull request Feb 2, 2023

Roll Flutter from 1573c12963c6 to ca0596e41da3 (22 revisions) flutter/packages#3146

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 2, 2023

4ae2d3b 🔥 Do not format the messages file for gen-l10n (flutter/flu…

5705494

…tter#119596)

engine-flutter-autoroll mentioned this pull request Feb 2, 2023

Roll Flutter from 1573c12963c6 to 9abb6d7076bd (23 revisions) flutter/packages#3147

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 2, 2023

4ae2d3b 🔥 Do not format the messages file for gen-l10n (flutter/flu…

6328551

…tter#119596)

engine-flutter-autoroll mentioned this pull request Feb 2, 2023

Roll Flutter from d27880801435 to 9abb6d7076bd (25 revisions) flutter/plugins#7083

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Feb 2, 2023

4ae2d3b 🔥 Do not format the messages file for gen-l10n (flutter/flu…

8c137d8

…tter#119596)

engine-flutter-autoroll mentioned this pull request Feb 2, 2023

Roll Flutter from 1573c12963c6 to 9eafbcc8bea9 (24 revisions) flutter/packages#3150

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 2, 2023

4ae2d3b 🔥 Do not format the messages file for gen-l10n (flutter/flu…

a14432d

…tter#119596)

engine-flutter-autoroll mentioned this pull request Feb 2, 2023

Roll Flutter from d27880801435 to 9eafbcc8bea9 (26 revisions) flutter/plugins#7085

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Feb 2, 2023

4ae2d3b 🔥 Do not format the messages file for gen-l10n (flutter/flu…

e99b15a

…tter#119596)

engine-flutter-autoroll mentioned this pull request Feb 2, 2023

Roll Flutter from 1573c12963c6 to 1ee87990dc76 (25 revisions) flutter/packages#3151

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 2, 2023

4ae2d3b 🔥 Do not format the messages file for gen-l10n (flutter/flu…

080bb4f

…tter#119596)

engine-flutter-autoroll mentioned this pull request Feb 2, 2023

Roll Flutter from 1573c12963c6 to 07b51a0dbbfb (26 revisions) flutter/packages#3152

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 2, 2023

4ae2d3b 🔥 Do not format the messages file for gen-l10n (flutter/flu…

92a29c8

…tter#119596)

engine-flutter-autoroll mentioned this pull request Feb 2, 2023

Roll Flutter from 1573c12963c6 to 201380ab2698 (27 revisions) flutter/packages#3153

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Feb 2, 2023

4ae2d3b 🔥 Do not format the messages file for gen-l10n (flutter/flu…

63f5bdc

…tter#119596)

engine-flutter-autoroll mentioned this pull request Feb 2, 2023

Roll Flutter from d27880801435 to 201380ab2698 (29 revisions) flutter/plugins#7086

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Feb 2, 2023

4ae2d3b 🔥 Do not format the messages file for gen-l10n (flutter/flu…

dbc006e

…tter#119596)

engine-flutter-autoroll mentioned this pull request Feb 2, 2023

Roll Flutter from d27880801435 to e7d934a01466 (31 revisions) flutter/plugins#7088

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Feb 2, 2023

4ae2d3b 🔥 Do not format the messages file for gen-l10n (flutter/flu…

3bd63f8

…tter#119596)

engine-flutter-autoroll mentioned this pull request Feb 3, 2023

Roll Flutter from d27880801435 to c5e8757fcb79 (54 revisions) flutter/plugins#7092

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Feb 3, 2023

4ae2d3b 🔥 Do not format the messages file for gen-l10n (flutter/flu…

852d5c7

…tter#119596)

AlexV525 mentioned this pull request Jul 25, 2023

🐛 Only format Dart files for gen-l10n #131232

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

🔥 Do not format the messages file for `gen-l10n` #119596

🔥 Do not format the messages file for `gen-l10n` #119596

Uh oh!

AlexV525 commented Jan 31, 2023 •

edited

Loading

Uh oh!

thkim1011 Jan 31, 2023

Uh oh!

AlexV525 Feb 1, 2023 •

edited

Loading

Uh oh!

AlexV525 Feb 1, 2023

Uh oh!

christopherfujino Feb 1, 2023

Uh oh!

AlexV525 Feb 1, 2023

Uh oh!

thkim1011 left a comment •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

🔥 Do not format the messages file for gen-l10n #119596

🔥 Do not format the messages file for gen-l10n #119596

Uh oh!

Conversation

AlexV525 commented Jan 31, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

thkim1011 Jan 31, 2023

Choose a reason for hiding this comment

Uh oh!

AlexV525 Feb 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlexV525 Feb 1, 2023

Choose a reason for hiding this comment

Uh oh!

christopherfujino Feb 1, 2023

Choose a reason for hiding this comment

Uh oh!

AlexV525 Feb 1, 2023

Choose a reason for hiding this comment

Uh oh!

thkim1011 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

🔥 Do not format the messages file for `gen-l10n` #119596

🔥 Do not format the messages file for `gen-l10n` #119596

AlexV525 commented Jan 31, 2023 •

edited

Loading

AlexV525 Feb 1, 2023 •

edited

Loading

thkim1011 left a comment •

edited

Loading