Refactor to make source property readonly

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

Author: b1ink0

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

@@ -44,7 +44,7 @@
  *                                timestamp: float,
  *                                viewport: ViewportRect,
  *                                elements: ElementData[],
- *                                source?: non-empty-string,
+ *                                source?: 'visitor'|'user'|'synthetic',
  *                            }
  * @phpstan-type JSONSchema   array{
  *                                type: string|string[],
@@ -315,6 +315,7 @@ public static function get_json_schema(): array {
 					'description' => __( 'The source of the URL Metric.', 'optimization-detective' ),
 					'type'        => 'string',
 					'required'    => false,
+					'readonly'    => true, // Omit from REST API.
 					'enum'        => array(
 						'visitor',
 						'user',
@@ -542,7 +543,7 @@ function ( array $element ): OD_Element {
 	 *
 	 * @since n.e.x.t
 	 *
-	 * @return non-empty-string|null Source.
+	 * @return 'visitor'|'user'|'synthetic'|null Source.
 	 */
 	public function get_source(): ?string {
 		return $this->data['source'] ?? null;

plugins/optimization-detective/detect.js

@@ -919,13 +919,8 @@ export default async function detect( {
 			height: win.innerHeight,
 		},
 		elements: [],
-		source: restApiNonce ? 'user' : 'visitor',
 	};
 
-	if ( odPrimeUrlMetricsVerificationToken ) {
-		urlMetric.source = 'synthetic';
-	}
-
 	const lcpMetric = lcpMetricCandidates.at( -1 );
 
 	// Populate the elements in the URL Metric.

plugins/optimization-detective/storage/class-od-rest-url-metrics-store-endpoint.php

@@ -228,6 +228,7 @@ public function handle_rest_request( WP_REST_Request $request ) {
 						'timestamp' => microtime( true ),
 						'uuid'      => wp_generate_uuid4(),
 						'etag'      => $request->get_param( 'current_etag' ),
+						'source'    => '' !== (string) $request->get_param( 'prime_url_metrics_verification_token' ) ? 'synthetic' : ( is_user_logged_in() ? 'user' : 'visitor' ),
 					)
 				)
 			);

plugins/optimization-detective/types.ts

@@ -28,7 +28,6 @@ export interface URLMetric {
 		height: number;
 	};
 	elements: ElementData[];
-	source: 'visitor' | 'user' | 'synthetic';
 }
 
 export type ExtendedRootData = ExcludeProps< URLMetric >;