feat: Base messages in google_cloud_protobuf (#2660)

1. supports the move of `ProtoMessage` and `ProtoEnum` to
`package:google_cloud_protobuf`
2. supports the move of `encodings.dart` to
`package:google_cloud_protobuf`

Fixes googleapis/google-cloud-dart#51

Author: brianquinlan

internal/sidekick/internal/dart/annotate.go

@@ -60,7 +60,8 @@ type modelAnnotations struct {
 	ApiKeyEnvironmentVariables []string
 	// Dart `export` statements e.g.
 	// ["export 'package:google_cloud_gax/gax.dart' show Any", "export 'package:google_cloud_gax/gax.dart' show Status"]
-	Exports []string
+	Exports     []string
+	ProtoPrefix string
 }
 
 // HasServices returns true if the model has services.
@@ -97,6 +98,7 @@ type messageAnnotation struct {
 	// A custom body for the message's constructor.
 	ConstructorBody string
 	ToStringLines   []string
+	Model           *api.API
 }
 
 // HasFields returns true if the message has fields.
@@ -167,6 +169,7 @@ type fieldAnnotation struct {
 type enumAnnotation struct {
 	Name     string
 	DocLines []string
+	Model    *api.API
 }
 
 type enumValueAnnotation struct {
@@ -234,6 +237,8 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {
 		issueTrackerURL            string
 		apiKeyEnvironmentVariables = []string{}
 		exports                    = []string{}
+		protobufPrefix             string
+		pkgName                    string
 	)
 
 	for key, definition := range options {
@@ -343,11 +348,18 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {
 	devDependencies = append(devDependencies, "lints")
 
 	// Add the import for the google_cloud_gax package.
-	annotate.imports[commonImport] = true
+	if len(model.Services) > 0 {
+		annotate.imports[gaxImport] = true
+	}
 
-	packageDependencies, err := calculateDependencies(annotate.imports, annotate.dependencyConstraints)
-	if err != nil {
-		return err
+	// `google.protobuf` defines `JsonEncodable`, which is needed by any package that defines a
+	// `message` or `enum`, i.e., all of them.
+	protobufPrefix = annotate.packagePrefixes["google.protobuf"]
+	if protobufPrefix == "" {
+		annotate.imports[protobufImport] = true
+	} else {
+		annotate.imports[protobufImport+" as "+protobufPrefix] = true
+		protobufPrefix += "."
 	}
 
 	if len(model.Services) > 0 && len(apiKeyEnvironmentVariables) == 0 {
@@ -358,9 +370,15 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {
 		return errors.New("all packages must define 'issue-tracker-url'")
 	}
 
+	pkgName = packageName(model, packageNameOverride)
+	packageDependencies, err := calculateDependencies(annotate.imports, annotate.dependencyConstraints, pkgName)
+	if err != nil {
+		return err
+	}
+
 	ann := &modelAnnotations{
 		Parent:         model,
-		PackageName:    packageName(model, packageNameOverride),
+		PackageName:    pkgName,
 		PackageVersion: packageVersion,
 		MainFileName:   strcase.ToSnake(model.Name),
 		CopyrightYear:  generationYear,
@@ -385,6 +403,7 @@ func (annotate *annotateModel) annotateModel(options map[string]string) error {
 		ReadMeQuickstartText:       readMeQuickstartText,
 		ApiKeyEnvironmentVariables: apiKeyEnvironmentVariables,
 		Exports:                    exports,
+		ProtoPrefix:                protobufPrefix,
 	}
 
 	model.Codec = ann
@@ -417,7 +436,7 @@ func calculateRequiredFields(model *api.API) map[string]*api.Field {
 }
 
 // calculateDependencies calculates package dependencies based on `package:` imports.
-func calculateDependencies(imports map[string]bool, constraints map[string]string) ([]packageDependency, error) {
+func calculateDependencies(imports map[string]bool, constraints map[string]string, packageName string) ([]packageDependency, error) {
 	deps := []packageDependency{}
 
 	for imp := range imports {
@@ -431,7 +450,10 @@ func calculateDependencies(imports map[string]bool, constraints map[string]strin
 				if len(constraint) == 0 {
 					return nil, fmt.Errorf("unknown version constraint for package %q (did you forget to add it to .sidekick.toml?)", name)
 				}
-				deps = append(deps, packageDependency{Name: name, Constraint: constraint})
+
+				if name != packageName {
+					deps = append(deps, packageDependency{Name: name, Constraint: constraint})
+				}
 			}
 		}
 	}
@@ -501,7 +523,8 @@ func (annotate *annotateModel) annotateService(s *api.Service) {
 
 func (annotate *annotateModel) annotateMessage(m *api.Message) {
 	// Add the import for the common JSON helpers.
-	annotate.imports[commonHelpersImport] = true
+
+	annotate.imports[encodingImport] = true
 
 	for _, f := range m.Fields {
 		annotate.annotateField(f)
@@ -536,6 +559,7 @@ func (annotate *annotateModel) annotateMessage(m *api.Message) {
 		OmitGeneration:  omit || m.IsMap,
 		ConstructorBody: constructorBody,
 		ToStringLines:   toStringLines,
+		Model:           annotate.model,
 	}
 }
 
@@ -869,6 +893,7 @@ func (annotate *annotateModel) annotateEnum(enum *api.Enum) {
 	enum.Codec = &enumAnnotation{
 		Name:     enumName(enum),
 		DocLines: formatDocComments(enum.Documentation, annotate.state),
+		Model:    annotate.model,
 	}
 }
 

internal/sidekick/internal/dart/annotate_test.go

@@ -29,7 +29,9 @@ var (
 		"issue-tracker-url":              "http://www.example.com/issues",
 		"package:googleapis_auth":        "^2.0.0",
 		"package:google_cloud_gax":       "^1.2.3",
-		"package:http":                   "^4.5.6"}
+		"package:http":                   "^4.5.6",
+		"package:google_cloud_protobuf":  "^7.8.9",
+	}
 )
 
 func TestAnnotateModel(t *testing.T) {
@@ -149,9 +151,10 @@ func TestAnnotateModel_Options(t *testing.T) {
 			map[string]string{"google_cloud_gax": "^1.2.3", "package:http": "1.2.0"},
 			func(t *testing.T, am *annotateModel) {
 				if diff := cmp.Diff(map[string]string{
-					"google_cloud_gax": "^1.2.3",
-					"googleapis_auth":  "^2.0.0",
-					"http":             "1.2.0"},
+					"google_cloud_gax":      "^1.2.3",
+					"google_cloud_protobuf": "^7.8.9",
+					"googleapis_auth":       "^2.0.0",
+					"http":                  "1.2.0"},
 					am.dependencyConstraints); diff != "" {
 					t.Errorf("mismatch in annotateModel.dependencyConstraints (-want, +got)\n:%s", diff)
 				}
@@ -252,31 +255,33 @@ func TestAnnotateMethod(t *testing.T) {
 
 func TestCalculateDependencies(t *testing.T) {
 	for _, test := range []struct {
-		name    string
-		imports []string
-		want    []packageDependency
+		testName string
+		pkgName  string
+		imports  []string
+		want     []packageDependency
 	}{
-		{name: "empty", imports: []string{}, want: []packageDependency{}},
-		{name: "dart import", imports: []string{typedDataImport}, want: []packageDependency{}},
-		{name: "package import", imports: []string{httpImport}, want: []packageDependency{{Name: "http", Constraint: "^1.3.0"}}},
-		{name: "dart and package imports", imports: []string{typedDataImport, httpImport}, want: []packageDependency{{Name: "http", Constraint: "^1.3.0"}}},
-		{name: "package imports", imports: []string{
+		{testName: "empty", pkgName: "google_cloud_bar", imports: []string{}, want: []packageDependency{}},
+		{testName: "dart import", pkgName: "google_cloud_bar", imports: []string{typedDataImport}, want: []packageDependency{}},
+		{testName: "package import", pkgName: "google_cloud_bar", imports: []string{httpImport}, want: []packageDependency{{Name: "http", Constraint: "^1.3.0"}}},
+		{testName: "dart and package imports", pkgName: "google_cloud_bar", imports: []string{typedDataImport, httpImport}, want: []packageDependency{{Name: "http", Constraint: "^1.3.0"}}},
+		{testName: "package imports", pkgName: "google_cloud_bar", imports: []string{
 			httpImport,
 			"package:google_cloud_foo/foo.dart",
 		}, want: []packageDependency{{Name: "google_cloud_foo", Constraint: "^1.2.3"}, {Name: "http", Constraint: "^1.3.0"}}},
+		{testName: "same package", pkgName: "google_cloud_bar", imports: []string{typedDataImport, httpImport, "google_cloud_bar"}, want: []packageDependency{{Name: "http", Constraint: "^1.3.0"}}},
 	} {
-		t.Run(test.name, func(t *testing.T) {
+		t.Run(test.testName, func(t *testing.T) {
 			deps := map[string]bool{}
 			for _, imp := range test.imports {
 				deps[imp] = true
 			}
-			got, err := calculateDependencies(deps, map[string]string{"google_cloud_foo": "^1.2.3", "http": "^1.3.0"})
+			got, err := calculateDependencies(deps, map[string]string{"google_cloud_foo": "^1.2.3", "http": "^1.3.0"}, test.pkgName)
 			if err != nil {
 				t.Fatal(err)
 			}
 
 			if diff := cmp.Diff(test.want, got); diff != "" {
-				t.Errorf("mismatch in calculateDependencies (-want, +got)\n:%s", diff)
+				t.Errorf("mismatch in %q in calculateDependencies (-want, +got)\n:%s", test.testName, diff)
 			}
 		})
 	}

internal/sidekick/internal/dart/dart.go

@@ -28,8 +28,9 @@ import (
 var typedDataImport = "dart:typed_data"
 var authImport = "package:googleapis_auth/auth_io.dart as auth"
 var httpImport = "package:http/http.dart as http"
-var commonImport = "package:google_cloud_gax/gax.dart"
-var commonHelpersImport = "package:google_cloud_gax/src/encoding.dart"
+var gaxImport = "package:google_cloud_gax/gax.dart"
+var encodingImport = "package:google_cloud_protobuf/src/encoding.dart"
+var protobufImport = "package:google_cloud_protobuf/protobuf.dart"
 
 var needsCtorValidation = map[string]string{
 	".google.protobuf.Duration":  "",

internal/sidekick/internal/dart/templates/analysis_options.yaml.mustache

@@ -25,9 +25,4 @@ analyzer:
     camel_case_types: ignore
     implementation_imports: ignore
     unintended_html_in_doc_comment: ignore
-{{!
-`package:google_cloud_gax` protocol messages that are also found in
-other packages
-}}
-    unnecessary_import: ignore
     unused_import: ignore

internal/sidekick/internal/dart/templates/lib/enum.mustache

@@ -17,7 +17,7 @@ limitations under the License.
 {{#Codec.DocLines}}
 {{{.}}}
 {{/Codec.DocLines}}
-final class {{Codec.Name}} extends ProtoEnum {
+final class {{Codec.Name}} extends {{Codec.Model.Codec.ProtoPrefix}}ProtoEnum {
   {{#Values}}
   {{#Codec.DocLines}}
   {{{.}}}

internal/sidekick/internal/dart/templates/lib/message.mustache

@@ -18,7 +18,7 @@ limitations under the License.
 {{#Codec.DocLines}}
 {{{.}}}
 {{/Codec.DocLines}}
-final class {{Codec.Name}} extends ProtoMessage {
+final class {{Codec.Name}} extends {{Codec.Model.Codec.ProtoPrefix}}ProtoMessage {
   static const String fullyQualifiedName = '{{Codec.QualifiedName}}';
 
   {{#Fields}}

internal/sidekick/internal/dart/templates/lib/method.mustache

@@ -41,7 +41,7 @@ Stream<{{Codec.ResponseType}}> {{Codec.Name}}({{Codec.RequestType}} request) {
 ///
 /// This method can be used to get the current status of a long-running
 /// operation.
-Future<Operation<T, S>> getOperation<T extends ProtoMessage, S extends ProtoMessage>(Operation<T, S> request) async {
+Future<Operation<T, S>> getOperation<T extends {{Model.Codec.ProtoPrefix}}ProtoMessage, S extends {{Model.Codec.ProtoPrefix}}ProtoMessage>(Operation<T, S> request) async {
   final url = Uri.https(_host, '{{PathInfo.Codec.PathFmt}}');
   {{#Codec.ReturnsValue}}final response = {{/Codec.ReturnsValue}}await _client.{{Codec.RequestMethod}}(url{{#Codec.HasBody}}, body: {{Codec.BodyMessageName}}{{/Codec.HasBody}});
   return Operation.fromJson(response, request.operationHelper);