Sample generation for MPG for cliassical client #2770

MaryGao · 2024-08-26T09:03:08Z

Scope

This pr would support sample generation for classical client from TCGC SdkPackage. And the api layer sample generation is not in this pr's scope.

The main test cases are covered under modularUnit/scenarios/samples. And we also enable serveral test cases in smoke testing.

Non Scope

Full support for client-level parameter will be covered

Some known issues

Support special union type generation in sample gen in Modular #2826
Optional body parameter is handled differently in HLC and Modular which would cause breakings #2827

…into sample-experienmental

…autorest.typescript into pr/2770

packages/typespec-ts/test/modularIntegration/generated/azure/example/basic/src/index.d.ts

…autorest.typescript into sample-gen-ready-branch

packages/autorest.typescript/src/generators/modelsGenerator.ts

packages/typespec-ts/test/modularUnit/scenarios/samples/operations/multipleExamplesInOneFile.md

...tworkAnalytics.Management/generated/typespec-ts/samples-dev/dataProductsAddUserRoleSample.ts

...st/NetworkAnalytics.Management/generated/typespec-ts/samples-dev/dataProductsCreateSample.ts

qiaozha · 2024-09-14T08:22:42Z

packages/typespec-ts/src/modular/emitSamples.ts

+    case "null":
+    case "any":
+    case "union":
+      retValue = `${value.value}`;


what about union of models where the model have different serializeName and client name?

this is not covered by current tcgc and issue tracked here: Azure/typespec-azure#1556. and we are blocked by tcgc design yet and let me know if any service impacted especially for mpg. Our issue is here: #2826.

qiaozha · 2024-09-14T08:47:59Z

packages/typespec-ts/src/index.ts

