@autorest/typescript 6.0.0-beta.7 → 6.0.0-rc.1

package/src/generators/static/readmeFileGenerator.ts

@@ -5,9 +5,11 @@ import { Project } from "ts-morph";
 import * as hbs from "handlebars";
 import * as fs from "fs";
 import * as path from "path";
-import { ClientDetails } from "../../models/clientDetails";
 import { getAutorestOptions } from "../../autorestSession";
-import { PackageDetails } from "../../models/packageDetails";
+import { CodeModel, Info, Languages } from "@autorest/codemodel";
+import { getLanguageMetadata } from "../../utils/languageHelpers";
+import { normalizeName, NameType } from "../../utils/nameUtils";
+import { getSecurityInfoFromModel } from "../../utils/schemaHelpers";
 
 /**
  * Meta data information about the service, the package, and the client.
@@ -47,22 +49,40 @@ interface Metadata {
   addCredentials?: boolean;
   /** The link to the identity package in the repository */
   identityPackageURL?: string;
+  /** Indicates if the package is a test/releasable package. */
+  isReleasablePackage?: boolean;
+  /** indicate if the package is management plane SDK */
+  azureArm?: boolean;
+  /** The URL for the service document */
+  serviceDocURL?: string;
+  /** The dependency info for this service */
+  dependencyDescription?: string;
+  dependencyLink?: string;
+  /** Indicates if the package is a multi-client */
+  hasMultiClients?: boolean;
 }
 
 /**
  * Returns meta data information about the service, the package, and the client.
- * @param clientDetails - the client details
- * @param packageDetails - the package details
+ * @param codeModel - include the client details
  * @returns inferred metadata about the service, the package, and the client
  */
