Add swift_prefix to managed mode (#4215)

Co-authored-by: Doria Keung <[email protected]>

Author: bufdev

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## [Unreleased]
 
+- Add `swift_prefix` to managed mode.
 - Add `textDocument/rename` and `textDocument/prepareRename` support for `buf lsp serve`.
 - Fix panic in LSP for empty option paths.
 - Fix support for multi-arch image manifests for `buf beta registry plugin push`.

private/bufpkg/bufconfig/buf_gen_yaml_file.go

@@ -333,6 +333,7 @@ type externalGenerateManagedConfigV1 struct {
 	GoPackagePrefix     externalGoPackagePrefixConfigV1   `json:"go_package_prefix,omitempty" yaml:"go_package_prefix,omitempty"`
 	ObjcClassPrefix     externalObjcClassPrefixConfigV1   `json:"objc_class_prefix,omitempty" yaml:"objc_class_prefix,omitempty"`
 	RubyPackage         externalRubyPackageConfigV1       `json:"ruby_package,omitempty" yaml:"ruby_package,omitempty"`
+	SwiftPrefix         externalSwiftPrefixConfigV1       `json:"swift_prefix,omitempty" yaml:"swift_prefix,omitempty"`
 	// Override maps from a file option to a file path then to the value.
 	Override map[string]map[string]string `json:"override,omitempty" yaml:"override,omitempty"`
 }
@@ -460,6 +461,20 @@ func (e externalRubyPackageConfigV1) isEmpty() bool {
 	return len(e.Except) == 0 && len(e.Override) == 0
 }
 
+// externalSwiftPrefixConfigV1 represents the swift_prefix config in a v1 buf.gen.yaml file.
+type externalSwiftPrefixConfigV1 struct {
+	Default  string            `json:"default,omitempty" yaml:"default,omitempty"`
+	Except   []string          `json:"except,omitempty" yaml:"except,omitempty"`
+	Override map[string]string `json:"override,omitempty" yaml:"override,omitempty"`
+}
+
+// isEmpty returns true is the config is empty.
+func (e externalSwiftPrefixConfigV1) isEmpty() bool {
+	return e.Default == "" &&
+		len(e.Except) == 0 &&
+		len(e.Override) == 0
+}
+
 // externalObjcClassPrefixConfigV1 represents the objc_class_prefix config in a v1 buf.gen.yaml file.
 type externalObjcClassPrefixConfigV1 struct {
 	Default  string            `json:"default,omitempty" yaml:"default,omitempty"`

private/bufpkg/bufconfig/generate_config_test.go

@@ -600,6 +600,57 @@ func TestParseConfigFromExternalV1(t *testing.T) {
 				},
 			},
 		},
