Updated notification support

docker-compose.yml

@@ -25,6 +25,8 @@ services:
       NODE_ENV: development
       PORT: 8100
       REDIS_DSN: redis://redis:6379/0
+      SENDGRID_API_KEY: ${SENDGRID_API_KEY}
+      SENDGRID_FROM: ${SENDGRID_FROM}
   redis:
     image: redis:alpine
   mongo:

package.json

@@ -52,6 +52,7 @@
     "body-parser": "^1.18.2",
     "cors": "^2.8.4",
     "crawler-user-agents": "https://github.com/monperrus/crawler-user-agents.git#master",
+    "cron": "^1.3.0",
     "deep-assign": "^2.0.0",
     "deepmerge": "^2.1.0",
     "elasticsearch": "^15.0.0",

src/email-templates/campaign.created.hbs

@@ -0,0 +1,3 @@
+<p>Campaign "{{ campaign.name }}" was created.</p>
+
+<p>Click here to submit your creatives: <a href="{{ materialCollectUri }}">{{ materialCollectUri }}</a></p>

src/email-templates/campaign.ended.hbs

@@ -0,0 +1,6 @@
+<p>Campaign "{{ campaign.name }}" has ended.</p>
+
+<p>Click here to view the summary report: <a href="{{ reportSummaryUri }}">{{ reportSummaryUri }}</a></p>
+
+<p>Click here to view the creative report: <a href="{{ reportCreativeUri }}">{{ reportCreativeUri }}</a></p>
+

src/email-templates/campaign.started.hbs

@@ -0,0 +1 @@
+<p>Campaign "{{ campaign.name }}" has started.</p>

src/graph/resolvers/campaign.js

@@ -20,6 +20,12 @@ const getNotifyDefaults = async (advertiserId, user) => {
   return notify;
 };
 
