@beauraines/node-helpers 2.7.2 → 2.9.0

package/CHANGELOG.md

@@ -2,7 +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.7.2](https://github.com/beauraines/node-helpers/compare/v2.7.1...v2.7.2) (2023-06-30)
+## [2.9.0](https://github.com/beauraines/node-helpers/compare/v2.7.1...v2.9.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

package/README.md

@@ -5,3 +5,22 @@ This is a set of helpers for node. They're written for quick reuse rather than r
 My use is primarily in quicker one off scripts that sometime morph into something long lasting...
 
 
+## Azure Storage
+
+Get blob from Azure example, downloads `bar.jpg` from `foo` container to `baz.jgp`
+
+```javascript
+const AzureStorage  = require('./src/azure.js')
+
+
+let storageAccountName = 'devstoreaccount1'
+let storageAccountKey = 'Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw=='
+let options = {cloudName: 'Azurite'}
+
+let azure = new AzureStorage(storageAccountName,storageAccountKey,options)
+
+let containerName = 'foo'
+let blob = 'bar.jpg'
+let file = 'baz.jpg'
+await azure.downloadBlobToFile(containerName,blob,file)
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/node-helpers",
-  "version": "2.7.2",
+  "version": "2.9.0",
   "description": "Collection of node helpers",
   "main": "index.js",
   "scripts": {
@@ -11,6 +11,7 @@
   "author": "beau.raines@gmail.com",
   "license": "ISC",
   "dependencies": {
+    "@azure/storage-blob": "^12.14.0",
     "@azure/storage-queue": "^12.11.0",
     "azure-devops-node-api": "^12.0.0",
     "azure-storage": "^2.10.7",

package/src/azure.js

@@ -1,6 +1,8 @@
 const azure = require('azure-storage');
 const dayjs = require('dayjs')
-const { QueueClient, StorageSharedKeyCredential } = require("@azure/storage-queue");
+const { streamToBuffer } = require('./helpers.js')
+const { BlobServiceClient, StorageSharedKeyCredential } = require("@azure/storage-blob");
+const { QueueClient } = require("@azure/storage-queue");
 var path = require('path');
 
 /**
@@ -124,6 +126,7 @@ 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 = {
@@ -147,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
    */
+  //TODO migrate to @azure/storage-blob
   uploadBlobFromFile(containerName,file) {
     const blobService = azure.createBlobService(this.storageAccountName, this.storageAccountKey, this.host('blob',this.cloudName));
     const options = {
@@ -163,6 +167,79 @@ getStorageQueueSignedURL(queueUrl,options) {
     });
   }
 
+  /**
+   * Downloads a blob to a local file
+   * 
+   * @param {string} containerName the name of the container to download the blob from
+   * @param {string} blob The blob to download
+   * @param {string} file The path to the location to write the file
+   */
+  async downloadBlobToFile(containerName,blobName,file) {
+    const blobServiceClient = new BlobServiceClient(
+      this.host('blob',this.cloudName),
+      new StorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+    );
+    const containerClient = blobServiceClient.getContainerClient(containerName);
+    const blobClient = containerClient.getBlobClient(blobName);
+
+    const downloadBlockBlobResponse = await blobClient.download();
+    let writer = fs.createWriteStream(file) 
+    downloadBlockBlobResponse.readableStreamBody.pipe(writer)
+    console.log(`${blobName} downloaded to ${file}`)
+
+  }
+
+  /**
+   * Gets a blob and returns the content. The idea is that you can get a blob without 
+   * having to save it to a file and then re-read it. This may be limited in that it 
+   * can only deal with non-binary content.
+   * 
+   * @param {string} containerName the container to get the blob from
+   * @param {string} blobName the name of the blob to get
+   * @returns {string} the downloaded blob as 
+   */
+  async getBlob(containerName,blobName) {
+    const blobServiceClient = new BlobServiceClient(
+      this.host('blob',this.cloudName),
+      new StorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+    );
+    const containerClient = blobServiceClient.getContainerClient(containerName);
+    const blobClient = containerClient.getBlobClient(blobName);
+
+     // Get blob content from position 0 to the end
+    // In Node.js, get downloaded data by accessing downloadBlockBlobResponse.readableStreamBody
+    const downloadBlockBlobResponse = await blobClient.download();
+    const downloaded = (
+      await streamToBuffer(downloadBlockBlobResponse.readableStreamBody)
+    ).toString(); // FIXME - what happens with binary content?
+    // console.log("Downloaded blob content:", downloaded);
+    return downloaded
+
+  }
+
+  /**
+   * 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/helpers.js

@@ -42,6 +42,15 @@ async function readFile(filePath) {
   return fs.readFileSync(filePath,{ encoding: 'utf8', flag: 'r' });
 }
 
+/**
+ * Asynchronously writes input to filename.
+ * @param {string} filePath fully qualified path and filename
+ * @returns any
+ */
+async function writeFile(filePath,data) {
+  return fs.writeFileSync(filePath,data,{ encoding: 'utf8' });
+}
+
 /**
  * Asynchronously reads the contents of a directory and returns the filenames as an array. Optionally, 
  * filters by the extension
@@ -138,6 +147,21 @@ const getResourceId = (url) => {
   return id
 }
 
+
+// [Node.js only] A helper method used to read a Node.js readable stream into a Buffer
+async function streamToBuffer(readableStream) {
+  return new Promise((resolve, reject) => {
+    const chunks = [];
+    readableStream.on("data", (data) => {
+      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
+    });
+    readableStream.on("end", () => {
+      resolve(Buffer.concat(chunks));
+    });
+    readableStream.on("error", reject);
+  });
+}
+
 module.exports = {
     getEpochMillis,
     getResourceId,
@@ -146,7 +170,9 @@ module.exports = {
     readFile,
     listFiles,
     sparkline,
+    streamToBuffer,
     stripNewLines,
     toTitleCase,
-    unixTimestamp
+    unixTimestamp,
+    writeFile
 }