Fix webapi returns variables in JSON using snake case and I need came… #31001

jayankaghosh · 2020-11-20T17:30:40Z

Description (*)

Added objectKeyMap which accepts parameters from di.xml to modify data object keys
We can now modify the keys of any accessor on any class used in the rendering of the REST API, using the following (or similar) snippet in the di.xml of the webapi_rest directory.

<type name="Magento\Framework\Reflection\DataObjectProcessor">
        <arguments>
            <argument name="objectKeyMap" xsi:type="array">
                <item name="Magento\Cms\Api\Data\PageInterface" xsi:type="array"> <!-- Change the accessors keys of this class -->
                    <item name="page_layout" xsi:type="string">PageLayout</item> <!-- page_layout should be shown as PageLayout in the ouput -->
                </item>
            </argument>
        </arguments>
    </type>

Fixed Issues (if relevant)

Fixes webapi returns variables in JSON using snake case and I need camelCase #24681 : webapi returns variables in JSON using snake case and I need camelCase

Manual testing scenarios (*)

Add a di.xml inside webapi_rest directory of any module and inject object key names to it, similar to the following

<type name="Magento\Framework\Reflection\DataObjectProcessor">
        <arguments>
            <argument name="objectKeyMap" xsi:type="array">
                <item name="Magento\Cms\Api\Data\PageInterface" xsi:type="array">
                    <item name="page_layout" xsi:type="string">PageLayout</item>
                </item>
            </argument>
        </arguments>
    </type>

Call the REST API and observe the new keys reflecting.

Contribution checklist (*)

Pull request has a meaningful description of its purpose
All commits are accompanied by meaningful commit messages
All new or changed code is covered with unit/integration tests (if applicable)
All automated tests passed successfully (all builds are green)

…lCase

m2-assistant · 2020-11-20T17:30:43Z

Hi @jayankaghosh. Thank you for your contribution
Here is some useful tips how you can test your changes using Magento test environment.
Add the comment under your pull request to deploy test or vanilla Magento instance:

@magento give me test instance - deploy test instance based on PR changes
@magento give me 2.4-develop instance - deploy vanilla Magento instance

❗ Automated tests can be triggered manually with an appropriate comment:

@magento run all tests - run or re-run all required tests against the PR changes
@magento run <test-build(s)> - run or re-run specific test build(s)
For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

Database Compare
Functional Tests CE
Functional Tests EE,
Functional Tests B2B
Integration Tests
Magento Health Index
Sample Data Tests CE
Sample Data Tests EE
Sample Data Tests B2B
Static Tests
Unit Tests
WebAPI Tests

You can find more information about the builds here

ℹ️ Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

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

⚠️ According to the Magento Contribution requirements, all Pull Requests 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 Pull Requests 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

ihor-sviziev · 2020-11-20T17:49:40Z

@magento run all tests

ihor-sviziev

Hi @jayankaghosh,
In general your changes looks good to me.

Could you make the new method to be private (due to backward compatibility reasons) and cover your changes with any type of automated tests?

lib/internal/Magento/Framework/Reflection/DataObjectProcessor.php

ihor-sviziev · 2020-11-23T14:22:15Z

lib/internal/Magento/Framework/Reflection/DataObjectProcessor.php

@@ -128,7 +136,7 @@ public function buildOutputDataArray($dataObject, $dataObjectType)
                }
            }

-            $outputData[$key] = $value;
+            $outputData[$this->mapObjectKey($key, ltrim($dataObjectType, '\\'))] = $value;


Can we move ltrim inside the mapObjectKey method?

We could. But that wouldn't make any difference to the flow right? The mapObjectKey should only be responsible for mapping the object keys. Which is why I had kept the ltrim (to include any class names with preceding slashes given in the di.xml as well) outside of it

The issue with it that it might not find the correct key, if in the client code we'll not do ltrim.

I don't think I understand. The mapObjectKey can't be called from any other class. It'll just be called from the buildOutputDataArray function, and we have done the ltrim there

Ok. but in case if someone will adjust this code a bit later or will call it in the another method - this issue will appear. It's better to incapsulate this logic inside the method

I see. Okay. In that case I think it's better that we name the function something other than mapObjectKey?

getKeyByObjectType?

Guess that'll work

ihor-sviziev

Hi @jayankaghosh ,
Now the changes looks good to me. Could you cover your changes with some kind of automated test?

aredridel · 2020-11-25T16:33:59Z

