Add logging for simulator actions (#1021)

Author: microbit-robert

src/device/simulator.ts

@@ -163,6 +163,9 @@ export class SimulatorDeviceConnection
       }
       case "request_flash": {
         this.emit(EVENT_REQUEST_FLASH);
+        this.logging.event({
+          type: "sim-user-start",
+        });
         break;
       }
       case "state_change": {
@@ -229,11 +232,21 @@ export class SimulatorDeviceConnection
 
   constructor(
     private logging: Logging,
-    private iframe: () => HTMLIFrameElement | null
+    private iframe: () => HTMLIFrameElement | null,
+    private sensorsLogged: Record<string, boolean> = {}
   ) {
     super();
   }
 
+  private logSensor(sensorId: string): void {
+    if (!this.sensorsLogged[sensorId]) {
+      this.logging.event({
+        type: `sim-user-${sensorId}`,
+      });
+      this.sensorsLogged[sensorId] = true;
+    }
+  }
+
   async initialize(): Promise<void> {
     window.addEventListener("message", this.messageListener);
     this.setStatus(ConnectionStatus.NOT_CONNECTED);
@@ -286,11 +299,13 @@ export class SimulatorDeviceConnection
   }
 
   radioSend(message: string) {
+    const kind = "radio_input";
     const data = new TextEncoder().encode(message);
     const prefixed = new Uint8Array(3 + data.length);
     prefixed.set([1, 0, 1]);
     prefixed.set(data, 3);
-    this.postMessage("radio_input", { data: prefixed });
+    this.postMessage(kind, { data: prefixed });
+    this.logSensor(kind);
   }
 
   setSimulatorValue = async (
@@ -314,6 +329,7 @@ export class SimulatorDeviceConnection
       id,
       value,
     });
+    this.logSensor(id);
   };
 
   stop = async (): Promise<void> => {
@@ -323,14 +339,23 @@ export class SimulatorDeviceConnection
   reset = async (): Promise<void> => {
     this.postMessage("reset", {});
     this.notifyResetComms();
+    this.logging.event({
+      type: "sim-user-reset",
+    });
   };
 
   mute = async (): Promise<void> => {
     this.postMessage("mute", {});
+    this.logging.event({
+      type: "sim-user-mute",
+    });
   };
 
   unmute = async (): Promise<void> => {
     this.postMessage("unmute", {});
+    this.logging.event({
+      type: "sim-user-unmute",
+    });
   };
 
   private setStatus(newStatus: ConnectionStatus) {

src/simulator/DataLoggingModule.tsx

@@ -22,6 +22,7 @@ import { ReactNode, useCallback, useMemo } from "react";
 import { RiDownload2Line, RiErrorWarningLine } from "react-icons/ri";
 import { FormattedMessage } from "react-intl";
 import { DataLog } from "../device/simulator";
+import { useLogging } from "../logging/logging-hooks";
 import { useDataLog } from "./data-logging-hooks";
 import { useAutoScrollToBottom } from "./scroll-hooks";
 
@@ -53,12 +54,16 @@ const DataLoggingModule = ({
     };
   }, [untruncatedDataLog]);
   const [ref, handleScroll] = useAutoScrollToBottom(truncatedDataLog);
+  const logging = useLogging();
   const handleSaveLog = useCallback(() => {
     const blob = new Blob([toCsv(untruncatedDataLog)], {
       type: "text/csv;charset=utf-8",
     });
     saveAs(blob, "simulated-log-data.csv");
-  }, [untruncatedDataLog]);
+    logging.event({
+      type: "sim-user-data-log-saved",
+    });
+  }, [logging, untruncatedDataLog]);
   if (minimised) {
     return (
       <HStack spacing={3}>

src/simulator/SimulatorActionBar.tsx

@@ -19,6 +19,7 @@ import {
 } from "../device/device-hooks";
 import { EVENT_REQUEST_FLASH } from "../device/simulator";
 import { useFileSystem } from "../fs/fs-hooks";
+import { useLogging } from "../logging/logging-hooks";
 import { RunningStatus } from "./Simulator";
 
 interface SimulatorActionBarProps extends BoxProps {
@@ -34,6 +35,7 @@ const SimulatorActionBar = ({
   const device = useSimulator();
   const fs = useFileSystem();
   const intl = useIntl();
+  const logging = useLogging();
   const [isMuted, setIsMuted] = useState<boolean>(false);
   const syncStatus = useSyncStatus();
   const handlePlay = useCallback(async () => {
@@ -43,13 +45,21 @@ const SimulatorActionBar = ({
     });
     onRunningChange(RunningStatus.RUNNING);
   }, [device, fs, onRunningChange]);
-  const handleStop = useCallback(() => {
-    device.stop();
-    onRunningChange(RunningStatus.STOPPED);
-  }, [device, onRunningChange]);
+  const handleStop = useCallback(
+    (source: "user" | "code") => {
+      device.stop();
+      onRunningChange(RunningStatus.STOPPED);
+      if (source === "user") {
+        logging.event({
+          type: "sim-user-stopped",
+        });
+      }
+    },
+    [device, logging, onRunningChange]
+  );
   useEffect(() => {
     if (syncStatus === SyncStatus.OUT_OF_SYNC) {
-      handleStop();
+      handleStop("code");
     }
   }, [handleStop, syncStatus]);
   const handleMuteUnmute = useCallback(() => {
@@ -72,7 +82,7 @@ const SimulatorActionBar = ({
       <IconButton
         size={size}
         variant="outline"
-        onClick={handleStop}
+        onClick={() => handleStop("user")}
         icon={<RiStopFill />}
         aria-label={intl.formatMessage({ id: "simulator-stop" })}
         disabled={running === RunningStatus.STOPPED}