@beauraines/node-helpers 2.5.0 → 2.6.0

package/CHANGELOG.md

@@ -2,16 +2,27 @@
 
 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.6.0](https://github.com/beauraines/node-helpers/compare/v2.5.2...v2.6.0) (2023-06-14)
+
+
+### Features
+
+* Adds Azure DevOps helpers ([#36](https://github.com/beauraines/node-helpers/issues/36)) ([3bf0658](https://github.com/beauraines/node-helpers/commit/3bf065851e2ebbeb17de4d010a8e5e25323f8ecf))
+
+### [2.5.2](https://github.com/beauraines/node-helpers/compare/v2.5.0...v2.5.2) (2023-06-03)
+
 ## [2.5.0](https://github.com/beauraines/node-helpers/compare/v2.4.3...v2.5.0) (2023-06-03)
 
 
 ### Features
 
 * new config module ([#32](https://github.com/beauraines/node-helpers/issues/32)) ([514df50](https://github.com/beauraines/node-helpers/commit/514df509ca33527a8b18e5efe43d1b772963e879))
+* supports cross OS file paths ([#33](https://github.com/beauraines/node-helpers/issues/33)) ([27f5e27](https://github.com/beauraines/node-helpers/commit/27f5e27d02408bff07220c3e82bd90186023b324)), closes [#24](https://github.com/beauraines/node-helpers/issues/24)
 
 
 ### Bug Fixes
 
+* adds export of new config module ([#34](https://github.com/beauraines/node-helpers/issues/34)) ([81c7a27](https://github.com/beauraines/node-helpers/commit/81c7a27696da3d9a0b6fb3a215418185c9b1d153))
 * **deps:** bump @azure/storage-queue from 12.12.0 to 12.13.0 ([45acd3d](https://github.com/beauraines/node-helpers/commit/45acd3d808ab064c1dbc4b492a013c7b60ebf5b2))
 * **deps:** bump dayjs from 1.11.7 to 1.11.8 ([2208985](https://github.com/beauraines/node-helpers/commit/22089855cd90758273bac28fa1d8669d21f661b5))
 * **deps:** bump node-fetch from 2.6.9 to 2.6.11 ([d9fbed2](https://github.com/beauraines/node-helpers/commit/d9fbed2e6ade418caada9cc68f6ac05ba4d3159d))

package/index.js

@@ -1,5 +1,6 @@
 
 const AzureStorage = require("./src/azure")
+const config = require('./src/config.js')
 const credentials = require("./src/credentials.js");
 const database = require("./src/database");
 const helpers = require("./src/helpers");
@@ -7,6 +8,7 @@ const jira = require("./src/jira");
 
 module.exports = {
     AzureStorage,
+    config,
     credentials,
     database,
     helpers,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/node-helpers",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "Collection of node helpers",
   "main": "index.js",
   "scripts": {
@@ -12,6 +12,7 @@
   "license": "ISC",
   "dependencies": {
     "@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",

package/src/ado.js

@@ -0,0 +1,114 @@
+const azdev = require('azure-devops-node-api')
+const {getResourceId} = require('./helpers.js')
+const {readConfig } = require('./config.js')
+const fetch = require('node-fetch');
+
+// get Current iteration
+// Get current iteration work items
+// get Teams
+// get workitems
+// update work items
+
+async function getAdoApi(configFile) {
+	const config = await readConfig(configFile)
+
+    const orgUrl = config.org;
+    // let token: string = process.env.AZURE_PERSONAL_ACCESS_TOKEN;
+    const token= config.token
+    const teamContext = { project: config.project, team: config.team};
+    
+    const authHandler = azdev.getPersonalAccessTokenHandler(token); 
+    const connection = new azdev.WebApi(orgUrl, authHandler);    
+    
+    const workAPI = await connection.getWorkApi();
+
+    const workItemAPI = await connection.getWorkItemTrackingApi();
+    
+    return {
+        workAPI,
+        workItemAPI,
+        teamContext,
+        config
+    }
+}
+
+async function getChildWorkItems(workItemAPI, id) {
+    let parentWorkItem = await workItemAPI.getWorkItem(id, undefined, undefined, 'Relations');
+
+
+    const childWorkItemIds = parentWorkItem.relations.filter(x => x.attributes.name == 'Child').map((x) => {
+        return getResourceId(x.url)
+    });
+
+    let childWorkItems = childWorkItemIds.map(id => workItemAPI.getWorkItem(id, undefined, undefined));
+    childWorkItems = await Promise.all(childWorkItems);
+
+    return childWorkItems
+}
+
+/**
+ * Gets array of distinct parent items when passed an array of work-item IDs
+ * 
+ * @param {WorkItemAPI} workItemAPI 
+ * @param {Array} ids The array of work-items of which to find the distinct parents
+ * @returns WorkItems[] Array of distinct parent work itesm
+ */
+async function getDistinctParentWorkItems(workItemAPI, ids) {
+    let workItems = ids.map(id => {
+        return workItemAPI.getWorkItem(id, undefined, undefined, 'Relations')
+    })
+    workItems = await Promise.all(workItems)   
+
+    let parentIds = workItems.map(wi => {
+        const parent = wi?.relations?.filter(x => x.attributes.name == 'Parent')[0]
+        return parent ? getResourceId(parent.url) : null
+    })
+
+    let parentWorkItems = parentIds.map(parentId => workItemAPI.getWorkItem(parentId,undefined, undefined, 'Relations'))
+    parentWorkItems = await Promise.all(parentWorkItems)
+    parentWorkItems = parentWorkItems.filter(x => x!=null)
+    
+    let distinctParentWorkItemIds = [...new Set(parentWorkItems.map(wi => wi?.id))];
+
+    let distinctParentWorkItems = distinctParentWorkItemIds.map(distinctParentId => workItemAPI.getWorkItem(distinctParentId,undefined, undefined, 'Relations'))
+    distinctParentWorkItems = await Promise.all(distinctParentWorkItems)
+
+    return distinctParentWorkItems
+}
+
+
+// TODO do something different about how to Auth
+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;
+    try {
+        response = await fetch(url, {
+            method: 'GET',
+            headers: {
+                'Authorization': `Basic ${bearerToken}`,
+                'Accept': 'application/json',
+                'Content-Type': 'application/json',
+            }
+        });
+
+        if (response.ok) {
+            return response.json();
+        } else {
+            throw new Error(response.statusText);
+        }
+    } catch (error) {
+        console.error(error.message)
+    }
+}
+
+
+module.exports = {
+    getAdoApi,
+    getChildWorkItems,
+    getDistinctParentWorkItems,
+    callRestApi
+} 

package/src/database.js

@@ -2,15 +2,15 @@ const {homedir} = require('os');
 const sqlite = require('sqlite');
 const sqlite3 = require('sqlite3');
 const {fileExists} = require('./helpers');
+const path = require('path');
 
 /**
  * Opens the BurnDownStatus SQLite3 Database
- * @param file file name of the SQLite3 DB. If not provided, defaults to ${homedir}/BurnDownStatus.db
+ * @param file file name of the SQLite3 DB. If not provided, defaults to BurnDownStatus.db in the users home
  * @returns SQLite database connection
  */
 async function getDBConnection(file) {
-    const homeDir = homedir();
-    file = file ? file : `${homeDir}/BurnDownStatus.db`;
+    file = file ? file : path.join(homedir(),'BurnDownStatus.db');
     if (! await fileExists(file)){
         console.error(`${file} not found`);
         // ! Separation of concerns - this should probably not be doing the exiting, but it is.

package/src/database.test.js

@@ -3,6 +3,7 @@ const sqlite = require('sqlite');
 const sqlite3 = require('sqlite3');
 const helpers = require('./helpers');
 const { getDBConnection } = require('./database');
+const path = require('path');
 
 jest.mock('sqlite');
 jest.mock('os');
@@ -32,7 +33,7 @@ describe('database module', () => {
         helpers.fileExists.mockReturnValue(true);
 
 
-        const expectedDefaultFile = `${os.homedir()}/BurnDownStatus.db`
+        const expectedDefaultFile = path.join(os.homedir(),'BurnDownStatus.db')
         
         const file = undefined;
         // call function with null file
@@ -56,7 +57,7 @@ describe('database module', () => {
         os.homedir.mockReturnValue(expectedHomeDir);
         helpers.fileExists.mockReturnValue(true);
 
-        const expectedDefaultFile = `${os.homedir()}/my_database.db`
+        const expectedDefaultFile = path.join(os.homedir(),'BurnDownStatus.db')
 
         const db = await getDBConnection(expectedDefaultFile)
 

package/src/helpers.js

@@ -121,8 +121,26 @@ function sparkline(data,label,options) {
   return `${label} [${minValue},${maxValue}] ${sparkly(data.map( x=> x- minValue))} ${lastValue}`
 }
 
+/**
+ * Given a RESTful url e.g. https://www.example.com/app/#list/44719910/959889147?id=12234&363636=334' 
+ * this function will return the resource ID, ignoring the query parameters
+ * 
+ * @param {string} url The URL to find the resource or last part of the routing
+ * @returns string
+ */
+const getResourceId = (url) => {
+  let queryStringStart = url.lastIndexOf('?')
+  if (queryStringStart == -1) {
+      queryStringStart = url.length
+  }
+  const lastSlash = url.lastIndexOf('/')
+  const id = url.substring(lastSlash+1,queryStringStart) 
+  return id
+}
+
 module.exports = {
     getEpochMillis,
+    getResourceId,
     fileExists,
     groupAndSum,
     readFile,