Fix generic comparisons on protobuf messages

Generated protobuf messages contain internal data structures
that general purpose comparison functions (e.g., reflect.DeepEqual,
pretty.Compare, etc) do not properly compare. It is already the case
today that these functions may report a difference when two messages
are actually semantically equivalent.

Fix all usages by either calling proto.Equal directly if
the top-level types are themselves proto.Message, or by calling
cmp.Equal with the cmp.Comparer(proto.Equal) option specified.
This option teaches cmp to use proto.Equal anytime it encounters
proto.Message types.

PiperOrigin-RevId: 282412693

Author: TypeScript Team

internal/ts_repositories.bzl

@@ -46,6 +46,12 @@ def ts_setup_dev_workspace():
 
     ts_setup_workspace()
 
+    go_repository(
+        name = "com_github_google_go_cmp",
+        commit = "2d0692c2e9617365a95b295612ac0d4415ba4627",
+        importpath = "github.com/google/go-cmp",
+    )
+
     go_repository(
         name = "com_github_kylelemons_godebug",
         commit = "d65d576e9348f5982d7f6d83682b694e731a45c6",

ts_auto_deps/analyze/BUILD.bazel

@@ -1,4 +1,4 @@
-// Package analyze uses bazel query to determine and locate missing imports
+// Package analyze uses blaze query to determine and locate missing imports
 // in TypeScript source files.
 package analyze
 
@@ -10,13 +10,13 @@ import (
 	"regexp"
 	"strings"
 
-	"github.com/bazelbuild/buildtools/edit"
+	"google3/net/proto2/go/proto"
+	"google3/third_party/bazel_buildifier/edit/edit"
 	"github.com/bazelbuild/rules_typescript/ts_auto_deps/platform"
 	"github.com/bazelbuild/rules_typescript/ts_auto_deps/workspace"
-	"github.com/golang/protobuf/proto"
 
-	appb "github.com/bazelbuild/buildtools/build_proto"
-	arpb "github.com/bazelbuild/rules_typescript/ts_auto_deps/proto"
+	appb "google3/third_party/bazel/src/main/protobuf/build_go_proto"
+	arpb "google3/third_party/bazel_rules/rules_typescript/ts_auto_deps/proto/analyze_result_go_proto"
 )
 
 var (
@@ -97,7 +97,7 @@ func New(loader TargetLoader) *Analyzer {
 
 // Analyze generates a dependency report for each target label in labels.
 //
-// dir is the directory that ts_auto_deps should execute in. Must be a sub-directory
+// dir is the directory that taze should execute in. Must be a sub-directory
 // of the workspace root.
 func (a *Analyzer) Analyze(ctx context.Context, dir string, labels []string) ([]*arpb.DependencyReport, error) {
 	if len(labels) == 0 {
@@ -124,14 +124,14 @@ func (a *Analyzer) Analyze(ctx context.Context, dir string, labels []string) ([]
 	return a.generateReports(labels, resolved)
 }
 
-// resolvedTarget represents a Bazel target and all resolved information.
+// resolvedTarget represents a Blaze target and all resolved information.
 type resolvedTarget struct {
 	label string
 	// A map of all existing dependencies on a target at the time of analysis.
 	// The keys are labels and the values are thes loaded target.
 	dependencies map[string]*appb.Rule
 	// A map of source file paths to their imports.
-	imports map[string][]*ts_auto_depsImport
+	imports map[string][]*tazeImport
 	// rule is the original rule the target was constructed from.
 	rule *appb.Rule
 	// missingSources are source files which could not be opened on disk.
@@ -147,7 +147,7 @@ type resolvedTarget struct {
 // setSources sets the sources on t.  It returns an error if one of the srcs of
 // t's rule isn't in loadedSrcs.  It also sorts the sources into literal and
 // generated sources, setting literalSourcePaths and generatedSourcePaths.
-// Returns an error if all the sources are generated - ts_auto_deps can't read the
+// Returns an error if all the sources are generated - taze can't read the
 // import statements to determine deps.
 func (t *resolvedTarget) setSources(loadedSrcs map[string]*appb.Target) error {
 	for _, label := range listAttribute(t.rule, "srcs") {
@@ -220,7 +220,7 @@ func newResolvedTarget(r *appb.Rule) *resolvedTarget {
 	return &resolvedTarget{
 		label:        r.GetName(),
 		dependencies: make(map[string]*appb.Rule),
-		imports:      make(map[string][]*ts_auto_depsImport),
+		imports:      make(map[string][]*tazeImport),
 		rule:         r,
 		sources:      make(map[string]*appb.Target),
 	}
@@ -264,7 +264,7 @@ func (a *Analyzer) resolveImportsForTargets(ctx context.Context, currentPkg, roo
 			return nil, err
 		}
 	}
-	// only extract the imports out of the literal sources, since ts_auto_deps can't
+	// only extract the imports out of the literal sources, since taze can't
 	// see the contents of generated files
 	allLiteralSrcPaths, err := getAllLiteralSrcPaths(targets)
 	if err != nil {
@@ -302,7 +302,7 @@ func (a *Analyzer) resolveImportsForTargets(ctx context.Context, currentPkg, roo
 func (a *Analyzer) resolveImports(ctx context.Context, currentPkg, root string, targets map[string]*resolvedTarget) error {
 	for _, target := range targets {
 		var paths []string
-		needingResolution := make(map[string][]*ts_auto_depsImport)
+		needingResolution := make(map[string][]*tazeImport)
 		for _, imports := range target.imports {
 		handlingImports:
 			for _, imp := range imports {
@@ -363,7 +363,7 @@ var ambientModuleDeclRE = regexp.MustCompile("(?m)^\\s*declare\\s+module\\s+['\"
 //
 // If the import already has a knownTarget, findRuleProvidingImport will
 // return the knownTarget.
-func (a *Analyzer) findExistingDepProvidingImport(ctx context.Context, root string, rt *resolvedTarget, i *ts_auto_depsImport) (string, error) {
+func (a *Analyzer) findExistingDepProvidingImport(ctx context.Context, root string, rt *resolvedTarget, i *tazeImport) (string, error) {
 	if i.knownTarget != "" {
 		return i.knownTarget, nil
 	}
@@ -545,17 +545,17 @@ func (a *Analyzer) generateReport(target *resolvedTarget) (*arpb.DependencyRepor
 			// TypeScript declarations might declare arbitrary global symbols, so it
 			// is impossible to detect reliably if the import is being used (without
 			// compiling, at least).  Report that the rule has no explicit import as a
-			// warning, so that ts_auto_deps can decide to import remove or not based on a
+			// warning, so that taze can decide to import remove or not based on a
 			// flag.
 			warning := fmt.Sprintf("WARNING: %s: keeping possibly used %s '%s'", rule.GetLocation(), class, label)
 			report.Feedback = append(report.Feedback, warning)
 		case "css_library":
-			// Similar to ts_declaration, ts_auto_deps can't reliably detect if css_library
-			// imports are being used, since ts_auto_deps can't currently parse @requirecss
+			// Similar to ts_declaration, taze can't reliably detect if css_library
+			// imports are being used, since taze can't currently parse @requirecss
 			// annotations.  Unlike ts_declaration, there's no flag to remove them, so
 			// there's no need to report a warning.
 		default:
-			// The contents of generated files aren't visible, so ts_auto_deps can't discover
+			// The contents of generated files aren't visible, so taze can't discover
 			// the import statements/deps that they contain.  To be safe, don't remove
 			// any unused deps, since they might be used by the generated file(s).
 			if len(target.generatedSourcePaths) == 0 {

ts_auto_deps/analyze/analyze.go

@@ -10,12 +10,14 @@ import (
 	"strings"
 	"testing"
 
+	"google3/net/proto2/go/proto"
 	"github.com/bazelbuild/rules_typescript/ts_auto_deps/platform"
-	"github.com/golang/protobuf/proto"
-	"github.com/kylelemons/godebug/pretty"
+	"google3/third_party/golang/cmp/cmp"
+	"google3/third_party/golang/cmp/cmpopts/cmpopts"
+	"google3/third_party/golang/godebug/pretty/pretty"
 
-	appb "github.com/bazelbuild/buildtools/build_proto"
-	arpb "github.com/bazelbuild/rules_typescript/ts_auto_deps/proto"
+	appb "google3/third_party/bazel/src/main/protobuf/build_go_proto"
+	arpb "google3/third_party/bazel_rules/rules_typescript/ts_auto_deps/proto/analyze_result_go_proto"
 )
 
 var (
@@ -204,7 +206,7 @@ func TestUnnecessaryDependencies(t *testing.T) {
 func TestNecessaryDependencies(t *testing.T) {
 	tests := [][]string{
 		[]string{"import x from 'b/target';"},
-		[]string{"// ts_auto_deps: x from //b:b_lib"},
+		[]string{"// taze: x from //b:b_lib"},
 		[]string{"export x from 'b/target';"},
 	}
 	for _, test := range tests {
@@ -616,7 +618,7 @@ func TestSetSources(t *testing.T) {
 				t.Errorf("got err %q, expected %q", err, test.err)
 			}
 
-			if diff := pretty.Compare(rt.sources, test.expected); err == nil && diff != "" {
+			if diff := cmp.Diff(rt.sources, test.expected, cmpopts.EquateEmpty(), cmp.Comparer(proto.Equal)); err == nil && diff != "" {
 				t.Errorf("failed to set correct sources: (-got, +want)\n%s", diff)
 			}
 		})
@@ -646,7 +648,7 @@ func createFile(path string, content ...string) error {
 	return ioutil.WriteFile(path, []byte(strings.Join(content, "\n")), 0666)
 }
 
-// This method creates a WORKSPACE file in the root of the Bazel test
+// This method creates a WORKSPACE file in the root of the Blaze test
 // directory. This allows the tests to resolve the root path of the
 // workspace by looking for the WORKSPACE file on disk.
 func createWorkspaceFile() error {

ts_auto_deps/analyze/analyze_test.go

@@ -11,13 +11,13 @@ import (
 	"github.com/bazelbuild/rules_typescript/ts_auto_deps/workspace"
 )
 
-// ts_auto_depsImport represents a single import in a TypeScript source.
-type ts_auto_depsImport struct {
+// tazeImport represents a single import in a TypeScript source.
+type tazeImport struct {
 	// importPath can be an ES6 path ('./foo/bar'), but also a namespace ('goog:...').
 	// This is the import path as it appears in the TypeScript source.
 	importPath string
-	// knownTarget is the (fully qualified) bazel target providing importPath.
-	// It's either found by locateMissingTargets or taken from a ts_auto_deps comment.
+	// knownTarget is the (fully qualified) blaze target providing importPath.
+	// It's either found by locateMissingTargets or taken from a taze comment.
 	knownTarget string
 	location    sourceLocation
 }
@@ -30,7 +30,7 @@ type ts_auto_depsImport struct {
 // these imports depends on the dependencies of the target the source
 // location is a member of. For example, an import of 'foo/bar' would have
 // no resolvedPath.
-func (i *ts_auto_depsImport) resolvedPath() string {
+func (i *tazeImport) resolvedPath() string {
 	if strings.HasPrefix(i.importPath, "./") || strings.HasPrefix(i.importPath, "../") {
 		// If the import is relative to the source location, use the source
 		// location to form a "canonical" path from the root.
@@ -55,9 +55,9 @@ type sourceLocation struct {
 //
 // paths should be relative to root. The root will be joined to each path
 // to construct a physical path to each file.
-func extractAllImports(root string, paths []string) (map[string][]*ts_auto_depsImport, []error) {
+func extractAllImports(root string, paths []string) (map[string][]*tazeImport, []error) {
 	debugf("extracting imports from TypeScript files relative to %q: %q", root, paths)
-	allImports := make(map[string][]*ts_auto_depsImport)
+	allImports := make(map[string][]*tazeImport)
 	var (
 		errors []error
 		mutex  sync.Mutex
@@ -84,7 +84,7 @@ func extractAllImports(root string, paths []string) (map[string][]*ts_auto_depsI
 
 // extractImports extracts the TypeScript imports from a single file. path
 // should be a path from the root to the file.
-func extractImports(root, path string) ([]*ts_auto_depsImport, error) {
+func extractImports(root, path string) ([]*tazeImport, error) {
 	d, err := ioutil.ReadFile(filepath.Join(root, path))
 	if err != nil {
 		return nil, err
@@ -93,7 +93,7 @@ func extractImports(root, path string) ([]*ts_auto_depsImport, error) {
 }
 
 const (
-	ts_auto_depsFrom  = `^[ \t]*//[ \t]+ts_auto_deps:[^\n]*?from[ \t]+(?P<Target>//\S+)$`
+	tazeFrom          = `^[ \t]*//[ \t]+taze:[^\n]*?from[ \t]+(?P<Target>//\S+)$`
 	importPreface     = `^[ \t]*(?:import|export)\b\s*`
 	wildcardTerm      = `\*(?:\s*as\s+\S+)?` // "as..." is optional to match exports.
 	identifiersClause = `(?:\{[^}]*\}|\S+|` + wildcardTerm + `)`
@@ -103,26 +103,26 @@ const (
 )
 
 var importRE = regexp.MustCompile("(?ms)" +
-	"(?:" + ts_auto_depsFrom + ")|" +
+	"(?:" + tazeFrom + ")|" +
 	"(?:" + importPreface + symbolsTerm + url + namespaceComment + ")")
 
-// parseImports scans contents for imports (ES6 modules, ts_auto_deps comments), and
-// returns a list of ts_auto_depsImports. knownTarget is already filled in for imports
-// that have ts_auto_deps comments.
-func parseImports(sourcePath string, contents []byte) []*ts_auto_depsImport {
-	var imports []*ts_auto_depsImport
+// parseImports scans contents for imports (ES6 modules, taze comments), and
+// returns a list of tazeImports. knownTarget is already filled in for imports
+// that have taze comments.
+func parseImports(sourcePath string, contents []byte) []*tazeImport {
+	var imports []*tazeImport
 	lastOffset := 0
 	line := 1
 	column := 1
 	for _, matchIndices := range importRE.FindAllSubmatchIndex(contents, -1) {
-		imp := &ts_auto_depsImport{}
+		imp := &tazeImport{}
 		imports = append(imports, imp)
 		// matchIndices[0, 1]: full RE match
 		imp.location.sourcePath = sourcePath
 		for lastOffset < matchIndices[1] {
 			// Iterate to the *end* of the import statement.
-			// The ts_auto_deps comment must be placed at the end of the "import" statement.
-			// This offset has to be exactly the end of the import for ts_auto_deps later on
+			// The taze comment must be placed at the end of the "import" statement.
+			// This offset has to be exactly the end of the import for taze later on
 			// to insert the '// from' comment in the correct line.
 			column++
 			if contents[lastOffset] == '\n' {
@@ -135,7 +135,7 @@ func parseImports(sourcePath string, contents []byte) []*ts_auto_depsImport {
 		imp.location.length = matchIndices[1] - matchIndices[0]
 		imp.location.line = line
 		if matchIndices[2] >= 0 {
-			// matchIndices[2, 3]: Target for a // ts_auto_deps: ... from ... comment.
+			// matchIndices[2, 3]: Target for a // taze: ... from ... comment.
 			imp.knownTarget = string(contents[matchIndices[2]:matchIndices[3]])
 		} else {
 			// matchIndices[4, 5]: URL in import x from 'url';

ts_auto_deps/analyze/imports.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"testing"
 
-	"github.com/kylelemons/godebug/pretty"
+	"google3/third_party/golang/godebug/pretty/pretty"
 )
 
 func TestParseImports(t *testing.T) {
@@ -41,8 +41,8 @@ func TestParseImports(t *testing.T) {
 		{"export*from'no whitespace';", "no whitespace", ""},
 		{"export{}from'no whitespace';", "no whitespace", ""},
 		// Comments
-		{"x;\n// ts_auto_deps: ng from //some/global:rule\ny;", "", "//some/global:rule"},
-		{"// ts_auto_deps: ng from //foo/bar from //some/global:rule", "", "//some/global:rule"},
+		{"x;\n// taze: ng from //some/global:rule\ny;", "", "//some/global:rule"},
+		{"// taze: ng from //foo/bar from //some/global:rule", "", "//some/global:rule"},
 	}
 
 	for i, tst := range tests {