-function createMetadata(
-  packageDetails: PackageDetails,
-  clientDetails: ClientDetails,
-  azureOutputDirectory?: string,
-  addCredentials?: boolean,
-  azureArm?: boolean
-): Metadata {
-  const azureHuh = packageDetails.scopeName === "azure";
+function createMetadata(codeModel: CodeModel): Metadata {
+  const {
+    packageDetails,
+    azureOutputDirectory,
+    azureArm,
+    isTestPackage,
+    productDocLink,
+    dependencyInfo,
+    multiClient,
+    batch
+  } = getAutorestOptions();
+  const { addCredentials } = getSecurityInfoFromModel(codeModel.security);
+
+  const azureHuh =
+    packageDetails?.scopeName === "azure" ||
+    packageDetails?.scopeName === "azure-rest";
   const repoURL = azureHuh
     ? "https://github.com/Azure/azure-sdk-for-js"
     : undefined;
@@ -70,14 +90,21 @@ function createMetadata(
   const packageSourceURL =
     relativePackageSourcePath &&
     repoURL &&
-    `${repoURL}/tree/master/${relativePackageSourcePath}`;
+    `${repoURL}/tree/main/${relativePackageSourcePath}`;
   const names = relativePackageSourcePath?.split("/").slice(1);
   const packageParentDirectoryName = names?.[0];
   const packageDirectoryName = names?.[1];
-  const clientClassName = clientDetails.name;
-  const clientPackageName = packageDetails.name;
-  const serviceTitle = clientDetails.info?.title ?? clientClassName;
-  const simpleServiceName =
+
+  const clientPackageName = packageDetails?.name;
+  const { clientClassName, serviceTitle } = getClientAndServiceName(
+    codeModel.language,
+    codeModel.info
+  );
+  let simpleServiceName =
+    batch && batch.length > 1
+      ? normalizeName(packageDetails.nameWithoutScope, NameType.Class)
+      : normalizeName(serviceTitle, NameType.Class);
+  simpleServiceName =
     /**
      * It is a required convention in Azure swaggers for their titles to end with
      * "Client".
@@ -87,14 +114,21 @@ function createMetadata(
     serviceTitle.match(/(.*)Client/)?.[1] ??
     clientClassName.match(/(.*)Client/)?.[1] ??
     serviceTitle.match(/(.*) Service/)?.[1] ??
-    "Service";
+    simpleServiceName;
+
   const serviceName = azureHuh
     ? simpleServiceName.startsWith("Azure")
       ? simpleServiceName
       : `Azure ${simpleServiceName}`
     : simpleServiceName;
   const identityPackageURL =
-    repoURL && `${repoURL}/tree/master/sdk/identity/identity`;
+    repoURL && `${repoURL}/tree/main/sdk/identity/identity`;
+
+  var apiRefUrlQueryParameter: string = "";
+  if (packageDetails?.version.includes("beta")) {
+    apiRefUrlQueryParameter = "?view=azure-node-preview";
+  }
+
   return {
     serviceName: serviceName,
     clientPackageName: clientPackageName,
@@ -112,42 +146,36 @@ function createMetadata(
         `https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2F${packageParentDirectoryName}%2F${packageDirectoryName}%2FREADME.png`
       : undefined,
     clientDescriptiveName: `${serviceName} client`,
-    description: clientDetails.info?.description,
+    description: codeModel.info?.description,
     apiRefURL: azureHuh
-      ? `https://docs.microsoft.com/javascript/api/${clientPackageName}`
+      ? `https://docs.microsoft.com/javascript/api/${clientPackageName}${apiRefUrlQueryParameter}`
       : undefined,
     packageNPMURL: `https://www.npmjs.com/package/${clientPackageName}`,
-    contributingGuideURL: repoURL && `${repoURL}/blob/master/CONTRIBUTING.md`,
+    contributingGuideURL: repoURL && `${repoURL}/blob/main/CONTRIBUTING.md`,
     projectName: azureHuh ? "Microsoft Azure SDK for JavaScript" : undefined,
     addCredentials,
-    identityPackageURL
+    identityPackageURL,
+    isReleasablePackage: !isTestPackage,
+    azureArm: azureArm,
+    serviceDocURL: productDocLink,
+    dependencyDescription: dependencyInfo?.description,
+    dependencyLink: dependencyInfo?.link,
+    hasMultiClients: multiClient && batch && batch.length > 1
   };
 }
 
-export function generateReadmeFile(
-  clientDetails: ClientDetails,
-  project: Project
-) {
-  const {
-    packageDetails,
-    azureOutputDirectory,
-    generateMetadata,
-    addCredentials,
-    azureArm
-  } = getAutorestOptions();
+export function generateReadmeFile(codeModel: CodeModel, project: Project) {
+  const { generateMetadata, restLevelClient } = getAutorestOptions();
 
   if (!generateMetadata) {
     return;
   }
 
-  const metadata = createMetadata(
-    packageDetails,
-    clientDetails,
-    azureOutputDirectory,
-    addCredentials,
-    azureArm
-  );
-  const file = fs.readFileSync(path.join(__dirname, "README.md.hbs"), {
+  const metadata = createMetadata(codeModel);
+  const templateFile = !restLevelClient
+    ? "hlcREADME.md.hbs"
+    : "rlcREADME.md.hbs";
+  const file = fs.readFileSync(path.join(__dirname, templateFile), {
     encoding: "utf-8"
   });
   const readmeFileContents = hbs.compile(file, { noEscape: true });
@@ -155,3 +183,18 @@ export function generateReadmeFile(
     overwrite: true
   });
 }
+
+function getClientAndServiceName(
+  codeModelLanguage: Languages,
+  codeModelInfo: Info
+) {
+  const { name: clientName } = getLanguageMetadata(codeModelLanguage);
+  const className = normalizeName(
+    clientName,
+    NameType.Class,
+    true /** shouldGuard */
+  );
+  const clientClassName = className;
+  const serviceTitle = codeModelInfo?.title ?? clientClassName;
+  return { clientClassName, serviceTitle };
+}

package/src/generators/static/rlcREADME.md.hbs

@@ -0,0 +1,71 @@
+# {{ clientDescriptiveName }} library for JavaScript
+
+{{ description }}
+
+**Please rely heavily on {{#if serviceDocURL}}[the service's documentation]({{ serviceDocURL }}) and {{/if}}our [REST client docs](https://github.com/Azure/azure-sdk-for-js/blob/main/documentation/rest-clients.md) to use this library**
+
+Key links:
+
+{{#if packageSourceURL}}
+- [Source code]({{ packageSourceURL }})
+{{/if}}
+{{#if packageNPMURL}}
+- [Package (NPM)]({{ packageNPMURL }})
+{{/if}}
+{{#if apiRefURL}}
+- [API reference documentation]({{ apiRefURL }})
+{{/if}}
+{{#if serviceDocURL}}
+- [Product documentation]({{ serviceDocURL }})
+{{/if}}
+{{#if samplesURL}}
+- [Samples]({{ samplesURL }})
+{{/if}}
+
+## Getting started
+
+### Currently supported environments
+
+- Node.js version 14.x.x or higher
+
+### Prerequisites
+
+- You must have an [Azure subscription](https://azure.microsoft.com/free/){{#if dependencyLink}} and follow [these]({{ dependencyLink }}) instructions{{/if}} to use this package.
+
+### Install the `{{ clientPackageName }}` package
+
+Install the {{ clientDescriptiveName }} REST client library for JavaScript with `npm`:
+
+```bash
+npm install {{ clientPackageName }}
+```
+
+### Create and authenticate a `{{ clientClassName }}`
+
+To use an [Azure Active Directory (AAD) token credential](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/identity/identity/samples/AzureIdentityExamples.md#authenticating-with-a-pre-fetched-access-token),
+provide an instance of the desired credential type obtained from the
+[@azure/identity](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) library.
+
+To authenticate with AAD, you must first `npm` install [`@azure/identity`](https://www.npmjs.com/package/@azure/identity) {{#if dependencyLink}}and
+[{{dependencyDescription }}]({{ dependencyLink }}){{/if}}
+
+After setup, you can choose which type of [credential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#credentials) from `@azure/identity` to use.
+As an example, [DefaultAzureCredential](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/identity/identity#defaultazurecredential)
+can be used to authenticate the client.
+
+Set the values of the client ID, tenant ID, and client secret of the AAD application as environment variables:
+AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET
+
+## Troubleshooting
+
+### Logging
+
+Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
+
+```javascript
+import { setLogLevel } from "@azure/logger";
+
+setLogLevel("info");
+```
+
+For more detailed instructions on how to enable logs, you can look at the [@azure/logger package docs](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/logger).

package/src/generators/static/rollupConfigFileGenerator.ts

@@ -5,12 +5,17 @@ import { Project } from "ts-morph";
 import { getAutorestOptions } from "../../autorestSession";
 
 export function generateRollupConfig(project: Project) {
-  const { generateMetadata } = getAutorestOptions();
+  const { generateMetadata, restLevelClient, azureSdkForJs } = getAutorestOptions();
 
   if (!generateMetadata) {
     return;
   }
 
+  // when it's generating rlc codes, only generate rollup config in codegen test
+  if (restLevelClient && azureSdkForJs) {
+    return;
+  }
+
   const rollupFile = project.createSourceFile("rollup.config.js", undefined, {
     overwrite: true
   });
@@ -24,62 +29,14 @@ export function generateRollupConfig(project: Project) {
     
     import nodeBuiltins from "builtin-modules";
     
-    /**
-     * Gets the proper configuration needed for rollup's commonJS plugin for @opentelemetry/api.
-     *
-     * NOTE: this manual configuration is only needed because OpenTelemetry uses an
-     * __exportStar downleveled helper function to declare its exports which confuses
-     * rollup's automatic discovery mechanism.
-     *
-     * @returns an object reference that can be \`...\`'d into your cjs() configuration.
-     */
-    export function openTelemetryCommonJs() {
-      const namedExports = {};
-    
-      for (const key of [
-        "@opentelemetry/api",
-        "@azure/core-tracing/node_modules/@opentelemetry/api"
-      ]) {
-        namedExports[key] = [
-          "SpanKind",
-          "TraceFlags",
-          "getSpan",
-          "setSpan",
-          "SpanStatusCode",
-          "getSpanContext",
-          "setSpanContext"
-        ];
-      }
-    
-      const releasedOpenTelemetryVersions = ["0.10.2", "1.0.0-rc.0"];
-    
-      for (const version of releasedOpenTelemetryVersions) {
-        namedExports[
-          // working around a limitation in the rollup common.js plugin - it's not able to resolve these modules so the named exports listed above will not get applied. We have to drill down to the actual path.
-          \`../../../common/temp/node_modules/.pnpm/@opentelemetry/api@\${version}/node_modules/@opentelemetry/api/build/src/index.js\`
-        ] = [
-            "SpanKind",
-            "TraceFlags",
-            "getSpan",
-            "setSpan",
-            "StatusCode",
-            "CanonicalCode",
-            "getSpanContext",
-            "setSpanContext"
-          ];
-      }
-    
-      return namedExports;
-    }
-    
     // #region Warning Handler
     
     /**
-     * A function that can determine whether a rollupwarning should be ignored. If
+     * A function that can determine whether a rollup warning should be ignored. If
      * the function returns \`true\`, then the warning will not be displayed.
      */
     
-    function ignoreNiseSinonEvalWarnings(warning) {
+    function ignoreNiseSinonEval(warning) {
       return (
         warning.code === "EVAL" &&
         (warning.id && ((warning.id.includes("node_modules/nise")) ||
@@ -87,7 +44,7 @@ export function generateRollupConfig(project: Project) {
       );
     }
     
-    function ignoreChaiCircularDependencyWarnings(warning) {
+    function ignoreChaiCircularDependency(warning) {
       return (
         warning.code === "CIRCULAR_DEPENDENCY" &&
         (warning.importer && warning.importer.includes("node_modules/chai") === true)
@@ -95,8 +52,8 @@ export function generateRollupConfig(project: Project) {
     }
     
     const warningInhibitors = [
-      ignoreChaiCircularDependencyWarnings,
-      ignoreNiseSinonEvalWarnings
+      ignoreChaiCircularDependency,
+      ignoreNiseSinonEval
     ];
     
     /**
@@ -131,22 +88,7 @@ export function generateRollupConfig(project: Project) {
           nodeResolve({
             mainFields: ["module", "browser"]
           }),
-          cjs({
-            namedExports: {
-              // Chai's strange internal architecture makes it impossible to statically
-              // analyze its exports.
-              chai: [
-                "version",
-                "use",
-                "util",
-                "config",
-                "expect",
-                "should",
-                "assert"
-              ],
-              ...openTelemetryCommonJs()
-            }
-          }),
+          cjs(),
           json(),
           sourcemaps()
           //viz({ filename: "dist-test/browser-stats.html", sourcemap: true })
@@ -185,7 +127,7 @@ export function generateRollupConfig(project: Project) {
         ],
         output: { file: "dist/index.js", format: "cjs", sourcemap: true },
         preserveSymlinks: false,
-        plugins: [sourcemaps(), nodeResolve(), cjs()]
+        plugins: [sourcemaps(), nodeResolve()]
       };
     
       const config = [baseConfig];

package/src/generators/static/tsConfigFileGenerator.ts

@@ -4,7 +4,7 @@
 import { Project } from "ts-morph";
 import { getAutorestOptions } from "../../autorestSession";
 
-const highLevelTsConfig = {
+const highLevelTsConfig: Record<string, any> = {
   compilerOptions: {
     module: "es6",
     moduleResolution: "node",
@@ -15,43 +15,77 @@ const highLevelTsConfig = {
     esModuleInterop: true,
     allowSyntheticDefaultImports: true,
     forceConsistentCasingInFileNames: true,
-    preserveConstEnums: true,
     lib: ["es6", "dom"],
     declaration: true,
-    outDir: "./esm",
+    outDir: "./dist-esm",
     importHelpers: true
   },
   include: ["./src/**/*.ts"],
   exclude: ["node_modules"]
 };
 
-const restLevelTsConfig = {
-  compilerOptions: {
-    module: "es6",
-    target: "es2015",
-    moduleResolution: "node",
-    declaration: true,
-    declarationMap: true,
-    outDir: "./esm"
+
+const restLevelTsConfigInAzureSdkForJs: Record<string, any> = {
+  "extends": "../../../tsconfig.package",
+  "compilerOptions": {
+    "outDir": "./dist-esm",
+    "declarationDir": "./types",
   },
-  exclude: [
-    "node_modules",
-    "types",
-    "temp",
-    "browser",
-    "dist",
-    "dist-esm",
-    "./samples/**/*.ts"
-  ]
+  "include": ["src/**/*.ts"]
 };
 
+const restLevelTsConfigNotInAzureSdkForJs: Record<string, any> = {
+  "compilerOptions": {
+    "target": "ES2017",
+    "module": "es6",
+    "lib": [],
+    "declaration": true,
+    "declarationMap": true,
+    "inlineSources": true,
+    "sourceMap": true,
+    "importHelpers": true,
+    "strict": true,
+    "alwaysStrict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "outDir": "./dist-esm",
+    "declarationDir": "./types"
+  },
+  "include": ["./src/**/*.ts"]
+}
+
+
 export function generateTsConfig(project: Project) {
-  const { generateMetadata, restLevelClient } = getAutorestOptions();
+  const { generateMetadata, restLevelClient, generateTest, packageDetails, generateSample, azureSdkForJs } = getAutorestOptions();
 
   if (!generateMetadata) {
     return;
   }
 
+  const clientPackageName = packageDetails.name;
+
+  const restLevelTsConfig = azureSdkForJs ? restLevelTsConfigInAzureSdkForJs : restLevelTsConfigNotInAzureSdkForJs;
+
+  if (generateTest) {
+    highLevelTsConfig.include.push("./test/**/*.ts");
+    restLevelTsConfig.include.push("./test/**/*.ts");
+  }
+
+  if (generateSample) {
+    highLevelTsConfig.include.push("samples-dev/**/*.ts");
+    highLevelTsConfig.compilerOptions["paths"] = {};
+    highLevelTsConfig.compilerOptions["paths"][clientPackageName] = ["./src/index"];
+    restLevelTsConfig.include.push("samples-dev/**/*.ts");
+    restLevelTsConfig.compilerOptions["paths"] = {};
+    restLevelTsConfig.compilerOptions["paths"][clientPackageName] = ["./src/index"];
+  }
+
   const tsConfigContents = restLevelClient
     ? restLevelTsConfig
     : highLevelTsConfig;

package/src/generators/test/envBrowserFileGenerator.ts

@@ -0,0 +1,14 @@
+import { Project } from "ts-morph";
+import { getAutorestOptions } from "../../autorestSession";
+
+export function generateEnvBrowserFile(
+  project: Project
+) {
+  const { generateTest, restLevelClient } = getAutorestOptions();
+  if (!generateTest || !restLevelClient) {
+    return;
+  }
+  project.createSourceFile("test/public/utils/env.browser.ts", "", {
+    overwrite: true
+  });
+}

package/src/generators/test/envFileGenerator.ts

@@ -0,0 +1,22 @@
+import { Project } from "ts-morph";
+import * as path from 'path';
+import * as fs from 'fs';
+import * as hbs from "handlebars";
+import { getAutorestOptions } from "../../autorestSession";
+
+export function generateEnvFile(
+    project: Project
+  ) {
+    const { generateTest, restLevelClient } = getAutorestOptions();
+    if (!generateTest || !restLevelClient) {
+      return;
+    }
+    const metadata = {}
+    const file = fs.readFileSync(path.join(__dirname, "rlcEnv.ts.hbs"), {
+      encoding: "utf-8"
+    });
+    const envFileContents = hbs.compile(file, { noEscape: true });
+    project.createSourceFile("test/public/utils/env.ts", envFileContents(metadata), {
+      overwrite: true
+    });
+  }

package/src/generators/test/recordedClientFileGenerator.ts

@@ -0,0 +1,22 @@
+import { Project } from "ts-morph";
+import * as path from 'path';
+import * as fs from 'fs';
+import * as hbs from "handlebars";
+import { getAutorestOptions } from "../../autorestSession";
+
+export function generateRecordedClientFile(
+    project: Project
+  ) {
+    const { generateTest, restLevelClient } = getAutorestOptions();
+    if (!generateTest || !restLevelClient) {
+      return;
+    }
+    const metadata = {}
+    const file = fs.readFileSync(path.join(__dirname, "rlcRecordedClient.ts.hbs"), {
+      encoding: "utf-8"
+    });
+    const recordedClientFileContents = hbs.compile(file, { noEscape: true });
+    project.createSourceFile("test/public/utils/recordedClient.ts", recordedClientFileContents(metadata), {
+      overwrite: true
+    });
+  }

package/src/generators/test/rlcEnv.ts.hbs

@@ -0,0 +1,3 @@
+import * as dotenv from "dotenv";
+
+dotenv.config();

package/src/generators/test/rlcRecordedClient.ts.hbs

@@ -0,0 +1,26 @@
+import { Context } from "mocha";
+import { Recorder, RecorderStartOptions } from "@azure-tools/test-recorder";
+import "./env";
+
+const envSetupForPlayback: Record<string, string> = {
+  ENDPOINT: "https://endpoint",
+  AZURE_CLIENT_ID: "azure_client_id",
+  AZURE_CLIENT_SECRET: "azure_client_secret",
+  AZURE_TENANT_ID: "88888888-8888-8888-8888-888888888888",
+  SUBSCRIPTION_ID: "azure_subscription_id"
+};
+
+const recorderEnvSetup: RecorderStartOptions = {
+  envSetupForPlayback
+};
+
+/**
+* creates the recorder and reads the environment variables from the `.env` file.
+* Should be called first in the test suite to make sure environment variables are
+* read before they are being used.
+*/
+export async function createRecorder(context: Context): Promise<Recorder> {
+  const recorder = new Recorder(context.currentTest);
+  await recorder.start(recorderEnvSetup);
+  return recorder;
+}

package/src/generators/test/rlcSampleTest.spec.ts.hbs

@@ -0,0 +1,20 @@
+import { Recorder } from "@azure-tools/test-recorder";
+import { assert } from "chai";
+import { createRecorder } from "./utils/recordedClient";
+import { Context } from "mocha";
+
+describe("My test", () => {
+  let recorder: Recorder;
+
+  beforeEach(async function(this: Context) {
+    recorder = await createRecorder(this);
+  });
+
+  afterEach(async function() {
+    await recorder.stop();
+  });
+
+  it("sample test", async function() {
+    assert.equal(1, 1);
+  });
+});

package/src/generators/test/sampleTest.ts.hbs

@@ -0,0 +1,32 @@
+import { Recorder, RecorderStartOptions, env } from "@azure-tools/test-recorder";
+import { assert } from "chai";
+import { Context } from "mocha";
+
+
+const replaceableVariables: Record<string, string> = {
+  AZURE_CLIENT_ID: "azure_client_id",
+  AZURE_CLIENT_SECRET: "azure_client_secret",
+  AZURE_TENANT_ID: "88888888-8888-8888-8888-888888888888",
+  SUBSCRIPTION_ID: "azure_subscription_id"
+};
+
+const recorderOptions: RecorderStartOptions = {
+  envSetupForPlayback: replaceableVariables,
+};
+
+describe("My test", () => {
+  let recorder: Recorder;
+
+  beforeEach(async function (this: Context) {
+    recorder = new Recorder(this.currentTest);
+    await recorder.start(recorderOptions);
+  });
+
+  afterEach(async function () {
+    await recorder.stop();
+  });
+
+  it("sample test", async function () {
+    console.log("Hi, I'm a test!");
+  });
+});