[perf] Migrate @azure-tests/perf-keyvault-keys to ESM (#32242)

### Packages impacted by this PR - @azure-tests/perf-keyvault-keys ### Issues associated with this PR - #31338 ### Describe the problem that is addressed by this PR Migrates @azure-tests/perf-keyvault-keys to ESM via automation. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
Azure · Dec 17, 2024 · c968e25 · c968e25
1 parent 0e13ee1
commit c968e25
Show file tree

Hide file tree

Showing 10 changed files with 103 additions and 47 deletions.
diff --git a/sdk/keyvault/perf-tests/keyvault-keys/package.json b/sdk/keyvault/perf-tests/keyvault-keys/package.json
@@ -3,47 +3,76 @@
   "sdk-type": "perf-test",
   "version": "1.0.0",
   "description": "",
-  "main": "",
+  "main": "./dist/commonjs/index.js",
+  "module": "./dist/esm/index.js",
   "keywords": [],
-  "author": "",
-  "license": "ISC",
+  "author": "Microsoft Corporation",
+  "license": "MIT",
   "dependencies": {
     "@azure-tools/test-perf": "^1.0.0",
-    "@azure/identity": "^4.0.1",
-    "@azure/keyvault-keys": "^4.2.1",
+    "@azure/identity": "^4.5.0",
+    "@azure/keyvault-keys": "^4.9.0",
     "dotenv": "^16.0.0",
-    "uuid": "^8.3.0"
+    "tslib": "^2.8.1"
   },
   "devDependencies": {
     "@azure/dev-tool": "^1.0.0",
     "@types/node": "^18.0.0",
-    "@types/uuid": "^8.0.0",
     "eslint": "^9.9.0",
-    "ts-node": "^10.0.0",
-    "tslib": "^2.2.0",
     "typescript": "~5.6.2"
   },
   "private": true,
   "scripts": {
-    "build": "npm run clean && tsc -p .",
+    "build": "npm run clean && dev-tool run build-package",
     "build:samples": "echo skipped",
     "build:test": "echo skipped",
-    "check-format": "dev-tool run vendored prettier --list-different --config ../../../../.prettierrc.json --ignore-path ../../../../.prettierignore \"test/**/*.ts\" \"*.{js,json}\"",
+    "check-format": "dev-tool run vendored prettier --list-different --config ../../../../.prettierrc.json --ignore-path ../../../../.prettierignore \"src/**/*.ts\" \"*.{js,json}\"",
     "clean": "dev-tool run vendored rimraf --glob dist dist-* types *.tgz *.log",
-    "format": "dev-tool run vendored prettier --write --config ../../../../.prettierrc.json --ignore-path ../../../../.prettierignore \"test/**/*.ts\" \"*.{js,json}\"",
+    "format": "dev-tool run vendored prettier --write --config ../../../../.prettierrc.json --ignore-path ../../../../.prettierignore \"src/**/*.ts\" \"*.{js,json}\"",
     "integration-test": "echo skipped",
     "integration-test:browser": "echo skipped",
     "integration-test:node": "echo skipped",
-    "lint": "eslint -c ../../../../common/tools/eslint-plugin-azure-sdk/eslint.perftests.config.mjs test",
-    "lint:fix": "eslint -c ../../../../common/tools/eslint-plugin-azure-sdk/eslint.perftests.config.mjs test --fix --fix-type [problem,suggestion]",
+    "lint": "dev-tool run vendored eslint -c ../../../../common/tools/eslint-plugin-azure-sdk/eslint.perftests.config.mjs src",
+    "lint:fix": "dev-tool run vendored eslint -c ../../../../common/tools/eslint-plugin-azure-sdk/eslint.perftests.config.mjs src --fix --fix-type [problem,suggestion]",
     "pack": "npm pack 2>&1",
-    "perf-test:node": "npm run build && node dist-esm/index.spec.js",
+    "perf-test:node": "npm run build && node dist/esm/index.js",
     "test": "echo skipped",
     "test:browser": "echo skipped",
     "test:node": "echo skipped",
     "unit-test": "echo skipped",
     "unit-test:browser": "echo skipped",
     "unit-test:node": "echo skipped",
     "update-snippets": "echo skipped"
-  }
+  },
+  "type": "module",
+  "tshy": {
+    "exports": {
+      "./package.json": "./package.json",
+      ".": "./src/index.ts"
+    },
+    "dialects": [
+      "esm",
+      "commonjs"
+    ],
+    "selfLink": false
+  },
+  "files": [
+    "dist/",
+    "README.md",
+    "LICENSE"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "types": "./dist/esm/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/commonjs/index.d.ts",
+        "default": "./dist/commonjs/index.js"
+      }
+    }
+  },
+  "types": "./dist/commonjs/index.d.ts"
 }
diff --git a/...ys/test/cryptography/cryptography.spec.ts → ...eys/src/cryptography/cryptography.spec.ts b/...ys/test/cryptography/cryptography.spec.ts → ...eys/src/cryptography/cryptography.spec.ts
@@ -1,7 +1,10 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
 import { PerfOptionDictionary, PerfTest } from "@azure-tools/test-perf";
 import { CryptographyClient, KeyClient } from "@azure/keyvault-keys";
