Skip to content
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

Nicer failures when an annotation is not resolvable #201

Merged
merged 4 commits into from
Jul 6, 2017
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
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
result we've added `#annotationsOfExact|firstAnnotationOfExact` which has the
old behavior for precise checks.

* `TypeChecker#annotations...`-methods now throw a `StateError` if one or more
annotations on an element are not resolvable. This is usually a sign of a
mispelling, missing import, or missing dependency.

## 0.5.10+1

* Update minimum `analyzer` package to `0.29.10`.
Expand Down
17 changes: 14 additions & 3 deletions lib/src/type_checker.dart
Original file line number Diff line number Diff line change
Expand Up @@ -58,16 +58,27 @@ abstract class TypeChecker {
return results.isEmpty ? null : results.first;
}

DartObject _checkedConstantValue(ElementAnnotation annotation) {
final result = annotation.computeConstantValue();
if (result == null) {
throw new StateError(
'Could not resolve $annotation. An import or dependency may be '
'missing or invalid.');
}
return result;
}

/// Returns annotating constants on [element] assignable to this type.
Iterable<DartObject> annotationsOf(Element element) => element.metadata
.map((a) => a.computeConstantValue())
.map(_checkedConstantValue)
.where((a) => isAssignableFromType(a.type));

/// Returns annotating constants on [element] of exactly this type.
Iterable<DartObject> annotationsOfExact(Element element) => element.metadata
.map((a) => a.computeConstantValue())
.where((a) => isExactlyType(a.type));
.map(_checkedConstantValue)
.where((a) => a?.type != null && isAssignableFromType(a.type));

/// Returns `true` if the type of [element] can be assigned to this type.
/// Returns `true` if the type of [element] can be assigned to this type.
bool isAssignableFrom(Element element) =>
isExactly(element) || _getAllSupertypes(element).any(isExactlyType);
Expand Down
15 changes: 15 additions & 0 deletions test/type_checker_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -179,4 +179,19 @@ void main() {
checkGeneratorForAnnotation: () => const TypeChecker.fromUrl(
'package:source_gen/src/generator_for_annotation.dart#GeneratorForAnnotation'));
});

test('should gracefully when something is not resolvable', () async {
final resolver = await resolveSource(r'''
library _test;

@depracated // Intentionally mispelled.
class X {}
''');
final lib = resolver.getLibraryByName('_test');
final classX = lib.getType('X');
final $deprecated = const TypeChecker.fromRuntime(Deprecated);

expect(() => $deprecated.annotationsOf(classX), throwsStateError,
reason: 'deprecated was spelled wrong; no annotation can be resolved');
});
}