TCGC, add crossLanguageDefinitionId to SdkClientType (#1238)

Fix #954
Azure · Aug 1, 2024 · 7f5f070 · 7f5f070
1 parent 45eab1e
commit 7f5f070
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 3 deletions.
diff --git a/.chronus/changes/client-cross-language-id-2024-6-25-3-32-24.md b/.chronus/changes/client-cross-language-id-2024-6-25-3-32-24.md
@@ -0,0 +1,8 @@
+---
+# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
+changeKind: fix
+packages:
+  - "@azure-tools/typespec-client-generator-core"
+---
+
+TCGC, add `crossLanguageDefinitionId` to `SdkClientType`
diff --git a/packages/typespec-client-generator-core/src/decorators.ts b/packages/typespec-client-generator-core/src/decorators.ts
@@ -335,7 +335,7 @@ export function listClients(context: TCGCContext): SdkClient[] {
       service: service.type,
       type: service.type,
       arm: isArm(service.type),
-      crossLanguageDefinitionId: `${getNamespaceFullName(service.type)}.${clientName}`,
+      crossLanguageDefinitionId: getNamespaceFullName(service.type),
     } as SdkClient;
   });
 

diff --git a/packages/typespec-client-generator-core/src/interfaces.ts b/packages/typespec-client-generator-core/src/interfaces.ts
@@ -100,6 +100,7 @@ export interface SdkClientType<TServiceOperation extends SdkServiceOperation>
   methods: SdkMethod<TServiceOperation>[];
   apiVersions: string[];
   nameSpace: string; // fully qualified
+  crossLanguageDefinitionId: string;
   /**
    * @deprecated This property is deprecated. Look at `.arm` on `SdkContext` instead.
    */

diff --git a/packages/typespec-client-generator-core/src/package.ts b/packages/typespec-client-generator-core/src/package.ts
@@ -524,6 +524,8 @@ function createSdkClientType<TServiceOperation extends SdkServiceOperation>(
     // eslint-disable-next-line deprecation/deprecation
     arm: client.kind === "SdkClient" ? client.arm : false,
     decorators: diagnostics.pipe(getTypeDecorators(context, client.type)),
+    // if it is client, the crossLanguageDefinitionId is the ${namespace}, if it is operation group, the crosslanguageDefinitionId is the %{namespace}.%{operationGroupName}
+    crossLanguageDefinitionId: getCrossLanguageDefinitionId(context, client.type),
   };
   return diagnostics.wrap(sdkClientType);
 }

diff --git a/packages/typespec-client-generator-core/test/decorators.test.ts b/packages/typespec-client-generator-core/test/decorators.test.ts
@@ -177,7 +177,7 @@ describe("typespec-client-generator-core: decorators", () => {
           service: MyService,
           type: MyService,
           arm: false,
-          crossLanguageDefinitionId: "MyService.MyServiceClient",
+          crossLanguageDefinitionId: "MyService",
         },
       ]);
     });
@@ -431,7 +431,7 @@ describe("typespec-client-generator-core: decorators", () => {
           service: MyService,
           type: MyService,
           arm: false,
-          crossLanguageDefinitionId: "MyService.MyServiceClient",
+          crossLanguageDefinitionId: "MyService",
         },
       ]);
     });

diff --git a/packages/typespec-client-generator-core/test/package.test.ts b/packages/typespec-client-generator-core/test/package.test.ts
@@ -447,6 +447,7 @@ describe("typespec-client-generator-core: package", () => {
       strictEqual(sdkPackage.clients.length, 1);
       const client = sdkPackage.clients[0];
       strictEqual(client.name, "ServiceClient");
+      strictEqual(client.crossLanguageDefinitionId, "My.Service");
       strictEqual(client.initialization.properties.length, 3);
       strictEqual(client.apiVersions.length, 1);
       strictEqual(client.apiVersions[0], "2022-12-01-preview");
@@ -516,6 +517,7 @@ describe("typespec-client-generator-core: package", () => {
       strictEqual(sdkPackage.clients.length, 1);
       const client = sdkPackage.clients[0];
       strictEqual(client.name, "ServiceClient");
+      strictEqual(client.crossLanguageDefinitionId, "My.Service");
       strictEqual(client.initialization.properties.length, 3);
       strictEqual(client.apiVersions.length, 2);
       deepStrictEqual(client.apiVersions, ["2022-12-01-preview", "2022-12-01"]);
@@ -579,6 +581,7 @@ describe("typespec-client-generator-core: package", () => {
       strictEqual(mainClient.methods.length, 1);
       strictEqual(mainClient.initialization.properties.length, 1);
       strictEqual(mainClient.initialization.properties[0].name, "endpoint");
+      strictEqual(mainClient.crossLanguageDefinitionId, "TestService");
 
       const clientAccessor = mainClient.methods[0];
       strictEqual(clientAccessor.kind, "clientaccessor");
@@ -596,6 +599,7 @@ describe("typespec-client-generator-core: package", () => {
         operationGroup.methods[0].crossLanguageDefintionId,
         "TestService.MyOperationGroup.func"
       );
+      strictEqual(operationGroup.crossLanguageDefinitionId, "TestService.MyOperationGroup");
     });
 
     it("operationGroup2", async () => {
@@ -629,6 +633,7 @@ describe("typespec-client-generator-core: package", () => {
       ok(mainClient.initialization);
       strictEqual(mainClient.initialization.properties.length, 1);
       strictEqual(mainClient.initialization.properties[0].name, "endpoint");
+      strictEqual(mainClient.crossLanguageDefinitionId, "TestService");
 
       const fooAccessor = mainClient.methods[0];
       strictEqual(fooAccessor.kind, "clientaccessor");
@@ -649,6 +654,7 @@ describe("typespec-client-generator-core: package", () => {
       strictEqual(fooClient.initialization.properties.length, 1);
       strictEqual(fooClient.initialization.access, "internal");
       strictEqual(fooClient.methods.length, 1);
+      strictEqual(fooClient.crossLanguageDefinitionId, "TestService.Foo");
 
       const fooBarAccessor = fooClient.methods[0];
       strictEqual(fooBarAccessor.kind, "clientaccessor");
@@ -660,13 +666,15 @@ describe("typespec-client-generator-core: package", () => {
 
       strictEqual(fooBarClient.initialization.properties.length, 1);
       strictEqual(fooBarClient.initialization.access, "internal");
+      strictEqual(fooBarClient.crossLanguageDefinitionId, "TestService.Foo.Bar");
       strictEqual(fooBarClient.methods.length, 1);
       strictEqual(fooBarClient.methods[0].kind, "basic");
       strictEqual(fooBarClient.methods[0].name, "one");
       strictEqual(fooBarClient.methods[0].crossLanguageDefintionId, "TestService.Foo.Bar.one");
 
       strictEqual(barClient.initialization.properties.length, 1);
       strictEqual(barClient.initialization.access, "internal");
+      strictEqual(barClient.crossLanguageDefinitionId, "TestService.Bar");
       strictEqual(barClient.methods.length, 1);
       strictEqual(barClient.methods[0].kind, "basic");
       strictEqual(barClient.methods[0].name, "two");