Refactor the sample generation into rlc-common & Generate samples with mock content

.vscode/launch.json

@@ -27,6 +27,24 @@
         "${workspaceFolder}/packages/*/dist-dev/**/*.js"
       ]
     },
+    {
+      "name": "[Autorest] Run Debug Integration Test",
+      "request": "launch",
+      "cwd": "${workspaceFolder}/packages/autorest.typescript",
+      "runtimeArgs": [
+        "ts-node",
+        "./test/commands/test-swagger-gen.ts",
+        "--",
+        "rlc"
+      ],
+      "runtimeExecutable": "npx",
+      "skipFiles": ["<node_internals>/**"],
+      "type": "pwa-node",
+      "outFiles": [
+        "${workspaceFolder}/packages/*/dist/**/*.js",
+        "${workspaceFolder}/packages/*/dist-dev/**/*.js"
+      ]
+    },
     {
       "type": "node",
       "request": "launch",
@@ -84,7 +102,7 @@
     {
       "name": "[TypeSpec] Smoke Test Debug",
       "request": "launch",
-      "cwd": "${workspaceFolder}/packages/typespec-test/test/openai_modular",
+      "cwd": "${workspaceFolder}/packages/typespec-test/test/customWrapper",
       "runtimeArgs": ["tsp", "compile", "./spec"],
       "runtimeExecutable": "npx",
       "skipFiles": ["<node_internals>/**"],
@@ -98,7 +116,7 @@
       "runtimeArgs": [
         "ts-node",
         "./test/commands/gen-cadl-ranch.ts",
-        "--tag=modular",
+        "--tag=rlc",
         "--debug"
       ],
       "runtimeExecutable": "npx",

packages/autorest.typescript/src/generators/samples/rlcSampleGenerator.ts

@@ -2,86 +2,53 @@ import {
   ExampleParameter,
   TestCodeModel
 } from "@autorest/testmodeler/dist/src/core/model";
-import { Project } from "ts-morph";
 import { getAutorestOptions, getSession } from "../../autorestSession";
-import * as fs from "fs";
-import * as path from "path";
-import * as hbs from "handlebars";
 import { NameType, normalizeName } from "../../utils/nameUtils";
 import { getLanguageMetadata } from "../../utils/languageHelpers";
 import { transformBaseUrl } from "../../transforms/urlTransforms";
-import {
-  RLCSampleDetail,
-  RLCSampleGroup,
-  SampleParameter,
-  SampleParameters,
-  TestSampleParameters,
-  OperationMethod
-} from "../../restLevelClient/interfaces";
 import { camelCase } from "@azure-tools/codegen";
 import { Operation, ParameterLocation } from "@autorest/codemodel";
 import { isLongRunningOperation } from "../../restLevelClient/helpers/hasPollingOperations";
 import { isPagingOperation } from "../../utils/extractPaginationDetails";
 import { getSecurityInfoFromModel } from "../../utils/schemaHelpers";
 import { getParameterAssignment } from "../../utils/valueHelpers";
-import { Paths, PathMetadata } from "@azure-tools/rlc-common";
+import {
+  Paths,
+  PathMetadata,
+  RLCSampleGroup,
+  RLCSampleDetail,
+  SampleParameter,
+  SampleParameters,
+  OperationMethod,
+  SampleParameterPosition
+} from "@azure-tools/rlc-common";
 import { transformPaths } from "../../restLevelClient/transforms/transformPaths";
 
+type TestSampleParameters = Record<SampleParameterPosition, ExampleParameter[]>;
+
 const tokenCredentialPackage = "@azure/identity";
 const apiKeyCredentialPackage = "@azure/core-auth";
 
-export let hasRLCSamplesGenerated = false;
-
-export function generateRLCSamples(model: TestCodeModel, project: Project) {
+export function transformRLCSampleData(
+  model: TestCodeModel
+): RLCSampleGroup[] | undefined {
   const { generateSample, multiClient } = getAutorestOptions();
-  const session = getSession();
   if (!generateSample || !model?.testModel?.mockTest?.exampleGroups) {
     return;
   }
+  const session = getSession();
   // Currently only support single client
   if (multiClient) {
     session.info(
       "Not support to generate samples for multi-clients and return directly"
     );
     return;
   }
-  const sampleGroups: RLCSampleGroup[] = transformRLCSampleData(model);
-  if (sampleGroups.length > 0) {
-    hasRLCSamplesGenerated = true;
-  }
-  for (const sampleGroup of sampleGroups) {
-    try {
-      const file = fs.readFileSync(path.join(__dirname, "rlcSamples.ts.hbs"), {
-        encoding: "utf-8"
-      });
-      const sampleGroupFileContents = hbs.compile(file, { noEscape: true });
-      project.createSourceFile(
-        `samples-dev/${sampleGroup.filename}.ts`,
-        sampleGroupFileContents(sampleGroup),
-        {
-          overwrite: true
-        }
-      );
-    } catch (error) {
-      session.error(
-        "An error was encountered while handling sample generation",
-        [sampleGroup.filename]
-      );
-      session.error(
-        "Stop generating samples and please inform the developers of codegen the detailed errors",
-        []
-      );
-    }
-  }
-}
-
-export function transformRLCSampleData(model: TestCodeModel): RLCSampleGroup[] {
   const rlcSampleGroups: RLCSampleGroup[] = [];
   if (!model?.testModel?.mockTest?.exampleGroups) {
     return rlcSampleGroups;
   }
   // Get all paths
-  const session = getSession();
   const paths: Paths = transformPaths(model);
   const clientName = getLanguageMetadata(model.language).name;
   const clientInterfaceName = clientName.endsWith("Client")

packages/autorest.typescript/src/restLevelClient/generateRestLevel.ts

@@ -9,10 +9,6 @@ import { prettierJSONOptions, prettierTypeScriptOptions } from "./config";
 import * as path from "path";
 import * as fsextra from "fs-extra";
 import { generateSampleEnv } from "../generators/samples/sampleEnvGenerator";
-import {
-  generateRLCSamples,
-  hasRLCSamplesGenerated
-} from "../generators/samples/rlcSampleGenerator";
 import { transform } from "./transforms/transform";
 import {
   buildApiExtractorConfig,
@@ -36,13 +32,15 @@ import {
   buildLicenseFile,
   buildReadmeFile,
   buildSerializeHelper,
-  buildLogger
+  buildLogger,
+  buildSamples
 } from "@azure-tools/rlc-common";
 import {
   generateFileByBuilder,
   generateSchemaTypes,
   generateTopLevelIndexFile
 } from "./helpers/generatorHelpers";
+import { buildSamplesOnMockContent } from "@azure-tools/rlc-common";
 
 /**
  * Generates a Rest Level Client library
@@ -70,6 +68,14 @@ export async function generateRestLevelClient() {
 
   // then transform CodeModel to RLCModel
   const rlcModels = transform(model);
+  if (
+    generateSample === true &&
+    generateMetadata === true &&
+    (rlcModels.sampleGroups ?? []).length === 0
+  ) {
+    rlcModels.sampleGroups = buildSamplesOnMockContent(rlcModels);
+  }
+  const hasSampleGenerated = (rlcModels.sampleGroups ?? []).length > 0;
 
   if (generateMetadata) {
     // buildReadmeFile
@@ -118,31 +124,18 @@ export async function generateRestLevelClient() {
   generateFileByBuilder(project, buildSerializeHelper, rlcModels);
   generateFileByBuilder(project, buildLogger, rlcModels);
   generateTopLevelIndexFile(rlcModels, project);
-  if (generateSample && generateMetadata) {
-    generateRLCSamples(model, project);
+  if (hasSampleGenerated && generateMetadata) {
+    generateFileByBuilder(project, buildSamples, rlcModels);
   }
-  if (
-    ((generateSample && hasRLCSamplesGenerated) || generateTest) &&
-    generateMetadata
-  ) {
+  if ((hasSampleGenerated || generateTest) && generateMetadata) {
     generateSampleEnv(project);
   }
 
   if (generateMetadata) {
     // buildPackageFile
-    generateFileByBuilder(
-      project,
-      buildPackageFile,
-      rlcModels,
-      hasRLCSamplesGenerated
-    );
+    generateFileByBuilder(project, buildPackageFile, rlcModels);
     // buildTsConfig
-    generateFileByBuilder(
-      project,
-      buildTsConfig,
-      rlcModels,
-      hasRLCSamplesGenerated
-    );
+    generateFileByBuilder(project, buildTsConfig, rlcModels);
   }
 
   // Save the source files to the virtual filesystem

packages/autorest.typescript/src/restLevelClient/helpers/generatorHelpers.ts

@@ -9,18 +9,13 @@ import { buildSchemaTypes } from "@azure-tools/rlc-common";
 export function generateFileByBuilder(
   project: Project,
   buildFnOrList: ContentBuilder | ContentBuilder[],
-  rlcModels: RLCModel,
-  hasSampleGenerated?: boolean
+  rlcModels: RLCModel
 ) {
   if (!Array.isArray(buildFnOrList)) {
     buildFnOrList = [buildFnOrList];
   }
   for (const buildFn of buildFnOrList) {
-    const preparedFile: RLCFile | undefined = buildFn(
-      rlcModels,
-      hasSampleGenerated
-    );
-    generateFile(preparedFile, project);
+    generateFile(buildFn(rlcModels), project);
   }
 }
 
@@ -30,8 +25,17 @@ export function generateSchemaTypes(project: Project, rlcModels: RLCModel) {
   generateFile(outputModelFile, project);
 }
 
-function generateFile(file: RLCFile | undefined, project: Project) {
-  if (file) {
+function generateFile(
+  files: RLCFile[] | RLCFile | undefined,
+  project: Project
+) {
+  if (!files) {
+    return;
+  }
+  if (!Array.isArray(files)) {
+    files = [files];
+  }
+  for (const file of files) {
     project.createSourceFile(file.path, file.content, {
       overwrite: true
     });

packages/autorest.typescript/src/restLevelClient/transforms/transform.ts

@@ -34,6 +34,7 @@ import {
 import { transformPaths } from "./transformPaths";
 import { transformResponseTypes } from "./transformResponseTypes";
 import { transformSchemas } from "./transformSchemas";
+import { transformRLCSampleData } from "../../generators/samples/rlcSampleGenerator";
 
 export function transform(model: CodeModel): RLCModel {
   const { srcPath } = getAutorestOptions();
@@ -53,7 +54,8 @@ export function transform(model: CodeModel): RLCModel {
     parameters: transformParameterTypes(model, importDetails),
     helperDetails: transformHelperDetails(model),
     urlInfo: transformUrlInfo(model),
-    apiVersionInfo: transformApiVersion(model, urlInfo)
+    apiVersionInfo: transformApiVersion(model, urlInfo),
+    sampleGroups: transformRLCSampleData(model)
   };
   return rlcModel;
 }