@beauraines/node-helpers 2.14.0 → 4.0.0

package/CHANGELOG.md

@@ -2,9 +2,15 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-## [2.14.0](https://github.com/beauraines/node-helpers/compare/v2.7.1...v2.14.0) (2023-07-02)
+## [4.0.0](https://github.com/beauraines/node-helpers/compare/v2.7.1...v4.0.0) (2023-07-02)
 
 
+### ⚠ BREAKING CHANGES
+
+* **azure:** - `generateBlobSignedUrl` is now asynchronous and must be called with `await`
+
+Updates unit test to run async
+
 ### Features
 
 * adds download blob from azure helper ([08a1571](https://github.com/beauraines/node-helpers/commit/08a1571ab18b9eeeb1273e05b5abed95a7300457))
@@ -17,8 +23,12 @@ All notable changes to this project will be documented in this file. See [standa
 
 * **deps:** bump azure-devops-node-api from 12.0.0 to 12.1.0 ([#37](https://github.com/beauraines/node-helpers/issues/37)) ([b71396d](https://github.com/beauraines/node-helpers/commit/b71396d28d089a1f8919ad53363a4759f61b1e52))
 * **deps:** bump node-fetch from 2.6.11 to 2.6.12 ([786f458](https://github.com/beauraines/node-helpers/commit/786f458fbf0c03fd9462ab67db558c5646afb62e))
+* **deps:** bump xml2js and @azure/core-http ([#46](https://github.com/beauraines/node-helpers/issues/46)) ([83b0c60](https://github.com/beauraines/node-helpers/commit/83b0c6077e70120a7e24519f7a03740578236969))
 * increment version number ([c42e3ae](https://github.com/beauraines/node-helpers/commit/c42e3aebf1373b8820b18ced1b88617bbfe69da6))
 
+
+* **azure:** migrates remaining methods to @azure/storage blob ([#45](https://github.com/beauraines/node-helpers/issues/45)) ([0b11af0](https://github.com/beauraines/node-helpers/commit/0b11af00b2fb11b3e99a6190fd7848cd7563901c))
+
 ### [2.7.1](https://github.com/beauraines/node-helpers/compare/v2.7.0...v2.7.1) (2023-06-14)
 
 ## [2.7.0](https://github.com/beauraines/node-helpers/compare/v2.6.1...v2.7.0) (2023-06-14)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/node-helpers",
-  "version": "2.14.0",
+  "version": "4.0.0",
   "description": "Collection of node helpers",
   "main": "index.js",
   "scripts": {
@@ -16,7 +16,6 @@
     "@azure/storage-blob": "^12.14.0",
     "@azure/storage-queue": "^12.11.0",
     "azure-devops-node-api": "^12.0.0",
-    "azure-storage": "^2.10.7",
     "dayjs": "^1.11.7",
     "node-fetch": "^2.6.7",
     "sparkly": "^5.0.0",

package/src/azure.js

@@ -1,4 +1,3 @@
-const azure = require('azure-storage');
 const dayjs = require('dayjs')
 const fs = require('fs');
 const { streamToBuffer } = require('./helpers.js')
@@ -127,22 +126,26 @@ getStorageQueueSignedURL(queueUrl,options) {
    * @param {string} blobName The name of the blob to generate the token
    * @returns {string} the signed URL for the blob
    */
-    //TODO migrate to @azure/storage-blob
-  generateBlobSignedUrl(containerName, blobName) {
-
-    const sharedAccessPolicy = {
-        AccessPolicy: {
-            Permissions: azure.BlobUtilities.SharedAccessPermissions.READ,
-            Start: new Date(),
-            Expiry: azure.date.minutesFromNow(this.tokenExpiry),
-        },
-    };
+  async generateBlobSignedUrl(containerName, blobName) {
+
+    const blobServiceClient = new BlobServiceClient(
+      this.host('blob',this.cloudName),
+      new StorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+    );
+    const containerClient = blobServiceClient.getContainerClient(containerName);
+    const blockBlobClient = containerClient.getBlockBlobClient(blobName);
+    
+    const now = dayjs()
 
-    const blobService = azure.createBlobService(this.storageAccountName, this.storageAccountKey, this.host('blob',this.cloudName));
-    const sasToken = blobService.generateSharedAccessSignature(containerName, blobName, sharedAccessPolicy);
-    const blobUrl = blobService.getUrl(containerName, blobName, sasToken);
+    const options = {
+      permissions: 'r',
+      startsOn: now.toDate(), 
+      expiresOn: now.add(this.tokenExpiry,'minutes')
+    }
 
-    return blobUrl;
+    const signedUrl = await blockBlobClient.generateSasUrl(options)
+    console.log(signedUrl)
+    return signedUrl;
   }
 
   /**
@@ -152,26 +155,35 @@ getStorageQueueSignedURL(queueUrl,options) {
    * @param {string} file The path the the local file to upload to the container
    * @returns {boolean} Success or failure to upload
    */
-  //TODO migrate to @azure/storage-blob
-  uploadBlobFromFile(containerName,file) {
-    const blobService = azure.createBlobService(this.storageAccountName, this.storageAccountKey, this.host('blob',this.cloudName));
+  async uploadBlobFromFile(containerName,file) {
+    const blobServiceClient = new BlobServiceClient(
+      this.host('blob',this.cloudName),
+      new StorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+    );
+    const containerClient = blobServiceClient.getContainerClient(containerName);
+    
     const options = {
-        access: 'container'
+      access: 'container'
     };
     
     let blobName = path.basename(file)
-    blobService.createBlockBlobFromLocalFile(containerName,blobName,file,options,function(error,response) {
-      if( error) {
-        console.error(error.message)
-        return false
-      } else {
-        // TODO remove this from this function - separation of concerns, let the caller do the logging
-        console.log(`${response.name} uploaded to ${response.container} container`)
-        return true
-      }
-    });
+    const blockBlobClient = containerClient.getBlockBlobClient(blobName);
+    try {
+      // eslint-disable-next-line no-unused-vars
+      const response = await blockBlobClient.uploadFile(file,options)
+      // TODO remove this from this function - separation of concerns, let the caller do the logging
+      console.log(`${file} uploaded to ${containerName} container as ${blobName}`)
+      return true
+    } catch (error) {
+      console.error(error.message)
+      return false
+    }
+
+
+      
   }
 
+
   /**
    * Downloads a blob to a local file
    * 

package/src/azure.test.js

@@ -46,7 +46,7 @@ describe('Azure Storage module', () => {
 
     })
 
-    it.skip('should generate a signed URL for a blob', () => {
+    it.skip('should generate a signed URL for a blob', async () => {
         const account = "devstoreaccount1";
         const accountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==";
         let containerName = 'node-helpers-testing'
@@ -56,7 +56,7 @@ describe('Azure Storage module', () => {
         const options = {
             tokenExpiry: 42
         }
-        const signedUrl = azure.generateBlobSignedUrl(containerName,blobName,options)
+        const signedUrl = await azure.generateBlobSignedUrl(containerName,blobName,options)
         let url = new URL(signedUrl)
         const sasTokenParams = url.searchParams;