SpeechToText: Check if SpeechRecognition is listening before start/stop (DevExpress#31186)

Co-authored-by: Ruslan Farkhutdinov <[email protected]>

Author: r-farkhutdinov

packages/devextreme/js/__internal/core/speech_recognition_adapter.ts

@@ -19,6 +19,8 @@ const EVENT_NAMES = ['onresult', 'onerror', 'onend'];
 export class SpeechRecognitionAdapter {
   private _speechRecognition?: SpeechRecognition | null;
 
+  private _isListening = false;
+
   constructor(config: SpeechRecognitionConfig, events: SpeechRecognitionEvents) {
     const window = getWindow();
     // @ts-expect-error SpeechRecognition API is not supported in TS
@@ -42,7 +44,15 @@ export class SpeechRecognitionAdapter {
     }
 
     // eslint-disable-next-line spellcheck/spell-checker
-    this._speechRecognition.onend = events.onEnd;
+    this._speechRecognition.onstart = (): void => {
+      this._isListening = true;
+    };
+    // eslint-disable-next-line spellcheck/spell-checker
+    this._speechRecognition.onend = (event: Event): void => {
+      this._isListening = false;
+
+      events.onEnd(event);
+    };
     // eslint-disable-next-line spellcheck/spell-checker
     this._speechRecognition.onresult = events.onResult;
     this._speechRecognition.onerror = events.onError;
@@ -57,10 +67,18 @@ export class SpeechRecognitionAdapter {
   }
 
   start(): void {
+    if (this._isListening) {
+      return;
+    }
+
     this._speechRecognition?.start();
   }
 
   stop(): void {
+    if (!this._isListening) {
+      return;
+    }
+
     this._speechRecognition?.stop();
   }
 

packages/devextreme/testing/tests/DevExpress.core/speechRecognitionAdapter.tests.js

@@ -13,6 +13,7 @@ QUnit.module('SpeechRecognitionAdapter', {
             constructor() {
                 this.start = sinon.spy();
                 this.stop = sinon.spy();
+                this.onstart = null;
                 this.onresult = null;
                 this.onerror = null;
                 this.onend = null;
@@ -118,6 +119,7 @@ QUnit.module('SpeechRecognitionAdapter', {
         const speechRecognition = adapter._speechRecognition;
 
         adapter.start();
+        speechRecognition.onstart();
         adapter.stop();
 
         assert.ok(speechRecognition.start.calledOnce, 'start called');
@@ -131,5 +133,37 @@ QUnit.module('SpeechRecognitionAdapter', {
         adapter.dispose();
         assert.strictEqual(adapter._speechRecognition, null, 'cleared after dispose');
     });
+
+    QUnit.test('should not call start when listening', function(assert) {
+        const adapter = this.createAdapter();
+        const speechRecognition = adapter._speechRecognition;
+
+        speechRecognition.onstart();
+        adapter.start();
+
+        assert.ok(speechRecognition.start.notCalled, 'start not called');
+    });
+
+    QUnit.test('should not call stop if not listening', function(assert) {
+        const adapter = this.createAdapter();
+        const speechRecognition = adapter._speechRecognition;
+
+        adapter.stop();
+
+        assert.ok(speechRecognition.stop.notCalled, 'stop not called');
+    });
+
+    QUnit.test('should update _isListening on onstart/onend', function(assert) {
+        const adapter = this.createAdapter();
+        const speechRecognition = adapter._speechRecognition;
+
+        assert.strictEqual(adapter._isListening, false, 'initially not listening');
+
+        speechRecognition.onstart();
+        assert.strictEqual(adapter._isListening, true, 'set to listening after onstart');
+
+        speechRecognition.onend();
+        assert.strictEqual(adapter._isListening, false, 'reset to false after onend');
+    });
 });