feat: Added exceptions feature

Author: dploeger

README.md

@@ -52,6 +52,11 @@ A table of maintainers for pages.
 - Maintainer: The users that should receive all notifications for pages matching this pattern (separated by ,). You can 
   use `_lastauthor` to reference the last author of the page) 
 
+### Panel "Exceptions"
+
+A list of regular expressions that are matched against all document paths. If a pattern matches, that document will be
+excluded from notifications.
+
 ### Panel "Notification Template"
 
 This panel includes two child panels which hold [Handlebars](https://handlebarsjs.com/guide/) templates for the

lib/api/Configuration.ts

@@ -57,7 +57,12 @@ export class Configuration {
   /**
    * A list of checks for outdated documents
    */
-  public checks: Array<Check>
+  public checks: Array<Check> = []
+
+  /**
+   * An array of regular expressions for document paths that should not be notified
+   */
+  public exceptions: Array<RegExp> = []
 
   /**
    * A list of page maintainers
@@ -89,7 +94,6 @@ export class Configuration {
     this.confluenceUser = confluenceUser
     this.confluencePassword = confluencePassword
     this.configurationDocumentId = configurationDocumentId
-    this.checks = []
     this._loaded = false
 
     this._log = log.getLogger('Configuration')
@@ -172,6 +176,10 @@ export class Configuration {
         }
       })
 
+      // Load exceptions
+
+      this.exceptions = this._getConfigurationFromPanel($, 'Exceptions').map<RegExp>((value) => new RegExp(value.regularexpression))
+
       this.notificationSubjectTemplate = $(
         'ac\\:parameter:contains("Notification Template") + ac\\:rich-text-body ac\\:parameter:contains("Subject") + ac\\:rich-text-body'
       ).text()

lib/api/Notification.ts

@@ -8,6 +8,7 @@ import { Logger } from 'loglevel'
 import { Moment } from 'moment'
 import log = require('loglevel')
 import moment = require('moment')
+import doc = Mocha.reporters.doc
 
 export class Notification {
   private _configuration: Configuration
@@ -26,6 +27,13 @@ export class Notification {
   }
 
   public async notify(documentInfo: DocumentInfo): Promise<void> {
+    for (const exception of this._configuration.exceptions) {
+      if (documentInfo.matchesPath(exception)) {
+        this._log.info(`Skipping ${documentInfo.title} because it matches the exception ${exception}`)
+        return
+      }
+    }
+
     Handlebars.registerHelper('moment', (text, format) => {
       return moment(text).format(format)
     })

resources/configurationDocument.html

@@ -67,6 +67,26 @@
         </table>
     </ac:rich-text-body>
 </ac:structured-macro>
+<ac:structured-macro ac:name="panel" ac:schema-version="1" ac:macro-id="1d192d60-7e69-4af8-8dd6-4006a7bfc952">
+    <ac:parameter ac:name="title">Exceptions</ac:parameter>
+    <ac:rich-text-body>
+        <i>This table holds a list of RegExp patterns. A document which path matches one of this pattern will be excluded from notifications.</i>
+        <table class="wrapped">
+            <colgroup>
+                <col/>
+                <col/>
+            </colgroup>
+            <tbody>
+            <tr>
+                <th>RegularException</th>
+            </tr>
+            <tr>
+                <td></td>
+            </tr>
+            </tbody>
+        </table>
+    </ac:rich-text-body>
+</ac:structured-macro>
 <ac:structured-macro ac:name="panel" ac:schema-version="1" ac:macro-id="93f1d981-c841-4cb4-b6e2-5940dfe69132">
     <ac:parameter ac:name="title">Notification Template</ac:parameter>
     <ac:rich-text-body>

test/ConfigurationTest.ts

@@ -21,6 +21,8 @@ describe('The Configuration API', (): void => {
 
     chai.expect(configuration.maintainer).to.have.lengthOf(1)
 
+    chai.expect(configuration.exceptions).to.have.lengthOf(1)
+
     chai.expect(configuration.notificationBodyTemplate).to.eq(MockServer.NOTIFICATION_BODY)
     chai.expect(configuration.notificationSubjectTemplate).to.eq(MockServer.NOTIFICATION_SUBJECT)
 

test/MockServer.ts

@@ -124,6 +124,24 @@ export class MockServer {
         </table>
     </ac:rich-text-body>
 </ac:structured-macro>
+<ac:structured-macro ac:name='panel' ac:schema-version='1' ac:macro-id='1d192d60-7e69-4af8-8dd6-4006a7bfc952'>
+    <ac:parameter ac:name='title'>Exceptions</ac:parameter>
+    <ac:rich-text-body>
+        <table class='wrapped'>
+            <colgroup>
+                <col/>
+            </colgroup>
+            <tbody>
+            <tr>
+                <th>RegularExpression</th>
+            </tr>
+            <tr>
+                <td>main/Test/NOT</td>
+            </tr>
+            </tbody>
+        </table>
+    </ac:rich-text-body>
+</ac:structured-macro>
 <ac:structured-macro ac:name='panel' ac:schema-version='1' ac:macro-id='93f1d981-c841-4cb4-b6e2-5940dfe69132'>
     <ac:parameter ac:name='title'>Notification Template</ac:parameter>
     <ac:rich-text-body>

test/NotificationTest.ts

@@ -64,4 +64,10 @@ describe('The Notification API', (): void => {
     await notification.notify(documentInfo)
     chai.expect((transportStub as unknown as SinonStubbedInstance<Mail>).sendMail.notCalled).to.be.true
   })
+  it('should not send notifications for an excluded document', async (): Promise<void> => {
+    const notification = new Notification(configuration, '', confluence, transportStub)
+    const documentInfo = new DocumentInfo(0, 'author2', moment(), 'message', 'NOT', ['main', 'Test'], 'http://example.com')
+    await notification.notify(documentInfo)
+    chai.expect((transportStub as unknown as SinonStubbedInstance<Mail>).sendMail.calledOnce).to.be.false
+  })
 })