feat:

Added maintainer feature
Completed CLI

Author: dploeger

index.ts

@@ -1,36 +1,12 @@
-/**
- * @module confluence-outdated
- */
-/**
- */
+#!/usr/bin/env node
 
-// import needed modules
+import * as Path from 'path'
+import { CLI, Shim } from 'clime'
 
-import * as loglevel from 'loglevel'
-import Bluebird = require('bluebird')
+// The second parameter is the path to folder that contains command modules.
+const cli = new CLI('confluence-outdated', Path.join(__dirname, 'lib', 'commands'))
 
-/**
- * confluence-outdated - Constant validation of Confluence document outdates
- */
-export class ExampleClass {
-  /**
-   * Use a logger instance to log, what you're doing
-   */
-  private _log: loglevel.Logger = null
-
-  constructor() {
-    this._log = loglevel.getLogger('confluence-outdated:ExampleClass')
-  }
-
-  /**
-   * Be nice.
-   * @param {string} name Who are you?
-   * @return {Bluebird<string>} My greets to you
-   */
-  public helloWorld(name: string): Bluebird<string> {
-    if (name === '') {
-      return Bluebird.reject(new Error('Found nobody to greet'))
-    }
-    return Bluebird.resolve(`Hello ${name}`)
-  }
-}
+// Clime in its core provides an object-based command-line infrastructure.
+// To have it work as a common CLI, a shim needs to be applied:
+const shim = new Shim(cli)
+shim.execute(process.argv)

lib/DefaultOptions.ts

@@ -0,0 +1,45 @@
+import { option, Options } from 'clime'
+import * as log from 'loglevel'
+import * as prefix from 'loglevel-plugin-prefix'
+
+export class DefaultOptions extends Options {
+  @option({
+    name: 'url',
+    flag: 'U',
+    description: 'URL to your Confluence instance',
+    required: true,
+  })
+  confluenceUrl: string
+
+  @option({
+    name: 'user',
+    flag: 'u',
+    description: 'Username for checking all confluence documents',
+    required: true,
+  })
+  confluenceUser: string
+
+  @option({
+    name: 'password',
+    flag: 'p',
+    description: 'Password for the user',
+    required: true,
+  })
+  confluencePassword: string
+
+  @option({
+    description: 'Log-Level to use (trace, debug, verbose, info, warn, error)',
+    default: 'error',
+    validator: /trace|debug|verbose|info|warn|error/,
+  })
+  public loglevel: string
+
+  public getLogger(): log.Logger {
+    prefix.reg(log)
+    prefix.apply(log, {
+      template: '[%t] %l (%n)',
+    })
+    log.setDefaultLevel(this.loglevel as log.LogLevelDesc)
+    return log.getLogger('cli')
+  }
+}

lib/api/Configuration.ts

@@ -5,6 +5,7 @@ import { ConfigurationError } from '../error/ConfigurationError'
 import * as SMTPTransport from 'nodemailer/lib/smtp-transport'
 import log = require('loglevel')
 import * as cheerio from 'cheerio'
+import { Maintainer } from './Maintainer'
 
 /**
  * Configuration API
@@ -63,6 +64,11 @@ export class Configuration {
    */
   public checks: Array<Check>
 
+  /**
+   * A list of page maintainers
+   */
+  public maintainer: Array<Maintainer>
+
   /**
    * A Handlebars template for the notification mail subject
    */
@@ -130,6 +136,9 @@ export class Configuration {
         throw e
       }
 
+      this._log.trace(`Configuration document content: 
+      ${configurationDocument.body.storage.value}`)
+
       const $ = cheerio.load(configurationDocument.body.storage.value)
 
       if ($ === null) {
@@ -155,6 +164,15 @@ export class Configuration {
         }
       })
 
