@dhyasama/totem-models 12.35.0 → 12.37.0

package/lib/Document.js

@@ -6,6 +6,7 @@ module.exports = function(mongoose, config) {
 
     Schema = mongoose.Schema,
     utilities = require('@dhyasama/totem-utilities'),
+    metricSources = require('./MetricSource')(mongoose),
     _ = require('underscore');
 
   var Document = new Schema({
@@ -148,11 +149,10 @@ module.exports = function(mongoose, config) {
       });
 
       const doc = await query;
-      if (!doc) return null;
-
-      // No population so no need to scrub
-
-      await doc.deleteOne();
+      // Always attempt the unlink so retrying a partially failed deletion also
+      // repairs metric references after the source itself is already gone.
+      if (doc) await doc.deleteOne();
+      await metricSources.unlink('Document', id, options.CUSTOMER_ID);
       return doc;
     };
 

package/lib/Meeting.js

@@ -4,7 +4,8 @@ module.exports = function(mongoose, config) {
 
   var
 
-    Schema = mongoose.Schema;
+    Schema = mongoose.Schema,
+    metricSources = require('./MetricSource')(mongoose);
 
   let moment = require('moment');
 
@@ -159,8 +160,8 @@ module.exports = function(mongoose, config) {
 
       let query = this.findOne({ _id: meetingId, customer: options.CUSTOMER_ID });
       const meeting = await query;
-      if (!meeting) { return null; }
-      await meeting.deleteOne();
+      if (meeting) await meeting.deleteOne();
+      await metricSources.unlink('Meeting', meetingId, options.CUSTOMER_ID);
       return meeting;
     };
 

package/lib/Message.js

@@ -10,6 +10,7 @@ module.exports = function(mongoose, config) {
     _ = require('underscore'),
     moment = require('moment'),
     helpers = require('../helpers'),
+    metricSources = require('./MetricSource')(mongoose),
     Document = mongoose.model('Document');
 
   let Message = new Schema({
@@ -66,6 +67,7 @@ module.exports = function(mongoose, config) {
         '_id': messageId,
         'customer': customerId
       });
+      await metricSources.unlink('Message', messageId, customerId);
       return result;
     };
 

package/lib/MetricSource.js

@@ -0,0 +1,38 @@
+'use strict';
+
+var SOURCE_MODELS = ['Document', 'Meeting', 'Message', 'News', 'Note'];
+
+module.exports = function(mongoose) {
+  return {
+    unlink: async function(model, ref, customerId) {
+      if (SOURCE_MODELS.indexOf(model) === -1) {
+        throw new Error('model must be a supported metric source');
+      }
+      if (!ref) { throw new Error('ref is required'); }
+      if (!customerId && model !== 'News') { throw new Error('customerId is required'); }
+
+      var source = { model: model, ref: ref };
+      var Financials = mongoose.model('Financials');
+      var filter = {
+        $or: [
+          { 'snapshots.metrics.sources': { $elemMatch: source } },
+          { 'snapshots.metrics.previous.sources': { $elemMatch: source } }
+        ]
+      };
+
+      // News is global and has no customer field. All current source models are
+      // tenant-owned and must only affect the deleting customer.
+      if (customerId) filter.customer = customerId;
+
+      return Financials.updateMany(
+        filter,
+        {
+          $pull: {
+            'snapshots.$[].metrics.$[].sources': source,
+            'snapshots.$[].metrics.$[].previous.sources': source
+          }
+        }
+      );
+    }
+  };
+};

package/lib/News.js

@@ -7,6 +7,7 @@ module.exports = function(mongoose, config) {
 
     Schema = mongoose.Schema,
     helpers = require('../helpers'),
+    metricSources = require('./MetricSource')(mongoose),
     moment = require('moment'),
 
     News = new Schema({
@@ -15,6 +16,8 @@ module.exports = function(mongoose, config) {
 
       text: { type: String, required: false, default: null },
 
+      html: { type: String, required: false, default: null },
+
       summary: { type: String, required: false, default: null },
 
       pageUrl: { type: String, required: false, default: null },
@@ -27,6 +30,13 @@ module.exports = function(mongoose, config) {
 
       sentiment: { type: Number, required: false, default: null },
 
+      analysis: {
+        insights: [{
+          text: { type: String },
+          category: { type: String, enum: ['highlight', 'lowlight', 'goal', 'ask'] }
+        }]
+      },
+
       diffbotUri: { type: String, required: true, unique: true },
 
       org: {
@@ -112,6 +122,26 @@ module.exports = function(mongoose, config) {
 
   };
 
+  News.statics.delete = function(id, cb) {
+
+    const run = async () => {
+      if (!id) { throw new Error('id is required'); }
+      if (!mongoose.Types.ObjectId.isValid(id)) { throw new Error('id is not a valid ObjectId'); }
+
+      const news = await this.findById(id);
+      if (news) await news.deleteOne();
+
+      // News records are global rather than customer-owned, so deleting one
+      // removes its metric reference for every customer.
+      await metricSources.unlink('News', id);
+      return news;
+    };
+
+    if (typeof cb === 'function') { run().then(result => cb(null, result), err => cb(err)); return; }
+    else { return run(); }
+
+  };
+
   News.statics.upsert = function (news, cb) {
 
     const run = async () => {

package/lib/Note.js

@@ -5,6 +5,7 @@ module.exports = function(mongoose, config) {
   let
 
     Schema = mongoose.Schema,
+    metricSources = require('./MetricSource')(mongoose),
     querystring = require('querystring');
 
   let Note = new Schema({
@@ -44,9 +45,8 @@ module.exports = function(mongoose, config) {
       });
 
       const note = await query;
-      if (!note) return null;
-
-      await note.deleteOne();
+      if (note) await note.deleteOne();
+      await metricSources.unlink('Note', noteId, customerId);
       return note;
     };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dhyasama/totem-models",
-  "version": "12.35.0",
+  "version": "12.37.0",
   "author": "Jason Reynolds",
   "license": "UNLICENSED",
   "description": "Models for Totem platform",

package/test/MetricSource.js

@@ -0,0 +1,61 @@
+'use strict';
+
+var should = require('should');
+var createMetricSources = require('../lib/MetricSource');
+
+describe('MetricSource', function() {
+  it('unlinks a source from current and previous metric states for one customer', async function() {
+    var captured;
+    var mongoose = {
+      model: function(name) {
+        name.should.equal('Financials');
+        return {
+          updateMany: function(filter, update) {
+            captured = { filter: filter, update: update };
+            return Promise.resolve({ modifiedCount: 1 });
+          }
+        };
+      }
+    };
+
+    await createMetricSources(mongoose).unlink('Meeting', 'meeting-id', 'customer-id');
+
+    captured.filter.customer.should.equal('customer-id');
+    captured.filter.$or.should.have.length(2);
+    captured.update.$pull['snapshots.$[].metrics.$[].sources'].should.eql({
+      model: 'Meeting', ref: 'meeting-id'
+    });
+    captured.update.$pull['snapshots.$[].metrics.$[].previous.sources'].should.eql({
+      model: 'Meeting', ref: 'meeting-id'
+    });
+  });
+
+  it('rejects unsupported source models', async function() {
+    var metricSources = createMetricSources({});
+
+    await metricSources.unlink('Event', 'event-id', 'customer-id').should.be.rejectedWith(
+      'model must be a supported metric source'
+    );
+  });
+
+  it('unlinks global News sources without a customer filter', async function() {
+    var capturedFilter;
+    var mongoose = {
+      model: function() {
+        return {
+          updateMany: function(filter) {
+            capturedFilter = filter;
+            return Promise.resolve({ modifiedCount: 1 });
+          }
+        };
+      }
+    };
+
+    await createMetricSources(mongoose).unlink('News', 'news-id');
+
+    should.not.exist(capturedFilter.customer);
+    capturedFilter.$or[0]['snapshots.metrics.sources'].$elemMatch.should.eql({
+      model: 'News', ref: 'news-id'
+    });
+  });
+});

package/test/News.js

@@ -25,12 +25,23 @@ describe('News', function() {
     news.createdBy = 'Jason';
     news.createdOn = Date.now();
     news.title = 'Google';
+    news.html = '<p>Google announced quarterly revenue.</p>';
+    news.analysis = {
+      insights: [{
+        text: 'Quarterly revenue reached a new high.',
+        category: 'highlight'
+      }]
+    };
     news.link = 'http://google.com';
     news.internal = false;
 
     News.upsert(news, function(err, item) {
       should.not.exist(err);
       should.exist(item);
+      item.html.should.equal('<p>Google announced quarterly revenue.</p>');
+      item.analysis.insights.should.have.length(1);
+      item.analysis.insights[0].text.should.equal('Quarterly revenue reached a new high.');
+      item.analysis.insights[0].category.should.equal('highlight');
       news = item;
       done();
     });