Release 1.3.0

src/graphql/graphql-api.php → src/graphql/graphql-api-v1.php

@@ -14,7 +14,7 @@
 /**
  * GraphQL API to offer an alternative to the REST API.
  */
-class GraphQLApi {
+class GraphQLApiV1 {
 	/**
 	 * Initiatilize the graphQL API by hooking into the graphql_register_types action,
 	 * which only fires if WPGraphQL is installed and enabled, and is further controlled
@@ -140,11 +140,11 @@ public static function register_types() {
 		/**
 		 * Filter to enable/disable the graphQL API. By default, it is enabled.
 		 *
-		 * @param bool $is_graphql_to_be_enabled Whether the graphQL API should be enabled or not.
+		 * @param bool $is_graphql_enabled Whether the graphQL API should be enabled or not.
 		 */
-		$is_graphql_to_be_enabled = apply_filters( 'vip_block_data_api__is_graphql_enabled', true );
+		$is_graphql_enabled = apply_filters( 'vip_block_data_api__is_graphql_enabled', true );
 
-		if ( ! $is_graphql_to_be_enabled ) {
+		if ( ! $is_graphql_enabled ) {
 			return;
 		}
 
@@ -246,7 +246,7 @@ public static function register_types() {
 			'blocksData',
 			[
 				'type'        => 'BlocksData',
-				'description' => 'A block representation of post content',
+				'description' => 'Deprecated, prefer blocksDataV2. A block representation of post content.',
 				'resolve'     => [ __CLASS__, 'get_blocks_data' ],
 			]
 		);
@@ -277,4 +277,4 @@ public static function get_block_attribute_pair( $name, $value ) {
 	}
 }
 
-GraphQLApi::init();
+GraphQLApiV1::init();

src/graphql/graphql-api-v2.php

@@ -0,0 +1,257 @@
+<?php
+/**
+ * GraphQL API
+ *
+ * @package vip-block-data-api
+ */
+
+namespace WPCOMVIP\BlockDataApi;
+
+use GraphQLRelay\Relay;
+
+defined( 'ABSPATH' ) || die();
+
+/**
+ * GraphQL API to offer an alternative to the REST API.
+ */
+class GraphQLApiV2 {
+	/**
+	 * Initiatilize the graphQL API by hooking into the graphql_register_types action,
+	 * which only fires if WPGraphQL is installed and enabled, and is further controlled
+	 * by the vip_block_data_api__is_graphql_enabled filter.
+	 */
+	public static function init() {
+		add_action( 'graphql_register_types', [ __CLASS__, 'register_types' ] );
+	}
+
+	/**
+	 * Extract the blocks data for a post, and return back in the format expected by the GraphQL API.
+	 *
+	 * @param  \WPGraphQL\Model\Post $post_model Post model for post.
+	 *
+	 * @return array
+	 */
+	public static function get_blocks_data( $post_model ) {
+		$post_id = $post_model->ID;
+		$post    = get_post( $post_id );
+
+		$content_parser = new ContentParser();
+
+		$parser_results = $content_parser->parse( $post->post_content, $post_id );
+
+		// We need to not return a WP_Error object, and so a regular exception is returned.
+		if ( is_wp_error( $parser_results ) ) {
+			Analytics::record_error( $parser_results );
+
+			// Return API-safe error with extra data (e.g. stack trace) removed.
+			return new \Exception( $parser_results->get_error_message() );
+		}
+
+		$parser_results['blocks'] = array_map( function ( $block ) use ( $post_id ) {
+			return self::transform_block_format( $block, $post_id );
+		}, $parser_results['blocks'] );
+
+		$parser_results['blocks'] = self::flatten_blocks( $parser_results['blocks'] );
+		return $parser_results;
+	}
+
+	/**
+	 * Transform the block's format to the format expected by the graphQL API.
+	 *
+	 * @param array $block   An associative array of parsed block data with keys 'name' and 'attributes'.
+	 * @param array $post_id The associated post ID for the content being transformed. Used to produce unique block IDs.
+	 *
+	 * @return array
+	 */
+	public static function transform_block_format( $block, $post_id ) {
+		// Generate a unique ID for the block.
+		$block['id'] = Relay::toGlobalId( 'BlockDataV2', sprintf( '%d:%d', $post_id, wp_unique_id() ) );
+
+		// Convert the attributes to be in the name-value format that the schema expects.
+		$block = self::map_attributes( $block );
+
+		if ( isset( $block['innerBlocks'] ) && ! empty( $block['innerBlocks'] ) ) {
+			$block['innerBlocks'] = array_map( function ( $block ) use ( $post_id ) {
+				return self::transform_block_format( $block, $post_id );
+			}, $block['innerBlocks'] );
+		}
+
+		return $block;
+	}
+
+	/**
+	 * Convert the attributes to be in the name-value format that the schema expects.
+	 *
+	 * @param array $block An associative array of parsed block data with keys 'name' and 'attributes'.
+	 *
+	 * @return array
+	 */
+	public static function map_attributes( $block ) {
+		// check if type of attributes is stdClass and unset it as that's not supported by graphQL.
+		if ( isset( $block['attributes'] ) && is_object( $block['attributes'] ) ) {
+			unset( $block['attributes'] );
+		} elseif ( isset( $block['attributes'] ) && ! empty( $block['attributes'] ) ) {
+			$block['attributes'] = array_map(
+				[ __CLASS__, 'get_block_attribute_pair' ],
+				array_keys( $block['attributes'] ),
+				array_values( $block['attributes'] )
+			);
+		}
+
+		return $block;
+	}
+
+	/**
+	 * Flatten blocks recursively.
+	 *
+	 * @param array  $blocks the inner blocks in the block.
+	 * @param string $parent_id Optional. ID of the parent block that $blocks belong to.
+	 *
+	 * @return array
+	 */
+	public static function flatten_blocks( $blocks, $parent_id = null ) {
+		$flattened_blocks = [];
+
+		foreach ( $blocks as $block ) {
+			// Gather innerBlocks from current block
+			$inner_blocks = $block['innerBlocks'] ?? [];
+			unset( $block['innerBlocks'] );
+
+			// Set parent ID on current block
+			$block['parentId'] = $parent_id;
+
+			// Recurse into inner blocks
+			$flattened_blocks[] = $block;
+			$flattened_blocks   = array_merge( $flattened_blocks, self::flatten_blocks( $inner_blocks, $block['id'] ) );
+		}
+
+		return $flattened_blocks;
+	}
+
+	/**
+	 * Register types and fields graphql integration.
+	 *
+	 * @return void
+	 */
+	public static function register_types() {
+		/**
+		 * Filter to enable/disable the graphQL API. By default, it is enabled.
+		 *
+		 * @param bool $is_graphql_enabled Whether the graphQL API should be enabled or not.
+		 */
+		$is_graphql_enabled = apply_filters( 'vip_block_data_api__is_graphql_enabled', true );
+
+		if ( ! $is_graphql_enabled ) {
+			return;
+		}
+
+		// Register the type corresponding to the attributes of each individual block.
+		register_graphql_object_type(
+			'BlockAttributeV2',
+			[
+				'description' => 'Block attribute',
+				'fields'      => [
+					'name'               => [
+						'type'        => [ 'non_null' => 'String' ],
+						'description' => 'Block data attribute name',
+					],
+					'value'              => [
+						'type'        => [ 'non_null' => 'String' ],
+						'description' => 'Block data attribute value',
+					],
+					'isValueJsonEncoded' => [
+						'type'        => [ 'non_null' => 'Boolean' ],
+						'description' => 'True if value is a complex JSON-encoded field. This is used to encode attribute types like arrays and objects.',
+					],
+				],
+			],
+		);
+
+		// Register the type corresponding to the individual block, with the above attribute.
+		register_graphql_type(
+			'BlockDataV2',
+			[
+				'description' => 'Block data (v2)',
+				'fields'      => [
+					'id'         => [
+						'type'        => [ 'non_null' => 'ID' ],
+						'description' => 'ID of the block',
+					],
+					'parentId'   => [
+						'type'        => 'ID',
+						'description' => 'ID of the parent for this inner block, if it is an inner block. Otherwise, it will be null.',
+					],
+					'test'       => [
+						'type'        => 'String',
+						'description' => 'Test field',
+					],
+					'name'       => [
+						'type'        => [ 'non_null' => 'String' ],
+						'description' => 'Block name',
+					],
+					'attributes' => [
+						'type'        => [
+							'list_of' => 'BlockAttributeV2',
+						],
+						'description' => 'Block attributes',
+					],
+				],
+			],
+		);
+
+		// Register the type corresponding to the list of individual blocks, with each item being the above type.
+		register_graphql_type(
+			'BlocksDataV2',
+			[
+				'description' => 'Data for all the blocks',
+				'fields'      => [
+					'blocks'   => [
+						'type'        => [ 'list_of' => 'BlockDataV2' ],
+						'description' => 'List of blocks data',
+					],
+					'warnings' => [
+						'type'        => [ 'list_of' => 'String' ],
+						'description' => 'List of warnings related to processing the blocks data',
+					],
+				],
+			],
+		);
+
+		// Register the field on every post type that supports 'editor'.
+		register_graphql_field(
+			'NodeWithContentEditor',
+			'blocksDataV2',
+			[
+				'type'        => 'BlocksDataV2',
+				'description' => 'A block representation of post content (v2)',
+				'resolve'     => [ __CLASS__, 'get_blocks_data' ],
+			]
+		);
+	}
+
+	/**
+	 * Given a block attribute name and value, return a BlockAttribute array.
+	 *
+	 * @param string $name The name of the block attribute.
+	 * @param mixed  $value The value of the block attribute.
+	 *
+	 * @return array
+	 */
+	public static function get_block_attribute_pair( $name, $value ) {
+		// Non-string types (numbers, booleans, arrays, objects, for example) are encoded as JSON strings.
+		$is_value_json_encoded = false;
+
+		if ( ! is_string( $value ) ) {
+			$value                 = wp_json_encode( $value );
+			$is_value_json_encoded = true;
+		}
+
+		return [
+			'name'               => $name,
+			'value'              => strval( $value ),
+			'isValueJsonEncoded' => $is_value_json_encoded,
+		];
+	}
+}
+
+GraphQLApiV2::init();

src/parser/content-parser.php

@@ -240,7 +240,7 @@ protected function source_block( $block, $registered_blocks, $filter_options ) {
 			$crawler = new Crawler( sprintf( '<!doctype html><html><body>%s</body></html>', $block['innerHTML'] ) );
 
 			// Enter the <body> tag for block parsing.
-			$crawler = $crawler->filter( 'body' );
+			$crawler = $crawler->filter( 'body' )->children();
 
 			$attribute_value = $this->source_attribute( $crawler, $block_attribute_definition );
 
@@ -313,11 +313,11 @@ protected function source_attribute( $crawler, $block_attribute_definition ) {
 
 			$attribute_value = $this->source_block_attribute( $crawler, $block_attribute_definition );
 		} elseif ( 'rich-text' === $attribute_source ) {
+			$attribute_value = $this->source_block_rich_text( $crawler, $block_attribute_definition );
+		} elseif ( 'html' === $attribute_source ) {
 			// Most 'html' sources were converted to 'rich-text' in WordPress 6.5.
 			// https://github.com/WordPress/gutenberg/pull/43204
 
-			$attribute_value = $this->source_block_rich_text( $crawler, $block_attribute_definition );
-		} elseif ( 'html' === $attribute_source ) {
 			$attribute_value = $this->source_block_html( $crawler, $block_attribute_definition );
 		} elseif ( 'text' === $attribute_source ) {
 			$attribute_value = $this->source_block_text( $crawler, $block_attribute_definition );
@@ -552,7 +552,7 @@ protected function source_block_raw( $crawler ) {
 		$attribute_value = null;
 
 		if ( $crawler->count() > 0 ) {
-			$attribute_value = trim( $crawler->html() );
+			$attribute_value = trim( $crawler->outerHtml() );
 		}
 
 		return $attribute_value;

tests/graphql/test-graphql-api.php → tests/graphql/test-graphql-api-v1.php

@@ -7,10 +7,19 @@
 
 namespace WPCOMVIP\BlockDataApi;
 
+use GraphQLRelay\Relay;
+
 /**
  * Tests for the GraphQL API.
  */
-class GraphQLAPITest extends RegistryTestCase {
+class GraphQLAPIV1Test extends RegistryTestCase {
+
+	protected function setUp(): void {
+		parent::setUp();
+
+		// Reset block ID counter before each test
+		Relay::reset();
+	}
 
 	public function test_is_graphql_enabled_true() {
 		$this->assertTrue( apply_filters( 'vip_block_data_api__is_graphql_enabled', true ) );
@@ -175,11 +184,13 @@ public function test_get_blocks_data() {
 			'post_content' => $html,
 		] );
 
-		$blocks_data = GraphQLApi::get_blocks_data( $post );
+		$blocks_data = GraphQLApiV1::get_blocks_data( $post );
 
 		$this->assertEquals( $expected_blocks, $blocks_data );
 	}
 
+	// get_blocks_data() attribute type tests
+
 	public function test_array_data_in_attribute() {
 		$this->register_global_block_with_attributes( 'test/custom-table', [
 			'head' => [
@@ -311,7 +322,7 @@ public function test_array_data_in_attribute() {
 							'isValueJsonEncoded' => true,
 						],
 					],
-					'id'         => '6',
+					'id'         => '1',
 				],
 			],
 		];
@@ -320,7 +331,7 @@ public function test_array_data_in_attribute() {
 			'post_content' => $html,
 		] );
 
-		$blocks_data = GraphQLApi::get_blocks_data( $post );
+		$blocks_data = GraphQLApiV1::get_blocks_data( $post );
 
 		$this->assertEquals( $expected_blocks, $blocks_data );
 	}
@@ -467,7 +478,7 @@ public function test_flatten_inner_blocks() {
 			],
 		];
 
-		$flattened_blocks = GraphQLApi::flatten_inner_blocks( $inner_blocks, '1' );
+		$flattened_blocks = GraphQLApiV1::flatten_inner_blocks( $inner_blocks, '1' );
 
 		$this->assertEquals( $expected_blocks, $flattened_blocks );
 	}