Note "Subject" is not optional for SNS messages #315
Conversation
Since 4.13.0. Specifically because of https://github.com/mapbox/ecs-watchbot/pull/279/files#diff-cb88e96d819797caf0f16e3e34843499R43.
| @@ -27,7 +27,8 @@ | |||
|
|
|||
| ### 4.13.0 | |||
|
|
|||
| - Adds support for first-in-first-out (FIFO) SQS queues. https://github.com/mapbox/ecs-watchbot/pull/279 | |||
| - Adds support for first-in-first-out (FIFO) SQS queues. https://github.com/mapbox/ecs-watchbot/pull/279. | |||
| - SNS message objects are required to have both a "Message" and a "Subject" property. Previously, "Subject" was optional. | |||
There was a problem hiding this comment.
Could you link to the issue ticket here? This wording sounds like it was an intentional change, but in fact it was a regression.
There was a problem hiding this comment.
Just so I understand, subjects used to be required, a regression was introduced at some point and it was fixed at version 4.13.0?
There was a problem hiding this comment.
No. Subject used to be optional. Now they are required, i.e. the regression is that we accidentally introduced this requirement. More details at #304.
There was a problem hiding this comment.
@vsmart the Travis errors were transient, I re-ran the builds and all is green.
Point taken about this being more of a regression. I don't usually edit my own change logs to retroactively note regressions introduced, only their fixes. Feel free to close this, though I would love to see some action. 3 different Mapbox projects stumbled over this.
Me and my team are fine about Subject being required, by the way. We went without them originally because we didn't know any better.
There was a problem hiding this comment.
I wonder if there's an appropriate place to capture this in the repo documentation. I fear only mentioning this in the changelog might still be a bit buried.
Perhaps either a note about message format in the README (could crib some of the wording from #279?) or in the "Worker Runtime Environment" doc?
Since 4.13.0. Specifically because of https://github.com/mapbox/ecs-watchbot/pull/279/files#diff-cb88e96d819797caf0f16e3e34843499R43.
Related to https://github.com/mapbox/pxm/issues/1345, #304.