Upgrade tc-email-service and logs

.eslintrc.js

@@ -0,0 +1,9 @@
+module.exports = {
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "env": {
+      "node": true,
+      "es2021": true
+    }
+  }
+}

.gitignore

@@ -1,2 +1,3 @@
 node_modules
 .env
+log.txt

Dockerfile

@@ -2,7 +2,8 @@
 # and runs it against the specified Topcoder backend (development or
 # production) when container is executed.
 
-FROM node:8.2.1
+
+FROM node:16.17
 LABEL app="tc email" version="1.1"
 
 WORKDIR /opt/app

config/default.js

@@ -1,13 +1,15 @@
 /**
  * The configuration file.
  */
+require('dotenv').config()
 module.exports = {
   LOG_LEVEL: process.env.LOG_LEVEL,
   PORT: process.env.PORT,
   AUTH_SECRET: process.env.AUTH_SECRET,
   DATABASE_URL: process.env.DATABASE_URL,
   DATABASE_OPTIONS: {
     dialect: 'postgres',
+    logging: false,
     dialectOptions: {
       ssl: process.env.DATABASE_SSL != null,
     },
@@ -34,18 +36,21 @@ module.exports = {
   TEMPLATE_MAP: process.env.TEMPLATE_MAP,
   SENDGRID_API_KEY: process.env.SENDGRID_API_KEY || '',
   EMAIL_FROM: process.env.EMAIL_FROM || 'no-reply@topcoder.com',
-  
+
   // temporary not in use feature
   EMAIL_MAX_ERRORS: process.env.EMAIL_MAX_ERRORS || 2,
   EMAIL_PAUSE_TIME: process.env.EMAIL_PAUSE_TIME || 30,
 
   //in every 2 minutes will retry for failed status
   EMAIL_RETRY_SCHEDULE: process.env.EMAIL_RETRY_SCHEDULE || '0 */2 * * * *',
   //wont't retry failed emails older than this time (msec)
-  EMAIL_RETRY_MAX_AGE: process.env.EMAIL_RETRY_MAX_AGE || 1000*60*60*24,
+  EMAIL_RETRY_MAX_AGE: process.env.EMAIL_RETRY_MAX_AGE || 1000 * 60 * 60 * 24,
 
   API_CONTEXT_PATH: process.env.API_CONTEXT_PATH || '/v5/email',
 
   PAYLOAD_SENDGRID_TEMPLATE_KEY: process.env.PAYLOAD_SENDGRID_TEMPLATE_KEY || 'sendgrid_template_id',
-
+  //Tracing information
+  APM_OTLP_TRACE_EXPORTER_URL: process.env.APM_OTLP_TRACE_EXPORTER_URL || '',
+  APM_SERVICE_NAME: process.env.APM_SERVICE_NAME || 'tc-email-service-svc',
+  APM_TRACER_NAME: process.env.APM_TRACER_NAME || 'tc-email-service-svc',
 };

connect/connectEmailServer.js

@@ -1,10 +1,6 @@
 /**
  * This is TopCoder connect email server.
  */
-'use strict';
-
-global.Promise = require('bluebird');
-
 const _ = require('lodash');
 const config = require('config');
 const emailServer = require('../index');
@@ -13,27 +9,27 @@ const logger = require('../src/common/logger');
 
 // set configuration for the server, see ../config/default.js for available config parameters
 // setConfig should be called before initDatabase and start functions
-emailServer.setConfig({ LOG_LEVEL: 'debug' });
+emailServer.setConfig({ LOG_LEVEL: config.LOG_LEVEL });
 
 // add topic handlers,
 // handler is used build a notification list for a message of a topic,
-// it is defined as: function(topic, message, callback),
+// it is defined as: function(topic, message),
 // the topic is topic name,
 // the message is JSON event message,
-// the callback is function(error, templateId), where templateId is the used SendGrid template id
-const handler = (topic, message, callback) => {
+const handler = async (topic, message) => {
   let templateId = config.TEMPLATE_MAP[topic];
   templateId = _.get(message, config.PAYLOAD_SENDGRID_TEMPLATE_KEY, templateId);
   if (!templateId) {
-    return callback(null, { success: false, error: `Template not found for topic ${topic}` });
+    return { success: false, error: `Template not found for topic ${topic}` };
   }
 
-    service.sendEmail(templateId, message).then(() => {
-      callback(null, { success: true });
-    }).catch((err) => {
-      logger.error("Error occurred in sendgrid api calling:", err);
-      callback(null, { success: false, error: err });
-    });
+  try {
+    await service.sendEmail(templateId, message)
+    return { success: true };
+  } catch (err) {
+    logger.error("Error occurred in sendgrid api calling:", err);
+    return { success: false, error: err };
+  }
 
 };
 
@@ -45,8 +41,15 @@ _.keys(config.TEMPLATE_MAP).forEach((eventType) => {
 // init database, it will clear and re-create all tables
 emailServer
   .initDatabase()
-  .then(() => emailServer.start())
-  .catch((e) => console.log(e)); // eslint-disable-line no-console
+  .then(() => {
+    logger.info('Database initialized successfully.')
+
+    emailServer.start()
+  })
+  .catch((e) => {
+    logger.error('Error occurred in starting email server:', e);
+    process.exit(1);
+  }); // eslint-disable-line no-console
 
 // if no need to init database, then directly start the server:
-// emailServer.start();
+// emailServer.start()

connect/service.js

@@ -1,37 +1,44 @@
 /**
  * This is TopCoder connect email service.
  */
-'use strict';
 
 const sgMail = require('@sendgrid/mail');
 const config = require('config');
+const logger = require('../src/common/logger');
 
 // set api key for SendGrid email client
 sgMail.setApiKey(config.SENDGRID_API_KEY);
 
-const sendEmail = (templateId, message) => { // send email
-
+const sendEmail = async (templateId, message) => { // send email
+  const span = await logger.startSpan('sendEmail');
+  let msg = {}
   const from = message.from ? message.from : config.EMAIL_FROM;
   const replyTo = message.replyTo ? message.replyTo : config.EMAIL_FROM;
-  const substitutions = message.data ;
-  const categories = message.categories ? message.categories: [];
+  const substitutions = message.data;
+  const categories = message.categories ? message.categories : [];
   const to = message.recipients;
-  const cc =  message.cc ? message.cc : [];
+  const cc = message.cc ? message.cc : [];
   const bcc = message.bcc ? message.bcc : [];
-
-  if (message.version && message.version=="v3"){
-    return  sgMail.send({
+  const sendAt = message.sendAt ? message.sendAt : undefined;
+  const personalizations = message.personalizations ? message.personalizations : undefined
+  const attachments = message.attachments ? message.attachments : [];
+
+  if (message.version && message.version == "v3") {
+    msg = {
       to,
       templateId,
       dynamicTemplateData: substitutions,
+      personalizations,
       from,
       replyTo,
       categories,
       cc,
       bcc,
-    });
-  } else{
-    return  sgMail.send({
+      attachments,
+      sendAt
+    };
+  } else {
+    msg = {
       to,
       templateId,
       substitutions,
@@ -41,9 +48,22 @@ const sendEmail = (templateId, message) => { // send email
       categories,
       cc,
       bcc,
-    });
+    };
+  }
+  logger.info(`Sending email with templateId: ${templateId} and message: ${JSON.stringify(msg)}`);
+  try {
+    await logger.endSpan(span);
+    const sgSpan = await logger.startSpan('sendgrid');
+    const result = await sgMail.send(msg)
+    await logger.endSpan(sgSpan);
+    logger.info(`Email sent successfully with result: ${JSON.stringify(result)} \n ${JSON.stringify(msg)}`);
+    return result
+  } catch (err) {
+    logger.error(`Error occurred in sendgrid api calling: ${err}`);
+    throw err
   }
 }
 module.exports = {
   sendEmail,
 }
+logger.buildService(module.exports)

docs/swagger_api.yaml

@@ -4,9 +4,9 @@ info:
   description: "TOPCODER EMAIL SERIES - EMAIL SERVER"
   version: "1.0.0"
 host: "localhost:6100"
-basePath : "/v5/email"
+basePath: "/v5/email"
 schemes:
-- "https"
+  - "https"
 securityDefinitions:
   jwt:
     type: apiKey
@@ -17,8 +17,7 @@ securityDefinitions:
 paths:
   /health:
     get:
-      description:
-        health check endpoint
+      description: health check endpoint
       produces:
         - application/json
       responses: