feat(go): Add support for User-Agent header (#5398)

fern/pages/changelogs/go-sdk/2024-12-12.mdx

@@ -0,0 +1,4 @@
+## 0.34.0
+**`(feat):`** Add support for sending the `User-Agent` header on every request. Go packages are uniquely identified by their full module path, so the `User-Agent` header is generated in the `<module>/<version>` format, e.g.
+``` User-Agent: github.com/acme/acme-go/1.0.0 ```
+

generators/browser-compatible-base/src/utils/getSdkVersion.ts

@@ -10,32 +10,3 @@ export function getSdkVersion(config: FernGeneratorExec.GeneratorConfig): string
         }
     });
 }
-
-export function getPackageName(config: FernGeneratorExec.GeneratorConfig): string | undefined {
-    return config.output.mode._visit<string | undefined>({
-        publish: (gpc: FernGeneratorExec.GeneratorPublishConfig) =>
-            gpc.publishTarget?._visit({
-                maven: (mrc: FernGeneratorExec.MavenRegistryConfigV2) => mrc.coordinate,
-                npm: (nrc: FernGeneratorExec.NpmRegistryConfigV2) => nrc.packageName,
-                pypi: (prc: FernGeneratorExec.PypiRegistryConfig) => prc.packageName,
-                rubygems: (rgrc: FernGeneratorExec.RubyGemsRegistryConfig) => rgrc.packageName,
-                nuget: (nrc: FernGeneratorExec.NugetRegistryConfig) => nrc.packageName,
-                postman: () => undefined,
-                _other: () => undefined
-            }),
-        downloadFiles: () => undefined,
-        github: (gom: FernGeneratorExec.GithubOutputMode) =>
-            gom.publishInfo?._visit({
-                maven: (mrc: FernGeneratorExec.MavenGithubPublishInfo) => mrc.coordinate,
-                npm: (nrc: FernGeneratorExec.NpmGithubPublishInfo) => nrc.packageName,
-                pypi: (prc: FernGeneratorExec.PypiGithubPublishInfo) => prc.packageName,
-                rubygems: (rgrc: FernGeneratorExec.RubyGemsGithubPublishInfo) => rgrc.packageName,
-                nuget: (nrc: FernGeneratorExec.NugetGithubPublishInfo) => nrc.packageName,
-                postman: () => undefined,
-                _other: () => undefined
-            }),
-        _other: () => {
-            throw new Error("Unrecognized output mode.");
-        }
-    });
-}

generators/go/internal/generator/sdk.go

@@ -496,6 +496,9 @@ func (f *fileWriter) writePlatformHeaders(
 		f.P(fmt.Sprintf("headers.Set(%q, %q)", sdkConfig.PlatformHeaders.Language, goLanguageHeader))
 		f.P(fmt.Sprintf("headers.Set(%q, %q)", sdkConfig.PlatformHeaders.SdkName, moduleConfig.Path))
 		f.P(fmt.Sprintf("headers.Set(%q, %q)", sdkConfig.PlatformHeaders.SdkVersion, sdkVersion))
+		if sdkConfig.PlatformHeaders.UserAgent != nil {
+			f.P(fmt.Sprintf("headers.Set(%q, %q)", sdkConfig.PlatformHeaders.UserAgent.Header(), sdkConfig.PlatformHeaders.UserAgent.Value))
+		}
 		f.P("return headers")
 		f.P("}")
 	}

generators/go/sdk/versions.yml

@@ -1,3 +1,15 @@
+- version: 0.34.0
+  changelogEntry:
+    - type: feat
+      summary: >-
+        Add support for sending the `User-Agent` header on every request. Go packages
+        are uniquely identified by their full module path, so the `User-Agent` header
+        is generated in the `<module>/<version>` format, e.g.
+
+        ```
+        User-Agent: github.com/acme/acme-go/1.0.0
+        ```
+  irVersion: 53
 - version: 0.33.0
   changelogEntry:
     - type: feat

packages/cli/cli/versions.yml

@@ -1,3 +1,10 @@
+- changelogEntry:
+    - summary: |
+        Add support for setting the `User-Agent` header value for Go generators.
+      type: fix
+  irVersion: 53
+  version: 0.46.1
+
 - changelogEntry:
     - summary: |
         No changes; promote `0.46.0-rc1` release candidate to minor version.

packages/cli/configuration-loader/src/generators-yml/convertGeneratorsConfiguration.ts

@@ -752,6 +752,7 @@ async function getGithubLicense({
     });
 }
 
+// TODO: This is where we should add support for Go and PHP.
 function getGithubPublishInfo(
     output: generatorsYml.GeneratorOutputSchema,
     maybeGroupLevelMetadata: OutputMetadata | undefined,

packages/cli/configuration/src/generators-yml/GeneratorsConfiguration.ts

@@ -137,6 +137,9 @@ export function getPackageName({
 }: {
     generatorInvocation: GeneratorInvocation;
 }): string | undefined {
+    if (generatorInvocation.language === "go") {
+        return getGoPackageName(generatorInvocation);
+    }
     return generatorInvocation.outputMode._visit<string | undefined>({
         downloadFiles: () => undefined,
         github: (val) =>
@@ -164,3 +167,18 @@ export function getPackageName({
         _other: () => undefined
     });
 }
+
+/**
+ * Go doesn't use a central package manager; the Go Module Proxy simply uses the name
+ * of the GitHub repository.
+ */
+function getGoPackageName(generatorInvocation: GeneratorInvocation): string | undefined {
+    return generatorInvocation.outputMode._visit<string | undefined>({
+        downloadFiles: () => undefined,
+        github: (val) => `github.com/${val.owner}/${val.repo}`,
+        githubV2: (val) => `github.com/${val.owner}/${val.repo}`,
+        publish: () => undefined,
+        publishV2: () => undefined,
+        _other: () => undefined
+    });
+}