npm - dashcam - Versions diffs - 0.8.4 → 1.0.1-beta.10 - Mend

dashcam 0.8.4 → 1.0.1-beta.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (55) hide show

package/.dashcam/cli-config.json +3 -0
package/.dashcam/recording.log +135 -0
package/.dashcam/web-config.json +11 -0
package/.github/RELEASE.md +59 -0
package/.github/workflows/publish.yml +43 -0
package/BACKWARD_COMPATIBILITY.md +177 -0
package/LOG_TRACKING_GUIDE.md +225 -0
package/README.md +709 -155
package/bin/dashcam-background.js +177 -0
package/bin/dashcam.cjs +8 -0
package/bin/dashcam.js +696 -0
package/bin/index.js +63 -0
package/examples/execute-script.js +152 -0
package/examples/simple-test.js +37 -0
package/lib/applicationTracker.js +311 -0
package/lib/auth.js +222 -0
package/lib/binaries.js +21 -0
package/lib/config.js +34 -0
package/lib/extension-logs/helpers.js +182 -0
package/lib/extension-logs/index.js +347 -0
package/lib/extension-logs/manager.js +344 -0
package/lib/ffmpeg.js +155 -0
package/lib/logTracker.js +23 -0
package/lib/logger.js +118 -0
package/lib/logs/index.js +488 -0
package/lib/permissions.js +85 -0
package/lib/processManager.js +317 -0
package/lib/recorder.js +690 -0
package/lib/store.js +58 -0
package/lib/tracking/FileTracker.js +105 -0
package/lib/tracking/FileTrackerManager.js +62 -0
package/lib/tracking/LogsTracker.js +161 -0
package/lib/tracking/active-win.js +212 -0
package/lib/tracking/icons/darwin.js +39 -0
package/lib/tracking/icons/index.js +167 -0
package/lib/tracking/icons/windows.js +27 -0
package/lib/tracking/idle.js +82 -0
package/lib/tracking.js +23 -0
package/lib/uploader.js +456 -0
package/lib/utilities/jsonl.js +77 -0
package/lib/webLogsDaemon.js +234 -0
package/lib/websocket/server.js +223 -0
package/package.json +53 -21
package/recording.log +814 -0
package/sea-bundle.mjs +34595 -0
package/test-page.html +15 -0
package/test.log +1 -0
package/test_run.log +48 -0
package/test_workflow.sh +154 -0
package/examples/crash-test.js +0 -11
package/examples/github-issue.sh +0 -1
package/examples/protocol.html +0 -22
package/index.js +0 -158
package/lib.js +0 -199
package/recorder.js +0 -85

package/test-page.html ADDED Viewed

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Test Page for Extension</title>
+</head>
+<body>
+    <h1>Simple Test Page</h1>
+    <p>This is a test page for the Chrome extension script execution.</p>
+    <p id="result">Waiting for script execution...</p>
+    <script>
+        console.log('Test page loaded, title:', document.title);
+    </script>
+</body>
+</html>

package/test.log ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"message": "test log entry", "level": "info", "timestamp": 1761692597000}

package/test_run.log ADDED Viewed

