Skip to content

Convert to using a single AnalysisDriver in place of a single AnalysisContext. #1598

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 10 commits into from
Feb 2, 2018
Merged

Convert to using a single AnalysisDriver in place of a single AnalysisContext. #1598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
fc6c9e8
More or less wired up.
jcollins-g Jan 29, 2018
e71736a
Hacks everywhere but dartdoc mostly works
jcollins-g Jan 29, 2018
294f3b8
Analysis driver seems to work
jcollins-g Jan 30, 2018
41f0043
Cleanup and regen docs
jcollins-g Jan 30, 2018
0ecb481
Add link to analyzer issue and dartfmt
jcollins-g Jan 30, 2018
9400f42
fix analyzer error I missed somehow
jcollins-g Jan 30, 2018
ed20cf5
Removing computeNode from annotations tests as safe now.
jcollins-g Jan 31, 2018
336f0ea
Cleanup dynamic use (no longer necessary since element.metadata is re…
jcollins-g Jan 31, 2018
5fce3cd
Merge branch 'master' into analysis-driver
jcollins-g Jan 31, 2018
ad89c0c
review comment
jcollins-g Feb 2, 2018
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
9 changes: 5 additions & 4 deletions lib/dartdoc.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import 'dart:convert';
import 'dart:io';

import 'package:analyzer/analyzer.dart';
import 'package:analyzer/dart/analysis/results.dart';
import 'package:analyzer/src/generated/engine.dart';
import 'package:analyzer/src/generated/source.dart';
import 'package:dartdoc/src/utils.dart';
Expand Down Expand Up @@ -99,14 +100,14 @@ class DartDoc extends PackageBuilder {
Stream<String> get onCheckProgress => _onCheckProgress.stream;

@override
void logAnalysisErrors(Set<Source> sources) {
logAnalysisErrors(Set<Source> sources) async {
List<AnalysisErrorInfo> errorInfos = [];
// TODO(jcollins-g): figure out why sources can't contain includeExternals
// or embedded SDK components without having spurious(?) analysis errors.
// That seems wrong. dart-lang/dartdoc#1547
for (Source source in sources) {
context.computeErrors(source);
AnalysisErrorInfo info = context.getErrors(source);
ErrorsResult errorsResult = await driver.getErrors(source.fullName);
AnalysisErrorInfo info = new AnalysisErrorInfoImpl(errorsResult.errors, errorsResult.lineInfo);
List<_Error> errors = [info]
.expand((AnalysisErrorInfo info) {
return info.errors.map((error) =>
Expand Down Expand Up @@ -153,7 +154,7 @@ class DartDoc extends PackageBuilder {
Future<DartDocResults> generateDocs() async {
Stopwatch _stopwatch = new Stopwatch()..start();
double seconds;
package = buildPackage();
package = await buildPackage();
seconds = _stopwatch.elapsedMilliseconds / 1000.0;
logInfo(
"Initialized dartdoc with ${package.libraries.length} librar${package.libraries.length == 1 ? 'y' : 'ies'} "
Expand Down
158 changes: 82 additions & 76 deletions lib/src/model.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,13 @@
/// The models used to represent Dart code.
library dartdoc.models;

import 'dart:async';
import 'dart:collection' show UnmodifiableListView;
import 'dart:convert';
import 'dart:io';

import 'package:analyzer/dart/ast/ast.dart'
show
AnnotatedNode,
Declaration,
Expression,
FieldDeclaration,
InstanceCreationExpression,
VariableDeclaration,
VariableDeclarationList;
show Declaration, Expression, InstanceCreationExpression;
import 'package:analyzer/dart/element/element.dart';
import 'package:analyzer/dart/element/type.dart';
import 'package:analyzer/file_system/file_system.dart' as fileSystem;
Expand All @@ -26,9 +20,11 @@ import 'package:analyzer/source/package_map_resolver.dart';
import 'package:analyzer/source/sdk_ext.dart';
// TODO(jcollins-g): Stop using internal analyzer structures somehow.
import 'package:analyzer/src/context/builder.dart';
import 'package:analyzer/src/dart/analysis/file_state.dart';
import 'package:analyzer/src/dart/element/element.dart';
import 'package:analyzer/src/dart/element/handle.dart';
import 'package:analyzer/src/dart/sdk/sdk.dart';
import 'package:analyzer/src/generated/engine.dart';
import 'package:analyzer/src/generated/engine.dart' hide AnalysisResult;
import 'package:analyzer/src/generated/java_io.dart';
import 'package:analyzer/src/generated/resolver.dart'
show Namespace, NamespaceBuilder, InheritanceManager;
Expand All @@ -38,8 +34,11 @@ import 'package:analyzer/src/generated/source_io.dart';
import 'package:analyzer/src/generated/utilities_dart.dart' show ParameterKind;
import 'package:analyzer/src/dart/element/member.dart'
show ExecutableMember, Member, ParameterMember;
import 'package:analyzer/src/dart/analysis/driver.dart';
import 'package:collection/collection.dart';
import 'package:dartdoc/src/io_utils.dart';
import 'package:front_end/byte_store.dart';
import 'package:front_end/src/base/performance_logger.dart';
import 'package:path/path.dart' as p;
import 'package:tuple/tuple.dart';
import 'package:package_config/discovery.dart' as package_config;
Expand Down Expand Up @@ -2062,7 +2061,7 @@ class Library extends ModelElement {
String get nameFromPath {
if (_nameFromPath == null) {
_nameFromPath =
getNameFromPath(element, package.context, package.packageMeta);
getNameFromPath(element, package.driver, package.packageMeta);
}
return _nameFromPath;
}
Expand Down Expand Up @@ -2200,13 +2199,13 @@ class Library extends ModelElement {
/// Not the same as [Package.name] because there we always strip all
/// path components; this function only strips the package prefix if the
/// library is part of the default package.
static String getNameFromPath(LibraryElement element, AnalysisContext context,
static String getNameFromPath(LibraryElement element, AnalysisDriver driver,
PackageMeta defaultPackage) {
String name;
if (element.source.uri.toString().startsWith('dart:')) {
name = element.source.uri.toString();
} else {
name = context.sourceFactory.restoreUri(element.source).toString();
name = driver.sourceFactory.restoreUri(element.source).toString();
}
if (name.startsWith('file:')) {
// restoreUri doesn't do anything for the package we're documenting.
Expand Down Expand Up @@ -2575,6 +2574,12 @@ abstract class ModelElement extends Canonicalization
Accessor getter,
Accessor setter,
Package package}) {
// With AnalysisDriver, we sometimes get ElementHandles when building
// docs for the SDK, seen via [Library.importedExportedLibraries]. Why?
if (e is ElementHandle) {
e = (e as ElementHandle).actualElement;
}

Member originalMember;
// TODO(jcollins-g): Refactor object model to instantiate 'ModelMembers'
// for members?
Expand Down Expand Up @@ -2632,7 +2637,9 @@ abstract class ModelElement extends Canonicalization
assert(e.enclosingElement.name != '');
newModelElement = new ModelFunctionTypedef(e, library);
} else {
assert(e.name == '');
// Allowing null here is allowed as a workaround for
// dart-lang/sdk#32005.
assert(e.name == '' || e.name == null);
newModelElement = new ModelFunctionAnonymous(e, library);
}
}
Expand All @@ -2644,7 +2651,7 @@ abstract class ModelElement extends Canonicalization
if (enclosingClass == null) {
if (e.isEnumConstant) {
int index =
e.computeConstantValue().getField('index').toIntValue();
e.computeConstantValue().getField(e.name).toIntValue();
newModelElement =
new EnumField.forConstant(index, e, library, getter);
} else if (e.enclosingElement.isEnum) {
Expand Down Expand Up @@ -2737,31 +2744,12 @@ abstract class ModelElement extends Canonicalization

// TODO(jcollins-g): annotations should now be able to use the utility
// functions in package for finding elements and avoid using computeNode().
List<String> get annotations {
List<dynamic> metadata;
if (element.computeNode() is AnnotatedNode) {
AnnotatedNode node = element.computeNode() as AnnotatedNode;

// Declarations are contained inside FieldDeclarations, and that is where
// the actual annotations are.
while ((node is VariableDeclaration || node is VariableDeclarationList) &&
node is! FieldDeclaration) {
assert(null != node.parent);
node = node.parent;
}
metadata = node.metadata;
} else {
metadata = element.metadata;
}
return annotationsFromMetadata(metadata);
}
List<String> get annotations => annotationsFromMetadata(element.metadata);

/// Returns annotations from a given metadata set, with escaping.
/// md is a dynamic parameter since ElementAnnotation and Annotation have no
/// common class for calling toSource() and element.
List<String> annotationsFromMetadata(List<dynamic> md) {
if (md == null) md = new List<dynamic>();
return md.map((dynamic a) {
/// Returns linked annotations from a given metadata set, with escaping.
List<String> annotationsFromMetadata(List<ElementAnnotation> md) {
if (md == null) return <String>[];
return md.map((ElementAnnotation a) {
String annotation = (const HtmlEscape()).convert(a.toSource());
// a.element can be null if the element can't be resolved.
var me =
Expand Down Expand Up @@ -3863,7 +3851,7 @@ class Package extends Canonicalization with Nameable, Warnable {
@override
Package get package => this;

final AnalysisContext context;
final AnalysisDriver driver;
final DartSdk sdk;

Map<Source, SdkLibrary> _sdkLibrarySources;
Expand Down Expand Up @@ -3899,7 +3887,7 @@ class Package extends Canonicalization with Nameable, Warnable {
bool _macrosAdded = false;

Package(Iterable<LibraryElement> libraryElements, this.packageMeta,
this._packageWarningOptions, this.context,
this._packageWarningOptions, this.driver,
[this.sdk]) {
assert(_allConstructedModelElements.isEmpty);
assert(allLibraries.isEmpty);
Expand Down Expand Up @@ -4641,7 +4629,14 @@ class Parameter extends ModelElement implements EnclosedElement {
String enclosingName = _parameter.enclosingElement.name;
if (_parameter.enclosingElement is GenericFunctionTypeElement) {
// TODO(jcollins-g): Drop when GenericFunctionTypeElement populates name.
enclosingName = _parameter.enclosingElement.enclosingElement.name;
// Also, allowing null here is allowed as a workaround for
// dart-lang/sdk#32005.
for (Element e = _parameter.enclosingElement;
e.enclosingElement != null;
e = e.enclosingElement) {
enclosingName = e.name;
if (enclosingName != null && enclosingName.isNotEmpty) break;
}
}
return '${enclosingName}-param-${name}';
}
Expand Down Expand Up @@ -4999,10 +4994,10 @@ class PackageBuilder {

void logAnalysisErrors(Set<Source> sources) {}

Package buildPackage() {
Set<LibraryElement> libraries = getLibraries(getFiles);
Future<Package> buildPackage() async {
Set<LibraryElement> libraries = await getLibraries(getFiles);
return new Package(
libraries, packageMeta, getWarningOptions(), context, sdk);
libraries, packageMeta, getWarningOptions(), driver, sdk);
}

DartSdk _sdk;
Expand Down Expand Up @@ -5079,19 +5074,32 @@ class PackageBuilder {
return sourceFactory;
}

AnalysisContext _context;
AnalysisContext get context {
if (_context == null) {
// TODO(jcollins-g): fix this so it actually obeys analyzer options files.
var options = new AnalysisOptionsImpl();
AnalysisDriver _driver;
AnalysisDriver get driver {
if (_driver == null) {
// The performance log is why we have a direct dependency on front_end.
PerformanceLog log = new PerformanceLog(null);
AnalysisDriverScheduler scheduler = new AnalysisDriverScheduler(log);
AnalysisOptionsImpl options = new AnalysisOptionsImpl();
options.enableSuperMixins = true;
AnalysisEngine.instance.processRequiredPlugins();

_context = AnalysisEngine.instance.createAnalysisContext()
..analysisOptions = options
..sourceFactory = sourceFactory;
}
return _context;
// TODO(jcollins-g): Make use of currently not existing API for managing
// many AnalysisDrivers
// TODO(jcollins-g): make use of DartProject isApi()
_driver = new AnalysisDriver(
scheduler,
log,
PhysicalResourceProvider.INSTANCE,
new MemoryByteStore(),
new FileContentOverlay(),
null,
sourceFactory,
options);
driver.results.listen((_) {});
driver.exceptions.listen((_) {});
scheduler.start();
}
return _driver;
}

PackageWarningOptions getWarningOptions() {
Expand Down Expand Up @@ -5119,11 +5127,11 @@ class PackageBuilder {

bool isExcluded(String name) => excludes.any((pattern) => name == pattern);

/// Parse a single library at [filePath] using the current analysis context.
/// Parse a single library at [filePath] using the current analysis driver.
/// Note: [libraries] and [sources] are output parameters. Adds a libraryElement
/// only if it has a non-private name.
void processLibrary(
String filePath, Set<LibraryElement> libraries, Set<Source> sources) {
Future processLibrary(String filePath, Set<LibraryElement> libraries,
Set<Source> sources) async {
String name = filePath;
if (name.startsWith(Directory.current.path)) {
name = name.substring(Directory.current.path.length);
Expand All @@ -5140,15 +5148,16 @@ class PackageBuilder {
if (uri != null) {
source = new FileBasedSource(javaFile, uri);
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we still use java files?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Apparently so. It looks like it might be possible to eliminate some of the usage (the TODO above), but we still need them for finding the analysis errors we care about later on.

} else {
uri = context.sourceFactory.restoreUri(source);
uri = driver.sourceFactory.restoreUri(source);
if (uri != null) {
source = new FileBasedSource(javaFile, uri);
}
}
// TODO(jcollins-g): Excludes can match on uri or on name. Fix that.
if (!isExcluded(source.uri.toString())) {
if (context.computeKindOf(source) == SourceKind.LIBRARY) {
LibraryElement library = context.computeLibraryElement(source);
LibraryElement library =
await driver.getLibraryByUri(source.uri.toString());
if (library != null) {
if (!isExcluded(Library.getLibraryName(library)) &&
!excludePackages.contains(Library.getPackageMeta(library)?.name)) {
libraries.add(library);
Expand All @@ -5158,16 +5167,13 @@ class PackageBuilder {
}
}

List<LibraryElement> _parseLibraries(Set<String> files) {
Future<List<LibraryElement>> _parseLibraries(Set<String> files) async {
Set<LibraryElement> libraries = new Set();
Set<Source> sources = new Set();
files.forEach((filename) => processLibrary(filename, libraries, sources));
// Ensure that the analysis engine performs all remaining work.
AnalysisResult result = context.performAnalysisTask();
while (result.hasMoreWork) {
result = context.performAnalysisTask();
}
logAnalysisErrors(sources);
Set<Source> sources = new Set<Source>();
files.forEach((filename) => driver.addFile(filename));

await Future.wait(files.map((f) => processLibrary(f, libraries, sources)));
await logAnalysisErrors(sources);
return libraries.toList();
}

Expand Down Expand Up @@ -5238,16 +5244,16 @@ class PackageBuilder {
});
}
// Use the includeExternals.
for (Source source in context.librarySources) {
if (includeExternals.any((string) => source.fullName.endsWith(string)))
files.add(source.fullName);
for (String fullName in driver.knownFiles) {
if (includeExternals.any((string) => fullName.endsWith(string)))
files.add(fullName);
}
return files;
return new Set.from(files.map((s) => new File(s).absolute.path));
}

Set<LibraryElement> getLibraries(Set<String> files) {
Future<Set<LibraryElement>> getLibraries(Set<String> files) async {
Set<LibraryElement> libraries = new Set();
libraries.addAll(_parseLibraries(files));
libraries.addAll(await _parseLibraries(files));
if (includes != null && includes.isNotEmpty) {
Iterable knownLibraryNames = libraries.map((l) => l.name);
Set notFound =
Expand Down
2 changes: 2 additions & 0 deletions lib/src/model_utils.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ bool isInExportedLibraries(

final RegExp slashes = new RegExp('[\/]');
bool hasPrivateName(Element e) {
if (e.name == null) return false;

if (e.name.startsWith('_')) {
return true;
}
Expand Down
2 changes: 1 addition & 1 deletion pubspec.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ packages:
source: hosted
version: "0.3.1"
front_end:
dependency: transitive
dependency: "direct main"
description:
name: front_end
url: "https://pub.dartlang.org"
Expand Down
1 change: 1 addition & 0 deletions pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ dependencies:
analyzer: 0.31.0-alpha.2
args: '>=0.13.0 <2.0.0'
collection: ^1.2.0
front_end: ^0.1.0-alpha.7
html: '>=0.12.1 <0.14.0'
# We don't use http_parser directly; this dep exists to ensure that we get at
# least version 3.0.3 to work around an issue with 3.0.2.
Expand Down
6 changes: 3 additions & 3 deletions test/model_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ void main() {
Library interceptorsLib;
Package sdkAsPackage;

setUpAll(() {
utils.init();
setUpAll(() async {
await utils.init();
package = utils.testPackage;
ginormousPackage = utils.testPackageGinormous;
exLibrary = package.libraries.firstWhere((lib) => lib.name == 'ex');
Expand Down Expand Up @@ -2065,7 +2065,7 @@ String topLevelFunction(int param1, bool param2, Cool coolBeans,
expect(
aComplexTypedef.linkedReturnType,
equals(
'Function<span class="signature">(<span class="parameter" id="-param-"><span class="type-annotation">A1</span>, </span> <span class="parameter" id="-param-"><span class="type-annotation">A2</span>, </span> <span class="parameter" id="-param-"><span class="type-annotation">A3</span></span>)</span>'));
'Function<span class="signature">(<span class="parameter" id="aComplexTypedef-param-"><span class="type-annotation">A1</span>, </span> <span class="parameter" id="aComplexTypedef-param-"><span class="type-annotation">A2</span>, </span> <span class="parameter" id="aComplexTypedef-param-"><span class="type-annotation">A3</span></span>)</span>'));
expect(
aComplexTypedef.linkedParamsLines,
equals(
Expand Down
Loading