@beauraines/node-helpers 2.9.0 → 2.11.0

package/.github/workflows/test.yaml

@@ -22,5 +22,6 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm ci
+      - run: npm run lint
       - run: npm run build --if-present
       - run: npm test

package/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 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.9.0](https://github.com/beauraines/node-helpers/compare/v2.7.1...v2.9.0) (2023-07-01)
+## [2.11.0](https://github.com/beauraines/node-helpers/compare/v2.7.1...v2.11.0) (2023-07-01)
 
 
 ### Features
@@ -15,6 +15,7 @@ All notable changes to this project will be documented in this file. See [standa
 
 ### 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,12 +1,14 @@
 {
   "name": "@beauraines/node-helpers",
-  "version": "2.9.0",
+  "version": "2.11.0",
   "description": "Collection of node helpers",
   "main": "index.js",
   "scripts": {
     "test": "jest",
     "release": "standard-version",
-    "should-release": "should-release"
+    "should-release": "should-release",
+    "lint": "eslint '*/**.js'",
+    "lint:fix": "eslint '*/**.js' --fix"
   },
   "author": "beau.raines@gmail.com",
   "license": "ISC",

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}`)
 
   }
@@ -229,7 +236,6 @@ getStorageQueueSignedURL(queueUrl,options) {
       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)

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,76 @@ 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)
+        console.log(blobs)
+        expect(Array.isArray(blobs));
+        expect(blobs.length).toBeGreaterThan(0)
+        expect(blobs.filter(b => b.name == blobName).length).toBe(1)
+    })
+
 })

package/src/config.js

@@ -47,7 +47,7 @@ const validateConfig = async (configFile, configProps) => {
     config = JSON.parse(config);
     // Check for properties
     let validConfig = true
-    for (key of configProps) {
+    for (const key of configProps) {
         validConfig = config[key] ? true : false
     }
 
@@ -67,7 +67,7 @@ const validateConfig = async (configFile, configProps) => {
 const createConfig = async (configFile,configProps) => {
     configFile = path.join(homedir(),configFile)
     let config = {}
-    for (key of configProps) {
+    for (const key of configProps) {
         config[key] = ''
     }
     fs.writeFileSync(configFile,JSON.stringify(config))

package/src/credentials.js

@@ -1,5 +1,6 @@
 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,4 +1,5 @@
 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,6 +4,7 @@ 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');
@@ -37,6 +38,7 @@ describe('database module', () => {
         
         const file = undefined;
         // call function with null file
+        // eslint-disable-next-line no-unused-vars
         const db = await getDBConnection(file)
 
         // In theory you should mock the open function and what it returns.
@@ -59,6 +61,7 @@ describe('database module', () => {
 
         const expectedDefaultFile = path.join(os.homedir(),'BurnDownStatus.db')
 
+        // eslint-disable-next-line no-unused-vars
         const db = await getDBConnection(expectedDefaultFile)
 
         expect(sqlite.open).toHaveBeenCalledWith({

package/src/helpers.js

@@ -115,6 +115,7 @@ function getEpochMillis() {
  * @param {object} options Optional options for display, e.g display min,max,last, range coercion
  * @returns 
  */
+// eslint-disable-next-line no-unused-vars
 function sparkline(data,label,options) {
   // TODO add handling if data is object
   // let open = last30days.map( x=> x.open_count)
@@ -153,9 +154,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

@@ -8,6 +8,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
 }