+      // Load maintainer
+
+      this.maintainer = this._getConfigurationFromPanel($, 'Maintainer').map<Maintainer>((value) => {
+        return {
+          pagePattern: new RegExp(value.pagepattern),
+          maintainer: value.maintainer,
+        }
+      })
+
       this.transportOptions = this._getConfigurationFromPanel($, 'SMTP')[0]
 
       this.notificationSubjectTemplate = $(

lib/api/DocumentInfo.ts

@@ -19,7 +19,7 @@ export interface DocumentInfo {
   /**
    * The date of the last version
    */
-  lastVersionDate: Moment
+  lastVersionDate: Moment | string
   /**
    * The edit message of the last version
    */
@@ -33,12 +33,12 @@ export interface DocumentInfo {
 export class DocumentInfo implements DocumentInfo {
   public id: number
   public author: string
-  public lastVersionDate: moment.Moment
+  public lastVersionDate: Moment | string
   public lastVersionMessage: string
   public title: string
   public url: string
 
-  constructor(id: number, author: string, lastVersionDate: moment.Moment, lastVersionMessage: string, title: string, url: string) {
+  constructor(id: number, author: string, lastVersionDate: Moment, lastVersionMessage: string, title: string, url: string) {
     this.id = id
     this.author = author
     this.lastVersionDate = lastVersionDate

lib/api/Maintainer.ts

@@ -0,0 +1,24 @@
+/**
+ * A maintainer definition for pages matching a pattern.
+ * Will override the last version author
+ */
+export interface Maintainer {
+  /**
+   * A pattern matching the document title
+   */
+  pagePattern: RegExp
+  /**
+   * The username of the user maintaining the pages matching the pattern
+   */
+  maintainer: string
+}
+
+export class Maintainer implements Maintainer {
+  public maintainer: string
+  public pagePattern: RegExp
+
+  constructor(maintainer: string, pagePattern: RegExp) {
+    this.maintainer = maintainer
+    this.pagePattern = pagePattern
+  }
+}

lib/api/Notification.ts

@@ -4,26 +4,52 @@ import { createTransport } from 'nodemailer'
 import * as Mail from 'nodemailer/lib/mailer'
 import { DocumentInfo } from './DocumentInfo'
 import * as Handlebars from 'handlebars'
+import { Logger } from 'loglevel'
+import { Moment } from 'moment'
+import log = require('loglevel')
+import moment = require('moment')
 
 export class Notification {
   private _configuration: Configuration
   private _confluence: Confluence
   private _transport: Mail
+  private _log: Logger
+  private readonly _dryRun: boolean
 
-  constructor(configuration: Configuration, confluence: Confluence, transport: Mail = null) {
+  constructor(configuration: Configuration, confluence: Confluence, transport: Mail = null, dryRun = false) {
     this._configuration = configuration
     this._confluence = confluence
     this._transport = transport || createTransport(this._configuration.transportOptions)
+
+    this._log = log.getLogger('Notification')
+    this._dryRun = dryRun
   }
 
   public async notify(documentInfo: DocumentInfo): Promise<void> {
+    Handlebars.registerHelper('moment', (text, format) => {
+      return moment(text).format(format)
+    })
     const subjectTemplate = Handlebars.compile(this._configuration.notificationSubjectTemplate)
     const bodyTemplate = Handlebars.compile(this._configuration.notificationBodyTemplate)
-    await this._transport.sendMail({
+
+    documentInfo.lastVersionDate = (documentInfo.lastVersionDate as Moment).toISOString() as string
+
+    for (const maintainer of this._configuration.maintainer) {
+      if (maintainer.pagePattern.test(documentInfo.title)) {
+        documentInfo.author = maintainer.maintainer
+      }
+    }
+
+    const mailOptions = {
       from: this._configuration.notificationFrom,
       to: `${documentInfo.author}@${this._configuration.domain}`,
       subject: subjectTemplate(documentInfo),
       html: bodyTemplate(documentInfo),
-    })
+    }
+    this._log.info(`Notifying ${mailOptions.to} about ${documentInfo.title}`)
+    this._log.trace(mailOptions)
+    if (!this._dryRun) {
+      await this._transport.sendMail(mailOptions)
+    }
   }
 }

lib/commands/Check.ts

@@ -0,0 +1,60 @@
+import { command, Command, metadata, option } from 'clime'
+import { Configuration } from '../api/Configuration'
+import { Confluence } from '../api/Confluence'
+import { Notification } from '../api/Notification'
+import { DefaultOptions } from '../DefaultOptions'
+
+export class CheckOptions extends DefaultOptions {
+  @option({
+    name: 'id',
+    flag: 'i',
+    description: 'ID of configuration document',
+    required: true,
+  })
+  configurationDocumentId: string
+
+  @option({
+    name: 'dryrun',
+    flag: 'd',
+    description: 'Do not send notifications',
+    toggle: true,
+  })
+  dryRun: boolean
+}
+
+@command({
+  description: 'Check confluence for outdated documents',
+})
+export default class extends Command {
+  @metadata
+  public async execute(options: CheckOptions): Promise<void> {
+    const log = options.getLogger()
+
+    log.info('Checking for outdated documents')
+
+    const configuration = new Configuration(
+      options.confluenceUrl,
+      options.confluenceUser,
+      options.confluencePassword,
+      options.configurationDocumentId
+    )
+    await configuration.load()
+
+    const confluence = new Confluence(options.confluenceUrl, options.confluenceUser, options.confluencePassword)
+
+    const notification = new Notification(configuration, confluence, null, options.dryRun)
+
+    for (const check of configuration.checks) {
+      log.debug(`Checking for documents older than ${check.maxAge} day(s) with label(s) ${check.labels.join(',')}`)
+      let filter = `label = ${check.labels.join('AND label = ')}`
+      if (configuration.space && configuration.space != '') {
+        filter = `${filter} AND space = ${configuration.space}`
+      }
+      const checkedDocuments = await confluence.findDocumentsOlderThan(filter, check.maxAge)
+
+      for (const checkedDocument of checkedDocuments) {
+        await notification.notify(checkedDocument)
+      }
+    }
+  }
+}