feat: support service renaming for snippets (#1622)

* feat: support service renaming for snippets

* fix service name initialization

* remove log statements

Author: hongalex

internal/gengapic/client_init.go

@@ -160,16 +160,21 @@ func (g *generator) serviceDoc(serv *descriptorpb.ServiceDescriptorProto) {
 		return
 	}
 
+	servName := serv.GetName()
+	if override := g.getServiceNameOverride(serv); override != "" {
+		servName = override
+	}
+
 	// If the service is marked as deprecated and there is no comment, then add default deprecation comment.
 	// If the service has a comment but it does not include a deprecation notice, then append a default deprecation notice.
 	// If the service includes a deprecation notice at the beginning of the comment, prepend a comment stating the service is deprecated and use the included deprecation notice.
 	if serv.GetOptions().GetDeprecated() {
 		if com == "" {
-			com = fmt.Sprintf("\n%s is deprecated.\n\nDeprecated: %[1]s may be removed in a future version.", serv.GetName())
+			com = fmt.Sprintf("\n%s is deprecated.\n\nDeprecated: %[1]s may be removed in a future version.", servName)
 		} else if strings.HasPrefix(com, "Deprecated:") {
-			com = fmt.Sprintf("\n%s is deprecated.\n\n%s", serv.GetName(), com)
+			com = fmt.Sprintf("\n%s is deprecated.\n\n%s", servName, com)
 		} else if !containsDeprecated(com) {
-			com = fmt.Sprintf("%s\n\nDeprecated: %s may be removed in a future version.", com, serv.GetName())
+			com = fmt.Sprintf("%s\n\nDeprecated: %s may be removed in a future version.", com, servName)
 		}
 	}
 	com = strings.TrimSpace(com)
@@ -240,6 +245,12 @@ func (g *generator) clientInit(serv *descriptorpb.ServiceDescriptorProto, servNa
 func (g *generator) genClientWrapperMethod(m *descriptorpb.MethodDescriptorProto, serv *descriptorpb.ServiceDescriptorProto, servName string) error {
 	p := g.printf
 
+	// This cannot be servName since that is a shortened version and the
+	// addSnippetsMetadataResult function expects the full service name.
+	snippetServiceName := serv.GetName()
+	if override := g.getServiceNameOverride(serv); override != "" {
+		snippetServiceName = override
+	}
 	clientTypeName := fmt.Sprintf("%sClient", servName)
 	inType := g.descInfo.Type[m.GetInputType()]
 	inSpec, err := g.descInfo.ImportSpec(inType)
@@ -258,7 +269,7 @@ func (g *generator) genClientWrapperMethod(m *descriptorpb.MethodDescriptorProto
 		p("}")
 		p("")
 
-		g.addSnippetsMetadataParams(m, serv.GetName(), reqTyp)
+		g.addSnippetsMetadataParams(m, snippetServiceName, reqTyp)
 		return nil
 	}
 
@@ -277,8 +288,8 @@ func (g *generator) genClientWrapperMethod(m *descriptorpb.MethodDescriptorProto
 		p("}")
 		p("")
 
-		g.addSnippetsMetadataParams(m, serv.GetName(), reqTyp)
-		g.addSnippetsMetadataResult(m, serv.GetName(), lroType)
+		g.addSnippetsMetadataParams(m, snippetServiceName, reqTyp)
+		g.addSnippetsMetadataResult(m, snippetServiceName, lroType)
 		return nil
 	}
 
@@ -296,8 +307,8 @@ func (g *generator) genClientWrapperMethod(m *descriptorpb.MethodDescriptorProto
 		p("}")
 		p("")
 
-		g.addSnippetsMetadataParams(m, serv.GetName(), reqTyp)
-		g.addSnippetsMetadataResult(m, serv.GetName(), iter.iterTypeName)
+		g.addSnippetsMetadataParams(m, snippetServiceName, reqTyp)
+		g.addSnippetsMetadataResult(m, snippetServiceName, iter.iterTypeName)
 		return nil
 	}
 
@@ -315,8 +326,8 @@ func (g *generator) genClientWrapperMethod(m *descriptorpb.MethodDescriptorProto
 		p("}")
 		p("")
 
-		g.addSnippetsMetadataParams(m, serv.GetName(), "")
-		g.addSnippetsMetadataResult(m, serv.GetName(), retTyp)
+		g.addSnippetsMetadataParams(m, snippetServiceName, "")
+		g.addSnippetsMetadataResult(m, snippetServiceName, retTyp)
 		return nil
 	case m.GetServerStreaming():
 		servSpec, err := g.descInfo.ImportSpec(serv)
@@ -332,8 +343,8 @@ func (g *generator) genClientWrapperMethod(m *descriptorpb.MethodDescriptorProto
 		p("}")
 		p("")
 
-		g.addSnippetsMetadataParams(m, serv.GetName(), reqTyp)
-		g.addSnippetsMetadataResult(m, serv.GetName(), retTyp)
+		g.addSnippetsMetadataParams(m, snippetServiceName, reqTyp)
+		g.addSnippetsMetadataResult(m, snippetServiceName, retTyp)
 		return nil
 	default:
 		reqTyp := fmt.Sprintf("%s.%s", inSpec.Name, inType.GetName())
@@ -348,8 +359,8 @@ func (g *generator) genClientWrapperMethod(m *descriptorpb.MethodDescriptorProto
 		p("}")
 		p("")
 
-		g.addSnippetsMetadataParams(m, serv.GetName(), reqTyp)
-		g.addSnippetsMetadataResult(m, serv.GetName(), retTyp)
+		g.addSnippetsMetadataParams(m, snippetServiceName, reqTyp)
+		g.addSnippetsMetadataResult(m, snippetServiceName, retTyp)
 		return nil
 	}
 

internal/gengapic/gengapic.go

@@ -652,7 +652,11 @@ func (g *generator) methodDoc(m *descriptorpb.MethodDescriptorProto, serv *descr
 
 	// Prepend the method name to all non-empty comments.
 	com = m.GetName() + " " + lowerFirst(com)
-	g.addSnippetsMetadataDoc(m, serv.GetName(), com)
+	servName := serv.GetName()
+	if override := g.getServiceNameOverride(serv); override != "" {
+		servName = override
+	}
+	g.addSnippetsMetadataDoc(m, servName, com)
 	g.comment(com)
 }
 

internal/gengapic/snippets.go

@@ -73,7 +73,11 @@ func (g *generator) genAndCommitSnippets(s *descriptorpb.ServiceDescriptorProto)
 		return nil
 	}
 	defaultHost := proto.GetExtension(s.Options, annotations.E_DefaultHost).(string)
-	g.snippetMetadata.AddService(s.GetName(), defaultHost)
+	servName := s.GetName()
+	if override := g.getServiceNameOverride(s); override != "" {
+		servName = override
+	}
+	g.snippetMetadata.AddService(servName, defaultHost)
 	methods := append(s.GetMethod(), g.getMixinMethods()...)
 	for _, m := range methods {
 		if m.GetClientStreaming() != m.GetServerStreaming() {
@@ -89,27 +93,32 @@ func (g *generator) genAndCommitSnippets(s *descriptorpb.ServiceDescriptorProto)
 		g.imports[pbinfo.ImportSpec{Name: g.opts.pkgName, Path: g.opts.pkgPath}] = true
 		// Use the client short name in this filepath.
 		// E.g. the client for LoggingServiceV2 is just "Client".
-		clientName := pbinfo.ReduceServName(s.GetName(), g.opts.pkgName) + "Client"
+		clientName := pbinfo.ReduceServName(servName, g.opts.pkgName) + "Client"
 		// Get the original proto namespace for the method (different from `s` only for mixins).
 		f := g.descInfo.ParentFile[m]
 		// Get the original proto service for the method (different from `s` only for mixins).
 		methodServ := (g.descInfo.ParentElement[m]).(*descriptorpb.ServiceDescriptorProto)
 		lineCount := g.commit(filepath.Join(g.snippetsOutDir(), clientName, m.GetName(), "main.go"), "main")
-		g.snippetMetadata.AddMethod(s.GetName(), m.GetName(), f.GetPackage(), methodServ.GetName(), lineCount-1)
+		g.snippetMetadata.AddMethod(servName, m.GetName(), f.GetPackage(), methodServ.GetName(), lineCount-1)
 	}
 	return nil
 }
 
 // genSnippetFile generates a single RPC snippet by leveraging exampleMethodBody in gengapic/example.go.
 func (g *generator) genSnippetFile(s *descriptorpb.ServiceDescriptorProto, m *descriptorpb.MethodDescriptorProto) error {
-	regionTag := g.snippetMetadata.RegionTag(s.GetName(), m.GetName())
+	servName := s.GetName()
+	if override := g.getServiceNameOverride(s); override != "" {
+		servName = override
+	}
+	regionTag := g.snippetMetadata.RegionTag(servName, m.GetName())
 	g.headerComment(fmt.Sprintf("[START %s]", regionTag))
 	pkgName := g.opts.pkgName
-	servName := pbinfo.ReduceServName(s.GetName(), pkgName)
+
+	reducedServName := pbinfo.ReduceServName(servName, pkgName)
 
 	p := g.printf
 	p("func main() {")
-	if err := g.exampleMethodBody(pkgName, servName, m); err != nil {
+	if err := g.exampleMethodBody(pkgName, reducedServName, m); err != nil {
 		return err
 	}
 	p("}")