Fix failing test because of new source property

Co-authored-by: Weston Ruter <[email protected]>

Author: b1ink0

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

@@ -31,6 +31,7 @@ public function data_provider_to_test_constructor(): array {
 		return array(
 			'valid_minimal'                   => array(
 				'data' => array(
+					// Note: The 'source' field is currently optional, so this data is still valid without it.
 					'url'       => home_url( '/' ),
 					'etag'      => md5( '' ),
 					'viewport'  => $viewport,
@@ -136,6 +137,17 @@ static function ( $value ) {
 				),
 				'error' => 'etag is a required property of OD_URL_Metric.',
 			),
+			'missing_source'                  => array(
+				'data' => array(
+					'uuid'      => wp_generate_uuid4(),
+					'etag'      => md5( '' ),
+					'url'       => home_url( '/' ),
+					'viewport'  => $viewport,
+					'timestamp' => microtime( true ),
+					'elements'  => array(),
+				),
+				// Note: Add error message 'source is a required property of OD_URL_Metric.' when 'source' becomes mandatory.
+			),
 			'missing_viewport'                => array(
 				'data'  => array(
 					'uuid'      => wp_generate_uuid4(),
@@ -331,6 +343,15 @@ static function ( OD_Element $element ) {
 		$this->assertSame( $data['etag'], $url_metric->get( 'etag' ) );
 		$this->assertTrue( 1 === preg_match( '/^[a-f0-9]{32}$/', $url_metric->get_etag() ) );
 
+		// Note: When the 'source' field becomes required, the else statement can be removed.
+		if ( array_key_exists( 'source', $data ) ) {
+			$this->assertSame( $data['source'], $url_metric->get_source() );
+			$this->assertSame( $data['source'], $url_metric->get( 'source' ) );
+			$this->assertContains( $url_metric->get_source(), array( 'visitor', 'user', 'synthetic' ) );
+		} else {
+			$this->assertNull( $url_metric->get_source() );
+		}
+
 		$this->assertTrue( wp_is_uuid( $url_metric->get_uuid() ) );
 		$this->assertSame( $url_metric->get_uuid(), $url_metric->get( 'uuid' ) );
 
@@ -919,7 +940,7 @@ public function test_get_json_schema_extensibility( Closure $set_up, Closure $as
 	 */
 	protected function check_schema_subset( array $schema, string $path, bool $extended = false ): void {
 		$this->assertArrayHasKey( 'required', $schema, $path );
-		if ( ! $extended ) {
+		if ( ! $extended && 'root/source' !== $path ) {
 			$this->assertTrue( $schema['required'], $path );
 		}
 		$this->assertArrayHasKey( 'type', $schema, $path );

plugins/optimization-detective/tests/test-class-od-url-metrics-group.php

@@ -295,6 +295,23 @@ public function data_provider_test_is_complete(): array {
 				'freshness_ttl'              => -1,
 				'expected_is_group_complete' => false,
 			),
+			// Note: The following test case will not be required once the 'source' is mandatory in a future release.
+			'source_missing'                   => array(
+				'url_metric'                 => new OD_URL_Metric(
+					array(
+						'url'       => home_url( '/' ),
+						'etag'      => md5( '' ),
+						'viewport'  => array(
+							'width'  => 400,
+							'height' => 700,
+						),
+						'timestamp' => microtime( true ),
+						'elements'  => array(),
+					)
+				),
+				'freshness_ttl'              => HOUR_IN_SECONDS,
+				'expected_is_group_complete' => true,
+			),
 		);
 	}