Skip to content

Fix TTS cache bug #1123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dkotter wants to merge 2 commits into
base: develop
Choose a base branch
from
+34 −2
Open

Fix TTS cache bug #1123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
091796a
Ensure if a cached result is returned, we don't try and save that
dkotter Jun 18, 2026
3741b27
Add tests to verify fix
dkotter Jun 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions includes/Classifai/Features/TextToSpeech.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,8 @@ public function rest_endpoint_callback( WP_REST_Request $request ) {
$results = $this->run( $request->get_param( 'id' ), 'synthesize' );

if ( $results && ! is_wp_error( $results ) ) {
$attachment_id = $this->save( $results, $request->get_param( 'id' ) );
// An integer result means the provider returned a cached attachment ID
$attachment_id = is_int( $results ) ? $results : $this->save( $results, $request->get_param( 'id' ) );

if ( ! is_wp_error( $attachment_id ) ) {
return rest_ensure_response(
Expand Down Expand Up @@ -676,7 +677,10 @@ public function generate_text_to_speech_audio( int $post_id, ?int $calling_user_
$results = $this->run( $post_id, 'synthesize' );

if ( $results && ! is_wp_error( $results ) ) {
$this->save( $results, $post_id );
// An integer result means the provider returned a cached attachment ID
if ( ! is_int( $results ) ) {
$this->save( $results, $post_id );
}
delete_post_meta( $post_id, '_classifai_text_to_speech_error' );
} elseif ( is_wp_error( $results ) ) {
update_post_meta(
Expand Down
28 changes: 28 additions & 0 deletions tests/Integration/Features/TextToSpeechTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,4 +125,32 @@ public function test_save_replaces_existing_audio() {
$this->assertSame( $second, (int) get_post_meta( $post_id, TextToSpeech::AUDIO_ID_KEY, true ) );
$this->assertNull( get_post( $first ), 'The old audio attachment is deleted.' );
}

/**
* When the provider returns a cached attachment ID (content unchanged), the
* existing audio must be left intact rather than overwritten with the
* numeric ID coerced to a string.
*
* @covers ::generate_text_to_speech_audio
*/
public function test_cached_audio_is_not_overwritten() {
$feature = new TextToSpeech();
$post_id = self::factory()->post->create( [ 'post_content' => 'Some content to read.' ] );
$this->as_user_with_role( 'administrator' );
$this->enable_feature();

// Seed a previously generated audio attachment.
$attachment_id = $feature->save( 'real-audio-bytes', $post_id );
$audio_file = get_attached_file( $attachment_id );

// Mark the saved content hash so the provider's cached branch is taken.
update_post_meta( $post_id, TextToSpeech::AUDIO_HASH_KEY, md5( $feature->normalize_post_content( $post_id ) ) );

$feature->generate_text_to_speech_audio( $post_id );

// The attachment must be untouched: same ID, same file, same bytes.
$this->assertSame( $attachment_id, (int) get_post_meta( $post_id, TextToSpeech::AUDIO_ID_KEY, true ) );
$this->assertNotNull( get_post( $attachment_id ), 'The cached audio attachment is preserved.' );
$this->assertSame( 'real-audio-bytes', file_get_contents( $audio_file ) );
}
}
Loading