Put all package-not-found errors into one diagnostic

Author: owen-mc

go/extractor/diagnostics/diagnostics.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"log"
 	"os"
+	"strings"
 	"time"
 )
 
@@ -124,10 +125,32 @@ func EmitPackageDifferentOSArchitecture(pkgPath string) {
 	)
 }
 
-func EmitCannotFindPackage(pkgPath string) {
-	emitDiagnostic("go/autobuilder/package-not-found",
-		"Package "+pkgPath+" could not be found",
-		"Check that the path is correct. If it is a private package, make sure it can be accessed. If it is contained in the repository then you may need a [custom build command](https://docs.github.com/en/github-ae@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language).",
+const maxNumPkgPaths = 5
+
+func EmitCannotFindPackages(pkgPaths []string) {
+	numPkgPaths := len(pkgPaths)
+
+	ending := "s"
+	if numPkgPaths == 1 {
+		ending = ""
+	}
+
+	numPrinted := numPkgPaths
+	truncated := false
+	if numPrinted > maxNumPkgPaths {
+		numPrinted = maxNumPkgPaths
+		truncated = true
+	}
+
+	secondLine := "`" + strings.Join(pkgPaths[0:numPrinted], "`, `") + "`"
+	if truncated {
+		secondLine += fmt.Sprintf(" and %d more", numPkgPaths-maxNumPkgPaths)
+	}
+
+	emitDiagnostic(
+		"go/autobuilder/package-not-found",
+		fmt.Sprintf("%d package%s could not be found", numPkgPaths, ending),
+		"The following packages could not be found. Check that the paths are correct and make sure any private packages can be accessed. If any of the packages are present in the repository then you may need a [custom build command](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages).\n\n"+secondLine,
 		severityError, false,
 		true, true, true,
 		"", 0, 0, 0, 0,

go/extractor/extractor.go

@@ -128,6 +128,8 @@ func ExtractWithFlags(buildFlags []string, patterns []string) error {
 		log.Printf("Done running go list deps: resolved %d packages.", len(pkgInfos))
 	}
 
+	pkgsNotFound := make([]string, 0, len(pkgs))
+
 	// Do a post-order traversal and extract the package scope of each package
 	packages.Visit(pkgs, func(pkg *packages.Package) bool {
 		return true
@@ -162,14 +164,19 @@ func ExtractWithFlags(buildFlags []string, patterns []string) error {
 					diagnostics.EmitPackageDifferentOSArchitecture(pkg.PkgPath)
 				} else if strings.Contains(errString, "cannot find package") ||
 					strings.Contains(errString, "no required module provides package") {
-					diagnostics.EmitCannotFindPackage(pkg.PkgPath)
+					pkgsNotFound = append(pkgsNotFound, pkg.PkgPath)
 				}
 				extraction.extractError(tw, err, lbl, i)
 			}
 		}
+
 		log.Printf("Done extracting types for package %s.", pkg.PkgPath)
 	})
 
+	if len(pkgsNotFound) > 0 {
+		diagnostics.EmitCannotFindPackages(pkgsNotFound)
+	}
+
 	for _, pkg := range pkgs {
 		pkgInfo, ok := pkgInfos[pkg.PkgPath]
 		if !ok || pkgInfo.PkgDir == "" {

go/ql/integration-tests/all-platforms/go/diagnostics/package-not-found-with-go-mod/diagnostics.expected

@@ -1,11 +1,11 @@
 {
   "internal": false,
-  "markdownMessage": "Check that the path is correct. If it is a private package, make sure it can be accessed. If it is contained in the repository then you may need a [custom build command](https://docs.github.com/en/github-ae@latest/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language).",
+  "markdownMessage": "The following packages could not be found. Check that the paths are correct and make sure any private packages can be accessed. If any of the packages are present in the repository then you may need a [custom build command](https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages).\n\n`github.com/nosuchorg/nosuchrepo000`, `github.com/nosuchorg/nosuchrepo001`, `github.com/nosuchorg/nosuchrepo002`, `github.com/nosuchorg/nosuchrepo003`, `github.com/nosuchorg/nosuchrepo004` and 105 more",
   "severity": "error",
   "source": {
     "extractorName": "go",
     "id": "go/autobuilder/package-not-found",
-    "name": "Package github.com/linode/linode-docs-theme could not be found"
+    "name": "110 packages could not be found"
   },
   "visibility": {
     "cliSummaryTable": true,