Merge pull request #5813 from magento-engcom/banned-words-plus-asset-fields

[Magento Community Engineering] Forwardporting required changes from 2.4.0

Author: lenaorobei

app/code/Magento/Catalog/Model/FilterProductCustomAttribute.php

@@ -8,21 +8,21 @@
 namespace Magento\Catalog\Model;
 
 /**
- * Filter custom attributes for product using the blacklist
+ * Filter custom attributes for product using the excluded list
  */
 class FilterProductCustomAttribute
 {
     /**
      * @var array
      */
-    private $blackList;
+    private $excludedList;
 
     /**
-     * @param array $blackList
+     * @param array $excludedList
      */
-    public function __construct(array $blackList = [])
+    public function __construct(array $excludedList = [])
     {
-        $this->blackList = $blackList;
+        $this->excludedList = $excludedList;
     }
 
     /**
@@ -33,6 +33,6 @@ public function __construct(array $blackList = [])
      */
     public function execute(array $attributes): array
     {
-        return array_diff_key($attributes, array_flip($this->blackList));
+        return array_diff_key($attributes, array_flip($this->excludedList));
     }
 }

app/code/Magento/CatalogInventory/etc/di.xml

@@ -37,7 +37,7 @@
     </type>
     <type name="Magento\Catalog\Model\FilterProductCustomAttribute">
         <arguments>
-            <argument name="blackList" xsi:type="array">
+            <argument name="excludedList" xsi:type="array">
                 <item name="quantity_and_stock_status" xsi:type="string">quantity_and_stock_status</item>
             </argument>
         </arguments>

app/code/Magento/Eav/Model/Validator/Attribute/Data.php

@@ -23,12 +23,12 @@ class Data extends \Magento\Framework\Validator\AbstractValidator
     /**
      * @var array
      */
-    protected $_attributesWhiteList = [];
+    protected $allowedAttributesList = [];
 
     /**
      * @var array
      */
-    protected $_attributesBlackList = [];
+    protected $deniedAttributesList = [];
 
     /**
      * @var array
@@ -68,9 +68,9 @@ public function setAttributes(array $attributes)
      * @param array $attributesCodes
      * @return $this
      */
-    public function setAttributesWhiteList(array $attributesCodes)
+    public function setAllowedAttributesList(array $attributesCodes)
     {
-        $this->_attributesWhiteList = $attributesCodes;
+        $this->allowedAttributesList = $attributesCodes;
         return $this;
     }
 
@@ -82,9 +82,9 @@ public function setAttributesWhiteList(array $attributesCodes)
      * @param array $attributesCodes
      * @return $this
      */
-    public function setAttributesBlackList(array $attributesCodes)
+    public function setDeniedAttributesList(array $attributesCodes)
     {
-        $this->_attributesBlackList = $attributesCodes;
+        $this->deniedAttributesList = $attributesCodes;
         return $this;
     }
 
@@ -171,11 +171,11 @@ protected function _getAttributes($entity)
             $attributesCodes[] = $attributeCode;
         }
 
-        $ignoreAttributes = $this->_attributesBlackList;
-        if ($this->_attributesWhiteList) {
+        $ignoreAttributes = $this->deniedAttributesList;
+        if ($this->allowedAttributesList) {
             $ignoreAttributes = array_merge(
                 $ignoreAttributes,
-                array_diff($attributesCodes, $this->_attributesWhiteList)
+                array_diff($attributesCodes, $this->allowedAttributesList)
             );
         }
 

app/code/Magento/Eav/Test/Unit/Model/Validator/Attribute/DataTest.php

@@ -249,10 +249,10 @@ public function testIsValidAttributesFromCollection()
     }
 
     /**
-     * @dataProvider whiteBlackListProvider
+     * @dataProvider allowDenyListProvider
      * @param callable $callback
      */
