Modified custom_arg message_id for compatibility with SendGrid webhook #109
Conversation
This file contains hidden or 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
medmunds
reviewed
May 24, 2018
anymail/backends/sendgrid.py
Outdated
| # record, we can supply the 'smtp-id' field for any events missing it. | ||
| self.data.setdefault("custom_args", {})["smtp-id"] = self.message_id | ||
| # Set anymail-id to track our custom message ID | ||
| self.data.setdefault("custom_args", {})["anymail-id"] = self.message_id |
There was a problem hiding this comment.
I'd maybe go with "anymail_id" (underscore), to parallel all other webhook data fields. ("smtp-id" is the outlier.)
anymail/webhooks/sendgrid.py
Outdated
| @@ -69,10 +69,12 @@ def esp_to_anymail_event(self, esp_event): | |||
| else: | |||
| metadata = {} | |||
|
|
|||
| anymail_id = esp_event.get('anymail-id', None) | |||
| smtp_id = esp_event.get('smtp-id', None) | |||
There was a problem hiding this comment.
This could be simplified to message_id = esp_event.get('anymail_id', esp_event.get('smtp-id')).
(Use 'anymail_id' if present, else use 'smtp-id' for backwards compatibility.)
|
Updated based on further discussion in #108. Removed a concern for |
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.
Based our discussion in #108.
According to SendGrid support, the
Message-IDandsmtp-idare both used by SendGrid to set their unique message ID. Based on the conversation with SendGrid support we should use a custom arg with a key named something other thanMessage-IDorsmtp-id.Tried to set this up to ensure backwards compatibility for users who upgrade so that the
smtp-idstill gets referenced if theanymail-idis not present in the webhook data.