[$175] TaaS-App : Interface for Report an Issue

[nkumar-topcoder]

A pop-up for report an issue button which shall enable email along with issue description to be shared.
Probable Impact on :

• TaaS-API
• TaaS-DB
• TaaS-app

[maxceem]

@nkumar-topcoder I'm not completely aware of possible solutions here in terms of Topcoder infrastructure.

Should we directly call Sendgrid from our TaaS API to send email. Or is there any general Topcoder service that we can use to send email?

[maxceem]

@nkumar-topcoder I've got you clarification in the google sheet on how to use Email Service for this via Kafka event.

It looks clear for me, thanks.

One question. Do I understand this correctly, that we would have a separate template for this teamplate inside SendGrid. So we would have to define its id as ENV variable and send inside Kafka event like sendgrid_template_id: "123e4567-e89b-12d3-a456-426614174000",?

[maxceem]

And another question, should we create the design/template for this email? Or we already have some which we can reuse?

[nkumar-topcoder]

@maxceem yes, this has to be at ENV variable and send to kafka.
The design template is already created & specific to our TaaS Issue reporting, Let me know if any change is required & we can change as needed.

[maxceem]

Sum up:

• The main aim of this task is to implement API to send Issues Report Email from the TaaS App as per UI https://marvelapp.com/prototype/921gg0f/screen/75360462

  • At the moment we could report a general issue for the team
  • or report a particular member

• Create a new endpoint POST /taas-teams/email

• This should be a general endpoint that we can use to send various emails (we already have 2 types)

• To send an email, we have to post a Kafka event using TC BUS API:

   {
       "topic": "external.action.email",
       "mime-type": "application/json",
       "originator": "testing",
       "timestamp": "2020-07-10T16:40:10.017Z",
       "payload": {
           "data": {
               "subject": "Issue Reported on TaaS Team <projectName> (<projectID>).",
               "handle": "pshah_manager", // user who calls the `POST /taas-teams/email` endpoint
               "message": "
                  <userHandle> handle of member reported
                  <Project ID> and <link to TaaS app>
                  <Describe your issue>
                "
           },
           "sendgrid_template_id": "1daf23r-asd3-1232-asfd-asdfsdfsdfsd",
           "version": "v3",
           "recipients": [
               "test@gtest.com"
           ]
       }
   }

  • "topic" should be defined as a constant, like other topics we send from API
  • "sendgrid_template_id" - should be defined in config so we can also define it using ENV var REPORT_ISSUE_SENDGRID_TEMPLATE_ID, it may be different from DEV/PROD
  • "test@gtest.com" - same like "sendgrid_template_id" we should be able to config the email to send via ENV variable REPORT_ISSUE_EMAIL

• Note that as we would like to keep the logic general we have to make everything configurable for example like this.

• The body of this request can have a shape of:

  {
     // required, this would defined which template to use for sending email
     // we would have a config of supported templates, if template is not found, return error
     template: "member-issue-report"
     // this would contain any arbitrary data for the template
     data: {
        projectName: "TaaS Project Name",
        projectId: 12345,
        userHandle: "pshah_manager",
        reportText: "I have issue with ..."   
     }
  }

• And should be able to config various templates like this:

  const EMAIL_TEMPLATES = {
     // we can define many email templates
     "team-issue-report": {
         subject: "Issue Reported on TaaS Team {{projectName}} ({{projectID}}).",
         message: "
             {{projectId}} and {{TAAS_APP_URL}}/{{projectId}}
             {{reportText}}
         ",
         recipients: [
            REPORT_ISSUE_EMAIL
         ],
         sendgridTemplateId: REPORT_ISSUE_SENDGRID_TEMPLATE_ID
     },
     "member-issue-report": {
         subject: "Issue Reported for member {{userHandle}} on TaaS Team {{projectName}} ({{projectID}}).",
         message: "
             {{userHandle}} - handle of member reported
             {{projectId}} and {{TAAS_APP_URL}}/{{projectId}}
             {{reportText}}
         ",
         recipients: [
            REPORT_ISSUE_EMAIL
         ],
         sendgridTemplateId: REPORT_ISSUE_SENDGRID_TEMPLATE_ID
     }
  }

  • we can use https://handlebarsjs.com/ to populate fields of the email template with data from the POST request

• The shape of the template/data is for reference, you may update it as you think is the best. This is to give the idea about how much configurable it should be

• Update Swagger and Postman

[maxceem]

Challenge https://www.topcoder.com/challenges/954f1ad9-c72c-46a6-86fb-1eb7889d6d31 has been created for this ticket.

This is an automated message for maxceem via Topcoder X

[maxceem]

@imcaizheng this is ready for pickup

[maxceem]

Challenge https://www.topcoder.com/challenges/954f1ad9-c72c-46a6-86fb-1eb7889d6d31 has been assigned to aaron2017.

This is an automated message for maxceem via Topcoder X