Skip to content

Commit 4308314

Browse files
authored
[widget-preview] Copy host web directory to widget preview scaffold (flutter#188595)
Fixes flutter#179577 When `flutter widget-preview start` is run, it generates a scaffold project. However, it was not copying the host project's `web/` directory to the scaffold. This caused web-specific bootstrap resources (like custom `index.html` or scripts required by dependencies) to be missing, leading to crashes or failures on startup if dependencies required them. This PR fixes the issue by copying the host project's `web/` directory (if it exists) to the scaffold project: 1. During the initial scaffold generation. 2. On subsequent startups to ensure any updates in the host's `web/` directory are synced to the scaffold. A unit test has been added to verify that the host `web/` directory is correctly copied to the scaffold.
1 parent 62e0b8a commit 4308314

2 files changed

Lines changed: 70 additions & 0 deletions

File tree

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,7 @@ final class WidgetPreviewStartCommand extends WidgetPreviewSubCommandBase with C
359359
printStatusWhenWriting: verbose,
360360
);
361361
if (customPreviewScaffoldOutput != null) {
362+
_copyHostWebDirToScaffold(widgetPreviewScaffold);
362363
return FlutterCommandResult.success();
363364
}
364365
_previewManifest.generate();
@@ -388,6 +389,8 @@ final class WidgetPreviewStartCommand extends WidgetPreviewSubCommandBase with C
388389
await _previewPubspecBuilder.populatePreviewPubspec(rootProject: rootProject);
389390
}
390391

392+
_copyHostWebDirToScaffold(widgetPreviewScaffold);
393+
391394
if (!widgetPreviewScaffoldProject.dartTool.existsSync()) {
392395
await _previewPubspecBuilder.generatePackageConfig(
393396
widgetPreviewScaffoldProject: widgetPreviewScaffoldProject,
@@ -451,6 +454,21 @@ final class WidgetPreviewStartCommand extends WidgetPreviewSubCommandBase with C
451454
return FlutterCommandResult.success();
452455
}
453456

457+
void _copyHostWebDirToScaffold(Directory scaffoldDirectory) {
458+
final Directory hostWebDir = rootProject.directory.childDirectory('web');
459+
if (hostWebDir.existsSync()) {
460+
final Directory scaffoldWebDir = scaffoldDirectory.childDirectory('web');
461+
if (scaffoldWebDir.existsSync()) {
462+
logger.printTrace('Deleting scaffold web directory: ${scaffoldWebDir.path}');
463+
scaffoldWebDir.deleteSync(recursive: true);
464+
}
465+
logger.printTrace(
466+
'Copying host web directory to scaffold web directory: ${hostWebDir.path} -> ${scaffoldWebDir.path}',
467+
);
468+
copyDirectory(hostWebDir, scaffoldWebDir);
469+
}
470+
}
471+
454472
void onLegacyChangeDetected(PreviewDependencyGraph previews) {
455473
_previewCodeGenerator.populatePreviewsInGeneratedPreviewScaffold(previews);
456474
logger.printStatus('Triggering reload based on change to preview set: $previews');

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

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -443,6 +443,58 @@ void main() {
443443
},
444444
);
445445

446+
testUsingContext(
447+
'start copies host web directory to scaffold if it exists and removes stale files',
448+
() async {
449+
final Directory rootProject = await createRootProject();
450+
final Directory hostWebDir = rootProject.childDirectory('web')..createSync();
451+
hostWebDir.childFile('index.html').writeAsStringSync('<html>custom index</html>');
452+
final File staleFile = hostWebDir.childFile('stale.js')
453+
..writeAsStringSync('console.log("stale");');
454+
455+
await startWidgetPreview(rootProject: rootProject);
456+
457+
final Directory scaffoldWebDir = WidgetPreviewStartCommand.widgetPreviewScaffold
458+
.childDirectory('web');
459+
expect(scaffoldWebDir.existsSync(), true);
460+
expect(
461+
scaffoldWebDir.childFile('index.html').readAsStringSync(),
462+
'<html>custom index</html>',
463+
);
464+
expect(scaffoldWebDir.childFile('stale.js').readAsStringSync(), 'console.log("stale");');
465+
expectSinglePreviewLaunchTimingEvent();
466+
467+
// Now remove stale.js from host, and add a new file.
468+
staleFile.deleteSync();
469+
hostWebDir.childFile('new.js').writeAsStringSync('console.log("new");');
470+
471+
// Run again
472+
await startWidgetPreview(rootProject: rootProject);
473+
474+
expect(scaffoldWebDir.childFile('stale.js').existsSync(), false);
475+
expect(scaffoldWebDir.childFile('new.js').readAsStringSync(), 'console.log("new");');
476+
expect(
477+
scaffoldWebDir.childFile('index.html').readAsStringSync(),
478+
'<html>custom index</html>',
479+
);
480+
expectNPreviewLaunchTimingEvents(2);
481+
},
482+
overrides: <Type, Generator>{
483+
Analytics: () => fakeAnalytics,
484+
DeviceManager: () => fakeDeviceManager,
485+
FileSystem: () => fs,
486+
ProcessManager: () => loggingProcessManager,
487+
Pub: () => Pub.test(
488+
fileSystem: fs,
489+
logger: logger,
490+
processManager: loggingProcessManager,
491+
botDetector: botDetector,
492+
platform: platform,
493+
stdio: mockStdio,
494+
),
495+
},
496+
);
497+
446498
testUsingContext(
447499
'start waits for analysis to complete',
448500
() async {

0 commit comments

Comments
 (0)