Graphql Query naming changed in SP18

Customers upgrading their Adobe Experience Manager (AEM) environments to Service Pack 16 or later may encounter changes in the naming conventions of GraphQL queries. This article explores the issue and provides a resolution to help maintain application stability and functionality.

Description description

Environment

Adobe Experience Manager 6.5

Issue/Symptoms

After upgrading to AEM Service Pack 16 or later, a change in the naming convention of GraphQL queries has been observed. For example, queries that were previously named "eXAMPLExTopicByPath" and "eXAMPLExTopicList" in Service Pack 10 would change to "examplexTopicByPath" and "examplexList" in Service Pack 16 and beyond. This alteration can lead to issues in production applications that rely on the original query names, requiring attention and a workaround to prevent application breakdowns.

Resolution resolution

The issue stems from a change in behavior introduced in AEM Service Pack 16. The recommended resolution involves using Apache rewrite rules to redirect the old query paths to the new ones, providing teams with the flexibility to update their endpoints in a managed and scheduled manner. Furthermore, Adobe recommends using the standard out-of-the-box query names as documented in the latest service packs, since the functionality that allowed for customizing the query names was not officially documented and has been corrected. This approach ensures future compatibility and minimizes the risk of similar issues arising from subsequent updates or service packs.