Skip to content

Store dartdoc report with ScoreCard too. #1592

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 1 commit into from
Sep 10, 2018
Merged
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 app/bin/service/dartdoc.dart
Original file line number Diff line number Diff line change
@@ -14,6 +14,8 @@ import 'package:pub_dartlang_org/analyzer/backend.dart';
import 'package:pub_dartlang_org/history/backend.dart';
import 'package:pub_dartlang_org/job/backend.dart';
import 'package:pub_dartlang_org/job/job.dart';
import 'package:pub_dartlang_org/scorecard/backend.dart';
import 'package:pub_dartlang_org/scorecard/scorecard_memcache.dart';
import 'package:pub_dartlang_org/shared/analyzer_client.dart';
import 'package:pub_dartlang_org/shared/configuration.dart';
import 'package:pub_dartlang_org/shared/dartdoc_memcache.dart';
@@ -86,4 +88,6 @@ Future _registerServices() async {
registerDartdocBackend(new DartdocBackend(dbService, storageBucket));
registerHistoryBackend(new HistoryBackend(dbService));
registerJobBackend(new JobBackend(dbService));
registerScoreCardMemcache(new ScoreCardMemcache(memcacheService));
registerScoreCardBackend(new ScoreCardBackend(dbService));
}
20 changes: 20 additions & 0 deletions app/lib/dartdoc/dartdoc_runner.dart
Original file line number Diff line number Diff line change
@@ -15,6 +15,8 @@ import 'package:uuid/uuid.dart';
import '../analyzer/backend.dart';
import '../job/backend.dart';
import '../job/job.dart';
import '../scorecard/backend.dart';
import '../scorecard/models.dart';
import '../shared/analyzer_client.dart';
import '../shared/configuration.dart' show envConfig;
import '../shared/urls.dart';
@@ -74,6 +76,8 @@ class DartdocJobProcessor extends JobProcessor {
bool depsResolved = false;
bool hasContent = false;

String reportStatus = ReportStatus.failed;
final suggestions = <Suggestion>[];
try {
final pkgDir = await downloadPackage(job.packageName, job.packageVersion);
if (pkgDir == null) {
@@ -129,12 +133,14 @@ class DartdocJobProcessor extends JobProcessor {
_logger.severe('Regression detected in $job, aborting upload.');
} else {
await dartdocBackend.uploadDir(entry, outputDir);
reportStatus = hasContent ? ReportStatus.success : ReportStatus.failed;
}

if (!hasContent && isLatestStable) {
reportIssueWithLatest(job, 'No content.');
}
} catch (e, st) {
reportStatus = ReportStatus.aborted;
if (isLatestStable) {
reportIssueWithLatest(job, '$e\n$st');
}
@@ -143,6 +149,20 @@ class DartdocJobProcessor extends JobProcessor {
await tempDir.delete(recursive: true);
}

if (!hasContent) {
suggestions.add(getDartdocRunFailedSuggestion());
}
// TODO: calculate coverage score
Copy link

Choose a reason for hiding this comment

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

File an issue?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

dart-lang/pana#269 covers it.

await scoreCardBackend.updateReport(
job.packageName,
job.packageVersion,
new DartdocReport(
reportStatus: reportStatus,
coverageScore: hasContent ? 1.0 : 0.0,
suggestions: suggestions.isEmpty ? null : suggestions,
));
await scoreCardBackend.updateScoreCard(job.packageName, job.packageVersion);

await dartdocBackend.removeObsolete(job.packageName, job.packageVersion);

// Trigger analyzer job to pick up the new dartdoc results.