-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[tcgc] support emit code model (#1912)
fix: #1892 There are three ways to get the code model after TCGC conversion: 1. Use TCGC as an emitter to emit the code model: tsp compile . --emit=@azure-tools/typespec-client-generator-core 2. Output the TCGC code model when used by language’s emitter: set `exportTCGCoutput` to true when `createSdkContext` 3. In Azure playground, select @azure-tools/typespec-client-generator-core emitter
- Loading branch information
Showing
22 changed files
with
4,989 additions
and
287 deletions.
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: feature | ||
| packages: | ||
| - "@azure-tools/typespec-client-generator-core" | ||
| --- | ||
|
|
||
| support emit code 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 |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| import { | ||
| createDiagnosticCollector, | ||
| EmitContext, | ||
| emitFile, | ||
| Program, | ||
| resolvePath, | ||
| } from "@typespec/compiler"; | ||
| import { stringify } from "yaml"; | ||
| import { defaultDecoratorsAllowList } from "./configs.js"; | ||
| import { handleClientExamples } from "./example.js"; | ||
| import { | ||
| SdkContext, | ||
| SdkEmitterOptions, | ||
| SdkHttpOperation, | ||
| SdkServiceOperation, | ||
| TCGCContext, | ||
| } from "./interfaces.js"; | ||
| import { parseEmitterName } from "./internal-utils.js"; | ||
| import { getSdkPackage } from "./package.js"; | ||
|
|
||
| export function createTCGCContext(program: Program, emitterName?: string): TCGCContext { | ||
| const diagnostics = createDiagnosticCollector(); | ||
| return { | ||
| program, | ||
| emitterName: diagnostics.pipe( | ||
| parseEmitterName(program, emitterName ?? program.emitters[0]?.metadata?.name), | ||
| ), | ||
| diagnostics: diagnostics.diagnostics, | ||
| originalProgram: program, | ||
| __clientToParameters: new Map(), | ||
| __tspTypeToApiVersions: new Map(), | ||
| __clientToApiVersionClientDefaultValue: new Map(), | ||
| previewStringRegex: /-preview$/, | ||
| disableUsageAccessPropagationToBase: false, | ||
| __pagedResultSet: new Set(), | ||
| }; | ||
| } | ||
|
|
||
| interface VersioningStrategy { | ||
| readonly strategy?: "ignore"; | ||
| readonly previewStringRegex?: RegExp; // regex to match preview versions | ||
| } | ||
|
|
||
| export interface CreateSdkContextOptions { | ||
| readonly versioning?: VersioningStrategy; | ||
| additionalDecorators?: string[]; | ||
| disableUsageAccessPropagationToBase?: boolean; // this flag is for some languages that has no need to generate base model, but generate model with composition | ||
| exportTCGCoutput?: boolean; // this flag is for emitter to export TCGC output as yaml file | ||
| } | ||
|
|
||
| export async function createSdkContext< | ||
| TOptions extends Record<string, any> = SdkEmitterOptions, | ||
| TServiceOperation extends SdkServiceOperation = SdkHttpOperation, | ||
| >( | ||
| context: EmitContext<TOptions>, | ||
| emitterName?: string, | ||
| options?: CreateSdkContextOptions, | ||
| ): Promise<SdkContext<TOptions, TServiceOperation>> { | ||
| const diagnostics = createDiagnosticCollector(); | ||
| const protocolOptions = true; // context.program.getLibraryOptions("generate-protocol-methods"); | ||
| const convenienceOptions = true; // context.program.getLibraryOptions("generate-convenience-methods"); | ||
| const generateProtocolMethods = context.options["generate-protocol-methods"] ?? protocolOptions; | ||
| const generateConvenienceMethods = | ||
| context.options["generate-convenience-methods"] ?? convenienceOptions; | ||
| const tcgcContext = createTCGCContext( | ||
| context.program, | ||
| emitterName ?? context.options["emitter-name"], | ||
| ); | ||
| const sdkContext: SdkContext<TOptions, TServiceOperation> = { | ||
| ...tcgcContext, | ||
| emitContext: context, | ||
| sdkPackage: undefined!, | ||
| generateProtocolMethods: generateProtocolMethods, | ||
| generateConvenienceMethods: generateConvenienceMethods, | ||
| packageName: context.options["package-name"], | ||
| flattenUnionAsEnum: context.options["flatten-union-as-enum"] ?? true, | ||
| apiVersion: options?.versioning?.strategy === "ignore" ? "all" : context.options["api-version"], | ||
| examplesDir: context.options["examples-dir"] ?? context.options["examples-directory"], | ||
| decoratorsAllowList: [...defaultDecoratorsAllowList, ...(options?.additionalDecorators ?? [])], | ||
| previewStringRegex: options?.versioning?.previewStringRegex || tcgcContext.previewStringRegex, | ||
| disableUsageAccessPropagationToBase: options?.disableUsageAccessPropagationToBase ?? false, | ||
| }; | ||
| sdkContext.sdkPackage = diagnostics.pipe(getSdkPackage(sdkContext)); | ||
| for (const client of sdkContext.sdkPackage.clients) { | ||
| diagnostics.pipe(await handleClientExamples(sdkContext, client)); | ||
| } | ||
| sdkContext.diagnostics = sdkContext.diagnostics.concat(diagnostics.diagnostics); | ||
|
|
||
| if (options?.exportTCGCoutput) { | ||
| await exportTCGCOutput(sdkContext); | ||
| } | ||
| return sdkContext; | ||
| } | ||
|
|
||
| async function exportTCGCOutput(context: SdkContext) { | ||
| await emitFile(context.program, { | ||
| path: resolvePath(context.emitContext.emitterOutputDir, "tcgc-output.yaml"), | ||
| content: stringify( | ||
| context.sdkPackage, | ||
| (k, v) => { | ||
| if (typeof k === "string" && k.startsWith("__")) { | ||
| return undefined; // skip keys starting with "__" from the output | ||
| } | ||
| if (k === "scheme") { | ||
| return undefined; // remove credential schema | ||
| } | ||
| if (k === "rawExample") { | ||
| return undefined; // remove raw example | ||
| } | ||
| return v; | ||
| }, | ||
| { lineWidth: 0 }, | ||
| ), | ||
| }); | ||
| } | ||
|
|
||
| export async function $onEmit(context: EmitContext<SdkEmitterOptions>) { | ||
| if (!context.program.compilerOptions.noEmit) { | ||
| const sdkContext = await createSdkContext(context); | ||
| await exportTCGCOutput(sdkContext); | ||
| } | ||
| } |
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
Oops, something went wrong.