[perf] Migrate @azure-tests/perf-storage-blob to ESM (#32271)

### Packages impacted by this PR - @azure-tests/perf-storage-blob ### Issues associated with this PR - #31338 ### Describe the problem that is addressed by this PR Migrates @azure-tests/perf-storage-blob 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 · ba7b2e0 · ba7b2e0
1 parent 2a34627
commit ba7b2e0
Show file tree

Hide file tree

Showing 11 changed files with 83 additions and 48 deletions.
diff --git a/sdk/storage/perf-tests/storage-blob/package.json b/sdk/storage/perf-tests/storage-blob/package.json
@@ -3,46 +3,77 @@
   "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/core-rest-pipeline": "^1.1.0",
-    "@azure/core-util": "^1.6.1",
-    "@azure/storage-blob": "^12.23.0-beta.1",
-    "dotenv": "^16.0.0"
+    "@azure/core-rest-pipeline": "^1.18.0",
+    "@azure/core-util": "^1.11.0",
+    "@azure/storage-blob": "^12.26.0",
+    "dotenv": "^16.0.0",
+    "tslib": "^2.8.1"
   },
   "devDependencies": {
     "@azure/dev-tool": "^1.0.0",
     "@types/node": "^18.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/...rage-blob/test/core-rest-pipeline.spec.ts → ...orage-blob/src/core-rest-pipeline.spec.ts b/...rage-blob/test/core-rest-pipeline.spec.ts → ...orage-blob/src/core-rest-pipeline.spec.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { StorageBlobDownloadWithSASTest } from "./dowloadWithSAS.spec";
+import { StorageBlobDownloadWithSASTest } from "./dowloadWithSAS.spec.js";
 import {
   createDefaultHttpClient,
   HttpClient,

diff --git a/.../storage-blob/test/dowloadWithSAS.spec.ts → ...s/storage-blob/src/dowloadWithSAS.spec.ts b/.../storage-blob/test/dowloadWithSAS.spec.ts → ...s/storage-blob/src/dowloadWithSAS.spec.ts
@@ -2,14 +2,14 @@
 // Licensed under the MIT License.
 
 import { PerfOptionDictionary, getEnvVar, drainStream } from "@azure-tools/test-perf";
-import { StorageBlobTest } from "./storageTest.spec";
+import { StorageBlobTest } from "./storageTest.spec.js";
 import {
   BlockBlobClient,
   generateBlobSASQueryParameters,
   BlobSASPermissions,
   BlobClient,
 } from "@azure/storage-blob";
-import { getValueInConnString } from "./utils/utils";
+import { getValueInConnString } from "./utils/utils.js";
 import { randomUUID } from "@azure/core-util";
 
 interface StorageBlobDownloadTestOptions {

diff --git a/...-tests/storage-blob/test/download.spec.ts → ...f-tests/storage-blob/src/download.spec.ts b/...-tests/storage-blob/test/download.spec.ts → ...f-tests/storage-blob/src/download.spec.ts
@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 import { drainStream, PerfOptionDictionary } from "@azure-tools/test-perf";
-import { StorageBlobTest } from "./storageTest.spec";
+import { StorageBlobTest } from "./storageTest.spec.js";
 import { BlockBlobClient } from "@azure/storage-blob";
 import { randomUUID } from "@azure/core-util";
 

diff --git a/...erf-tests/storage-blob/test/index.spec.ts → ...rage/perf-tests/storage-blob/src/index.ts b/...erf-tests/storage-blob/test/index.spec.ts → ...rage/perf-tests/storage-blob/src/index.ts
@@ -2,12 +2,12 @@
 // Licensed under the MIT License.
 
 import { createPerfProgram } from "@azure-tools/test-perf";
-import { StorageBlobDownloadTest } from "./download.spec";
-import { StorageBlobUploadTest } from "./upload.spec";
-import { StorageBlobUploadFileTest } from "./uploadFromFile.spec";
-import { StorageBlobListTest } from "./listBlobs.spec";
-import { StorageBlobDownloadWithSASTest } from "./dowloadWithSAS.spec";
-import { CoreHTTPSDownloadWithSASTest } from "./core-rest-pipeline.spec";
+import { StorageBlobDownloadTest } from "./download.spec.js";
+import { StorageBlobUploadTest } from "./upload.spec.js";
+import { StorageBlobUploadFileTest } from "./uploadFromFile.spec.js";
+import { StorageBlobListTest } from "./listBlobs.spec.js";
+import { StorageBlobDownloadWithSASTest } from "./dowloadWithSAS.spec.js";
+import { CoreHTTPSDownloadWithSASTest } from "./core-rest-pipeline.spec.js";
 
 const perfProgram = createPerfProgram(
   StorageBlobDownloadTest,

diff --git a/...tests/storage-blob/test/listBlobs.spec.ts → ...-tests/storage-blob/src/listBlobs.spec.ts b/...tests/storage-blob/test/listBlobs.spec.ts → ...-tests/storage-blob/src/listBlobs.spec.ts
@@ -3,7 +3,8 @@
 
 import { randomUUID } from "@azure/core-util";
 import { PerfOptionDictionary, executeParallel } from "@azure-tools/test-perf";
-import { StorageBlobTest } from "./storageTest.spec";
+import { StorageBlobTest } from "./storageTest.spec.js";
+
 interface StorageBlobListTestOptions {
   count: number;
 }

diff --git a/...sts/storage-blob/test/storageTest.spec.ts → ...ests/storage-blob/src/storageTest.spec.ts b/...sts/storage-blob/test/storageTest.spec.ts → ...ests/storage-blob/src/storageTest.spec.ts
@@ -8,11 +8,10 @@ import {
   ContainerClient,
   StorageSharedKeyCredential,
 } from "@azure/storage-blob";
-import { getValueInConnString } from "./utils/utils";
+import { getValueInConnString } from "./utils/utils.js";
 
 // Expects the .env file at the same level
-import * as dotenv from "dotenv";
-dotenv.config();
+import "dotenv/config";
 
 export abstract class StorageBlobTest<TOptions> extends PerfTest<TOptions> {
   blobServiceClient: BlobServiceClient;

diff --git a/...rf-tests/storage-blob/test/upload.spec.ts → ...erf-tests/storage-blob/src/upload.spec.ts b/...rf-tests/storage-blob/test/upload.spec.ts → ...erf-tests/storage-blob/src/upload.spec.ts
@@ -3,7 +3,7 @@
 
 import { randomUUID } from "@azure/core-util";
 import { PerfOptionDictionary } from "@azure-tools/test-perf";
-import { StorageBlobTest } from "./storageTest.spec";
+import { StorageBlobTest } from "./storageTest.spec.js";
 
 interface StorageBlobUploadTestOptions {
   size: number;

diff --git a/.../storage-blob/test/uploadFromFile.spec.ts → ...s/storage-blob/src/uploadFromFile.spec.ts b/.../storage-blob/test/uploadFromFile.spec.ts → ...s/storage-blob/src/uploadFromFile.spec.ts
@@ -1,14 +1,10 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
-import fs from "fs";
-import util from "util";
-import { BlockBlobClient } from "@azure/storage-blob";
-const writeFile = util.promisify(fs.writeFile);
-const fileExists = util.promisify(fs.exists);
-const mkdir = util.promisify(fs.mkdir);
-const deleteFile = util.promisify(fs.unlink);
 
-import { StorageBlobUploadTest } from "./upload.spec";
+import { existsSync } from "node:fs";
+import { mkdir, unlink, writeFile } from "node:fs/promises";
+import { BlockBlobClient } from "@azure/storage-blob";
+import { StorageBlobUploadTest } from "./upload.spec.js";
 
 const dirName = "temp";
 const fileName = `${dirName}/upload-from-test-temp-file.txt`;
@@ -22,12 +18,12 @@ export class StorageBlobUploadFileTest extends StorageBlobUploadTest {
 
   public async globalSetup() {
     await super.globalSetup();
-    if (!(await fileExists(dirName))) await mkdir(dirName);
+    if (!existsSync(dirName)) await mkdir(dirName);
     await writeFile(fileName, Buffer.alloc(this.parsedOptions.size.value!));
   }
 
   public async globalCleanup() {
-    await deleteFile(fileName);
+    await unlink(fileName);
     await super.globalCleanup();
   }
 

diff --git a/...rf-tests/storage-blob/test/utils/utils.ts → ...erf-tests/storage-blob/src/utils/utils.ts b/...rf-tests/storage-blob/test/utils/utils.ts → ...erf-tests/storage-blob/src/utils/utils.ts
diff --git a/sdk/storage/perf-tests/storage-blob/tsconfig.json b/sdk/storage/perf-tests/storage-blob/tsconfig.json
@@ -1,12 +1,20 @@
 {
   "extends": "../../../../tsconfig",
   "compilerOptions": {
-    "module": "commonjs",
-    "declarationDir": "./types/latest",
-    "outDir": "./dist-esm",
-    "lib": ["dom", "es5", "es6", "es7", "esnext"]
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "rootDir": ".",
+    "paths": {
+      "@azure-tests/perf-storage-blob": ["./src/index.js"]
+    }
   },
-  "compileOnSave": true,
-  "exclude": ["node_modules"],
-  "include": ["./test/**/*.ts"]
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.mts",
+    "src/**/*.cts",
+    "samples-dev/**/*.ts",
+    "test/**/*.ts",
+    "test/**/*.mts",
+    "test/**/*.cts"
+  ]
 }