@beauraines/node-helpers 2.8.0 → 2.10.0

package/CHANGELOG.md

@@ -2,18 +2,20 @@
 
 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.8.0](https://github.com/beauraines/node-helpers/compare/v2.7.1...v2.8.0) (2023-07-01)
+## [2.10.0](https://github.com/beauraines/node-helpers/compare/v2.7.1...v2.10.0) (2023-07-01)
 
 
 ### Features
 
 * adds download blob from azure helper ([08a1571](https://github.com/beauraines/node-helpers/commit/08a1571ab18b9eeeb1273e05b5abed95a7300457))
+* **azure:** adds list blob command ([#42](https://github.com/beauraines/node-helpers/issues/42)) ([e60219b](https://github.com/beauraines/node-helpers/commit/e60219bf75acea70defde417a07219a1508b7c61))
 * **azure:** new getBlob function ([876716b](https://github.com/beauraines/node-helpers/commit/876716b8256b090a2eadf45c1d03b097362b2eb2))
 * **helper:** adds file write helper ([9e727e9](https://github.com/beauraines/node-helpers/commit/9e727e9ffe51525d2a73fa66ea933c1804304729))
 
 
 ### Bug Fixes
 
+* **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))
 
 ### [2.7.1](https://github.com/beauraines/node-helpers/compare/v2.7.0...v2.7.1) (2023-06-14)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/node-helpers",
-  "version": "2.8.0",
+  "version": "2.10.0",
   "description": "Collection of node helpers",
   "main": "index.js",
   "scripts": {

package/src/azure.js

@@ -1,5 +1,6 @@
 const azure = require('azure-storage');
 const dayjs = require('dayjs')
+const fs = require('fs');
 const { streamToBuffer } = require('./helpers.js')
 const { BlobServiceClient, StorageSharedKeyCredential } = require("@azure/storage-blob");
 const { QueueClient } = require("@azure/storage-queue");
@@ -149,6 +150,7 @@ getStorageQueueSignedURL(queueUrl,options) {
    * 
    * @param {string} containerName the container to which the file will be uploaded
    * @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) {
@@ -161,8 +163,11 @@ getStorageQueueSignedURL(queueUrl,options) {
     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
       }
     });
   }
@@ -183,8 +188,10 @@ getStorageQueueSignedURL(queueUrl,options) {
     const blobClient = containerClient.getBlobClient(blobName);
 
     const downloadBlockBlobResponse = await blobClient.download();
+    // TODO add a success and failure test
     let writer = fs.createWriteStream(file) 
     downloadBlockBlobResponse.readableStreamBody.pipe(writer)
+    // TODO remove this from this function - separation of concerns, let the caller do the logging
     console.log(`${blobName} downloaded to ${file}`)
 
   }
@@ -217,6 +224,29 @@ getStorageQueueSignedURL(queueUrl,options) {
 
   }
 
+  /**
+   * Lists the blobs in a specified container, returning an array of the BlobItem object
+   * 
+   * @param {string} containerName 
+   * @returns Blob[] 
+   */
+  async listBlobs(containerName) {
+    const blobServiceClient = new BlobServiceClient(
+      this.host('blob',this.cloudName),
+      new StorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+    );
+    const containerClient = blobServiceClient.getContainerClient(containerName);
+    let i = 1;
+    let blobs = []
+    for await (const blob of containerClient.listBlobsFlat()) {
+      blobs.push(blob)
+    }
+
+    return blobs
+
+  }
+
+
 }
 
 module.exports = AzureStorage

package/src/azure.test.js

@@ -1,5 +1,9 @@
+const dayjs = require('dayjs')
+const { fileExists } = require('./helpers.js')
 const AzureStorage  = require('./azure.js')
-
+const os = require('os');
+const path = require('path');
+  
 describe('Azure Storage module', () => {
 
     it('should be created with default values', () => {
@@ -42,8 +46,75 @@ describe('Azure Storage module', () => {
 
     })
 
-    it.todo('should generate a signed URL for a blob')
-    it.todo('should upload a blob from a file')
+    it.skip('should generate a signed URL for a blob', () => {
+        const account = "devstoreaccount1";
+        const accountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==";
+        let containerName = 'node-helpers-testing'
+        let blobName = 'package.json'
+
+        let azure = new AzureStorage(account,accountKey,{cloudName:'Azurite'})
+        const options = {
+            tokenExpiry: 42
+        }
+        const signedUrl = azure.generateBlobSignedUrl(containerName,blobName,options)
+        let url = new URL(signedUrl)
+        const sasTokenParams = url.searchParams;
+
+        expect(signedUrl).toContain(azure.host('blob','Azurite'))
+        expect(dayjs(sasTokenParams.get('st')).isBefore(dayjs()))
+        expect(dayjs(sasTokenParams.get('se')).isAfter(dayjs()))
+        expect(dayjs(sasTokenParams.get('st')).add(azure.tokenExpiry).isSame(dayjs(sasTokenParams.get('se'))))
+        expect(sasTokenParams.get('sp')).toBe('r') // Read only by default
+    })
+
+    it.skip('should upload a blob from a file',async () => {
+        const account = "devstoreaccount1";
+        const accountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==";
+        let containerName = 'node-helpers-testing'
+        let file = 'package.json'
+        let azure = new AzureStorage(account,accountKey,{cloudName:'Azurite'})
+        let success = await azure.uploadBlobFromFile(containerName,file)
+        expect(success)
+    })
+
     it.todo('should send a message to the storage queue')
 
+    it.skip('should get a blob from azure storage', async () =>{
+        const account = "devstoreaccount1";
+        const accountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==";
+        let containerName = 'node-helpers-testing'
+        let blobName = 'package.json'
+        let azure = new AzureStorage(account,accountKey,{cloudName:'Azurite'})
+        let file = await azure.getBlob(containerName,blobName)
+        file = JSON.parse(file)
+        expect(file.name).toBe("@beauraines/node-helpers")
+
+    })
+
+    it.skip('should download a blob to a file', async () => {
+        const account = "devstoreaccount1";
+        const accountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==";
+        let containerName = 'node-helpers-testing'
+        let blobName = 'package.json'
+        let file = path.join(os.tmpdir(),`package.${dayjs().unix()}.json`)
+        let azure = new AzureStorage(account,accountKey,{cloudName:'Azurite'})
+        await azure.downloadBlobToFile(containerName,blobName,file)
+        expect(fileExists(file))
+    })
+
+
+
+
+    it.skip('should list blobs from azure storage', async () => {
+        const account = "devstoreaccount1";
+        const accountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==";
+        let containerName = 'node-helpers-testing'
+        let blobName = 'package.json'
+        let azure = new AzureStorage(account,accountKey,{cloudName:'Azurite'})
+        let blobs = await azure.listBlobs(containerName)
+        expect(Array.isArray(blobs));
+        expect(blobs.length).toBeGreaterThan(0)
+        expect(blobs.filter(b => b.name == blobName).length).toBe(1)
+    })
+
 })