Use the end of a process to indicate that the results are ready to se…

…nd to the host process - fixes #400

package.json

@@ -103,6 +103,7 @@
     "lodash.includes": "^4.3.0",
     "lodash.isobject": "^2.4.1",
     "lodash.keys": "^4.0.8",
+    "node-cleanup": "^2.1.2",
     "node-fetch": "^1.6.3",
     "parse-diff": "^0.4.0",
     "parse-link-header": "^1.0.1",

scripts/run-fixtures.js

@@ -10,7 +10,7 @@ const chalk = require("chalk")
 const expect = require("expect")
 
 // Toggle this on to update the JSON files for each run
-const writeResults = false
+const writeResults = true
 
 const runnerFileJS = "distribution/commands/danger-runner.js"
 

source/ambient.d.ts

@@ -17,6 +17,7 @@ declare module "*/package.json"
 
 declare module "require-from-string"
 declare module "node-eval"
+declare module "node-cleanup"
 
 // declare module "require-from-string" {
 //   export interface RequireOptions {

source/commands/danger-runner.ts

@@ -1,13 +1,12 @@
-import setSharedArgs, { SharedCLI } from "./utils/sharedDangerfileArgs"
+import setSharedArgs from "./utils/sharedDangerfileArgs"
+import * as nodeCleanup from "node-cleanup"
 
 import * as program from "commander"
+import * as getSTDIN from "get-stdin"
 import * as chalk from "chalk"
 
 import { contextForDanger } from "../runner/Dangerfile"
 import inline from "../runner/runners/inline"
-import { Executor } from "../runner/Executor"
-import { getPlatformForEnv } from "../platforms/platform"
-import getRuntimeCISource from "./utils/getRuntimeCISource"
 import { dangerfilePath } from "./utils/file-utils"
 import { DangerDSLJSONType } from "../dsl/DangerDSL"
 import { jsonToDSL } from "../runner/jsonToDSL"
@@ -25,64 +24,36 @@ program
 
 setSharedArgs(program).parse(process.argv)
 
-const app = (program as any) as SharedCLI
+let foundDSL = false
+let runtimeEnv = {} as any
 
 const run = async (jsonString: string) => {
-  console.log(jsonString)
-
+  foundDSL = true
   const dslJSON = JSON.parse(jsonString) as { danger: DangerDSLJSONType }
   const dsl = await jsonToDSL(dslJSON.danger)
   const dangerFile = dangerfilePath(program)
 
   // Set up the runtime env
   const context = contextForDanger(dsl)
-  const runtimeEnv = await inline.createDangerfileRuntimeEnvironment(context)
-  const results = await inline.runDangerfileEnvironment(dangerFile, undefined, runtimeEnv)
-  console.log(results)
-
-  const config = {
-    stdoutOnly: app.textOnly,
-    jsonOnly: true,
-    verbose: app.verbose,
-  }
-
-  const source = await getRuntimeCISource(app)
-  const platform = getPlatformForEnv(process.env, source!)
-
-  const exec = new Executor(source!, platform, inline, config)
-  await exec.handleResults(results)
+  runtimeEnv = await inline.createDangerfileRuntimeEnvironment(context)
+  await inline.runDangerfileEnvironment(dangerFile, undefined, runtimeEnv)
 }
 
