Skip to content

Mitigate out of free space issues while running dartdoc postprocessing. #8079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 26, 2024
Merged

Mitigate out of free space issues while running dartdoc postprocessing. #8079

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
91d6f24
Mitigate out of free space issues while running dartdoc postprocessing.
isoos Sep 26, 2024
38913c5
remove parts
isoos Sep 26, 2024
7968a2a
Added rethrow
isoos Sep 26, 2024
ae78cd6
updated comment
isoos Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 31 additions & 12 deletions pkg/pub_worker/lib/src/bin/dartdoc_wrapper.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ Future<void> postProcessDartdoc({
required String docDir,
}) async {
_log.info('Running dartdoc post-processing');
final tmpOutDir = p.join(outputFolder, '_doc');
await Directory(tmpOutDir).create(recursive: true);
final tmpOutDir = Directory(p.join(outputFolder, '_doc'));
await tmpOutDir.create(recursive: true);
final processingFuture = Isolate.run(() async {
final files = Directory(docDir)
.list(recursive: true, followLinks: false)
.whereType<File>();
await for (final file in files) {
final suffix = file.path.substring(docDir.length + 1);
final targetFile = File(p.join(tmpOutDir, suffix));
final targetFile = File(p.join(tmpOutDir.path, suffix));
await targetFile.parent.create(recursive: true);
final isDartDocSidebar =
file.path.endsWith('.html') && file.path.endsWith('-sidebar.html');
Expand Down Expand Up @@ -85,14 +85,33 @@ Future<void> postProcessDartdoc({
_log.info('Finished .tar.gz archive');
});

await Future.wait([
processingFuture,
archiveFuture,
]);
try {
await Future.wait([
processingFuture,
archiveFuture,
]);

// Move from temporary output directory to final one, ensuring that
// documentation files won't be present unless all files have been processed.
// This helps if there is a timeout along the way.
await Directory(tmpOutDir).rename(p.join(outputFolder, 'doc'));
await tmpTar.rename(p.join(outputFolder, 'doc', 'package.tar.gz'));
// Move from temporary output directory to final one, ensuring that
// documentation files won't be present unless all files have been processed.
// This helps if there is a timeout along the way.
await tmpOutDir.rename(p.join(outputFolder, 'doc'));
await tmpTar.rename(p.join(outputFolder, 'doc', 'package.tar.gz'));
} catch (e, st) {
// We are likely out of free disk space.
// Cleanup the content as we won't use it.
await tmpOutDir.deleteIgnoringErrors(recursive: true);
await tmpTar.deleteIgnoringErrors();

_log.shout('Failed to run dartdoc post-processing.', e, st);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At a minimum we should exit non-zero here, right?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or rethrow?

}
}

extension on FileSystemEntity {
Future<void> deleteIgnoringErrors({bool recursive = false}) async {
try {
await delete(recursive: recursive);
} catch (_) {
// ignored
}
}
}
Loading