Inventory source item's source_code is case insensitive during insert, but case sensitive during read

[bap14]

Preconditions and environment

• Magento version: 2.4.6-p4

Steps to reproduce

1. Create at least one additional custom stock source

Source Name	Source Code
Warehouse Alpha	warehouse_alpha
Warehouse Bravo	warehouse_bravo

2. Create a new stock associated to the website
3. Associate the custom sources to the new stock
4. Utilizing the API, create an inventory source item

curl 'https://magento-opensource.test/rest/default/V1/inventory/source-items' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--data '{
    "sourceItems": [
        {
            "sku": "24-MB01",
            "source_code": "Warehouse_Bravo",
            "quantity": 5000,
            "status": 1
        }
    ]
}
'

5. Log in to the admin panel
6. Navigate to the catalog products grid

Expected result

The product grid renders

Actual result

An error is displayed:

Warning: Undefined array key "Warehouse_Bravo" in /var/www/html/vendor/magento/module-inventory-catalog-admin-ui/Ui/DataProvider/Product/Listing/Modifier/QuantityPerSource.php on line 142

Additional information

This appears to be because the data in the source_code column is collated to be case insensitive (utf8mb3_general_ci). The data provider for the admin grid loads the source items for the product into an array, keyed by the source_code value. While iterating over the product's source items it looks for the key in the array; however, the source item's source_code value doesn't match the source_code for the inventory source.

The workaround to this is to either delete the offending records, or override the private function to force the comparison to be done in a case-insensitive manner.

Release note

Fixes an issue where using the inventory/source-items API an incorrectly cased source_code value can cause the admin grid to fail to render with error Warning: Undefined array key "<source code>"

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 @bap14. 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. To deploy vanilla Magento instance on our environment, Add a comment to the issue:

• @magento give me 2.4-develop instance - upcoming 2.4.x release
• 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.

[bap14]

@magento give me 2.4-develop instance

[magento-deployment-service]

Hi @bap14. Thank you for your request. I'm working on Magento instance for you.

[magento-deployment-service]

Hi @bap14, here is your Magento Instance: https://b568f0ff472c8c82e3c2c1205da4dd50.instances-prod.magento-community.engineering
Admin access: https://b568f0ff472c8c82e3c2c1205da4dd50.instances-prod.magento-community.engineering/admin_f73b
Login: 8ffbc5b1
Password: ab7b34158141

[bap14]

This is confirmed happening in a fresh instance:

1. Create new stock sources: warehouse_alpha and warehouse_bravo
   
2. Assign sources to a new stock
   
3. Use inventory/source-items API to add an item to an invalidly cased source: Warehouse_Bravo

curl 'https://b568f0ff472c8c82e3c2c1205da4dd50.instances-prod.magento-community.engineering/rest/default/V1/inventory/source-items' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--data '{
    "sourceItems": [
        {
            "sku": "24-MB01",
            "source_code": "Warehouse_Bravo",
            "quantity": 5000,
            "status": 1
        }
    ]
}
'

4. Attempt to load catalog grid
   

[bap14]

The following patch resolves the case sensitivity issue in the erroring part of the code for the admin UI grid. It just lowercases all the array keys, and then uses strtolower to find the matching array key. It was a quick-and-dirty patch to check if it would work.
magento2-38488.patch

[m2-assistant]

Hi @engcom-Bravo. 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

  - 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-Bravo]

@magento give me 2.4-develop instance

[magento-deployment-service]

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

[magento-deployment-service]

Hi @engcom-Bravo, here is your Magento Instance: https://b568f0ff472c8c82e3c2c1205da4dd50.instances-prod.magento-community.engineering
Admin access: https://b568f0ff472c8c82e3c2c1205da4dd50.instances-prod.magento-community.engineering/admin_314b
Login: 17c45ba4
Password: 521b2059e124

[engcom-Bravo]

Hi @bap14,

Thank you for reporting and collaboration.

Verified the issue on Magento 2.4-develop instance and the issue is not reproducible.Kindly refer the screenshots.

Steps to reproduce

1. Create at least one additional custom stock source

Source Name | Source Code -- | -- Warehouse Alpha | warehouse_alpha Warehouse Bravo | warehouse_bravo

2. Create a new stock associated to the website
3. Associate the custom sources to the new stock
4. Utilizing the API, create an inventory source item

