initial implementation to handle async

source/dsl/DangerResults.ts

@@ -7,6 +7,11 @@ import { MarkdownString } from "../dsl/Aliases"
  * do not add functions, only data to this interface.
  */
 export interface DangerResults {
+  /**
+   * Asynchronous functions to be run after parsing
+   * @type {Function[]}
+   */
+  scheduled: Array<Function>
   /**
    * Failed messages
    * @type {Violation[]}

source/runner/Dangerfile.ts

@@ -3,6 +3,13 @@ import { DangerDSLType } from "../dsl/DangerDSL"
 import { MarkdownString } from "../dsl/Aliases"
 
 export interface DangerContext {
+  /**
+   * Contains asynchronous code to be run after the application has booted.
+   *
+   * @param {Function} asyncFunction the function to run asynchronously
+   */
+  schedule(asyncFunction: (p: Promise<any>) => void): void
+
   /**
    * Fails a build, outputting a specific reason for failing
    *
@@ -59,15 +66,21 @@ export function contextForDanger(dsl: DangerDSLType): DangerContext {
     fails: [],
     warnings: [],
     messages: [],
-    markdowns: []
+    markdowns: [],
+    scheduled: []
   }
 
+  const schedule = (fn: Function) => {
+    console.log("scheduling task", fn)
+    results.scheduled.push(fn)
+  }
   const fail = (message: MarkdownString) =>  results.fails.push({ message })
   const warn = (message: MarkdownString) => results.warnings.push({ message })
   const message = (message: MarkdownString) => results.messages.push({ message })
   const markdown = (message: MarkdownString) => results.markdowns.push(message)
 
   return {
+    schedule,
     fail,
     warn,
     message,

source/runner/Executor.ts

@@ -62,6 +62,9 @@ export class Executor {
    * @returns {void} It's a promise, so a void promise
    */
   async handleResults(results: DangerResults) {
+    // run the asynchronous code first
+    console.log("handling scheduled tasks", results.scheduled)
+    await Promise.all(results.scheduled)
     // Ensure process fails if there are fails
     if (results.fails.length) {
       process.exitCode = 1

source/runner/_tests/fixtures/ExampleDangerResults.ts

@@ -1,36 +1,49 @@
 import { DangerResults } from "../../../dsl/DangerResults"
 
 export const emptyResults: DangerResults = {
+  scheduled: [],
   fails: [],
   warnings: [],
   messages: [],
   markdowns: []
 }
 
 export const failsResultsWithoutMessages: DangerResults = {
+  scheduled: [],
   fails: [{}, {}],
   warnings: [],
   messages: [],
   markdowns: []
 }
 
 export const warnResults: DangerResults = {
+  scheduled: [],
   fails: [],
   warnings: [{ message: "Warning message" }],
   messages: [],
   markdowns: []
 }
 
 export const failsResults: DangerResults = {
+  scheduled: [],
   fails: [{ message: "Failing message" }],
   warnings: [],
   messages: [],
   markdowns: []
 }
 
 export const summaryResults: DangerResults = {
+  scheduled: [],
   fails: [{ message: "Failing message Failing message" }],
   warnings: [{ message: "Warning message Warning message" }],
   messages: [{ message: "message" }],
   markdowns: ["markdown"],
 }
+
+export const asyncResults: DangerResults = {
+  scheduled: [async () => 1],
+  fails: [],
+  warnings: [],
+  messages: [],
+  markdowns: [],
+}