Page Comparison

...

• When we send emails to users, should we download the body of the email and send it in the email body?  Or should we tell them to visit the portal?

  • It may be difficult to enforce zipping of messages 
  • At the moment, the body of the email == the body of the message.  And files are assumed to be stored as plain text
  Who should be the sender of system notifications or messages?  i.e. If we were to send a password reset email via the messaging system, who should be in the "from" field?
• Should we bootstrap a "synapse@sagebase.org" user to be the default sender of these messages?
Should we use an existing bootstrapped user or group?  i.e. Authenticated_Users or Anonymous  (Neither of these would allow message retrieval later on)


• How should we configure Amazon SES? <<< What can be done using readily available SES tools, dashboards and/or alarms?

  • Proposal:
    • Reroute bounce and complaints to SNS
    • Have a worker disable emails to hard-bounced recipients
    • Also flip flags in settings for complaints
    • Store the bounce/complaint in a blob
• Should users be notified of bounces? <<< Yes, and (1) this is a special case of 'notification', i.e. a Message triggered by a Synapse event, (2) perhaps user can configure email receipt to avoid excessive email from notifications (or other sources)
• Should some messages be stored as templates? <<< The template should be stored as a properties file. Each individual Message should be stored in its final form.  This design choice would change for very very large notification message volumes.
  
  • If we start sending out notifications about Entity changes and the like, most of the contents will be similar except for the ID and some small part of the message body. We could conceivably add a flag to the MessageToUser object that tells the client to fill in a messages according to some simple template.  Then we could store the key-values of the template in a blob (perhaps following the same schema as StringAnnotations) along with the message.  .

• Jira Legacy
  server JIRA (sagebionetworks.jira.com) columns key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution serverId ba6fb084-9827-3160-8067-8ac7470f78b2 key PLFM-1039

   Should notifications of this nature be implemented now or later?
  • Also, if the affected entity has child entities, should those be included in the notification?
• How should we tie Entities to users in terms of notifications?
  • Ownership?  << It might be this.
  • Favorites? << It might be this.
  • Permissions?  << I don't think it's this.
  • Something else?  << It could be a completely new set of services, allowing users to enable/disable notification.  (Could be initialized from Favorites and Owners.)

...

•  Throttle message input 
  • Max 10 creations per minute
  • Max 50 recipients
•  When adding a new person to a conversation, the new person should get the whole history of the conversation
  • Might be implemented by forwarding ALL the previous messages 
  • OR by concatenating all previous into one new message
•  

  Configure Amazon SES

  • Automated proposal:
    • Reroute bounce and complaints to SNS
    • Have a worker subscribe to the topic via SQS
    • Have a worker disable emails to hard-bounced recipients
    • The worker may email a Google Group to notify us of anything it cannot handle
    • Also flip flags in settings for complaints
    • Store the bounce/complaint in a blob 
•  Add methods to send messages according to templates
  • Each individual Message should be stored in its final form.  
  • This design choice would change for very very large notification message volumes.
  • Templates:
    •  Password reset
    •  Welcome
    •  Delivery failure
    •  Entity shared
    •  Entity changed
    •  TBD

...

Message sender (worker)

•  Extend ObjectType to include a "MESSAGE" type
•  Have DBOMessage extend ObservableEntity
•  Send a change message when a message is created
•  Subscribe worker to the repo-changes topic
•  Look for MESSAGE-CREATED changes to process
•  The worker should always check to see if a message has already been sent, so that messages do not get resent every time the stack changes.
•  A message has been sent if there is a recipient.  The worker is in charge of making sure all sent messages have at least one recipient.  In the case where a user sends a message to multiple recipients, all of which are not visible to the user, then the worker should bounce the message back to the user, along with a bounce message.  This ensures the message has a row in the MessageStatus table.   Whenever the message sending worker encounters an error:
  •  Send the sender of the message a notification with the summary of delivery failures
  •  Add CloudWatch metrics to count delivery failures
  •  If the message cannot be sent to anyone, mark the sender as the receiver of the message so that it doesn't get reprocessed (i.e. after migration)
•  Process change of other ObjectTypes (i.e. ENTITY) for notifications
  •  Needs additional state: either a link between ObjectID/Type and messageContent or ObjectID/Type and UserID (to prevent messages from being resent everytime the stack blows away the change messages)

...

Services

• Sorting & Pagination
  •  Sort by creation date
  •  Sort by subject
  •  Sort by recipient name

...