+const updateNotifications = async (campaignId) => {
+  contactNotifier.scheduleCampaignCreated({ campaignId });
+  contactNotifier.scheduleCampaignStarted({ campaignId });
+  contactNotifier.scheduleCampaignEnded({ campaignId });
+};
+
 module.exports = {
   /**
    *
@@ -111,26 +117,29 @@ module.exports = {
       payload.criteria = { start: payload.startDate };
       payload.notify = await getNotifyDefaults(payload.advertiserId, auth.user);
       const campaign = await CampaignRepo.create(payload);
-      contactNotifier.sendInternalCampaignCreated({ campaign });
-      contactNotifier.sendExternalCampaignCreated({ campaign });
+      await updateNotifications(campaign.id);
       return campaign;
     },
 
     /**
      *
      */
-    updateCampaign: (root, { input }, { auth }) => {
+    updateCampaign: async (root, { input }, { auth }) => {
       auth.check();
       const { id, payload } = input;
-      return CampaignRepo.update(id, payload);
+      const campaign = await CampaignRepo.update(id, payload);
+      await updateNotifications(id);
+      return campaign;
     },
 
     assignCampaignValue: async (root, { input }) => {
       const { id, field, value } = input;
       const campaign = await Campaign.findById(id);
       if (!campaign) throw new Error(`Unable to assign field '${field}' to campaign: no record found for id '${id}'`);
       campaign.set(field, value);
-      return campaign.save();
+      await campaign.save();
+      await updateNotifications(id);
+      return campaign;
     },
 
     /**
@@ -139,7 +148,9 @@ module.exports = {
     campaignCriteria: async (root, { input }, { auth }) => {
       auth.check();
       const { campaignId, payload } = input;
-      return CriteriaRepo.setFor(campaignId, payload);
+      const criteria = await CriteriaRepo.setFor(campaignId, payload);
+      await updateNotifications(campaignId);
+      return criteria;
     },
 
     campaignUrl: async (root, { input }, { auth }) => {
@@ -148,16 +159,20 @@ module.exports = {
       const campaign = await Campaign.findById(campaignId);
       if (!campaign) throw new Error(`Unable to set campaign URL: no campaign found for '${campaignId}'`);
       campaign.url = url;
-      return campaign.save();
+      await campaign.save();
+      await updateNotifications(campaignId);
+      return campaign;
     },
 
     /**
      *
      */
-    addCampaignCreative: (root, { input }, { auth }) => {
+    addCampaignCreative: async (root, { input }, { auth }) => {
       const { campaignId, payload } = input;
       auth.checkCampaignAccess(campaignId);
-      return CreativeRepo.createFor(campaignId, payload);
+      const creative = await CreativeRepo.createFor(campaignId, payload);
+      await updateNotifications(campaignId);
+      return creative;
     },
 
     /**
@@ -167,6 +182,7 @@ module.exports = {
       const { campaignId, creativeId } = input;
       auth.checkCampaignAccess(campaignId);
       await CreativeRepo.removeFrom(campaignId, creativeId);
+      await updateNotifications(campaignId);
       return 'ok';
     },
 
@@ -176,7 +192,9 @@ module.exports = {
     campaignCreativeStatus: async (root, { input }, { auth }) => {
       auth.check();
       const { campaignId, creativeId, status } = input;
-      return CreativeRepo.setStatusFor(campaignId, creativeId, status);
+      const saved = await CreativeRepo.setStatusFor(campaignId, creativeId, status);
+      await updateNotifications(campaignId);
+      return saved;
     },
 
     /**
@@ -186,7 +204,13 @@ module.exports = {
       const { campaignId, creativeId, payload } = input;
       auth.checkCampaignAccess(campaignId);
       const { title, teaser, status } = payload;
-      return CreativeRepo.updateDetailsFor(campaignId, creativeId, { title, teaser, status });
+      const details = await CreativeRepo.updateDetailsFor(
+        campaignId,
+        creativeId,
+        { title, teaser, status },
+      );
+      await updateNotifications(campaignId);
+      return details;
     },
 
     /**
@@ -195,16 +219,20 @@ module.exports = {
     campaignCreativeImage: async (root, { input }, { auth }) => {
       const { campaignId, creativeId, imageId } = input;
       auth.checkCampaignAccess(campaignId);
-      return CreativeRepo.updateImageFor(campaignId, creativeId, imageId);
+      const image = await CreativeRepo.updateImageFor(campaignId, creativeId, imageId);
+      await updateNotifications(campaignId);
+      return image;
     },
 
     /**
      *
      */
-    campaignContacts: (root, { input }, { auth }) => {
+    campaignContacts: async (root, { input }, { auth }) => {
       auth.check();
       const { id, type, contactIds } = input;
-      return ContactRepo.setContactsFor(Campaign, id, type, contactIds);
+      const contacts = await ContactRepo.setContactsFor(Campaign, id, type, contactIds);
+      await updateNotifications(id);
+      return contacts;
     },
   },
 };

src/handlebars.js

@@ -64,6 +64,4 @@ handlebars.registerHelper('build-ua-beacon', (context) => {
   return new handlebars.SafeString(`<script>if (window.ga) { ga('send', 'event', 'Fortnight', 'load', '${pid || ''}', '${cid || ''}'); }</script>`);
 });
 
-handlebars.registerHelper('link-to', (...parts) => parts.filter(el => typeof el === 'string').join('/'));
-
 module.exports = handlebars;

src/index.js

@@ -4,10 +4,13 @@ const env = require('./env');
 const output = require('./output');
 const pkg = require('../package.json');
 const { app } = require('./server');
+const contactNotifier = require('./services/contact-notifier');
 
 const { PORT } = env;
 
 const server = app.listen(PORT);
 output.write(`🕸️ 🕸️ 🕸️ Express app '${pkg.name}' listening on port ${PORT}`);
 
+contactNotifier.init();
+
 module.exports = server;

src/models/campaign-notification.js

@@ -0,0 +1,4 @@
+const mongoose = require('../connections/mongoose/instance');
+const schema = require('../schema/campaign-notification');
+
+module.exports = mongoose.model('campaign-notification', schema);

src/schema/advertiser.js

@@ -4,6 +4,7 @@ const notifyPlugin = require('../plugins/notify');
 const { applyElasticPlugin, setEntityFields } = require('../elastic/mongoose');
 const imagePlugin = require('../plugins/image');
 const pushIdPlugin = require('../plugins/push-id');
+const accountService = require('../services/account');
 
 const schema = new Schema({
   name: {
@@ -38,6 +39,12 @@ schema.pre('save', async function updateCampaigns() {
   }
 });
 
+schema.virtual('portalUri').get(async function getPortalUri() {
+  const account = await accountService.retrieve();
+  const uri = await account.get('uri');
+  return `${uri}/app/${this.pushId}`;
+});
+
 schema.plugin(notifyPlugin);
 
 setEntityFields(schema, 'name');

src/schema/campaign-notification.js

@@ -0,0 +1,44 @@
+const { Schema } = require('mongoose');
+const connection = require('../connections/mongoose/instance');
+
+const schema = new Schema({
+  campaignId: {
+    type: Schema.Types.ObjectId,
+    required: true,
+    validate: {
+      async validator(v) {
+        const doc = await connection.model('campaign').findOne({ _id: v }, { _id: 1 });
+        if (doc) return true;
+        return false;
+      },
+      message: 'No campaign found for ID {VALUE}',
+    },
+  },
+  type: {
+    type: String,
+    enum: ['Campaign Created', 'Campaign Started', 'Campaign Ended'],
+    required: true,
+  },
+  status: {
+    type: String,
+    enum: ['Pending', 'Sending', 'Sent', 'Errored'],
+    default: 'Pending',
+  },
+  error: String,
+  sendAt: {
+    type: Date,
+    required: true,
+    default: () => new Date(),
+  },
+
+  to: [String],
+  cc: [String],
+  bcc: [String],
+
+  subject: String,
+  text: String,
+  html: String,
+}, { timestamps: true });
+
+
+module.exports = schema;

src/schema/campaign/index.js

@@ -93,6 +93,27 @@ schema.pre('save', async function setAdvertiserName() {
   }
 });
 
+schema.virtual('portalUri').get(async function getPortalUri() {
+  const advertiser = await connection.model('advertiser').findOne({ _id: this.advertiserId }, { pushId: 1 });
+  const uri = await advertiser.get('portalUri');
+  return `${uri}/campaigns/${this.pushId}`;
+});
+
+schema.virtual('vMaterialCollectUri').get(async function getVMCU() {
+  const uri = await this.get('portalUri');
+  return `${uri}/materials`;
+});
+
+schema.virtual('vReportSummaryUri').get(async function getVRSU() {
+  const uri = await this.get('portalUri');
+  return `${uri}/report/summary`;
+});
+
+schema.virtual('vReportCreativeUri').get(async function getVRCU() {
+  const uri = await this.get('portalUri');
+  return `${uri}/report/creative-breakdown`;
+});
+
 schema.plugin(notifyPlugin);
 schema.plugin(pushIdPlugin, { required: true });