Skip to content

Commit 431b96e

Browse files
committed
[flutter_tools] Reload widget-preview when data assets change
1 parent 416d09a commit 431b96e

6 files changed

Lines changed: 40 additions & 19 deletions

File tree

‎packages/flutter_tools/lib/src/asset.dart‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ class FlutterHookResult {
7272

7373
static bool _wasAnyFileModifiedSince(FileSystem fileSystem, DateTime since, List<Uri> uris) {
7474
for (final uri in uris) {
75-
final DateTime modified = fileSystem.statSync(uri.toFilePath()).modified;
76-
if (modified.isAfter(since)) {
75+
final FileStat stat = fileSystem.statSync(uri.toFilePath());
76+
if (stat.type == FileSystemEntityType.notFound || stat.modified.isAfter(since)) {
7777
return true;
7878
}
7979
}

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -275,6 +275,7 @@ final class WidgetPreviewStartCommand extends WidgetPreviewSubCommandBase with C
275275
fs: fs,
276276
onChangeDetected: onLegacyChangeDetected,
277277
onPubspecChangeDetected: _onPubspecChangeDetected,
278+
onNonDartFileChangeDetected: _onNonDartFileChangeDetected,
278279
);
279280

280281
late final _lspPreviewDetector = LspPreviewDetector(
@@ -285,6 +286,7 @@ final class WidgetPreviewStartCommand extends WidgetPreviewSubCommandBase with C
285286
fs: fs,
286287
onChangeDetected: onChangeDetected,
287288
onPubspecChangeDetected: _onPubspecChangeDetected,
289+
onNonDartFileChangeDetected: _onNonDartFileChangeDetected,
288290
shutdownHooks: shutdownHooks,
289291
dtd: _dtdService,
290292
processManager: processManager,
@@ -559,6 +561,13 @@ final class WidgetPreviewStartCommand extends WidgetPreviewSubCommandBase with C
559561
unawaited(_triggerReload(.hotReload));
560562
}
561563

564+
void _onNonDartFileChangeDetected(String path) {
565+
if (_widgetPreviewApp?.assetBundle.needsBuild() ?? false) {
566+
logger.printStatus('Triggering reload based on update to asset: $path');
567+
unawaited(_triggerReload(.hotReload));
568+
}
569+
}
570+
562571
/// Configures the Dart Tooling Daemon connection.
563572
///
564573
/// If --dtd-uri is provided, the existing DTD instance will be used. If the tool fails to

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ class LspPreviewDetector {
3737
required this.logger,
3838
required this.onChangeDetected,
3939
required this.onPubspecChangeDetected,
40+
this.onNonDartFileChangeDetected,
4041
required this.dtd,
4142
required this.processManager,
4243
required this.terminal,
@@ -58,6 +59,7 @@ class LspPreviewDetector {
5859
final Logger logger;
5960
final void Function(FlutterWidgetPreviews) onChangeDetected;
6061
final void Function(String path) onPubspecChangeDetected;
62+
final void Function(String path)? onNonDartFileChangeDetected;
6163
@visibleForTesting
6264
final void Function(String path)? onPackageConfigChangeDetected;
6365
final WatcherBuilder watcherBuilder;
@@ -196,6 +198,7 @@ class LspPreviewDetector {
196198
return;
197199
}
198200
if (!filePath.isDartFile) {
201+
onNonDartFileChangeDetected?.call(filePath);
199202
return;
200203
}
201204
previewAnalytics.startPreviewReloadStopwatch();

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

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ class PreviewDetector {
3838
required this.logger,
3939
required this.onChangeDetected,
4040
required this.onPubspecChangeDetected,
41+
this.onNonDartFileChangeDetected,
4142
@visibleForTesting this.watcherBuilder = _defaultWatcherBuilder,
4243
@visibleForTesting this.onPackageConfigChangeDetected,
4344
}) : projectRoot = _resolveDirectory(project.directory);
@@ -59,6 +60,7 @@ class PreviewDetector {
5960
final Logger logger;
6061
final void Function(PreviewDependencyGraph) onChangeDetected;
6162
final void Function(String path) onPubspecChangeDetected;
63+
final void Function(String path)? onNonDartFileChangeDetected;
6264
@visibleForTesting
6365
final void Function(String path)? onPackageConfigChangeDetected;
6466
final WatcherBuilder watcherBuilder;
@@ -186,18 +188,19 @@ class PreviewDetector {
186188
onPubspecChangeDetected(eventPath);
187189
return;
188190
}
189-
// Only trigger a reload when changes to Dart sources are detected. We
190-
// ignore the generated preview file to avoid getting stuck in a loop.
191+
// Only trigger a preview analysis reload when changes to Dart sources are detected.
192+
// For non-Dart files (such as data assets), notify onNonDartFileChangeDetected.
191193
if (!eventPath.isDartFile) {
194+
onNonDartFileChangeDetected?.call(eventPath);
192195
return;
193196
}
194197

195198
AnalysisContext context;
196199
try {
197200
context = _collection.contextFor(eventPath);
198201
} on StateError {
199-
// The modified file isn't part of the analysis context and is safe to
200-
// ignore.
202+
// The modified file isn't part of the analysis context, but could be a hook script.
203+
onNonDartFileChangeDetected?.call(eventPath);
201204
return;
202205
}
203206

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

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ void main() {
4545
late ShutdownHooks shutdownHooks;
4646
late List<FlutterWidgetPreviews> detectedChanges;
4747
late List<String> detectedPubspecChanges;
48+
late List<String> detectedNonDartFileChanges;
4849
late LspPreviewDetector detector;
4950

5051
setUp(() async {
@@ -63,6 +64,7 @@ void main() {
6364
shutdownHooks = ShutdownHooks();
6465
detectedChanges = <FlutterWidgetPreviews>[];
6566
detectedPubspecChanges = <String>[];
67+
detectedNonDartFileChanges = <String>[];
6668

6769
detector = LspPreviewDetector(
6870
platform: platform,
@@ -72,6 +74,7 @@ void main() {
7274
logger: logger,
7375
onChangeDetected: detectedChanges.add,
7476
onPubspecChangeDetected: detectedPubspecChanges.add,
77+
onNonDartFileChangeDetected: detectedNonDartFileChanges.add,
7578
dtd: fakeDtd,
7679
processManager: FakeProcessManager.any(),
7780
terminal: Terminal.test(),
@@ -136,21 +139,20 @@ void main() {
136139
},
137140
);
138141

139-
testWithoutContext(
140-
'does not report preview reload timing when non-Dart file is modified',
141-
() async {
142-
expectNPreviewReloadTimingEvents(0);
143-
expect(detectedChanges, isEmpty);
144-
expect(detectedPubspecChanges, isEmpty);
142+
testWithoutContext('notifies onNonDartFileChangeDetected and does not report preview reload timing when non-Dart file is modified', () async {
143+
expectNPreviewReloadTimingEvents(0);
144+
expect(detectedChanges, isEmpty);
145+
expect(detectedPubspecChanges, isEmpty);
146+
expect(detectedNonDartFileChanges, isEmpty);
145147

146-
await emitEvent(WatchEvent(ChangeType.MODIFY, _kNonDartFilePath));
148+
await emitEvent(WatchEvent(ChangeType.MODIFY, _kNonDartFilePath));
147149

148-
expect(detectedChanges, isEmpty);
149-
expect(detectedPubspecChanges, isEmpty);
150-
expectNPreviewReloadTimingEvents(0);
151-
expect(fakeAnalysisServer.waitForAnalysisCallCount, 0);
152-
},
153-
);
150+
expect(detectedChanges, isEmpty);
151+
expect(detectedPubspecChanges, isEmpty);
152+
expect(detectedNonDartFileChanges, <String>[_kNonDartFilePath]);
153+
expectNPreviewReloadTimingEvents(0);
154+
expect(fakeAnalysisServer.waitForAnalysisCallCount, 0);
155+
});
154156

155157
testWithoutContext('does not report preview reload timing for ignored directories', () async {
156158
expectNPreviewReloadTimingEvents(0);
@@ -159,6 +161,7 @@ void main() {
159161

160162
expect(detectedChanges, isEmpty);
161163
expect(detectedPubspecChanges, isEmpty);
164+
expect(detectedNonDartFileChanges, isEmpty);
162165
expectNPreviewReloadTimingEvents(0);
163166
expect(fakeAnalysisServer.waitForAnalysisCallCount, 0);
164167
});

‎packages/flutter_tools/test/general.shard/asset_bundle_test.dart‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,9 @@ void main() {
127127
],
128128
},
129129
);
130+
expect(bundle.needsBuild(), isFalse);
131+
dataAssetFile.deleteSync();
132+
expect(bundle.needsBuild(), isTrue);
130133
},
131134
overrides: <Type, Generator>{
132135
FileSystem: () => testFileSystem,

0 commit comments

Comments
 (0)