Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit e8366e3

Browse files
AlexV525AlexV525
authored
🐛 Use consist slashes when generating dep files (#169570)
Continue with flutter/flutter#169467. I've noticed that paths in the depfile on Windows are generated with non-normalized paths. This PR normalizes every single file path before putting them into the output. This might also fix flutter/flutter#163591 as a root cause and can be easily cherry-picked. ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [ ] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
1 parent c08e9df commit e8366e3

2 files changed

Lines changed: 75 additions & 19 deletions

File tree

‎packages/flutter_tools/lib/src/build_system/depfile.dart‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,16 +66,19 @@ class DepfileService {
6666
}
6767

6868
void _writeFilesToBuffer(List<File> files, StringBuffer buffer) {
69+
final bool backslash = _fileSystem.path.style.separator == r'\';
6970
for (final File outputFile in files) {
70-
if (_fileSystem.path.style.separator == r'\') {
71-
// backslashes and spaces in a depfile have to be escaped if the
72-
// platform separator is a backslash.
73-
final String path = outputFile.path.replaceAll(r'\', r'\\').replaceAll(r' ', r'\ ');
74-
buffer.write(' $path');
71+
String path = _fileSystem.path.normalize(outputFile.path);
72+
if (backslash) {
73+
// Backslashes in a depfile have to be escaped if the platform separator is a backslash.
74+
path = path.replaceAll(r'\', r'\\');
7575
} else {
76-
final String path = outputFile.path.replaceAll(r' ', r'\ ');
77-
buffer.write(' $path');
76+
// Convert all path separators to forward slashes.
77+
path = path.replaceAll(r'\', r'/');
7878
}
79+
// Escape spaces.
80+
path = path.replaceAll(r' ', r'\ ');
81+
buffer.write(' $path');
7982
}
8083
}
8184

@@ -93,7 +96,8 @@ class DepfileService {
9396
// The tool doesn't write duplicates to these lists. This call is an attempt to
9497
// be resilient to the outputs of other tools which write or user edits to depfiles.
9598
.toSet()
96-
.map(_fileSystem.file)
99+
// Normalize the path before creating a file object.
100+
.map((String path) => _fileSystem.file(_fileSystem.path.normalize(path)))
97101
.toList();
98102
}
99103
}

‎packages/flutter_tools/test/general.shard/build_system/depfile_test.dart‎

Lines changed: 63 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ void main() {
1717
fileSystem = MemoryFileSystem.test();
1818
depfileService = DepfileService(logger: BufferLogger.test(), fileSystem: fileSystem);
1919
});
20+
2021
testWithoutContext('Can parse depfile from file', () {
2122
final File depfileSource = fileSystem.file('example.d')..writeAsStringSync('''
2223
a.txt: b.txt
@@ -48,22 +49,34 @@ a.txt c.txt d.txt: b.txt
4849
});
4950

5051
testWithoutContext('Can parse depfile with windows file paths', () {
51-
fileSystem = MemoryFileSystem.test(style: FileSystemStyle.windows);
52-
depfileService = DepfileService(logger: BufferLogger.test(), fileSystem: fileSystem);
52+
final FileSystem fileSystem = MemoryFileSystem.test(style: FileSystemStyle.windows);
53+
final DepfileService depfileService = DepfileService(
54+
logger: BufferLogger.test(),
55+
fileSystem: fileSystem,
56+
);
5357
final File depfileSource = fileSystem.file('example.d')..writeAsStringSync(r'''
54-
C:\\a.txt: C:\\b.txt
58+
C:\\a1.txt C:\\a2/a3.txt: C:\\b1.txt C:\\b2/b3.txt
5559
''');
5660
final Depfile depfile = depfileService.parse(depfileSource);
5761

58-
expect(depfile.inputs.single.path, r'C:\b.txt');
59-
expect(depfile.outputs.single.path, r'C:\a.txt');
62+
expect(depfile.inputs.map((File e) => e.path).toList(), <String>[
63+
r'C:\b1.txt',
64+
r'C:\b2\b3.txt',
65+
]);
66+
expect(depfile.outputs.map((File e) => e.path).toList(), <String>[
67+
r'C:\a1.txt',
68+
r'C:\a2\a3.txt',
69+
]);
6070
});
6171

6272
testWithoutContext(
6373
'Can escape depfile with windows file paths and spaces in directory names',
6474
() {
65-
fileSystem = MemoryFileSystem.test(style: FileSystemStyle.windows);
66-
depfileService = DepfileService(logger: BufferLogger.test(), fileSystem: fileSystem);
75+
final FileSystem fileSystem = MemoryFileSystem.test(style: FileSystemStyle.windows);
76+
final DepfileService depfileService = DepfileService(
77+
logger: BufferLogger.test(),
78+
fileSystem: fileSystem,
79+
);
6780
final File inputFile =
6881
fileSystem.directory(r'Hello Flutter').childFile('a.txt').absolute
6982
..createSync(recursive: true);
@@ -73,8 +86,9 @@ C:\\a.txt: C:\\b.txt
7386
final File outputDepfile = fileSystem.file('depfile');
7487
depfileService.writeToFile(depfile, outputDepfile);
7588

76-
expect(outputDepfile.readAsStringSync(), contains(r'C:\\Hello\ Flutter\\a.txt'));
77-
expect(outputDepfile.readAsStringSync(), contains(r'C:\\Hello\ Flutter\\b.txt'));
89+
final String output = outputDepfile.readAsStringSync();
90+
expect(output, contains(r'C:\\Hello\ Flutter\\a.txt'));
91+
expect(output, contains(r'C:\\Hello\ Flutter\\b.txt'));
7892
},
7993
);
8094

@@ -88,8 +102,46 @@ C:\\a.txt: C:\\b.txt
88102
final File outputDepfile = fileSystem.file('depfile');
89103
depfileService.writeToFile(depfile, outputDepfile);
90104

91-
expect(outputDepfile.readAsStringSync(), contains(r'/Hello\ Flutter/a.txt'));
92-
expect(outputDepfile.readAsStringSync(), contains(r'/Hello\ Flutter/b.txt'));
105+
final String output = outputDepfile.readAsStringSync();
106+
expect(output, contains(r'/Hello\ Flutter/a.txt'));
107+
expect(output, contains(r'/Hello\ Flutter/b.txt'));
108+
});
109+
110+
testWithoutContext('Can produce normalized paths', () {
111+
final List<(FileSystemStyle style, String input, String output, List<String> expects)> pairs =
112+
<(FileSystemStyle style, String input, String output, List<String> expects)>[
113+
(
114+
FileSystemStyle.posix,
115+
r'Hello Flutter\a.txt',
116+
r'Hello Flutter\b.txt',
117+
<String>[r'/Hello\ Flutter/a.txt', r'/Hello\ Flutter/b.txt'],
118+
),
119+
(
120+
FileSystemStyle.windows,
121+
r'Hello Flutter/a.txt',
122+
r'Hello Flutter/b.txt',
123+
<String>[r'\\Hello\ Flutter\\a.txt', r'\\Hello\ Flutter\\b.txt'],
124+
),
125+
];
126+
127+
for (final (FileSystemStyle style, String input, String output, List<String> expects)
128+
in pairs) {
129+
final FileSystem fileSystem = MemoryFileSystem.test(style: style);
130+
final DepfileService depfileService = DepfileService(
131+
logger: BufferLogger.test(),
132+
fileSystem: fileSystem,
133+
);
134+
final File inputFile = fileSystem.file(input).absolute..createSync(recursive: true);
135+
final File outputFile = fileSystem.file(output).absolute..createSync();
136+
final Depfile depfile = Depfile(<File>[inputFile], <File>[outputFile]);
137+
final File outputDepfile = fileSystem.file('depfile');
138+
depfileService.writeToFile(depfile, outputDepfile);
139+
140+
final String outputString = outputDepfile.readAsStringSync();
141+
for (final String path in expects) {
142+
expect(outputString, contains(path));
143+
}
144+
}
93145
});
94146

95147
testWithoutContext('Resilient to weird whitespace', () {

0 commit comments

Comments
 (0)