+		{
+			description: "managed_mode_swift_prefix",
+			externalConfig: externalBufGenYAMLFileV1{
+				Version: "v1",
+				Plugins: []externalGeneratePluginConfigV1{
+					{
+						Plugin: "go",
+						Out:    "go/out",
+					},
+				},
+				Managed: externalGenerateManagedConfigV1{
+					Enabled: true,
+					SwiftPrefix: externalSwiftPrefixConfigV1{
+						Default: "foo",
+						Except:  []string{"buf.build/acme/foo"},
+						Override: map[string]string{
+							"buf.build/acme/petapis": "pet",
+						},
+					},
+				},
+			},
+			expectedConfig: &generateConfig{
+				generatePluginConfigs: []GeneratePluginConfig{
+					&generatePluginConfig{
+						generatePluginConfigType: GeneratePluginConfigTypeLocalOrProtocBuiltin,
+						name:                     "go",
+						out:                      "go/out",
+					},
+				},
+				generateManagedConfig: &generateManagedConfig{
+					enabled: true,
+					disables: []ManagedDisableRule{
+						&managedDisableRule{
+							fileOption:     FileOptionSwiftPrefix,
+							moduleFullName: "buf.build/acme/foo",
+						},
+					},
+					overrides: []ManagedOverrideRule{
+						&managedOverrideRule{
+							fileOption: FileOptionSwiftPrefix,
+							value:      "foo",
+						},
+						&managedOverrideRule{
+							fileOption:     FileOptionSwiftPrefix,
+							moduleFullName: "buf.build/acme/petapis",
+							value:          "pet",
+						},
+					},
+				},
+			},
+		},
 		{
 			description: "managed_mode_per_file_override",
 			externalConfig: externalBufGenYAMLFileV1{

private/bufpkg/bufconfig/generate_managed_config.go

@@ -387,6 +387,32 @@ func newGenerateManagedConfigFromExternalV1(
 		disables = append(disables, rubyPackageDisables...)
 		overrides = append(overrides, rubyPackageOverrides...)
 	}
+	if externalSwiftPrefix := externalConfig.SwiftPrefix; !externalSwiftPrefix.isEmpty() {
+		if externalSwiftPrefix.Default != "" {
+			// objc class prefix allows empty default
+			defaultOverride, err := NewManagedOverrideRuleForFileOption(
+				"",
+				"",
+				FileOptionSwiftPrefix,
+				externalSwiftPrefix.Default,
+			)
+			if err != nil {
+				return nil, err
+			}
+			overrides = append(overrides, defaultOverride)
+		}
+		swiftPrefixDisables, swiftPrefixOverrides, err := disablesAndOverridesFromExceptAndOverrideV1(
+			FileOptionSwiftPrefix,
+			externalSwiftPrefix.Except,
+			FileOptionSwiftPrefix,
+			externalSwiftPrefix.Override,
+		)
+		if err != nil {
+			return nil, err
+		}
+		disables = append(disables, swiftPrefixDisables...)
+		overrides = append(overrides, swiftPrefixOverrides...)
+	}
 	perFileOverrides, err := overrideRulesForPerFileOverridesV1(externalConfig.Override)
 	if err != nil {
 		return nil, err

private/bufpkg/bufconfig/generate_managed_option.go

@@ -65,6 +65,8 @@ const (
 	FileOptionRubyPackage
 	// FileOptionRubyPackageSuffix is the file option ruby_package_suffix.
 	FileOptionRubyPackageSuffix
+	// FileOptionSwiftPrefix is the file option swift_prefix.
+	FileOptionSwiftPrefix
 )
 
 // String implements fmt.Stringer.
@@ -117,6 +119,7 @@ var (
 		FileOptionPhpMetadataNamespaceSuffix: "php_metadata_namespace_suffix",
 		FileOptionRubyPackage:                "ruby_package",
 		FileOptionRubyPackageSuffix:          "ruby_package_suffix",
+		FileOptionSwiftPrefix:                "swift_prefix",
 	}
 	stringToFileOption = map[string]FileOption{
 		"java_package":                  FileOptionJavaPackage,
@@ -137,6 +140,7 @@ var (
 		"php_metadata_namespace_suffix": FileOptionPhpMetadataNamespaceSuffix,
 		"ruby_package":                  FileOptionRubyPackage,
 		"ruby_package_suffix":           FileOptionRubyPackageSuffix,
+		"swift_prefix":                  FileOptionSwiftPrefix,
 	}
 	fileOptionToParseOverrideValueFunc = map[FileOption]func(any) (any, error){
 		FileOptionJavaPackage:                parseOverrideValue[string],
@@ -157,6 +161,7 @@ var (
 		FileOptionPhpMetadataNamespaceSuffix: parseOverrideValue[string],
 		FileOptionRubyPackage:                parseOverrideValue[string],
 		FileOptionRubyPackageSuffix:          parseOverrideValue[string],
+		FileOptionSwiftPrefix:                parseOverrideValue[string],
 	}
 	fieldOptionToString = map[FieldOption]string{
 		FieldOptionJSType: "jstype",
@@ -258,7 +263,8 @@ func getOverrideValue(fileOptionName string, fieldOptionName string, value any)
 			FileOptionPhpMetadataNamespace,
 			FileOptionPhpMetadataNamespaceSuffix,
 			FileOptionRubyPackage,
-			FileOptionRubyPackageSuffix:
+			FileOptionRubyPackageSuffix,
+			FileOptionSwiftPrefix:
 			return value, nil
 
 		case FileOptionOptimizeFor:

private/bufpkg/bufimage/bufimagemodify/bufimagemodify.go

@@ -45,6 +45,7 @@ func Modify(
 			modifyPhpMetadataNamespace,
 			modifyPhpNamespace,
 			modifyRubyPackage,
+			modifySwiftPrefix,
 			modifyJsType,
 		},
 		options...,
@@ -163,6 +164,20 @@ func ModifyRubyPackage(
 	)
 }
 
+// ModifySwiftPrefix modifies the swift_prefix file option.
+func ModifySwiftPrefix(
+	image bufimage.Image,
+	config bufconfig.GenerateManagedConfig,
+	options ...ModifyOption,
+) error {
+	return modifyImageForSingleOption(
+		image,
+		config,
+		modifySwiftPrefix,
+		options...,
+	)
+}
+
 // ModifyCcEnableArenas modifies the cc_enable_arenas file option.
 func ModifyCcEnableArenas(
 	image bufimage.Image,

private/bufpkg/bufimage/bufimagemodify/bufimagemodify_test.go

@@ -99,6 +99,7 @@ func TestModifyImage(t *testing.T) {
 					PhpMetadataNamespace: proto.String(`Foo\Empty_\GPBMetadata`),
 					PhpNamespace:         proto.String(`Foo\Empty_`),
 					RubyPackage:          proto.String("Foo::Empty"),
+					SwiftPrefix:          proto.String("Foo_Empty_"),
 				},
 				"foo_empty/without_package.proto": {
 					// CcEnableArena's default value is true
@@ -125,7 +126,7 @@ func TestModifyImage(t *testing.T) {
 					PhpNamespace:         proto.String(`Bar\All`),
 					PyGenericServices:    proto.Bool(false),
 					RubyPackage:          proto.String("Bar::All"),
-					SwiftPrefix:          proto.String("bar"),
+					SwiftPrefix:          proto.String("Bar_All_"),
 				},
 				"bar_all/without_package.proto": {
 					CcEnableArenas:       proto.Bool(true),
@@ -546,6 +547,65 @@ func TestModifyImageFile(
 				"foo_all/with_package.proto":      {objcClassPrefixPath},
 			},
 		},
+		{
+			description: "swift_prefix",
+			dirPathToFullName: map[string]string{
+				filepath.Join("testdata", "foo"): "buf.build/acme/foo",
+				filepath.Join("testdata", "bar"): "buf.build/acme/bar",
+			},
+			config: bufconfig.NewGenerateManagedConfig(
+				true,
+				[]bufconfig.ManagedDisableRule{
+					newTestManagedDisableRule(t, "foo_empty/with_package.proto", "", "", bufconfig.FileOptionSwiftPrefix, bufconfig.FieldOptionUnspecified),
+				},
+				[]bufconfig.ManagedOverrideRule{
+					newTestFileOptionOverrideRule(t, "", "buf.build/acme/bar", bufconfig.FileOptionSwiftPrefix, "BAR"),
+					newTestFileOptionOverrideRule(t, "", "buf.build/acme/foo", bufconfig.FileOptionSwiftPrefix, "FOO"),
+					newTestFileOptionOverrideRule(t, "foo_all", "buf.build/acme/foo", bufconfig.FileOptionSwiftPrefix, "FOOALL"),
+				},
+			),
+			modifyFunc: modifySwiftPrefix,
+			filePathToExpectedOptions: map[string]*descriptorpb.FileOptions{
+				"bar_empty/with_package.proto": {
+					SwiftPrefix: proto.String("BAR"),
+				},
+				"bar_empty/without_package.proto": {
+					SwiftPrefix: proto.String("BAR"),
+				},
+				// disabled
+				"foo_empty/with_package.proto": nil,
+				// no package
+				"foo_empty/without_package.proto": {
+					SwiftPrefix: proto.String("FOO"),
+				},
+				"foo_all/with_package.proto": {
+					ObjcClassPrefix:      proto.String("foo"),
+					CcEnableArenas:       proto.Bool(true),
+					CcGenericServices:    proto.Bool(true),
+					CsharpNamespace:      proto.String("foo"),
+					GoPackage:            proto.String("foo"),
+					JavaGenericServices:  proto.Bool(true),
+					JavaMultipleFiles:    proto.Bool(true),
+					JavaOuterClassname:   proto.String("foo"),
+					JavaPackage:          proto.String("foo"),
+					JavaStringCheckUtf8:  proto.Bool(true),
+					OptimizeFor:          descriptorpb.FileOptions_CODE_SIZE.Enum(),
+					PhpClassPrefix:       proto.String("foo"),
+					PhpMetadataNamespace: proto.String("foo"),
+					PhpNamespace:         proto.String("foo"),
+					PyGenericServices:    proto.Bool(true),
+					RubyPackage:          proto.String("foo"),
+					SwiftPrefix:          proto.String("FOOALL"),
+				},
+			},
+			filePathToExpectedMarkedLocationPaths: map[string][][]int32{
+				"bar_empty/with_package.proto":    {swiftPrefixPath},
+				"bar_empty/without_package.proto": {swiftPrefixPath},
+				"foo_empty/without_package.proto": {swiftPrefixPath},
+				"foo_all/without_package.proto":   {swiftPrefixPath},
+				"foo_all/with_package.proto":      {swiftPrefixPath},
+			},
+		},
 	}
 	for _, testcase := range testcases {
 		for _, includeSourceInfo := range []bool{true, false} {

private/bufpkg/bufimage/bufimagemodify/file_option.go

@@ -56,10 +56,12 @@ var (
 	// phpNamespacePath is the SourceCodeInfo path for the php_namespace option.
 	// Ref: https://github.com/protocolbuffers/protobuf/blob/61689226c0e3ec88287eaed66164614d9c4f2bf7/src/google/protobuf/descriptor.proto#L443
 	phpNamespacePath = []int32{8, 41}
-
 	// rubyPackagePath is the SourceCodeInfo path for the ruby_package option.
 	// https://github.com/protocolbuffers/protobuf/blob/61689226c0e3ec88287eaed66164614d9c4f2bf7/src/google/protobuf/descriptor.proto#L453
 	rubyPackagePath = []int32{8, 45}
+	// swiftPrefixPath is the SourceCodeInfo path for the swift_prefix option.
+	// https://github.com/protocolbuffers/protobuf/blob/61689226c0e3ec88287eaed66164614d9c4f2bf7/src/google/protobuf/descriptor.proto#L434
+	swiftPrefixPath = []int32{8, 39}
 )
 
 func modifyJavaOuterClass(
@@ -359,6 +361,43 @@ func modifyRubyPackage(
 	)
 }
 
+func modifySwiftPrefix(
+	sweeper internal.MarkSweeper,
+	imageFile bufimage.ImageFile,
+	config bufconfig.GenerateManagedConfig,
+	options ...ModifyOption,
+) error {
+	modifyOptions := newModifyOptions()
+	for _, option := range options {
+		option(modifyOptions)
+	}
+	return modifyStringOption(
+		sweeper,
+		imageFile,
+		config,
+		modifyOptions.preserveExisting,
+		bufconfig.FileOptionSwiftPrefix,
+		bufconfig.FileOptionUnspecified,
+		bufconfig.FileOptionUnspecified,
+		func(bufimage.ImageFile) stringOverrideOptions {
+			return stringOverrideOptions{value: swiftPrefixValue(imageFile)}
+		},
+		func(imageFile bufimage.ImageFile, _ stringOverrideOptions) string {
+			return swiftPrefixValue(imageFile)
+		},
+		func(options *descriptorpb.FileOptions) string {
+			return options.GetSwiftPrefix()
+		},
+		func(options *descriptorpb.FileOptions, value string) {
+			options.SwiftPrefix = proto.String(value)
+		},
+		func(options *descriptorpb.FileOptions) bool {
+			return options != nil && options.SwiftPrefix != nil
+		},
+		swiftPrefixPath,
+	)
+}
+
 func modifyCcEnableArenas(
 	sweeper internal.MarkSweeper,
 	imageFile bufimage.ImageFile,

private/bufpkg/bufimage/bufimagemodify/override.go

@@ -422,3 +422,20 @@ func rubyPackageValue(imageFile bufimage.ImageFile) string {
 	}
 	return strings.Join(packageParts, "::")
 }
+
+// swiftPrefixValue returns the swift_prefix for the given ImageFile based on its
+// package declaration. If the image file doesn't have a package declaration, an
+// empty string is returned.
+func swiftPrefixValue(imageFile bufimage.ImageFile) string {
+	pkg := imageFile.FileDescriptorProto().GetPackage()
+	if pkg == "" {
+		return ""
+	}
+	packageParts := strings.Split(pkg, ".")
+	for i, part := range packageParts {
+		packageParts[i] = xstrings.ToPascalCase(part)
+	}
+	// We add a "_" as the suffix since this emulates the default behavior if swift_prefix
+	// is not set.
+	return strings.Join(packageParts, "_") + "_"
+}