1404: Dont delete field data on p2b API error #1393
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
holt83
force-pushed
the
1404-p2b-error-handling
branch
3 times, most recently
from
9a69f99
to
99c9972
Compare
kasperg
requested changes
Mar 25, 2019
| // Ensure that both 'synchronize' and 'do_sync' is set and TRUE, before | ||
| // making any requests to p2b API. This is to ensure we don't make lots | ||
| // of unneeded requests when nodes are saved programmatically or updated | ||
| // in bulk via the UI. | ||
| // See ding_place2book_field_widget_form() for more info. | ||
| if ($settings['synchronize'] && !empty($settings['do_sync'])) { | ||
| $items = _ding_place2book_sync_p2b_entities($entity, $settings); | ||
| $synchronized = _ding_place2book_sync_p2b_entities($entity, $settings); |
There was a problem hiding this comment.
This seems odd to me. According to the DocBlock _ding_place2book_sync_p2b_entities returns an array. This change seems to assume that it can be a boolean. Does the DocBlock need updating or are we handling a case where we might get an empty array returned in case on an error?
Could we simplify the change to something like:
$synchronized_items = _ding_place2book_sync_p2b_entities($entity, $settings);
// Only update field data if synchronization was successful.
if (!empty($synchronized_items)) {
$items = $synchronized_items;
}There was a problem hiding this comment.
With your suggestion we don't have to change return value and update docblock, so I think we should go with that. I'll update PR.
| } | ||
| catch (Exception $ex) { | ||
| watchdog_exception('ding_place2book', $ex); | ||
| drupal_set_message($ex->getMessage(), 'error'); | ||
| return $items; | ||
| return FALSE; |
There was a problem hiding this comment.
This seems to indicate that the DocBlock should be updated or that we should just make it explicit that returning an empty array means that no items are sync'ed.
holt83
force-pushed
the
1404-p2b-error-handling
branch
from
99c9972
to
b8f3193
Compare
cableman
approved these changes
Mar 27, 2019
kasperg
approved these changes
Mar 28, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Link to issue
https://platform.dandigbib.org/issues/1404
Description
I discovered this while testing the new integration module on our production database:
If something goes wrong communicating with p2b API when updating existing event that is sync'ed with p2b, the code will override the field data with empty array, destroying the the link between p2b and CMS.
This PR introduces some better handling of these situations.
Screenshot of the result
If your change affects the user interface you should include a screenshot of the result with the pull request.
Checklist