Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend complex types #66

Merged
merged 5 commits into from
Jul 26, 2024
Merged

Extend complex types #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
56af143
Encode non-string types as JSON strings
Zamfi99 Jul 10, 2024
64da386
Update tests
Zamfi99 Jul 10, 2024
4ba3a36
Fix block ID state in Relay mock for GraphQL tests
alecgeatches Jul 24, 2024
d9268cc
Add tests for boolean, string, integer, and number type encoding in G…
alecgeatches Jul 24, 2024
a0ce58b
Merge pull request #1 from Automattic/feature/graphql-extend-complex-…
Zamfi99 Jul 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/graphql/graphql-api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,10 +261,10 @@ public static function register_types() {
* @return array
*/
public static function get_block_attribute_pair( $name, $value ) {
// Unknown array types (table cells, for example) are encoded as JSON strings.
// Non-string types (numbers, booleans, arrays, objects, for example) are encoded as JSON strings.
$is_value_json_encoded = false;

if ( ! is_scalar( $value ) ) {
if ( ! is_string( $value ) ) {
$value = wp_json_encode( $value );
$is_value_json_encoded = true;
}
Expand Down
161 changes: 155 additions & 6 deletions tests/graphql/test-graphql-api.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,20 @@

namespace WPCOMVIP\BlockDataApi;

use GraphQLRelay\Relay;

/**
* Tests for the GraphQL API.
*/
class GraphQLAPITest 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 ) );
}
Expand Down Expand Up @@ -104,8 +113,8 @@ public function test_get_blocks_data() {
],
[
'name' => 'dropCap',
'value' => '',
'isValueJsonEncoded' => false,
'value' => 'false',
'isValueJsonEncoded' => true,
],
],
'id' => '1',
Expand All @@ -130,8 +139,8 @@ public function test_get_blocks_data() {
],
[
'name' => 'dropCap',
'value' => '',
'isValueJsonEncoded' => false,
'value' => 'false',
'isValueJsonEncoded' => true,
],
],
'id' => '3',
Expand All @@ -157,7 +166,7 @@ public function test_get_blocks_data() {
[
'name' => 'level',
'value' => '2',
'isValueJsonEncoded' => false,
'isValueJsonEncoded' => true,
],
],
'id' => '5',
Expand All @@ -180,6 +189,8 @@ public function test_get_blocks_data() {
$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' => [
Expand Down Expand Up @@ -311,7 +322,145 @@ public function test_array_data_in_attribute() {
'isValueJsonEncoded' => true,
],
],
'id' => '6',
'id' => '1',
],
],
];

$post = $this->factory()->post->create_and_get( [
'post_content' => $html,
] );

$blocks_data = GraphQLApi::get_blocks_data( $post );

$this->assertEquals( $expected_blocks, $blocks_data );
}

public function test_get_block_data_with_boolean_attributes() {
$this->register_global_block_with_attributes( 'test/toggle-text', [
'isVisible' => [
'type' => 'boolean',
],
'isBordered' => [
'type' => 'boolean',
],
] );

$html = '
<!-- wp:test/toggle-text { "isVisible": true, "isBordered": false } -->
<div>Block</div>
<!-- /wp:test/toggle-text -->
';

$expected_blocks = [
'blocks' => [
[
'id' => '1',
'name' => 'test/toggle-text',
'attributes' => [
[
'name' => 'isVisible',
'value' => 'true',
'isValueJsonEncoded' => true,
],
[
'name' => 'isBordered',
'value' => 'false',
'isValueJsonEncoded' => true,
],
],
],
],
];

$post = $this->factory()->post->create_and_get( [
'post_content' => $html,
] );

$blocks_data = GraphQLApi::get_blocks_data( $post );

$this->assertEquals( $expected_blocks, $blocks_data );
}

public function test_get_block_data_with_number_attributes() {
$this->register_global_block_with_attributes( 'test/gallery-block', [
'tileCount' => [
'type' => 'number',
],
'tileWidthPx' => [
'type' => 'integer', // Same as 'number'
],
'tileOpacity' => [
'type' => 'number',
],
] );

$html = '
<!-- wp:test/gallery-block { "tileCount": 5, "tileWidthPx": 300, "tileOpacity": 0.5 } -->
<div>Gallery</div>
<!-- /wp:test/gallery-block -->
';

$expected_blocks = [
'blocks' => [
[
'id' => '1',
'name' => 'test/gallery-block',
'attributes' => [
[
'name' => 'tileCount',
'value' => '5',
'isValueJsonEncoded' => true,
],
[
'name' => 'tileWidthPx',
'value' => '300',
'isValueJsonEncoded' => true,
],
[
'name' => 'tileOpacity',
'value' => '0.5',
'isValueJsonEncoded' => true,
],
],
],
],
];

$post = $this->factory()->post->create_and_get( [
'post_content' => $html,
] );

$blocks_data = GraphQLApi::get_blocks_data( $post );

$this->assertEquals( $expected_blocks, $blocks_data );
}

public function test_get_block_data_with_string_attribute() {
$this->register_global_block_with_attributes( 'test/custom-block', [
'myComment' => [
'type' => 'string',
],
] );

$html = '
<!-- wp:test/custom-block { "myComment": "great!" } -->
<p>Toggleable text</p>
<!-- /wp:test/custom-block -->
';

$expected_blocks = [
'blocks' => [
[
'id' => '1',
'name' => 'test/custom-block',
'attributes' => [
[
'name' => 'myComment',
'value' => 'great!',
'isValueJsonEncoded' => false, // Strings should not be marked JSON encoded
],
],
],
],
];
Expand Down
4 changes: 4 additions & 0 deletions tests/mocks/graphql-relay-mock.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,8 @@ public static function toGlobalId( $type, $id ) {
++self::$current_id;
return strval( self::$current_id );
}

public static function reset() {
self::$current_id = 0;
}
}
Loading