-import { v4 as uuid } from "uuid";
-import { credential, keyVaultUri } from "../utils";
+import { randomUUID } from "node:crypto";
+import { credential, keyVaultUri } from "../utils.js";
 
 interface CryptographyPerfTestOptions {
   keySize: number;
@@ -20,7 +23,7 @@ export abstract class CryptographyTest extends PerfTest<CryptographyPerfTestOpti
 
   keyClient: KeyClient;
   static cryptoClient?: CryptographyClient;
-  static keyName = `k-${uuid()}`;
+  static keyName = `k-${randomUUID()}`;
 
   constructor() {
     super();

diff --git a/...lt-keys/test/cryptography/decrypt.spec.ts → ...ult-keys/src/cryptography/decrypt.spec.ts b/...lt-keys/test/cryptography/decrypt.spec.ts → ...ult-keys/src/cryptography/decrypt.spec.ts
@@ -1,6 +1,9 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
 import { RsaEncryptionAlgorithm } from "@azure/keyvault-keys";
-import { randomBytes } from "crypto";
-import { CryptographyTest } from "./cryptography.spec";
+import { randomBytes } from "node:crypto";
+import { CryptographyTest } from "./cryptography.spec.js";
 
 export class DecryptTest extends CryptographyTest {
   private cipherText?: Uint8Array;

diff --git a/...vault-keys/test/cryptography/sign.spec.ts → ...yvault-keys/src/cryptography/sign.spec.ts b/...vault-keys/test/cryptography/sign.spec.ts → ...yvault-keys/src/cryptography/sign.spec.ts
@@ -1,5 +1,8 @@
-import { createHash, randomBytes } from "crypto";
-import { CryptographyTest } from "./cryptography.spec";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { createHash, randomBytes } from "node:crypto";
+import { CryptographyTest } from "./cryptography.spec.js";
 
 export class SignTest extends CryptographyTest {
   private digest?: Uint8Array;

diff --git a/...-keys/test/cryptography/unwrapKey.spec.ts → ...t-keys/src/cryptography/unwrapKey.spec.ts b/...-keys/test/cryptography/unwrapKey.spec.ts → ...t-keys/src/cryptography/unwrapKey.spec.ts
@@ -1,6 +1,9 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
 import { RsaEncryptionAlgorithm } from "@azure/keyvault-keys";
-import { randomBytes } from "crypto";
-import { CryptographyTest } from "./cryptography.spec";
+import { randomBytes } from "node:crypto";
+import { CryptographyTest } from "./cryptography.spec.js";
 
 export class UnwrapKeyTest extends CryptographyTest {
   encryptedKey?: Uint8Array;

diff --git a/sdk/keyvault/perf-tests/keyvault-keys/src/index.ts b/sdk/keyvault/perf-tests/keyvault-keys/src/index.ts
@@ -0,0 +1,12 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { createPerfProgram } from "@azure-tools/test-perf";
+import { GetKeyTest } from "./keys/get.spec.js";
+import { DecryptTest } from "./cryptography/decrypt.spec.js";
+import { SignTest } from "./cryptography/sign.spec.js";
+import { UnwrapKeyTest } from "./cryptography/unwrapKey.spec.js";
+
+const perfProgram = createPerfProgram(GetKeyTest, DecryptTest, SignTest, UnwrapKeyTest);
+
+perfProgram.run();
diff --git a/...tests/keyvault-keys/test/keys/get.spec.ts → ...-tests/keyvault-keys/src/keys/get.spec.ts b/...tests/keyvault-keys/test/keys/get.spec.ts → ...-tests/keyvault-keys/src/keys/get.spec.ts
@@ -1,7 +1,10 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
 import { PerfOptionDictionary, PerfTest } from "@azure-tools/test-perf";
 import { KeyClient } from "@azure/keyvault-keys";
-import { credential, keyVaultUri } from "../utils";
-import { v4 as uuid } from "uuid";
+import { credential, keyVaultUri } from "../utils.js";
+import { randomUUID } from "node:crypto";
 
 interface KeyPerfTestOptions {
   keySize: number;
@@ -19,7 +22,7 @@ export abstract class KeyTest extends PerfTest<KeyPerfTestOptions> {
   };
 
   keyClient: KeyClient;
-  static keyName = `k-${uuid()}`;
+  static keyName = `k-${randomUUID()}`;
 
   constructor() {
     super();

diff --git a/...lt/perf-tests/keyvault-keys/test/utils.ts → ...ult/perf-tests/keyvault-keys/src/utils.ts b/...lt/perf-tests/keyvault-keys/test/utils.ts → ...ult/perf-tests/keyvault-keys/src/utils.ts
@@ -1,8 +1,9 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
 import { ClientSecretCredential } from "@azure/identity";
 import { getEnvVar } from "@azure-tools/test-perf";
-import * as dotenv from "dotenv";
-
-dotenv.config();
+import "dotenv/config";
 
 export const credential = new ClientSecretCredential(
   getEnvVar("AZURE_TENANT_ID"),

diff --git a/sdk/keyvault/perf-tests/keyvault-keys/test/index.spec.ts b/sdk/keyvault/perf-tests/keyvault-keys/test/index.spec.ts
diff --git a/sdk/keyvault/perf-tests/keyvault-keys/tsconfig.json b/sdk/keyvault/perf-tests/keyvault-keys/tsconfig.json
@@ -1,12 +1,20 @@
 {
   "extends": "../../../../tsconfig",
   "compilerOptions": {
-    "module": "CommonJS",
-    "target": "ES2015",
-    "lib": ["ES6", "ESNext.AsyncIterable"],
-    "noEmit": true
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "rootDir": ".",
+    "paths": {
+      "@azure-tests/perf-keyvault-keys": ["./src/index"]
+    }
   },
-  "compileOnSave": true,
-  "exclude": ["node_modules"],
-  "include": ["./test/**/*.ts"]
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.mts",
+    "src/**/*.cts",
+    "samples-dev/**/*.ts",
+    "test/**/*.ts",
+    "test/**/*.mts",
+    "test/**/*.cts"
+  ]
 }