Fix error scenario handling. (#57)

- Clarify meaning of dispose on components with rename.
- Fix missing dispose/boardStopped call for data logging.

Author: microbit-matt-hillsdon

src/board/accelerometer.ts

@@ -75,5 +75,5 @@ export class Accelerometer {
     this.gestureCallback = gestureCallback;
   }
 
-  dispose() {}
+  boardStopped() {}
 }

src/board/audio/index.ts

@@ -138,7 +138,7 @@ export class Audio {
     }
   }
 
-  dispose() {
+  boardStopped() {
     if (this.context) {
       this.context.close();
       this.context = undefined;

src/board/buttons.ts

@@ -115,7 +115,7 @@ export class Button {
     return result;
   }
 
-  dispose() {
+  boardStopped() {
     this._presses = 0;
   }
 }

src/board/compass.ts

@@ -27,5 +27,5 @@ export class Compass {
     return Math.sqrt(x * x + y * y + z * z);
   }
 
-  dispose() {}
+  boardStopped() {}
 }

src/board/data-logging.test.ts

@@ -233,7 +233,7 @@ describe("DataLogging", () => {
 
   it("dispose resets timestamp if nothing written", () => {
     logging.setTimestamp(MICROBIT_HAL_LOG_TIMESTAMP_SECONDS);
-    logging.dispose();
+    logging.boardStopped();
     logging.initialize();
 
     logging.beginRow();
@@ -253,7 +253,7 @@ describe("DataLogging", () => {
     logging.logData("b", "");
     logging.endRow();
 
-    logging.dispose();
+    logging.boardStopped();
     logging.initialize();
 
     logging.beginRow();

src/board/data-logging.ts

@@ -133,7 +133,7 @@ export class DataLogging {
 
   initialize() {}
 
-  dispose() {
+  boardStopped() {
     // We don't delete the log here as it's on flash, but we do reset in-memory state.
     this.resetNonFlashStateExceptTimestamp();
     // Keep the timestamp if we could restore it from a persisted log.

src/board/display.ts

@@ -73,7 +73,7 @@ export class Display {
     }
   }
 
-  dispose() {
+  boardStopped() {
     this.clear();
   }
 }

src/board/index.ts

@@ -331,10 +331,11 @@ export class Board {
       module.forceStop();
     } catch (e: any) {
       if (e.name !== "ExitStatus") {
-        console.error(e);
-        throw new Error("Expected status message");
+        this.notifications.onInternalError(e);
       }
     }
+    // Called by the HAL for normal shutdown but not in error scenarios.
+    this.stopComponents();
     this.modulePromise = undefined;
 
     if (panicCode !== undefined) {
@@ -530,15 +531,16 @@ export class Board {
     this.serialInputBuffer.length = 0;
   }
 
-  dispose() {
-    this.audio.dispose();
-    this.buttons.forEach((b) => b.dispose());
-    this.pins.forEach((p) => p.dispose());
-    this.display.dispose();
-    this.accelerometer.dispose();
-    this.compass.dispose();
-    this.microphone.dispose();
-    this.radio.dispose();
+  stopComponents() {
+    this.audio.boardStopped();
+    this.buttons.forEach((b) => b.boardStopped());
+    this.pins.forEach((p) => p.boardStopped());
+    this.display.boardStopped();
+    this.accelerometer.boardStopped();
+    this.compass.boardStopped();
+    this.microphone.boardStopped();
+    this.radio.boardStopped();
+    this.dataLogging.boardStopped();
     this.serialInputBuffer.length = 0;
 
     // Nofify of the state resets.

src/board/microphone.ts

@@ -63,7 +63,7 @@ export class Microphone {
     this.soundLevelCallback = soundLevelCallback;
   }
 
-  dispose() {
+  boardStopped() {
     this.microphoneOff();
   }
 }

src/board/pins.ts

@@ -113,5 +113,5 @@ export class Pin {
     }
   }
 
-  dispose() {}
+  boardStopped() {}
 }

src/board/radio.test.ts

@@ -55,7 +55,7 @@ describe("Radio", () => {
   });
 
   it("disables the radio", () => {
-    radio.dispose();
+    radio.boardStopped();
     expect(radio.state).toEqual({
       type: "radio",
       enabled: false,

src/board/radio.ts

@@ -107,7 +107,7 @@ export class Radio {
     }
   }
 
-  dispose() {
+  boardStopped() {
     this.rxQueue = undefined;
     this.config = undefined;
     this.state = {

src/jshal.js

@@ -31,7 +31,7 @@ mergeInto(LibraryManager.library, {
   },
 
   mp_js_hal_deinit: function () {
-    Module.board.dispose();
+    Module.board.stopComponents();
   },
 
   mp_js_hal_ticks_ms: function () {