[tcgc] one client multiple services by iscai-msft · Pull Request #3460 · Azure/typespec-azure

iscai-msft · 2025-10-30T17:25:26Z

fixes #3536, fixes #3537

azure-sdk · 2025-10-30T17:26:40Z

All changed packages have been documented.

✅ @azure-tools/typespec-client-generator-core

Show changes

`@azure-tools/typespec-client-generator-core` - feature ✏️

Add support to define one client from multiple services. Api versions for services will rest on the subclient

azure-sdk · 2025-10-30T17:36:21Z

You can try these changes here

🛝 Playground	🌐 Website

pkg-pr-new · 2025-10-30T17:48:19Z

Open in StackBlitz

npm i https://pkg.pr.new/Azure/typespec-azure/@azure-tools/typespec-client-generator-core@3460

commit: 9ed2b77

…cgc/multiServiceOneClient

tadelesh · 2025-11-12T06:36:26Z

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

        this.apiVersion !== undefined &&
        this.apiVersion !== "latest" &&
        this.apiVersion !== "all" &&
-        !this.__packageVersions.includes(this.apiVersion)
+        !serviceVersions.includes(this.apiVersion)


This config could only be used for one service. How could this work for multiple service's version?

We may need to think about how to specific multiple service's api version in the config.

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

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

…cgc/multiServiceOneClient

tadelesh · 2025-11-28T07:32:30Z

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

      // operations directly under the group
      const operations = [...group.type.operations.values()];

+      // For interfaces that extend other interfaces, also collect operations from the source interfaces


Is it a bug from TypeSpec? This seems a hack to get back the operations that raw type graph does not have. If it only happens when having versioning, I doubt if it is a versioning mutator issue.

tadelesh · 2025-11-28T07:40:05Z

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

  const diagnostics = createDiagnosticCollector();

-  const packageVersions = context.getPackageVersions();
+  const packageVersions = context.getApiVersions();


This will fail for example loading since different service have different version.

tadelesh · 2025-11-28T08:03:31Z

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

+  // Find the service that has versioning information
+  // In single-service scenarios, this should be the service with @versioned
+  // In multi-service without @useDependency, use the first service with versions
+  let targetService = services[0].type;
+  for (const service of services) {
+    const versions = getVersions(context.program, service.type)[1];
+    if (versions) {
+      targetService = service.type;
+      break;
+    }
+  }
+


So, for multiple service, we always need to define @client with parent to build the hierarchy?
If so, here we could just keep the original logic. I'm not get the point to find a versioned service for multi-service.
If not, I think we could generate paralleled clients with these services.

tadelesh · 2025-11-28T08:08:43Z

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

+              reportDiagnostic(this.program, {
+                code: "multiple-services-require-use-dependency",
+                format: { services: services.map((s) => s.type.name).join(", ") },
+                target: services[0].type,
+              });


If not meet the case, shall we return directly?

tadelesh · 2025-11-28T08:17:06Z

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

+      const cachedVersions = this.__serviceToVersions.get(service);
+      if (cachedVersions?.length) {
+        return cachedVersions;
+      }
+
+      const versions = getVersions(program, service)[1]?.getVersions();
      if (!versions) {
-        this.__packageVersions = [];
-        return this.__packageVersions;
+        return [];
      }


For services that without versioning, we should also save the cache.

tadelesh · 2025-11-28T08:29:44Z

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

+  if (!parent && client.kind === "SdkClient" && client.parent) {
+    const parentRaw = context.__rawClientsOperationGroupsCache?.get(client.parent) as
+      | SdkClient
+      | undefined;
+    parent = context.__clientTypesCache?.find((c) => c.__raw === parentRaw) as
+      | SdkClientType<TServiceOperation>
+      | undefined;
+  }


I don't prefer to mix the client hierarchy build into the SDK type creation section. It's better to do it in the cache process.

tadelesh · 2025-11-28T08:37:54Z

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

    }
  }
+
+  // Check for multi-service scenario with @useDependency


I'm wondering why the API parameter no longer poped up from the operation level's parameter for multi-service cases? I believe only the top-level client should have special logic.

tadelesh · 2025-11-28T08:46:42Z

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

  return diagnostics.wrap(sdkPackage);
 }

