dashcam 0.4.3 → 0.5.0

package/README.md

@@ -55,6 +55,14 @@ Anything you type in your terminal will appear in your dash. To exit, simply typ
 exit
 ```
 
+## Pipe command output into dashcam for recording
+
+To record the output of a command in the Dashcam app (In this example the `ping 1.1.1.1` command ), use the following command
+
+```
+ping 1.1.1.1 | dashcam pipe
+```
+
 ### Create a Replay
 
 ```sh

package/index.js

@@ -6,7 +6,6 @@ const lib = require("./lib");
 const Recorder = require("./recorder");
 const packageMetadata = require("./package.json");
 
-
 if (module.parent) {
   module.exports = lib;
   return;
@@ -37,6 +36,10 @@ program
     "Markdown body. This may also be piped in: `cat README.md | dashcam create`"
   )
   .option("--md", "Returns code for a rich markdown image link.")
+  .option(
+    "-p, --publish",
+    "Whether to publish the clip instantly after creation or not."
+  )
   .action(async function (str, options) {
     try {
       let description = this.opts().description;
@@ -49,6 +52,7 @@ program
         description,
         private: this.opts().private,
         md: this.opts().md,
+        publish: this.opts().publish,
         png: this.opts().png,
       });
       console.log(result);
@@ -60,10 +64,11 @@ program
 
 program
   .command("record")
+  .option("-s, --silent", "Use silent mode when recording")
   .description(
     "Start a recording terminal to be included in your dashcam video recording"
   )
-  .action(async function (str, options) {
+  .action(async function ({ silent }) {
     try {
       const dashcam = new lib.PersistantDashcamIPC();
       const id = crypto.randomUUID();
@@ -71,14 +76,51 @@ program
 
       dashcam.onConnected = () => dashcam.emit("track-cli", logFile);
       fs.appendFileSync(logFile, "");
-      const recorder = new Recorder(logFile);
+      const recorder = new Recorder(logFile, silent);
       await recorder.start();
     } catch (e) {
       console.log("Error: ", e);
     }
   });
 
-if (process.stdin.isTTY) {
+program
+  .command("pipe")
+  .description(
+    "Pipe command output to dashcam to be included in recorded video"
+  )
+  .action(async function () {
+    try {
+      const dashcam = new lib.PersistantDashcamIPC();
+      const id = crypto.randomUUID();
+      const logFile = lib.getLogFilePath(id);
+
+      dashcam.onConnected = () => dashcam.emit("track-cli", logFile);
+      fs.appendFileSync(logFile, "");
+      process.stdin.on("data", (data) => {
+        process.stdout.write(data);
+        fs.appendFileSync(logFile, data);
+      });
+      process.stdin.on("close", () => process.exit());
+      process.stdin.on("error", () => process.exit(1));
+    } catch (e) {
+      console.log("Error: ", e);
+    }
+  });
+
+program
+  .command("start")
+  .description("Start instant replay recording on dashcam")
+  .action(async function (name, options) {
+    try {
+      await lib.startInstantReplay();
+      process.exit(0);
+    } catch (e) {
+      console.log("startInstantReplay error: ", e);
+      process.exit(1);
+    }
+  });
+
+if (process.stdin.isTTY || process.argv[2] === "pipe") {
   program.parse(process.argv);
 } else {
   process.stdin.on("error", function () {});

package/lib.js

@@ -36,6 +36,7 @@ const connectToIpc = function () {
 
 const createReplay = async function (options = {}) {
   options.md = options.md || false;
+  options.publish = options.publish || false;
 
   options.title = options.title || false;
   options.description = options.description || null;
@@ -46,7 +47,7 @@ const createReplay = async function (options = {}) {
     ipc.of.dashcam.on(
       "upload", //any event or message type your server listens for
       function (data) {
-        if (options.md) {
+        if (options.md && !options.publish) {
           resolve(data.replay.markdown);
         } else {
           resolve(data.replay.shareLink);
@@ -60,9 +61,33 @@ const createReplay = async function (options = {}) {
       );
     }, 60000 * 5);
 
-    ipc.of.dashcam.emit("create", {
+    const replay = {
       title: options.title,
       description: options.description,
+      publish: options.publish,
+    };
+
+    ipc.of.dashcam.emit("create", replay);
+
+    if (!options.publish) {
+      resolve(replay);
+    }
+  });
+};
+
+const startInstantReplay = async function (options = {}) {
+  return new Promise(async (resolve, reject) => {
+    await connectToIpc();
+    setTimeout(() => {
+      reject(
+        "Dashcam Desktop App did not respond in time. Cancel startInstantReplay"
+      );
+    }, 60000 * 5);
+
+    ipc.of.dashcam.emit("start-instant-replay");
+
+    resolve({
+      started: true,
     });
   });
 };
@@ -92,7 +117,10 @@ class PersistantDashcamIPC {
   }
 
   emit(event, payload) {
-    if (!this.#isConnected) return;
+    if (!this.#isConnected) {
+      console.log(`Cannot emit event: ${event}. Disconnected!`);
+      return;
+    }
     persistantIPC.of.dashcam.emit(event, payload);
   }
 }
@@ -103,6 +131,7 @@ const getLogFilePath = (id) => {
 
 module.exports = {
   createReplay,
+  startInstantReplay,
   getLogFilePath,
   PersistantDashcamIPC,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dashcam",
-  "version": "0.4.3",
+  "version": "0.5.0",
   "description": "Fix bugs, close pulls, and update your team with desktop instant replay.",
   "main": "index.js",
   "scripts": {

package/recorder.js

@@ -6,12 +6,15 @@ const find = require("find-process");
 class Recorder {
   #ptyProcess = null;
   #logFile = null;
+  #silent = false;
 
-  constructor(logFile) {
+  constructor(logFile, silent) {
     // This way we don't run the recording script recursively, especially
     // if it's inside bash/zsh configs
+    this.#silent = silent;
     if (process.env.DASHCAM_TERMINAL_RECORDING) {
-      console.log("The current terminal is already being recorded");
+      if (!this.#silent)
+        console.log("The current terminal is already being recorded");
       process.exit(0);
     }
     this.#logFile = logFile;
@@ -27,8 +30,10 @@ class Recorder {
   }
 
   async start() {
-    console.log("This session is being recorded by Dashcam");
-    console.log("Type `exit` to stop recording");
+    if (!this.#silent) {
+      console.log("This session is being recorded by Dashcam");
+      console.log("Type `exit` to stop recording");
+    }
 
     // TODO: Find a way to consistently get the current shell this is running from
     // instead of using the default user shell (Maybe use parent processId to find