feat(csharp): Generate version constant file (#4424)

Author: amckinney

generators/csharp/codegen/src/ast/Field.ts

@@ -12,6 +12,10 @@ export declare namespace Field {
         name: string;
         /* The type of the field */
         type: Type;
+        /* The access level of the method */
+        access: Access;
+        /* Whether the the field is a constant value */
+        const_?: boolean;
         /* Whether the the field should use the new keyword */
         new_?: boolean;
         /* Whether the field has a getter method */
@@ -20,8 +24,6 @@ export declare namespace Field {
         init?: boolean;
         /* Whether the field has an set method. Cannot be used with an init method. */
         set?: boolean;
-        /* The access level of the method */
-        access: Access;
         /* Whether the field is static */
         static_?: boolean;
         /* Field annotations */
@@ -43,6 +45,7 @@ export class Field extends AstNode {
     public readonly name: string;
     public readonly access: Access;
     private type: Type;
+    private const_: boolean;
     private new_: boolean;
     private get: boolean;
     private init: boolean;
@@ -58,11 +61,12 @@ export class Field extends AstNode {
     constructor({
         name,
         type,
+        access,
+        const_,
         new_,
         get,
         init,
         set,
-        access,
         annotations,
         initializer,
         summary,
@@ -74,6 +78,7 @@ export class Field extends AstNode {
         super();
         this.name = name;
         this.type = type;
+        this.const_ = const_ ?? false;
         this.new_ = new_ ?? false;
         this.get = get ?? false;
         this.init = init ?? false;
@@ -119,6 +124,9 @@ export class Field extends AstNode {
         }
 
         writer.write(`${this.access} `);
+        if (this.const_) {
+            writer.write("const ");
+        }
         if (this.new_) {
             writer.write("new ");
         }

generators/csharp/codegen/src/context/AbstractCsharpGeneratorContext.ts

@@ -79,6 +79,10 @@ export abstract class AbstractCsharpGeneratorContext<
         return `${this.namespace}.Core`;
     }
 
+    public getPublicCoreNamespace(): string {
+        return this.getNamespace();
+    }
+
     public getTestNamespace(): string {
         return `${this.namespace}.Test`;
     }
@@ -91,6 +95,15 @@ export abstract class AbstractCsharpGeneratorContext<
         return `${this.getTestNamespace()}.Unit.MockServer`;
     }
 
+    public getVersion(): string | undefined {
+        return this.config.output?.mode._visit({
+            downloadFiles: () => undefined,
+            github: (github) => github.version,
+            publish: (publish) => publish.version,
+            _other: () => undefined
+        });
+    }
+
     public hasGrpcEndpoints(): boolean {
         // TODO: Replace this with the this.ir.sdkConfig.hasGrpcEndpoints property (when available).
         return Object.values(this.ir.services).some((service) => service.transport?.type === "grpc");
@@ -185,6 +198,25 @@ export abstract class AbstractCsharpGeneratorContext<
         });
     }
 
+    public getVersionClassReference(): csharp.ClassReference {
+        return csharp.classReference({
+            name: "Version",
+            namespace: this.getPublicCoreNamespace()
+        });
+    }
+
+    public getCurrentVersionValueAccess(): csharp.CodeBlock {
+        return csharp.codeblock((writer) => {
+            writer.writeNode(this.getVersionClassReference());
+            writer.write(".");
+            writer.write(this.getCurrentVersionPropertyName());
+        });
+    }
+
+    public getCurrentVersionPropertyName(): string {
+        return "Current";
+    }
+
     public getCollectionItemSerializerReference(
         itemType: csharp.ClassReference,
         serializer: csharp.ClassReference

generators/csharp/codegen/src/project/CsharpProject.ts

@@ -151,12 +151,7 @@ export class CsharpProject {
         const protobufSourceFilePaths = await this.sourceFetcher.copyProtobufSources(absolutePathToProtoDirectory);
 
         const csproj = new CsProj({
-            version: this.context.config.output?.mode._visit({
-                downloadFiles: () => undefined,
-                github: (github) => github.version,
-                publish: (publish) => publish.version,
-                _other: () => undefined
-            }),
+            version: this.context.getVersion(),
             license: this.context.config.license?._visit({
                 custom: (val) => {
                     return val.filename;

generators/csharp/model/src/ModelGeneratorCli.ts

@@ -3,6 +3,7 @@ import { FernGeneratorExec, GeneratorNotificationService } from "@fern-api/gener
 import { IntermediateRepresentation } from "@fern-fern/ir-sdk/api";
 import { generateModels } from "./generateModels";
 import { generateWellKnownProtobufFiles } from "./generateWellKnownProtobufFiles";
+import { generateVersion } from "./generateVersion";
 import { ModelCustomConfigSchema } from "./ModelCustomConfig";
 import { ModelGeneratorContext } from "./ModelGeneratorContext";
 
@@ -51,12 +52,16 @@ export class ModelGeneratorCLI extends AbstractCsharpGeneratorCli<ModelCustomCon
         for (const file of generatedTypes) {
             context.project.addSourceFiles(file);
         }
+
+        context.project.addSourceFiles(generateVersion({ context }));
+
         const protobufFiles = generateWellKnownProtobufFiles(context);
         if (protobufFiles != null) {
             for (const file of protobufFiles) {
                 context.project.addSourceFiles(file);
             }
         }
+
         await context.project.persist();
     }
 }

generators/csharp/model/src/generateVersion.ts

@@ -0,0 +1,8 @@
+import { CSharpFile } from "@fern-api/csharp-codegen";
+import { ModelGeneratorContext } from "./ModelGeneratorContext";
+import { VersionGenerator } from "./version/VersionGenerator";
+
+export function generateVersion({ context }: { context: ModelGeneratorContext }): CSharpFile {
+    const versionGenerator = new VersionGenerator(context);
+    return versionGenerator.generate();
+}

generators/csharp/model/src/index.ts

@@ -1,6 +1,7 @@
 export { generateModels } from "./generateModels";
 export { generateModelTests as generateTests } from "./generateTests";
 export { generateWellKnownProtobufFiles } from "./generateWellKnownProtobufFiles";
+export { generateVersion } from "./generateVersion";
 export * from "./ModelGeneratorCli";
 export { ExampleGenerator } from "./snippets/ExampleGenerator";
 export { getUndiscriminatedUnionSerializerAnnotation } from "./undiscriminated-union/getUndiscriminatedUnionSerializerAnnotation";

generators/csharp/model/src/version/VersionGenerator.ts

@@ -0,0 +1,49 @@
+import { csharp, CSharpFile, FileGenerator } from "@fern-api/csharp-codegen";
+import { join, RelativeFilePath } from "@fern-api/fs-utils";
+import { ModelCustomConfigSchema } from "../ModelCustomConfig";
+import { ModelGeneratorContext } from "../ModelGeneratorContext";
+
+const DEFAULT_VERSION = "0.0.0";
+
+export class VersionGenerator extends FileGenerator<CSharpFile, ModelCustomConfigSchema, ModelGeneratorContext> {
+    private classReference: csharp.ClassReference;
+
+    constructor(context: ModelGeneratorContext) {
+        super(context);
+        this.classReference = this.context.getVersionClassReference();
+    }
+
+    public doGenerate(): CSharpFile {
+        const class_ = csharp.class_({
+            ...this.classReference,
+            partial: false,
+            access: "internal"
+        });
+
+        class_.addField(
+            csharp.field({
+                name: this.context.getCurrentVersionPropertyName(),
+                type: csharp.Type.string(),
+                access: "public",
+                const_: true,
+                initializer: csharp.codeblock(`"${this.context.getVersion() ?? DEFAULT_VERSION}"`)
+            })
+        );
+
+        return new CSharpFile({
+            clazz: class_,
+            directory: this.context.getPublicCoreDirectory(),
+            allNamespaceSegments: this.context.getAllNamespaceSegments(),
+            allTypeClassReferences: this.context.getAllTypeClassReferences(),
+            namespace: this.context.getPublicCoreNamespace(),
+            customConfig: this.context.customConfig
+        });
+    }
+
+    protected getFilepath(): RelativeFilePath {
+        return join(
+            this.context.project.filepaths.getPublicCoreFilesDirectory(),
+            RelativeFilePath.of(this.classReference.name + ".cs")
+        );
+    }
+}

generators/csharp/sdk/CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.0] - 2024-08-26
+
+- Improvement: Generate an internal `Version` class that can be used to reference the current version.
+  This is useful for users that wrap the generated base client so that it's easier to keep the version
+  in-sync across releases. For example, consider the following custom `User-Agent` header:
+
+  ```csharp
+  var defaultHeaders = new Headers()
+  {
+      ...
+      ["User-Agent"] = $"lang=C#; version={Version.Current}"
+  };
+  ```
+
 ## [1.3.0] - 2024-08-22
 
 - No changes.

generators/csharp/sdk/VERSION

@@ -1 +1 @@
-1.3.0
+1.4.0

generators/csharp/sdk/src/SdkGeneratorCli.ts

@@ -2,7 +2,8 @@ import { AbstractCsharpGeneratorCli, TestFileGenerator, validateReadOnlyMemoryTy
 import {
     generateModels,
     generateTests as generateModelTests,
-    generateWellKnownProtobufFiles
+    generateWellKnownProtobufFiles,
+    generateVersion
 } from "@fern-api/fern-csharp-model";
 import { GeneratorNotificationService } from "@fern-api/generator-commons";
 import { FernGeneratorExec } from "@fern-fern/generator-exec-sdk";
@@ -96,6 +97,9 @@ export class SdkGeneratorCLI extends AbstractCsharpGeneratorCli<SdkCustomConfigS
         for (const file of models) {
             context.project.addSourceFiles(file);
         }
+
+        context.project.addSourceFiles(generateVersion({ context }));
+
         if (context.config.writeUnitTests) {
             const modelTests = generateModelTests({ context });
             for (const file of modelTests) {