Fix log time percentage

Author: Marco LUCARELLA

docs-gen/docs/api/api-introduction.md

@@ -62,7 +62,7 @@ The responses are cached in order to reduce the network load.
 - [`$ji.macro.getWorkLogBySprint(projectKeyOrId: string, sprint: IJiraSprint)`](/docs/api/api-macro#getWorkLogBySprint)
 - [`$ji.macro.getWorkLogBySprintId(projectKeyOrId: string, sprintId: number)`](/docs/api/api-macro#getWorkLogBySprintId)
 - [`$ji.macro.getWorkLogByDates(projectKeyOrId: string, startDate: string, endDate: string = 'now()')`](/docs/api/api-macro#getWorkLogByDates)
-- [`$ji.macro.getWorkLogByUser(projectKeyOrId: string, startDate: string, endDate: string = 'now()')`](/docs/api/api-macro#getWorkLogByUser)
+- [`$ji.macro.getWorkLogSeriesByUser(projectKeyOrId: string, startDate: string, endDate: string = 'now()')`](/docs/api/api-macro#getWorkLogSeriesByUser)
 - [`$ji.macro.getVelocity(projectKeyOrId: string, sprintId: number, storyPointFieldName: string = 'aggregatetimeoriginalestimate')`](/docs/api/api-macro#getVelocity)
 
 ### API Category - [Chart](/docs/api/api-chart)

src/api/api.ts

@@ -1,6 +1,6 @@
 import { getAccountByAlias, getAccountByHost } from "../utils"
 import ObjectsCache from "../objectsCache"
-import { getActiveSprint, getActiveSprintName, getVelocity, getWorkLogByDates, getWorkLogBySprint, getWorkLogBySprintId, getWorkLogByUser } from "./apiMacro"
+import { getActiveSprint, getActiveSprintName, getVelocity, getWorkLogByDates, getWorkLogBySprint, getWorkLogBySprintId, getWorkLogSeriesByUser } from "./apiMacro"
 import { getDefaultedSearchResults, getIssueDefaulted } from "./apiDefaulted"
 import { getWorklogPerDay, getWorklogPerUser } from "./apiChart"
 import { getBoards, getDevStatus, getIssue, getLoggedUser, getSearchResults, getSprint, getSprints } from "./apiBase"
@@ -25,7 +25,7 @@ const API = {
         getWorkLogBySprint: getWorkLogBySprint,
         getWorkLogBySprintId: getWorkLogBySprintId,
         getWorkLogByDates: getWorkLogByDates,
-        getWorkLogByUser: getWorkLogByUser,
+        getWorkLogSeriesByUser: getWorkLogSeriesByUser,
         getVelocity: getVelocity,
     },
     chart: {

src/api/apiChart.ts

@@ -1,15 +1,18 @@
 import moment from "moment"
 import { IMultiSeries, ISeries } from "../interfaces/issueInterfaces"
-import { SECOND_IN_A_DAY } from "../interfaces/settingsInterfaces"
 import { getRandomRGBColor, resetRandomGenerator } from "../utils"
 import API from "./api"
+const ms = require('ms')
 
 enum EChartFormat {
-    SECONDS = 'Seconds',
+    HOURS = 'Hours',
     DAYS = 'Days',
     PERCENTAGE = 'Percentage',
 }
 
+const MS_IN_A_DAY = ms('1d')
+const MS_IN_A_HOUR = ms('1h')
+
 export async function getWorklogPerDay(projectKeyOrId: string, startDate: string, endDate: string = 'now()') {
     const worklogs = await API.macro.getWorkLogByDates(projectKeyOrId, startDate, endDate)
     const labels = []
@@ -22,7 +25,7 @@ export async function getWorklogPerDay(projectKeyOrId: string, startDate: string
     }
     const usersSeries: IMultiSeries = {}
     for (const worklog of worklogs) {
-        const author = worklog.author.key
+        const author = worklog.author.name
         if (!usersSeries[author]) {
             usersSeries[author] = Object.assign({}, emptySeries)
         }
@@ -53,22 +56,32 @@ export async function getWorklogPerDay(projectKeyOrId: string, startDate: string
 export async function getWorklogPerUser(projectKeyOrId: string, startDate: string, endDate: string = 'now()', options: { format?: EChartFormat, capacity?: ISeries } = {}) {
     const opt = {
         format: options.format || EChartFormat.PERCENTAGE,
-        capacity: options.capacity || {},
+        capacity: options.capacity || null,
     }
-    const series = await API.macro.getWorkLogByUser(projectKeyOrId, startDate, endDate)
+    const series = await API.macro.getWorkLogSeriesByUser(projectKeyOrId, startDate, endDate)
     switch (opt.format) {
-        case EChartFormat.SECONDS:
+        case EChartFormat.HOURS:
+            for (const a in series) {
+                series[a] = series[a] / MS_IN_A_HOUR
+            }
             break
         case EChartFormat.DAYS:
             for (const a in series) {
-                series[a] = series[a] / SECOND_IN_A_DAY
+                series[a] = series[a] / MS_IN_A_DAY
             }
             break
         case EChartFormat.PERCENTAGE:
-            const days = moment(moment(endDate).unix() - moment(startDate).unix()).days()
+            const days = moment.duration(moment(endDate).diff(startDate)).asDays()
             for (const author in series) {
-                const capacity = opt.capacity[author] || days
-                series[author] = series[author] / capacity / SECOND_IN_A_DAY * 100
+                if (opt.capacity) {
+                    if (author in opt.capacity) {
+                        series[author] = series[author] / opt.capacity[author] / MS_IN_A_DAY * 100
+                    } else {
+                        delete series[author]
+                    }
+                } else {
+                    series[author] = series[author] / days / MS_IN_A_DAY * 100
+                }
             }
             break
         default:

src/api/apiMacro.ts

@@ -1,6 +1,7 @@
 import { ESprintState, IJiraSprint, IJiraWorklog, ISeries } from "../interfaces/issueInterfaces"
 import API from "./api"
 import moment from "moment"
+const ms = require('ms')
 
 function dateTimeToDate(dateTime: string): string {
     if (dateTime.match(/^\d/)) {
@@ -42,21 +43,22 @@ export async function getWorkLogByDates(projectKeyOrId: string, startDate: strin
     let worklogs: IJiraWorklog[] = []
     for (const issue of searchResults.issues) {
         if (issue.fields.worklog && issue.fields.worklog.worklogs) {
+            issue.fields.worklog.worklogs.forEach(worklog => worklog.issueKey = issue.key)
             worklogs = worklogs.concat(issue.fields.worklog.worklogs)
         }
     }
     return worklogs
 }
 
-export async function getWorkLogByUser(projectKeyOrId: string, startDate: string, endDate: string = 'now()'): Promise<ISeries> {
+export async function getWorkLogSeriesByUser(projectKeyOrId: string, startDate: string, endDate: string = 'now()'): Promise<ISeries> {
     const worklogs = await API.macro.getWorkLogByDates(projectKeyOrId, startDate, endDate)
     const series: ISeries = {}
     for (const worklog of worklogs) {
-        const author = worklog.author.key
+        const author = worklog.author.name
         if (!(author in series)) {
             series[author] = 0
         }
-        series[author] += worklog.timeSpentSeconds
+        series[author] += worklog.timeSpent.split(' ').map(x => ms(x)).reduce((x, y) => x + y)
     }
     return series
 }

src/interfaces/issueInterfaces.ts

@@ -88,11 +88,13 @@ export interface IJiraWorklog {
     timeSpentSeconds: number
     updateAuthor: IJiraUser
     updated: string
+    issueKey?: string
 }
 
 export interface IJiraUser {
     active: boolean
     displayName: string
+    name: string
     key: string
     emailAddress: string
     self: string

src/interfaces/settingsInterfaces.ts

@@ -19,7 +19,6 @@ export const COLOR_SCHEMA_DESCRIPTION = {
 
 export const COMPACT_SYMBOL = '-'
 export const COMMENT_REGEX = /^\s*#/
-export const SECOND_IN_A_DAY = 25200
 
 export interface IJiraIssueSettings {
     accounts: IJiraIssueAccountSettings[]