-    public function testIsValidBlackListWhiteListChecks($callback)
+    public function testIsValidExclusionInclusionListChecks($callback)
     {
         $attribute = $this->_getAttributeMock(
             [
@@ -302,19 +302,19 @@ public function testIsValidBlackListWhiteListChecks($callback)
     /**
      * @return array
      */
-    public function whiteBlackListProvider()
+    public function allowDenyListProvider()
     {
-        $whiteCallback = function ($validator) {
-            $validator->setAttributesWhiteList(['attribute']);
+        $allowedCallbackList = function ($validator) {
+            $validator->setAllowedAttributesList(['attribute']);
         };
 
-        $blackCallback = function ($validator) {
-            $validator->setAttributesBlackList(['attribute2']);
+        $deniedCallbackList = function ($validator) {
+            $validator->setDeniedAttributesList(['attribute2']);
         };
-        return ['white_list' => [$whiteCallback], 'black_list' => [$blackCallback]];
+        return ['allowed' => [$allowedCallbackList], 'denied' => [$deniedCallbackList]];
     }
 
-    public function testSetAttributesWhiteList()
+    public function testSetAttributesAllowedList()
     {
         $this->markTestSkipped('Skipped in #27500 due to testing protected/private methods and properties');
 
@@ -328,12 +328,14 @@ public function testSetAttributesWhiteList()
             )
             ->getMock();
         $validator = new Data($attrDataFactory);
-        $result = $validator->setAttributesWhiteList($attributes);
-        $this->assertAttributeEquals($attributes, '_attributesWhiteList', $validator);
+        $result = $validator->setIncludedAttributesList($attributes);
+
+        // phpstan:ignore
+        $this->assertAttributeEquals($attributes, '_attributesAllowed', $validator);
         $this->assertEquals($validator, $result);
     }
 
-    public function testSetAttributesBlackList()
+    public function testSetAttributesDeniedList()
     {
         $this->markTestSkipped('Skipped in #27500 due to testing protected/private methods and properties');
 
@@ -347,8 +349,9 @@ public function testSetAttributesBlackList()
             )
             ->getMock();
         $validator = new Data($attrDataFactory);
-        $result = $validator->setAttributesBlackList($attributes);
-        $this->assertAttributeEquals($attributes, '_attributesBlackList', $validator);
+        $result = $validator->setDeniedAttributesList($attributes);
+        // phpstan:ignore
+        $this->assertAttributeEquals($attributes, '_attributesDenied', $validator);
         $this->assertEquals($validator, $result);
     }
 

app/code/Magento/Elasticsearch/etc/di.xml

@@ -537,7 +537,7 @@
     </type>
     <type name="Magento\Search\Model\SearchEngine\Validator">
         <arguments>
-            <argument name="engineBlacklist" xsi:type="array">
+            <argument name="excludedEngineList" xsi:type="array">
                 <item name="elasticsearch" xsi:type="string">Elasticsearch 2</item>
             </argument>
             <argument name="engineValidators" xsi:type="array">

app/code/Magento/Fedex/etc/wsdl/RateService_v10.wsdl

@@ -472,7 +472,7 @@
       <xs:complexType name="Commodity">
         <xs:annotation>
           <xs:documentation>
-            For international multiple piece shipments, commodity information must be passed in the Master and on each child transaction.
+            For international multiple piece shipments, commodity information must be passed in the Main and on each child transaction.
             If this shipment contains more than four commodity line items, the four highest valued should be included in the first 4 occurrences for this request.
           </xs:documentation>
         </xs:annotation>
@@ -983,7 +983,7 @@
           </xs:element>
           <xs:element name="CustomsValue" type="ns:Money" minOccurs="0">
             <xs:annotation>
-              <xs:documentation>The total customs value for the shipment. This total will rrepresent th esum of the values of all commodities, and may include freight, miscellaneous, and insurance charges. Must contain 2 explicit decimal positions with a max length of 17 including the decimal. For Express International MPS, the Total Customs Value is in the master transaction and all child transactions</xs:documentation>
+              <xs:documentation>The total customs value for the shipment. This total will rrepresent th esum of the values of all commodities, and may include freight, miscellaneous, and insurance charges. Must contain 2 explicit decimal positions with a max length of 17 including the decimal. For Express International MPS, the Total Customs Value is in the main transaction and all child transactions</xs:documentation>
             </xs:annotation>
           </xs:element>
           <xs:element name="FreightOnValue" type="ns:FreightOnValueType" minOccurs="0">
@@ -1005,7 +1005,7 @@
           <xs:element name="Commodities" type="ns:Commodity" minOccurs="0" maxOccurs="99">
             <xs:annotation>
               <xs:documentation>
-                For international multiple piece shipments, commodity information must be passed in the Master and on each child transaction.
+                For international multiple piece shipments, commodity information must be passed in the Main and on each child transaction.
                 If this shipment contains more than four commodity line items, the four highest valued should be included in the first 4 occurrences for this request.
               </xs:documentation>
             </xs:annotation>
@@ -4867,4 +4867,4 @@
       <s1:address location="https://wsbeta.fedex.com:443/web-services/rate"/>
     </port>
   </service>
-</definitions>
+</definitions>

app/code/Magento/Fedex/etc/wsdl/RateService_v9.wsdl

@@ -471,7 +471,7 @@
       <xs:complexType name="Commodity">
         <xs:annotation>
           <xs:documentation>
-            For international multiple piece shipments, commodity information must be passed in the Master and on each child transaction.
+            For international multiple piece shipments, commodity information must be passed in the Main and on each child transaction.
             If this shipment commitment more than four commodity line items, the four highest valued should be included in the first 4 occurrences for this request.
           </xs:documentation>
         </xs:annotation>
@@ -983,7 +983,7 @@
           </xs:element>
           <xs:element name="CustomsValue" type="ns:Money" minOccurs="0">
             <xs:annotation>
-              <xs:documentation>The total customs value for the shipment. This total will rrepresent th esum of the values of all commodities, and may include freight, miscellaneous, and insurance charges. Must contain 2 explicit decimal positions with a max length of 17 including the decimal. For Express International MPS, the Total Customs Value is in the master transaction and all child transactions</xs:documentation>
+              <xs:documentation>The total customs value for the shipment. This total will rrepresent th esum of the values of all commodities, and may include freight, miscellaneous, and insurance charges. Must contain 2 explicit decimal positions with a max length of 17 including the decimal. For Express International MPS, the Total Customs Value is in the main transaction and all child transactions</xs:documentation>
             </xs:annotation>
           </xs:element>
           <xs:element name="FreightOnValue" type="ns:FreightOnValueType" minOccurs="0">
@@ -1005,7 +1005,7 @@
           <xs:element name="Commodities" type="ns:Commodity" minOccurs="0" maxOccurs="99">
             <xs:annotation>
               <xs:documentation>
-                For international multiple piece shipments, commodity information must be passed in the Master and on each child transaction.
+                For international multiple piece shipments, commodity information must be passed in the Main and on each child transaction.
                 If this shipment contains more than four commodity line items, the four highest valued should be included in the first 4 occurrences for this request.
               </xs:documentation>
             </xs:annotation>

app/code/Magento/Fedex/etc/wsdl/ShipService_v10.wsdl

@@ -497,7 +497,7 @@
       <xs:complexType name="Commodity">
         <xs:annotation>
           <xs:documentation>
-            For international multiple piece shipments, commodity information must be passed in the Master and on each child transaction.
+            For international multiple piece shipments, commodity information must be passed in the Main and on each child transaction.
             If this shipment contains more than four commodity line items, the four highest valued should be included in the first 4 occurrences for this request.
           </xs:documentation>
         </xs:annotation>
@@ -724,7 +724,7 @@
           </xs:element>
           <xs:element name="MasterTrackingId" type="ns:TrackingId" minOccurs="0">
             <xs:annotation>
-              <xs:documentation>The master tracking number and form id of this multiple piece shipment. This information is to be provided for each subsequent of a multiple piece shipment.</xs:documentation>
+              <xs:documentation>The main tracking number and form id of this multiple piece shipment. This information is to be provided for each subsequent of a multiple piece shipment.</xs:documentation>
             </xs:annotation>
           </xs:element>
           <xs:element name="ServiceTypeDescription" type="xs:string" minOccurs="0">

app/code/Magento/Fedex/etc/wsdl/ShipService_v9.wsdl

@@ -497,7 +497,7 @@
       <xs:complexType name="Commodity">
         <xs:annotation>
           <xs:documentation>
-            For international multiple piece shipments, commodity information must be passed in the Master and on each child transaction.
+            For international multiple piece shipments, commodity information must be passed in the Main and on each child transaction.
             If this shipment contains more than four commodity line items, the four highest valued should be included in the first 4 occurrences for this request.
           </xs:documentation>
         </xs:annotation>
@@ -724,7 +724,7 @@
           </xs:element>
           <xs:element name="MasterTrackingId" type="ns:TrackingId" minOccurs="0">
             <xs:annotation>
-              <xs:documentation>The master tracking number and form id of this multiple piece shipment. This information is to be provided for each subsequent of a multiple piece shipment.</xs:documentation>
+              <xs:documentation>The main tracking number and form id of this multiple piece shipment. This information is to be provided for each subsequent of a multiple piece shipment.</xs:documentation>
             </xs:annotation>
           </xs:element>
           <xs:element name="ServiceTypeDescription" type="xs:string" minOccurs="0">

app/code/Magento/ImportExport/Model/Import/AbstractEntity.php

@@ -15,6 +15,7 @@
 /**
  * Import entity abstract model
  *
+ * phpcs:disable Magento2.Classes.AbstractApi
  * @api
  *
  * @SuppressWarnings(PHPMD.TooManyFields)
@@ -335,6 +336,8 @@ public function __construct(
     }
 
     /**
+     * Returns Error aggregator
+     *
      * @return ProcessingErrorAggregatorInterface
      */
     public function getErrorAggregator()
@@ -413,7 +416,7 @@ protected function _saveValidatedBunches()
 
         $source->rewind();
         $this->_dataSourceModel->cleanBunches();
-        $masterAttributeCode = $this->getMasterAttributeCode();
+        $mainAttributeCode = $this->getMasterAttributeCode();
 
         while ($source->valid() || count($bunchRows) || isset($entityGroup)) {
             if ($startNewBunch || !$source->valid()) {
@@ -453,7 +456,7 @@ protected function _saveValidatedBunches()
                     continue;
                 }
 
-                if (isset($rowData[$masterAttributeCode]) && trim($rowData[$masterAttributeCode])) {
+                if (isset($rowData[$mainAttributeCode]) && trim($rowData[$mainAttributeCode])) {
                     /* Add entity group that passed validation to bunch */
                     if (isset($entityGroup)) {
                         foreach ($entityGroup as $key => $value) {
@@ -590,6 +593,7 @@ public function getBehavior(array $rowData = null)
      * Get default import behavior
      *
      * @return string
+     * phpcs:disable Magento2.Functions.StaticFunction
      */
     public static function getDefaultBehavior()
     {
@@ -652,7 +656,9 @@ public function isAttributeParticular($attributeCode)
     }
 
     /**
-     * @return string the master attribute code to use in an import
+     * Returns the master attribute code to use in an import
+     *
+     * @return string
      */
     public function getMasterAttributeCode()
     {