"Exclude child attributes" doesn't show all attributes

[DuckThom]

Issue Brief

The list of attributes shown in the backend config "Exclude child attributes" does not show all the available product attributes.
This is the default config for this setting:

Magento2TweakwiseExport/etc/config.xml

Line 23 in 1eadf2e

<exclude_child_attributes>url_key,small_image,small_image_label,thumbnail_label,status,tax_class_id,type_id,required_options,visibility</exclude_child_attributes>

However, when a custom config is set, overriding the default line above, visibility (among others) is then duplicated for Bundle and Configurable products.
The "Exclude child attributes" should prevent this, but as visibility is not one of the options in the list, it's not possible to add it back.
This results in certain Bundle/Configurable products being searchable, even when their visibility is set to "Catalog" as one or more child items has "Catalog, Search".

Environment

• PHP Version: 8.1.29
• Magento Version: 2.4.6-p8
• Magento Enterprise: no
• Tweakwise Export Version: v7.1.0
• Magento Deploy Mode: production
• Third party modules: n.a.

Steps to reproduce

1. Install Magento with the export module
2. Check the "Exclude child attributes" setting to see there's no visibility option
3. Select 1 or more attributes in "Exclude child attributes"
4. Export a configurable and/or bundle product with visibility "Catalog" that has 1 or more children with visibility "Catalog, Search" or "Search"
5. Validate the output xml and see multiple visibility options for the confgurable and/or bundle product

Actual result

All visibility options are exported on bundle/configurable products after customizing the "Exclude child attributes" config

        <attribute datatype="numeric">
          <name><![CDATA[visibility]]></name>
          <value>2</value>
        </attribute>
        <attribute datatype="numeric">
          <name><![CDATA[visibility]]></name>
          <value>4</value>
        </attribute>

Expected result

• [] Having the ability to select all (or at least the same as the default config) product attributes in the exclude child attributes config
• [] Visibility is only exported once when custom "Exclude child attributes" is present

[DuckThom]

As a workaround for now, I've copied the config to app/etc/config.php and added the visibility attribute manually to exclude_child_attributes:

            'tweakwise' => [
                'export' => [
                    'exclude_child_attributes' => 'url_key,...,visibility'
                ],

[pmzandbergen]

Related (if you would like to disable child export): #83

[ahuininga-orisha]

@DuckThom

I'm not sure why "visibility" isn't included in the excluded child attributes, but it may be related to how we determine which products/children get exported. I'll discuss this internally to see if we can add "visibility" to the exclusion list for child items.

The reason "visibility" is exported multiple times is due to the way we handle child attributes. If one child has a visibility value of 1 and another has a value of 4, both are exported separately. This applies to all attributes, not just visibility. You will only see a single attribute entry if all child items share the same value.

[DuckThom]

@AH-NET

I'm not sure why "visibility" isn't included in the excluded child attributes, but it may be related to how we determine which products/children get exported. I'll discuss this internally to see if we can add "visibility" to the exclusion list for child items.

I think the main issue is that it's not returned by this function:

Magento2TweakwiseExport/Model/ProductAttributes.php

Line 43 in cfdd81c

public function getAttributesToExport(array $attributeCodes = null): array

The reason "visibility" is exported multiple times is due to the way we handle child attributes. If one child has a visibility value of 1 and another has a value of 4, both are exported separately. This applies to all attributes, not just visibility. You will only see a single attribute entry if all child items share the same value.

Yeah, this part is clear to me but the issue is that once a custom selection for tweakwise/export/exclude_child_attributes is made in the admin panel, visibility is bascially removed from from this config value since it's not part of the multiselect yet it is part of the default value for this config key.

For us, the main problem that this was causing is that there are certain Simple products on our client's catalog that are attached to both a Configurable and a Bundle product. The Configurable product has visibility Catalog, Search and the Bundle only has Catalog. However, because our client made a custom selection for the tweakwise/export/exclude_child_attributes config (which removed visibility from it, as explained above) , it caused both the Configurable and the Bundle to receive the visibility options of the Simple products, causing the Bundle product to also receive the Catalog, Search visibility in Tweakwise.

[ahuininga-orisha]

@DuckThom I'll add this issue to the backlog. We will look into this and see if we can come up with an solution

[iwanzijderveld]

@ahuininga-orisha
Is there any update on this issue?

We just ran into this issue where the result of the query from tweakwise products would indicate that the result has more products than it should.

This is because the exclude_child_attributes didn't have the visibillity attribute, so the export script would export it into the parent product.

For example:
We have a configurable product that is visible in the catalog, but not in the search. The child simple products are visible in the search.
But because the attribute visibillity was not ignored the child value for the visibility attribute was exported into tweakwise for the configurable product. Then when executing a search tweakwise would run a query to determine which products match and returns the configurable product even tho it is not visible. We also cannot disable child attributes in export because we need other attributes to be exported to tweakwise in our configuration.

The \Tweakwise\Magento2TweakwiseExport\Model\ProductAttributes::shouldExportAttribute function prevents the visibillity attribute from being displayed in the multiselect because it doesn't match any of the validations (see code below).

 protected function shouldExportAttribute(Attribute $attribute): bool
    {
        $isBlackListed = $this->isAttributeBlacklisted($attribute);
        return !$isBlackListed &&
            (
                $attribute->getUsedInProductListing() ||
                $attribute->getIsFilterable() ||
                $attribute->getIsFilterableInSearch() ||
                $attribute->getIsSearchable() ||
                $attribute->getIsVisibleInAdvancedSearch() ||
                $attribute->getUsedForSortBy()
            );
    }

I guess the solution would be to only filter out attributes that are user defined.

    protected function shouldExportAttribute(Attribute $attribute): bool
    {
        $isBlackListed = $this->isAttributeBlacklisted($attribute);
        return !$isBlackListed  && 
            (
                $attribute->getUsedInProductListing() ||
                $attribute->getIsFilterable() ||
                $attribute->getIsFilterableInSearch() ||
                $attribute->getIsSearchable() ||
                $attribute->getIsVisibleInAdvancedSearch() ||
                $attribute->getUsedForSortBy() ||
                !$attribute->getIsUserDefined()
            );
    }

[ahuininga-orisha]

@iwanzijderveld I don't have an update for you. This issue is in our backlog, but we currently don't have an indication when we get to it.

Since visibility is also used on the side of tweakwise to filter out products, this needs to be tested properly. I'm not sure if this will work as intended in all cases. For example if children are visible indivdually.

I've this issue has high priority for you, please say so, and i'll check internally if the issue can be higher on the backlog.