Don't change 'type' schema

Author: t-hamano

src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

@@ -626,12 +626,21 @@ public function create_item( $request ) {
 			);
 		}
 
+		// Do not allow comments to be created with a non-core type.
+		if ( ! empty( $request['type'] ) && ! in_array( $request['type'], array( 'comment', 'note' ), true ) ) {
+			return new WP_Error(
+				'rest_invalid_comment_type',
+				__( 'Cannot create a comment with that type.', 'gutenberg' ),
+				array( 'status' => 400 )
+			);
+		}
+
 		$prepared_comment = $this->prepare_item_for_database( $request );
 		if ( is_wp_error( $prepared_comment ) ) {
 			return $prepared_comment;
 		}
 
-		$prepared_comment['comment_type'] = $request['type'];
+		$prepared_comment['comment_type'] = empty( $request['type'] ) ? 'comment' : $request['type'];
 
 		if ( ! isset( $prepared_comment['comment_content'] ) ) {
 			$prepared_comment['comment_content'] = '';
@@ -1556,9 +1565,8 @@ public function get_item_schema() {
 				'type'              => array(
 					'description' => __( 'Type of the comment.' ),
 					'type'        => 'string',
-					'enum'        => array( 'comment', 'note' ),
-					'default'     => 'comment',
 					'context'     => array( 'view', 'edit', 'embed' ),
+					'readonly'    => true,
 				),
 			),
 		);

tests/phpunit/tests/rest-api/rest-comments-controller.php

@@ -1699,7 +1699,7 @@ public function test_create_comment_with_invalid_type() {
 		$request->set_body( wp_json_encode( $params ) );
 
 		$response = rest_get_server()->dispatch( $request );
-		$this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+		$this->assertErrorResponse( 'rest_invalid_comment_type', $response, 400 );
 	}
 
 	public function test_create_comment_invalid_email() {
@@ -2716,7 +2716,7 @@ public function test_update_comment_invalid_type() {
 		$request->set_body( wp_json_encode( $params ) );
 
 		$response = rest_get_server()->dispatch( $request );
-		$this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+		$this->assertErrorResponse( 'rest_comment_invalid_type', $response, 404 );
 	}
 
 	public function test_update_comment_with_raw_property() {
@@ -3305,9 +3305,9 @@ public function test_get_item_schema() {
 
 		$this->assertSame( 0, $properties['parent']['default'] );
 		$this->assertSame( 0, $properties['post']['default'] );
-		$this->assertSame( array( 'comment', 'note' ), $properties['type']['enum'] );
 
 		$this->assertTrue( $properties['link']['readonly'] );
+		$this->assertTrue( $properties['type']['readonly'] );
 	}
 
 	public function test_get_item_schema_show_avatar() {
@@ -3792,8 +3792,10 @@ public function test_create_note_status() {
 	 */
 	public function test_cannot_create_with_non_valid_comment_type() {
 		wp_set_current_user( self::$admin_id );
+		$post_id = $this->factory->post->create();
 
 		$params = array(
+			'post'         => $post_id,
 			'author_name'  => 'Ishmael',
 			'author_email' => '[email protected]',
 			'author_url'   => 'https://en.wikipedia.org/wiki/Herman_Melville',
@@ -3807,7 +3809,7 @@ public function test_cannot_create_with_non_valid_comment_type() {
 		$request->set_body( wp_json_encode( $params ) );
 		$response = rest_get_server()->dispatch( $request );
 
-		$this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+		$this->assertErrorResponse( 'rest_invalid_comment_type', $response, 400 );
 	}
 
 	/**