Hi @ihor-sviziev I am not affiliated with this PR in any way

ihor-sviziev · 2020-11-25T18:51:22Z

@aredridel , I just pressed wrong nick from the autocomplete. Sorry for disturbing you

ihor-sviziev · 2020-11-25T18:51:40Z

@magento run all tests

jayankaghosh · 2020-11-25T19:53:51Z

Hi @jayankaghosh ,
Now the changes looks good to me. Could you cover your changes with some kind of automated test?

@ihor-sviziev I'm not sure how to proceed with writing the tests for this. Some help would be appreciated

ihor-sviziev · 2020-11-26T04:39:47Z

Hi @engcom-Bravo @engcom-Charlie @engcom-Delta could you help with cover thing this PR with automated tests?

ihor-sviziev · 2021-01-05T09:03:39Z

Maybe @engcom-Hotel @sdzhepa could help?

jayankaghosh · 2021-01-12T13:42:23Z

@ihor-sviziev Guess they've abandoned us 😛

sdzhepa · 2021-02-05T16:23:52Z

Hello @ihor-sviziev @jayankaghosh

Sorry for the late response.

Let me please clarify the situation.
We are working(fix, covering, QA, delivery, etc) and focusing on the Hight Priority(P0-P1-P2) tickets first.
This issue was triaged as Priority: P4 . Currently, we do not have a plan to work on it

xtremevision · 2022-06-27T14:20:09Z

Can this solution be used? Perhaps with an override/plugin?

jayankaghosh · 2022-09-20T14:17:33Z

@sdzhepa When can I expect an update on this?

xtremevision · 2022-09-20T14:24:14Z

@sdzhepa When can I expect an update on this?

Add this in werbapi_rest\di.xml:

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
	<type name="[Vendor]\[Module]\Plugin\DataObjectProcessor">
        <arguments>
            <argument name="objectKeyMap" xsi:type="array">
                <item name="[Vendor]\[Module]\Api\Data\[InterfaceFileWhereVarsAreDeclared]" xsi:type="array">
                    <item name="order_item" xsi:type="string">OrderItem</item>
                    <item name="transaction_id" xsi:type="string">TransactionID</item>
                </item>
            </argument>
        </arguments>
    </type>
</config>

This way you can name your vars as you please.

tuyennn · 2024-10-05T02:59:11Z

@jayankaghosh could I take your pull request to another one with test unit #39237, any problem with you?

jayankaghosh · 2024-10-05T03:34:08Z

@jayankaghosh could I take your pull request to another one with test unit #39237, any problem with you?

No problem man. Please do

engcom-Dash · 2024-11-07T10:43:05Z

Hello @jayankaghosh,

Thanks for the contributions!

Please resolve the conflict so we can proceed with this PR.

Thanks.

tuyennn · 2024-11-13T01:49:11Z

@engcom-Dash @jayankaghosh any problem if we close this and switch to #39237

tuyennn · 2025-01-17T10:40:04Z

@jayankaghosh can you grand me the collaborator access on https://github.com/jayankaghosh/magento2/, I can push my change and follow this pull request

engcom-Charlie · 2025-02-10T11:10:44Z

Hi @jayankaghosh,

Thank you for your contribution!

@tuyennn, as @jayankaghosh aggred to go ahead with your PR here and we didnt get any input on conflict resolution, we are closing this PR now.

@jayankaghosh, please feel free to reopen once done with changes.

tuyennn · 2025-02-10T14:04:16Z

@engcom-Charlie I mean #39237 not this pull request

engcom-Charlie · 2025-02-11T05:38:46Z

@tuyennn you have asked to continue on ##39237 in your comment and as @jayankaghosh is okay to proceed with your request in his comment, I have closed this PR and you can continue on ##39237 further.

Fix webapi returns variables in JSON using snake case and I need came…

6ae193d

…lCase

m2-community-project bot added Priority: P4 No current plan to fix. Fixing can be deferred as a logical part of more important work. Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”. labels Nov 20, 2020

magento-engcom-team added Component: Reflection Release Line: 2.4 labels Nov 20, 2020

m2-community-project bot added the Progress: pending review label Nov 20, 2020

jayankaghosh mentioned this pull request Nov 20, 2020

Fix webapi returns variables in JSON using snake case and I need camelCase #25180

Closed

4 tasks

ihor-sviziev self-assigned this Nov 20, 2020

m2-community-project bot added Progress: review and removed Progress: pending review labels Nov 20, 2020

