@azure-tools/typespec-ts 0.56.0-dev.3 → 0.56.0-dev.6

package/src/metadata/test/build-recorded-client.ts

@@ -1,15 +1,9 @@
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore: to fix the handlebars issue
-import hbs from "handlebars";
 import { ClientModel } from "../../interfaces.js";
 import { recordedClientContent } from "./template.js";
 
 export function buildRecordedClientFile(_model: ClientModel) {
-  const recordedClientFileContents = hbs.compile(recordedClientContent, {
-    noEscape: true,
-  });
   return {
     path: "test/public/utils/recordedClient.ts",
-    content: recordedClientFileContents({}),
+    content: recordedClientContent,
   };
 }

package/src/metadata/test/build-sample-test.ts

@@ -1,12 +1,9 @@
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore: to fix the handlebars issue
-import hbs from "handlebars";
 import { ClientModel } from "../../interfaces.js";
 import { sampleTestContent } from "./template.js";
 
 export function buildSampleTest(_model: ClientModel) {
   return {
     path: "test/public/sampleTest.spec.ts",
-    content: hbs.compile(sampleTestContent, { noEscape: true })({}),
+    content: sampleTestContent,
   };
 }

package/src/metadata/test/build-snippets.ts

@@ -1,8 +1,6 @@
-// eslint-disable-next-line @typescript-eslint/ban-ts-comment
-// @ts-ignore: to fix the handlebars issue
-import hbs from "handlebars";
 import { ClientModel } from "../../interfaces.js";
 import { getClientName } from "../../utils/name-constructors.js";