@@ -259,6 +265,15 @@ export async function $onEmit(context: EmitContext) {

    const isMultiClients = modularCodeModel.clients.length > 1;

+    // Enable modular sample generation when explicitly set to true or MPG
+    if (emitterOptions?.generateSample === true) {


Since RLC sample generation is not supported yet, what would happen if generateSample is true but isModularLibrary is false?

this will be crashed as

$ npx tsp compile ./client.tsp TypeSpec compiler v0.59.0 Emitter "@azure-tools/typespec-ts" crashed! This is a bug. Please file an issue at https://github.com/Azure/autorest.typescript/issues TypeError: Cannot convert undefined or null to object at Function.keys (<anonymous>) at getSdkModelExample (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:569:31) at getSdkTypeExample (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:443:16) at getSdkModelExample (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:573:11) at getSdkTypeExample (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:443:16) at getSdkModelExample (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:573:11) at getSdkTypeExample (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:443:16) at getSdkModelExample (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:573:11) at getSdkTypeExample (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:443:16) at handleHttpResponse (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:318:13) -------------------------------------------------- Library Version 0.33.0 TypeSpec Compiler Version 0.59.0 --------------------------------------------------

RLC sample generation from given example is not supported and it should be covered in issue: #2538.

But we have implemented a version for sample generation from fake value. So if generateSample is true but isModularLibrary is false even though this is not recommanded but it should generate fake values and see smoke case here: https://github.com/Azure/autorest.typescript/blob/main/packages/typespec-test/test/loadTest/tspconfig.yaml#L25.

this will be crashed as

$ npx tsp compile ./client.tsp TypeSpec compiler v0.59.0 Emitter "@azure-tools/typespec-ts" crashed! This is a bug. Please file an issue at https://github.com/Azure/autorest.typescript/issues TypeError: Cannot convert undefined or null to object at Function.keys (<anonymous>) at getSdkModelExample (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:569:31) at getSdkTypeExample (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:443:16) at getSdkModelExample (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:573:11) at getSdkTypeExample (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:443:16) at getSdkModelExample (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:573:11) at getSdkTypeExample (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:443:16) at getSdkModelExample (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:573:11) at getSdkTypeExample (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:443:16) at handleHttpResponse (file:///D:/Git/autorest.typescript/common/temp/node_modules/.pnpm/@[email protected]_rxzquxnvxkwebgrumlsfc6ni5i/node_modules/@azure-tools/typespec-client-generator-core/src/example.ts:318:13) -------------------------------------------------- Library Version 0.33.0 TypeSpec Compiler Version 0.59.0 --------------------------------------------------

@kazrael2119 there should be no issue even if we enable sample gen for RLC and example folder. and this issue is thrown from tcgc before running it could you ensure the example and tsp are latest?

I update isModularLibrary as false in networkanalytics , and it would generate samples, but for loadtest, it failed as above error message, I create a draft pr to investigate MaryGao#45

The issue confirmed is a tcgc bug and should be fixed in latest version(not integrate yet) in loadtest.

qiaozha · 2024-09-14T08:58:29Z

packages/typespec-ts/test/modularUnit/scenarios/samples/parameters/bodyOptionalCheck.md

+async function read() {
+  const client = new TestingClient();
+  const result = await client.read("required path param", "required query", {
+    body: { name: "body name" },


can you check if we need body key for optional body in HLC and if this is correct in the modular ?

Seems there exists in-consistancy between hlc and modular: #2827. I prefer skipping this case for now until we finalize the modular design.

see hlc swagger: https://github.com/Azure/autorest.typescript/blob/main/packages/autorest.typescript/test/integration/swaggers/appconfiguration.json#L457-L462
hlc generated code: https://github.com/Azure/autorest.typescript/blob/main/packages/autorest.typescript/test/integration/generated/appconfiguration/src/models/index.ts#L512-L513

modular generated code:
https://github.com/Azure/autorest.typescript/blob/main/packages/typespec-ts/test/modularIntegration/generated/parameters/body-optionality/src/index.d.ts#L25-L26

MaryGao and others added 30 commits July 29, 2024 16:18

Upgrade to the latest tcgc

4a2ecc5

Update the fixes

03abd99

Init sample generation

abbad79

Fix testing issues

e9ed632

Init sample gen

61d7964

Init sample gen

5a2a237

Upgrade tcgc to v44.3

71e8cd9

Merge branch 'main' into upgrade-to-july-tcgc-breakings

151258d

Merge remote-tracking branch 'origin/upgrade-to-july-tcgc-breakings' …

66136b6

…into sample-experienmental

Generate the first sample gen

fdece2e

Update the dependencies

6fc0f29

Merge branch 'main' into sample-experienmental

9bf7986

Merge remote-tracking branch 'origin/main' into sample-experienmental

2173981

Merge remote-tracking branch 'origin/main' into sample-experienmental

0a37eb0

Update the samples

7d2ad50

Update the sample gen for network anayltisc

6897a9e

Build samples with multiple examples for one operations

c0f2514

Merge remote-tracking branch 'origin/main' into sample-experienmental

af3ed09

Merge remote-tracking branch 'origin/main' into sample-experienmental

144ff67

Update the samples

ce16403

Update the comments in sample gen

a8d73ca

Generate models from TCGC and use binder

10267e1

Merge remote-tracking branch 'origin/main' into sample-experienmental

2755e2f

Fix subscription id issue

4300767

update the example summary

345016e

Update the paging operations

842a3f4

Add import for default credential

35b42a3

Update the package name dependencies

7e399b1

update the package.json file

5ba88ff

Update the property name

a12885a

MaryGao and others added 5 commits September 3, 2024 14:10

Refactor with client and method parameters

310f453

Update the samples and skip console void result

eaf7545

Update the required body cases

0bfe1af

Merge branch 'sample-gen-ready-branch' of https://github.com/MaryGao/…

044787c

…autorest.typescript into pr/2770

fix ci

efe501a

MaryGao commented Sep 4, 2024

View reviewed changes

packages/typespec-ts/test/modularIntegration/generated/azure/example/basic/src/index.d.ts Show resolved Hide resolved

MaryGao added 4 commits September 5, 2024 11:15

update the deduplicateProperties

61da2ca

Merge branch 'sample-gen-ready-branch' of https://github.com/marygao/…

99d7154

…autorest.typescript into sample-gen-ready-branch

Merge remote-tracking branch 'origin/main' into sample-gen-ready-branch

0b6575d

Resolve conflicts

9b44440

MaryGao commented Sep 9, 2024

View reviewed changes

packages/autorest.typescript/src/generators/modelsGenerator.ts Outdated Show resolved Hide resolved

MaryGao added 5 commits September 9, 2024 17:20

Update packages/autorest.typescript/src/generators/modelsGenerator.ts

99d78b3

Resolve comments

ae61bd4

Update date and time cases

72af658

Update the sample with sperated file and json pair

7213fb4

Updated cases for hierachy and operation groups

e276359

MaryGao requested a review from qiaozha September 10, 2024 09:33

MaryGao added 3 commits September 10, 2024 17:35

Just renamings

3b10e58

Merge to main

adf158a

Merge remote-tracking branch 'origin/main' into sample-gen-ready-branch

0933004

MaryGao commented Sep 11, 2024

View reviewed changes

packages/typespec-ts/test/modularUnit/scenarios/samples/operations/multipleExamplesInOneFile.md Outdated Show resolved Hide resolved

Update the test cases

a8cf417

MaryGao mentioned this pull request Sep 11, 2024

Leverage binder to add client import in sample generation #2821

Open

lirenhe reviewed Sep 13, 2024

View reviewed changes

...tworkAnalytics.Management/generated/typespec-ts/samples-dev/dataProductsAddUserRoleSample.ts Show resolved Hide resolved

lirenhe reviewed Sep 13, 2024

View reviewed changes

...st/NetworkAnalytics.Management/generated/typespec-ts/samples-dev/dataProductsCreateSample.ts Show resolved Hide resolved

update the descriptions

9b185cb

qiaozha reviewed Sep 14, 2024

View reviewed changes

Skip optional body test cases

956fe2c

qiaozha approved these changes Sep 18, 2024

View reviewed changes

MaryGao merged commit 2d85b98 into Azure:main Sep 18, 2024
15 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sample generation for MPG for cliassical client #2770

Sample generation for MPG for cliassical client #2770

MaryGao commented Aug 26, 2024 •

edited

Loading

qiaozha Sep 14, 2024

MaryGao Sep 18, 2024 •

edited

Loading

qiaozha Sep 14, 2024

kazrael2119 Sep 14, 2024

MaryGao Sep 18, 2024

MaryGao Sep 18, 2024 •

edited

Loading

kazrael2119 Sep 18, 2024 •

edited

Loading

MaryGao Sep 18, 2024 •

edited

Loading

qiaozha Sep 14, 2024

MaryGao Sep 18, 2024 •

edited

Loading

Sample generation for MPG for cliassical client #2770

Sample generation for MPG for cliassical client #2770

Conversation

MaryGao commented Aug 26, 2024 • edited Loading

Non Scope

qiaozha Sep 14, 2024

Choose a reason for hiding this comment

MaryGao Sep 18, 2024 • edited Loading

Choose a reason for hiding this comment

qiaozha Sep 14, 2024

Choose a reason for hiding this comment

kazrael2119 Sep 14, 2024

Choose a reason for hiding this comment

MaryGao Sep 18, 2024

Choose a reason for hiding this comment

MaryGao Sep 18, 2024 • edited Loading

Choose a reason for hiding this comment

kazrael2119 Sep 18, 2024 • edited Loading

Choose a reason for hiding this comment

MaryGao Sep 18, 2024 • edited Loading

Choose a reason for hiding this comment

qiaozha Sep 14, 2024

Choose a reason for hiding this comment

MaryGao Sep 18, 2024 • edited Loading

Choose a reason for hiding this comment

MaryGao commented Aug 26, 2024 •

edited

Loading

MaryGao Sep 18, 2024 •

edited

Loading

MaryGao Sep 18, 2024 •

edited

Loading

kazrael2119 Sep 18, 2024 •

edited

Loading

MaryGao Sep 18, 2024 •

edited

Loading

MaryGao Sep 18, 2024 •

edited

Loading