Honor calls to track.stop() during an ongoing restart attempt (#1131)

* Honor calls to track.stop() during an ongoing restart attempt

* Create eight-buses-design.md

* emit restarted before stopping

.changeset/eight-buses-design.md

@@ -0,0 +1,5 @@
+---
+"livekit-client": patch
+---
+
+Honor calls to track.stop() during an ongoing restart attempt

src/room/track/LocalTrack.ts

@@ -43,6 +43,8 @@ export default abstract class LocalTrack<
 
   protected audioContext?: AudioContext;
 
+  protected manuallyStopped: boolean = false;
+
   private restartLock: Mutex;
 
   /**
@@ -259,6 +261,7 @@ export default abstract class LocalTrack<
   }
 
   protected async restart(constraints?: MediaTrackConstraints) {
+    this.manuallyStopped = false;
     const unlock = await this.restartLock.lock();
     try {
       if (!constraints) {
@@ -296,8 +299,14 @@ export default abstract class LocalTrack<
 
       await this.setMediaStreamTrack(newTrack);
       this._constraints = constraints;
-
       this.emit(TrackEvent.Restarted, this);
+      if (this.manuallyStopped) {
+        this.log.warn(
+          'track was stopped during a restart, stopping restarted track',
+          this.logContext,
+        );
+        this.stop();
+      }
       return this;
     } finally {
       unlock();
@@ -361,6 +370,7 @@ export default abstract class LocalTrack<
   };
 
   stop() {
+    this.manuallyStopped = true;
     super.stop();
 
     this._mediaStreamTrack.removeEventListener('ended', this.handleEnded);