Skip to content

Align the client type shape from TCGC in our emitter #6179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 33 commits into from
Mar 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
48290fa
introduce the client type
ArcturusZhang Feb 21, 2025
42b6381
Merge remote-tracking branch 'origin/main' into align-tcgc-client-models
ArcturusZhang Mar 3, 2025
0d94ab9
Merge remote-tracking branch 'origin/main' into align-tcgc-client-models
ArcturusZhang Mar 3, 2025
6b30f7e
update accordingly, but operations we left empty
ArcturusZhang Mar 3, 2025
ed297f5
update deserialization accordingly
ArcturusZhang Mar 3, 2025
086a720
update around parent client
ArcturusZhang Mar 3, 2025
f020f15
making fixes on those test cases for clientprovider
ArcturusZhang Mar 3, 2025
f8e1f81
regen
ArcturusZhang Mar 3, 2025
568f4df
Merge remote-tracking branch 'origin/main' into align-tcgc-client-models
ArcturusZhang Mar 4, 2025
f4d1e26
some clean up
ArcturusZhang Mar 4, 2025
e13128c
Merge remote-tracking branch 'origin/main' into align-tcgc-client-models
ArcturusZhang Mar 4, 2025
d9cc472
regen
ArcturusZhang Mar 5, 2025
977f82e
Merge remote-tracking branch 'origin/main' into align-tcgc-client-models
ArcturusZhang Mar 6, 2025
72975ee
Merge remote-tracking branch 'origin/main' into align-tcgc-client-models
ArcturusZhang Mar 10, 2025
75f1385
fix spell check
ArcturusZhang Mar 10, 2025
2f24d15
fix test case issues
ArcturusZhang Mar 10, 2025
67614d8
format
ArcturusZhang Mar 10, 2025
c3c0154
fix test cases
ArcturusZhang Mar 10, 2025
6bd35ce
regen
ArcturusZhang Mar 10, 2025
70c2d45
clean up
ArcturusZhang Mar 10, 2025
98a92af
Merge branch 'main' into align-tcgc-client-models
ArcturusZhang Mar 11, 2025
706ad09
resolve comments
ArcturusZhang Mar 11, 2025
0561bda
resolve comments
ArcturusZhang Mar 12, 2025
f8de558
Merge remote-tracking branch 'origin/main' into align-tcgc-client-models
ArcturusZhang Mar 12, 2025
83b4030
fix after merge
ArcturusZhang Mar 12, 2025
f64083b
fix after merge
ArcturusZhang Mar 12, 2025
a58b44b
Merge branch 'main' into align-tcgc-client-models
ArcturusZhang Mar 12, 2025
0f69b1b
Merge remote-tracking branch 'origin/main' into align-tcgc-client-models
ArcturusZhang Mar 20, 2025
c2dc51a
change how we do the children list
ArcturusZhang Mar 20, 2025
0c844ef
Merge remote-tracking branch 'origin/main' into align-tcgc-client-models
ArcturusZhang Mar 24, 2025
7f0a5cc
Merge branch 'main' into align-tcgc-client-models
ArcturusZhang Mar 25, 2025
fceb204
regen
ArcturusZhang Mar 25, 2025
a6739c4
Merge remote-tracking branch 'origin/main' into align-tcgc-client-models
ArcturusZhang Mar 25, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/http-client-csharp/emitter/src/emitter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ export async function $onEmit(context: EmitContext<CSharpEmitterOptions>) {
logger: logger,
__typeCache: {
crossLanguageDefinitionIds: new Map(),
clients: new Map(),
types: new Map(),
models: new Map(),
enums: new Map(),
Expand Down
162 changes: 162 additions & 0 deletions packages/http-client-csharp/emitter/src/lib/client-converter.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.

import {
SdkClientType as SdkClientTypeOfT,
SdkEndpointParameter,
SdkEndpointType,
SdkHttpOperation,
} from "@azure-tools/typespec-client-generator-core";
import { NoTarget } from "@typespec/compiler";
import { CSharpEmitterContext } from "../sdk-context.js";
import { InputOperationParameterKind } from "../type/input-operation-parameter-kind.js";
import { InputParameter } from "../type/input-parameter.js";
import { InputClient, InputType } from "../type/input-type.js";
import { RequestLocation } from "../type/request-location.js";
import { fromSdkServiceMethod, getParameterDefaultValue } from "./operation-converter.js";
import { fromSdkType } from "./type-converter.js";

type SdkClientType = SdkClientTypeOfT<SdkHttpOperation>;

export function fromSdkClients(
sdkContext: CSharpEmitterContext,
clients: SdkClientType[],
rootApiVersions: string[],
): InputClient[] {
const inputClients: InputClient[] = [];
for (const client of clients) {
const inputClient = fromSdkClient(sdkContext, client, rootApiVersions);
inputClients.push(inputClient);
}

return inputClients;
}

function fromSdkClient(
sdkContext: CSharpEmitterContext,
client: SdkClientType,
rootApiVersions: string[],
): InputClient {
let inputClient: InputClient | undefined = sdkContext.__typeCache.clients.get(client);
if (inputClient) {
return inputClient;
}
const endpointParameter = client.clientInitialization.parameters.find(
(p) => p.kind === "endpoint",
) as SdkEndpointParameter;
const uri = getMethodUri(endpointParameter);
const clientParameters = fromSdkEndpointParameter(endpointParameter);

inputClient = {
kind: "client",
name: client.name,
namespace: client.namespace,
doc: client.doc,
summary: client.summary,
operations: client.methods
.filter((m) => m.kind !== "clientaccessor")
.map((m) => fromSdkServiceMethod(sdkContext, m, uri, rootApiVersions)),
parameters: clientParameters,
decorators: client.decorators,
crossLanguageDefinitionId: client.crossLanguageDefinitionId,
apiVersions: client.apiVersions,
parent: undefined,
children: undefined,
};

updateSdkClientTypeReferences(sdkContext, client, inputClient);

// fill parent
if (client.parent) {
inputClient.parent = fromSdkClient(sdkContext, client.parent, rootApiVersions);
}
// fill children
if (client.children) {
inputClient.children = client.children.map((c) =>
fromSdkClient(sdkContext, c, rootApiVersions),
);
}

return inputClient;

function fromSdkEndpointParameter(p: SdkEndpointParameter): InputParameter[] {
if (p.type.kind === "union") {
return fromSdkEndpointType(p.type.variantTypes[0]);
} else {
return fromSdkEndpointType(p.type);
}
}

function fromSdkEndpointType(type: SdkEndpointType): InputParameter[] {
// TODO: support free-style endpoint url with multiple parameters
const endpointExpr = type.serverUrl
.replace("https://", "")
.replace("http://", "")
.split("/")[0];
if (!/^\{\w+\}$/.test(endpointExpr)) {
sdkContext.logger.reportDiagnostic({
code: "unsupported-endpoint-url",
format: { endpoint: type.serverUrl },
target: NoTarget,
});
return [];
}
const endpointVariableName = endpointExpr.substring(1, endpointExpr.length - 1);

const parameters: InputParameter[] = [];
for (const parameter of type.templateArguments) {
const isEndpoint = parameter.name === endpointVariableName;
const parameterType: InputType = isEndpoint
? {
kind: "url",
name: "url",
crossLanguageDefinitionId: "TypeSpec.url",
}
: fromSdkType(sdkContext, parameter.type); // TODO: consolidate with converter.fromSdkEndpointType
parameters.push({
name: parameter.name,
nameInRequest: parameter.serializedName,
summary: parameter.summary,
doc: parameter.doc,
type: parameterType,
location: RequestLocation.Uri,
isApiVersion: parameter.isApiVersionParam,
isContentType: false,
isRequired: !parameter.optional,
isEndpoint: isEndpoint,
skipUrlEncoding: false,
explode: false,
kind: InputOperationParameterKind.Client,
defaultValue: getParameterDefaultValue(
sdkContext,
parameter.clientDefaultValue,
parameterType,
),
});
}
return parameters;
}
}

function updateSdkClientTypeReferences(
sdkContext: CSharpEmitterContext,
sdkClient: SdkClientType,
inputClient: InputClient,
) {
sdkContext.__typeCache.clients.set(sdkClient, inputClient);
sdkContext.__typeCache.crossLanguageDefinitionIds.set(
sdkClient.crossLanguageDefinitionId,
sdkClient.__raw.type,
);
}

function getMethodUri(p: SdkEndpointParameter | undefined): string {
if (!p) return "";

if (p.type.kind === "endpoint" && p.type.templateArguments.length > 0) return p.type.serverUrl;

if (p.type.kind === "union" && p.type.variantTypes.length > 0)
return (p.type.variantTypes[0] as SdkEndpointType).serverUrl;

return `{${p.name}}`;
}
159 changes: 4 additions & 155 deletions packages/http-client-csharp/emitter/src/lib/client-model-builder.ts
Original file line number Diff line number Diff line change
@@ -1,26 +1,13 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.

import {
SdkClientType,
SdkEndpointParameter,
SdkEndpointType,
SdkHttpOperation,
SdkServiceMethod,
UsageFlags,
} from "@azure-tools/typespec-client-generator-core";
import { UsageFlags } from "@azure-tools/typespec-client-generator-core";
import { NoTarget } from "@typespec/compiler";
import { CSharpEmitterContext } from "../sdk-context.js";
import { CodeModel } from "../type/code-model.js";
import { InputClient } from "../type/input-client.js";
import { InputOperationParameterKind } from "../type/input-operation-parameter-kind.js";
import { InputParameter } from "../type/input-parameter.js";
import { InputType } from "../type/input-type.js";
import { RequestLocation } from "../type/request-location.js";
import { fromSdkClients } from "./client-converter.js";
import { navigateModels } from "./model.js";
import { fromSdkServiceMethod, getParameterDefaultValue } from "./operation-converter.js";
import { processServiceAuthentication } from "./service-authentication.js";
import { fromSdkType } from "./type-converter.js";
import { getClientNamespaceString } from "./utils.js";

/**
Expand All @@ -36,7 +23,7 @@ export function createModel(sdkContext: CSharpEmitterContext): CodeModel {

const sdkApiVersionEnums = sdkPackage.enums.filter((e) => e.usage === UsageFlags.ApiVersionEnum);

const rootClients = sdkPackage.clients.filter((c) => c.initialization.access === "public");
const rootClients = sdkPackage.clients;
if (rootClients.length === 0) {
sdkContext.logger.reportDiagnostic({
code: "no-root-client",
Expand All @@ -51,8 +38,7 @@ export function createModel(sdkContext: CSharpEmitterContext): CodeModel {
? sdkApiVersionEnums[0].values.map((v) => v.value as string).flat()
: rootClients[0].apiVersions;

const inputClients: InputClient[] = [];
fromSdkClients(rootClients, inputClients, []);
const inputClients = fromSdkClients(sdkContext, rootClients, rootApiVersions);

const clientModel: CodeModel = {
// To ensure deterministic library name, customers would need to set the package-name property as the ordering of the namespaces could change
Expand All @@ -66,141 +52,4 @@ export function createModel(sdkContext: CSharpEmitterContext): CodeModel {
};

return clientModel;

function fromSdkClients(
clients: SdkClientType<SdkHttpOperation>[],
inputClients: InputClient[],
parentClientNames: string[],
) {
for (const client of clients) {
const inputClient = fromSdkClient(client, parentClientNames);
inputClients.push(inputClient);
const subClients = client.methods
.filter((m) => m.kind === "clientaccessor")
.map((m) => m.response as SdkClientType<SdkHttpOperation>);
parentClientNames.push(inputClient.name);
fromSdkClients(subClients, inputClients, parentClientNames);
parentClientNames.pop();
}
}

function fromSdkClient(
client: SdkClientType<SdkHttpOperation>,
parentNames: string[],
): InputClient {
const endpointParameter = client.initialization.properties.find(
(p) => p.kind === "endpoint",
) as SdkEndpointParameter;
const uri = getMethodUri(endpointParameter);
const clientParameters = fromSdkEndpointParameter(endpointParameter);
const clientName = getClientName(client, parentNames);

sdkContext.__typeCache.crossLanguageDefinitionIds.set(
client.crossLanguageDefinitionId,
client.__raw.type,
);
return {
name: clientName,
namespace: client.namespace,
summary: client.summary,
doc: client.doc,
operations: client.methods
.filter((m) => m.kind !== "clientaccessor")
.map((m) =>
fromSdkServiceMethod(
sdkContext,
m as SdkServiceMethod<SdkHttpOperation>,
uri,
rootApiVersions,
),
),
parent: parentNames.length > 0 ? parentNames[parentNames.length - 1] : undefined,
parameters: clientParameters,
decorators: client.decorators,
crossLanguageDefinitionId: client.crossLanguageDefinitionId,
};
}

function getClientName(
client: SdkClientType<SdkHttpOperation>,
parentClientNames: string[],
): string {
const clientName = client.name;

if (parentClientNames.length === 0) return clientName;
if (parentClientNames.length >= 2)
return `${parentClientNames.slice(parentClientNames.length - 1).join("")}${clientName}`;

return clientName;
}

function fromSdkEndpointParameter(p: SdkEndpointParameter): InputParameter[] {
if (p.type.kind === "union") {
return fromSdkEndpointType(p.type.variantTypes[0]);
} else {
return fromSdkEndpointType(p.type);
}
}

function fromSdkEndpointType(type: SdkEndpointType): InputParameter[] {
// TODO: support free-style endpoint url with multiple parameters
const endpointExpr = type.serverUrl
.replace("https://", "")
.replace("http://", "")
.split("/")[0];
if (!/^\{\w+\}$/.test(endpointExpr)) {
sdkContext.logger.reportDiagnostic({
code: "unsupported-endpoint-url",
format: { endpoint: type.serverUrl },
target: NoTarget,
});
return [];
}
const endpointVariableName = endpointExpr.substring(1, endpointExpr.length - 1);

const parameters: InputParameter[] = [];
for (const parameter of type.templateArguments) {
const isEndpoint = parameter.name === endpointVariableName;
const parameterType: InputType = isEndpoint
? {
kind: "url",
name: "url",
crossLanguageDefinitionId: "TypeSpec.url",
}
: fromSdkType(sdkContext, parameter.type); // TODO: consolidate with converter.fromSdkEndpointType
parameters.push({
name: parameter.name,
nameInRequest: parameter.serializedName,
summary: parameter.summary,
doc: parameter.doc,
// TODO: we should do the magic in generator
type: parameterType,
location: RequestLocation.Uri,
isApiVersion: parameter.isApiVersionParam,
isContentType: false,
isRequired: !parameter.optional,
isEndpoint: isEndpoint,
skipUrlEncoding: false,
explode: false,
kind: InputOperationParameterKind.Client,
defaultValue: getParameterDefaultValue(
sdkContext,
parameter.clientDefaultValue,
parameterType,
),
});
}
return parameters;
}
}

function getMethodUri(p: SdkEndpointParameter | undefined): string {
if (!p) return "";

if (p.type.kind === "endpoint" && p.type.templateArguments.length > 0) return p.type.serverUrl;

if (p.type.kind === "union" && p.type.variantTypes.length > 0)
return (p.type.variantTypes[0] as SdkEndpointType).serverUrl;

return `{${p.name}}`;
}
10 changes: 8 additions & 2 deletions packages/http-client-csharp/emitter/src/sdk-context.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.

import { SdkContext, SdkType } from "@azure-tools/typespec-client-generator-core";
import {
SdkClientType,
SdkContext,
SdkHttpOperation,
SdkType,
} from "@azure-tools/typespec-client-generator-core";
import { Type } from "@typespec/compiler";
import { Logger } from "./lib/logger.js";
import { CSharpEmitterOptions } from "./options.js";
import { InputEnumType, InputModelType, InputType } from "./type/input-type.js";
import { InputClient, InputEnumType, InputModelType, InputType } from "./type/input-type.js";

/**
* The emitter context for the CSharp emitter.
Expand All @@ -18,6 +23,7 @@ export interface CSharpEmitterContext extends SdkContext<CSharpEmitterOptions> {

export interface SdkTypeMap {
crossLanguageDefinitionIds: Map<string, Type | undefined>;
clients: Map<SdkClientType<SdkHttpOperation>, InputClient>;
types: Map<SdkType, InputType>;
models: Map<string, InputModelType>;
enums: Map<string, InputEnumType>;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
// Licensed under the MIT License. See License.txt in the project root for license information.

import { InputAuth } from "./input-auth.js";
import { InputClient } from "./input-client.js";
import { InputEnumType, InputModelType } from "./input-type.js";
import { InputClient, InputEnumType, InputModelType } from "./input-type.js";

export interface CodeModel {
name: string;
Expand Down
Loading
Loading