-// getSTDIN().then(run)
-
-const stdin = process.stdin
-
-stdin.setEncoding("utf8")
-
-let foundDSL = false
-
-stdin.on("readable", () => {
-  const data = stdin.read()
-  if (data) {
-    const trimmed = data.toString().trim()
-    console.log("> ", trimmed)
-    if (trimmed.startsWith("{") && trimmed.endsWith("}") && trimmed.includes("danger")) {
-      console.log(">>>")
-      console.log(trimmed)
-      console.log(">>>")
-      foundDSL = true
-      run(trimmed)
-    }
+// Wait till the end of the process to print out the results
+nodeCleanup(() => {
+  if (foundDSL) {
+    process.stdout.write(JSON.stringify(runtimeEnv.results, null, 2))
   }
 })
 
-stdin.on("end", () => {
-  console.log("stdend")
-})
-
+// Add a timeout so that CI doesn't run forever if something has broken.
 setTimeout(() => {
   if (!foundDSL) {
-    console.error(chalk.red("Timeout: Failed to get the Danger DSL after 10 seconds"))
+    console.error(chalk.red("Timeout: Failed to get the Danger DSL after 1 second"))
     process.exitCode = 1
+    process.exit(1)
   }
-}, 10000)
+}, 1000)
+
+// Start waiting on STDIN for the DSL
+getSTDIN().then(run)

source/dsl/DangerResults.ts

@@ -33,5 +33,5 @@ export interface DangerRuntimeContainer extends DangerResults {
   /**
    * Asynchronous functions to be run after parsing
    */
-  scheduled: any[]
+  scheduled?: any[]
 }

source/runner/Dangerfile.ts

@@ -84,7 +84,7 @@ export function contextForDanger(dsl: DangerDSLType): DangerContext {
     scheduled: [],
   }
 
-  const schedule = (fn: any) => results.scheduled.push(fn)
+  const schedule = (fn: any) => results.scheduled && 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 })

source/runner/Executor.ts

