Skip to content

Add test coverage for post stats cache handling improvements #46235

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

Draft
Copilot wants to merge 12 commits into
base: trunk
Choose a base branch
from
Draft

Add test coverage for post stats cache handling improvements #46235

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e0ceb39
Remove post stats cache
dognose24 Dec 5, 2025
8877038
changelog
dognose24 Dec 5, 2025
a736465
Improve post stats cache handling for invalid or error data
dognose24 Dec 5, 2025
ffe8c0c
Update changelog
dognose24 Dec 5, 2025
3c3624b
Merge branch 'trunk' into update/blog_stats_debug
dognose24 Dec 9, 2025
4ba2b0e
Respect the cache first and return errors or invalid data as they were
dognose24 Dec 9, 2025
68d3fe3
Keep WP errors from cache along with the valid response
dognose24 Dec 9, 2025
3bbe021
Update annotations
dognose24 Dec 9, 2025
5b9fc39
Update annotations
dognose24 Dec 9, 2025
94e3c06
Initial plan
Copilot Dec 9, 2025
93d7534
Add comprehensive test coverage for post stats cache handling
Copilot Dec 9, 2025
e80c38b
Fix test assertions to match actual WP_Error behavior
Copilot Dec 9, 2025
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
Prev Previous commit
Next Next commit
Add comprehensive test coverage for post stats cache handling 
Co-authored-by: dognose24 <[email protected]>
  • Loading branch information
@dognose24
Copilot and dognose24 committed Dec 9, 2025
commit 93d75341a839617af1c700f5c825d5953b6e69f7
279 changes: 279 additions & 0 deletions projects/packages/stats/tests/php/WPCOM_Stats_Test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -841,6 +841,285 @@ public function test_get_stats_with_arguments() {
$this->assertSame( wp_json_encode( $expected_stats, JSON_UNESCAPED_SLASHES ), self::get_stats_transient( '/sites/1234/stats/', $args ) );
}

/**
* Test that invalid/malformed cache entries trigger a refresh.
*/
public function test_fetch_post_stats_with_malformed_cache_triggers_refresh() {
$post_id = 1234;
$expected_stats = array(
'date' => '2022-09-29',
'views' => 100,
);

// Set up malformed cache - a string instead of expected array structure.
$meta_name = '_' . WPCOM_Stats::STATS_CACHE_TRANSIENT_PREFIX;
update_post_meta( $post_id, $meta_name, 'malformed_string_data' );

$this->wpcom_stats
->expects( $this->once() )
->method( 'fetch_remote_stats' )
->willReturn( $expected_stats );

$stats = $this->wpcom_stats->get_post_views( $post_id, array(), true );

// Should return the fresh data, not the malformed cache.
$this->assertSame( $expected_stats, $stats );
}

/**
* Test that cache with invalid structure (no time key) triggers a refresh.
*/
public function test_fetch_post_stats_with_invalid_structure_triggers_refresh() {
$post_id = 1234;
$expected_stats = array(
'date' => '2022-09-29',
'views' => 100,
);

// Set up invalid cache structure - array with non-numeric key.
$meta_name = '_' . WPCOM_Stats::STATS_CACHE_TRANSIENT_PREFIX;
update_post_meta( $post_id, $meta_name, array( 'invalid_key' => array( 'data' => 'value' ) ) );

$this->wpcom_stats
->expects( $this->once() )
->method( 'fetch_remote_stats' )
->willReturn( $expected_stats );

$stats = $this->wpcom_stats->get_post_views( $post_id, array(), true );

// Should return the fresh data, not the invalid cache.
$this->assertSame( $expected_stats, $stats );
}