ihor-sviziev requested changes Nov 23, 2020

View reviewed changes

lib/internal/Magento/Framework/Reflection/DataObjectProcessor.php Outdated Show resolved Hide resolved

m2-community-project bot added Progress: needs update and removed Progress: review labels Nov 23, 2020

ihor-sviziev added Auto-Tests: Not Covered Changes in Pull Request requires coverage by auto-tests Award: bug fix Progress: review and removed Progress: needs update labels Nov 23, 2020

m2-community-project bot added Progress: needs update and removed Progress: review labels Nov 23, 2020

ihor-sviziev added the Progress: review label Nov 23, 2020

m2-community-project bot removed the Progress: needs update label Nov 23, 2020

ihor-sviziev added the Progress: needs update label Nov 23, 2020

m2-community-project bot removed the Progress: review label Nov 23, 2020

ihor-sviziev reviewed Nov 23, 2020

View reviewed changes

m2-community-project bot added Progress: review and removed Progress: needs update labels Nov 23, 2020

ihor-sviziev added the Progress: needs update label Nov 23, 2020

m2-community-project bot removed the Progress: review label Nov 23, 2020

m2-community-project bot added the Progress: review label Nov 24, 2020

jayankaghosh added 2 commits November 24, 2020 20:49

Encapsulate ltrim inside getKeyByObjectType function

f6d4cbe

Encapsulate ltrim inside getKeyByObjectType function

5fef144

ihor-sviziev requested changes Nov 25, 2020

View reviewed changes

m2-community-project bot added Progress: needs update and removed Progress: review labels Nov 25, 2020

ihor-sviziev added the help wanted label Nov 26, 2020

tuyennn mentioned this pull request Oct 4, 2024

Fix #24681 Support camelCase webapi #39237

Open

5 tasks

engcom-Charlie self-assigned this Feb 10, 2025

engcom-Charlie closed this Feb 10, 2025

engcom-Bravo removed this from Pull Requests Dashboard Apr 10, 2025

Fix webapi returns variables in JSON using snake case and I need came… #31001

Fix webapi returns variables in JSON using snake case and I need came… #31001

Uh oh!

Conversation

jayankaghosh commented Nov 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description (*)

Fixed Issues (if relevant)

Manual testing scenarios (*)

Contribution checklist (*)

Uh oh!

m2-assistant bot commented Nov 20, 2020

Uh oh!

ihor-sviziev commented Nov 20, 2020

Uh oh!

ihor-sviziev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ihor-sviziev Nov 23, 2020

Choose a reason for hiding this comment

Uh oh!

jayankaghosh Nov 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ihor-sviziev Nov 24, 2020

Choose a reason for hiding this comment

Uh oh!

jayankaghosh Nov 24, 2020

Choose a reason for hiding this comment

Uh oh!

ihor-sviziev Nov 24, 2020

Choose a reason for hiding this comment

Uh oh!

jayankaghosh Nov 24, 2020

Choose a reason for hiding this comment

Uh oh!

ihor-sviziev Nov 24, 2020

Choose a reason for hiding this comment

Uh oh!

jayankaghosh Nov 24, 2020

Choose a reason for hiding this comment

Uh oh!

ihor-sviziev left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aredridel commented Nov 25, 2020

Uh oh!

ihor-sviziev commented Nov 25, 2020

Uh oh!

ihor-sviziev commented Nov 25, 2020

Uh oh!

jayankaghosh commented Nov 25, 2020

Uh oh!

ihor-sviziev commented Nov 26, 2020

Uh oh!

ihor-sviziev commented Jan 5, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jayankaghosh commented Jan 12, 2021

Uh oh!

sdzhepa commented Feb 5, 2021

Uh oh!

xtremevision commented Jun 27, 2022

Uh oh!

jayankaghosh commented Sep 20, 2022

Uh oh!

xtremevision commented Sep 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tuyennn commented Oct 5, 2024

Uh oh!

jayankaghosh commented Oct 5, 2024

Uh oh!

engcom-Dash commented Nov 7, 2024

Uh oh!

tuyennn commented Nov 13, 2024

Uh oh!

jayankaghosh commented Nov 20, 2020 •

edited

Loading

jayankaghosh Nov 24, 2020 •

edited

Loading

ihor-sviziev left a comment •

edited

Loading

ihor-sviziev commented Jan 5, 2021 •

edited

Loading

xtremevision commented Sep 20, 2022 •

edited

Loading