@beauraines/node-helpers 4.3.0 → 5.1.0

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 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.
 
+## [5.1.0](https://github.com/beauraines/node-helpers/compare/v5.0.0...v5.1.0) (2024-10-16)
+
+
+### Features
+
+* adds cli argument module ([#155](https://github.com/beauraines/node-helpers/issues/155)) ([b7943b6](https://github.com/beauraines/node-helpers/commit/b7943b6cf55a221ecc1a55afec2ab9505ed88347))
+
+## [5.0.0](https://github.com/beauraines/node-helpers/compare/v4.3.0...v5.0.0) (2024-10-14)
+
+
+### ⚠ BREAKING CHANGES
+
+* Updates and adds Storage Queue functions (#154)
+
+### Features
+
+* Updates and adds Storage Queue functions ([#154](https://github.com/beauraines/node-helpers/issues/154)) ([7301e37](https://github.com/beauraines/node-helpers/commit/7301e37e5e819a5d9ac222602a5e4f7be8e0816c))
+
 ## [4.3.0](https://github.com/beauraines/node-helpers/compare/v4.2.1...v4.3.0) (2024-10-14)
 
 

package/eslint.config.mjs

@@ -22,6 +22,7 @@ export default [...compat.extends("eslint:recommended"), {
         globals: {
             ...globals.browser,
             ...globals.commonjs,
+            ...globals.node,
             ...jest.environments.globals.globals,
         },
 

package/index.js

@@ -1,6 +1,7 @@
 
 const ado = require("./src/ado");
 const AzureStorage = require("./src/azure")
+const cliArguments = require('./src/cli-arguments.js');
 const config = require('./src/config.js')
 const credentials = require("./src/credentials.js");
 const database = require("./src/database");
@@ -8,12 +9,13 @@ const helpers = require("./src/helpers");
 const jira = require("./src/jira");
 
 module.exports = {
+    ado,
     AzureStorage,
+    cliArguments,
     config,
     credentials,
     database,
     helpers,
-    jira,
-    ado
+    jira
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/node-helpers",
-  "version": "4.3.0",
+  "version": "5.1.0",
   "description": "Collection of node helpers",
   "main": "index.js",
   "repository": {

package/src/ado.js

@@ -82,7 +82,7 @@ async function getDistinctParentWorkItems(workItemAPI, ids) {
 async function callRestApi(url, username, token) {
     // console.log(url) // Only display this in verbose mode
     // Bearer token format for ADO
-    // eslint-disable-next-line no-undef
+     
     let bearerToken = Buffer.from(`${username}:${token}`).toString('base64');
 
     let response;

package/src/azure.js

@@ -1,8 +1,8 @@
 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");
+const { BlobServiceClient, StorageSharedKeyCredential:BlobStorageSharedKeyCredential } = require("@azure/storage-blob");
+const { QueueServiceClient ,StorageSharedKeyCredential:QueueStorageSharedKeyCredential } = require("@azure/storage-queue");
 var path = require('path');
 
 /**
@@ -74,44 +74,148 @@ class AzureStorage {
   /**
    * Sends a message to the specified storage queue. The messages are given a TTL based upon the
    * class's `queueMessageTTLSeconds` value.
+   * 
+   * The response includes the `expiresOn`, `messageId` and `requestId` as well as a status code in 
+   * `_response.status`
+   * 
    * @param {string} queueUrl The URL to the storage queue
    * @param {string} messageContent The message to send to the queue
+   * 
+   * @returns {Object} sendMessageResponse
    */
-  async sendMessageToQueue(queueUrl, messageContent,) {
+  async sendMessageToQueue(queueName, messageContent) {
     try {
-      const queueClient = new QueueClient(
-        queueUrl,
-        new StorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+      const queueServiceClient = new QueueServiceClient(
+        this.host('queue',this.cloudName),
+        new QueueStorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
       );
+
+      const queueClient = queueServiceClient.getQueueClient(queueName);
+        
       let queueOptions = {
         messageTimeToLive: this.queueMessageTTLSeconds
       };
-      let sendMessageResponse = await queueClient.sendMessage(messageContent, queueOptions);
-      console.log(
-        "Sent message successfully, service assigned message Id:", sendMessageResponse.messageId,
-        "service assigned request Id:", sendMessageResponse.requestId
-      );
+
+      let sendMessageResponse = await queueClient.sendMessage(messageContent,queueOptions);
+      sendMessageResponse.status = sendMessageResponse._response.status;
+      delete sendMessageResponse._response;
+      return sendMessageResponse;
+
     } catch (error) {
-      console.error(error.message)
+      console.log(error.message)      
+    }
+  }
+
+  /**
+   * Gets any number of messages from the queue. The messages themselves are in the property
+   * `receivedMessageItems[]messageText` Use the options to control the number of messages returned, 
+   * defaults are 1 with a 30 second timeout. You will need the `messageId` and `popReceipt` to
+   * delete the message after processing.
+   * 
+   * @param {string} queueName The name of the queue
+   * @param {object} options Any options such as `numberOfMessages` or `visibilityTimeout`
+   * @returns {object} The queue messages response
+   */
+  async getQueueMessages(queueName,options) {
+    const queueServiceClient = new QueueServiceClient(
+      this.host('queue',this.cloudName),
+      new QueueStorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+    );
+
+    const queueClient = queueServiceClient.getQueueClient(queueName);
+    const receivedMessagesResponse = await queueClient.receiveMessages(options);
+    return receivedMessagesResponse;
+
+  }
+
+
+  /**
+   * Deletes a message, by `messageId` and `popReceipt` from a named queue
+   * 
+   * @param {string} queueName The name of the queue that has the message
+   * @param {string} messageId The message id to be deleted
+   * @param {string} popReceipt The popReceipt of teh message to be deleted
+   * @returns object with a nothing really useful
+   */
+  async deleteQueueMessage(queueName,messageId,popReceipt) {
+    const queueServiceClient = new QueueServiceClient(
+      this.host('queue',this.cloudName),
+      new QueueStorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+    );
+
+    const queueClient = queueServiceClient.getQueueClient(queueName);
+    const deleteMessageResponse = await queueClient.deleteMessage(messageId,popReceipt);
+    return deleteMessageResponse
+
+  }
+
+  /**
+   * Gets the named queues properties, which includes the approximateMessagesCount
+   * 
+   * @param {string} queueName 
+   * 
+   * @returns {Object} the queues properties
+   */
+  async getQueueProperties(queueName) {
+    const queueServiceClient = new QueueServiceClient(
+      this.host('queue',this.cloudName),
+      new QueueStorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+    );
+
+    const queueClient = queueServiceClient.getQueueClient(queueName);
+    const properties = await queueClient.getProperties();
+    return properties
+
+  }
+
+  /**
+   * Lists storage queues in the  storage account
+   * 
+   * @returns Array
+   */
+  async listsQueues() {
+    try {
+    const queueServiceClient = new QueueServiceClient(
+      this.host('queue',this.cloudName),
+      new QueueStorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+    );
+
+    let queues = []
+    for await (const queue of queueServiceClient.listQueues()) {
+        queues.push(queue)
     }
+
+    return queues;
+
+  } catch (error) {
+    console.log(error.message)
   }
+}
 
   /**
-   * Gets a SAS token for the storage queue
+   * Gets a SAS URL for the storage queue
    * .
-   * @param {string} queueUrl The URL to the storage queue
+   * @param {string} queueName The name of the storage queue
    * @param {object} options Should include `permissions: "raup"` or some combination thereof Any additional options supported. https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+   * 
+   * @returns {string} SAS URL for the specified queue
    */
-getStorageQueueSignedURL(queueUrl,options) {
-    
-  const queueClient = new QueueClient(
-      queueUrl,
-      new StorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
-      )
-  
+getStorageQueueSignedURL(queueName,options) {
+  const queueServiceClient = new QueueServiceClient(
+    this.host('queue',this.cloudName),
+    new QueueStorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+  );
+
+  const queueClient = queueServiceClient.getQueueClient(queueName);
+ 
   options = {
-      startsOn: dayjs().toDate(),
-      ...options
+    startsOn: dayjs().toDate(),
+    expiresOn: dayjs().add(this.tokenExpiry,'minutes'),
+    ...options
+  }
+  
+  if (!options.permissions || !options.expiresOn) {
+    throw new Error("Must provide 'permissions' and 'expiresOn' for Queue SAS generation when 'identifier' is not provided");    
   }
 
   return queueClient.generateSasUrl(options)
@@ -130,7 +234,7 @@ getStorageQueueSignedURL(queueUrl,options) {
 
     const blobServiceClient = new BlobServiceClient(
       this.host('blob',this.cloudName),
-      new StorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+      new BlobStorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
     );
     const containerClient = blobServiceClient.getContainerClient(containerName);
     const blockBlobClient = containerClient.getBlockBlobClient(blobName);
@@ -158,7 +262,7 @@ getStorageQueueSignedURL(queueUrl,options) {
   async uploadBlobFromFile(containerName,file) {
     const blobServiceClient = new BlobServiceClient(
       this.host('blob',this.cloudName),
-      new StorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+      new BlobStorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
     );
     const containerClient = blobServiceClient.getContainerClient(containerName);
     
@@ -194,7 +298,7 @@ getStorageQueueSignedURL(queueUrl,options) {
   async downloadBlobToFile(containerName,blobName,file) {
     const blobServiceClient = new BlobServiceClient(
       this.host('blob',this.cloudName),
-      new StorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+      new BlobStorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
     );
     const containerClient = blobServiceClient.getContainerClient(containerName);
     const blobClient = containerClient.getBlobClient(blobName);
@@ -219,7 +323,7 @@ getStorageQueueSignedURL(queueUrl,options) {
   async getBlob(containerName,blobName) {
     const blobServiceClient = new BlobServiceClient(
       this.host('blob',this.cloudName),
-      new StorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+      new BlobStorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
     );
     const containerClient = blobServiceClient.getContainerClient(containerName);
     const blobClient = containerClient.getBlobClient(blobName);
@@ -246,7 +350,7 @@ getStorageQueueSignedURL(queueUrl,options) {
   async getBinaryBlob(containerName,blobName) {
     const blobServiceClient = new BlobServiceClient(
       this.host('blob',this.cloudName),
-      new StorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+      new BlobStorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
     );
     const containerClient = blobServiceClient.getContainerClient(containerName);
     const blobClient = containerClient.getBlobClient(blobName);
@@ -268,7 +372,7 @@ getStorageQueueSignedURL(queueUrl,options) {
   async listBlobs(containerName) {
     const blobServiceClient = new BlobServiceClient(
       this.host('blob',this.cloudName),
-      new StorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
+      new BlobStorageSharedKeyCredential(this.storageAccountName, this.storageAccountKey)
     );
     const containerClient = blobServiceClient.getContainerClient(containerName);
     let blobs = []

package/src/azure.test.js

@@ -77,8 +77,6 @@ describe('Azure Storage module', () => {
         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==";
@@ -102,9 +100,6 @@ describe('Azure Storage module', () => {
         expect(fileExists(file))
     })
 
-
-
-
     it.skip('should list blobs from azure storage', async () => {
         const account = "devstoreaccount1";
         const accountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==";
@@ -118,4 +113,89 @@ describe('Azure Storage module', () => {
         expect(blobs.filter(b => b.name == blobName).length).toBe(1)
     })
 
+    it.skip('should send a message to the storage queue', async () => {
+        const account = "devstoreaccount1";
+        const accountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==";
+        let azure = new AzureStorage(account,accountKey,{cloudName:'Azurite'})
+        const message = {foo:"bar"}
+        const queueName = 'node-helpers-testing'
+        let response = await azure.sendMessageToQueue(queueName,JSON.stringify(message))
+        expect(response.status).toBe(201)
+    })
+
+    it.skip('should error when generating a SAS URL for the storage queue without permissions', async () => {
+        const account = "devstoreaccount1";
+        const accountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==";
+        let azure = new AzureStorage(account,accountKey,{cloudName:'Azurite'})
+        const queueName = 'node-helpers-testing'
+        expect(() => azure.getStorageQueueSignedURL(queueName)).toThrow();
+    })
+
+    it.skip('should generate a SAS URL for the storage queue', async () => {
+        const account = "devstoreaccount1";
+        const accountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==";
+        let azure = new AzureStorage(account,accountKey,{cloudName:'Azurite'})
+        const queueName = 'node-helpers-testing'
+        const options = {permissions:"r"}
+        let response = await azure.getStorageQueueSignedURL(queueName,options)
+        expect(response.includes('sp=r')).toBe(true) // Read permissions
+        expect(response.includes('http://127.0.0.1:10001/devstoreaccount1/node-helpers-testing')).toBe(true) // Azurite URL for storage queue
+        // TODO compute the expected expiration time
+        // expect(response.includes('se=2024-10-13T23%3A59%3A02Z')).toBe(true) // Expiration time defaults to 30 minutes
+    })
+
+
+    it.skip('should list the queues in the storage account', async () => {
+        const account = "devstoreaccount1";
+        const accountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==";
+        let azure = new AzureStorage(account,accountKey,{cloudName:'Azurite'})
+        const queueName = 'node-helpers-testing';
+        let queues = await azure.listsQueues();
+        expect(queues.map(x => x.name).indexOf(queueName)).toBeGreaterThan(-1)
+    })
+
+    it.skip('should get the queue properties', async () => {
+        const account = "devstoreaccount1";
+        const accountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==";
+        let azure = new AzureStorage(account,accountKey,{cloudName:'Azurite'})
+        const queueName = 'node-helpers-testing';
+        let properties = await azure.getQueueProperties(queueName);
+        expect(properties.approximateMessagesCount).toBeGreaterThan(0)
+    })
+
+    it.skip('should get a message from the queue', async () => {
+        const account = "devstoreaccount1";
+        const accountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==";
+        let azure = new AzureStorage(account,accountKey,{cloudName:'Azurite'})
+        const queueName = 'node-helpers-testing';
+        let response = await azure.getQueueMessages(queueName);
+        const expectedMessage = {foo:"bar"}
+        expect(response._response.status).toBe(200)
+        expect(response.receivedMessageItems.length).toBeGreaterThan(0)
+        expect(response.receivedMessageItems[0].messageText).toBe(JSON.stringify(expectedMessage))
+    })
+
+    it.skip('should get multiple messages from the queue', async () => {
+        const account = "devstoreaccount1";
+        const accountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==";
+        let azure = new AzureStorage(account,accountKey,{cloudName:'Azurite'})
+        const queueName = 'node-helpers-testing';
+        let response = await azure.getQueueMessages(queueName,{numberOfMessages:5});
+        expect(response._response.status).toBe(200)
+        expect(response.receivedMessageItems.length).toBeGreaterThan(1)
+        expect(response.receivedMessageItems.length).toBeLessThan(6)
+    })
+
+    it.skip('should delete a message from the queue',async () => {
+        const account = "devstoreaccount1";
+        const accountKey = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==";
+        let azure = new AzureStorage(account,accountKey,{cloudName:'Azurite'})
+        const queueName = 'node-helpers-testing';
+        expect(() => azure.deleteQueueMessage(queueName,undefined,undefined)).toThrow() // popReceipt cannot be null
+        let addedMessage = await azure.sendMessageToQueue(queueName,'abc123')
+        let response = await azure.deleteQueueMessage(queueName,addedMessage.messageId,addedMessage.popReceipt);
+        expect(response.errorCode).toBe(undefined)
+    })
+
+
 })

package/src/cli-arguments.js

@@ -0,0 +1,78 @@
+/**
+ * Parses command-line parameters and returns an array of the parameters. This is really getting the 
+ * "arguments" passed from the command-line, but there is no additional parsing or formatting, so 
+ * this is best suited to just parameters. You could handle each element in the array yourself for 
+ * involved processing
+ * 
+ * `node script.js beau 42`
+ * 
+ * returns
+ * `[ 'beau', '42' ]`
+ * 
+ *  * 
+ * @returns Array 
+ */
+const getParameters = () => {
+    // process.argv is an array where:
+    // - The first element is the path to the Node.js executable (e.g., '/usr/local/bin/node')
+    // - The second element is the path to the script file (e.g., '/path/to/script.js')
+    // - The subsequent elements are the command-line arguments
+
+    // Get the arguments starting from the third element
+    const args = process.argv.slice(2).length > 0 ? process.argv.slice(2) : []
+    return args
+}
+
+/**
+ * Parses named command-line arguments. This only supports long-named arguments prefixed with a `--`.
+ * Short arguments .e.g. `-d` are not supported. The value can either be space separated or with an
+ * equals sign
+ * 
+ * `node name-arguments.js  --age=42 --name=Beau`
+ * 
+ * Using this function this will return
+ * 
+ * { age: '42', name: 'Beau' }
+ * 
+ * 
+ * @returns Object
+ */
+const getNamedArguments = () => {
+    const args = {};
+  
+    const argv =process.argv;
+    // Start from index 2 to skip the node executable and script file paths
+    for (let i = 2; i < argv.length; i++) {
+      let arg = argv[i];
+  
+      if (arg.startsWith('--')) {
+        // Remove the leading --
+        arg = arg.slice(2);
+  
+        // Handle --key=value
+        if (arg.includes('=')) {
+          const [key, value] = arg.split('=');
+          args[key] = value;
+        } else {
+          // Handle --key value
+          const key = arg;
+          const value = argv[i + 1];
+  
+          if (!value || value.startsWith('--')) {
+            args[key] = true; // For flags without values
+          } else {
+            args[key] = value;
+            i++; // Skip the next item as it's the value for this key
+          }
+        }
+      }
+    }
+  
+    return args;
+  }
+
+
+module.exports = {
+    getNamedArguments,
+    getParameters
+}

package/src/credentials.js

@@ -1,6 +1,5 @@
 const fs = require('fs');
 const {fileExists} = require('./helpers');
-const process = require('node:process')
 
 /**
  * Reads a file for credentials and validates that the file has the required attributes. 

package/src/database.js

@@ -1,5 +1,4 @@
 const {homedir} = require('os');
-const process = require('node:process')
 const sqlite = require('sqlite');
 const sqlite3 = require('sqlite3');
 const {fileExists} = require('./helpers');

package/src/database.test.js

@@ -4,7 +4,6 @@ const sqlite3 = require('sqlite3');
 const helpers = require('./helpers');
 const { getDBConnection } = require('./database');
 const path = require('path');
-const process = require('node:process')
 
 jest.mock('sqlite');
 jest.mock('os');

package/src/helpers.js

@@ -137,7 +137,7 @@ function getEpochMillis() {
  * 
  * @returns 
  */
-// eslint-disable-next-line no-unused-vars
+ 
 function sparkline(data,label,options) {
 
   options = {
@@ -192,11 +192,11 @@ async function streamToBuffer(readableStream) {
   return new Promise((resolve, reject) => {
     const chunks = [];
     readableStream.on("data", (data) => {
-      // eslint-disable-next-line no-undef
+       
       chunks.push(data instanceof Buffer ? data : Buffer.from(data));
     });
     readableStream.on("end", () => {
-      // eslint-disable-next-line no-undef
+       
       resolve(Buffer.concat(chunks));
     });
     readableStream.on("error", reject);

package/src/jira.js

@@ -9,7 +9,7 @@ const fetch = require('node-fetch');
  * @returns String
  */
 function credentialsToToken(email,token) {
-    // eslint-disable-next-line no-undef
+     
     let bearerToken = Buffer.from(`${email}:${token}`).toString('base64');
     return bearerToken
 }