Skip to content

Commit 1cf24f1

Browse files
westonruterwestonruter
committed
Rename od_url_metric_collected action to od_url_metric_stored and use OD_URL_Metric_Stored_Context instead of array
1 parent b833e1b commit 1cf24f1

File tree

4 files changed

+108
-18
lines changed

4 files changed

+108
-18
lines changed

‎plugins/optimization-detective/load.php

+1
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ static function ( string $version ): void {
108108
require_once __DIR__ . '/storage/class-od-storage-lock.php';
109109
require_once __DIR__ . '/storage/data.php';
110110
require_once __DIR__ . '/storage/rest-api.php';
111+
require_once __DIR__ . '/storage/class-od-url-metric-stored-context.php';
111112

112113
// Detection logic.
113114
require_once __DIR__ . '/detection.php';

‎plugins/optimization-detective/storage/class-od-url-metric-stored-context.php

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<?php
2+
/**
3+
* Optimization Detective: OD_URL_Metric_Stored_Context class
4+
*
5+
* @package optimization-detective
6+
* @since n.e.x.t
7+
*/
8+
9+
// Exit if accessed directly.
10+
if ( ! defined( 'ABSPATH' ) ) {
11+
exit;
12+
}
13+
14+
/**
15+
* Context for when a URL metric is successfully stored via the REST API.
16+
*
17+
* @since n.e.x.t
18+
* @access private
19+
*/
20+
final class OD_URL_Metric_Stored_Context {
21+
22+
/**
23+
* Request.
24+
*
25+
* @var WP_REST_Request<array<string, mixed>>
26+
* @readonly
27+
*/
28+
public $request;
29+
30+
/**
31+
* ID for the URL metric post.
32+
*
33+
* @var int
34+
* @readonly
35+
*/
36+
public $post_id;
37+
38+
/**
39+
* URL metric group collection.
40+
*
41+
* @var OD_URL_Metric_Group_Collection
42+
* @readonly
43+
*/
44+
public $url_metric_group_collection;
45+
46+
/**
47+
* URL metric group.
48+
*
49+
* @var OD_URL_Metric_Group
50+
* @readonly
51+
*/
52+
public $url_metric_group;
53+
54+
/**
55+
* URL metric.
56+
*
57+
* @var OD_URL_Metric
58+
* @readonly
59+
*/
60+
public $url_metric;
61+
62+
/**
63+
* Constructor.
64+
*
65+
* @phpstan-param WP_REST_Request<array<string, mixed>> $request
66+
*
67+
* @param WP_REST_Request $request REST API request.
68+
* @param int $post_id ID for the URL metric post.
69+
* @param OD_URL_Metric_Group_Collection $url_metric_group_collection URL metric group collection.
70+
* @param OD_URL_Metric_Group $url_metric_group URL metric group.
71+
* @param OD_URL_Metric $url_metric URL metric.
72+
*/
73+
public function __construct( WP_REST_Request $request, int $post_id, OD_URL_Metric_Group_Collection $url_metric_group_collection, OD_URL_Metric_Group $url_metric_group, OD_URL_Metric $url_metric ) {
74+
$this->request = $request;
75+
$this->post_id = $post_id;
76+
$this->url_metric_group_collection = $url_metric_group_collection;
77+
$this->url_metric_group = $url_metric_group;
78+
$this->url_metric = $url_metric;
79+
}
80+
}

‎plugins/optimization-detective/storage/rest-api.php

+10-18
Original file line numberDiff line numberDiff line change
@@ -172,28 +172,20 @@ function od_handle_rest_request( WP_REST_Request $request ) {
172172
$post_id = $result;
173173

174174
/**
175-
* Fires whenever a URL Metric was successfully collected.
175+
* Fires whenever a URL Metric was successfully stored.
176176
*
177-
* @since 0.6.0
177+
* @since n.e.x.t
178178
*
179-
* @param array $context {
180-
* Context about the successful URL Metric collection.
181-
*
182-
* @type int $post_id ID for URL metrics post.
183-
* @type WP_REST_Request<array<string, mixed>> $request Storage request.
184-
* @type OD_Strict_URL_Metric $url_metric URL metric.
185-
* @type OD_URL_Metric_Group $url_metric_group URL metric group.
186-
* @type OD_URL_Metric_Group_Collection $url_metric_group_collection URL metric group collection.
187-
* }
179+
* @param OD_URL_Metric_Stored_Context $context Context.
188180
*/
189181
do_action(
190-
'od_url_metric_collected',
191-
array(
192-
'post_id' => $post_id,
193-
'request' => $request,
194-
'url_metric' => $url_metric,
195-
'url_metric_group' => $url_metric_group,
196-
'url_metric_group_collection' => $url_metric_group_collection,
182+
'od_url_metric_stored',
183+
new OD_URL_Metric_Stored_Context(
184+
$request,
185+
$post_id,
186+
$url_metric_group_collection,
187+
$url_metric_group,
188+
$url_metric
197189
)
198190
);
199191

‎plugins/optimization-detective/tests/storage/test-rest-api.php

+17
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,17 @@ static function ( array $properties ): array {
6363
* @covers ::od_handle_rest_request
6464
*/
6565
public function test_rest_request_good_params( Closure $set_up ): void {
66+
add_action(
67+
'od_url_metric_stored',
68+
function ( OD_URL_Metric_Stored_Context $context ): void {
69+
$this->assertInstanceOf( OD_URL_Metric_Group_Collection::class, $context->url_metric_group_collection );
70+
$this->assertInstanceOf( OD_URL_Metric_Group::class, $context->url_metric_group );
71+
$this->assertInstanceOf( OD_URL_Metric::class, $context->url_metric );
72+
$this->assertInstanceOf( WP_REST_Request::class, $context->request );
73+
$this->assertIsInt( $context->post_id );
74+
}
75+
);
76+
6677
$valid_params = $set_up();
6778
$this->assertCount( 0, get_posts( array( 'post_type' => OD_URL_Metrics_Post_Type::SLUG ) ) );
6879
$request = $this->create_request( $valid_params );
@@ -87,6 +98,7 @@ public function test_rest_request_good_params( Closure $set_up ): void {
8798
$expected_data,
8899
wp_array_slice_assoc( $url_metrics[0]->jsonSerialize(), array_keys( $expected_data ) )
89100
);
101+
$this->assertSame( 1, did_action( 'od_url_metric_stored' ) );
90102
}
91103

92104
/**
@@ -225,6 +237,7 @@ public function test_rest_request_bad_params( array $params ): void {
225237
$this->assertSame( 'rest_invalid_param', $response->get_data()['code'], 'Response: ' . wp_json_encode( $response ) );
226238

227239
$this->assertNull( OD_URL_Metrics_Post_Type::get_post( $params['slug'] ) );
240+
$this->assertSame( 0, did_action( 'od_url_metric_stored' ) );
228241
}
229242

230243
/**
@@ -239,6 +252,7 @@ public function test_rest_request_not_json_data(): void {
239252
$response = rest_get_server()->dispatch( $request );
240253
$this->assertSame( 400, $response->get_status(), 'Response: ' . wp_json_encode( $response ) );
241254
$this->assertSame( 'missing_array_json_body', $response->get_data()['code'], 'Response: ' . wp_json_encode( $response ) );
255+
$this->assertSame( 0, did_action( 'od_url_metric_stored' ) );
242256
}
243257

244258
/**
@@ -254,6 +268,7 @@ public function test_rest_request_not_json_content_type(): void {
254268
$response = rest_get_server()->dispatch( $request );
255269
$this->assertSame( 400, $response->get_status(), 'Response: ' . wp_json_encode( $response ) );
256270
$this->assertSame( 'rest_missing_callback_param', $response->get_data()['code'], 'Response: ' . wp_json_encode( $response ) );
271+
$this->assertSame( 0, did_action( 'od_url_metric_stored' ) );
257272
}
258273

259274
/**
@@ -269,6 +284,7 @@ public function test_rest_request_empty_array_json_body(): void {
269284
$response = rest_get_server()->dispatch( $request );
270285
$this->assertSame( 400, $response->get_status(), 'Response: ' . wp_json_encode( $response ) );
271286
$this->assertSame( 'rest_missing_callback_param', $response->get_data()['code'], 'Response: ' . wp_json_encode( $response ) );
287+
$this->assertSame( 0, did_action( 'od_url_metric_stored' ) );
272288
}
273289

274290
/**
@@ -284,6 +300,7 @@ public function test_rest_request_non_array_json_body(): void {
284300
$response = rest_get_server()->dispatch( $request );
285301
$this->assertSame( 400, $response->get_status(), 'Response: ' . wp_json_encode( $response ) );
286302
$this->assertSame( 'rest_missing_callback_param', $response->get_data()['code'], 'Response: ' . wp_json_encode( $response ) );
303+
$this->assertSame( 0, did_action( 'od_url_metric_stored' ) );
287304
}
288305

289306
/**

0 commit comments

Comments
 (0)