Skip to content
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

add a cache for parameters/responses/operations #6030

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
add cache for response
  • Loading branch information
ArcturusZhang committed Feb 17, 2025
commit 865a6f66c780d0cd9f78fc2b5eafdfc4eee3d457
Original file line number Diff line number Diff line change
@@ -8,7 +8,6 @@ import {
SdkExampleValue,
SdkHttpOperationExample,
SdkHttpParameterExampleValue,
SdkHttpResponse,
SdkHttpResponseExampleValue,
SdkModelExampleValue,
SdkNullExampleValue,
@@ -41,13 +40,12 @@ import {
InputPrimitiveType,
InputUnionType,
} from "../type/input-type.js";
import { OperationResponse } from "../type/operation-response.js";
import { fromSdkHttpOperationResponse } from "./operation-converter.js";
import { fromSdkType } from "./type-converter.js";

export function fromSdkHttpExamples(
sdkContext: CSharpEmitterContext,
examples: SdkHttpOperationExample[],
responseMap: Map<SdkHttpResponse, OperationResponse>,
): InputHttpOperationExample[] {
return examples.map((example) => fromSdkHttpExample(example));

@@ -72,12 +70,12 @@ export function fromSdkHttpExamples(
}

function fromSdkOperationResponse(
response: SdkHttpResponseExampleValue,
responseValue: SdkHttpResponseExampleValue,
): OperationResponseExample {
return {
response: responseMap.get(response.response)!,
statusCode: response.statusCode,
bodyValue: response.bodyValue ? fromSdkExample(response.bodyValue) : undefined,
response: fromSdkHttpOperationResponse(sdkContext, responseValue.response),
statusCode: responseValue.statusCode,
bodyValue: responseValue.bodyValue ? fromSdkExample(responseValue.bodyValue) : undefined,
};
}

Original file line number Diff line number Diff line change
@@ -57,7 +57,6 @@ export function fromSdkServiceMethod(
generateConvenience = false;
}

const responseMap = fromSdkHttpOperationResponses(sdkContext, method.operation.responses);
return {
Name: method.name,
ResourceName:
@@ -69,7 +68,7 @@ export function fromSdkServiceMethod(
Doc: method.doc,
Accessibility: method.access,
Parameters: fromSdkOperationParameters(sdkContext, method.operation, rootApiVersions),
Responses: [...responseMap.values()],
Responses: fromSdkHttpOperationResponses(sdkContext, method.operation.responses),
HttpMethod: parseHttpRequestMethod(method.operation.verb),
RequestBodyMediaType: getBodyMediaType(method.operation.bodyParam?.type),
Uri: uri,
@@ -84,7 +83,7 @@ export function fromSdkServiceMethod(
CrossLanguageDefinitionId: method.crossLanguageDefinitionId,
Decorators: method.decorators,
Examples: method.operation.examples
? fromSdkHttpExamples(sdkContext, method.operation.examples, responseMap)
? fromSdkHttpExamples(sdkContext, method.operation.examples)
: undefined,
};
}
@@ -234,22 +233,38 @@ function loadLongRunningOperation(
function fromSdkHttpOperationResponses(
sdkContext: CSharpEmitterContext,
operationResponses: SdkHttpResponse[],
): Map<SdkHttpResponse, OperationResponse> {
const responses = new Map<SdkHttpResponse, OperationResponse>();
): OperationResponse[] {
const responses: OperationResponse[] = [];
for (const r of operationResponses) {
const range = r.statusCodes;
responses.set(r, {
StatusCodes: toStatusCodesArray(range),
BodyType: r.type ? fromSdkType(sdkContext, r.type) : undefined,
BodyMediaType: BodyMediaType.Json,
Headers: fromSdkServiceResponseHeaders(sdkContext, r.headers),
IsErrorResponse: r.type !== undefined && isErrorModel(sdkContext.program, r.type.__raw!),
ContentTypes: r.contentTypes,
});
responses.push(fromSdkHttpOperationResponse(sdkContext, r));
}
return responses;
}

export function fromSdkHttpOperationResponse(
sdkContext: CSharpEmitterContext,
sdkResponse: SdkHttpResponse,
): OperationResponse {
let retVar = sdkContext.__typeCache.responses.get(sdkResponse);
if (retVar) {
return retVar;
}

const range = sdkResponse.statusCodes;
retVar = {
StatusCodes: toStatusCodesArray(range),
BodyType: sdkResponse.type ? fromSdkType(sdkContext, sdkResponse.type) : undefined,
BodyMediaType: BodyMediaType.Json,
Headers: fromSdkServiceResponseHeaders(sdkContext, sdkResponse.headers),
IsErrorResponse:
sdkResponse.type !== undefined && isErrorModel(sdkContext.program, sdkResponse.type.__raw!),
ContentTypes: sdkResponse.contentTypes,
};

sdkContext.__typeCache.updateSdkResponseReferences(sdkResponse, retVar);
return retVar;
}

function fromSdkServiceResponseHeaders(
sdkContext: CSharpEmitterContext,
headers: SdkServiceResponseHeader[],
19 changes: 14 additions & 5 deletions packages/http-client-csharp/emitter/src/sdk-context.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.

import { SdkContext, SdkHttpParameter, SdkType } from "@azure-tools/typespec-client-generator-core";
import {
SdkContext,
SdkHttpParameter,
SdkHttpResponse,
SdkType,
} from "@azure-tools/typespec-client-generator-core";
import { Logger } from "./lib/logger.js";
import { CSharpEmitterOptions } from "./options.js";
import { InputParameter } from "./type/input-parameter.js";
import { InputEnumType, InputModelType, InputType } from "./type/input-type.js";
import { OperationResponse } from "./type/operation-response.js";

/**
* The emitter context for the CSharp emitter.
@@ -19,12 +25,16 @@ export interface CSharpEmitterContext extends SdkContext<CSharpEmitterOptions> {
export function createSdkTypeCache(): SdkTypeCache {
return {
parameters: new Map<SdkHttpParameter, InputParameter>(),
responses: new Map<SdkHttpResponse, OperationResponse>(),
types: new Map<SdkType, InputType>(),
models: new Map<string, InputModelType>(),
enums: new Map<string, InputEnumType>(),
updateSdkParameterReferences(sdkParameter: SdkHttpParameter, inputParameter: InputParameter) {
this.parameters.set(sdkParameter, inputParameter);
},
updateSdkResponseReferences(sdkResponse: SdkHttpResponse, response: OperationResponse) {
this.responses.set(sdkResponse, response);
},
updateSdkTypeReferences(sdkType: SdkType, inputType: InputType) {
this.types.set(sdkType, inputType);
},
@@ -40,14 +50,13 @@ export function createSdkTypeCache(): SdkTypeCache {

export interface SdkTypeCache {
parameters: Map<SdkHttpParameter, InputParameter>;
responses: Map<SdkHttpResponse, OperationResponse>;
types: Map<SdkType, InputType>;
models: Map<string, InputModelType>;
enums: Map<string, InputEnumType>;

updateSdkParameterReferences(
sdkParameter: SdkHttpParameter,
inputParameter: InputParameter,
): void;
updateSdkParameterReferences(sdkParameter: SdkHttpParameter, parameter: InputParameter): void;
updateSdkResponseReferences(sdkResponse: SdkHttpResponse, response: OperationResponse): void;
updateSdkTypeReferences(sdkType: SdkType, inputType: InputType): void;
updateTypeCache(typeName: string, type: InputType): void;
}
Loading
Oops, something went wrong.