| // Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file |
| // for details. All rights reserved. Use of this source code is governed by a |
| // BSD-style license that can be found in the LICENSE file. |
| |
| /// This is a helper library to make working with io easier. |
| library dartdoc.io_utils; |
| |
| import 'dart:async'; |
| import 'dart:convert'; |
| import 'dart:io'; |
| |
| import 'package:dartdoc/src/tuple.dart'; |
| import 'package:path/path.dart' as pathLib; |
| |
| /// Return a resolved path including the home directory in place of tilde |
| /// references. |
| String resolveTildePath(String originalPath) { |
| if (originalPath == null || !originalPath.startsWith('~/')) { |
| return originalPath; |
| } |
| |
| String homeDir; |
| |
| if (Platform.isWindows) { |
| homeDir = pathLib.absolute(Platform.environment['USERPROFILE']); |
| } else { |
| homeDir = pathLib.absolute(Platform.environment['HOME']); |
| } |
| |
| return pathLib.join(homeDir, originalPath.substring(2)); |
| } |
| |
| /// Lists the contents of [dir]. |
| /// |
| /// If [recursive] is `true`, lists subdirectory contents (defaults to `false`). |
| /// |
| /// Excludes files and directories beginning with `.` |
| /// |
| /// The returned paths are guaranteed to begin with [dir]. |
| Iterable<String> listDir(String dir, |
| {bool recursive: false, |
| Iterable<FileSystemEntity> listDir(Directory dir)}) { |
| if (listDir == null) listDir = (Directory dir) => dir.listSync(); |
| |
| return _doList(dir, new Set<String>(), recursive, listDir); |
| } |
| |
| Iterable<String> _doList(String dir, Set<String> listedDirectories, |
| bool recurse, Iterable<FileSystemEntity> listDir(Directory dir)) sync* { |
| // Avoid recursive symlinks. |
| var resolvedPath = new Directory(dir).resolveSymbolicLinksSync(); |
| if (!listedDirectories.contains(resolvedPath)) { |
| listedDirectories = new Set<String>.from(listedDirectories); |
| listedDirectories.add(resolvedPath); |
| |
| for (var entity in listDir(new Directory(dir))) { |
| // Skip hidden files and directories |
| if (pathLib.basename(entity.path).startsWith('.')) { |
| continue; |
| } |
| |
| yield entity.path; |
| if (entity is Directory) { |
| if (recurse) { |
| yield* _doList(entity.path, listedDirectories, recurse, listDir); |
| } |
| } |
| } |
| } |
| } |
| |
| /// Converts `.` and `:` into `-`, adding a ".html" extension. |
| /// |
| /// For example: |
| /// |
| /// * dart.dartdoc => dart_dartdoc.html |
| /// * dart:core => dart_core.html |
| String getFileNameFor(String name) => |
| '${name.replaceAll(libraryNameRegexp, '-')}.html'; |
| |
| final libraryNameRegexp = new RegExp('[.:]'); |
| final partOfRegexp = new RegExp('part of '); |
| final newLinePartOfRegexp = new RegExp('\npart of '); |
| |
| final RegExp quotables = new RegExp(r'[ "\r\n\$]'); |
| |
| /// Best used with Future<void>. |
| class MultiFutureTracker<T> { |
| /// Approximate maximum number of simultaneous active Futures. |
| final int parallel; |
| |
| final Set<Future<T>> _trackedFutures = new Set(); |
| |
| MultiFutureTracker(this.parallel); |
| |
| /// Wait until fewer or equal to this many Futures are outstanding. |
| Future<void> _waitUntil(int max) async { |
| while (_trackedFutures.length > max) { |
| await Future.any(_trackedFutures); |
| } |
| } |
| |
| /// Generates a [Future] from the given closure and adds it to the queue, |
| /// once the queue is sufficiently empty. The returned future completes |
| /// when the generated [Future] has been added to the queue. |
| Future<void> addFutureFromClosure(Future<T> Function() closure) async { |
| while (_trackedFutures.length > parallel - 1) { |
| await Future.any(_trackedFutures); |
| } |
| Future future = closure(); |
| _trackedFutures.add(future); |
| // ignore: unawaited_futures |
| future.then((f) => _trackedFutures.remove(future)); |
| } |
| |
| /// Wait until all futures added so far have completed. |
| Future<void> wait() async => await _waitUntil(0); |
| } |
| |
| /// Keeps track of coverage data automatically for any processes run by this |
| /// [CoverageSubprocessLauncher]. Requires that these be dart processes. |
| class CoverageSubprocessLauncher extends SubprocessLauncher { |
| CoverageSubprocessLauncher(String context, [Map<String, String> environment]) |
| : super(context, environment); |
| |
| static int nextObservatoryPort = 9292; |
| |
| /// Set this to true to enable coverage runs. |
| static bool coverageEnabled = false; |
| |
| /// A list of all coverage results picked up by all launchers. |
| static List<Tuple2<String, Future<Iterable<Map>>>> coverageResults = []; |
| |
| static Directory _tempDir; |
| static Directory get tempDir => |
| _tempDir ??= Directory.systemTemp.createTempSync('dartdoc_coverage_data'); |
| |
| int _observatoryPort; |
| // TODO(jcollins-g): use ephemeral ports |
| int get observatoryPort => _observatoryPort ??= nextObservatoryPort++; |
| |
| String _outCoverageFilename; |
| String get outCoverageFilename => _outCoverageFilename ??= |
| pathLib.join(tempDir.path, 'dart-cov-0-${observatoryPort}.json'); |
| |
| /// Call once all coverage runs have been generated by calling runStreamed |
| /// on all [CoverageSubprocessLaunchers]. |
| static Future<void> generateCoverageToFile(File outputFile) async { |
| if (!coverageEnabled) return Future.value(null); |
| var currentCoverageResults = coverageResults; |
| coverageResults = []; |
| var launcher = SubprocessLauncher('format_coverage'); |
| |
| /// Wait for all coverage runs to finish. |
| await Future.wait(currentCoverageResults.map((t) => t.item2)); |
| |
| return launcher.runStreamed(Platform.executable, [ |
| 'tool/format_coverage.dart', // TODO(jcollins-g): use pub after dart-lang/coverage#240 is landed |
| '--lcov', |
| '-v', |
| '-b', '.', |
| '--packages=.packages', |
| '--sdk-root=${pathLib.canonicalize(pathLib.join(pathLib.dirname(Platform.executable), '..'))}', |
| '--out=${pathLib.canonicalize(outputFile.path)}', |
| '--report-on=bin,lib', |
| '-i', tempDir.path, |
| ]); |
| } |
| |
| @override |
| Future<Iterable<Map>> runStreamed(String executable, List<String> arguments, |
| {String workingDirectory}) { |
| assert(executable == Platform.executable, |
| 'Must use dart executable for tracking coverage'); |
| |
| if (coverageEnabled) { |
| arguments = [ |
| '--enable-vm-service=${observatoryPort}', |
| '--pause-isolates-on-exit' |
| ]..addAll(arguments); |
| } |
| |
| Future<Iterable<Map>> results = super |
| .runStreamed(executable, arguments, workingDirectory: workingDirectory); |
| |
| if (coverageEnabled) { |
| coverageResults.add(new Tuple2( |
| outCoverageFilename, |
| super.runStreamed('pub', [ |
| 'run', |
| 'coverage:collect_coverage', |
| '--wait-paused', |
| '--resume-isolates', |
| '--port=${observatoryPort}', |
| '--out=${outCoverageFilename}', |
| ]))); |
| } |
| return results; |
| } |
| } |
| |
| class SubprocessLauncher { |
| final String context; |
| final Map<String, String> environment; |
| |
| String get prefix => context.isNotEmpty ? '$context: ' : ''; |
| |
| // from flutter:dev/tools/dartdoc.dart, modified |
| static Future<void> _printStream(Stream<List<int>> stream, Stdout output, |
| {String prefix: '', Iterable<String> Function(String line) filter}) { |
| assert(prefix != null); |
| if (filter == null) filter = (line) => [line]; |
| return stream |
| .transform(utf8.decoder) |
| .transform(const LineSplitter()) |
| .expand(filter) |
| .listen((String line) { |
| if (line != null) { |
| output.write('$prefix$line'.trim()); |
| output.write('\n'); |
| } |
| }).asFuture(); |
| } |
| |
| SubprocessLauncher(this.context, [Map<String, String> environment]) |
| : this.environment = environment ?? <String, String>{}; |
| |
| /// A wrapper around start/await process.exitCode that will display the |
| /// output of the executable continuously and fail on non-zero exit codes. |
| /// It will also parse any valid JSON objects (one per line) it encounters |
| /// on stdout/stderr, and return them. Returns null if no JSON objects |
| /// were encountered, or if DRY_RUN is set to 1 in the execution environment. |
| /// |
| /// Makes running programs in grinder similar to set -ex for bash, even on |
| /// Windows (though some of the bashisms will no longer make sense). |
| /// TODO(jcollins-g): move this to grinder? |
| Future<Iterable<Map>> runStreamed(String executable, List<String> arguments, |
| {String workingDirectory}) async { |
| List<Map> jsonObjects; |
| |
| /// Allow us to pretend we didn't pass the JSON flag in to dartdoc by |
| /// printing what dartdoc would have printed without it, yet storing |
| /// json objects into [jsonObjects]. |
| Iterable<String> jsonCallback(String line) { |
| Map result; |
| try { |
| result = json.decoder.convert(line); |
| } catch (FormatException) {} |
| if (result != null) { |
| if (jsonObjects == null) { |
| jsonObjects = new List(); |
| } |
| jsonObjects.add(result); |
| if (result.containsKey('message')) { |
| line = result['message']; |
| } else if (result.containsKey('data')) { |
| line = result['data']['text']; |
| } |
| } |
| return line.split('\n'); |
| } |
| |
| stderr.write('$prefix+ '); |
| if (workingDirectory != null) stderr.write('(cd "$workingDirectory" && '); |
| if (environment != null) { |
| stderr.write(environment.keys.map((String key) { |
| if (environment[key].contains(quotables)) { |
| return "$key='${environment[key]}'"; |
| } else { |
| return "$key=${environment[key]}"; |
| } |
| }).join(' ')); |
| stderr.write(' '); |
| } |
| stderr.write('$executable'); |
| if (arguments.isNotEmpty) { |
| for (String arg in arguments) { |
| if (arg.contains(quotables)) { |
| stderr.write(" '$arg'"); |
| } else { |
| stderr.write(" $arg"); |
| } |
| } |
| } |
| if (workingDirectory != null) stderr.write(')'); |
| stderr.write('\n'); |
| |
| if (Platform.environment.containsKey('DRY_RUN')) return null; |
| |
| String realExecutable = executable; |
| final List<String> realArguments = []; |
| if (Platform.isLinux) { |
| // Use GNU coreutils to force line buffering. This makes sure that |
| // subprocesses that die due to fatal signals do not chop off the |
| // last few lines of their output. |
| // |
| // Dart does not actually do this (seems to flush manually) unless |
| // the VM crashes. |
| realExecutable = 'stdbuf'; |
| realArguments.addAll(['-o', 'L', '-e', 'L']); |
| realArguments.add(executable); |
| } |
| realArguments.addAll(arguments); |
| |
| Process process = await Process.start(realExecutable, realArguments, |
| workingDirectory: workingDirectory, environment: environment); |
| Future<void> stdoutFuture = _printStream(process.stdout, stdout, |
| prefix: prefix, filter: jsonCallback); |
| Future<void> stderrFuture = _printStream(process.stderr, stderr, |
| prefix: prefix, filter: jsonCallback); |
| await Future.wait([stderrFuture, stdoutFuture, process.exitCode]); |
| |
| int exitCode = await process.exitCode; |
| if (exitCode != 0) { |
| throw new ProcessException(executable, arguments, |
| "SubprocessLauncher got non-zero exitCode: $exitCode", exitCode); |
| } |
| return jsonObjects; |
| } |
| } |