Make 'etag' a required property of the URL Metric

Signed-off-by: Shyamsundar Gadde <[email protected]>

Author: ShyamGadde

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

@@ -286,11 +286,6 @@ public function is_complete(): bool {
 					return false;
 				}
 
-				// The ETag is not populated yet, so this is stale. Eventually this will be required.
-				if ( $url_metric->get_etag() === null ) {
-					return false;
-				}
-
 				// The ETag of the URL Metric does not match the current ETag for the collection, so it is stale.
 				if ( ! hash_equals( $url_metric->get_etag(), $this->collection->get_current_etag() ) ) {
 					return false;

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

@@ -39,7 +39,7 @@
  *                            }
  * @phpstan-type Data         array{
  *                                uuid: non-empty-string,
- *                                etag?: non-empty-string,
+ *                                etag: non-empty-string,
  *                                url: non-empty-string,
  *                                timestamp: float,
  *                                viewport: ViewportRect,
@@ -171,6 +171,7 @@ public function set_group( OD_URL_Metric_Group $group ): void {
 	 *
 	 * @since 0.1.0
 	 * @since 0.9.0 Added the 'etag' property to the schema.
+	 * @since n.e.x.t The 'etag' property is now required.
 	 *
 	 * @todo Cache the return value?
 	 *
@@ -230,7 +231,7 @@ public static function get_json_schema(): array {
 					'pattern'     => '^[0-9a-f]{32}\z',
 					'minLength'   => 32,
 					'maxLength'   => 32,
-					'required'    => false, // To be made required in a future release.
+					'required'    => true,
 					'readonly'    => true, // Omit from REST API.
 				),
 				'url'       => array(
@@ -446,12 +447,12 @@ public function get_uuid(): string {
 	 * Gets ETag.
 	 *
 	 * @since 0.9.0
+	 * @since n.e.x.t No longer returns null as 'etag' is now required.
 	 *
-	 * @return non-empty-string|null ETag.
+	 * @return non-empty-string ETag.
 	 */
-	public function get_etag(): ?string {
-		// Since the ETag is optional for now, return null for old URL Metrics that do not have one.
-		return $this->data['etag'] ?? null;
+	public function get_etag(): string {
+		return $this->data['etag'];
 	}
 
 	/**

plugins/optimization-detective/storage/class-od-url-metrics-post-type.php

@@ -226,13 +226,6 @@ public static function store_url_metric( string $slug, OD_URL_Metric $new_url_me
 		}
 
 		$etag = $new_url_metric->get_etag();
-		if ( null === $etag ) {
-			// This case actually will never occur in practice because the store_url_metric function is only called
-			// in the REST API endpoint where the ETag parameter is required. It is here exclusively for the sake of
-			// PHPStan's static analysis. This entire condition can be removed in a future release when the 'etag'
-			// property becomes required.
-			return new WP_Error( 'missing_etag' );
-		}
 
 		$group_collection = new OD_URL_Metric_Group_Collection(
 			$url_metrics,