fix: resumeInfinity/onresume interaction #544

tuncayuk · 2025-11-26T16:01:10Z

Change resumeInfinity to reset the existing timeout instead of calling clear() when a timer is present
Introduce resumeFromKeepAlive guard so keep-alive resume() calls don’t recursively trigger resumeInfinity

Key changes for consumers:

1) Added enableUtteranceKeepAlive parameter

Previously, the startKeepAlive() logic (resume/pause) was enabled only for non-Android user agents via:

const isAndroid = /android/i.test((window.navigator || {}).userAgent || '')

However, on Comcast XI devices, triggering SpeechSynthesisUtterance resume/pause events can cause the announce to get stuck (the Promise never resolves). Also, for Comcast XI we don’t need to run the startKeepAlive() (resume/pause) logic.

With the new enableUtteranceKeepAlive option, consumers can explicitly enable/disable the keep-alive behavior from the app side:

this.$announcer.configure({ enableUtteranceKeepAlive: false });
this.$announcer.enable();

Note: The default value is based on defaultUtteranceKeepAlive, so consumers can override it if needed. This is not a breaking change.
const defaultUtteranceKeepAlive = !isAndroid

2) Added cancelPrevious parameter

While working with Vishnu, I noticed they were cancelling the previous utterance during navigation by calling three APIs:

this.$announcer.stop();
this.$announcer.clear();
this.$announcer.speak(utterance);

To simplify this requirement, I added cancelPrevious, which cancels any in-progress/queued utterance before speaking the new one:

this.$announcer.speak(utterance, 'off', { cancelPrevious: true });

This reduces multiple calls into a single, safer API call.

3) Improved clearing of utterances

I improved how we clear utterances by removing them based on the utterance ID, ensuring references are cleaned up more reliably and avoiding stale entries in the map.

github-actions · 2025-11-26T16:01:56Z

Test Results: ✅ PASSED

Run at: 2025-11-26T16:01:42.800Z

Summary:
passed: 917 failed: 0 of 917 tests

michielvandergeest

LGTM! A few minor syntax related comments

src/announcer/speechSynthesis.js

…function

…Infinity functions

…ume handler

github-actions · 2025-12-02T10:28:37Z

Test Results: ✅ PASSED

Run at: 2025-12-02T10:28:25.494Z

Summary:
passed: 917 failed: 0 of 917 tests

github-actions · 2025-12-03T12:18:00Z

Test Results: ✅ PASSED

Run at: 2025-12-03T12:17:48.082Z

Summary:
passed: 917 failed: 0 of 917 tests

github-actions · 2025-12-03T12:20:44Z

Test Results: ✅ PASSED

Run at: 2025-12-03T12:20:32.097Z

Summary:
passed: 917 failed: 0 of 917 tests

github-actions · 2025-12-03T14:38:36Z

Test Results: ✅ PASSED

Run at: 2025-12-03T14:38:24.613Z

Summary:
passed: 917 failed: 0 of 917 tests

…ity function

github-actions · 2025-12-03T15:06:27Z

Test Results: ✅ PASSED

Run at: 2025-12-03T15:06:07.990Z

Summary:
passed: 917 failed: 0 of 917 tests

… synthesis

…meInfinity function

…ech queue

github-actions · 2025-12-04T09:08:14Z

Test Results: ✅ PASSED

Run at: 2025-12-04T09:07:59.870Z

Summary:
passed: 917 failed: 0 of 917 tests

github-actions · 2025-12-04T09:47:10Z

Test Results: ✅ PASSED

Run at: 2025-12-04T09:46:56.875Z

Summary:
passed: 917 failed: 0 of 917 tests

… is ready before speaking

github-actions · 2025-12-05T10:56:52Z

Test Results: ✅ PASSED

Run at: 2025-12-05T10:56:39.578Z

Summary:
passed: 917 failed: 0 of 917 tests

…handling

github-actions · 2025-12-08T13:39:54Z

Test Results: ✅ PASSED

Run at: 2025-12-08T13:39:40.543Z

