CompilationUnit.directive.stringValue Strips Path Separators on Windows #59629
Comments
|
I don't know why it would be behaving differently under Windows, but it shouldn't be, so there's definitely a bug. But there might also be an incorrect expectation. When you execute |
|
(Side note: also interesting to get the literal string content as the string can be a concatenation of adjacent strings. E.g. this is legal: |
|
@BenAuerDev thanks for the detailed report. Is there a way to get a minimal reproduction case? I'd basically like to see "Here's the Dart source with an import with a slash in it" and "Here's what |
Ah 💪 That would make my use case even easier if the returned value is the same on windows and linux |
|
@srawlins Unfortunately I don't have access to a windows machine currently. I only came across it when running a test at I can see if I'll be able to set up a VM with windows and try it there, or maybe borrow a windows machine when I'm visiting family over the holidays 💪 |
|
Hello @srawlins, I managed to get a minimal reproduction case, I tested it via the serverpod pipeline: test(
'CompilationUnit.directives[i].uri.stringValue returns relative path without separators on Windows.',
() {
var content = Platform.isWindows
? "part 'sub_dir\\example_child.dart';"
: "part 'sub_dir/example_child.dart';";
var unit = parseString(content: content).unit;
var directive = unit.directives.whereType<PartDirective>().first;
var directiveStringValue = directive.uri.stringValue;
var expectedPath = Platform.isWindows
? 'sub_direxample_child.dart'
: 'sub_dir/example_child.dart';
expect(directiveStringValue == expectedPath, isTrue);
}); |
|
(Just for the record, the |
|
Thanks for the information about URI standards, @lrhn. That's a helpful clarification regarding best practices for cross-platform compatibility. To clarify the issue I'm seeing, it's not so much about the validity of backslashes themselves in the string literal. Instead, on Windows, |
|
ACK. I'm not saying there is no problem, just that the reproduction example has an issue. Whether that issue has any effect is uncertain, just something to be wary of. |
|
Understood, @lrhn. Thanks for pointing that out. I'll keep that in mind. |
CompilationUnit.directives.uri.stringValuebehaves inconsistently across platforms. On Windows, path separators inpartandpart ofdirectives are stripped, whereas on Linux, they are preserved.Current Behavior
For the following directives in Dart code:
Linux Output:
../filename.dartandsub_dir/filename.dartWindows Output:
..filename.dartandsub_dirfilename.dartExpected Behavior
For the above directives:
Linux Output (unchanged):
../filename.dartandsub_dir/filename.dartWindows Output:
..\filename.dartandsub_dir\filename.dartsdk version: '>=3.3.0 <4.0.0'analyzer: '^6.0.0'Related Work:
I encountered this while I was working on a PR at serverpod where I tested generated code using
CompilationUnitand comparingCompilationUnit.directives.uri.stringValueto the expected path.This test worked fine on Linux but failed on Windows due to the inconsistency.
Log of the directives of the
CompilationUnitin windows:Log of
directive.uri.stringValueon windows:Log of
directive.uri.stringValueon Linux:If I can help with any further information, you can holla at me any time 💪
The text was updated successfully, but these errors were encountered: