also write the events data to a temp file

Author: mikrostew

crates/volta-core/src/event.rs

@@ -7,7 +7,7 @@ use serde::{Deserialize, Serialize};
 
 use crate::error::{ExitCode, VoltaError};
 use crate::hook::Publish;
-use crate::monitor::Monitor;
+use crate::monitor::send_events;
 use crate::session::ActivityKind;
 
 // the Event data that is serialized to JSON and sent the plugin
@@ -135,8 +135,7 @@ impl EventLog {
             // Note: This call to unimplemented is left in, as it's not a Fallible operation that can use ErrorKind::Unimplemented
             Some(&Publish::Url(_)) => unimplemented!(),
             Some(&Publish::Bin(ref command)) => {
-                let mut monitor = Monitor::new(command);
-                monitor.send_events(&self.events);
+                send_events(command, &self.events);
             }
             None => {}
         }

crates/volta-core/src/monitor.rs

@@ -1,50 +1,42 @@
 use std::io::Write;
+use std::path::PathBuf;
 use std::process::{Child, Stdio};
 
 use log::debug;
+use tempfile::NamedTempFile;
 
 use crate::command::create_command;
 use crate::event::Event;
 
-pub struct Monitor {
-    monitor_process: Option<Child>,
-}
-
-impl Monitor {
-    /// Returns the current monitor.
-    pub fn new(command: &str) -> Monitor {
-        Monitor {
-            monitor_process: spawn_process(command),
-        }
-    }
-
-    /// send event to the monitor process
-    // if hook command is not configured, this is a no-op
-    pub fn send_events(&mut self, events: &[Event]) {
-        if let Some(ref mut child_process) = self.monitor_process {
-            if let Some(ref mut p_stdin) = child_process.stdin.as_mut() {
-                let json = serde_json::to_string(&events);
-
-                match json {
-                    Ok(data) => {
-                        // FIXME: tighten up this error message
-                        writeln!(p_stdin, "{}", data).expect("Writing data to plugin failed!");
-                    }
-                    Err(error) => {
-                        // FIXME: tighten up this error message
-                        debug!("There was a problem serializing the JSON data: {:?}", error);
-                    }
-                };
-            }
+/// send event to the spawned command process
+// if hook command is not configured, this is not called
+pub fn send_events(command: &str, events: &[Event]) {
+    // TODO: make these expects into errors or whatever
+    let events_json =
+        serde_json::to_string_pretty(&events).expect("Problem serializing events JSON data");
+    let mut events_file = NamedTempFile::new().expect("Could not create temp file for events");
+    events_file
+        .write_all(events_json.as_bytes())
+        .expect("Writing data to file failed");
+    // don't automatically delete this temp file please
+    let path = events_file.into_temp_path();
+    let tempfile_path = path.keep().expect("Could not persist temp file");
+
+    // spawn a child process, with the path to that temp file as an env var
+    if let Some(ref mut child_process) = spawn_process(command, tempfile_path) {
+        if let Some(ref mut p_stdin) = child_process.stdin.as_mut() {
+            // still send the data over stdin
+            writeln!(p_stdin, "{}", events_json).expect("Writing data to plugin failed!");
         }
     }
 }
 
-fn spawn_process(command: &str) -> Option<Child> {
+fn spawn_process(command: &str, tempfile_path: PathBuf) -> Option<Child> {
     command.split(' ').take(1).next().and_then(|executable| {
         let mut child = create_command(executable);
         child.args(command.split(' ').skip(1));
         child.stdin(Stdio::piped());
+        child.env("EVENTS_FILE", tempfile_path);
 
         #[cfg(not(debug_assertions))]
         // Hide stdout and stderr of spawned process in release mode

tests/acceptance/hooks.rs

@@ -23,17 +23,17 @@ const PROJECT_PACKAGE_JSON: &str = r#"
     }
 }"#;
 
-// scripts that read stdin, and write it to file 'events.json'
+// scripts that write events to file 'events.json'
 cfg_if::cfg_if! {
     if #[cfg(windows)] {
+        // have not been able to read events from stdin with batch, powershell, etc.
+        // so just copy the tempfile (path in EVENTS_FILE env var) to events.json
         const EVENTS_EXECUTABLE: &str = r#"@echo off
-setlocal
-break >events.json
-for /F "tokens=*" %%line in ('more') do (
-    echo %%line >>events.json
-)"#;
+copy %%EVENTS_FILE%% events.json
+"#;
         const SCRIPT_FILENAME: &str = "write-events.bat";
     } else if #[cfg(unix)] {
+        // read events from stdin
         const EVENTS_EXECUTABLE: &str = r#"#!/bin/bash
 # read Volta events from stdin, and write to events.json
 # (but first clear it out)
@@ -144,7 +144,7 @@ fn redirects_download() {
             .with_stderr_contains("[..]/hook/default/node/1.2.3")
     );
 
-    thread::sleep(time::Duration::from_millis(5000));
+    thread::sleep(time::Duration::from_millis(500));
     assert_events(
         &s,
         vec![
@@ -174,7 +174,7 @@ fn merges_project_and_default_hooks() {
             .with_stderr_contains("[..]Could not download [email protected]")
             .with_stderr_contains("[..]/hook/project/yarn/3.2.1")
     );
-    thread::sleep(time::Duration::from_millis(5000));
+    thread::sleep(time::Duration::from_millis(500));
     assert_events(
         &s,
         vec![
@@ -193,7 +193,7 @@ fn merges_project_and_default_hooks() {
             .with_stderr_contains("[..]Could not download [email protected]")
             .with_stderr_contains("[..]/hook/default/node/10.12.1")
     );
-    thread::sleep(time::Duration::from_millis(5000));
+    thread::sleep(time::Duration::from_millis(500));
     assert_events(
         &s,
         vec![
@@ -230,7 +230,7 @@ fn merges_workspace_hooks() {
             .with_stderr_contains("[..]Could not download [email protected]")
             .with_stderr_contains("[..]/hook/project/yarn/3.1.4")
     );
-    thread::sleep(time::Duration::from_millis(5000));
+    thread::sleep(time::Duration::from_millis(500));
     assert_events(
         &s,
         vec![
@@ -249,7 +249,7 @@ fn merges_workspace_hooks() {
             .with_stderr_contains("[..]Could not download [email protected]")
             .with_stderr_contains("[..]/hook/workspace/npm/5.6.7")
     );
-    thread::sleep(time::Duration::from_millis(5000));
+    thread::sleep(time::Duration::from_millis(500));
     assert_events(
         &s,
         vec![

tests/acceptance/merged_platform.rs

@@ -53,25 +53,17 @@ const PLATFORM_WITH_YARN: &str = r#"{
     "yarn": "1.7.71"
 }"#;
 
-// scripts that read stdin, and write it to file 'events.json'
 cfg_if::cfg_if! {
     if #[cfg(windows)] {
+        // copy the tempfile (path in EVENTS_FILE env var) to events.json
         const EVENTS_EXECUTABLE: &str = r#"@echo off
-setlocal
-break >events.json
-for /F "tokens=*" %%line in ('more') do (
-    echo %%line >>events.json
-)"#;
+copy %%EVENTS_FILE%% events.json
+"#;
         const SCRIPT_FILENAME: &str = "write-events.bat";
     } else if #[cfg(unix)] {
+        // copy the tempfile (path in EVENTS_FILE env var) to events.json
         const EVENTS_EXECUTABLE: &str = r#"#!/bin/bash
-# read Volta events from stdin, and write to events.json
-# (but first clear it out)
-echo -n "" >events.json
-while read line
-do
-  echo "$line" >>events.json
-done
+cp "$EVENTS_FILE" events.json
 "#;
         const SCRIPT_FILENAME: &str = "write-events.sh";
     } else {
@@ -259,7 +251,7 @@ fn uses_project_yarn_if_available() {
             .with_stderr_contains("[..]Yarn: 1.12.99 from project configuration")
     );
 
-    thread::sleep(time::Duration::from_millis(5000));
+    thread::sleep(time::Duration::from_millis(500));
     assert_events(
         &s,
         vec![