@@ -111,10 +111,10 @@ export class Executor {
     if (this.options.jsonOnly) {
       // Format for Danger Process
       const results = {
-        failures: fails,
-        warnings: warnings,
-        messages: messages,
-        markdowns: markdowns,
+        fails,
+        warnings,
+        messages,
+        markdowns,
       }
       process.stdout.write(JSON.stringify(results, null, 2))
     } else {

source/runner/_tests/fixtures/__DangerfileNoScheduledAsync.ts

@@ -0,0 +1,3 @@
+/*eslint-disable */
+
+setTimeout(() => warn("Totally Async"), 1000)

source/runner/_tests/fixtures/results/__DangerfileAsync.js.json

@@ -1,5 +1,5 @@
 {
-  "failures": [],
+  "fails": [],
   "warnings": [
     {
       "message": "Async Function"
@@ -9,5 +9,6 @@
     }
   ],
   "messages": [],
-  "markdowns": []
+  "markdowns": [],
+  "scheduled": [null]
 }

source/runner/_tests/fixtures/results/__DangerfileAsync.ts.json

@@ -1,5 +1,5 @@
 {
-  "failures": [],
+  "fails": [],
   "warnings": [
     {
       "message": "Async Function"
@@ -9,5 +9,6 @@
     }
   ],
   "messages": [],
-  "markdowns": []
+  "markdowns": [],
+  "scheduled": [null]
 }

source/runner/_tests/fixtures/results/__DangerfileCallback.js.json

@@ -1,10 +1,11 @@
 {
-  "failures": [],
+  "fails": [],
   "warnings": [
     {
       "message": "Scheduled a callback"
     }
   ],
   "messages": [],
-  "markdowns": []
+  "markdowns": [],
+  "scheduled": [null]
 }

source/runner/_tests/fixtures/results/__DangerfileEmpty.js.json

@@ -1,6 +1,7 @@
 {
-  "failures": [],
+  "fails": [],
   "warnings": [],
   "messages": [],
-  "markdowns": []
+  "markdowns": [],
+  "scheduled": []
 }

source/runner/_tests/fixtures/results/__DangerfileFullMessages.js.json

@@ -1,5 +1,5 @@
 {
-  "failures": [
+  "fails": [
     {
       "message": "this is a failure"
     }
@@ -14,5 +14,6 @@
       "message": "this is a message"
     }
   ],
-  "markdowns": ["this is a *markdown*"]
+  "markdowns": ["this is a *markdown*"],
+  "scheduled": []
 }

source/runner/_tests/fixtures/results/__DangerfileImportRelative.js.json

@@ -1,6 +1,7 @@
 {
-  "failures": [],
+  "fails": [],
   "warnings": [],
   "messages": [],
-  "markdowns": []
+  "markdowns": [],
+  "scheduled": []
 }

source/runner/_tests/fixtures/results/__DangerfileMultiScheduled.js.json

@@ -1,5 +1,5 @@
 {
-  "failures": [
+  "fails": [
     {
       "message": "Asynchronous Failure"
     }
@@ -14,5 +14,6 @@
       "message": "Asynchronous Message"
     }
   ],
-  "markdowns": ["Asynchronous Markdown"]
+  "markdowns": ["Asynchronous Markdown"],
+  "scheduled": [{}, {}, {}, {}]
 }

source/runner/_tests/fixtures/results/__DangerfileNoScheduledAsync.ts.json

@@ -0,0 +1,11 @@
+{
+  "fails": [],
+  "warnings": [
+    {
+      "message": "Totally Async"
+    }
+  ],
+  "messages": [],
+  "markdowns": [],
+  "scheduled": []
+}

source/runner/_tests/fixtures/results/__DangerfilePlugin.js.json

@@ -1,11 +1,12 @@
 {
-  "failures": [
+  "fails": [
     {
       "message":
         "@types dependencies were added to package.json, as a dependency for others.<br/><i>You need to move &#64;types/danger into \"devDependencies\"?</i>"
     }
   ],
   "warnings": [],
   "messages": [],
-  "markdowns": []
+  "markdowns": [],
+  "scheduled": []
 }

source/runner/_tests/fixtures/results/__DangerfileScheduled.js.json

@@ -1,10 +1,11 @@
 {
-  "failures": [],
+  "fails": [],
   "warnings": [
     {
       "message": "Asynchronous Warning"
     }
   ],
   "messages": [],
-  "markdowns": []
+  "markdowns": [],
+  "scheduled": [{}]
 }

source/runner/_tests/fixtures/results/__DangerfileTypeScript.ts.json

@@ -1,10 +1,11 @@
 {
-  "failures": [],
+  "fails": [],
   "warnings": [],
   "messages": [
     {
       "message": "Honey, we got Types"
     }
   ],
-  "markdowns": []
+  "markdowns": [],
+  "scheduled": []
 }

source/runner/runners/inline.ts

@@ -66,29 +66,11 @@ export async function runDangerfileEnvironment(
 
     _require(compiled, filename, {})
 
-    const results = environment.results
-    await Promise.all(
-      results.scheduled.map((fnOrPromise: any) => {
-        if (fnOrPromise instanceof Promise) {
-          return fnOrPromise
-        }
-        if (fnOrPromise.length === 1) {
-          // callback-based function
-          return new Promise(res => fnOrPromise(res))
-        }
-        return fnOrPromise()
-      })
-    )
-
-    return {
-      fails: results.fails,
-      warnings: results.warnings,
-      messages: results.messages,
-      markdowns: results.markdowns,
-    }
+    return environment.results
   } catch (error) {
     console.error("Unable to evaluate the Dangerfile")
-    return resultsForCaughtError(filename, content, error)
+    environment.results = resultsForCaughtError(filename, content, error)
+    return environment.results
   }
 }
 

yarn.lock

@@ -3622,6 +3622,10 @@ netrc@^0.1.4:
   version "0.1.4"
   resolved "https://registry.yarnpkg.com/netrc/-/netrc-0.1.4.tgz#6be94fcaca8d77ade0a9670dc460914c94472444"
 
+node-cleanup@^2.1.2:
+  version "2.1.2"
+  resolved "https://registry.yarnpkg.com/node-cleanup/-/node-cleanup-2.1.2.tgz#7ac19abd297e09a7f72a71545d951b517e4dde2c"
+
 node-fetch@^1.6.3:
   version "1.6.3"
   resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-1.6.3.tgz#dc234edd6489982d58e8f0db4f695029abcd8c04"