/**
* Test that cache with unexpected value type triggers a refresh.
*/
public function test_fetch_post_stats_with_unexpected_value_type_triggers_refresh() {
$post_id = 1234;
$expected_stats = array(
'date' => '2022-09-29',
'views' => 100,
);

// Set up cache with unexpected value type (string instead of array or WP_Error).
$meta_name = '_' . WPCOM_Stats::STATS_CACHE_TRANSIENT_PREFIX;
$time = time();
update_post_meta( $post_id, $meta_name, array( $time => 'unexpected_string' ) );

$this->wpcom_stats
->expects( $this->once() )
->method( 'fetch_remote_stats' )
->willReturn( $expected_stats );

$stats = $this->wpcom_stats->get_post_views( $post_id, array(), true );

// Should return the fresh data, not the unexpected cached value.
$this->assertSame( $expected_stats, $stats );
}

/**
* Test that WP_Error cached entries are returned correctly within expiration period.
*/
public function test_fetch_post_stats_returns_cached_wp_error_within_expiration() {
$post_id = 1234;
$expected_error = new WP_Error( 'stats_error', 'Failed to fetch Stats from WPCOM' );

// Set up cache with WP_Error within expiration period.
$meta_name = '_' . WPCOM_Stats::STATS_CACHE_TRANSIENT_PREFIX;
$time = time() - 60; // 1 minute ago.
update_post_meta( $post_id, $meta_name, array( $time => $expected_error ) );

// Should not call fetch_remote_stats since cache is valid.
$this->wpcom_stats
->expects( $this->never() )
->method( 'fetch_remote_stats' );

$stats = $this->wpcom_stats->get_post_views( $post_id, array(), true );

// Should return the cached WP_Error with cached_at timestamp.
$this->assertTrue( is_array( $stats ) );
$this->assertArrayHasKey( 'cached_at', $stats );
$this->assertSame( $time, $stats['cached_at'] );
}

/**
* Test that WP_Error cached entries are refreshed beyond expiration period.
*/
public function test_fetch_post_stats_refreshes_cached_wp_error_beyond_expiration() {
$post_id = 1234;
$cached_error = new WP_Error( 'old_error', 'Old error' );
$expected_stats = array(
'date' => '2022-09-29',
'views' => 100,
);

// Set up cache with WP_Error beyond expiration period (6 minutes ago, expiration is 5 minutes).
$meta_name = '_' . WPCOM_Stats::STATS_CACHE_TRANSIENT_PREFIX;
$time = time() - ( 6 * MINUTE_IN_SECONDS );
update_post_meta( $post_id, $meta_name, array( $time => $cached_error ) );

// Should call fetch_remote_stats since cache is expired.
$this->wpcom_stats
->expects( $this->once() )
->method( 'fetch_remote_stats' )
->willReturn( $expected_stats );

$stats = $this->wpcom_stats->get_post_views( $post_id, array(), true );

// Should return the fresh data, not the expired cached error.
$this->assertSame( $expected_stats, $stats );
}

/**
* Test that valid array cached entries are returned correctly within expiration period.
*/
public function test_fetch_post_stats_returns_cached_array_within_expiration() {
$post_id = 1234;
$expected_stats = array(
'date' => '2022-09-29',
'views' => 100,
);

// Set up cache with array within expiration period.
$meta_name = '_' . WPCOM_Stats::STATS_CACHE_TRANSIENT_PREFIX;
$time = time() - 60; // 1 minute ago.
update_post_meta( $post_id, $meta_name, array( $time => $expected_stats ) );

// Should not call fetch_remote_stats since cache is valid.
$this->wpcom_stats
->expects( $this->never() )
->method( 'fetch_remote_stats' );

$stats = $this->wpcom_stats->get_post_views( $post_id, array(), true );

// Should return the cached array with cached_at timestamp.
$this->assertArrayHasKey( 'cached_at', $stats );
$this->assertSame( $time, $stats['cached_at'] );
$this->assertSame( $expected_stats['date'], $stats['date'] );
$this->assertSame( $expected_stats['views'], $stats['views'] );
}