+import { renderTemplate } from "../render-template.js";
 import { snippetsContent } from "./template.js";
 
 export function buildSnippets(model: ClientModel, clientName?: string) {
@@ -14,7 +12,7 @@ export function buildSnippets(model: ClientModel, clientName?: string) {
   ) {
     return {
       path: "test/snippets.spec.ts",
-      content: hbs.compile(snippetsContent, { noEscape: true })({
+      content: renderTemplate(snippetsContent, {
         clientClassName: clientName ? clientName : getClientName(model),
         azureArm: model.options?.azureArm,
         hasSubscriptionId: model.options.hasSubscriptionId,

package/src/metadata/test/template.ts

@@ -1,131 +1,3 @@
-export const karmaConfig = `
-// https://github.com/karma-runner/karma-chrome-launcher
-process.env.CHROME_BIN = require("puppeteer").executablePath();
-require("dotenv").config();
-const { relativeRecordingsPath } = require("@azure-tools/test-recorder");
-process.env.RECORDINGS_RELATIVE_PATH = relativeRecordingsPath();
-
-module.exports = function (config) {
-  config.set({
-    // base path that will be used to resolve all patterns (eg. files, exclude)
-    basePath: "./",
-
-    // frameworks to use
-    // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
-    frameworks: ["source-map-support", "mocha"],
-
-    plugins: [
-      "karma-mocha",
-      "karma-mocha-reporter",
-      "karma-chrome-launcher",
-      "karma-firefox-launcher",
-      "karma-env-preprocessor",
-      "karma-coverage",
-      "karma-sourcemap-loader",
-      "karma-junit-reporter",
-      "karma-source-map-support",
-    ],
-
-    // list of files / patterns to load in the browser
-    files: [
-      "dist-test/index.browser.js",
-      { pattern: "dist-test/index.browser.js.map", type: "html", included: false, served: true },
-    ],
-
-    // list of files / patterns to exclude
-    exclude: [],
-
-    // preprocess matching files before serving them to the browser
-    // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
-    preprocessors: {
-      "**/*.js": ["sourcemap", "env"],
-      // IMPORTANT: COMMENT following line if you want to debug in your browsers!!
-      // Preprocess source file to calculate code coverage, however this will make source file unreadable
-      // "dist-test/index.js": ["coverage"]
-    },
-
-    envPreprocessor: [
-      "TEST_MODE",
-      "ENDPOINT",
-      "AZURE_CLIENT_SECRET",
-      "AZURE_CLIENT_ID",
-      "AZURE_TENANT_ID",
-      "SUBSCRIPTION_ID",
-      "RECORDINGS_RELATIVE_PATH",
-    ],
-
-    // test results reporter to use
-    // possible values: 'dots', 'progress'
-    // available reporters: https://npmjs.org/browse/keyword/karma-reporter
-    reporters: ["mocha", "coverage", "junit"],
-
-    coverageReporter: {
-      // specify a common output directory
-      dir: "coverage-browser/",
-      reporters: [
-        { type: "json", subdir: ".", file: "coverage.json" },
-        { type: "lcovonly", subdir: ".", file: "lcov.info" },
-        { type: "html", subdir: "html" },
-        { type: "cobertura", subdir: ".", file: "cobertura-coverage.xml" },
-      ],
-    },
-
-    junitReporter: {
-      outputDir: "", // results will be saved as $outputDir/$browserName.xml
-      outputFile: "test-results.browser.xml", // if included, results will be saved as $outputDir/$browserName/$outputFile
-      suite: "", // suite will become the package name attribute in xml testsuite element
-      useBrowserName: false, // add browser name to report and classes names
-      nameFormatter: undefined, // function (browser, result) to customize the name attribute in xml testcase element
-      classNameFormatter: undefined, // function (browser, result) to customize the classname attribute in xml testcase element
-      properties: {}, // key value pair of properties to add to the <properties> section of the report
-    },
-
-    // web server port
-    port: 9876,
-
-    // enable / disable colors in the output (reporters and logs)
-    colors: true,
-
-    // level of logging
-    // possible values: config.LOG_DISABLE || config.LOG_ERROR || config.LOG_WARN || config.LOG_INFO || config.LOG_DEBUG
-    logLevel: config.LOG_INFO,
-
-    // enable / disable watching file and executing tests whenever any file changes
-    autoWatch: false,
-
-    // --no-sandbox allows our tests to run in Linux without having to change the system.
-    // --disable-web-security allows us to authenticate from the browser without having to write tests using interactive auth, which would be far more complex.
-    browsers: ["ChromeHeadlessNoSandbox"],
-    customLaunchers: {
-      ChromeHeadlessNoSandbox: {
-        base: "ChromeHeadless",
-        flags: ["--no-sandbox", "--disable-web-security"],
-      },
-    },
-
-    // Continuous Integration mode
-    // if true, Karma captures browsers, runs the tests and exits
-    singleRun: false,
-
-    // Concurrency level
-    // how many browser should be started simultaneous
-    concurrency: 1,
-
-    browserNoActivityTimeout: 60000000,
-    browserDisconnectTimeout: 10000,
-    browserDisconnectTolerance: 3,
-
-    client: {
-      mocha: {
-        // change Karma's debug.html to the mocha web reporter
-        reporter: "html",
-        timeout: "600000",
-      },
-    },
-  });
-};
-`;
-
 export const recordedClientContent = `
 
 import {

package/src/modular/build-root-index.ts

@@ -1,8 +1,15 @@
 import { SdkClientType, SdkServiceOperation } from "@azure-tools/typespec-client-generator-core";
 import { joinPaths, NoTarget } from "@typespec/compiler";
-import { Project, SourceFile } from "ts-morph";
+import { Project, SourceFile, StructureKind } from "ts-morph";
 import { useContext } from "../context-manager.js";
 import { resolveReference } from "../framework/reference.js";
+import {
+  beginSourceFileBatch,
+  enqueueStatement,
+  flushSourceFileBatch,
+  getEffectiveExportedNames,
+  getQueuedExportNames,
+} from "../framework/source-file-batch.js";
 import { reportDiagnostic } from "../lib.js";
 import { getClientModuleInfo } from "../utils/client-utils.js";
 import { SdkContext } from "../utils/interfaces.js";
@@ -24,6 +31,20 @@ export function buildRootIndex(
   emitterOptions: ModularEmitterOptions,
   rootIndexFile: SourceFile,
   clientMap?: [string[], SdkClientType<SdkServiceOperation>],
+) {
+  beginSourceFileBatch();
+  try {
+    buildRootIndexImpl(context, emitterOptions, rootIndexFile, clientMap);
+  } finally {
+    flushSourceFileBatch();
+  }
+}
+
+function buildRootIndexImpl(
+  context: SdkContext,
+  emitterOptions: ModularEmitterOptions,
+  rootIndexFile: SourceFile,
+  clientMap?: [string[], SdkClientType<SdkServiceOperation>],
 ) {
   if (!clientMap) {
     // we still need to export the models if no client is provided
@@ -109,7 +130,8 @@ function exportRestErrorTypes(rootIndexFile: SourceFile) {
   const existingExports = getExistingExports(rootIndexFile);
   const namedExports = ["RestError", "isRestError"].filter((name) => !existingExports.has(name));
   if (namedExports.length > 0) {
-    rootIndexFile.addExportDeclaration({
+    enqueueStatement(rootIndexFile, {
+      kind: StructureKind.ExportDeclaration,
       moduleSpecifier: "@azure/core-rest-pipeline",
       namedExports,
     });
@@ -165,13 +187,7 @@ function exportFileContentsType(context: SdkContext, rootIndexFile: SourceFile)
 }
 
 function getExistingExports(rootIndexFile: SourceFile): Set<string> {
-  return new Set(
-    rootIndexFile
-      .getExportDeclarations()
-      .flatMap((exportDecl) =>
-        exportDecl.getNamedExports().map((namedExport) => namedExport.getName()),
-      ),
-  );
+  return getEffectiveExportedNames(rootIndexFile);
 }
 
 function getNewNamedExports(namedExports: string[], existingExports: Set<string>): string[] {
@@ -186,7 +202,8 @@ function addExportsToRootIndexFile(
   const existingExports = getExistingExports(rootIndexFile);
   const newNamedExports = getNewNamedExports(namedExports, existingExports);
   if (newNamedExports.length > 0) {
-    rootIndexFile.addExportDeclaration({
+    enqueueStatement(rootIndexFile, {
+      kind: StructureKind.ExportDeclaration,
       isTypeOnly,
       namedExports: newNamedExports,
     });
@@ -222,7 +239,8 @@ function exportSimplePollerLike(
   const moduleSpecifier = `./${
     isTopLevel && subfolder && subfolder !== "" ? subfolder + "/" : ""
   }static-helpers/simplePollerHelpers.js`;
-  indexFile.addExportDeclaration({
+  enqueueStatement(indexFile, {
+    kind: StructureKind.ExportDeclaration,
     isTypeOnly: true,
     moduleSpecifier,
     namedExports: ["SimplePollerLike"],
@@ -243,7 +261,10 @@ function exportRestoreHelpers(
   if (!helperFile) {
     return;
   }
-  const exported = new Set(indexFile.getExportedDeclarations().keys());
+  const exported = new Set([
+    ...indexFile.getExportedDeclarations().keys(),
+    ...getQueuedExportNames(indexFile),
+  ]);
   const allEntries = [...helperFile.getExportedDeclarations().entries()];
   const moduleSpecifier = `./${
     isTopLevel && subfolder && subfolder !== "" ? subfolder + "/" : ""
@@ -259,7 +280,8 @@ function exportClassicalClient(
   isSubClient: boolean = false,
 ) {
   const clientName = client.name;
-  indexFile.addExportDeclaration({
+  enqueueStatement(indexFile, {
+    kind: StructureKind.ExportDeclaration,
     namedExports: [clientName],
     moduleSpecifier: `./${
       subfolder && subfolder !== "" && !isSubClient ? subfolder + "/" : ""
@@ -321,7 +343,10 @@ function exportModules(
       continue;
     }
 
-    const exported = new Set(indexFile.getExportedDeclarations().keys());
+    const exported = new Set([
+      ...indexFile.getExportedDeclarations().keys(),
+      ...getQueuedExportNames(indexFile),
+    ]);
     const serializerOrDeserializerRegex = /.*(Serializer|Deserializer)(_\d+)?$/;
     const filteredEntries = [...modelsFile.getExportedDeclarations().entries()].filter(
       (exDeclaration) => {
@@ -362,6 +387,19 @@ export function buildSubClientIndexFile(
   context: SdkContext,
   clientMap: [string[], SdkClientType<SdkServiceOperation>],
   emitterOptions: ModularEmitterOptions,
+) {
+  beginSourceFileBatch();
+  try {
+    buildSubClientIndexFileImpl(context, clientMap, emitterOptions);
+  } finally {
+    flushSourceFileBatch();
+  }
+}
+
+function buildSubClientIndexFileImpl(
+  context: SdkContext,
+  clientMap: [string[], SdkClientType<SdkServiceOperation>],
+  emitterOptions: ModularEmitterOptions,
 ) {
   const project = useContext("outputProject");
   const [_, client] = clientMap;

package/src/modular/build-subpath-index.ts

@@ -2,8 +2,13 @@ import { SdkClientType, SdkServiceOperation } from "@azure-tools/typespec-client
 import { joinPaths } from "@typespec/compiler";
 import { ModularEmitterOptions } from "./interfaces.js";
 
-import { Node, SourceFile } from "ts-morph";
+import { Node, SourceFile, StructureKind } from "ts-morph";
 import { useContext } from "../context-manager.js";
+import {
+  beginSourceFileBatch,
+  enqueueStatement,
+  flushSourceFileBatch,
+} from "../framework/source-file-batch.js";
 import { getClientModuleInfo } from "../utils/client-utils.js";
 
 export interface buildSubpathIndexFileOptions {
@@ -17,6 +22,20 @@ export function buildSubpathIndexFile(
   subpath: string,
   clientMap?: [string[], SdkClientType<SdkServiceOperation>],
   options: buildSubpathIndexFileOptions = {},
+) {
+  beginSourceFileBatch();
+  try {
+    buildSubpathIndexFileImpl(emitterOptions, subpath, clientMap, options);
+  } finally {
+    flushSourceFileBatch();
+  }
+}
+
+function buildSubpathIndexFileImpl(
+  emitterOptions: ModularEmitterOptions,
+  subpath: string,
+  clientMap?: [string[], SdkClientType<SdkServiceOperation>],
+  options: buildSubpathIndexFileOptions = {},
 ) {
   const project = useContext("outputProject");
   const subfolder = clientMap ? (getClientModuleInfo(clientMap).subfolder ?? "") : "";
@@ -137,14 +156,16 @@ export function partitionAndEmitExports(
     }
   }
   if (typeOnlyExports.length > 0) {
-    indexFile.addExportDeclaration({
+    enqueueStatement(indexFile, {
+      kind: StructureKind.ExportDeclaration,
       isTypeOnly: true,
       moduleSpecifier,
       namedExports: typeOnlyExports,
     });
   }
   if (valueExports.length > 0) {
-    indexFile.addExportDeclaration({
+    enqueueStatement(indexFile, {
+      kind: StructureKind.ExportDeclaration,
       moduleSpecifier,
       namedExports: valueExports,
     });

package/src/modular/emit-models.ts

@@ -46,6 +46,7 @@ import {
   pagedModelsKeptPublic,
 } from "../framework/hooks/sdk-types.js";
 import { refkey } from "../framework/refkey.js";
+import { beginSourceFileBatch, flushSourceFileBatch } from "../framework/source-file-batch.js";
 import { reportDiagnostic } from "../lib.js";
 import { getClientHierarchyMap } from "../utils/client-utils.js";
 import { SdkContext } from "../utils/interfaces.js";
@@ -117,32 +118,37 @@ export function emitTypes(context: SdkContext, { sourceRoot }: { sourceRoot: str
 
   let sourceFile;
 
-  for (const type of emitQueue) {
-    if (!isGenerableType(type)) {
-      continue;
-    }
+  beginSourceFileBatch();
+  try {
+    for (const type of emitQueue) {
+      if (!isGenerableType(type)) {
+        continue;
+      }
 
-    const namespaces = getModelNamespaces(context, type);
-    const filepath = getModelsPath(sourceRoot, namespaces);
-    sourceFile = outputProject.getSourceFile(filepath);
-    if (!sourceFile) {
-      sourceFile = outputProject.createSourceFile(filepath);
-      sourceFile.addStatements(`/**
+      const namespaces = getModelNamespaces(context, type);
+      const filepath = getModelsPath(sourceRoot, namespaces);
+      sourceFile = outputProject.getSourceFile(filepath);
+      if (!sourceFile) {
+        sourceFile = outputProject.createSourceFile(filepath);
+        sourceFile.addStatements(`/*
 * This file contains only generated model types and their (de)serializers.
 * Disable the following rules for internal models with '_' prefix and deserializers which require 'any' for raw JSON input.
 */
 /* eslint-disable @typescript-eslint/naming-convention */
 /* eslint-disable @typescript-eslint/explicit-module-boundary-types */`);
+      }
+      emitType(context, type, sourceFile);
     }
-    emitType(context, type, sourceFile);
-  }
 
-  // Emit serialization/deserialization functions for flattened properties
-  for (const [property, _] of flattenPropertyModelMap) {
-    const namespaces = getModelNamespaces(context, property.type);
-    const filepath = getModelsPath(sourceRoot, namespaces);
-    sourceFile = outputProject.getSourceFile(filepath);
-    addSerializationFunctions(context, property, sourceFile!);
+    // Emit serialization/deserialization functions for flattened properties
+    for (const [property, _] of flattenPropertyModelMap) {
+      const namespaces = getModelNamespaces(context, property.type);
+      const filepath = getModelsPath(sourceRoot, namespaces);
+      sourceFile = outputProject.getSourceFile(filepath);
+      addSerializationFunctions(context, property, sourceFile!);
+    }
+  } finally {
+    flushSourceFileBatch();
   }
 
   const modelFiles = outputProject.getSourceFiles(sourceRoot + "/models/**/*.ts");

package/src/transform/transform-client-options.ts

@@ -44,7 +44,6 @@ function extractClientOptions(
   const enableModelNamespace = getEnableModelNamespace(dpgContext, emitterOptions);
   const hierarchyClient = getHierarchyClient(emitterOptions);
   const clearOutputFolder = getClearOutputFolder(emitterOptions);
-  const isTypeSpecTest = emitterOptions["is-typespec-test"];
   const compatibilityMode = emitterOptions["compatibility-mode"];
   const compatibilityLro = emitterOptions["compatibility-lro"];
   const experimentalExtensibleEnums = emitterOptions["experimental-extensible-enums"];
@@ -73,7 +72,6 @@ function extractClientOptions(
     hierarchyClient,
     azureArm: dpgContext.arm,
     clearOutputFolder,
-    isTypeSpecTest,
     compatibilityMode,
     compatibilityLro,
     experimentalExtensibleEnums,