GraphQl Config (SchemaStiching) does not use LockGuardedCacheLoader (Expensive and large config)

[steven-hoffman-jomashop]

Preconditions and environment

Code on 2.4.8-beta1 shows no use of LockGuardedCacheLoader for GraphQl Config Data.

See GraphQl di.xml
For uses see:

• System.php
• AbstractBlock

This can lead to a 'stampede' type issue for the expensive schema stitching process. By using the LockGuardedCacheLoader, we can prevent this issue when the cache is flushed.

Other notes:

• LockGuardedCacheLoader should consider supporting different setting for allow_parallel_generation per usage.
• Most of the expensive parts of schema stitching can be done with di compile. (And the product/other fields merged in as currently done).

Steps to reproduce

• Clear cache (Or just remove zc:k:{id}_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA)
• Make 10x GraphQl requests at once / in quick succession.

Expected result

GraphQl schema stitching is only loaded once. (Or F times where F is some small fraction of N; this would mitigate against one process failing).

Actual result

GraphQl schema stitching is run once per request.

Additional information

You can see this effect by monitoring Redis

# Local test instance
$ redis-cli MONITOR | grep -i _MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA | cut -c -150
1734554861.066657 [0 10.0.2.2:63558] "hget" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "d"
1734554861.068282 [0 10.0.2.2:63562] "hget" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "d"
1734554861.082297 [0 10.0.2.2:63566] "hget" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "d"
1734554861.135661 [0 10.0.2.2:63572] "hget" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "d"
1734554861.141448 [0 10.0.2.2:63576] "hget" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "d"
1734554861.799215 [0 10.0.2.2:63580] "hget" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "d"
1734554862.930618 [0 10.0.2.2:63576] "hget" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "t"
1734554862.931542 [0 10.0.2.2:63558] "hget" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "t"
1734554862.931873 [0 10.0.2.2:63562] "hget" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "t"
1734554862.932389 [0 10.0.2.2:63572] "hget" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "t"
1734554862.932648 [0 10.0.2.2:63566] "hget" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "t"
1734554862.933038 [0 10.0.2.2:63580] "hget" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "t"
1734554862.955289 [0 10.0.2.2:63576] "hmset" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "d" "{\"Query\":{\"name\":\"Query\",\"ty
1734554862.968716 [0 10.0.2.2:63576] "sadd" "zc:ti:ABCD_CONFIG" "ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA"
1734554862.968721 [0 10.0.2.2:63576] "sadd" "zc:ti:ABCD_MAGE" "ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA"
1734554862.973511 [0 10.0.2.2:63566] "hmset" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "d" "{\"Query\":{\"name\":\"Query\",\"ty
1734554862.987830 [0 10.0.2.2:63566] "sadd" "zc:ti:ABCD_CONFIG" "ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA"
1734554862.987835 [0 10.0.2.2:63566] "sadd" "zc:ti:ABCD_MAGE" "ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA"
1734554862.993475 [0 10.0.2.2:63580] "hmset" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "d" "{\"Query\":{\"name\":\"Query\",\"ty
1734554863.007311 [0 10.0.2.2:63580] "sadd" "zc:ti:ABCD_CONFIG" "ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA"
1734554863.007315 [0 10.0.2.2:63580] "sadd" "zc:ti:ABCD_MAGE" "ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA"
1734554863.011244 [0 10.0.2.2:63572] "hmset" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "d" "{\"Query\":{\"name\":\"Query\",\"ty
1734554863.024044 [0 10.0.2.2:63572] "sadd" "zc:ti:ABCD_CONFIG" "ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA"
1734554863.024048 [0 10.0.2.2:63572] "sadd" "zc:ti:ABCD_MAGE" "ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA"
1734554863.024270 [0 10.0.2.2:63562] "hmset" "zc:k:ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA" "d" "{\"Query\":{\"name\":\"Query\",\"ty
1734554863.036918 [0 10.0.2.2:63562] "sadd" "zc:ti:ABCD_CONFIG" "ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA"
1734554863.036922 [0 10.0.2.2:63562] "sadd" "zc:ti:ABCD_MAGE" "ABCD_MAGENTO_FRAMEWORK_GRAPHQLSCHEMASTITCHING_CONFIG_DATA"

Release note

No response

Triage and priority

