dev: output GRAPHQL_DEBUG message if requested amount > connection limit

justlevine · justlevine · commit 471ca6a3b4a8 · 2024-01-06T06:14:11.000Z
diff --git a/src/Data/Connection/AbstractConnectionResolver.php b/src/Data/Connection/AbstractConnectionResolver.php
@@ -415,8 +415,9 @@ public function get_node_by_id( $id ) {
 	/**
 	 * Get_query_amount
 	 *
-	 * Returns the max between what was requested and what is defined as the $max_query_amount to
-	 * ensure that queries don't exceed unwanted limits when querying data.
+	 * Returns the max between what was requested and what is defined as the $max_query_amount to ensure that queries don't exceed unwanted limits when querying data.
+	 *
+	 * If the amount requested is greater than the max query amount, a debug message will be included in the GraphQL response.
 	 *
 	 * @return int
 	 * @throws \Exception
@@ -438,16 +439,25 @@ public function get_query_amount() {
 		 * @since 0.0.6
 		 */
 		$max_query_amount = apply_filters( 'graphql_connection_max_query_amount', 100, $this->source, $this->args, $this->context, $this->info );
+		
+		$requested_amount = $this->get_amount_requested();
 
-		return min( $max_query_amount, absint( $this->get_amount_requested() ) );
+		if ( $requested_amount > $max_query_amount ) {
+			graphql_debug(
+				sprintf( 'The number of items requested by the connection (%s) exceeds the max query amount. Only the first %s items will be returned.', $requested_amount, $max_query_amount ),
+				[ 'connection' => static::class ]
+			);
+		}
+
+		return min( $max_query_amount, $requested_amount );
 	}
 
 	/**
 	 * Get_amount_requested
 	 *
 	 * This checks the $args to determine the amount requested, and if
 	 *
-	 * @return int|null
+	 * @return int
 	 * @throws \GraphQL\Error\UserError If there is an issue with the pagination $args.
 	 */
 	public function get_amount_requested() {
@@ -495,7 +505,7 @@ public function get_amount_requested() {
 		 * @param int                        $amount   the requested amount
 		 * @param \WPGraphQL\Data\Connection\AbstractConnectionResolver $resolver Instance of the connection resolver class
 		 */
-		return max( 0, apply_filters( 'graphql_connection_amount_requested', $amount_requested, $this ) );
+		return (int) max( 0, apply_filters( 'graphql_connection_amount_requested', $amount_requested, $this ) );
 	}
 
 	/**
diff --git a/tests/wpunit/PostObjectConnectionQueriesTest.php b/tests/wpunit/PostObjectConnectionQueriesTest.php
@@ -195,6 +195,7 @@ static function () {
 
 		$this->assertCount( 20, $actual['data']['posts']['edges'] );
 		$this->assertTrue( $actual['data']['posts']['pageInfo']['hasNextPage'] );
+		$this->assertStringContainsString( 'The number of items requested by the connection (150) exceeds the max query amount.', $actual['extensions']['debug'][0]['message'] );
 	}
 
 	/**

Original file line number	Diff line number	Diff line change
`@@ -195,6 +195,7 @@ static function () {`
`195`	`195`
`196`	`196`	`$this->assertCount( 20, $actual['data']['posts']['edges'] );`
`197`	`197`	`$this->assertTrue( $actual['data']['posts']['pageInfo']['hasNextPage'] );`
	`198`	`+ $this->assertStringContainsString( 'The number of items requested by the connection (150) exceeds the max query amount.', $actual['extensions']['debug'][0]['message'] );`
`198`	`199`	`}`
`199`	`200`
`200`	`201`	`/**`