[tcgc] add client initialization usage #1664
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| changeKind: breaking | ||
| packages: | ||
| - "@azure-tools/typespec-client-generator-core" | ||
| --- | ||
|
|
||
| Make `SdkInitializationType` have an `access` property to denote if publicly instantiable, and a `model` property to show the client options model |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,6 +24,7 @@ import { | |
| getDoc, | ||
| getEncode, | ||
| getKnownValues, | ||
| getNamespaceFullName, | ||
| getSummary, | ||
| getVisibility, | ||
| ignoreDiagnostics, | ||
|
|
@@ -43,6 +44,7 @@ import { | |
| } from "@typespec/http"; | ||
| import { | ||
| getAccessOverride, | ||
| getClientInitialization, | ||
| getOverriddenClientMethod, | ||
| getUsageOverride, | ||
| listClients, | ||
|
|
@@ -67,10 +69,12 @@ import { | |
| SdkEnumType, | ||
| SdkEnumValueType, | ||
| SdkInitializationType, | ||
| SdkMethodParameter, | ||
| SdkModelPropertyType, | ||
| SdkModelPropertyTypeBase, | ||
| SdkModelType, | ||
| SdkOperationGroup, | ||
| SdkParameter, | ||
| SdkTupleType, | ||
| SdkType, | ||
| SdkUnionType, | ||
|
|
@@ -685,18 +689,6 @@ export function getSdkModel( | |
| return ignoreDiagnostics(getSdkModelWithDiagnostics(context, type, operation)); | ||
| } | ||
|
|
||
| export function getSdkModelWithDiagnostics( | ||
| context: TCGCContext, | ||
| type: Model, | ||
|
|
@@ -781,6 +773,75 @@ function getSdkEnumValueType( | |
| return diagnostics.wrap(getTypeSpecBuiltInType(context, kind!)); | ||
| } | ||
|
|
||
| export function createSdkInitializationTypeIfNonExist( | ||
| context: TCGCContext, | ||
| client: SdkClient | SdkOperationGroup, | ||
| ): SdkInitializationType { | ||
| const namePrefix = client.kind === "SdkClient" ? client.name : client.groupPath; | ||
| const name = `${namePrefix.split(".").at(-1)}Options`; | ||
| return { | ||
| access: client.kind === "SdkClient" ? "public" : "internal", | ||
| model: { | ||
| __raw: client.service, | ||
| doc: "Initialization class for the client", | ||
| kind: "model", | ||
| properties: [], | ||
| name, | ||
| isGeneratedName: true, | ||
| access: "public", | ||
| usage: UsageFlags.Input | UsageFlags.ClientInitialization, | ||
| crossLanguageDefinitionId: `${getNamespaceFullName(client.service.namespace!)}.${name}`, | ||
| apiVersions: context.__tspTypeToApiVersions.get(client.type)!, | ||
| decorators: [], | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| export function getSdkInitializationType( | ||
| context: TCGCContext, | ||
| client: SdkClient | SdkOperationGroup, | ||
| model: Model, | ||
| ): SdkInitializationType { | ||
| // convert to SDK type | ||
| const existingModel = context.modelsMap?.get(model) as SdkModelType<SdkParameter> | undefined; | ||
|
There was a problem hiding this comment. do we allow to reuse model in operation as a client initialization model? if so, can we have a test? if not, we could return directly and shall have some lint. There was a problem hiding this comment. @m-nash since c# appears to be the main sdk using client initialization model generation, is there anything precluding us from having a model be used in both scenarios? |
||
| let sdkModel: SdkModelType<SdkParameter>; | ||
| if (existingModel) { | ||
| sdkModel = existingModel; | ||
| } else { | ||
| sdkModel = getSdkModel(context, model) as SdkModelType<SdkParameter>; | ||
|
|
||
| sdkModel.properties = sdkModel.properties.map( | ||
| (property: SdkModelPropertyType): SdkMethodParameter => { | ||
| property.onClient = true; | ||
| property.kind = "method"; | ||
| return property as SdkMethodParameter; | ||
| }, | ||
| ); | ||
| } | ||
| const initializationModel: SdkInitializationType = { | ||
| access: client.kind === "SdkClient" ? "public" : "internal", | ||
| model: sdkModel, | ||
| }; | ||
| let clientParams = context.__clientToParameters.get(client.type); | ||
| if (!clientParams) { | ||
| clientParams = []; | ||
| context.__clientToParameters.set(client.type, clientParams); | ||
| } | ||
|
|
||
| for (const prop of initializationModel.model.properties) { | ||
| if (!clientParams.filter((p) => p.name === prop.name).length) { | ||
| clientParams.push(prop); | ||
| prop.onClient = true; | ||
| } | ||
| } | ||
| updateUsageOrAccessOfModel(context, UsageFlags.Input, sdkModel, { propagation: false }); | ||
| updateUsageOrAccessOfModel(context, UsageFlags.ClientInitialization, sdkModel, { | ||
| propagation: false, | ||
| }); | ||
| updateModelsMap(context, model, sdkModel); | ||
| return initializationModel; | ||
| } | ||
|
|
||
| function getUnionAsEnumValueType( | ||
| context: TCGCContext, | ||
| union: Union, | ||
|
|
@@ -1778,6 +1839,10 @@ export function getAllModelsWithDiagnostics( | |
| diagnostics.pipe(updateTypesFromOperation(context, operation)); | ||
| } | ||
| const ogs = listOperationGroups(context, client); | ||
| const clientInitModel = getClientInitialization(context, client.type); | ||
| if (clientInitModel) { | ||
| getSdkInitializationType(context, client, clientInitModel); | ||
| } | ||
iscai-msft marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| while (ogs.length) { | ||
| const operationGroup = ogs.pop(); | ||
| for (const operation of listOperationsInOperationGroup(context, operationGroup!)) { | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i've realized we can't modify the
.accesson our existingSdkInitializationTypeto denote whether a client is publicly or internally initialized. There is both the context that the client options model is used, and the client options model itself. In this case, the context that the client options model is used hasaccessthat depends on whether it's a client or og. However, that doesn't change the actualaccessof the client options model itself.This is a breaking change, so want to call this out and will call it out more in our sync