Fix dartdoc status when loading sandboxed ScoreCard. (#6874)

* Fix dartdoc status when loading sandboxed ScoreCard. * Use taskbackend.packageStatus instead.
dart-lang · Aug 2, 2023 · 83385b1 · 83385b1
1 parent 7efa4e3
commit 83385b1
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 13 deletions.
diff --git a/app/lib/fake/backend/fake_pub_worker.dart b/app/lib/fake/backend/fake_pub_worker.dart
@@ -127,7 +127,7 @@ Future<void> processTasksWithFakePanaAndDartdoc() async {
               }
 
               for (final e in dartdocFiles.entries) {
-                await addFileAsStringGzipped(e.key, e.value);
+                await addFileAsStringGzipped('doc/${e.key}', e.value);
               }
               await addFileAsStringGzipped(
                   'summary.json', json.encode(summary.toJson()));

diff --git a/app/lib/scorecard/backend.dart b/app/lib/scorecard/backend.dart
@@ -151,6 +151,9 @@ class ScoreCardBackend {
       final status = PackageStatus.fromModels(package, version);
       final summary =
           await taskBackend.panaSummary(packageName, packageVersion);
+      final stateInfo = await taskBackend.packageStatus(packageName);
+      final versionInfo = stateInfo.versions[packageVersion];
+      final hasDartdocFile = versionInfo?.docs ?? false;
 
       final data = ScoreCardData(
         packageName: packageName,
@@ -162,9 +165,8 @@ class ScoreCardBackend {
         packageVersionCreated: version.created,
         dartdocReport: DartdocReport(
           timestamp: summary?.createdAt ?? version.created,
-          // TODO: Embed dartdoc success status in summary, unclear if we need it
           reportStatus:
-              summary == null ? ReportStatus.failed : ReportStatus.success,
+              hasDartdocFile ? ReportStatus.success : ReportStatus.failed,
           dartdocEntry: null, // unused
           documentationSection: null, // already embedded in summary
         ),

diff --git a/app/test/frontend/golden/pkg_show_page_discontinued.html b/app/test/frontend/golden/pkg_show_page_discontinued.html
@@ -259,11 +259,6 @@ <h3 class="title">Topics</h3>
             <p>
               <a href="/packages?q=topic%3Achemical-element" rel="nofollow">#chemical-element</a>
             </p>
-            <h3 class="title">Documentation</h3>
-            <p>
-              <a class="link" href="/documentation/pkg/latest/">API reference</a>
-              <br/>
-            </p>
             <h3 class="title">Funding</h3>
             <p>
               Consider supporting this project:
@@ -346,11 +341,6 @@ <h3 class="title">Topics</h3>
           <p>
             <a href="/packages?q=topic%3Achemical-element" rel="nofollow">#chemical-element</a>
           </p>
-          <h3 class="title">Documentation</h3>
-          <p>
-            <a class="link" href="/documentation/pkg/latest/">API reference</a>
-            <br/>
-          </p>
           <h3 class="title">Funding</h3>
           <p>
             Consider supporting this project: