feat(internal/librarian/nodejs): add omit_common_resources flag (#6181)

This PR resolves the global path helper methods drift across the Node.js
monorepo by introducing and auto-detecting a new
`omit_common_resources` configuration flag.

Author: quirogas

doc/config-schema.md

@@ -346,6 +346,7 @@ This document describes the schema for the librarian.yaml.
 | :--- | :--- | :--- |
 | `additional_protos` | list of string | Is a list of additional proto files to include in generation. |
 | `diregapic` | bool | Indicates whether generation uses DIREGAPIC (Discovery REST GAPICs). This is typically false. Used for the GCE (compute) client. |
+| `omit_common_resources` | bool | Indicates whether to omit the default inclusion of google/cloud/common_resources.proto. |
 | `path` | string | Is the source path. |
 
 ## NodejsPackage Configuration

internal/config/language.go

@@ -779,6 +779,10 @@ type NodejsAPI struct {
 	// This is typically false. Used for the GCE (compute) client.
 	DIREGAPIC bool `yaml:"diregapic,omitempty"`
 
+	// OmitCommonResources indicates whether to omit the default inclusion of
+	// google/cloud/common_resources.proto.
+	OmitCommonResources bool `yaml:"omit_common_resources,omitempty"`
+
 	// Path is the source path.
 	Path string `yaml:"path,omitempty"`
 }

internal/librarian/nodejs/generate.go

@@ -127,28 +127,44 @@ func generateAPI(ctx context.Context, api *config.API, library *config.Library,
 // applying default values if no explicit configuration is found in the library.
 func resolveNodejsAPI(library *config.Library, api *config.API) *config.NodejsAPI {
 	res := &config.NodejsAPI{
-		Path:             api.Path,
-		AdditionalProtos: []string{commonProtos},
+		Path: api.Path,
 	}
+
+	var apiConfig *config.NodejsAPI
+	if library.Nodejs != nil {
+		for _, nodejsAPI := range library.Nodejs.NodejsAPIs {
+			if nodejsAPI.Path == api.Path {
+				apiConfig = nodejsAPI
+				break
+			}
+		}
+	}
+
+	omitCommon := false
+	if apiConfig != nil {
+		omitCommon = apiConfig.OmitCommonResources
+		res.DIREGAPIC = apiConfig.DIREGAPIC
+		res.OmitCommonResources = apiConfig.OmitCommonResources
+	}
+
+	var protos []string
+	if !omitCommon {
+		protos = append(protos, commonProtos)
+	}
+
 	if library.Nodejs == nil {
+		res.AdditionalProtos = protos
 		return res
 	}
 
-	// Always include commonProtos as a base.
-	protos := []string{commonProtos}
-
 	// Add package-level additional protos.
 	protos = append(protos, library.Nodejs.AdditionalProtos...)
 
-	for _, nodejsAPI := range library.Nodejs.NodejsAPIs {
-		if nodejsAPI.Path != api.Path {
-			continue
-		}
-		// Add API-level additional protos.
-		protos = append(protos, nodejsAPI.AdditionalProtos...)
-		res.DIREGAPIC = nodejsAPI.DIREGAPIC
-		break
+	// Add API-level additional protos.
+	if apiConfig != nil {
+		protos = append(protos, apiConfig.AdditionalProtos...)
 	}
+
 	res.AdditionalProtos = unique(protos)
 	return res
 }

internal/librarian/nodejs/generate_test.go

@@ -1214,6 +1214,128 @@ func TestResolveNodejsAPI(t *testing.T) {
 				DIREGAPIC:        true,
 			},
 		},
+		{
+			name: "omit common resources is true",
+			library: &config.Library{
+				Nodejs: &config.NodejsPackage{
+					NodejsAPIs: []*config.NodejsAPI{
+						{
+							Path:                "google/api/cloudquotas/v1",
+							OmitCommonResources: true,
+						},
+					},
+				},
+			},
+			api: &config.API{Path: "google/api/cloudquotas/v1"},
+			want: &config.NodejsAPI{
+				Path:                "google/api/cloudquotas/v1",
+				OmitCommonResources: true,
+				AdditionalProtos:    nil,
+			},
+		},
+		{
+			name: "omit common resources is true, package-level additional protos preserved",
+			library: &config.Library{
+				Nodejs: &config.NodejsPackage{
+					AdditionalProtos: []string{"pkg.proto"},
+					NodejsAPIs: []*config.NodejsAPI{
+						{
+							Path:                "google/cloud/secretmanager/v1",
+							OmitCommonResources: true,
+						},
+					},
+				},
+			},
+			api: &config.API{Path: "google/cloud/secretmanager/v1"},
+			want: &config.NodejsAPI{
+				Path:                "google/cloud/secretmanager/v1",
+				OmitCommonResources: true,
+				AdditionalProtos:    []string{"pkg.proto"},
+			},
+		},
+		{
+			name: "omit common resources is true, api-level additional protos preserved",
+			library: &config.Library{
+				Nodejs: &config.NodejsPackage{
+					NodejsAPIs: []*config.NodejsAPI{
+						{
+							Path:                "google/cloud/secretmanager/v1",
+							OmitCommonResources: true,
+							AdditionalProtos:    []string{"api.proto"},
+						},
+					},
+				},
+			},
+			api: &config.API{Path: "google/cloud/secretmanager/v1"},
+			want: &config.NodejsAPI{
+				Path:                "google/cloud/secretmanager/v1",
+				OmitCommonResources: true,
+				AdditionalProtos:    []string{"api.proto"},
+			},
+		},
+		{
+			name: "omit common resources is true, package-level and api-level protos combined",
+			library: &config.Library{
+				Nodejs: &config.NodejsPackage{
+					AdditionalProtos: []string{"pkg.proto"},
+					NodejsAPIs: []*config.NodejsAPI{
+						{
+							Path:                "google/cloud/secretmanager/v1",
+							OmitCommonResources: true,
+							AdditionalProtos:    []string{"api.proto"},
+						},
+					},
+				},
+			},
+			api: &config.API{Path: "google/cloud/secretmanager/v1"},
+			want: &config.NodejsAPI{
+				Path:                "google/cloud/secretmanager/v1",
+				OmitCommonResources: true,
+				AdditionalProtos:    []string{"pkg.proto", "api.proto"},
+			},
+		},
+		{
+			name: "omit common resources is false, all preserved",
+			library: &config.Library{
+				Nodejs: &config.NodejsPackage{
+					AdditionalProtos: []string{"pkg.proto"},
+					NodejsAPIs: []*config.NodejsAPI{
+						{
+							Path:                "google/cloud/secretmanager/v1",
+							OmitCommonResources: false,
+							AdditionalProtos:    []string{"api.proto"},
+						},
+					},
+				},
+			},
+			api: &config.API{Path: "google/cloud/secretmanager/v1"},
+			want: &config.NodejsAPI{
+				Path:                "google/cloud/secretmanager/v1",
+				OmitCommonResources: false,
+				AdditionalProtos:    []string{commonProtos, "pkg.proto", "api.proto"},
+			},
+		},
+		{
+			name: "duplicated protos",
+			library: &config.Library{
+				Nodejs: &config.NodejsPackage{
+					AdditionalProtos: []string{"pkg.proto", "dup.proto"},
+					NodejsAPIs: []*config.NodejsAPI{
+						{
+							Path:                "google/cloud/secretmanager/v1",
+							OmitCommonResources: true,
+							AdditionalProtos:    []string{"dup.proto", "api.proto"},
+						},
+					},
+				},
+			},
+			api: &config.API{Path: "google/cloud/secretmanager/v1"},
+			want: &config.NodejsAPI{
+				Path:                "google/cloud/secretmanager/v1",
+				OmitCommonResources: true,
+				AdditionalProtos:    []string{"pkg.proto", "dup.proto", "api.proto"},
+			},
+		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
 			got := resolveNodejsAPI(test.library, test.api)

tool/cmd/migrate/nodejs.go

@@ -27,6 +27,7 @@ import (
 	"sort"
 	"strings"
 
+	"github.com/bazelbuild/buildtools/build"
 	"github.com/googleapis/librarian/internal/config"
 	"github.com/googleapis/librarian/internal/librarian"
 	"github.com/googleapis/librarian/internal/yaml"
@@ -60,6 +61,7 @@ type nodejsGapicInfo struct {
 	handwrittenLayer      bool
 	mainService           string
 	mixins                string
+	omitCommonResources   bool
 }
 
 // owlBotSourceRegex extracts the base API path from an .OwlBot.yaml
@@ -265,11 +267,20 @@ func buildNodejsLibraryAPIs(googleapisDir string, apis []*config.API) []*config.
 	var nodejsAPIs []*config.NodejsAPI
 	for _, api := range apis {
 		info, err := parseBazelNodejsInfo(googleapisDir, api.Path)
-		if err == nil && info != nil && info.diregapic {
-			nodejsAPIs = append(nodejsAPIs, &config.NodejsAPI{
-				Path:      api.Path,
-				DIREGAPIC: true,
-			})
+		if err != nil || info == nil {
+			continue
+		}
+		if info.diregapic || info.omitCommonResources {
+			apiConfig := &config.NodejsAPI{
+				Path: api.Path,
+			}
+			if info.diregapic {
+				apiConfig.DIREGAPIC = true
+			}
+			if info.omitCommonResources {
+				apiConfig.OmitCommonResources = true
+			}
+			nodejsAPIs = append(nodejsAPIs, apiConfig)
 		}
 	}
 	return nodejsAPIs
@@ -369,12 +380,39 @@ func parseBazelNodejsInfo(googleapisDir, apiDir string) (*nodejsGapicInfo, error
 	if len(extraProtocParameters) == 0 {
 		extraProtocParameters = nil
 	}
+
+	src := rule.AttrString("src")
+	omitCommon := false
+	if src != "" {
+		srcName := strings.TrimPrefix(src, ":")
+		protoRules := file.Rules("proto_library_with_info")
+		var protoRule *build.Rule
+		for _, r := range protoRules {
+			if r.AttrString("name") == srcName {
+				protoRule = r
+				break
+			}
+		}
+		if protoRule != nil {
+			if attr := protoRule.Attr("deps"); attr != nil {
+				omitCommon = true
+				for _, dep := range extractStrings(attr) {
+					if strings.HasSuffix(dep, "google/cloud:common_resources_proto") {
+						omitCommon = false
+						break
+					}
+				}
+			}
+		}
+	}
+
 	info := &nodejsGapicInfo{
 		packageName:           rule.AttrString("package_name"),
 		bundleConfig:          rule.AttrString("bundle_config"),
 		extraProtocParameters: extraProtocParameters,
 		mainService:           rule.AttrString("main_service"),
 		mixins:                rule.AttrString("mixins"),
+		omitCommonResources:   omitCommon,
 	}
 	if rule.AttrLiteral("diregapic") == "True" {
 		info.diregapic = true