curl 'https://magento-opensource.test/rest/default/V1/inventory/source-items' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--data '{
    "sourceItems": [
        {
            "sku": "24-MB01",
            "source_code": "Warehouse_Bravo",
            "quantity": 5000,
            "status": 1
        }
    ]
}
'

5. Log in to the admin panel
6. Navigate to the catalog products grid

We are able to view the products grid.Could you please let us know if we are missing anything.

Thanks.

[bap14]

@magento give me 2.4-develop instance

[magento-deployment-service]

Hi @bap14. Thank you for your request. I'm working on Magento instance for you.

[magento-deployment-service]

Hi @bap14, here is your Magento Instance: https://b568f0ff472c8c82e3c2c1205da4dd50.instances-prod.magento-community.engineering
Admin access: https://b568f0ff472c8c82e3c2c1205da4dd50.instances-prod.magento-community.engineering/admin_eada
Login: 61f8b50c
Password: 2cdc563f461e

[bap14]

I think you're misunderstanding what was happening. The source_code field in the API request was using a capitalized version of a stock source's code. So in your configuration you used "E" and "T" as your source codes in Magento; however, you used "Warehouse_Bravo" as the source_code in the API request.

I've recorded a short video showing the setup and issue. You'll notice I'm using values under the Code column, not the Name column in my API request.

magento2-38488-vid.mp4

[bap14]

@engcom-Bravo So I took another look at your screenshots. The video above is still helpful, but the issue is you didn't mix the casing in your API request. So you created a source with the code warehouse_bravob and then made an API request assigning to warehouse_bravob. The error comes in when the API is used and a wrongly cased source code is used (e.g. Warehouse_BravoB).

[engcom-Bravo]

Hi @bap14,

Thanks for your quick response.

Verified the issue on Magento 2.4-develop instance and the issue is reproducible.Kindly refer the screenshots.

Steps to reproduce

1. Create at least one additional custom stock source

Source Name | Source Code -- | -- Warehouse Alpha | warehouse_alpha Warehouse Bravo | warehouse_bravo

2. Create a new stock associated to the website
3. Associate the custom sources to the new stock
4. Utilizing the API, create an inventory source item

curl 'https://magento-opensource.test/rest/default/V1/inventory/source-items' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--data '{
    "sourceItems": [
        {
            "sku": "24-MB01",
            "source_code": "Warehouse_Bravo",
            "quantity": 5000,
            "status": 1
        }
    ]
}
'

5. Log in to the admin panel
6. Navigate to the catalog products grid

Error got displayed in catalog products grid.

Hence Confirming the issue.

Thanks.

[github-jira-sync-bot]

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

[m2-assistant]

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

[andreifurrnica]

@magento give me 2.4-develop instance

[magento-deployment-service]

Hi @andreifurrnica. Thank you for your request. I'm working on Magento instance for you.

[magento-deployment-service]

Hi @andreifurrnica, here is your Magento Instance: https://b568f0ff472c8c82e3c2c1205da4dd50.instances-prod.magento-community.engineering
Admin access: https://b568f0ff472c8c82e3c2c1205da4dd50.instances-prod.magento-community.engineering/admin_df2e
Login: 03728a77
Password: daed7af876b1

[andreifurrnica]

@magento give me 2.4.6-p3 instance

[magento-deployment-service]

Hi @andreifurrnica. Thank you for your request. I'm working on Magento instance for you.

[magento-deployment-service]

Hi @andreifurrnica, unfortunately there is no ability to deploy Magento instance at the moment. Please try again later.

[heerdt]

@magento give me 2.4.6-p4 instance

[magento-deployment-service]

Hi @heerdt. Thank you for your request. I'm working on Magento instance for you.

[magento-deployment-service]

Hi @heerdt, unfortunately there is no ability to deploy Magento instance at the moment. Please try again later.

[heerdt]

@magento give me 2.4-develop instance

[magento-deployment-service]

Hi @heerdt. Thank you for your request. I'm working on Magento instance for you.

[magento-deployment-service]

Hi @heerdt, here is your Magento Instance: https://b568f0ff472c8c82e3c2c1205da4dd50.instances-prod.magento-community.engineering
Admin access: https://b568f0ff472c8c82e3c2c1205da4dd50.instances-prod.magento-community.engineering/admin_8ec7
Login: 1666bb21
Password: 7ff4e80f7722

[theuargb]

@magento I am working on this

[theuargb]

magento/inventory#3411