Skip to content

Commit 3700590

Browse files
authored
[flutter_tools] Resolve symlinks and fix flakiness in widget preview tests (flutter#191214)
## Description * Resolve symbolic links in `PreviewDetector`'s project root directory and ephemeral directories to ensure consistent path matching. * Pass the SDK path to `AnalysisContextCollection` to ensure correct SDK resolution in worktrees. * Add a 100ms delay in test helpers before triggering file changes to allow the file watcher to fully initialize on macOS. ## Related Issues Fixes flutter#189849 ## Tests - Updated widget preview unit and regression tests in `packages/flutter_tools/test/commands.shard/hermetic/widget_preview/` and `packages/flutter_tools/test/commands.shard/permeable/widget_preview/`.
1 parent 14002a4 commit 3700590

8 files changed

Lines changed: 81 additions & 9 deletions

File tree

‎packages/flutter_tools/lib/src/commands/widget_preview.dart‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,7 @@ final class WidgetPreviewStartCommand extends WidgetPreviewSubCommandBase with C
263263
);
264264

265265
late final _previewDetector = PreviewDetector(
266+
artifacts: artifacts,
266267
platform: platform,
267268
previewAnalytics: previewAnalytics,
268269
project: rootProject,

‎packages/flutter_tools/lib/src/widget_preview/preview_detector.dart‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import 'package:collection/collection.dart';
1212
import 'package:meta/meta.dart';
1313
import 'package:watcher/watcher.dart';
1414

15+
import '../artifacts.dart';
1516
import '../base/file_system.dart';
1617
import '../base/logger.dart';
1718
import '../base/platform.dart';
@@ -29,6 +30,7 @@ Watcher _defaultWatcherBuilder(String path) {
2930

3031
class PreviewDetector {
3132
PreviewDetector({
33+
required this.artifacts,
3234
required this.platform,
3335
required this.previewAnalytics,
3436
required this.project,
@@ -38,8 +40,17 @@ class PreviewDetector {
3840
required this.onPubspecChangeDetected,
3941
@visibleForTesting this.watcherBuilder = _defaultWatcherBuilder,
4042
@visibleForTesting this.onPackageConfigChangeDetected,
41-
}) : projectRoot = project.directory;
43+
}) : projectRoot = _resolveDirectory(project.directory);
4244

45+
static Directory _resolveDirectory(Directory directory) {
46+
try {
47+
return directory.fileSystem.directory(directory.resolveSymbolicLinksSync());
48+
} on Object catch (_) {
49+
return directory.absolute;
50+
}
51+
}
52+
53+
final Artifacts artifacts;
4354
final Platform platform;
4455
final WidgetPreviewAnalytics previewAnalytics;
4556
final FlutterProject project;
@@ -52,6 +63,10 @@ class PreviewDetector {
5263
final void Function(String path)? onPackageConfigChangeDetected;
5364
final WatcherBuilder watcherBuilder;
5465

66+
late final List<String> _resolvedEphemeralDirectoryPaths = project.ephemeralDirectories
67+
.map((Directory dir) => _resolveDirectory(dir).path)
68+
.toList();
69+
5570
@visibleForTesting
5671
static const kDirectoryWatcherClosedUnexpectedlyPrefix = 'Directory watcher closed unexpectedly';
5772
@visibleForTesting
@@ -127,9 +142,13 @@ class PreviewDetector {
127142
}
128143

129144
Future<void> _initializeAnalysisContextCollection() async {
145+
final String sdkPath = artifacts.getArtifactPath(Artifact.engineDartSdkPath);
146+
final bool sdkExists =
147+
fs.path.isAbsolute(sdkPath) && PhysicalResourceProvider.INSTANCE.getFolder(sdkPath).exists;
130148
_collection = AnalysisContextCollection(
131149
includedPaths: <String>[projectRoot.absolute.path],
132150
resourceProvider: PhysicalResourceProvider.INSTANCE,
151+
sdkPath: sdkExists ? sdkPath : null,
133152
);
134153

135154
// Find the initial set of previews.
@@ -158,7 +177,7 @@ class PreviewDetector {
158177
// the tool (e.g., build/, plugin directories, etc.).
159178
if (eventPath.doesContainDartTool ||
160179
eventPath.doesContainWidgetPreview ||
161-
project.ephemeralDirectories.any((dir) => eventPath.contains(dir.path))) {
180+
_resolvedEphemeralDirectoryPaths.any((String path) => eventPath.contains(path))) {
162181
return;
163182
}
164183
// If the pubspec has changed, new dependencies or assets could have been added, requiring

‎packages/flutter_tools/test/commands.shard/hermetic/widget_preview/preview_code_generator_test.dart‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import 'package:dart_style/dart_style.dart';
66
import 'package:file/memory.dart';
77
import 'package:file_testing/file_testing.dart';
8+
import 'package:flutter_tools/src/artifacts.dart';
89
import 'package:flutter_tools/src/base/file_system.dart';
910
import 'package:flutter_tools/src/base/logger.dart';
1011
import 'package:flutter_tools/src/base/platform.dart';
@@ -265,7 +266,12 @@ void main() {
265266
..childFile('lib/src/transitive_error.dart').writeAsStringSync(kTransitiveErrorLibrary)
266267
..childFile('lib/src/custom_previews.dart').writeAsStringSync(kCustomPreviews);
267268
project = FlutterProject.fromDirectoryTest(projectDir);
269+
final String? sdkPath = Cache.flutterRoot != null
270+
? fs.path.join(Cache.flutterRoot!, 'bin', 'cache', 'dart-sdk')
271+
: null;
272+
final Artifacts artifacts = FakeArtifacts(sdkPath: sdkPath);
268273
previewDetector = PreviewDetector(
274+
artifacts: artifacts,
269275
platform: FakePlatform(),
270276
previewAnalytics: WidgetPreviewAnalytics(
271277
analytics: getInitializedFakeAnalyticsInstance(

‎packages/flutter_tools/test/commands.shard/hermetic/widget_preview/preview_detector/preview_detector_regression_173895_test.dart‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import 'dart:async';
66

77
import 'package:file/memory.dart';
8+
import 'package:flutter_tools/src/artifacts.dart';
89
import 'package:flutter_tools/src/base/file_system.dart';
910
import 'package:flutter_tools/src/base/logger.dart';
1011
import 'package:flutter_tools/src/base/platform.dart';
@@ -34,6 +35,7 @@ void main() {
3435
fs.systemTempDirectory.createTempSync('root'),
3536
);
3637
previewDetector = PreviewDetector(
38+
artifacts: Artifacts.test(fileSystem: fs),
3739
// Explicitly set the platform to Windows.
3840
platform: FakePlatform(operatingSystem: 'windows'),
3941
previewAnalytics: WidgetPreviewAnalytics(

‎packages/flutter_tools/test/commands.shard/hermetic/widget_preview/preview_detector/preview_detector_regression_178317_test.dart‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@
55
import 'dart:async';
66

77
import 'package:file/memory.dart';
8+
import 'package:flutter_tools/src/artifacts.dart';
89
import 'package:flutter_tools/src/base/file_system.dart';
910
import 'package:flutter_tools/src/base/logger.dart';
1011
import 'package:flutter_tools/src/base/platform.dart';
12+
import 'package:flutter_tools/src/cache.dart';
1113
import 'package:flutter_tools/src/project.dart';
1214
import 'package:flutter_tools/src/widget_preview/analytics.dart';
1315
import 'package:flutter_tools/src/widget_preview/preview_detector.dart';
@@ -31,13 +33,19 @@ void main() {
3133
}
3234

3335
setUp(() {
36+
Cache.flutterRoot = getFlutterRoot();
3437
fs = MemoryFileSystem.test(
3538
style: const LocalPlatform().isWindows ? FileSystemStyle.windows : FileSystemStyle.posix,
3639
);
3740
watcher = FakeWatcher();
3841
logger = BufferLogger.test();
3942
project = FlutterProject.fromDirectoryTest(fs.systemTempDirectory.createTempSync('root'));
43+
final String? sdkPath = Cache.flutterRoot != null
44+
? fs.path.join(Cache.flutterRoot!, 'bin', 'cache', 'dart-sdk')
45+
: null;
46+
final Artifacts artifacts = FakeArtifacts(sdkPath: sdkPath);
4047
previewDetector = PreviewDetector(
48+
artifacts: artifacts,
4149
platform: FakePlatform(),
4250
previewAnalytics: WidgetPreviewAnalytics(
4351
analytics: getInitializedFakeAnalyticsInstance(

‎packages/flutter_tools/test/commands.shard/hermetic/widget_preview/utils/preview_detector_test_utils.dart‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import 'dart:async';
66

77
import 'package:file/memory.dart';
88
import 'package:file_testing/file_testing.dart';
9+
import 'package:flutter_tools/src/artifacts.dart';
910
import 'package:flutter_tools/src/base/file_system.dart';
1011
import 'package:flutter_tools/src/base/logger.dart';
1112
import 'package:flutter_tools/src/base/platform.dart';
@@ -83,7 +84,11 @@ PreviewDetector createTestPreviewDetector() {
8384
_projectRoot = _fs.systemTempDirectory.createTempSync('root');
8485
final FlutterProject project = FlutterProject.fromDirectory(_projectRoot!);
8586

87+
final String sdkPath = _fs.path.join(Cache.flutterRoot!, 'bin', 'cache', 'dart-sdk');
88+
final Artifacts artifacts = FakeArtifacts(sdkPath: sdkPath);
89+
8690
return PreviewDetector(
91+
artifacts: artifacts,
8792
platform: FakePlatform(),
8893
previewAnalytics: WidgetPreviewAnalytics(
8994
analytics: getInitializedFakeAnalyticsInstance(
@@ -166,6 +171,10 @@ Future<String> waitForPubspecChangeDetected({
166171
}
167172
completer.complete(path);
168173
};
174+
// Short delay to allow the file watcher (especially FSEvents on macOS) to
175+
// fully initialize and start listening for events before we trigger the
176+
// change operation.
177+
await Future<void>.delayed(const Duration(milliseconds: 100));
169178
await changeOperation();
170179
return completer.future;
171180
}
@@ -181,6 +190,10 @@ Future<String> waitForPackageConfigChangeDetected({
181190
}
182191
completer.complete(path);
183192
};
193+
// Short delay to allow the file watcher (especially FSEvents on macOS) to
194+
// fully initialize and start listening for events before we trigger the
195+
// change operation.
196+
await Future<void>.delayed(const Duration(milliseconds: 100));
184197
await changeOperation();
185198
return completer.future;
186199
}
@@ -200,6 +213,10 @@ Future<void> waitForChangeDetected({
200213
onChangeDetected(updated);
201214
completer.complete();
202215
};
216+
// Short delay to allow the file watcher (especially FSEvents on macOS) to
217+
// fully initialize and start listening for events before we trigger the
218+
// change operation.
219+
await Future<void>.delayed(const Duration(milliseconds: 100));
203220
await changeOperation();
204221
await completer.future;
205222
}
@@ -220,6 +237,10 @@ Future<void> waitForNChangesDetected({
220237
completer.complete();
221238
}
222239
};
240+
// Short delay to allow the file watcher (especially FSEvents on macOS) to
241+
// fully initialize and start listening for events before we trigger the
242+
// change operation.
243+
await Future<void>.delayed(const Duration(milliseconds: 100));
223244
await changeOperation();
224245
await completer.future;
225246
}

‎packages/flutter_tools/test/commands.shard/permeable/widget_preview/preview_detector_regression_178472_test.dart‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@
55
import 'dart:async';
66

77
import 'package:file/memory.dart';
8+
import 'package:flutter_tools/src/artifacts.dart';
89
import 'package:flutter_tools/src/base/file_system.dart';
910
import 'package:flutter_tools/src/base/logger.dart';
1011
import 'package:flutter_tools/src/base/platform.dart';
12+
import 'package:flutter_tools/src/cache.dart';
1113
import 'package:flutter_tools/src/project.dart';
1214
import 'package:flutter_tools/src/widget_preview/analytics.dart';
1315
import 'package:flutter_tools/src/widget_preview/dependency_graph.dart';
@@ -28,11 +30,17 @@ void main() {
2830
late BufferLogger logger;
2931

3032
setUp(() {
33+
Cache.flutterRoot = getFlutterRoot();
3134
fs = LocalFileSystem.test(signals: FakeSignals());
3235
watcher = FakeWatcher();
3336
logger = BufferLogger.test();
3437
project = FlutterProject.fromDirectoryTest(fs.systemTempDirectory.createTempSync('root'));
38+
final String? sdkPath = Cache.flutterRoot != null
39+
? fs.path.join(Cache.flutterRoot!, 'bin', 'cache', 'dart-sdk')
40+
: null;
41+
final Artifacts artifacts = FakeArtifacts(sdkPath: sdkPath);
3542
previewDetector = PreviewDetector(
43+
artifacts: artifacts,
3644
platform: FakePlatform(),
3745
previewAnalytics: WidgetPreviewAnalytics(
3846
analytics: getInitializedFakeAnalyticsInstance(

‎packages/flutter_tools/test/src/fakes.dart‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1005,9 +1005,11 @@ class FakeXcode extends Fake implements Xcode {
10051005
}
10061006

10071007
class FakeArtifacts extends Fake implements Artifacts {
1008-
FakeArtifacts({FileSystem? fileSystem}) : _delegate = Artifacts.test(fileSystem: fileSystem);
1008+
FakeArtifacts({FileSystem? fileSystem, this.sdkPath})
1009+
: _delegate = Artifacts.test(fileSystem: fileSystem);
10091010

10101011
final Artifacts _delegate;
1012+
final String? sdkPath;
10111013

10121014
@override
10131015
LocalEngineInfo? get localEngineInfo => _delegate.localEngineInfo;
@@ -1024,12 +1026,17 @@ class FakeArtifacts extends Fake implements Artifacts {
10241026
TargetPlatform? platform,
10251027
BuildMode? mode,
10261028
EnvironmentType? environmentType,
1027-
}) => _delegate.getArtifactPath(
1028-
artifact,
1029-
platform: platform,
1030-
mode: mode,
1031-
environmentType: environmentType,
1032-
);
1029+
}) {
1030+
if (artifact == Artifact.engineDartSdkPath && sdkPath != null) {
1031+
return sdkPath!;
1032+
}
1033+
return _delegate.getArtifactPath(
1034+
artifact,
1035+
platform: platform,
1036+
mode: mode,
1037+
environmentType: environmentType,
1038+
);
1039+
}
10331040

10341041
@override
10351042
String getEngineType(TargetPlatform platform, [BuildMode? mode]) =>

0 commit comments

Comments
 (0)