[tcgc] support generic type decorators in sdk types

.chronus/changes/decorators_list-2024-5-6-18-38-7.md

@@ -0,0 +1,7 @@
+---
+changeKind: feature
+packages:
+  - "@azure-tools/typespec-client-generator-core"
+---
+
+export decorators in white list to all sdk types

packages/typespec-client-generator-core/package.json

@@ -62,14 +62,16 @@
     "@typespec/compiler": "workspace:~",
     "@typespec/http": "workspace:~",
     "@typespec/rest": "workspace:~",
-    "@typespec/versioning": "workspace:~"
+    "@typespec/versioning": "workspace:~",
+    "@typespec/xml": "workspace:~"
   },
   "devDependencies": {
     "@azure-tools/typespec-azure-core": "workspace:~",
     "@types/node": "~18.11.19",
     "@types/pluralize": "^0.0.33",
     "@typespec/compiler": "workspace:~",
     "@typespec/http": "workspace:~",
+    "@typespec/xml": "workspace:~",
     "@typespec/library-linter": "workspace:~",
     "@typespec/prettier-plugin-typespec": "workspace:~",
     "@typespec/rest": "workspace:~",

packages/typespec-client-generator-core/src/configs.ts

@@ -0,0 +1 @@
+export const defaultDecoratorsWhiteList = ["TypeSpec\\.Xml\\..*"];

packages/typespec-client-generator-core/src/decorators.ts

@@ -29,6 +29,7 @@ import {
 } from "@typespec/compiler";
 import { isHeader } from "@typespec/http";
 import { buildVersionProjections, getVersions } from "@typespec/versioning";
+import { defaultDecoratorsWhiteList } from "./configs.js";
 import {
   AccessFlags,
   LanguageScopes,
@@ -313,6 +314,7 @@ export function listClients(context: TCGCContext): SdkClient[] {
 }
 
 const operationGroupKey = createStateSymbol("operationGroup");
+
 export function $operationGroup(
   context: DecoratorContext,
   target: Namespace | Interface,
@@ -412,6 +414,7 @@ function buildOperationGroupPath(context: TCGCContext, type: Namespace | Interfa
   }
   return path.reverse().join(".");
 }
+
 /**
  * Return the operation group object for the given namespace or interface or undefined is not an operation group.
  * @param context TCGCContext
@@ -570,9 +573,9 @@ export function listOperationsInOperationGroup(
   addOperations(group.type);
   return operations;
 }
-
-interface CreateSdkContextOptions {
+export interface CreateSdkContextOptions {
   readonly versionStrategy?: "ignore";
+  additionalDecorators?: string[];
 }
 
 export function createSdkContext<
@@ -607,6 +610,7 @@ export function createSdkContext<
     __namespaceToApiVersionParameter: new Map(),
     __tspTypeToApiVersions: new Map(),
     __namespaceToApiVersionClientDefaultValue: new Map(),
+    decoratorsWhiteList: [...defaultDecoratorsWhiteList, ...(options?.additionalDecorators ?? [])],
   };
   sdkContext.experimental_sdkPackage = getSdkPackage(sdkContext);
   if (sdkContext.diagnostics) {
@@ -706,6 +710,7 @@ function modelTransitiveSet(
 }
 
 const clientFormatKey = createStateSymbol("clientFormat");
+
 const allowedClientFormatToTargetTypeMap: Record<ClientFormat, string[]> = {
   unixtime: ["int32", "int64"],
   iso8601: ["utcDateTime", "offsetDateTime", "duration"],

packages/typespec-client-generator-core/src/http.ts

@@ -42,6 +42,7 @@ import {
   getAvailableApiVersions,
   getDocHelper,
   getLocationOfOperation,
+  getTypeDecorators,
   isAcceptHeader,
   isContentTypeHeader,
   isNeverOrVoidType,
@@ -166,6 +167,7 @@ function getSdkHttpParameters(
         optional: false,
         correspondingMethodParams,
         crossLanguageDefinitionId: `${getCrossLanguageDefinitionId(context, httpOperation.operation)}.body`,
+        decorators: diagnostics.pipe(getTypeDecorators(context, tspBody.type)),
       };
     }
     if (retval.bodyParam) {
@@ -234,6 +236,7 @@ function createContentTypeOrAcceptHeader(
   let type: SdkType = {
     kind: "string",
     encode: "string",
+    decorators: {},
   };
   // for contentType, we treat it as a constant IFF there's one value and it's application/json.
   // this is to prevent a breaking change when a service adds more content types in the future.
@@ -254,6 +257,7 @@ function createContentTypeOrAcceptHeader(
       valueType: type,
       name: `${httpOperation.operation.name}ContentType`,
       isGeneratedName: true,
+      decorators: {},
     };
   }
   // No need for clientDefaultValue because it's a constant, it only has one value
@@ -267,6 +271,7 @@ function createContentTypeOrAcceptHeader(
     onClient: false,
     optional: false,
     crossLanguageDefinitionId: `${getCrossLanguageDefinitionId(context, httpOperation.operation)}.${name}`,
+    decorators: {},
   };
 }
 

packages/typespec-client-generator-core/src/interfaces.ts

@@ -54,7 +54,8 @@ export interface SdkInitializationType extends SdkModelType {
   properties: SdkParameter[];
 }
 
-export interface SdkClientType<TServiceOperation extends SdkServiceOperation> {
+export interface SdkClientType<TServiceOperation extends SdkServiceOperation>
+  extends DecoratedType {
   kind: "client";
   name: string;
   description?: string;
@@ -77,7 +78,11 @@ export interface SdkOperationGroup {
   service: Namespace;
 }
 
-interface SdkTypeBase {
+interface DecoratedType {
+  decorators: Record<string, Record<string, any>>;
+}
+
+interface SdkTypeBase extends DecoratedType {
   __raw?: Type;
   kind: string;
   deprecation?: string;
@@ -326,7 +331,7 @@ export interface SdkEndpointType extends SdkTypeBase {
   templateArguments: SdkPathParameter[];
 }
 
-export interface SdkModelPropertyTypeBase {
+export interface SdkModelPropertyTypeBase extends DecoratedType {
   __raw?: ModelProperty;
   type: SdkType;
   /**
@@ -469,7 +474,7 @@ export interface SdkHttpOperation extends SdkServiceOperationBase {
 export type SdkServiceOperation = SdkHttpOperation;
 export type SdkServiceParameter = SdkHttpParameter;
 
-interface SdkMethodBase {
+interface SdkMethodBase extends DecoratedType {
   __raw?: Operation;
   name: string;
   access: AccessFlags;

packages/typespec-client-generator-core/src/internal-utils.ts

@@ -4,13 +4,15 @@ import {
   Interface,
   Model,
   Namespace,
+  Numeric,
   NumericLiteral,
   Operation,
   Program,
   ProjectedProgram,
   StringLiteral,
   Type,
   Union,
+  Value,
   createDiagnosticCollector,
   getDeprecationDetails,
   getDoc,
@@ -242,6 +244,7 @@ interface DefaultSdkTypeBase<TKind> {
   __raw: Type;
   deprecation?: string;
   kind: TKind;
+  decorators: Record<string, Record<string, any>>;
 }
 
 /**
@@ -252,12 +255,83 @@ export function getSdkTypeBaseHelper<TKind>(
   context: TCGCContext,
   type: Type,
   kind: TKind
-): DefaultSdkTypeBase<TKind> {
-  return {
+): [DefaultSdkTypeBase<TKind>, readonly Diagnostic[]] {
+  const diagnostics = createDiagnosticCollector();
+  return diagnostics.wrap({
     __raw: type,
     deprecation: getDeprecationDetails(context.program, type)?.message,
     kind,
-  };
+    decorators: diagnostics.pipe(getTypeDecorators(context, type)),
+  });
+}
+
+export function getNamespacePrefix(namespace: Namespace): string {
+  return namespace ? getNamespaceFullName(namespace) + "." : "";
+}
+
+export function getTypeDecorators(
+  context: TCGCContext,
+  type: Type
+): [Record<string, Record<string, any>>, readonly Diagnostic[]] {
+  const diagnostics = createDiagnosticCollector();
+  const retval: Record<string, Record<string, any>> = {};
+  if ("decorators" in type) {
+    for (const decorator of type.decorators) {
+      // only process explicitly defined decorators
+      if (decorator.definition) {
+        const decoratorName = `${getNamespacePrefix(decorator.definition?.namespace)}${decorator.definition?.name}`;
+        // white list filtering
+        if (
+          !context.decoratorsWhiteList ||
+          !context.decoratorsWhiteList.some((x) => new RegExp(x).test(decoratorName))
+        ) {
+          continue;
+        }
+
+        retval[decoratorName] = {};
+        for (let i = 0; i < decorator.args.length; i++) {
+          retval[decoratorName][decorator.definition.parameters[i].name] = diagnostics.pipe(
+            getDecoratorArgValue(decorator.args[i].jsValue, type, decoratorName)
+          );
+        }
+      }
+    }
+  }
+  return diagnostics.wrap(retval);
+}
+
+function getDecoratorArgValue(
+  arg:
+    | Type
+    | Record<string, unknown>
+    | Value
+    | unknown[]
+    | string
+    | number
+    | boolean
+    | Numeric
+    | null,
+  type: Type,
+  decoratorName: string
+): [any, readonly Diagnostic[]] {
+  const diagnostics = createDiagnosticCollector();
+  if (typeof arg === "object" && arg !== null && "kind" in arg) {
+    if (arg.kind === "EnumMember") {
+      return diagnostics.wrap(arg.value ?? arg.name);
+    }
+    if (arg.kind === "String" || arg.kind === "Number" || arg.kind === "Boolean") {
+      return diagnostics.wrap(arg.value);
+    }
+    diagnostics.add(
+      createDiagnostic({
+        code: "unsupported-generic-decorator-arg-type",
+        target: type,
+        format: { decoratorName },
+      })
+    );
+    return diagnostics.wrap(undefined);
+  }
+  return diagnostics.wrap(arg);
 }
 
 export function intOrFloat(value: number): "int32" | "float32" {
@@ -325,6 +399,7 @@ export interface TCGCContext {
   apiVersion?: string;
   __service_projection?: Map<Namespace, [Namespace, ProjectedProgram | undefined]>;
   originalProgram: Program;
+  decoratorsWhiteList?: string[];
 }
 
 export function createTCGCContext(program: Program): TCGCContext {
@@ -426,9 +501,14 @@ export function isNeverOrVoidType(type: Type): boolean {
   return isNeverType(type) || isVoidType(type);
 }
 
-export function getAnyType(): SdkBuiltInType {
-  return {
+export function getAnyType(
+  context: TCGCContext,
+  type: Type
+): [SdkBuiltInType, readonly Diagnostic[]] {
+  const diagnostics = createDiagnosticCollector();
+  return diagnostics.wrap({
     kind: "any",
     encode: "string",
-  };
+    decorators: diagnostics.pipe(getTypeDecorators(context, type)),
+  });
 }

packages/typespec-client-generator-core/src/lib.ts

@@ -132,19 +132,25 @@ export const $lib = createTypeSpecLibrary({
     "no-corresponding-method-param": {
       severity: "error",
       messages: {
-        default: `Missing "${"paramName"}" method parameter in method "${"methodName"}", when "${"paramName"}" must be sent to the service. Add a parameter named "${"paramName"}" to the method.`,
+        default: paramMessage`Missing "${"paramName"}" method parameter in method "${"methodName"}", when "${"paramName"}" must be sent to the service. Add a parameter named "${"paramName"}" to the method.`,
       },
     },
     "unsupported-protocol": {
       severity: "error",
       messages: {
-        default: paramMessage`Currently we only support HTTP and HTTPS protocols`,
+        default: "Currently we only support HTTP and HTTPS protocols",
       },
     },
     "no-emitter-name": {
       severity: "warning",
       messages: {
-        default: paramMessage`Can not find name for your emitter, please check your emitter name.`,
+        default: "Can not find name for your emitter, please check your emitter name.",
+      },
+    },
+    "unsupported-generic-decorator-arg-type": {
+      severity: "warning",
+      messages: {
+        default: paramMessage`Can not parse the arg type for decorator "${"decoratorName"}".`,
       },
     },
   },