Summary:
passed: 917 failed: 0 of 917 tests

…live functions

…ndling

github-actions · 2025-12-08T16:10:48Z

Test Results: ✅ PASSED

Run at: 2025-12-08T16:10:34.947Z

Summary:
passed: 917 failed: 0 of 917 tests

github-actions · 2025-12-23T20:37:25Z

Test Results: ✅ PASSED

Run at: 2025-12-23T20:37:14.088Z

Summary:
passed: 917 failed: 0 of 917 tests

michielvandergeest · 2025-12-23T20:23:31Z

src/announcer/announcer.js

        })
      debounce = null
-    }, 200)
+    }, 300)


Was there a specific reason for increasing the timeout from 200 to 300?

michielvandergeest · 2025-12-23T20:46:50Z

src/announcer/announcer.js

+  // Cancel any active speech synthesis
+  speechSynthesis.cancel()


does clearing the queue also mean that we want to cancel the current message being spoken out? I'm not sure that it should always be so ..

michielvandergeest · 2025-12-23T20:48:35Z

src/announcer/speechSynthesis.js

+  if (!state) {
+    return
+  }
+  if (state?.timer !== null) {


I prefer not to use optional chaining (as it doesn't transpile to very optimal es5 code)

michielvandergeest · 2025-12-23T20:50:53Z

src/announcer/speechSynthesis.js

+  const { utterance } = state
+
+  // utterance check: utterance instance is invalid
+  if (!(utterance instanceof SpeechSynthesisUtterance)) {


do we need this instanceof check? would there ever be a case where it's not an instance of SpeechSynthesisUtterance? instanceof is a relatively expensive operation

michielvandergeest · 2025-12-23T20:51:35Z

src/announcer/speechSynthesis.js

+  }
+
+  // Clear existing timer for this specific utterance
+  if (state?.timer !== null) {


Remove the optional chaining syntax

michielvandergeest · 2025-12-23T20:54:14Z

src/announcer/speechSynthesis.js

 const initialize = () => {
+  // syn api check: syn might not have getVoices method
+  if (!syn || typeof syn.getVoices !== 'function') {
+    initialized = true


is this correct? if syn is falsy, do we want to set initialized to true?

michielvandergeest · 2025-12-23T20:56:49Z

src/announcer/speechSynthesis.js

+      const isReady = !syn.speaking && !syn.pending
+
+      if (isReady) {
+        Log.warn(`SpeechSynthesis - ready after ${elapsed}ms`)


These should probably be Log.debug statements and not Log.warn?

michielvandergeest · 2025-12-23T20:57:14Z

src/announcer/speechSynthesis.js

+
+    const startTime = Date.now()
+
+    const intervalId = window.setInterval(() => {


why use window.setInterval instead of setInterval?

michielvandergeest · 2025-12-23T20:57:26Z

src/announcer/speechSynthesis.js

+
+      if (isReady) {
+        Log.warn(`SpeechSynthesis - ready after ${elapsed}ms`)
+        window.clearInterval(intervalId)


why use window.clearInterval instead of clearInterval?

michielvandergeest · 2025-12-23T20:59:07Z

src/announcer/speechSynthesis.js


    utterance.onerror = (e) => {
-      clear()
-      utterances.delete(id) // Cleanup


is this not necessary anymore?

fix: resumeInfinity/onresume interaction

3170c73

tuncayuk requested a review from michielvandergeest as a code owner November 26, 2025 16:01

michielvandergeest requested changes Dec 1, 2025

View reviewed changes

src/announcer/speechSynthesis.js Outdated Show resolved Hide resolved

src/announcer/speechSynthesis.js Outdated Show resolved Hide resolved

src/announcer/speechSynthesis.js Outdated Show resolved Hide resolved

tuncayuk added 3 commits December 2, 2025 10:22

chore: ensure target is a SpeechSynthesisUtterance in resumeInfinity …

15614f1

…function

fix: ensure infinityTimer is checked against null in clear and resume…

f35ab5e

…Infinity functions

fix: ensure resumeFromKeepAlive is strictly checked for true in onres…

910df0c

…ume handler

tuncayuk requested a review from michielvandergeest December 2, 2025 10:28

fix: improve utterance management and error handling in speech synthesis

ecb2ddc

chore: add placeholder for getVoices method in speech synthesis

d43ee72

tuncayuk added 2 commits December 3, 2025 14:37

chore: improve error handling in speak function of speech synthesis

3e56c9d

chore: enhance queue management and debounce handling in announcer

d2721b6

fix: add optional chaining to safely check timer state in resumeInfin…

6aa4a19

…ity function

tuncayuk added 5 commits December 3, 2025 17:02

fix: enhance stop and clear functions to ensure clean state in speech…

a1ebc94

… synthesis

fix: add double-check for utterance existence before resuming in resu…

9910a08

…meInfinity function

fix: add early return in clear function to handle non-existent state

624604f

chore: remove unused pause event handling in speak function

fa88731

fix: add cancelPrevious option to AnnouncerUtterance for managing spe…

4fb38de

…ech queue

chore: simplify stop api

cc30b5e

tuncayuk added 2 commits December 5, 2025 10:55

fix: increase debounce duration in processQueue to improve performance

3a1a66e

fix: add waitForSynthReady function to ensure speech synthesis engine…

7d842ee

… is ready before speaking

fix: add enableUtteranceKeepAlive option to improve speech synthesis …

41aa289

…handling

tuncayuk added 4 commits December 8, 2025 14:13

fix: remove previous resolve function in clear method

6f3a1ae

fix: remove redundant utterances.delete calls in clear and startKeepA…

2c5255f

…live functions

fix: log result of speaking in processQueue for better debugging

8e9d109

fix: include result in onend callback of speak function for better ha…

4dc14df

…ndling

michielvandergeest mentioned this pull request Dec 12, 2025

[BUG] Announcer on LG webOS TV - Cant hear the announcement #552

Open

michielvandergeest added 3 commits December 23, 2025 21:15

Removed unneeded variable assignments.

8441944

Removed debug log.

9959d92

Removed debug log and renamed variable.

1d4884e

michielvandergeest requested changes Dec 23, 2025

View reviewed changes

		// Cancel any active speech synthesis
		speechSynthesis.cancel()


		const startTime = Date.now()

		const intervalId = window.setInterval(() => {

fix: resumeInfinity/onresume interaction #544

Are you sure you want to change the base?

fix: resumeInfinity/onresume interaction #544

Uh oh!

Conversation

tuncayuk commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Key changes for consumers:

1) Added enableUtteranceKeepAlive parameter

2) Added cancelPrevious parameter

3) Improved clearing of utterances

Uh oh!

github-actions bot commented Nov 26, 2025

Test Results: ✅ PASSED

Uh oh!

michielvandergeest left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Dec 2, 2025

Test Results: ✅ PASSED

Uh oh!

github-actions bot commented Dec 3, 2025

Test Results: ✅ PASSED

Uh oh!

github-actions bot commented Dec 3, 2025

Test Results: ✅ PASSED

Uh oh!

github-actions bot commented Dec 3, 2025

Test Results: ✅ PASSED

Uh oh!

github-actions bot commented Dec 3, 2025

Test Results: ✅ PASSED

Uh oh!

github-actions bot commented Dec 4, 2025

Test Results: ✅ PASSED

Uh oh!

github-actions bot commented Dec 4, 2025

Test Results: ✅ PASSED

Uh oh!

github-actions bot commented Dec 5, 2025

Test Results: ✅ PASSED

Uh oh!

github-actions bot commented Dec 8, 2025

Test Results: ✅ PASSED

Uh oh!

github-actions bot commented Dec 8, 2025

Test Results: ✅ PASSED

Uh oh!

github-actions bot commented Dec 23, 2025

Test Results: ✅ PASSED

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

tuncayuk commented Nov 26, 2025 •

edited

Loading