[internal] go: rewrite third party package analysis to not use `go li…

…st` (#14157)

## Problem

The existing Go backend uses `go list` to analyze third party modules. Several users encountered a problem where the call to `go list` was demanding changes to `go.mod` with this error message:

```
go: updates to go.mod needed; to update it:
	go mod tidy
```

Running `go mod tidy`, however, made no changes to the `go.mod`, so there was no way to ever satisfy `go list`.

## Solution

Solve the issue by rewriting the Go backend to use the same custom package analyzer used for first-party package analysis.  This removes the reliance on `go list` for package analysis which was the `go` invocation that was generating the error message. (`go list` is still used to compute what modules are dependencies.)

`ThirdPartyPkgInfo` is renamed to `ThirdPartyPkgAnalysis` to better align with `FirstPartyPkgAnalysis`.

[ci skip-rust]

src/python/pants/backend/experimental/go/register.py

@@ -21,6 +21,7 @@
     go_mod,
     import_analysis,
     link,
+    pkg_analyzer,
     sdk,
     tests_analysis,
     third_party_pkg,
@@ -43,6 +44,7 @@ def rules():
         *go_mod.rules(),
         *first_party_pkg.rules(),
         *link.rules(),
+        *pkg_analyzer.rules(),
         *sdk.rules(),
         *tests_analysis.rules(),
         *tailor.rules(),

src/python/pants/backend/go/target_type_rules.py

@@ -30,8 +30,8 @@
 from pants.backend.go.util_rules.third_party_pkg import (
     AllThirdPartyPackages,
     AllThirdPartyPackagesRequest,
-    ThirdPartyPkgInfo,
-    ThirdPartyPkgInfoRequest,
+    ThirdPartyPkgAnalysis,
+    ThirdPartyPkgAnalysisRequest,
 )
 from pants.base.exceptions import ResolveError
 from pants.base.specs import AddressSpecs, SiblingAddresses
@@ -163,8 +163,8 @@ async def inject_go_third_party_package_dependencies(
     )
     tgt = wrapped_target.target
     pkg_info = await Get(
-        ThirdPartyPkgInfo,
-        ThirdPartyPkgInfoRequest(
+        ThirdPartyPkgAnalysis,
+        ThirdPartyPkgAnalysisRequest(
             tgt[GoImportPathField].value, go_mod_info.digest, go_mod_info.mod_path
         ),
     )
@@ -212,7 +212,7 @@ async def generate_targets_from_go_mod(
         AllThirdPartyPackagesRequest(go_mod_info.digest, go_mod_info.mod_path),
     )
 
-    def create_tgt(pkg_info: ThirdPartyPkgInfo) -> GoThirdPartyPackageTarget:
+    def create_tgt(pkg_info: ThirdPartyPkgAnalysis) -> GoThirdPartyPackageTarget:
         return GoThirdPartyPackageTarget(
             {GoImportPathField.alias: pkg_info.import_path},
             # E.g. `src/go:mod#github.com/google/uuid`.

src/python/pants/backend/go/util_rules/build_pkg_target.py

@@ -23,7 +23,10 @@
     FirstPartyPkgDigestRequest,
 )
 from pants.backend.go.util_rules.go_mod import GoModInfo, GoModInfoRequest
-from pants.backend.go.util_rules.third_party_pkg import ThirdPartyPkgInfo, ThirdPartyPkgInfoRequest
+from pants.backend.go.util_rules.third_party_pkg import (
+    ThirdPartyPkgAnalysis,
+    ThirdPartyPkgAnalysisRequest,
+)
 from pants.build_graph.address import Address
 from pants.engine.engine_aware import EngineAwareParameter
 from pants.engine.internals.selectors import Get, MultiGet
@@ -103,8 +106,8 @@ async def setup_build_go_package_target_request(
         _go_mod_address = target.address.maybe_convert_to_target_generator()
         _go_mod_info = await Get(GoModInfo, GoModInfoRequest(_go_mod_address))
         _third_party_pkg_info = await Get(
-            ThirdPartyPkgInfo,
-            ThirdPartyPkgInfoRequest(import_path, _go_mod_info.digest, _go_mod_info.mod_path),
+            ThirdPartyPkgAnalysis,
+            ThirdPartyPkgAnalysisRequest(import_path, _go_mod_info.digest, _go_mod_info.mod_path),
         )
 
         # We error if trying to _build_ a package with issues (vs. only generating the target and

src/python/pants/backend/go/util_rules/build_pkg_target_test.py

@@ -160,7 +160,7 @@ def test_build_third_party_pkg_target(rule_runner: RuleRunner) -> None:
         rule_runner,
         Address("", target_name="mod", generated_name=import_path),
         expected_import_path=import_path,
-        expected_dir_path="github.com/google/uuid@v1.3.0",
+        expected_dir_path="gopath/pkg/mod/github.com/google/uuid@v1.3.0",
         expected_go_file_names=[
             "dce.go",
             "doc.go",
@@ -247,7 +247,7 @@ def test_build_target_with_dependencies(rule_runner: RuleRunner) -> None:
         rule_runner,
         Address("", target_name="mod", generated_name=xerrors_internal_import_path),
         expected_import_path=xerrors_internal_import_path,
-        expected_dir_path="golang.org/x/xerrors@v0.0.0-20191204190536-9bdfabe68543/internal",
+        expected_dir_path="gopath/pkg/mod/golang.org/x/xerrors@v0.0.0-20191204190536-9bdfabe68543/internal",
         expected_go_file_names=["internal.go"],
         expected_direct_dependency_import_paths=[],
         expected_transitive_dependency_import_paths=[],
@@ -258,7 +258,7 @@ def test_build_target_with_dependencies(rule_runner: RuleRunner) -> None:
         rule_runner,
         Address("", target_name="mod", generated_name=xerrors_import_path),
         expected_import_path=xerrors_import_path,
-        expected_dir_path="golang.org/x/xerrors@v0.0.0-20191204190536-9bdfabe68543",
+        expected_dir_path="gopath/pkg/mod/golang.org/x/xerrors@v0.0.0-20191204190536-9bdfabe68543",
         expected_go_file_names=[
             "adaptor.go",
             "doc.go",

src/python/pants/backend/go/util_rules/first_party_pkg.py

@@ -10,13 +10,15 @@
 from pants.backend.go.go_sources import load_go_binary
 from pants.backend.go.go_sources.load_go_binary import LoadedGoBinary, LoadedGoBinaryRequest
 from pants.backend.go.target_types import GoPackageSourcesField
+from pants.backend.go.util_rules import pkg_analyzer
 from pants.backend.go.util_rules.embedcfg import EmbedConfig
 from pants.backend.go.util_rules.go_mod import (
     GoModInfo,
     GoModInfoRequest,
     OwningGoMod,
     OwningGoModRequest,
 )
+from pants.backend.go.util_rules.pkg_analyzer import PackageAnalyzerSetup
 from pants.build_graph.address import Address
 from pants.core.target_types import ResourceSourceField
 from pants.core.util_rules import source_files
@@ -157,12 +159,9 @@ async def compute_first_party_package_import_path(
 @rule
 async def analyze_first_party_package(
     request: FirstPartyPkgAnalysisRequest,
+    analyzer: PackageAnalyzerSetup,
 ) -> FallibleFirstPartyPkgAnalysis:
-    analyzer, wrapped_target, import_path_info, owning_go_mod = await MultiGet(
-        Get(
-            LoadedGoBinary,
-            LoadedGoBinaryRequest("analyze_package", ("main.go", "read.go"), "./package_analyzer"),
-        ),
+    wrapped_target, import_path_info, owning_go_mod = await MultiGet(
         Get(WrappedTarget, Address, request.address),
         Get(FirstPartyPkgImportPath, FirstPartyPkgImportPathRequest(request.address)),
         Get(OwningGoMod, OwningGoModRequest(request.address)),
@@ -178,7 +177,7 @@ async def analyze_first_party_package(
     result = await Get(
         FallibleProcessResult,
         Process(
-            ("./package_analyzer", request.address.spec_path or "."),
+            (analyzer.path, request.address.spec_path or "."),
             input_digest=input_digest,
             description=f"Determine metadata for {request.address}",
             level=LogLevel.DEBUG,
@@ -325,4 +324,4 @@ async def setup_first_party_pkg_digest(
 
 
 def rules():
-    return (*collect_rules(), *source_files.rules(), *load_go_binary.rules())
+    return (*collect_rules(), *source_files.rules(), *load_go_binary.rules(), *pkg_analyzer.rules())

src/python/pants/backend/go/util_rules/pkg_analyzer.py

@@ -0,0 +1,36 @@
+# Copyright 2022 Pants project contributors (see CONTRIBUTORS.md).
+# Licensed under the Apache License, Version 2.0 (see LICENSE).
+
+from dataclasses import dataclass
+
+from pants.backend.go.go_sources import load_go_binary
+from pants.backend.go.go_sources.load_go_binary import LoadedGoBinary, LoadedGoBinaryRequest
+from pants.engine.fs import Digest
+from pants.engine.internals.selectors import Get
+from pants.engine.rules import collect_rules, rule
+
+
+@dataclass(frozen=True)
+class PackageAnalyzerSetup:
+    digest: Digest
+    path: str
+
+
+@rule
+async def setup_go_package_analyzer() -> PackageAnalyzerSetup:
+    binary_path = "./package_analyzer"
+    binary = await Get(
+        LoadedGoBinary,
+        LoadedGoBinaryRequest("analyze_package", ("main.go", "read.go"), binary_path),
+    )
+    return PackageAnalyzerSetup(
+        digest=binary.digest,
+        path=binary_path,
+    )
+
+
+def rules():
+    return (
+        *collect_rules(),
+        *load_go_binary.rules(),
+    )