Adding minimum time plugin.

Added pluginOrder to sort plugin execution order.
Add Minimum plugin.
Add Round plugin.
Add Ceiling plugin.

Improvement might be to add timeModified description of all plugins with previous duration and new duration into the summary.

Author: LiamKarlMitchell

README.md

@@ -107,6 +107,63 @@ More Verbose Mode
 node index --verbose=5
 ```
 
+## Plugins
+
+Plugins can be loaded in.
+
+Optional argument of pluginOrder lets you sort the order in which plugins are loaded.
+
+Example Config:
+```json
+{
+  "plugins": {
+    "CollateTimeEntries": { "pluginOrder": 1, "enabled": true, "keyTags": [ "Overtime" ] },
+    "CompleteTicketViaTag": { "pluginOrder": 2, "enabled": true },
+    "StoreSummaryAsCommentOnTicketViaTag": { "pluginOrder": 3, "enabled": true },
+    "SyncResultsToHTML": { "pluginOrder": 4, "enabled": true },
+    "Minimum" : { "pluginOrder": 10, "minutes": 15 }
+  }
+}
+```
+
+### Collate Time Entries
+
+Collates time entries into a single record if they are the same project, issue number, comment, billable status, day.
+
+### Complete Ticket Via Tag
+
+Completes a ticket in Active Collab based on the Tag given.
+
+### Minimum
+
+Lets you have a minimum time for each entry.
+15 minutes default.
+
+Arguments:
+duration: seconds
+
+### Round
+
+Lets you round a time entry duration to a chuck of seconds.
+
+Arguments:
+duration: seconds
+
+### Ceiling
+
+Lets you round up a time entry duration to a chuck of seconds.
+
+Arguments:
+duration: seconds
+
+
+### Store Summary As Comment On Ticket Via Tag
+
+Store the summary from the time entry onto the Active Collab ticket if the tag is set.
+
+### Sync Results To HTML
+Recommended, gives an HTML report after syncing that can be used to see potential issues.
+
 ## License etc...
 License: MIT
 

config/config.dist.json

@@ -21,5 +21,6 @@
     "CompaniesAndProjects": "0 * * * *",
     "TimeEntries": "*/5 * * * *"
   },
-  "projectTasksCacheTTLSeconds": 300
+  "projectTasksCacheTTLSeconds": 300,
+  "plugins": {}
 }

index.js

@@ -57,7 +57,9 @@ async function Main () {
 const plugins = []
 async function LoadPlugins () {
   if (config.plugins) {
-    Object.entries(config.plugins).forEach(
+    Object.entries(config.plugins).sort((a, b) => {
+      return (a[1].pluginOrder || 0) - (b[1].pluginOrder || 0)
+    }).forEach(
       ([pluginName, pluginConfig]) => {
         var scriptName = pluginName
         pluginConfig.name = pluginName
@@ -147,7 +149,7 @@ async function ConfigCheck () {
     // people/PeopleId/users
 
     throw new Error(
-      "Expecting config.togglToActiveCollabUserMapping to map the Toggl User ID's to Active Collab User ID's.\nExample: { \"4118110\": 315 }"
+      "Expecting config.togglToActiveCollabUserMapping to map the Toggl User ID's to Active Collab User ID's.\nExample: { \"2108110\": 925 }"
     )
   }
 
@@ -786,7 +788,8 @@ async function SyncTimeEntries () {
     let timeEntry = timeEntries[index]
 
     if (timeEntry.wid !== config.Toggl.workspaceId) {
-      await deletePreviousTimeEntryMapping()
+      // TODO: Fix error Cannot access 'deletePreviousTimeEntryMapping' before initialization
+      //await deletePreviousTimeEntryMapping()
       syncResults.ignored.push({
         summary: 'Not in workspace.',
         timeEntry: timeEntry
@@ -803,7 +806,8 @@ async function SyncTimeEntries () {
     var activeCollabUserId =
       config.togglToActiveCollabUserMapping[timeEntry.uid]
     if (activeCollabUserId === undefined) {
-      await deletePreviousTimeEntryMapping()
+      // TODO: Fix error Cannot access 'deletePreviousTimeEntryMapping' before initialization
+      // await deletePreviousTimeEntryMapping()
       syncResults.failed.push({
         summary: `User ID mapping not found for Time Entry UID: ${
           timeEntry.uid
@@ -829,6 +833,10 @@ async function SyncTimeEntries () {
 
     let previousTimeEntryMapping = timeMappings.getRecord(timeEntry.id)
 
+    if (previousTimeEntryMapping !== null) {
+      await eventEmitter.emit('beforeDeletePreviousTimeEntry', { timeEntry: timeEntry, previousTimeEntryMapping: previousTimeEntryMapping, syncResults: syncResults })
+    }
+
     let deletePreviousTimeEntryMapping = async (deleteMappingRecord = true) => {
       if (previousTimeEntryMapping === null || previousTimeEntryMapping === undefined) {
         return

plugins/Ceiling.js

@@ -0,0 +1,28 @@
+const events = require('../MyEventEmitter')
+const activeCollab = require('../MyActiveCollabClient')
+
+module.exports = {
+  init: function (pluginConfig) {
+
+    // Default duration to round of 5 minutes.
+    if (typeof pluginConfig.duration === 'undefined') {
+      pluginConfig.duration = 300
+    }    
+
+    events.on('onTimeEntry', async function (event) {
+      let timeEntry = event.timeEntry
+
+      // Don't set the minimum duration if skipped or collated.
+      if (timeEntry.skip || timeEntry.collated) {
+        return
+      }
+
+      let roundDuration = Math.ceil(timeEntry.duration / pluginConfig.duration) * pluginConfig.duration
+
+      if (roundDuration != timeEntry.duration) {
+        timeEntry.timeModified = 'ceil'
+        timeEntry.duration = roundDuration
+      }
+    })
+  }
+}

plugins/Minimum.js

@@ -0,0 +1,25 @@
+const events = require('../MyEventEmitter')
+const activeCollab = require('../MyActiveCollabClient')
+
+module.exports = {
+  init: function (pluginConfig) {
+
+    if (typeof pluginConfig.duration === 'undefined') {
+      pluginConfig.duration = 15 * 60
+    }
+
+    events.on('onTimeEntry', async function (event) {
+      let timeEntry = event.timeEntry
+
+      // Don't set the minimum duration if skipped or collated.
+      if (timeEntry.skip || timeEntry.collated) {
+        return
+      }
+
+      if (timeEntry.duration < pluginConfig.duration) {
+        timeEntry.timeModified = 'minimum ' + pluginConfig.duration
+        timeEntry.duration = pluginConfig.duration
+      }
+    })
+  }
+}

plugins/Round.js

@@ -0,0 +1,28 @@
+const events = require('../MyEventEmitter')
+const activeCollab = require('../MyActiveCollabClient')
+
+module.exports = {
+  init: function (pluginConfig) {
+
+    // Default duration to round of 5 minutes.
+    if (typeof pluginConfig.duration === 'undefined') {
+      pluginConfig.duration = 300
+    }    
+
+    events.on('onTimeEntry', async function (event) {
+      let timeEntry = event.timeEntry
+
+      // Don't set the minimum duration if skipped or collated.
+      if (timeEntry.skip || timeEntry.collated) {
+        return
+      }
+
+      let roundDuration = Math.round(timeEntry.duration / pluginConfig.duration) * pluginConfig.duration
+
+      if (roundDuration != timeEntry.duration) {
+        timeEntry.timeModified = 'round'
+        timeEntry.duration = roundDuration
+      }
+    })
+  }
+}

plugins/SyncResultsToHTML.js

@@ -241,7 +241,7 @@ Recent: ${syncResults.recent.length}<br>
     ? '#' + result.timeEntry.issueNumber
     : ''
 }</td>`
-output += `<td>${result.timeEntry.billable ? '<small>$ Billable</small><br>' : ''}${result.timeEntry.tags !== undefined && result.timeEntry.tags.length > 0 ? "<small><span>"+result.timeEntry.tags.join('</span><span>')+"</span></small><br>" : ''}${result.timeEntry.collatedTimeEntries !== undefined ? '<small>Collated ('+result.timeEntry.collatedTimeEntries.length+')</small>' : ''}<xmp>${result.timeEntry.summary || result.timeEntry.description || ''}</xmp></td>`
+output += `<td>${result.timeEntry.billable ? '<small>$ Billable</small><br>' : ''}${result.timeEntry.tags !== undefined && result.timeEntry.tags.length > 0 ? "<small><span>"+result.timeEntry.tags.join('</span><span>')+"</span></small><br>" : ''}${result.timeEntry.collatedTimeEntries !== undefined ? '<small>Collated ('+result.timeEntry.collatedTimeEntries.length+')</small>' : ''}<xmp>${result.timeEntry.summary || result.timeEntry.description || ''}</xmp>${result.timeEntry.timeModified ? '<br><small>Time was modified ' + result.timeEntry.timeModified + '</small>': '' }</td>`
 output += `<td>${moment.utc(durationSeconds*1000).format('HH:mm:ss')}</td>
 <td>
 `