[tcgc] Fix generated name (#444)

Azure · Mar 19, 2024 · 7bdf1b7 · 7bdf1b7
1 parent 42f95a3
commit 7bdf1b7
Show file tree

Hide file tree

Showing 8 changed files with 467 additions and 315 deletions.
diff --git a/.chronus/changes/fix_generated_name-2024-2-19-14-44-7.md b/.chronus/changes/fix_generated_name-2024-2-19-14-44-7.md
@@ -0,0 +1,7 @@
+---
+changeKind: breaking
+packages:
+  - "@azure-tools/typespec-client-generator-core"
+---
+
+SdkUnionType, SdkEnumType, and SdkModelType will now always have a `.name` property. `.generatedName` is now a boolean that expresses whether the `.name` was generated or described in the tsp
diff --git a/packages/typespec-client-generator-core/src/interfaces.ts b/packages/typespec-client-generator-core/src/interfaces.ts
@@ -223,7 +223,7 @@ export interface SdkDictionaryType extends SdkTypeBase {
 export interface SdkEnumType extends SdkTypeBase {
   kind: "enum";
   name: string;
-  generatedName?: string;
+  generatedName: boolean;
   valueType: SdkBuiltInType;
   values: SdkEnumValueType[];
   isFixed: boolean;
@@ -252,8 +252,8 @@ export interface SdkConstantType extends SdkTypeBase {
 }
 
 export interface SdkUnionType extends SdkTypeBase {
-  name?: string;
-  generatedName?: string;
+  name: string;
+  generatedName: boolean;
   kind: "union";
   values: SdkType[];
 }
@@ -266,7 +266,7 @@ export interface SdkModelType extends SdkTypeBase {
   name: string;
   isFormDataType: boolean;
   isError: boolean;
-  generatedName?: string;
+  generatedName: boolean;
   description?: string;
   details?: string;
   access?: AccessFlags;

diff --git a/packages/typespec-client-generator-core/src/internal-utils.ts b/packages/typespec-client-generator-core/src/internal-utils.ts
@@ -21,7 +21,11 @@ import {
   SdkType,
   SdkUnionType,
 } from "./interfaces.js";
-import { getHttpOperationWithCache, isApiVersion } from "./public-utils.js";
+import {
+  getCrossLanguageDefinitionId,
+  getHttpOperationWithCache,
+  isApiVersion,
+} from "./public-utils.js";
 
 /**
  *
@@ -241,3 +245,13 @@ export function createTCGCContext(program: Program): TCGCContext {
     emitterName: "__TCGC_INTERNAL__",
   };
 }
+
+/**
+ * Use this if you are trying to create a generated name for something without an original TypeSpec type.
+ *
+ * Otherwise, you should use the `getGeneratedName` function.
+ * @param context
+ */
+export function createGeneratedName(type: Namespace | Operation, suffix: string): string {
+  return `${getCrossLanguageDefinitionId(type).split(".").at(-1)}${suffix}`;
+}
diff --git a/packages/typespec-client-generator-core/src/package.ts b/packages/typespec-client-generator-core/src/package.ts
@@ -48,6 +48,7 @@ import {
   UsageFlags,
 } from "./interfaces.js";
 import {
+  createGeneratedName,
   getAvailableApiVersions,
   getClientNamespaceStringHelper,
   getDocHelper,
@@ -396,6 +397,8 @@ function getSdkMethodResponse(
       kind: "union",
       values: allResponseBodies,
       nullable,
+      name: createGeneratedName(operation, "UnionResponse"),
+      generatedName: true,
     };
   } else if (responseTypes) {
     type = allResponseBodies[0];
@@ -740,6 +743,7 @@ function getSdkInitializationType<
     kind: "model",
     properties,
     name,
+    generatedName: true,
     access: "public",
     usage: UsageFlags.Input,
     nullable: false,

diff --git a/packages/typespec-client-generator-core/src/types.ts b/packages/typespec-client-generator-core/src/types.ts
@@ -88,6 +88,7 @@ import {
   isSdkBuiltInKind,
 } from "./interfaces.js";
 import {
+  createGeneratedName,
   getAvailableApiVersions,
   getDocHelper,
   getSdkTypeBaseHelper,
@@ -362,8 +363,8 @@ export function getSdkUnionWithDiagnostics(
 
   return diagnostics.wrap({
     ...getSdkTypeBaseHelper(context, type, "union"),
-    name: getLibraryName(context, type),
-    generatedName: type.name ? undefined : getGeneratedName(context, type),
+    name: getLibraryName(context, type) || getGeneratedName(context, type),
+    generatedName: !type.name,
     values: nonNullOptions.map((x) =>
       diagnostics.pipe(getClientTypeWithDiagnostics(context, x, operation))
     ),
@@ -521,8 +522,8 @@ export function getSdkModelWithDiagnostics(
     const docWrapper = getDocHelper(context, type);
     sdkType = {
       ...getSdkTypeBaseHelper(context, type, "model"),
-      name: getLibraryName(context, type),
-      generatedName: type.name === "" ? getGeneratedName(context, type) : undefined,
+      name: getLibraryName(context, type) || getGeneratedName(context, type),
+      generatedName: !type.name,
       description: docWrapper.description,
       details: docWrapper.details,
       properties: [],
@@ -635,6 +636,7 @@ export function getSdkEnum(context: TCGCContext, type: Enum, operation?: Operati
     sdkType = {
       ...getSdkTypeBaseHelper(context, type, "enum"),
       name: getLibraryName(context, type),
+      generatedName: false,
       description: docWrapper.description,
       details: docWrapper.details,
       valueType: getSdkEnumValueType(context, type.members.values()),
@@ -684,8 +686,8 @@ function getSdkUnionEnum(context: TCGCContext, type: UnionEnum, operation?: Oper
     const docWrapper = getDocHelper(context, union);
     sdkType = {
       ...getSdkTypeBaseHelper(context, type.union, "enum"),
-      name: getLibraryName(context, type.union),
-      generatedName: type.union.name ? undefined : getGeneratedName(context, type.union),
+      name: getLibraryName(context, type.union) || getGeneratedName(context, type.union),
+      generatedName: !type.union.name,
       description: docWrapper.description,
       details: docWrapper.details,
       valueType:
@@ -725,6 +727,7 @@ function getKnownValuesEnum(
       sdkType = {
         ...getSdkTypeBaseHelper(context, type, "enum"),
         name: getLibraryName(context, type),
+        generatedName: false,
         description: docWrapper.description,
         details: docWrapper.details,
         valueType: getSdkEnumValueType(context, knownValues.members.values()),
@@ -917,6 +920,8 @@ function getSdkCredentialType(
       kind: "union",
       values: credentialTypes,
       nullable: false,
+      name: createGeneratedName(client.service, "CredentialUnion"),
+      generatedName: false,
     };
   }
   return credentialTypes[0];