+function createClients<TServiceOperation extends SdkServiceOperation>(


Can we move this client hierarchy build process into cache builder section. I prefer after we get the client hierarchy info, all the following calculation does not have special logic for multi-service scenario. The only exception could be API version cache builder.

packages/typespec-client-generator-core/test/clients/structure.test.ts

tadelesh · 2025-11-28T09:04:25Z

packages/typespec-client-generator-core/test/clients/structure.test.ts

  );
 });
+
+it("one client from multiple services", async () => {


There are diagnostic error for these test cases. See playground. We need to change rule of invalid-initialized-by.

This reverts commit a872ce2.

This reverts commit a872ce2. --------- Co-authored-by: iscai-msft <isabellavcai@gmail.com>

add rough test

70cf314

microsoft-github-policy-service bot added the lib:tcgc Issues for @azure-tools/typespec-client-generator-core library label Oct 30, 2025

iscai-msft added 2 commits October 30, 2025 13:30

switch to parent initialization

a76ed5e

get rid of erroneous commit

c7a60a6

iscai-msft added 11 commits October 30, 2025 15:24

add parent arg to client decorator

e078c04

set up ideal structure

6c70802

get api versions by service when applicable

88af780

fix getting api versions enum so it's more granular

fa746ed

all tests passing

5ddb972

format

00d990c

add changeset

224d610

cspell

05ed64b

build docs and add versioning test

d3c20dd

Merge branch 'main' of https://github.com/Azure/typespec-azure into t…

4b7a6b7

…cgc/multiServiceOneClient

fix cspell

9623302

tadelesh reviewed Nov 12, 2025

View reviewed changes

iscai-msft added 6 commits November 13, 2025 16:09

Merge branch 'main' of https://github.com/Azure/typespec-azure into t…

4bf90bb

…cgc/multiServiceOneClient

remove unnecessary fallback

2a73a95

throw error for mutating multiple services

bb9a49b

Merge branch 'main' of https://github.com/Azure/typespec-azure into t…

d0742e2

…cgc/multiServiceOneClient

add requirement for useDependency

e274d6b

Merge branch 'main' of https://github.com/Azure/typespec-azure into t…

8e6339b

…cgc/multiServiceOneClient

iscai-msft marked this pull request as ready for review November 20, 2025 20:23

iscai-msft requested review from joheredi, lmazuel, m-nash and srnagar as code owners November 20, 2025 20:23

iscai-msft requested review from bterlson, markcowl and timotheeguerin as code owners November 20, 2025 20:23

iscai-msft added 4 commits November 20, 2025 15:24

use cspell

7b81398

cspell again

a1d7664

add docs

59b92a6

update docs

9ed2b77

iscai-msft enabled auto-merge November 20, 2025 22:21

lmazuel approved these changes Nov 21, 2025

View reviewed changes

iscai-msft added this pull request to the merge queue Nov 21, 2025

Merged via the queue into Azure:main with commit a872ce2 Nov 21, 2025
26 checks passed

iscai-msft deleted the tcgc/multiServiceOneClient branch November 21, 2025 00:55

tadelesh reviewed Nov 28, 2025

View reviewed changes

tadelesh mentioned this pull request Dec 3, 2025

[TCGC] Refining multiple services support #3587

Closed

tadelesh pushed a commit that referenced this pull request Dec 4, 2025

Revert "[tcgc] one client multiple services (#3460)"

9c0ca78

This reverts commit a872ce2.

iscai-msft pushed a commit to iscai-msft/typespec-azure that referenced this pull request Dec 9, 2025

Revert "[tcgc] one client multiple services (Azure#3460)"

cb7a145

This reverts commit a872ce2.

github-merge-queue bot pushed a commit that referenced this pull request Dec 9, 2025

Revert "[tcgc] one client multiple services (#3460)" (#3631)

7593c43

This reverts commit a872ce2. --------- Co-authored-by: iscai-msft <isabellavcai@gmail.com>

Conversation

iscai-msft commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azure-sdk commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

@azure-tools/typespec-client-generator-core - feature ✏️

Uh oh!

azure-sdk commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new bot commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

iscai-msft commented Oct 30, 2025 •

edited

Loading

azure-sdk commented Oct 30, 2025 •

edited

Loading

`@azure-tools/typespec-client-generator-core` - feature ✏️

azure-sdk commented Oct 30, 2025 •

edited

Loading

pkg-pr-new bot commented Oct 30, 2025 •

edited

Loading