Attribute is returned as aggregation in products query even if Use in Search Results Layered Navigation is set to no

[oneserv-heuser]

Preconditions (*)

1. Magento 2.4.2

Steps to reproduce (*)

1. On any attribute set the setting "Use in Search Results Layered Navigation" to no (using price as example here)
2. Execute the following graphql query:

query searchProducts {
    products(search: "") {
        aggregations {
            label
        }
    }
}

Expected result (*)

Actual result (*)

Whats the problem about it (*)

The huge problem is here that if you build filters based on the aggregation field the user will be able to filter the price. But if you try to filter via the price if it's disabled for layered navigation you'll receive the following error:

---

Please provide Severity assessment for the Issue as Reporter. This information will help during Confirmation and Issue triage processes.

• 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 @oneserv-heuser. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

• Summary of the issue
• Information on your environment
• Steps to reproduce
• Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento give me 2.4-develop instance - upcoming 2.4.x release

For more details, please, review the Magento Contributor Assistant documentation.

Please, add a comment to assign the issue: @magento I am working on this

---

• 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, please join the Community Contributions Triage session to discuss the appropriate ticket.

🎥 You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

✏️ Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

[oneserv-heuser]

@magento give me 2.4-develop instance

[magento-deployment-service]

Hi @oneserv-heuser. Thank you for your request. I'm working on Magento instance for you.

[magento-deployment-service]

Hi @oneserv-heuser, here is your Magento Instance: https://b21cb62d5a70b1ae6f2ad997506f84a3-2-4-develop.instances.magento-community.engineering
Admin access: https://b21cb62d5a70b1ae6f2ad997506f84a3-2-4-develop.instances.magento-community.engineering/admin_e715
Login: c5eec167
Password: 38052939e259

[oneserv-heuser]

@magento I can confirm that this issue is reproducible on the vanilla magento instance

[oneserv-heuser]

I just found out that this issue not only exists for the price attribute but for all attributes. Magento ignores the settings in the backend. If you set the setting "Use in Search Results Layered Navigation" to false then the attribute gets returned when asking for the aggregation field but you cannot use it in the field ProdutAttributeFilterInput.

[khrystynastolbova]

@magento I am working on this

[khrystynastolbova]

Hi @oneserv-heuser.
I tested, and Magento really ignores the settings in the backend of the "price" field, but I have no problems with other attributes.

The settings for the "price", "visibility", "category_ids" fields are specifically ignored (in file CatalogGraphQl/Plugin/Search/Request/ConfigReader.php)

/**
     * Generate search request for search products via GraphQL
     *
     * @return array
     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
     */
    private function generateRequest()
    {
        $request = [];
        foreach ($this->getSearchableAttributes() as $attribute) {
            if (\in_array($attribute->getAttributeCode(), ['price', 'visibility', 'category_ids'])) {
                //some fields have special semantics
                continue;
            }
           ...

The price is added separately in the file CatalogGraphQl/etc/graphql/di.xml

    <type name="Magento\CatalogGraphQl\DataProvider\Product\LayeredNavigation\LayerBuilder">
        <arguments>
            <argument name="builders" xsi:type="array">
                <item name="price_bucket" xsi:type="object">Magento\CatalogGraphQl\DataProvider\Product\LayeredNavigation\Builder\Price</item>
                <item name="category_bucket" xsi:type="object">Magento\CatalogGraphQl\DataProvider\Product\LayeredNavigation\Builder\Category</item>
                <item name="attribute_bucket" xsi:type="object">Magento\CatalogGraphQl\DataProvider\Product\LayeredNavigation\Builder\Attribute</item>
            </argument>
        </arguments>
    </type>

[oneserv-heuser]

@khrystynastolbova You're right, it only affects those attributes. I tried it again and my custom attributes are not returned. Maybe that was something cache related back then.

[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).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.4-develop branch

  Details

  - Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
  - 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]

Hi @oneserv-heuser,

Thank you for informing the issue.

The issue is verified and is reproducible on Magento 2.4-develop.

Navigated to Stores->Attributes->Product and I changed ‘Use in Layered Navigation’ to ‘No’ for ‘Price’ Attribute. Below a screenshot of the same:

I tried to run GraphQL product search query but ‘Price’ is still coming in ‘aggregations’ as below:

Magento is ignoring the ‘Price’ and some other settings which are set in Admin Panel. So that is why putting the issue as Confirmed.

Thanks,

[github-jira-sync-bot]

✅ Jira issue https://jira.corp.magento.com/browse/AC-1955 is successfully created for this GitHub issue.

[m2-assistant]

✅ Confirmed by @engcom-Hotel. Thank you for verifying the issue.
Issue Available: @engcom-Hotel, You will be automatically unassigned. Contributors/Maintainers can claim this issue to continue. To reclaim and continue work, reassign the ticket to yourself.

[engcom-Alfa]

Hi @oneserv-heuser ,
Thanks for your reported bug, the internal team has fixed and delivered this issue successfully.
Please find related commits HERE.

Kindly upgrade to the latest Magento version 2.4-develop to retest the case.

In case of any Magento related issues found in 2.4-develop, you may report a new bug with all the information like Preconditions, detailed steps to reproduce, expected and actual Results along with screenshots/ screen recordings.

For any Magento related references, you may refer to the Magento user guide.

Thanks!

[joggienl]

Hopefully someone can respond to this question because I am confused.

Which one of the following settings should be affected by this issue?

The issue seems to be talking about both of them.

Thanks!

[oneserv-heuser]

@joggienl The "Use in Layered Navigation" setting should be affected by this issue.