Preventing recursion in custom Magento API
I'm having some issues dealing with recursion in a custom API endpoint I have written for Magento 2.
I have an endpoint that returns an entity which contains a number of fields, one of these fields is related_entities which is an array of entities.
The problem is the code that handles API responses in Magento will iterate over each field in the response, identify their type as defined in the docblocks of the interface and will execute all methods on the entity. This means that if I have Entity A and Entity B and they are related to one another Magento will recursively call getRelated() on each of the children, resulting in an endless cycle (until the configure php stack limit is reached)
I know that strictly speaking the "correct" way to design a REST API should be to really just return the entity requested and provide URLs or IDs for these related entities, however in this case that will massively increase the complexity of the implementation for this.
Currently to combat this I am having to determine if the call is recursive using the Magento registry and some strategically placed $entity->getData() calls.
Are there any other ways to combat this? The other other way I can think of is using something like count(debug_backtrace()) which would result in really messy code.
Any thoughts on this would be greatly appreciated.
magento2 api rest-api interface
edited 5 mins ago
magefms
42713
asked 21 mins ago
CraigCraig
13
add a comment |
I'm having some issues dealing with recursion in a custom API endpoint I have written for Magento 2.
I have an endpoint that returns an entity which contains a number of fields, one of these fields is related_entities which is an array of entities.
The problem is the code that handles API responses in Magento will iterate over each field in the response, identify their type as defined in the docblocks of the interface and will execute all methods on the entity. This means that if I have Entity A and Entity B and they are related to one another Magento will recursively call getRelated() on each of the children, resulting in an endless cycle (until the configure php stack limit is reached)
I know that strictly speaking the "correct" way to design a REST API should be to really just return the entity requested and provide URLs or IDs for these related entities, however in this case that will massively increase the complexity of the implementation for this.
Currently to combat this I am having to determine if the call is recursive using the Magento registry and some strategically placed $entity->getData() calls.
Are there any other ways to combat this? The other other way I can think of is using something like count(debug_backtrace()) which would result in really messy code.
Any thoughts on this would be greatly appreciated.
magento2 api rest-api interface
edited 5 mins ago
magefms
42713
asked 21 mins ago
CraigCraig
13
add a comment |
I'm having some issues dealing with recursion in a custom API endpoint I have written for Magento 2.
I have an endpoint that returns an entity which contains a number of fields, one of these fields is related_entities which is an array of entities.
The problem is the code that handles API responses in Magento will iterate over each field in the response, identify their type as defined in the docblocks of the interface and will execute all methods on the entity. This means that if I have Entity A and Entity B and they are related to one another Magento will recursively call getRelated() on each of the children, resulting in an endless cycle (until the configure php stack limit is reached)
I know that strictly speaking the "correct" way to design a REST API should be to really just return the entity requested and provide URLs or IDs for these related entities, however in this case that will massively increase the complexity of the implementation for this.
Currently to combat this I am having to determine if the call is recursive using the Magento registry and some strategically placed $entity->getData() calls.
Are there any other ways to combat this? The other other way I can think of is using something like count(debug_backtrace()) which would result in really messy code.
Any thoughts on this would be greatly appreciated.
magento2 api rest-api interface
edited 5 mins ago
magefms
42713
asked 21 mins ago
CraigCraig
13
I'm having some issues dealing with recursion in a custom API endpoint I have written for Magento 2.
I have an endpoint that returns an entity which contains a number of fields, one of these fields is related_entities which is an array of entities.
The problem is the code that handles API responses in Magento will iterate over each field in the response, identify their type as defined in the docblocks of the interface and will execute all methods on the entity. This means that if I have Entity A and Entity B and they are related to one another Magento will recursively call getRelated() on each of the children, resulting in an endless cycle (until the configure php stack limit is reached)
I know that strictly speaking the "correct" way to design a REST API should be to really just return the entity requested and provide URLs or IDs for these related entities, however in this case that will massively increase the complexity of the implementation for this.
Currently to combat this I am having to determine if the call is recursive using the Magento registry and some strategically placed $entity->getData() calls.
Are there any other ways to combat this? The other other way I can think of is using something like count(debug_backtrace()) which would result in really messy code.
Any thoughts on this would be greatly appreciated.
magento2 api rest-api interface
magento2 api rest-api interface
edited 5 mins ago
magefms
42713
asked 21 mins ago
CraigCraig
13
edited 5 mins ago
magefms
42713
asked 21 mins ago
CraigCraig
13
edited 5 mins ago
magefms
42713
edited 5 mins ago
magefms
42713
edited 5 mins ago
magefms
42713
42713
asked 21 mins ago
CraigCraig
13
asked 21 mins ago
CraigCraig
13
asked 21 mins ago
CraigCraig
13
13
add a comment |
add a comment |
0
active
oldest
votes
Your Answer
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "479"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: false,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: null,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
var $window = $(window),
onScroll = function(e) {
var $elem = $('.new-login-left'),
docViewTop = $window.scrollTop(),
docViewBottom = docViewTop + $window.height(),
elemTop = $elem.offset().top,
elemBottom = elemTop + $elem.height();
if ((docViewTop elemBottom)) {
StackExchange.using('gps', function() { StackExchange.gps.track('embedded_signup_form.view', { location: 'question_page' }); });
$window.unbind('scroll', onScroll);
}
};
$window.on('scroll', onScroll);
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fmagento.stackexchange.com%2fquestions%2f258017%2fpreventing-recursion-in-custom-magento-api%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
0
active
oldest
votes
0
active
oldest
votes
active
oldest
votes
active
oldest
votes
Thanks for contributing an answer to Magento Stack Exchange!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
var $window = $(window),
onScroll = function(e) {
var $elem = $('.new-login-left'),
docViewTop = $window.scrollTop(),
docViewBottom = docViewTop + $window.height(),
elemTop = $elem.offset().top,
elemBottom = elemTop + $elem.height();
if ((docViewTop elemBottom)) {
StackExchange.using('gps', function() { StackExchange.gps.track('embedded_signup_form.view', { location: 'question_page' }); });
$window.unbind('scroll', onScroll);
}
};
$window.on('scroll', onScroll);
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fmagento.stackexchange.com%2fquestions%2f258017%2fpreventing-recursion-in-custom-magento-api%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
var $window = $(window),
onScroll = function(e) {
var $elem = $('.new-login-left'),
docViewTop = $window.scrollTop(),
docViewBottom = docViewTop + $window.height(),
elemTop = $elem.offset().top,
elemBottom = elemTop + $elem.height();
if ((docViewTop elemBottom)) {
StackExchange.using('gps', function() { StackExchange.gps.track('embedded_signup_form.view', { location: 'question_page' }); });
$window.unbind('scroll', onScroll);
}
};
$window.on('scroll', onScroll);
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
var $window = $(window),
onScroll = function(e) {
var $elem = $('.new-login-left'),
docViewTop = $window.scrollTop(),
docViewBottom = docViewTop + $window.height(),
elemTop = $elem.offset().top,
elemBottom = elemTop + $elem.height();
if ((docViewTop elemBottom)) {
StackExchange.using('gps', function() { StackExchange.gps.track('embedded_signup_form.view', { location: 'question_page' }); });
$window.unbind('scroll', onScroll);
}
};
$window.on('scroll', onScroll);
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
var $window = $(window),
onScroll = function(e) {
var $elem = $('.new-login-left'),
docViewTop = $window.scrollTop(),
docViewBottom = docViewTop + $window.height(),
elemTop = $elem.offset().top,
elemBottom = elemTop + $elem.height();
if ((docViewTop elemBottom)) {
StackExchange.using('gps', function() { StackExchange.gps.track('embedded_signup_form.view', { location: 'question_page' }); });
$window.unbind('scroll', onScroll);
}
};
$window.on('scroll', onScroll);
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
