feat: LL-482 Feature expiration (LearningLocker#1105)

* Start of expiration * Only site_admin can change the expiration. * Show expired organisation after login. * Added expiration email. * White space. * Fixed tests. * Fixed console errors. * Changing the expiration date will reset the email status. * Test old expiration, only if it was set. * Added worker log. * Removed re throwing error. * Added schedular to pm2. * Fixed typo. * Fixed build error. * test: Remove only * Fixed worker not building. * test: Add organisation to test dashboard token * Tweak email wording * Tweak email wording

Author: cbishopvelti

api/src/routes/HttpRoutes.js

@@ -198,7 +198,18 @@ router.get(
  * REST APIS
  */
 restify.defaults(RESTIFY_DEFAULTS);
-restify.serve(router, Organisation);
+restify.serve(router, Organisation, {
+ preUpdate: (req, res, next) => {
+ const authInfo = getAuthFromRequest(req);
+ const scopes = getScopesFromRequest(authInfo);
+ if (
+ findIndex(scopes, item => item === SITE_ADMIN) < 0
+ ) {
+ req.body = omit(req.body, 'expiration');
+ }
+ next();
+ }
+});
 restify.serve(router, Stream);
 restify.serve(router, Export);
 restify.serve(router, Download);

api/src/routes/tests/utils/models/createDashboard.js

@@ -6,5 +6,6 @@ export default (opts = { _id: testId }) =>
  Dashboard.create({
  name: 'Test dashboard',
  owner: ownerId,
+ organisation: testId,
  ...opts
  });

cli/build.js

@@ -1,5 +1,6 @@
 import 'dotenv/config';
 import path from 'path';
+import { all } from 'bluebird';
 import run from '../lib/tools/run';
 import bundle from '../lib/tools/bundle';
 import getWebpackConfig from '../lib/tools/getWebpackConfig';
@@ -25,13 +26,28 @@ const webpackConfig = getWebpackConfig({
  }
 });
 
+const schedulerWebpackConfig = getWebpackConfig({
+ isDebug,
+ isVerbose,
+ isClient: false,
+ sourceDir,
+ outputDir: path.resolve(__dirname, 'dist', 'scheduler'),
+ stats,
+ publicPath: '/',
+ entry: {
+ scheduler: 'scheduler.js'
+ }
+});
 
 /**
  * Uses webpack to compile the API server
  * into a single file executable by node
  */
 async function build() {
- await run(bundle, { webpackConfig, watch });
+ await all([
+ run(bundle, { webpackConfig, watch }),
+ run(bundle, { webpackConfig: schedulerWebpackConfig, watch })
+ ]);
 }
 
 export default build();

cli/src/commands/expirationNotificationEmails-test.js

@@ -0,0 +1,82 @@
+import Organisation, { EMAIL_PROCESSING, EMAIL_NOOP } from 'lib/models/organisation';
+import moment from 'moment';
+import { expect } from 'chai';
+import {
+ WEEK_BEFORE_NOTIFICATION,
+ EXPIRATION_NOTIFICATION
+} from 'lib/constants/expirationNotifications';
+import expirationNotificationEmails from './expirationNotificationEmails';
+
+describe('expirationNotificationEmails', () => {
+ beforeEach(async () => {
+ await Organisation.remove({});
+ });
+
+ it('should send weekBefore email', async () => {
+ const organisation = await Organisation.create({
+ expiration: moment().add(1, 'day').toDate()
+ });
+
+ let publishCalled = false;
+ await expirationNotificationEmails({
+ publish: ({
+ payload
+ }) => {
+ publishCalled = true;
+ expect(payload.organisationId).to.equal(organisation._id.toString());
+ expect(payload.emailType).to.equal(WEEK_BEFORE_NOTIFICATION);
+ },
+ dontExit: true
+ });
+
+ expect(publishCalled).to.equal(true);
+
+ const newOrg = await Organisation.findById(organisation._id);
+ expect(newOrg.expirationNotifications.weekBeforeNotificationSent).to.equal(EMAIL_PROCESSING);
+ expect(newOrg.expirationNotifications.expirationNotificationSent).to.equal(EMAIL_NOOP);
+ });
+
+ it('should not send any email', async () => {
+ const organisation = await Organisation.create({
+ expiration: moment().add(9, 'day').toDate()
+ });
+
+ let publishCalled = false;
+ await expirationNotificationEmails({
+ publish: () => {
+ publishCalled = true;
+ },
+ dontExit: true
+ });
+
+ expect(publishCalled).to.equal(false);
+
+ const newOrg = await Organisation.findById(organisation._id);
+ expect(newOrg.expirationNotifications.weekBeforeNotificationSent).to.equal(EMAIL_NOOP);
+ expect(newOrg.expirationNotifications.expirationNotificationSent).to.equal(EMAIL_NOOP);
+ });
+
+ it('should send expiration email', async () => {
+ const organisation = await Organisation.create({
+ expiration: moment().subtract(1, 'day').toDate()
+ });
+
+ let publishCalled = false;
+ await expirationNotificationEmails({
+ publish: ({
+ payload
+ }) => {
+ publishCalled = true;
+ expect(payload.organisationId).to.equal(organisation._id.toString());
+ expect(payload.emailType).to.equal(EXPIRATION_NOTIFICATION);
+ },
+ dontExit: true
+ });
+
+ expect(publishCalled).to.equal(true);
+
+ const newOrg = await Organisation.findById(organisation._id);
+ expect(newOrg.expirationNotifications.weekBeforeNotificationSent).to.equal(EMAIL_NOOP);
+ expect(newOrg.expirationNotifications.expirationNotificationSent).to.equal(EMAIL_PROCESSING);
+ });
+});

cli/src/commands/expirationNotificationEmails.js

@@ -0,0 +1,82 @@
+import Organisation, { EMAIL_NOOP, EMAIL_PROCESSING } from 'lib/models/organisation';
+import moment from 'moment';
+import { map } from 'bluebird';
+import { publish as publishToQueue } from 'lib/services/queue';
+import {
+ EXPIRATION_NOTIFICATION,
+ WEEK_BEFORE_NOTIFICATION,
+ EMAIL_EXPIRATION_NOTIFICATION_QUEUE
+} from 'lib/constants/expirationNotifications';
+
+export default async function ({
+ weekBefore, // for testing, iso string
+ publish = publishToQueue, // for testing
+ dontExit = false
+}) {
+ let weekBeforeMoment;
+ if (weekBefore) {
+ weekBeforeMoment = moment(weekBefore);
+ } else {
+ weekBeforeMoment = moment().add(1, 'week');
+ }
+
+ const todayMoment = moment();
+
+ const weekBeforeDate = weekBeforeMoment.toDate();
+ const todayDate = todayMoment.toDate();
+
+ const toSendEmail = await Organisation.find({
+ $or: [
+ {
+ 'expirationNotifications.weekBeforeNotificationSent': EMAIL_NOOP,
+ expiration: {
+ $lt: weekBeforeDate
+ }
+ },
+ {
+ 'expirationNotifications.expirationNotificationSent': EMAIL_NOOP,
+ expiration: {
+ $lt: todayDate
+ }
+ }
+ ]
+ }).exec();
+
+ await map(toSendEmail, async (organisation) => {
+ if (
+ weekBeforeMoment.isAfter(moment(organisation.expiration)) &&
+ todayMoment.isAfter(moment(organisation.expiration))
+ ) {
+ if (organisation.expirationNotifications.expirationNotificationSent === EMAIL_NOOP) {
+ // send expiration email
+ await publish({
+ queueName: EMAIL_EXPIRATION_NOTIFICATION_QUEUE,
+ payload: {
+ organisationId: organisation._id.toString(),
+ emailType: EXPIRATION_NOTIFICATION
+ }
+ });
+
+ organisation.expirationNotifications.expirationNotificationSent = EMAIL_PROCESSING;
+ await organisation.save();
+ }
+ } else if (weekBeforeMoment.isAfter(moment(organisation.expiration))) {
+ if (organisation.expirationNotifications.weekBeforeNotificationSent === EMAIL_NOOP) {
+ // send week before email
+ await publish({
+ queueName: EMAIL_EXPIRATION_NOTIFICATION_QUEUE,
+ payload: {
+ organisationId: organisation._id.toString(),
+ emailType: WEEK_BEFORE_NOTIFICATION
+ }
+ });
+
+ organisation.expirationNotifications.weekBeforeNotificationSent = EMAIL_PROCESSING;
+ await organisation.save();
+ }
+ }
+ });
+ if (!dontExit) {
+ process.exit();
+ }
+}

cli/src/commands/v2-migrations/20171127214500_remove_unused_persona_props.js

@@ -0,0 +1,35 @@
+import { getConnection } from 'lib/connections/mongoose';
+import { EMAIL_NOOP } from 'lib/models/organisation';
+
+const up = async () => {
+ const connection = getConnection();
+
+ await connection.collection('organisations').update({
+ expirationNotifications: { $exists: false }
+ }, {
+ $set: {
+ expirationNotifications: {
+ expirationNotificationSent: EMAIL_NOOP,
+ weekBeforeNotificationSent: EMAIL_NOOP
+ }
+ }
+ }, {
+ upsert: false,
+ multi: true
+ });
+};
+
+const down = async () => {
+ const connection = getConnection();
+
+ await connection.collection('organisation').update({}, {
+ $unset: {
+ expirationNotifications: ''
+ }
+ }, {
+ upsert: false,
+ multi: true
+ });
+};
+
+export default { up, down };

cli/src/commands/v2-migrations/20180212_expiration.js

@@ -1,7 +1,7 @@
 import { OrderedMap } from 'immutable';
 import commonIndexesMigration from './20171122100800_common_indexes';
 import updateRefs from './20171121153300_update_refs';
-// import removeUnusedPersonaProps from './20171127214500_remove_unused_persona_props';
+import expiration from './20180212_expiration';
 import migrateIdentifiers from './20171127214900_migrate_identifiers';
 import personasIndexes from './20171008104700_personas_indexes';
 // import removeOldIdents from './20171128144900_remove_old_idents';
@@ -12,6 +12,5 @@ export default new OrderedMap()
  .set('20171121153300_update_refs', updateRefs)
  .set('20171008104700_personas_indexes', personasIndexes)
  .set('20171127214900_migrate_identifiers', migrateIdentifiers)
- // .set('20171127214500_remove_unused_persona_props', removeUnusedPersonaProps)
- // .set('20171128144900_remove_old_idents', removeOldIdents)
+ .set('20180212_expiration', expiration)
  .set('20180320093000_shareable_dashboards', shareableDashboards);

cli/src/commands/v2-migrations/index.js

@@ -0,0 +1,17 @@
+import expirationNotificationEmails from 'cli/commands/expirationNotificationEmails';
+import logger from 'lib/logger';
+
+const timeout = 15 * 60 * 1000;
+
+const run = async () => {
+ logger.info('processing expiration');
+ const startTime = Date.now();
+
+ await expirationNotificationEmails({
+ dontExit: true
+ });
+
+ setTimeout(run, (startTime - Date.now()) + timeout);
+};
+
+run();

cli/src/scheduler.js

@@ -27,6 +27,7 @@ import testQueryBuilderCache from 'cli/commands/testQueryBuilderCache';
 import migrateMongo, { MIGRATIONS_PATH } from 'cli/migrateMongo';
 
 import seed from 'cli/seed';
+import expirationNotificationEmails from 'cli/commands/expirationNotificationEmails';
 
 program.version('0.0.1');
 
@@ -140,4 +141,10 @@ program
  .option('-i, --info [info]', "Display the state of the migrations, optional ['v'|'verbose']");
 // node cli/dist/server migrateMongo
 
+program
+ .command('expirationNotificationEmails')
+ .action(expirationNotificationEmails)
+ .option('--weekBefore [weekBefore]', 'The date of when to send the week before email');
+// node cli/dist/server expirationNotificationEmails
+
 program.parse(process.argv);