feat(go): Add inlineFileProperties configuration (#5202)

generators/go/cmd/fern-go-fiber/main.go

@@ -29,6 +29,7 @@ func run(config *cmd.Config, coordinator *coordinator.Client) ([]*generator.File
 		includeReadme,
 		config.Whitelabel,
 		config.AlwaysSendRequiredProperties,
+		config.InlineFileProperties,
 		config.Organization,
 		config.Version,
 		config.IrFilepath,

generators/go/cmd/fern-go-model/main.go

@@ -29,6 +29,7 @@ func run(config *cmd.Config, coordinator *coordinator.Client) ([]*generator.File
 		includeReadme,
 		config.Whitelabel,
 		config.AlwaysSendRequiredProperties,
+		config.InlineFileProperties,
 		config.Organization,
 		config.Version,
 		config.IrFilepath,

generators/go/cmd/fern-go-sdk/main.go

@@ -29,6 +29,7 @@ func run(config *cmd.Config, coordinator *coordinator.Client) ([]*generator.File
 		includeReadme,
 		config.Whitelabel,
 		config.AlwaysSendRequiredProperties,
+		config.InlineFileProperties,
 		config.Organization,
 		config.Version,
 		config.IrFilepath,

generators/go/internal/cmd/cmd.go

@@ -56,6 +56,7 @@ type Config struct {
 	IncludeLegacyClientOptions   bool
 	Whitelabel                   bool
 	AlwaysSendRequiredProperties bool
+	InlineFileProperties         bool
 	Organization                 string
 	CoordinatorURL               string
 	CoordinatorTaskID            string
@@ -200,6 +201,7 @@ func newConfig(configFilename string) (*Config, error) {
 
 	return &Config{
 		DryRun:                       config.DryRun,
+		InlineFileProperties:         customConfig.InlineFileProperties,
 		IncludeLegacyClientOptions:   customConfig.IncludeLegacyClientOptions,
 		EnableExplicitNull:           customConfig.EnableExplicitNull,
 		Organization:                 config.Organization,
@@ -255,6 +257,7 @@ func readConfig(configFilename string) (*generatorexec.GeneratorConfig, error) {
 
 type customConfig struct {
 	EnableExplicitNull           bool          `json:"enableExplicitNull,omitempty"`
+	InlineFileProperties         bool          `json:"inlineFileProperties,omitempty"`
 	IncludeLegacyClientOptions   bool          `json:"includeLegacyClientOptions,omitempty"`
 	AlwaysSendRequiredProperties bool          `json:"alwaysSendRequiredProperties,omitempty"`
 	ImportPath                   string        `json:"importPath,omitempty"`

generators/go/internal/generator/config.go

@@ -20,6 +20,7 @@ type Config struct {
 	IncludeReadme                bool
 	Whitelabel                   bool
 	AlwaysSendRequiredProperties bool
+	InlineFileProperties         bool
 	Organization                 string
 	Version                      string
 	IRFilepath                   string
@@ -57,6 +58,7 @@ func NewConfig(
 	includeReadme bool,
 	whitelabel bool,
 	alwaysSendRequiredProperties bool,
+	inlineFileProperties bool,
 	organization string,
 	version string,
 	irFilepath string,
@@ -79,6 +81,7 @@ func NewConfig(
 		Organization:                 organization,
 		Whitelabel:                   whitelabel,
 		AlwaysSendRequiredProperties: alwaysSendRequiredProperties,
+		InlineFileProperties:         inlineFileProperties,
 		Version:                      version,
 		IRFilepath:                   irFilepath,
 		SnippetFilepath:              snippetFilepath,

generators/go/internal/generator/fiber.go

@@ -70,7 +70,7 @@ func (f *fileWriter) WriteFiberRequestType(fernFilepath *ir.FernFilepath, endpoi
 		}
 		return nil
 	}
-	requestBody, err := requestBodyToFieldDeclaration(endpoint.RequestBody, f, importPath, bodyField, includeGenericOptionals)
+	requestBody, err := requestBodyToFieldDeclaration(endpoint.RequestBody, f, importPath, bodyField, includeGenericOptionals, false /* inlineFileProperties */)
 	if err != nil {
 		return err
 	}

generators/go/internal/generator/file_writer.go

@@ -33,6 +33,7 @@ type fileWriter struct {
 	baseImportPath               string
 	whitelabel                   bool
 	alwaysSendRequiredProperties bool
+	inlineFileProperties         bool
 	unionVersion                 UnionVersion
 	scope                        *gospec.Scope
 	types                        map[ir.TypeId]*ir.TypeDeclaration
@@ -49,6 +50,7 @@ func newFileWriter(
 	baseImportPath string,
 	whitelabel bool,
 	alwaysSendRequiredProperties bool,
+	inlineFileProperties bool,
 	unionVersion UnionVersion,
 	types map[ir.TypeId]*ir.TypeDeclaration,
 	errors map[ir.ErrorId]*ir.ErrorDeclaration,
@@ -89,6 +91,7 @@ func newFileWriter(
 		baseImportPath:               baseImportPath,
 		whitelabel:                   whitelabel,
 		alwaysSendRequiredProperties: alwaysSendRequiredProperties,
+		inlineFileProperties:         inlineFileProperties,
 		unionVersion:                 unionVersion,
 		scope:                        scope,
 		types:                        types,
@@ -125,6 +128,7 @@ func (f *fileWriter) File() (*File, error) {
 
 	formatted, err := removeUnusedImports(f.filename, append(header.buffer.Bytes(), f.buffer.Bytes()...))
 	if err != nil {
+		fmt.Println(string(append(header.buffer.Bytes(), f.buffer.Bytes()...)))
 		return nil, err
 	}
 
@@ -163,6 +167,7 @@ func (f *fileWriter) clone() *fileWriter {
 		f.baseImportPath,
 		f.whitelabel,
 		f.alwaysSendRequiredProperties,
+		f.inlineFileProperties,
 		f.unionVersion,
 		f.types,
 		f.errors,

generators/go/internal/generator/generator.go

@@ -132,7 +132,7 @@ func (g *Generator) Generate(mode Mode) ([]*File, error) {
 }
 
 func (g *Generator) generateModelTypes(ir *fernir.IntermediateRepresentation, mode Mode, rootPackageName string) ([]*File, error) {
-	fileInfoToTypes, err := fileInfoToTypes(rootPackageName, ir.Types, ir.Services, ir.ServiceTypeReferenceInfo)
+	fileInfoToTypes, err := fileInfoToTypes(rootPackageName, ir.Types, ir.Services, ir.ServiceTypeReferenceInfo, g.config.InlineFileProperties)
 	if err != nil {
 		return nil, err
 	}
@@ -144,6 +144,7 @@ func (g *Generator) generateModelTypes(ir *fernir.IntermediateRepresentation, mo
 			g.config.ImportPath,
 			g.config.Whitelabel,
 			g.config.AlwaysSendRequiredProperties,
+			g.config.InlineFileProperties,
 			g.config.UnionVersion,
 			ir.Types,
 			ir.Errors,
@@ -167,6 +168,7 @@ func (g *Generator) generateModelTypes(ir *fernir.IntermediateRepresentation, mo
 						typeToGenerate.Service.Headers,
 						ir.IdempotencyHeaders,
 						g.config.EnableExplicitNull,
+						g.config.InlineFileProperties,
 					); err != nil {
 						return nil, err
 					}
@@ -251,6 +253,7 @@ func (g *Generator) generate(ir *fernir.IntermediateRepresentation, mode Mode) (
 			"",
 			g.config.Whitelabel,
 			g.config.AlwaysSendRequiredProperties,
+			g.config.InlineFileProperties,
 			g.config.UnionVersion,
 			nil,
 			nil,
@@ -270,6 +273,7 @@ func (g *Generator) generate(ir *fernir.IntermediateRepresentation, mode Mode) (
 			"",
 			g.config.Whitelabel,
 			g.config.AlwaysSendRequiredProperties,
+			g.config.InlineFileProperties,
 			g.config.UnionVersion,
 			nil,
 			nil,
@@ -312,6 +316,7 @@ func (g *Generator) generate(ir *fernir.IntermediateRepresentation, mode Mode) (
 			g.config.ImportPath,
 			g.config.Whitelabel,
 			g.config.AlwaysSendRequiredProperties,
+			g.config.InlineFileProperties,
 			g.config.UnionVersion,
 			ir.Types,
 			ir.Errors,
@@ -341,6 +346,7 @@ func (g *Generator) generate(ir *fernir.IntermediateRepresentation, mode Mode) (
 				g.config.ImportPath,
 				g.config.Whitelabel,
 				g.config.AlwaysSendRequiredProperties,
+				g.config.InlineFileProperties,
 				g.config.UnionVersion,
 				ir.Types,
 				ir.Errors,
@@ -364,6 +370,7 @@ func (g *Generator) generate(ir *fernir.IntermediateRepresentation, mode Mode) (
 			g.config.ImportPath,
 			g.config.Whitelabel,
 			g.config.AlwaysSendRequiredProperties,
+			g.config.InlineFileProperties,
 			g.config.UnionVersion,
 			ir.Types,
 			ir.Errors,
@@ -392,6 +399,7 @@ func (g *Generator) generate(ir *fernir.IntermediateRepresentation, mode Mode) (
 				g.config.ImportPath,
 				g.config.Whitelabel,
 				g.config.AlwaysSendRequiredProperties,
+				g.config.InlineFileProperties,
 				g.config.UnionVersion,
 				ir.Types,
 				ir.Errors,
@@ -412,6 +420,7 @@ func (g *Generator) generate(ir *fernir.IntermediateRepresentation, mode Mode) (
 				g.config.ImportPath,
 				g.config.Whitelabel,
 				g.config.AlwaysSendRequiredProperties,
+				g.config.InlineFileProperties,
 				g.config.UnionVersion,
 				ir.Types,
 				ir.Errors,
@@ -435,6 +444,7 @@ func (g *Generator) generate(ir *fernir.IntermediateRepresentation, mode Mode) (
 				g.config.ImportPath,
 				g.config.Whitelabel,
 				g.config.AlwaysSendRequiredProperties,
+				g.config.InlineFileProperties,
 				g.config.UnionVersion,
 				ir.Types,
 				ir.Errors,
@@ -457,6 +467,7 @@ func (g *Generator) generate(ir *fernir.IntermediateRepresentation, mode Mode) (
 			g.config.ImportPath,
 			g.config.Whitelabel,
 			g.config.AlwaysSendRequiredProperties,
+			g.config.InlineFileProperties,
 			g.config.UnionVersion,
 			ir.Types,
 			ir.Errors,
@@ -480,13 +491,15 @@ func (g *Generator) generate(ir *fernir.IntermediateRepresentation, mode Mode) (
 		files = append(files, newFileParamFile(g.coordinator, rootPackageName, generatedNames))
 		files = append(files, newHttpCoreFile(g.coordinator))
 		files = append(files, newHttpInternalFile(g.coordinator))
-		files = append(files, newMultipartFile(g.coordinator))
-		files = append(files, newMultipartTestFile(g.coordinator))
 		files = append(files, newPointerFile(g.coordinator, rootPackageName, generatedNames))
 		files = append(files, newQueryFile(g.coordinator))
 		files = append(files, newQueryTestFile(g.coordinator))
 		files = append(files, newRetrierFile(g.coordinator, g.config.ImportPath))
 		files = append(files, newRetrierTestFile(g.coordinator, g.config.ImportPath))
+		if needsFileUploadHelpers(ir) {
+			files = append(files, newMultipartFile(g.coordinator))
+			files = append(files, newMultipartTestFile(g.coordinator))
+		}
 		if ir.SdkConfig.HasStreamingEndpoints {
 			files = append(files, newStreamFile(g.coordinator))
 			files = append(files, newStreamerFile(g.coordinator, g.config.ImportPath))
@@ -508,6 +521,7 @@ func (g *Generator) generate(ir *fernir.IntermediateRepresentation, mode Mode) (
 				g.config.ImportPath,
 				g.config.Whitelabel,
 				g.config.AlwaysSendRequiredProperties,
+				g.config.InlineFileProperties,
 				g.config.UnionVersion,
 				ir.Types,
 				ir.Errors,
@@ -661,6 +675,7 @@ func (g *Generator) generateService(
 		g.config.ImportPath,
 		g.config.Whitelabel,
 		g.config.AlwaysSendRequiredProperties,
+		g.config.InlineFileProperties,
 		g.config.UnionVersion,
 		ir.Types,
 		ir.Errors,
@@ -677,6 +692,7 @@ func (g *Generator) generateService(
 		ir.ErrorDiscriminationStrategy,
 		originalFernFilepath,
 		rootClientInstantiation,
+		g.config.InlineFileProperties,
 	)
 	if err != nil {
 		return nil, nil, err
@@ -705,6 +721,7 @@ func (g *Generator) generateServiceWithoutEndpoints(
 		g.config.ImportPath,
 		g.config.Whitelabel,
 		g.config.AlwaysSendRequiredProperties,
+		g.config.InlineFileProperties,
 		g.config.UnionVersion,
 		ir.Types,
 		ir.Errors,
@@ -721,6 +738,7 @@ func (g *Generator) generateServiceWithoutEndpoints(
 		ir.ErrorDiscriminationStrategy,
 		originalFernFilepath,
 		rootClientInstantiation,
+		g.config.InlineFileProperties,
 	); err != nil {
 		return nil, err
 	}
@@ -743,6 +761,7 @@ func (g *Generator) generateRootServiceWithoutEndpoints(
 		g.config.ImportPath,
 		g.config.Whitelabel,
 		g.config.AlwaysSendRequiredProperties,
+		g.config.InlineFileProperties,
 		g.config.UnionVersion,
 		ir.Types,
 		ir.Errors,
@@ -759,6 +778,7 @@ func (g *Generator) generateRootServiceWithoutEndpoints(
 		ir.ErrorDiscriminationStrategy,
 		fernFilepath,
 		rootClientInstantiation,
+		g.config.InlineFileProperties,
 	)
 	if err != nil {
 		return nil, nil, err
@@ -995,6 +1015,7 @@ func newClientTestFile(
 		baseImportPath,
 		false,
 		false,
+		false,
 		UnionVersionUnspecified,
 		nil,
 		nil,
@@ -1352,12 +1373,12 @@ func generatedPackagesFromIR(ir *fernir.IntermediateRepresentation) map[string]s
 }
 
 // shouldSkipRequestType returns true if the request type should not be generated.
-func shouldSkipRequestType(irEndpoint *fernir.HttpEndpoint) bool {
+func shouldSkipRequestType(irEndpoint *fernir.HttpEndpoint, inlineFileProperties bool) bool {
 	if irEndpoint.SdkRequest == nil || irEndpoint.SdkRequest.Shape == nil || irEndpoint.SdkRequest.Shape.Wrapper == nil {
 		// This endpoint doesn't have any in-lined request types that need to be generated.
 		return true
 	}
-	return !needsRequestParameter(irEndpoint)
+	return !needsRequestParameter(irEndpoint, inlineFileProperties)
 }
 
 // fileUploadHasBodyProperties returns true if the file upload request has at least
@@ -1376,6 +1397,22 @@ func fileUploadHasBodyProperties(fileUpload *fernir.FileUploadRequest) bool {
 	return false
 }
 
+// fileUploadHasFileProperties returns true if the file upload request has at least
+// one file property.
+func fileUploadHasFileProperties(fileUpload *fernir.FileUploadRequest) bool {
+	if fileUpload == nil {
+		return false
+	}
+	// If this request is a file upload, there must be at least one body property
+	// in order for us to generate the in-lined request type.
+	for _, property := range fileUpload.Properties {
+		if property.File != nil {
+			return true
+		}
+	}
+	return false
+}
+
 func packagePathForDocs(fernFilepath *fernir.FernFilepath) []string {
 	var packages []string
 	for _, packageName := range fernFilepath.PackagePath {
@@ -1416,11 +1453,12 @@ func fileInfoToTypes(
 	irTypes map[fernir.TypeId]*fernir.TypeDeclaration,
 	irServices map[fernir.ServiceId]*fernir.HttpService,
 	irServiceTypeReferenceInfo *fernir.ServiceTypeReferenceInfo,
+	inlineFileProperties bool,
 ) (map[fileInfo][]*typeToGenerate, error) {
 	result := make(map[fileInfo][]*typeToGenerate)
 	for _, irService := range irServices {
 		for _, irEndpoint := range irService.Endpoints {
-			if shouldSkipRequestType(irEndpoint) {
+			if shouldSkipRequestType(irEndpoint, inlineFileProperties) {
 				continue
 			}
 			fileInfo := fileInfoForType(rootPackageName, irService.Name.FernFilepath)
@@ -1677,6 +1715,18 @@ func needsPaginationHelpers(ir *fernir.IntermediateRepresentation) bool {
 	return false
 }
 
+// needsFileUploadHelpers returns true if at least endpoint specifies a file upload.
+func needsFileUploadHelpers(ir *fernir.IntermediateRepresentation) bool {
+	for _, irService := range ir.Services {
+		for _, irEndpoint := range irService.Endpoints {
+			if irEndpoint.RequestBody != nil && irEndpoint.RequestBody.FileUpload != nil {
+				return true
+			}
+		}
+	}
+	return false
+}
+
 func isReservedFilename(filename string) bool {
 	_, ok := reservedFilenames[filename]
 	return ok