@@ -0,0 +1,48 @@
+🎬 Starting Dashcam CLI Test Workflow
+======================================
+1. Authenticating with API key...
+18:22:40.554 [[32minfo[39m] Authenticating with API key
+18:22:40.827 [[32minfo[39m] Successfully authenticated and stored token
+Successfully authenticated with API key
+✅ Authentication complete
+2. Setting up web tracking for testdriver.ai...
+18:22:40.997 [[32minfo[39m] Started tracking logs for /tmp/test-cli-log.txt
+18:22:41.022 [[32minfo[39m] Web logs daemon not running, starting it...
+18:22:41.022 [[32minfo[39m] Added web tracker: testdriver-tracking
+Added web tracker "testdriver-tracking" with patterns: [ '*testdriver.ai*' ]
+✅ Web tracking configured
+3. Setting up file tracking...
+Using existing test file: /tmp/test-cli-log.txt
+✅ File tracking configured
+4. Starting background logging process...
+✅ Background logger started (PID: 7033)
+5. Starting dashcam recording in background...
+18:22:41.164 [[32minfo[39m] Verbose logging enabled
+Recording already in progress
+Duration: 33.7 seconds
+PID: 6007
+Use "dashcam stop" to stop the recording
+✅ Recording started in background
+6. Letting recording run for 2 minutes...
+✅ Recording completed
+7. Stopping recording and uploading...
+No active recording to stop
+✅ Recording stopped and uploaded
+🧹 Cleaning up...
+✅ Background logger stopped
+🎉 Test workflow completed successfully!
+======================================
+📊 Final Status:
+No active recording
+./test_workflow.sh: line 79:  7033 Terminated: 15          ( while true; do
+    echo "$(date): Current time logged" >> "$TEMP_FILE"; sleep 2;
+done )

package/test_workflow.sh ADDED Viewed

@@ -0,0 +1,154 @@
+#!/bin/bash
+# Test workflow script for dashcam CLI
+set -e
+echo "🎬 Starting Dashcam CLI Test Workflow"
+echo "======================================"
+# 1. Authenticate with API key
+echo "1. Authenticating with API key..."
+./bin/dashcam.js auth $TD_API_KEY
+echo "✅ Authentication complete"
+# 2. Track web for testdriver.ai
+echo ""
+echo "2. Setting up web tracking for testdriver.ai..."
+./bin/dashcam.js logs --add --name=testdriver-tracking --type=web --pattern="*testdriver.ai*"
+echo "✅ Web tracking configured"
+# 3. Create temporary file and set up file tracking
+echo ""
+echo "3. Setting up file tracking..."
+TEMP_FILE="/tmp/test-cli-log.txt"
+echo "Using existing test file: $TEMP_FILE"
+# File is already tracked from previous tests, check if it exists
+if [ ! -f "$TEMP_FILE" ]; then
+  touch "$TEMP_FILE"
+  ./bin/dashcam.js logs --add --name=temp-file-tracking --type=file --file="$TEMP_FILE"
+fi
+echo "✅ File tracking configured"
+# 4. Start dashcam recording in background
+echo ""
+echo "4. Starting dashcam recording in background..."
+# Start recording and redirect output to a log file so we can still monitor it
+./bin/dashcam.js record --title "Sync Test Recording" --description "Testing video/log synchronization with timestamped events" > /tmp/dashcam-recording.log 2>&1 &
+RECORD_PID=$!
+# Wait for recording to initialize and log tracker to start
+echo "Waiting for recording to initialize (PID: $RECORD_PID)..."
+sleep 1
+# Write first event after log tracker is fully ready
+RECORDING_START=$(date +%s)
+echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+echo "🔴 EVENT 1: Recording START at $(date '+%H:%M:%S')"
+echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+echo "[EVENT 1] Recording started at $(date '+%H:%M:%S') - TIMESTAMP: $RECORDING_START" >> "$TEMP_FILE"
+# Verify recording is actually running
+if ps -p $RECORD_PID > /dev/null; then
+  echo "✅ Recording started successfully"
+else
+  echo "❌ Recording process died, check /tmp/dashcam-recording.log"
+  exit 1
+fi
+# 5. Create synchronized log events with visual markers
+echo ""
+echo "5. Creating synchronized test events..."
+echo ""
+echo "╔════════════════════════════════════════════════════════════════╗"
+echo "║  SYNC TEST - Watch for these markers in the recording!        ║"
+echo "╚════════════════════════════════════════════════════════════════╝"
+echo ""
+# Event 1 was already written above - now continue with the rest
+sleep 3
+# Event 2 - after 3 seconds
+echo ""
+echo "🟡 EVENT 2: 3 seconds mark at $(date '+%H:%M:%S')"
+echo "[EVENT 2] 3 seconds elapsed at $(date '+%H:%M:%S')" >> "$TEMP_FILE"
+sleep 3
+# Event 3 - after 6 seconds
+echo ""
+echo "🟢 EVENT 3: 6 seconds mark at $(date '+%H:%M:%S')"
+echo "[EVENT 3] 6 seconds elapsed at $(date '+%H:%M:%S')" >> "$TEMP_FILE"
+sleep 3
+# Event 4 - after 9 seconds
+echo ""
+echo "🔵 EVENT 4: 9 seconds mark at $(date '+%H:%M:%S')"
+echo "[EVENT 4] 9 seconds elapsed at $(date '+%H:%M:%S')" >> "$TEMP_FILE"
+sleep 3
+# Event 5 - after 12 seconds
+echo ""
+echo "🟣 EVENT 5: 12 seconds mark at $(date '+%H:%M:%S')"
+echo "[EVENT 5] 12 seconds elapsed at $(date '+%H:%M:%S')" >> "$TEMP_FILE"
+sleep 3
+# Event 6 - before ending
+echo ""
+echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+echo "⚫ EVENT 6: Recording END at $(date '+%H:%M:%S')"
+echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
+RECORDING_END=$(date +%s)
+echo "[EVENT 6] Recording ending at $(date '+%H:%M:%S') - TIMESTAMP: $RECORDING_END" >> "$TEMP_FILE"
+DURATION=$((RECORDING_END - RECORDING_START))
+echo ""
+echo "✅ Test events completed (Duration: ${DURATION}s)"
+# Give a moment for the last event to be fully processed
+echo ""
+echo "Waiting 2 seconds to ensure all events are captured..."
+sleep 2
+# 6. Stop recording and upload (this will kill the background recording process)
+echo ""
+echo "6. Stopping recording and uploading..."
+./bin/dashcam.js stop
+echo "✅ Recording stopped and uploaded"
+echo ""
+echo "🧹 Cleaning up..."
+echo ""
+echo "🎉 Test workflow completed successfully!"
+echo "======================================"
+# Show final status
+echo ""
+echo "📊 Final Status:"
+./bin/dashcam.js status
+echo ""
+echo "╔════════════════════════════════════════════════════════════════╗"
+echo "║                  SYNC VERIFICATION GUIDE                       ║"
+echo "╚════════════════════════════════════════════════════════════════╝"
+echo ""
+echo "To verify video/log synchronization in the recording:"
+echo ""
+echo "1. Open the uploaded recording in your browser"
+echo "2. Check the log panel for '$TEMP_FILE'"
+echo "3. Verify these events appear at the correct times:"
+echo ""
+echo "   Time   | Terminal Display          | Log Entry"
+echo "   -------|---------------------------|---------------------------"
+echo "   0:00   | 🔴 EVENT 1               | [EVENT 1] Recording started"
+echo "   0:03   | 🟡 EVENT 2               | [EVENT 2] 3 seconds elapsed"
+echo "   0:06   | 🟢 EVENT 3               | [EVENT 3] 6 seconds elapsed"
+echo "   0:09   | 🔵 EVENT 4               | [EVENT 4] 9 seconds elapsed"
+echo "   0:12   | 🟣 EVENT 5               | [EVENT 5] 12 seconds elapsed"
+echo "   0:15   | ⚫ EVENT 6               | [EVENT 6] Recording ending"
+echo ""
+echo "4. The log timestamps should match the video timeline exactly"
+echo "5. Each colored event marker should appear in the video"
+echo "   at the same moment as the corresponding log entry"
+echo ""

package/examples/crash-test.js DELETED Viewed

@@ -1,11 +0,0 @@
-const replayable = require("../index");
-process.on("uncaughtException", async (err) => {
-  console.error(err);
-  let replay = await replayable.createReplay({ description: err.stack });
-  console.log("Replayable", replay);
-});
-setTimeout(() => {
-  throw new Error("Throw makes it go boom!");
-}, 3000);

package/examples/github-issue.sh DELETED Viewed

	@@ -1 +0,0 @@
1	- gh issue create -w -t "Title" -b "`replayable --md`"

package/examples/protocol.html DELETED Viewed

@@ -1,22 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="utf-8">
-  <title></title>
-</head>
-<body>
-  <a href="replayable://replay/create" target="_blank">Create Replay</a>
-  <a href="#" onClick="causeError()">Throw an Error</a>
-  <script>
-    window.onerror = function myErrorHandler(errorMsg, url, lineNumber) {
-      console.log('onError', errorMsg)
-      window.location= "replayable://replay/create";
-    }
-    causeError = () => {
-      throw new Error("Throw makes it go boom!");
-    }
-  </script>
-</body>
-</html>

package/index.js DELETED Viewed

@@ -1,158 +0,0 @@
-#!/usr/bin/env node
-const fs = require("fs");
-const crypto = require("crypto");
-const lib = require("./lib");
-const Recorder = require("./recorder");
-const packageMetadata = require("./package.json");
-if (module.parent) {
-  module.exports = lib;
-  return;
-}
-const { program } = require("commander");
-program
-  .name("dashcam")
-  .description("Capture the steps to reproduce every bug.")
-  .version(packageMetadata.version);
-program.showHelpAfterError();
-program
-  .command("auth")
-  .argument("<api-key>", "The team's ApiKey")
-  .description("Authenticate the dashcam desktop using a team's apiKey")
-  .action(async function (apiKey) {
-    await lib
-      .sendApiKey(apiKey)
-      .then(() => process.exit())
-      .catch(() => process.exit(1));
-  });
-program
-  .command("create", { isDefault: true })
-  .description(
-    "Create a clip and output the resulting url or markdown. Will launch desktop app for local editing before publishing."
-  )
-  .option(
-    "-t, --title <string>",
-    "Title of the clip. Automatically generated if not supplied."
-  )
-  .option(
-    "-d, --description [text]",
-    "Markdown body."
-  )
-  .option("--md", "Returns code for a rich markdown image link.")
-  .option("-r --replay", "Create a replay not capture.")
-  .option(
-    "-p, --publish",
-    "Whether to publish the clip instantly after creation or not."
-  )
-  .option(
-    "-k, --project [string]",
-    "The project id to which to publish the replay"
-  )
-  .action(async function (str, options) {
-    try {
-      let description = this.opts().description;
-      let result = await lib.createClip({
-        title: this.opts().title,
-        description,
-        md: this.opts().md,
-        publish: this.opts().publish,
-        capture: !this.opts().replay,
-        png: this.opts().png,
-        project: this.opts().project,
-      });
-      console.log(result);
-    } catch (e) {
-      console.log("Error: ", e);
-    }
-    process.exit(0);
-  });
-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 ({ silent }) {
-    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, "");
-      const recorder = new Recorder(logFile, silent);
-      await recorder.start();
-    } catch (e) {
-      console.log("Error: ", e);
-    }
-  });
-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("track")
-  .requiredOption("--name <name>", "The name for the log config.")
-  .requiredOption(
-    "--type <type>",
-    'The type of log config ("web" or "application").'
-  )
-  .requiredOption(
-    "--pattern <patterns...>",
-    'The patterns of the urls in the case of "web" or the file paths in the case of "application" (Can contain wildcards \'*\'), multiple patterns can be provided.'
-  )
-  .description("Add a logs config to Dashcam")
-  .action(async function ({ name, type, pattern: patterns }) {
-    if (!["web", "application"].includes(type)) {
-      console.log('The "type" options needs to be "web" or "application"');
-    } else {
-      await lib.addLogsConfig({ name, type, patterns });
-    }
-    process.exit(0);
-  });
-program
-  .command("start")
-  .description("Start capture on dashcam")
-  .option("-r, --replay", "Start replay, not capture.")
-  .action(async function (name, options) {
-    try {
-      const isCapture = !this.opts().replay;
-      await lib.startRecording(isCapture);
-      process.exit(0);
-    } catch (e) {
-      console.log("startRecording error: ", e);
-      process.exit(1);
-    }
-  });
-program.parse(process.argv);

package/lib.js DELETED Viewed

@@ -1,199 +0,0 @@
-const os = require("os");
-const path = require("path");
-const clc = require("cli-color");
-const ipc = require("node-ipc").default;
-ipc.config.id = "dashcam-cli";
-ipc.config.retry = 1500;
-ipc.config.silent = true;
-ipc.config.maxRetries = 0;
-const persistantIPC = new ipc.IPC();
-persistantIPC.config.retry = 500;
-persistantIPC.config.silent = true;
-const connectToIpc = function (timeout) {
-  return new Promise((resolve, reject) => {
-    let timeoutToClean;
-    ipc.connectTo("dashcam");
-    ipc.of.dashcam.on("connect", () => {
-      // console.log(
-      //   clc.green("Connected to Dashcam!")
-      // );
-      resolve();
-      if (timeoutToClean) clearTimeout(timeoutToClean);
-    });
-    ipc.of.dashcam.on("error", (e) => {
-      if (e.code === "ENOENT") {
-        console.log(
-          clc.red("Could not connect to Dashcam Desktop App. Is it running?")
-        );
-        console.log(
-          clc.yellow(
-            "You may need to download and install the app from https://bit.ly/3ipoQLJ"
-          )
-        );
-        reject();
-      } else {
-        console.log(e);
-      }
-    });
-    ipc.of.dashcam.on("disconnect", function () {
-      console.log(clc.red("Disconnected from Dashcam"));
-      reject();
-    });
-    if (timeout && typeof timeout === "number") {
-      timeoutToClean = setTimeout(() => {
-        console.log(
-          clc.red("Could not connect to Dashcam Desktop App. Is it running?")
-        );
-        console.log(
-          clc.yellow(
-            "You may need to download and install the app from https://bit.ly/3ipoQLJ"
-          )
-        );
-        reject();
-      }, timeout);
-    }
-  });
-};
-const createClip = async function (options = {}) {
-  options.md = options.md || false;
-  options.publish = options.publish || false;
-  options.title = options.title || false;
-  options.description = options.description || null;
-  await connectToIpc();
-  return new Promise(async (resolve, reject) => {
-    ipc.of.dashcam.on(
-      "upload", //any event or message type your server listens for
-      function (data) {
-        if (options.md) {
-          resolve(data.replay.gifMarkdown);
-        } else {
-          resolve(data.replay.shareLink);
-        }
-      }
-    );
-    ipc.of.dashcam.on("error", (e) => {
-      console.log(e);
-    });
-    ipc.of.dashcam.on("replay-failed", (errorMessage) => {
-      reject(errorMessage);
-    });
-    setTimeout(() => {
-      reject(
-        "Dashcam Desktop App did not respond in time. Did you publish a clip?"
-      );
-    }, 60000 * 10);
-    const replay = {
-      title: options.title,
-      description: options.description,
-      publish: options.publish,
-      project: options.project,
-      capture: options.capture,
-    };
-    ipc.of.dashcam.emit("create", replay);
-    if (!options.publish) {
-      resolve(replay);
-    }
-  });
-};
-const startRecording = async function (isCapture = false) {
-  return new Promise(async (resolve, reject) => {
-    await connectToIpc();
-    setTimeout(() => {
-      reject(
-        "Dashcam Desktop App did not respond in time. Cancel startRecording"
-      );
-    }, 60000 * 5);
-    ipc.of.dashcam.emit("start-instant-replay", isCapture);
-    resolve({
-      started: true,
-    });
-  });
-};
-const sendApiKey = async function (apiKey) {
-  return new Promise(async (resolve, reject) => {
-    await connectToIpc(5000).catch(reject);
-    ipc.of.dashcam.emit("auth", { apiKey });
-    ipc.of.dashcam.on("auth-state", ({ success, user }) => {
-      if (success) {
-        console.log(clc.green(`Connected as: ${user?.sub}!`));
-        return resolve();
-      }
-      console.log(clc.red("Could not authenticate using the ApiKey"));
-      reject();
-    });
-    setTimeout(() => {
-      console.log(clc.red("Could not authenticate using the ApiKey"));
-      reject();
-    }, 10000);
-  });
-};
-let singleInstance = null;
-class PersistantDashcamIPC {
-  #isConnected = false;
-  onConnected = null;
-  constructor() {
-    if (singleInstance) return singleInstance;
-    singleInstance = this;
-    persistantIPC.connectTo("dashcam");
-    persistantIPC.of.dashcam.on("connect", () => {
-      this.#isConnected = true;
-      if (this.onConnected && typeof this.onConnected === "function")
-        this.onConnected();
-    });
-    persistantIPC.of.dashcam.on("disconnect", () => {
-      // console.log('disconnected')
-      this.#isConnected = false;
-    });
-    persistantIPC.of.dashcam.on("error", (e) => {
-      // console.log(e)
-      this.#isConnected = false;
-    });
-  }
-  emit(event, payload) {
-    if (!this.#isConnected) {
-      console.log(`Cannot emit event: ${event}. Disconnected!`);
-      return;
-    }
-    persistantIPC.of.dashcam.emit(event, payload);
-  }
-}
-const getLogFilePath = (id) => {
-  return path.join(os.tmpdir(), `dashcam_cli_recording_${id}.log`);
-};
-const addLogsConfig = async (options) => {
-  await connectToIpc();
-  ipc.of.dashcam.emit("add-logs-config", options);
-};
-module.exports = {
-  sendApiKey,
-  createClip,
-  addLogsConfig,
-  getLogFilePath,
-  startRecording,
-  PersistantDashcamIPC,
-};