• Severity: S0 - Affects critical data or functionality and leaves users without workaround.
• Severity: S1 - Affects critical data or functionality and forces users to employ a workaround.
• Severity: S2 - Affects non-critical data or functionality and forces users to employ a workaround.
• Severity: S3 - Affects non-critical data or functionality and does not force users to employ a workaround.
• Severity: S4 - Affects aesthetics, professional look and feel, “quality” or “usability”.

[m2-assistant]

Hi @steven-hoffman-jomashop. Thank you for your report.
To speed up processing of this issue, make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce.

• For more details, review the Magento Contributor Assistant documentation.
• Add a comment to assign the issue: @magento I am working on this
• To learn more about issue processing workflow, refer to the Code Contributions.

---

Join Magento Community Engineering Slack and ask your questions in #github channel.
⚠️ According to the Magento Contribution requirements, all issues must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.
🕙 You can find the schedule on the Magento Community Calendar page.
📞 The triage of issues happens in the queue order. If you want to speed up the delivery of your contribution, join the Community Contributions Triage session to discuss the appropriate ticket.

[m2-assistant]

Hi @engcom-Hotel. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).
• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue.
• 3. Add Area: XXXXX label to the ticket, indicating the functional areas it may be related to.
• 4. Verify that the issue is reproducible on 2.4-develop branch
  Details

  - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!
• 5. Add label Issue: Confirmed once verification is complete.
• 6. Make sure that automatic system confirms that report has been added to the backlog.

[engcom-Hotel]

Hello @steven-hoffman-jomashop,

Thanks for the report and collaboration!

We have tried to reproduce the issue in the latest development branch i.e. 2.4-develop by adding logger in the below class:

magento2/lib/internal/Magento/Framework/GraphQlSchemaStitching/Common/Reader.php

Lines 37 to 44 in 56463d5

	public function read($scope = null) : array
	{
	$output = [];
	foreach ($this->readers as $reader) {
	$output = array_replace_recursive($output, $reader->read($scope));
	}
	return $output;
	}

We used the below script to send the multiple GraphQL requests:

Curl-PHP Script

$multiCurl = [];
$responses = [];
$mh = curl_multi_init();
for ($i = 0; $i < $totalRequests; $i++) {
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'BASE_URL/graphql');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Accept-Encoding: gzip, deflate, br',
'Content-Type: application/json',
'Accept: application/json',
'Connection: keep-alive',
'Origin: chrome-extension://flnheeellpciglgpaodhkhmapeljopja',
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"query":"{\n products(search: \"Simple 1\", pageSize: 2) {\n total_count\n items {\n name\n sku\n price_range {\n minimum_price {\n regular_price {\n value\n currency\n }\n }\n }\n }\n page_info {\n page_size\n current_page\n }\n }\n}","variables":{}}');

curl_multi_add_handle($mh, $ch);
$multiCurl[$i] = $ch;

}

do {
$status = curl_multi_exec($mh, $active);
if ($active) {
curl_multi_select($mh);
}
} while ($active && $status == CURLM_OK);

foreach ($multiCurl as $i => $ch) {
$responses[$i] = curl_multi_getcontent($ch); // Get the response
curl_multi_remove_handle($mh, $ch); // Remove the handle
curl_close($ch); // Close the handle
}
curl_multi_close($mh);
foreach ($responses as $response) {
print_r($response);
}

As per the script we have sent 100 simultaneous requests and it logs 40 times in the logger file. Are you talking about the same behaviour or please tell us if we have missed anything.

Thanks

[steven-hoffman-jomashop]

@engcom-Hotel,

I think that seems to be an alternative way to reproduce.
(As \Magento\Framework\GraphQlSchemaStitching\GraphQlReader should call into GraphQlSchemaStitching/Common/Reader.php, and as noted above, Reader is the class that caches the result)

As per the script we have sent 100 simultaneous requests and it logs 40 times in the logger file. Are you talking about the same behaviour or please tell us if we have missed anything.

So here we have the GQL schema stitching being performed 40 times for 100 requests. (After a cache flush I assume).
If locked style loading/generation was used here, we would expect 1 (or 2 for safety) hits.

[engcom-Hotel]

Hello @steven-hoffman-jomashop,

Thank you for the confirmation!

We are confirming this issue for further processing. If you have a fix for this issue, we encourage you to create a community PR. We will gladly review and process the PR further.

Thanks