chore!: updating azure-storage package to new @azue/storage-blob package (#661)

Itzaprado · phillipperalez · web-flow · commit 77b6340c41fc · 2025-05-16T11:09:42.000-06:00
BREAKING CHANGE: azure-storage package is now deprecated

Co-authored-by: phillipperalez &lt;peralez@google.com&gt;
diff --git a/lib/actions/azure/azure_storage.js b/lib/actions/azure/azure_storage.js
@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AzureStorageAction = void 0;
+const storage_blob_1 = require("@azure/storage-blob");
 const Hub = require("../../hub");
-const azure = require("azure-storage");
 class AzureStorageAction extends Hub.Action {
     constructor() {
         super(...arguments);
@@ -39,14 +39,11 @@ class AzureStorageAction extends Hub.Action {
             return new Hub.ActionResponse({ success: false, message: "Cannot determine a filename." });
         }
         const blobService = this.azureClientFromRequest(request);
-        const writeStream = blobService.createWriteStreamToBlockBlob(container, fileName);
+        const containerClient = blobService.getContainerClient(container);
+        const blockBlobClient = containerClient.getBlockBlobClient(fileName);
         try {
             await request.stream(async (readable) => {
-                return new Promise((resolve, reject) => {
-                    readable.pipe(writeStream)
-                        .on("error", reject)
-                        .on("finish", resolve);
-                });
+                return blockBlobClient.uploadStream(readable);
             });
             return new Hub.ActionResponse({ success: true });
         }
@@ -55,18 +52,12 @@ class AzureStorageAction extends Hub.Action {
         }
     }
     async form(request) {
-        // error in type definition for listContainersSegmented currentToken?
-        // https://github.com/Azure/azure-storage-node/issues/352
         const form = new Hub.ActionForm();
         const blobService = this.azureClientFromRequest(request);
-        return new Promise((resolve, _reject) => {
-            blobService.listContainersSegmented(null, (err, res) => {
-                if (err) {
-                    form.error = err;
-                    resolve(form);
-                }
-                else {
-                    const entries = res.entries;
+        return new Promise(async (resolve, _reject) => {
+            for await (const response of blobService.listContainers().byPage()) {
+                if (response.containerItems.length > 0) {
+                    const entries = response.containerItems;
                     if (entries.length > 0) {
                         form.fields = [{
                                 label: "Container",
@@ -84,17 +75,18 @@ class AzureStorageAction extends Hub.Action {
                             }];
                         resolve(form);
                     }
-                    else {
-                        form.error = "Create a container in your Azure account.";
-                        resolve(form);
-                    }
                 }
-            });
+                else {
+                    form.error = "Create a container in your Azure account.";
+                    resolve(form);
+                }
+            }
         });
     }
     azureClientFromRequest(request) {
         try {
-            return azure.createBlobService(request.params.account, request.params.accessKey);
+            const sharedKeyCredential = new storage_blob_1.StorageSharedKeyCredential(request.params.account, request.params.accessKey);
+            return new storage_blob_1.BlobServiceClient(`https://${request.params.account}.blob.core.windows.net`, sharedKeyCredential);
         }
         catch (err) {
             if (err && err.toString().includes("base64")) {
diff --git a/package.json b/package.json
@@ -14,6 +14,7 @@
     "test-dev": "./node_modules/.bin/nodemon --exec \"yarn test || true\"",
     "test": "NODE_OPTIONS=\"--trace-warnings\" yarn test-ts --trace-warnings && ./node_modules/.bin/tsc --noEmit && yarn lint",
     "test-ts": "./node_modules/.bin/mocha --exit -r ./node_modules/ts-node/register test/**/test.ts",
+    "test:single": "NODE_OPTIONS=\"--trace-warnings\" ./node_modules/.bin/mocha --exit -r ./node_modules/ts-node/register \"$1\"",
     "lint": "./node_modules/.bin/tslint -c tslint.json 'src/**/*.ts' 'bin/**/*.ts' 'test/**/*.ts' -p tsconfig.json",
     "lint-fix": "./node_modules/.bin/tslint --fix -c tslint.json 'src/**/*.ts' 'bin/**/*.ts' 'test/**/*.ts' -p tsconfig.json",
     "lint-dependencies": "./node_modules/.bin/depcheck . --ignores '@types/*,depcheck,tslint-language-service' --ignore-dirs 'lib'",
@@ -31,6 +32,7 @@
   },
   "license": "MIT",
   "dependencies": {
+    "@azure/storage-blob": "^12.26.0",
     "@google-cloud/storage": "^1.5.2",
     "@hubspot/api-client": "^2.0.1",
     "@sendgrid/helpers": "7.2.0",
@@ -59,7 +61,6 @@
     "analytics-node": "^3.3.0",
     "async-mutex": "^0.1.4",
     "aws-sdk": "^2.1691.0",
-    "azure-storage": "^2.10.3",
     "base64-url": "^2.3.3",
     "blocked-at": "^1.2.0",
     "body-parser": "^1.20.3",
@@ -70,6 +71,7 @@
     "dropbox": "^3.0.0",
     "express": "^4.21.1",
     "express-winston": "^4.2.0",
+    "firebase-admin": "^13.0.2",
     "googleapis": "^59.0.0",
     "i18n-iso-countries": "^7.1.0",
     "jira-client": "^6.18.0",
@@ -94,7 +96,6 @@
     "typescript": "^5.7.3",
     "uuid": "^3.4.0",
     "winston": "^2.4.5",
-    "firebase-admin": "^13.0.2",
     "yarn": "^1.22.18"
   },
   "typings": "lib/index",
diff --git a/src/actions/azure/azure_storage.ts b/src/actions/azure/azure_storage.ts
@@ -1,7 +1,6 @@
+import { BlobServiceClient, StorageSharedKeyCredential } from "@azure/storage-blob"
 import * as Hub from "../../hub"
 
-import * as azure from "azure-storage"
-
 export class AzureStorageAction extends Hub.Action {
 
   name = "azure_storage"
@@ -41,15 +40,12 @@ export class AzureStorageAction extends Hub.Action {
     }
 
     const blobService = this.azureClientFromRequest(request)
-    const writeStream = blobService.createWriteStreamToBlockBlob(container, fileName)
+    const containerClient = blobService.getContainerClient(container)
+    const blockBlobClient = containerClient.getBlockBlobClient(fileName)
 
     try {
       await request.stream(async (readable) => {
-        return new Promise<any>((resolve, reject) => {
-          readable.pipe(writeStream)
-            .on("error", reject)
-            .on("finish", resolve)
-        })
+        return blockBlobClient.uploadStream(readable)
       })
       return new Hub.ActionResponse({ success: true })
     } catch (e: any) {
@@ -58,17 +54,12 @@ export class AzureStorageAction extends Hub.Action {
   }
 
   async form(request: Hub.ActionRequest) {
-    // error in type definition for listContainersSegmented currentToken?
-    // https://github.com/Azure/azure-storage-node/issues/352
     const form = new Hub.ActionForm()
-    const blobService: any = this.azureClientFromRequest(request)
-    return new Promise<Hub.ActionForm>((resolve, _reject) => {
-      blobService.listContainersSegmented(null, (err: any, res: any) => {
-        if (err) {
-          form.error = err
-          resolve(form)
-        } else {
-          const entries: any[] = res.entries
+    const blobService: BlobServiceClient = this.azureClientFromRequest(request)
+    return new Promise<Hub.ActionForm>(async (resolve, _reject) => {
+      for await (const response of blobService.listContainers().byPage()) {
+        if (response.containerItems.length > 0) {
+          const entries: any[] = response.containerItems
           if (entries.length > 0) {
             form.fields = [{
               label: "Container",
@@ -85,18 +76,22 @@ export class AzureStorageAction extends Hub.Action {
               type: "string",
             }]
             resolve(form)
-          } else {
-            form.error = "Create a container in your Azure account."
-            resolve(form)
           }
+        } else {
+          form.error = "Create a container in your Azure account."
+          resolve(form)
         }
-      })
+      }
     })
   }
 
-  private azureClientFromRequest(request: Hub.ActionRequest) {
+  private azureClientFromRequest(request: Hub.ActionRequest): BlobServiceClient {
     try {
-      return azure.createBlobService(request.params.account!, request.params.accessKey!)
+      const sharedKeyCredential = new StorageSharedKeyCredential(request.params.account!, request.params.accessKey!)
+      return new BlobServiceClient(
+        `https://${request.params.account!}.blob.core.windows.net`,
+        sharedKeyCredential,
+      )
     } catch (err: any) {
       if (err && err.toString().includes("base64")) {
         throw "The provided Account Key is not a valid base64 string"
diff --git a/src/actions/azure/test_azure_storage.ts b/src/actions/azure/test_azure_storage.ts
@@ -1,32 +1,31 @@
 import * as chai from "chai"
+import chaiAsPromised = require("chai-as-promised")
 import * as sinon from "sinon"
-import { Stream } from "stream"
-
 import * as Hub from "../../hub"
-
 import { AzureStorageAction } from "./azure_storage"
 
+chai.use(chaiAsPromised)
+
 const action = new AzureStorageAction()
 
-function expectAzureStorageMatch(
+async function expectAzureStorageMatch(
   request: Hub.ActionRequest, _container: string, _fileName: string, dataBuffer: Buffer) {
 
-  const createWriteStreamToBlockBlobSpy = sinon.spy(async () => {
-    let data = Buffer.from("")
-    const stream = new Stream()
-    stream
-      .on("data", (chunk: any) => {
-        data = Buffer.concat([data, chunk])
-      })
-      .on("finish", () => {
-        chai.expect(data).to.equal(dataBuffer)
-      })
-    return stream
+  const uploadStreamSpy = sinon.spy(async (buffer: Buffer) => {
+    chai.expect(buffer).to.deep.equal(dataBuffer)
   })
 
+  const mockBlockBlobClient = {
+    uploadStream: uploadStreamSpy,
+  }
+
+  const mockContainerClient = {
+    getBlockBlobClient: sinon.stub().returns(mockBlockBlobClient),
+  }
+
   const stubClient = sinon.stub(action as any, "azureClientFromRequest")
     .callsFake(() => ({
-      createWriteStreamToBlockBlob: createWriteStreamToBlockBlobSpy,
+      getContainerClient: sinon.stub().withArgs(_container).returns(mockContainerClient),
     }))
 
   const stubSuggestedFilename = sinon.stub(request as any, "suggestedFilename")
@@ -52,26 +51,26 @@ describe(`${action.constructor.name} unit tests`, () => {
         .be.rejectedWith("Need Azure container.")
     })
 
-    it("sends right body to filename and container", () => {
+    it("sends right body to filename and container", async () => {
       const request = new Hub.ActionRequest()
       request.formParams = {
         container: "mycontainer",
       }
       request.attachment = {dataBuffer: Buffer.from("1,2,3,4", "utf8")}
-      return expectAzureStorageMatch(request,
+      return await expectAzureStorageMatch(request,
         "mycontainer",
         "stubSuggestedFilename",
         Buffer.from("1,2,3,4", "utf8"))
     })
 
-    it("sends to right filename if specified", () => {
+    it("sends to right filename if specified", async () => {
       const request = new Hub.ActionRequest()
       request.formParams = {
         container: "mycontainer",
         filename: "mywackyfilename",
       }
       request.attachment = {dataBuffer: Buffer.from("1,2,3,4", "utf8")}
-      return expectAzureStorageMatch(request,
+      return await expectAzureStorageMatch(request,
         "mycontainer",
         "mywackyfilename",
         Buffer.from("1,2,3,4", "utf8"))
@@ -88,16 +87,18 @@ describe(`${action.constructor.name} unit tests`, () => {
     it("has form with correct containers", (done) => {
       const stubClient = sinon.stub(action as any, "azureClientFromRequest")
         .callsFake(() => ({
-          listContainersSegmented: (filter: any, cb: (err: any, res: any) => void) => {
-            chai.expect(filter).to.equal(null)
-            const containers = {
-              entries: [
-                {id: "A", name: "A"},
-                {id: "B", name: "B"},
-              ],
-            }
-            cb(null, containers)
-          },
+          listContainers: () => ({
+            byPage: () => ({
+              async *[Symbol.asyncIterator]() {
+                yield {
+                  containerItems: [
+                    {id: "A", name: "A"},
+                    {id: "B", name: "B"},
+                  ],
+                }
+              },
+            }),
+          }),
         }))
 
       const request = new Hub.ActionRequest()
@@ -130,13 +131,15 @@ describe(`${action.constructor.name} unit tests`, () => {
   it("returns form error if no containers are present", (done) => {
     const stubClient = sinon.stub(action as any, "azureClientFromRequest")
         .callsFake(() => ({
-          listContainersSegmented: (filter: any, cb: (err: any, res: any) => void) => {
-            chai.expect(filter).to.equal(null)
-            const containers = {
-              entries: [],
-            }
-            cb(null, containers)
-          },
+          listContainers: () => ({
+            byPage: () => ({
+              async *[Symbol.asyncIterator]() {
+                yield {
+                  containerItems: [],
+                }
+              },
+            }),
+          }),
         }))
 
     const request = new Hub.ActionRequest()
diff --git a/yarn.lock b/yarn.lock
