Limit negative freshness TTL values to -1

Author: ShyamGadde

plugins/optimization-detective/class-od-url-metric-group-collection.php

@@ -73,7 +73,7 @@ final class OD_URL_Metric_Group_Collection implements Countable, IteratorAggrega
 	 * A freshness age of zero means a URL Metric will always be considered stale.
 	 *
 	 * @since 0.1.0
-	 * @var int
+	 * @var int<-1, max>
 	 */
 	private $freshness_ttl;
 
@@ -104,7 +104,7 @@ final class OD_URL_Metric_Group_Collection implements Countable, IteratorAggrega
 	 *
 	 * @phpstan-param positive-int[] $breakpoints
 	 * @phpstan-param int<1, max>    $sample_size
-	 * @phpstan-param int            $freshness_ttl
+	 * @phpstan-param int<-1, max>   $freshness_ttl
 	 *
 	 * @param OD_URL_Metric[]  $url_metrics   URL Metrics.
 	 * @param non-empty-string $current_etag  The current ETag.
@@ -215,7 +215,7 @@ public function get_sample_size(): int {
 	 *
 	 * @since 1.0.0
 	 *
-	 * @return int Freshness age (TTL) for a given URL Metric.
+	 * @return int<-1, max> Freshness age (TTL) for a given URL Metric.
 	 */
 	public function get_freshness_ttl(): int {
 		return $this->freshness_ttl;
@@ -691,7 +691,7 @@ public function count(): int {
 	 * @return array{
 	 *             current_etag: non-empty-string,
 	 *             breakpoints: positive-int[],
-	 *             freshness_ttl: int,
+	 *             freshness_ttl: int<-1, max>,
 	 *             sample_size: positive-int,
 	 *             all_element_max_intersection_ratios: array<string, float>,
 	 *             common_lcp_element: ?OD_Element,

plugins/optimization-detective/class-od-url-metric-group.php

@@ -62,7 +62,7 @@ final class OD_URL_Metric_Group implements IteratorAggregate, Countable, JsonSer
 	 *
 	 * @since 0.1.0
 	 *
-	 * @var int
+	 * @var int<-1, max>
 	 */
 	private $freshness_ttl;
 
@@ -102,7 +102,7 @@ final class OD_URL_Metric_Group implements IteratorAggregate, Countable, JsonSer
 	 * @phpstan-param int<0, max>      $minimum_viewport_width
 	 * @phpstan-param int<1, max>|null $maximum_viewport_width
 	 * @phpstan-param int<1, max>      $sample_size
-	 * @phpstan-param int              $freshness_ttl
+	 * @phpstan-param int<-1, max>     $freshness_ttl
 	 *
 	 * @param OD_URL_Metric[]                $url_metrics            URL Metrics to add to the group.
 	 * @param int                            $minimum_viewport_width Minimum possible viewport width (exclusive) for the group. Must be zero or greater.
@@ -192,7 +192,7 @@ public function get_sample_size(): int {
 	 * @since 0.9.0
 	 *
 	 * @todo Eliminate in favor of readonly public property.
-	 * @return int Freshness age.
+	 * @return int<-1, max> Freshness age.
 	 */
 	public function get_freshness_ttl(): int {
 		return $this->freshness_ttl;
@@ -504,7 +504,7 @@ public function clear_cache(): void {
 	 * @since 0.3.1
 	 *
 	 * @return array{
-	 *             freshness_ttl: int,
+	 *             freshness_ttl: int<-1, max>,
 	 *             sample_size: positive-int,
 	 *             minimum_viewport_width: int<0, max>,
 	 *             maximum_viewport_width: int<1, max>|null,

plugins/optimization-detective/storage/data.php

@@ -20,7 +20,7 @@
  * @since 0.1.0
  * @access private
  *
- * @return int Expiration TTL in seconds.
+ * @return int<-1, max> Expiration TTL in seconds.
  */
 function od_get_url_metric_freshness_ttl(): int {
 	/**
@@ -38,7 +38,8 @@ function od_get_url_metric_freshness_ttl(): int {
 	 *
 	 * @param int $ttl Expiration TTL in seconds. Defaults to 1 week.
 	 */
-	return (int) apply_filters( 'od_url_metric_freshness_ttl', WEEK_IN_SECONDS );
+	$ttl = (int) apply_filters( 'od_url_metric_freshness_ttl', WEEK_IN_SECONDS );
+	return max( -1, $ttl );
 }
 
 /**