@autorest/typescript 6.0.0-beta.19 → 6.0.0-beta.20

package/src/generators/operationGenerator.ts

@@ -768,30 +768,12 @@ function writeNoOverloadsOperationBody(
   const vanillaOptionsName = "options";
   let options = vanillaOptionsName;
 
-  if (tracingInfo) {
-    const operationName = operationMethod.getName();
-    const {
-      outputOptionsVarName: updatedOptionsName,
-      statement: tracingStatement
-    } = getTracingSpanStatement(
-      clientDetails,
-      operationName,
-      `${options} || {}`
-    );
-    operationMethod.addStatements([tracingStatement]);
-    // Options from createSpan should be used as operation options, updating
-    options = compileOperationOptionsToRequestOptionsBase(
-      updatedOptionsName,
-      operation.isLro,
-      lroResourceLocationConfig
-    );
-  } else {
-    options = compileOperationOptionsToRequestOptionsBase(
-      vanillaOptionsName,
-      operation.isLro,
-      lroResourceLocationConfig
-    );
-  }
+  // Options from createSpan should be used as operation options, updating
+  options = compileOperationOptionsToRequestOptionsBase(
+    vanillaOptionsName,
+    operation.isLro,
+    lroResourceLocationConfig
+  );
 
   const sendParams = parameterDeclarations
     .map(p =>
@@ -813,6 +795,7 @@ function writeNoOverloadsOperationBody(
   if (operation.isLro) {
     if (!useCoreV2) {
       writeLroOperationBody(
+        clientDetails,
         "operationArguments",
         responseName,
         operationSpecName,
@@ -823,6 +806,7 @@ function writeNoOverloadsOperationBody(
       );
     } else {
       writeLroOperationBody(
+        clientDetails,
         `{${sendParams}}`,
         responseName,
         operationSpecName,
@@ -850,18 +834,6 @@ interface OptionsStatement {
   outputOptionsVarName: string;
 }
 
-function getTracingSpanStatement(
-  clientDetails: ClientDetails,
-  operationName: string,
-  options: string
-): OptionsStatement {
-  const outputOptionsVarName = "updatedOptions";
-  return {
-    statement: `const { span, ${outputOptionsVarName} } = createSpan("${clientDetails.className}-${operationName}", ${options});`,
-    outputOptionsVarName: outputOptionsVarName
-  };
-}
-
 function writeSendOperationRequest(
   responseName: string,
   operationMethod: MethodDeclaration,
@@ -871,6 +843,7 @@ function writeSendOperationRequest(
   sendParams: string
 ) {
   const { useCoreV2, tracingInfo } = getAutorestOptions();
+  const operationName = operationMethod.getName();
   const client = isInline ? "" : ".client";
   const sendRequestStatement = !useCoreV2
     ? `this${client}.sendOperationRequest(operationArguments, ${operationSpecName})`
@@ -879,10 +852,11 @@ function writeSendOperationRequest(
   // When tracing is enabled we want to report success and failures through OpenTelemetry
   // so we create a span and mark it as succeeded or failed
   operationMethod.addStatements(
-    getTracingTryCatchStatement(
+    getTracingClientWithSpanStatement(
       sendRequestStatement,
       responseName,
-      !!tracingInfo
+      !!tracingInfo,
+      `${clientDetails.className}.${operationName}`
     )
   );
 }
@@ -891,25 +865,18 @@ function getSpanStatusCode() {
   return "coreTracing.SpanStatusCode.UNSET";
 }
 
-function getTracingTryCatchStatement(
+function getTracingClientWithSpanStatement(
   sendRequestStatement: string,
   responseName: string,
-  isTracingEnabled: boolean
+  isTracingEnabled: boolean,
+  spanName: string
 ) {
   const { useCoreV2 } = getAutorestOptions();
   if (isTracingEnabled) {
-    return `try {
-      const result = await ${sendRequestStatement}
-      return result as ${responseName};
-    } catch(error) {
-    span.setStatus({
-      code: ${getSpanStatusCode()},
-      message: error.message
-    });
-      throw error;
-    } finally {
-      span.end();
-    }`;
+    return `
+    return tracingClient.withSpan("${spanName}", options ?? {}, async options => {
+      return ${sendRequestStatement} as Promise<${responseName}>;
+    });`;
   } else {
     return !useCoreV2
       ? `return ${sendRequestStatement} as Promise<${responseName}>`
@@ -918,6 +885,7 @@ function getTracingTryCatchStatement(
 }
 
 function writeLroOperationBody(
+  clientDetails: ClientDetails,
   operationParamsName: string,
   responseName: string,
   operationSpecName: string,
@@ -927,14 +895,16 @@ function writeLroOperationBody(
   isTracingEnabled = false
 ) {
   const { useCoreV2 } = getAutorestOptions();
+  const spanName = `${clientDetails.className}.${methodDeclaration.getName()}`;
   const client = isInline ? "" : ".client";
   const sendRequestStatement = `this${client}.sendOperationRequest(args, spec)`;
   const sendOperationStatement = !useCoreV2
     ? `const directSendOperation = async (args: coreHttp.OperationArguments, spec: coreHttp.OperationSpec): Promise<${responseName}> => {
-      ${getTracingTryCatchStatement(
+      ${getTracingClientWithSpanStatement(
         sendRequestStatement,
         responseName,
-        isTracingEnabled
+        isTracingEnabled,
+        spanName
       )}
       };
       const sendOperation = async (args: coreHttp.OperationArguments, spec: coreHttp.OperationSpec) => {
@@ -946,10 +916,11 @@ function writeLroOperationBody(
         }};
     }`
     : `const directSendOperation = async (args: coreClient.OperationArguments, spec: coreClient.OperationSpec): Promise<${responseName}> => {
-    ${getTracingTryCatchStatement(
+    ${getTracingClientWithSpanStatement(
       sendRequestStatement,
       responseName,
-      isTracingEnabled
+      isTracingEnabled,
+      spanName
     )}
     };
     const sendOperation = async (args: coreClient.OperationArguments, spec: coreClient.OperationSpec) => {
@@ -984,8 +955,8 @@ function writeLroOperationBody(
         ? `, lroResourceLocationConfig: "${lroResourceLocationConfig.toLowerCase()}"`
         : ""
     } });`,
-    'await poller.poll();',
-    'return poller;'
+    "await poller.poll();",
+    "return poller;"
   ]);
 
   methodDeclaration.setReturnType(
@@ -1008,6 +979,7 @@ function writeMultiMediaTypeOperationBody(
 ): void {
   const { useCoreV2, tracingInfo } = getAutorestOptions();
   const coreImport = !useCoreV2 ? "coreHttp" : "coreClient";
+
   operationMethod.addStatements([
     `let operationSpec: ${coreImport}.OperationSpec;`,
     `let operationArguments: ${coreImport}.OperationArguments;`
@@ -1089,29 +1061,13 @@ function writeMultiMediaTypeOperationBody(
   const lroResourceLocationConfig =
     operation.lroOptions && operation.lroOptions["final-state-via"];
 
-  if (tracingInfo) {
-    const operationName = operationMethod.getName();
-    const {
-      outputOptionsVarName,
-      statement: tracingStatement
-    } = getTracingSpanStatement(clientDetails, operationName, optionsVarName);
-    operationMethod.addStatements([
-      tracingStatement,
-      `operationArguments.options = ${compileOperationOptionsToRequestOptionsBase(
-        outputOptionsVarName,
-        operation.isLro,
-        lroResourceLocationConfig
-      )};`
-    ]);
-  } else {
-    operationMethod.addStatements([
-      `operationArguments.options = ${compileOperationOptionsToRequestOptionsBase(
-        optionsVarName,
-        operation.isLro,
-        lroResourceLocationConfig
-      )};`
-    ]);
-  }
+  operationMethod.addStatements([
+    `operationArguments.options = ${compileOperationOptionsToRequestOptionsBase(
+      optionsVarName,
+      operation.isLro,
+      lroResourceLocationConfig
+    )};`
+  ]);
 
   if (!operation.isLro) {
     writeSendOperationRequest(
@@ -1124,6 +1080,7 @@ function writeMultiMediaTypeOperationBody(
     );
   } else {
     writeLroOperationBody(
+      clientDetails,
       "operationArguments",
       responseName,
       "operationSpec",
@@ -1323,10 +1280,7 @@ function addImports(
 
   const clientClassName = `${className}`;
 
-  const clientFileName = normalizeName(
-    clientClassName,
-    NameType.File
-  );
+  const clientFileName = normalizeName(clientClassName, NameType.File);
 
   operationGroupFile.addImportDeclaration({
     namedImports: [`${clientClassName}`],

package/src/generators/parametersGenerator.ts

@@ -11,7 +11,6 @@ import {
 } from "ts-morph";
 import { ClientDetails } from "../models/clientDetails";
 import { ParameterDetails } from "../models/parameterDetails";
-import { isString } from "util";
 import { writeMapper } from "./mappersGenerator";
 import { shouldImportParameters } from "./utils/importUtils";
 import { logger } from "../utils/logger";
@@ -143,7 +142,7 @@ function writeParameterMapper(
   { mapper }: ParameterDetails
 ) {
   writer.write("mapper: ");
-  if (isString(mapper)) {
+  if (typeof mapper === "string") {
     writer.write(`${mapper}Mapper`);
   } else {
     writeMapper(writer, mapper);
@@ -184,7 +183,7 @@ function getCoreHttpImports(clientDetails: ClientDetails) {
 
 function getImportedMappers(clientDetails: ClientDetails) {
   const mappers = clientDetails.parameters
-    .filter(p => !p.isSynthetic && isString(p.mapper))
+    .filter(p => !p.isSynthetic && typeof p.mapper === "string")
     .map(p => `${p.mapper} as ${p.mapper}Mapper`);
 
   return [...new Set<string>(mappers)];

package/src/generators/static/karma.conf.js.hbs

@@ -1,12 +1,8 @@
 // https://github.com/karma-runner/karma-chrome-launcher
 process.env.CHROME_BIN = require("puppeteer").executablePath();
 require("dotenv").config();
-const {
-  jsonRecordingFilterFunction,
-  isPlaybackMode,
-  isSoftRecordMode,
-  isRecordMode,
-} = require("@azure-tools/test-recorder");
+const { relativeRecordingsPath } = require("@azure-tools/test-recorder");
+process.env.RECORDINGS_RELATIVE_PATH = relativeRecordingsPath();
 
 module.exports = function (config) {
   config.set({
@@ -28,16 +24,14 @@ module.exports = function (config) {
       "karma-coverage",
       "karma-sourcemap-loader",
       "karma-junit-reporter",
-      "karma-json-to-file-reporter",
       "karma-source-map-support",
-      "karma-json-preprocessor",
     ],
 
     // 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 },
-    ].concat(isPlaybackMode() || isSoftRecordMode() ? ["recordings/browsers/**/*.json"] : []),
+    ],
 
     // list of files / patterns to exclude
     exclude: [],
@@ -46,7 +40,6 @@ module.exports = function (config) {
     // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
     preprocessors: {
       "**/*.js": ["sourcemap", "env"],
-      "recordings/browsers/**/*.json": ["json"],
       // 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"]
@@ -64,7 +57,7 @@ module.exports = function (config) {
     // test results reporter to use
     // possible values: 'dots', 'progress'
     // available reporters: https://npmjs.org/browse/keyword/karma-reporter
-    reporters: ["mocha", "coverage", "junit", "json-to-file"],
+    reporters: ["mocha", "coverage", "junit"],
 
     coverageReporter: {
       // specify a common output directory
@@ -87,11 +80,6 @@ module.exports = function (config) {
       properties: {}, // key value pair of properties to add to the <properties> section of the report
     },
 
-    jsonToFileReporter: {
-      filter: jsonRecordingFilterFunction,
-      outputPath: ".",
-    },
-
     // web server port
     port: 9876,
 
@@ -126,9 +114,6 @@ module.exports = function (config) {
     browserNoActivityTimeout: 60000000,
     browserDisconnectTimeout: 10000,
     browserDisconnectTolerance: 3,
-    browserConsoleLogOptions: {
-      terminal: !isRecordMode(),
-    },
 
     client: {
       mocha: {

package/src/generators/static/packageFileGenerator.ts

@@ -60,7 +60,7 @@ function restLevelPackage(packageDetails: PackageDetails) {
   const hasLRO = hasPollingOperations(model);
   const packageInfo: Record<string, any> = {
     name: `${packageDetails.name}`,
-    "sdk-type": `${azureArm ? "mgmt" : "client"}`,
+    "sdk-type": "client",
     author: "Microsoft Corporation",
     version: `${packageDetails.version}`,
     description: `${packageDetails.description}`,
@@ -132,7 +132,7 @@ function restLevelPackage(packageDetails: PackageDetails) {
     autoPublish: false,
     dependencies: {
       "@azure/core-auth": "^1.3.0",
-      "@azure-rest/core-client": "1.0.0-beta.8",
+      "@azure-rest/core-client": "1.0.0-beta.9",
       "@azure/core-rest-pipeline": "^1.8.0",
       "@azure/logger": "^1.0.0",
       tslib: "^2.2.0",
@@ -144,7 +144,7 @@ function restLevelPackage(packageDetails: PackageDetails) {
       })
     },
     devDependencies: {
-      "@microsoft/api-extractor": "^7.18.11",
+      "@microsoft/api-extractor": "7.18.11",
       autorest: "latest",
       "@types/node": "^12.0.0",
       dotenv: "^8.2.0",
@@ -184,11 +184,13 @@ function restLevelPackage(packageDetails: PackageDetails) {
 
   if (generateTest) {
     packageInfo.module = `./dist-esm/src/index.js`;
+    packageInfo.devDependencies["@azure-tools/test-credential"] = "^1.0.0";
     packageInfo.devDependencies["@azure/identity"] = "^2.0.1";
-    packageInfo.devDependencies["@azure-tools/test-recorder"] = "^1.0.0";
+    packageInfo.devDependencies["@azure-tools/test-recorder"] = "^2.0.0";
     packageInfo.devDependencies["mocha"] = "^7.1.1";
     packageInfo.devDependencies["mocha-junit-reporter"] = "^1.18.0";
     packageInfo.devDependencies["cross-env"] = "^7.0.2";
+    packageInfo.devDependencies["@types/chai"] = "^4.2.8";
     packageInfo.devDependencies["chai"] = "^4.2.0";
     packageInfo.devDependencies["cross-env"] = "^7.0.2";
     packageInfo.devDependencies["karma-chrome-launcher"] = "^3.0.0";
@@ -197,8 +199,6 @@ function restLevelPackage(packageDetails: PackageDetails) {
     packageInfo.devDependencies["karma-env-preprocessor"] = "^0.1.1";
     packageInfo.devDependencies["karma-firefox-launcher"] = "^1.1.0";
     packageInfo.devDependencies["karma-ie-launcher"] = "^1.0.0";
-    packageInfo.devDependencies["karma-json-preprocessor"] = "^0.3.3";
-    packageInfo.devDependencies["karma-json-to-file-reporter"] = "^1.0.1";
     packageInfo.devDependencies["karma-junit-reporter"] = "^2.0.1";
     packageInfo.devDependencies["karma-mocha-reporter"] = "^2.2.5";
     packageInfo.devDependencies["karma-mocha"] = "^2.0.1";
@@ -207,31 +207,27 @@ function restLevelPackage(packageDetails: PackageDetails) {
     packageInfo.devDependencies["karma"] = "^6.2.0";
     packageInfo.devDependencies["nyc"] = "^14.0.0";
     packageInfo.devDependencies["source-map-support"] = "^0.5.9";
-
-    packageInfo.scripts["test"] =
-      "npm run clean && npm run build:test && npm run unit-test";
-    packageInfo.scripts["test:node"] =
-      "npm run clean && npm run build:test && npm run unit-test:node";
-    packageInfo.scripts["test:browser"] =
-      "tsc -p . && cross-env ONLY_BROWSER=true rollup -c 2>&1";
-    packageInfo.scripts["unit-test"] =
-      "npm run unit-test:node && npm run unit-test:browser";
-    packageInfo.scripts["unit-test:node"] =
-      'mocha -r esm --require ts-node/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 1200000 --full-trace "test/{,!(browser)/**/}*.spec.ts"';
+    packageInfo.scripts["test"] = "npm run clean && npm run build:test && npm run unit-test";
+    packageInfo.scripts["test:node"] = "npm run clean && npm run build:test && npm run unit-test:node";
+    packageInfo.scripts["test:browser"] = "npm run clean && npm run build:test && npm run unit-test:browser";
+    packageInfo.scripts["build:browser"] = "tsc -p . && cross-env ONLY_BROWSER=true rollup -c 2>&1";
+    packageInfo.scripts["build:node"] = "tsc -p . && cross-env ONLY_NODE=true rollup -c 2>&1";
+    packageInfo.scripts["build:test"] = "tsc -p . && rollup -c 2>&1";
+    packageInfo.scripts["unit-test"] = "npm run unit-test:node && npm run unit-test:browser";
+    packageInfo.scripts["unit-test:node"] = "mocha -r esm --require ts-node/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 1200000 --full-trace \"test/{,!(browser)/**/}*.spec.ts\"";
     packageInfo.scripts["unit-test:browser"] = "karma start --single-run";
-    packageInfo.scripts["integration-test"] =
-      "npm run integration-test:node && npm run integration-test:browser";
-    packageInfo.scripts["integration-test:node"] =
-      'nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 5000000 --full-trace "dist-esm/test/{,!(browser)/**/}*.spec.js"';
-
+    packageInfo.scripts["integration-test:browser"] = "karma start --single-run";
+    packageInfo.scripts["integration-test:node"] = "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 5000000 --full-trace \"dist-esm/test/{,!(browser)/**/}*.spec.js\"";
+    packageInfo.scripts["integration-test"] = "npm run integration-test:node && npm run integration-test:browser";
     if (azureSdkForJs) {
       packageInfo.scripts["build:test"] = "tsc -p . && dev-tool run bundle";
       packageInfo.scripts["integration-test:browser"] =
         "dev-tool run test:browser";
-    } else {
-      packageInfo.scripts["build:test"] = "tsc -p . && rollup -c 2>&1";
-      packageInfo.scripts["integration-test:browser"] =
-        "karma start --single-run";
+      packageInfo.scripts["unit-test:browser"] = "dev-tool run test:browser";
+      packageInfo.scripts["unit-test:node"] =
+        "dev-tool run test:node-ts-input -- --timeout 1200000 --exclude 'test/**/browser/*.spec.ts' 'test/**/*.spec.ts'";
+      packageInfo.scripts["integration-test:node"] =
+        "dev-tool run test:node-js-input -- --timeout 5000000 'dist-esm/test/**/*.spec.js'";
     }
 
     packageInfo["browser"] = {
@@ -261,7 +257,8 @@ function regularAutorestPackage(
     azureOutputDirectory,
     generateTest,
     generateSample,
-    coreHttpCompatMode
+    coreHttpCompatMode,
+    azureSdkForJs
   } = getAutorestOptions();
   const { model } = getSession();
   const hasLro = hasPollingOperations(model);
@@ -298,8 +295,7 @@ function regularAutorestPackage(
         "@azure/core-rest-pipeline": "^1.8.0"
       }),
       ...(tracingInfo && {
-        "@azure/core-tracing": "1.0.0-preview.13",
-        "@opentelemetry/api": "^0.10.2"
+        "@azure/core-tracing": "^1.0.0"
       }),
       tslib: "^2.2.0"
     },
@@ -309,7 +305,7 @@ function regularAutorestPackage(
     module: `./dist-esm/index.js`,
     types: `./types/${packageDetails.nameWithoutScope}.d.ts`,
     devDependencies: {
-      "@microsoft/api-extractor": "^7.18.11",
+      "@microsoft/api-extractor": "7.18.11",
       "@rollup/plugin-commonjs": "^21.0.1",
       "@rollup/plugin-json": "^4.1.0",
       "@rollup/plugin-multi-entry": "^4.1.0",
@@ -391,8 +387,11 @@ function regularAutorestPackage(
   if (generateTest) {
     packageInfo.module = `./dist-esm/src/index.js`;
     packageInfo.devDependencies["@azure/identity"] = "^2.0.1";
-    packageInfo.devDependencies["@azure-tools/test-recorder"] = "^1.0.0";
+    packageInfo.devDependencies["@azure-tools/test-recorder"] = "^2.0.0";
+    packageInfo.devDependencies["@azure-tools/test-credential"] = "^1.0.0";
     packageInfo.devDependencies["mocha"] = "^7.1.1";
+    packageInfo.devDependencies["@types/chai"] = "^4.2.8";
+    packageInfo.devDependencies["chai"] = "^4.2.0";
     packageInfo.devDependencies["cross-env"] = "^7.0.2";
     packageInfo.scripts["test"] = "npm run integration-test";
     packageInfo.scripts["unit-test"] =
@@ -401,8 +400,15 @@ function regularAutorestPackage(
       "cross-env TEST_MODE=playback npm run integration-test:node";
     packageInfo.scripts["integration-test"] =
       "npm run integration-test:node && npm run integration-test:browser";
-    packageInfo.scripts["integration-test:node"] =
-      "mocha -r esm --require ts-node/register --timeout 1200000 --full-trace test/*.ts --reporter ../../../common/tools/mocha-multi-reporter.js";
+
+    if (azureSdkForJs) {
+      packageInfo.devDependencies["@azure/dev-tool"] = "^1.0.0";
+      packageInfo.scripts["integration-test:node"] =
+        "dev-tool run test:node-ts-input -- --timeout 1200000 'test/*.ts'";
+    } else {
+      packageInfo.scripts["integration-test:node"] =
+        "mocha -r esm --require ts-node/register --timeout 1200000 --full-trace test/*.ts --reporter ../../../common/tools/mocha-multi-reporter.js";
+    }
   }
   if (
     generateSample &&

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

@@ -1,28 +1,17 @@
 import { Context } from "mocha";
-import { record, RecorderEnvironmentSetup, Recorder } from "@azure-tools/test-recorder";
+import { Recorder, RecorderStartOptions } from "@azure-tools/test-recorder";
 import "./env";
 
-const recorderEnvSetup: RecorderEnvironmentSetup = {
-  replaceableVariables: {
-    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"
-  },
-  customizationsOnRecordings: [
-    (recording: any): any =>
-      recording.replace(/"access_token":"[^"]*"/g, `"access_token":"access_token"`),
-    // If we put ENDPOINT in replaceableVariables above, it will not capture
-    // the endpoint string used with nock, which will be expanded to
-    // https://<endpoint>:443/ and therefore will not match, so we have to do
-    // this instead.
-    (recording: string): string => {
-      const replaced = recording.replace("endpoint:443", "endpoint");
-      return replaced;
-    },
-  ],
-  queryParametersToSkip: []
+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
 };
 
 /**
@@ -30,6 +19,8 @@ const recorderEnvSetup: RecorderEnvironmentSetup = {
 * Should be called first in the test suite to make sure environment variables are
 * read before they are being used.
 */
-export function createRecorder(context: Context): Recorder {
-    return record(context, recorderEnvSetup);
+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

@@ -1,12 +1,13 @@
 import { Recorder } from "@azure-tools/test-recorder";
-import * as assert from "assert";
+import { assert } from "chai";
 import { createRecorder } from "./utils/recordedClient";
+import { Context } from "mocha";
 
 describe("My test", () => {
   let recorder: Recorder;
 
-  beforeEach(async function() {
-    recorder = createRecorder(this);
+  beforeEach(async function(this: Context) {
+    recorder = await createRecorder(this);
   });
 
   afterEach(async function() {

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

@@ -1,32 +1,32 @@
-import { env, record, RecorderEnvironmentSetup, Recorder } from "@azure-tools/test-recorder";
-import * as assert from "assert";
+import { Recorder, RecorderStartOptions, env } from "@azure-tools/test-recorder";
+import { assert } from "chai";
+import { Context } from "mocha";
 
-const recorderEnvSetup: RecorderEnvironmentSetup = {
-  replaceableVariables: {
-    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"
-  },
-  customizationsOnRecordings: [
-    (recording: any): any =>
-      recording.replace(/"access_token":"[^"]*"/g, `"access_token":"access_token"`)
-  ],
-  queryParametersToSkip: []
+
+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() {
-    recorder = record(this, recorderEnvSetup);
+  beforeEach(async function (this: Context) {
+    recorder = new Recorder(this.currentTest);
+    await recorder.start(recorderOptions);
   });
 
-  afterEach(async function() {
+  afterEach(async function () {
     await recorder.stop();
   });
 
-  it("sample test", async function() {
+  it("sample test", async function () {
     console.log("Hi, I'm a test!");
   });
 });