Control over the dartdoc version. (#998)

* Move versions to shared

* Control over the dartdoc version.

* Comments to keep versions in-sync.

Author: isoos

.travis.yml

@@ -4,7 +4,8 @@
 language: dart
 
 dart:
-  - dev
+  # Keep version in-sync with Dockerfile
+  - 2.0.0-dev.26.0
 
 env:
   - PKG=app TASK=dartanalyzer

Dockerfile

@@ -1,4 +1,5 @@
-FROM google/dart-runtime-base:2.0.0-dev.20.0
+# Keep version in-sync with .travis.yml
+FROM google/dart-runtime-base:2.0.0-dev.26.0
 
 # `apt-mark hold dart` ensures that Dart is not upgraded with the other packages
 #   We want to make sure SDK upgrades are explicit.

app/.travis.yml

@@ -1,7 +1,8 @@
 language: dart
 
 dart:
-  - dev
+  # Keep version in-sync with Dockerfile
+  - 2.0.0-dev.26.0
 
 dart_task:
   - test

app/lib/analyzer/backend.dart

@@ -12,9 +12,9 @@ import '../frontend/models.dart';
 import '../shared/analyzer_memcache.dart';
 import '../shared/analyzer_service.dart';
 import '../shared/utils.dart';
+import '../shared/versions.dart';
 
 import 'models.dart';
-import 'versions.dart';
 
 /// Sets the backend service.
 void registerAnalysisBackend(AnalysisBackend backend) =>

app/lib/analyzer/models.dart

@@ -11,9 +11,9 @@ import 'package:pub_semver/pub_semver.dart';
 
 import '../shared/analyzer_service.dart' show AnalysisStatus;
 import '../shared/utils.dart';
+import '../shared/versions.dart' as versions;
 
 import 'model_properties.dart';
-import 'versions.dart' as versions;
 
 /// Analyzed package report.
 @db.Kind(name: 'PackageAnalysis', idType: db.IdType.String)

app/lib/analyzer/task_sources.dart

@@ -9,9 +9,9 @@ import 'package:gcloud/db.dart';
 import '../shared/analyzer_service.dart' show AnalysisStatus;
 import '../shared/task_scheduler.dart';
 import '../shared/task_sources.dart';
+import '../shared/versions.dart';
 
 import 'models.dart';
-import 'versions.dart';
 
 /// Creates a task when a version uploaded in the past 10 minutes has no
 /// analysis yet.

app/lib/dartdoc/dartdoc_runner.dart

@@ -14,6 +14,7 @@ import 'package:uuid/uuid.dart';
 import '../shared/configuration.dart' show envConfig;
 import '../shared/task_scheduler.dart' show Task, TaskRunner;
 import '../shared/utils.dart' show redirectDartdocPages;
+import '../shared/versions.dart';
 
 import 'backend.dart';
 import 'models.dart';
@@ -26,14 +27,11 @@ const statusFilePath = 'status.json';
 const buildLogFilePath = 'log.txt';
 
 class DartdocRunner implements TaskRunner {
-  String _cachedDartdocVersion;
-
   @override
   Future<bool> shouldSkipTask(Task task) async {
     if (redirectDartdocPages.containsKey(task.package)) {
       return true;
     }
-    final dartdocVersion = await _getDartdocVersion();
     final shouldRun = await dartdocBackend.shouldRunTask(task, dartdocVersion);
     return !shouldRun;
   }
@@ -121,7 +119,7 @@ class DartdocRunner implements TaskRunner {
         uuid: _uuid.v4(),
         packageName: task.package,
         packageVersion: task.version,
-        dartdocVersion: await _getDartdocVersion(),
+        dartdocVersion: dartdocVersion,
         timestamp: new DateTime.now().toUtc(),
         hasContent: hasContent);
 
@@ -135,30 +133,4 @@ class DartdocRunner implements TaskRunner {
 
     return entry;
   }
-
-  Future<String> _getDartdocVersion() async {
-    if (_cachedDartdocVersion != null) return _cachedDartdocVersion;
-    final pr = await Process.run('dartdoc', ['--version']);
-    if (pr.exitCode != 0) {
-      _logger.severe('Unable to detect dartdoc version\n'
-          'exitCode: ${pr.exitCode}\n'
-          'stdout: ${pr.stdout}\n'
-          'stderr: ${pr.stderr}\n');
-      throw new Exception('dartdoc execution failed with code ${pr.exitCode}');
-    }
-
-    final match = _versionRegExp.firstMatch(pr.stdout.toString().trim());
-    if (match == null) {
-      _logger.severe('Unable to parse dartdoc version: ${pr.stdout}');
-      throw new Exception('Unable to parse dartdoc version: ${pr.stdout}');
-    }
-
-    final version = match.group(1).trim();
-    if (version.isNotEmpty) {
-      _cachedDartdocVersion = version;
-    }
-    return _cachedDartdocVersion;
-  }
 }
-
-final RegExp _versionRegExp = new RegExp(r'dartdoc version: (.*)$');

app/lib/shared/analyzer_client.dart

@@ -10,8 +10,6 @@ import 'package:http/http.dart' as http;
 import 'package:logging/logging.dart';
 import 'package:pana/pana.dart';
 
-import 'package:pub_dartlang_org/analyzer/versions.dart';
-
 import 'analyzer_memcache.dart';
 import 'analyzer_service.dart';
 import 'configuration.dart';
@@ -20,6 +18,7 @@ import 'notification.dart' show notifyService;
 import 'platform.dart';
 import 'popularity_storage.dart';
 import 'utils.dart';
+import 'versions.dart';
 
 export 'package:pana/pana.dart' show LicenseFile, PkgDependency, Suggestion;
 export 'analyzer_service.dart';

app/lib/analyzer/versions.dart renamed to app/lib/shared/versions.dart

@@ -11,3 +11,7 @@ final Version semanticPanaVersion = new Version.parse(panaVersion);
 // keep in-sync with app/script/setup-flutter.sh
 final String flutterVersion = '0.0.22';
 final Version semanticFlutterVersion = new Version.parse(flutterVersion);
+
+// keep in-sync with SDK version in .travis.yml and Dockerfile
+final String dartdocVersion = '0.16.0';
+final Version semanticDartdocVersion = new Version.parse(dartdocVersion);

app/pubspec.yaml

@@ -30,7 +30,7 @@ dependencies:
   stream_transform: ^0.0.7
   yaml: '^2.1.12'
   # pana version to be pinned
-  # keep in-sync with app/lib/analyzer/versions.dart
+  # keep in-sync with app/lib/shared/versions.dart
   pana: '0.10.2'
   # 3rd-party packages with pinned versions
   archive: '1.0.33'

app/script/setup-flutter.sh

@@ -24,7 +24,7 @@ fi
 
 git clone -b v0.0.22 --single-branch https://github.com/flutter/flutter.git $FLUTTER_SDK
 
-# Keep in-sync with app/lib/analyzer/versions.dart
+# Keep in-sync with app/lib/shared/versions.dart
 cd $FLUTTER_SDK
 
 # Downloads the Dart SDK and disables analytics tracking – which we always want.

app/test/analyzer/analyzer_version_test.dart renamed to app/test/shared/versions_test.dart

@@ -7,7 +7,7 @@ import 'dart:io';
 import 'package:test/test.dart';
 import 'package:yaml/yaml.dart';
 
-import 'package:pub_dartlang_org/analyzer/versions.dart';
+import 'package:pub_dartlang_org/shared/versions.dart';
 
 void main() {
   test('analyzer version should match resolved pana version', () async {
@@ -25,4 +25,15 @@ void main() {
         contains("git clone -b v$flutterVersion --single-branch "
             "https://github.com/flutter/flutter.git \$FLUTTER_SDK"));
   });
+
+  test('dartdoc version should match SDK dartdoc', () async {
+    final pr = await Process.run('dartdoc', ['--version']);
+    final RegExp versionRegExp = new RegExp(r'dartdoc version: (.*)$');
+    final match = versionRegExp.firstMatch(pr.stdout.toString().trim());
+    if (match == null) {
+      throw new Exception('Unable to parse dartdoc version: ${pr.stdout}');
+    }
+    final version = match.group(1).trim();
+    expect(version, dartdocVersion);
+  });
 }