More integrity checks: pubspec and info entries. (#2116)

* More integrity checks: pubspec and info entries.

* documentation

Author: isoos

app/bin/tools/check_integrity.dart

@@ -122,10 +122,12 @@ Future _checkPackage(Package p) async {
       _problems.add('Package(${p.name}) has invalid uploader: User($userId)');
     }
   }
-  final versions = <Key>{};
+  final versionKeys = <Key>{};
+  final qualifiedVersionKeys = <QualifiedVersionKey>{};
   await for (PackageVersion pv
       in dbService.query<PackageVersion>(ancestorKey: p.key).run()) {
-    versions.add(pv.key);
+    versionKeys.add(pv.key);
+    qualifiedVersionKeys.add(pv.qualifiedVersionKey);
     if (pv.uploader == null) {
       _problems
           .add('PackageVersion(${pv.package} ${pv.version}) has no uploader.');
@@ -139,15 +141,50 @@ Future _checkPackage(Package p) async {
           'PackageVersion(${pv.package} ${pv.version}) has invalid uploader: User(${pv.uploader})');
     }
   }
-  if (p.latestVersionKey != null && !versions.contains(p.latestVersionKey)) {
+  if (p.latestVersionKey != null && !versionKeys.contains(p.latestVersionKey)) {
     _problems.add(
         'Package(${p.name}) has missing latestVersionKey: ${p.latestVersionKey.id}');
   }
   if (p.latestDevVersionKey != null &&
-      !versions.contains(p.latestDevVersionKey)) {
+      !versionKeys.contains(p.latestDevVersionKey)) {
     _problems.add(
         'Package(${p.name}) has missing latestDevVersionKey: ${p.latestDevVersionKey.id}');
   }
+
+  // Checking if PackageVersionPubspec is referenced by a PackageVersion entity.
+  final pvpQuery = dbService.query<PackageVersionPubspec>()
+    ..filter('package =', p.name);
+  final pvpKeys = <QualifiedVersionKey>{};
+  await for (PackageVersionPubspec pvp in pvpQuery.run()) {
+    final key = pvp.qualifiedVersionKey;
+    pvpKeys.add(key);
+    if (!qualifiedVersionKeys.contains(key)) {
+      _problems.add('PackageVersionPubspec($key) has no PackageVersion.');
+    }
+  }
+  for (QualifiedVersionKey key in qualifiedVersionKeys) {
+    if (!pvpKeys.contains(key)) {
+      _problems.add('PackageVersion($key) has no PackageVersionPubspec.');
+    }
+  }
+
+  // Checking if PackageVersionInfo is referenced by a PackageVersion entity.
+  final pviQuery = dbService.query<PackageVersionInfo>()
+    ..filter('package =', p.name);
+  final pviKeys = <QualifiedVersionKey>{};
+  await for (PackageVersionInfo pvi in pviQuery.run()) {
+    final key = pvi.qualifiedVersionKey;
+    pviKeys.add(key);
+    if (!qualifiedVersionKeys.contains(key)) {
+      _problems.add('PackageVersionInfo($key) has no PackageVersion.');
+    }
+  }
+  for (QualifiedVersionKey key in qualifiedVersionKeys) {
+    if (!pviKeys.contains(key)) {
+      _problems.add('PackageVersion($key) has no PackageVersionInfo.');
+    }
+  }
+
   _packageChecked++;
   if (_packageChecked % 200 == 0) {
     print('  .. $_packageChecked done (${p.name})');

app/lib/frontend/models.dart

@@ -234,6 +234,14 @@ class PackageVersion extends db.ExpandoModel {
       issueTrackerUrl: pubspec.issueTracker,
     );
   }
+
+  QualifiedVersionKey get qualifiedVersionKey {
+    return QualifiedVersionKey(
+      namespace: '',
+      package: package,
+      version: version,
+    );
+  }
 }
 
 /// An derived entity that holds only the `pubspec.yaml` content of [PackageVersion].
@@ -269,6 +277,14 @@ class PackageVersionPubspec extends db.ExpandoModel {
     qualifiedPackage = key.qualifiedPackage;
     version = key.version;
   }
+
+  QualifiedVersionKey get qualifiedVersionKey {
+    return QualifiedVersionKey(
+      namespace: namespace,
+      package: package,
+      version: version,
+    );
+  }
 }
 
 /// An derived entity that holds derived/cleaned content of [PackageVersion].
@@ -343,6 +359,14 @@ class PackageVersionInfo extends db.ExpandoModel {
     qualifiedPackage = key.qualifiedPackage;
     version = key.version;
   }
+
+  QualifiedVersionKey get qualifiedVersionKey {
+    return QualifiedVersionKey(
+      namespace: namespace,
+      package: package,
+      version: version,
+    );
+  }
 }
 
 /// An identifier to point to a specific [namespace], [package] and [version].
@@ -361,6 +385,21 @@ class QualifiedVersionKey {
       namespace == null || namespace.isEmpty ? package : '$namespace:$package';
 
   String get qualifiedVersion => '$qualifiedPackage-$version';
+
+  @override
+  bool operator ==(Object other) =>
+      identical(this, other) ||
+      other is QualifiedVersionKey &&
+          runtimeType == other.runtimeType &&
+          namespace == other.namespace &&
+          package == other.package &&
+          version == other.version;
+
+  @override
+  int get hashCode => namespace.hashCode ^ package.hashCode ^ version.hashCode;
+
+  @override
+  String toString() => qualifiedVersion;
 }
 
 /// A secret value stored in Datastore, typically an access credential used by