Skip to content

Prepare tool_runner/definition for migration to NNBD #2784

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.

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 20, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 7 additions & 8 deletions lib/dartdoc.dart
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ import 'package:dartdoc/src/logging.dart';
import 'package:dartdoc/src/matching_link_result.dart';
import 'package:dartdoc/src/model/model.dart';
import 'package:dartdoc/src/package_meta.dart';
import 'package:dartdoc/src/tool_definition.dart';
import 'package:dartdoc/src/tool_runner.dart';
import 'package:dartdoc/src/tuple.dart';
import 'package:dartdoc/src/utils.dart';
import 'package:dartdoc/src/version.dart';
Expand Down Expand Up @@ -194,12 +192,15 @@ class Dartdoc {

Stream<String> get onCheckProgress => _onCheckProgress.stream;

@Deprecated('Will be removed in 4.0.0. '
'Use the return value from generateDocsBase instead.')
PackageGraph packageGraph;

@visibleForTesting
Future<DartdocResults> generateDocsBase() async {
var stopwatch = Stopwatch()..start();
packageGraph = await packageBuilder.buildPackageGraph();
var packageGraph = await packageBuilder.buildPackageGraph();
this.packageGraph = packageGraph;
var seconds = stopwatch.elapsedMilliseconds / 1000.0;
var libs = packageGraph.libraries.length;
logInfo("Initialized dartdoc with $libs librar${libs == 1 ? 'y' : 'ies'} "
Expand Down Expand Up @@ -243,10 +244,11 @@ class Dartdoc {
/// thrown if dartdoc fails in an expected way, for example if there is an
/// analysis error in the code.
Future<DartdocResults> generateDocs() async {
DartdocResults dartdocResults;
try {
logInfo('Documenting ${config.topLevelPackageMeta}...');

var dartdocResults = await generateDocsBase();
dartdocResults = await generateDocsBase();
if (dartdocResults.packageGraph.localPublicLibraries.isEmpty) {
logWarning('dartdoc could not find any libraries to document');
}
Expand All @@ -261,10 +263,7 @@ class Dartdoc {
logInfo('Success! Docs generated into $outDirPath');
return dartdocResults;
} finally {
// Clear out any cached tool snapshots and temporary directories.
SnapshotCache.instanceFor(config.resourceProvider).dispose();
// ignore: unawaited_futures
ToolTempFileTracker.instance?.dispose();
dartdocResults?.packageGraph?.dispose();
}
}

Expand Down
10 changes: 10 additions & 0 deletions lib/src/model/package_graph.dart
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ import 'package:dartdoc/src/package_meta.dart'
show PackageMeta, PackageMetaProvider;
import 'package:dartdoc/src/render/renderer_factory.dart';
import 'package:dartdoc/src/special_elements.dart';
import 'package:dartdoc/src/tool_definition.dart';
import 'package:dartdoc/src/tool_runner.dart';
import 'package:dartdoc/src/tuple.dart';
import 'package:dartdoc/src/warnings.dart';

Expand All @@ -37,6 +39,14 @@ class PackageGraph with CommentReferable, Nameable {
Package.fromPackageMeta(packageMeta, this);
}

void dispose() {
// Clear out any cached tool snapshots and temporary directories.
// TODO(jcollins-g): Consider ownership change for these objects
// so they are tied to PackageGraph instead of being global.
SnapshotCache.instanceFor(config.resourceProvider).dispose();
ToolTempFileTracker.instanceFor(config.resourceProvider).dispose();
}

@override
String get name => null;

Expand Down
2 changes: 1 addition & 1 deletion lib/src/tool_definition.dart
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ class SnapshotCache {
void dispose() {
_instances.remove(_resourceProvider);
if (snapshotCache != null && snapshotCache.exists) {
return snapshotCache.delete();
snapshotCache.delete();
}
return null;
}
Expand Down
18 changes: 8 additions & 10 deletions lib/src/tool_runner.dart
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,11 @@ class ToolTempFileTracker {
: temporaryDirectory =
resourceProvider.createSystemTemp('dartdoc_tools_');

static ToolTempFileTracker _instance;
static final Map<ResourceProvider, ToolTempFileTracker> _instances = {};

static ToolTempFileTracker get instance => _instance;

static ToolTempFileTracker createInstance(
ResourceProvider resourceProvider) =>
_instance ??= ToolTempFileTracker._(resourceProvider);
static ToolTempFileTracker instanceFor(ResourceProvider resourceProvider) =>
_instances.putIfAbsent(
resourceProvider, () => ToolTempFileTracker._(resourceProvider));

int _temporaryFileCount = 0;

Expand All @@ -46,9 +44,9 @@ class ToolTempFileTracker {
}

/// Call once no more files are to be created.
Future<void> dispose() async {
void dispose() {
if (temporaryDirectory.exists) {
return temporaryDirectory.delete();
temporaryDirectory.delete();
}
}
}
Expand Down Expand Up @@ -219,8 +217,8 @@ class ToolRunner {
// file before running the tool synchronously.

// Write the content to a temp file.
var tmpFile = ToolTempFileTracker.createInstance(resourceProvider)
.createTemporaryFile();
var tmpFile =
ToolTempFileTracker.instanceFor(resourceProvider).createTemporaryFile();
tmpFile.writeAsStringSync(content);
return pathContext.absolute(tmpFile.path);
}
Expand Down