Skip to content

Commit

Permalink
[Pattern Directory]: Add categories endpoint (#45749)
Browse files Browse the repository at this point in the history 
* [Pattern Directory]: Add categories endpoint

* fix linting issues

* add `locale` to the endpoint and transient key

* address feedback
  • Loading branch information
@ntsekouras
ntsekouras committed Nov 16, 2022
1 parent c9f6b05 commit 768e01a
Show file tree
Hide file tree
Showing 2 changed files with 167 additions and 10 deletions.
125 changes: 123 additions & 2 deletions lib/compat/wordpress-6.2/class-gutenberg-rest-pattern-directory-controller-6-2.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,127 @@
* Controller which provides REST endpoint for block patterns from wordpress.org/patterns.
*/
class Gutenberg_REST_Pattern_Directory_Controller_6_2 extends Gutenberg_REST_Pattern_Directory_Controller_6_0 {
/**
* Registers the necessary REST API routes.
*
* @since 5.8.0
* @since 6.2.0 Added pattern directory categories endpoint.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/categories',
array(
array(
'methods' => WP_REST_Server::READABLE,
'callback' => array( $this, 'get_pattern_categories' ),
'permission_callback' => array( $this, 'get_items_permissions_check' ),
),
)
);

parent::register_routes();
}

/**
* Retrieve block patterns categories.
*
* @since 6.2.0
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
*/
public function get_pattern_categories( $request ) {
$query_args = array( 'locale' => get_user_locale() );
$transient_key = 'wp_remote_block_pattern_categories_' . md5( serialize( $query_args ) );

/**
* Use network-wide transient to improve performance. The locale is the only site
* configuration that affects the response, and it's included in the transient key.
*/
$raw_pattern_categories = get_site_transient( $transient_key );

if ( ! $raw_pattern_categories ) {
$api_url = 'http://api.wordpress.org/patterns/1.0/?categories&' . build_query( $query_args );
if ( wp_http_supports( array( 'ssl' ) ) ) {
$api_url = set_url_scheme( $api_url, 'https' );
}

/**
* Default to a short TTL, to mitigate cache stampedes on high-traffic sites.
* This assumes that most errors will be short-lived, e.g., packet loss that causes the
* first request to fail, but a follow-up one will succeed. The value should be high
* enough to avoid stampedes, but low enough to not interfere with users manually
* re-trying a failed request.
*/
$cache_ttl = 5;
$wporg_response = wp_remote_get( $api_url );
$raw_pattern_categories = json_decode( wp_remote_retrieve_body( $wporg_response ) );
if ( is_wp_error( $wporg_response ) ) {
$raw_pattern_categories = $wporg_response;

} elseif ( ! is_array( $raw_pattern_categories ) ) {
// HTTP request succeeded, but response data is invalid.
$raw_pattern_categories = new WP_Error(
'pattern_directory_api_failed',
sprintf(
/* translators: %s: Support forums URL. */
__( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.', 'gutenberg' ),
__( 'https://wordpress.org/support/forums/', 'gutenberg' )
),
array(
'response' => wp_remote_retrieve_body( $wporg_response ),
)
);

} else {
// Response has valid data.
$cache_ttl = HOUR_IN_SECONDS;
}

set_site_transient( $transient_key, $raw_pattern_categories, $cache_ttl );
}

if ( is_wp_error( $raw_pattern_categories ) ) {
$raw_pattern_categories->add_data( array( 'status' => 500 ) );

return $raw_pattern_categories;
}

$response = array();

if ( $raw_pattern_categories ) {
foreach ( $raw_pattern_categories as $category ) {
$response[] = $this->prepare_response_for_collection(
$this->prepare_pattern_category_for_response( $category, $request )
);
}
}

return new WP_REST_Response( $response );
}

/**
* Prepare a raw block pattern category before it gets output in a REST API response.
*
* @since 6.2.0
*
* @param object $item Raw pattern category from api.wordpress.org, before any changes.
* @param WP_REST_Request $request Request object.
* @return WP_REST_Response
*/
public function prepare_pattern_category_for_response( $item, $request ) {
$raw_pattern_category = array(
'id' => absint( $item->id ),
'name' => sanitize_text_field( $item->name ),
'slug' => sanitize_title_with_dashes( $item->slug ),
);

$prepared_pattern_category = $this->add_additional_fields_to_object( $raw_pattern_category, $request );

return new WP_REST_Response( $prepared_pattern_category );
}

/**
* Search and retrieve block patterns metadata
*
Expand Down Expand Up @@ -48,7 +169,7 @@ public function get_items( $request ) {

$transient_key = $this->get_transient_key( $query_args );

/*
/**
* Use network-wide transient to improve performance. The locale is the only site
* configuration that affects the response, and it's included in the transient key.
*/
Expand All @@ -60,7 +181,7 @@ public function get_items( $request ) {
$api_url = set_url_scheme( $api_url, 'https' );
}

/*
/**
* Default to a short TTL, to mitigate cache stampedes on high-traffic sites.
* This assumes that most errors will be short-lived, e.g., packet loss that causes the
* first request to fail, but a follow-up one will succeed. The value should be high
Expand Down
52 changes: 44 additions & 8 deletions phpunit/class-wp-rest-pattern-directory-controller-test.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public static function wpSetUpBeforeClass( $factory ) {

self::$http_request_urls = array();

static::$controller = new WP_REST_Pattern_Directory_Controller();
static::$controller = new Gutenberg_REST_Pattern_Directory_Controller_6_2();
}

public static function wpTearDownAfterClass() {
Expand All @@ -68,6 +68,49 @@ public function tear_down() {
parent::tear_down();
}

/**
* @covers WP_REST_Pattern_Directory_Controller::register_routes
*
* @since 5.8.0
* @since 6.2.0 Added pattern directory categories endpoint.
*/
public function test_register_routes() {
$routes = rest_get_server()->get_routes();

$this->assertArrayHasKey( '/wp/v2/pattern-directory/patterns', $routes );
$this->assertArrayHasKey( '/wp/v2/pattern-directory/categories', $routes );
}

/**
* @covers WP_REST_Pattern_Directory_Controller::prepare_pattern_category_for_response
*
* @since 6.2.0
*/
public function test_prepare_pattern_category_for_response() {
$raw_categories = array(
(object) array(
'id' => 3,
'name' => 'Columns',
'slug' => 'columns',
'description' => 'A description',
),
);

$prepared_category = static::$controller->prepare_response_for_collection(
static::$controller->prepare_pattern_category_for_response( $raw_categories[0], new WP_REST_Request() )
);

$this->assertSame(
array(
'id' => 3,
'name' => 'Columns',
'slug' => 'columns',
),
$prepared_category
);
}


/**
* Tests if the provided query args are passed through to the wp.org API.
*
Expand Down Expand Up @@ -168,13 +211,6 @@ function ( $preempt, $args, $url ) {
);
}

/**
* @doesNotPerformAssertions
*/
public function test_register_routes() {
// Covered by the core test.
}

/**
* @doesNotPerformAssertions
*/
Expand Down

0 comments on commit 768e01a

Please sign in to comment.