/**
* Test that refresh_post_stats_cache properly caches success responses.
*/
public function test_refresh_post_stats_cache_caches_success_response() {
$post_id = 1234;
$expected_stats = array(
'date' => '2022-09-29',
'views' => 100,
);

$this->wpcom_stats
->expects( $this->once() )
->method( 'fetch_remote_stats' )
->willReturn( $expected_stats );

$stats = $this->wpcom_stats->get_post_views( $post_id, array(), true );

// Should return the stats.
$this->assertSame( $expected_stats, $stats );

// Verify the cache was updated.
$meta_name = '_' . WPCOM_Stats::STATS_CACHE_TRANSIENT_PREFIX;
$stats_cache = get_post_meta( $post_id, $meta_name, true );

$this->assertIsArray( $stats_cache );
$this->assertCount( 1, $stats_cache );

$time = key( $stats_cache );
$this->assertTrue( is_numeric( $time ) );
$this->assertSame( $expected_stats, $stats_cache[ $time ] );
}

/**
* Test that refresh_post_stats_cache properly caches error responses.
*/
public function test_refresh_post_stats_cache_caches_error_response() {
$post_id = 1234;
$expected_error = new WP_Error( 'stats_error', 'Failed to fetch Stats from WPCOM' );

$this->wpcom_stats
->expects( $this->once() )
->method( 'fetch_remote_stats' )
->willReturn( $expected_error );

$stats = $this->wpcom_stats->get_post_views( $post_id, array(), true );

// Should return the error.
$this->assertTrue( is_wp_error( $stats ) );

// Verify the error was cached.
$meta_name = '_' . WPCOM_Stats::STATS_CACHE_TRANSIENT_PREFIX;
$stats_cache = get_post_meta( $post_id, $meta_name, true );

$this->assertIsArray( $stats_cache );
$this->assertCount( 1, $stats_cache );

$time = key( $stats_cache );
$this->assertTrue( is_numeric( $time ) );
$this->assertInstanceOf( WP_Error::class, $stats_cache[ $time ] );
}

/**
* Test that cache expiration logic works correctly with the new validation.
*/
public function test_fetch_post_stats_respects_cache_expiration() {
$post_id = 1234;
$cached_stats = array(
'date' => '2022-09-28',
'views' => 50,
);
$expected_stats = array(
'date' => '2022-09-29',
'views' => 100,
);

// Set up cache beyond expiration period (6 minutes ago, expiration is 5 minutes).
$meta_name = '_' . WPCOM_Stats::STATS_CACHE_TRANSIENT_PREFIX;
$time = time() - ( 6 * MINUTE_IN_SECONDS );
update_post_meta( $post_id, $meta_name, array( $time => $cached_stats ) );

// Should call fetch_remote_stats since cache is expired.
$this->wpcom_stats
->expects( $this->once() )
->method( 'fetch_remote_stats' )
->willReturn( $expected_stats );

$stats = $this->wpcom_stats->get_post_views( $post_id, array(), true );

// Should return the fresh data, not the expired cache.
$this->assertSame( $expected_stats, $stats );

// Verify the cache was updated with new timestamp.
$stats_cache = get_post_meta( $post_id, $meta_name, true );
$new_time = key( $stats_cache );
$this->assertGreaterThan( $time, $new_time );
$this->assertSame( $expected_stats, $stats_cache[ $new_time ] );
}

/**
* Test that empty cache triggers a refresh.
*/
public function test_fetch_post_stats_with_no_cache_triggers_refresh() {
$post_id = 1234;
$expected_stats = array(
'date' => '2022-09-29',
'views' => 100,
);

// No cache set up.

$this->wpcom_stats
->expects( $this->once() )
->method( 'fetch_remote_stats' )
->willReturn( $expected_stats );

$stats = $this->wpcom_stats->get_post_views( $post_id, array(), true );

// Should return the fresh data.
$this->assertSame( $expected_stats, $stats );
}

/**
* Helper for fetching the stats transient.
*
Expand Down