@johnmmackey/ms-utils 3.3.3 → 4.1.0

package/CHANGELOG.md

@@ -1,7 +1,20 @@
-## Version 3.3.3
+## Version 4.1.0
+Added functionality:
+* uses ```dotenv``` to load a local .env file
+* pushes configuration into environment variables
+
+## Version 4.0.0
+BREAKING CHANGES
+* @johnmmackey/amqp-utils removed as a dependency
+* sendmail is removed, and replaced with the Mailer Class
+```js
+let m = new Mailer(connectionManager);
+await m.send(recipients, options);
+```
+* winstonMSLoggerFactory now requires the third parameter of connectionManager
+* mail attachements now placed in REDIS with base64 encoding
+* new REDIS client and other dependency upgrades
 
-* updated Buffer() to Buffer.from()
-* updated to latest @johnmmackey/amqp-utils package
 ## Version 3.3.1
 
 * updated etcd3 package to v1.1.0 (major rev upgrade)

package/README.md

@@ -28,7 +28,6 @@ let x = Config.get('key');      //typeof string
 let y = Config.getObj('key');   // typeof Object
 
 sendmail(
-    [
         {"email": "user1@gmail.com","name": "John Smith"},
         {"email": "user2@yahoo.com","name": "Jane Doe"},
         {"email": "user3@aol.com","name": "Karen from Texas"}
@@ -42,6 +41,14 @@ sendmail(
     .then( () => console.log('Success'))
     .catch( err => console.log(err))
 ```
+
+##
+```Config.load``` now has 2 side effects:
+* uses ```dotenv``` to load a .env file in the current working directory into the environment
+* pushes all items loaded from etcd into the environment.
+
+The order of precedence: .env > etcd > external set environment
+
 ## Future
 * Add local queueing for log events when AMQP is not operative.
 * Configurable logging setup (drivers)

package/index.js

@@ -3,6 +3,6 @@
 const Config = require('./lib/config');
 const winstonMSLoggerFactory = require('./lib/winston-mslogger');
 const Utils = require('./lib/utils');
-const sendmail = require('./lib/mail');
+const Mailer = require('./lib/mail');
 
-module.exports = { Utils, Config, winstonMSLoggerFactory, sendmail };
+module.exports = { Utils, Config, winstonMSLoggerFactory, Mailer };

package/lib/config.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const { Etcd3 } = require('etcd3');
+const dotenv = require('dotenv');
 const client = new Etcd3({ hosts: process.env.ETCD_URI || 'http://localhost:2379' });
 
 
@@ -24,7 +25,14 @@ async function tryLoad(serviceName) {
 }
 
 async function load(serviceName) {
-    return Promise.retry(10, tryLoad.bind(this, serviceName), 5000)
+    await Promise.retry(10, tryLoad.bind(this, serviceName), 5000);
+
+    // as a side-effect, load these into process.env
+    dotenv.populate(process.env, config, { override: true });
+
+    // load any .env file that may be present into the environment
+    dotenv.config({ override: true });
+
 }
 
 function get(k) {
@@ -34,10 +42,10 @@ function get(k) {
 function getObj(k) {
     try {
         return JSON.parse(config[k]);
-     }
-     catch (err) {
-         return null;
-     }
+    }
+    catch (err) {
+        return null;
+    }
 }
 
 module.exports = { load, get, getObj }

package/lib/mail.js

@@ -3,79 +3,84 @@
 const fs = require('fs');
 const redis = require("redis");
 const { v4: uuid } = require('uuid');
-
-const { ConnectionManager: aC } = require('@johnmmackey/amqp-utils');
-
-const rClient = redis.createClient({ url: process.env.REDIS_URI || 'redis://localhost' });
-
 const { promisify } = require('util');
-const setAsync = promisify(rClient.set).bind(rClient);
-const expireAsync = promisify(rClient.expire).bind(rClient);
 const readFileAsync = promisify(fs.readFile);
 
-aC.addConfig(ch => {
-	ch.assertQueue('email', { durable: true });
-})
-
-// recipients structure: [{"email": "johnmmackey@yahoo.ca","name": "John Mackey"}]
-// options:
-// from
-// subject
-// replyTo
-// textBody
-// htmlBody
-// attachments[]
-// includeUnsubscribeLink
-
-// returns a promise
-
-module.exports = async function (recipients, options) {
-
-	if (!options.htmlBody)	// Always want a html body
-		options.htmlBody = (options.textBody || '').replace(/\r?\n/g, '<br>');
-
-	var msg = {
-		from: options.from || "",
-		subject: options.subject || "",
-        attachments: [],
-        includeUnsubscribeLink: options.includeUnsubscribeLink
-	}
-
-	if (options.textBody) {
-		msg.textBodyKey = await writeKey(options.textBody, 'txt');
+module.exports = class Mailer {
+	constructor(connectionManager) {
+		// param is amqp connection manager - see @johnmmackey/amqp-utils
+		this.aC = connectionManager;
+		this.rClient = redis.createClient({ url: process.env.REDIS_URI || 'redis://localhost' });
+		// while this is async, it has a retry, so should be OK
+		this.rClient.connect();
+		this.aC.addConfig(ch => {
+			ch.assertQueue('email', { durable: true });
+		})
 	}
 
-	msg.htmlBodyKey = await writeKey(options.htmlBody, 'html');
-
-	for (let a of (options.attachments || [])) {
-		var da = {
-			filename: a.originalname,
-			contentType: a.mimetype
+	// recipients structure: [{"email": "johnmmackey@yahoo.ca","name": "John Mackey"}]
+	// options:
+	// from
+	// subject
+	// replyTo
+	// textBody
+	// htmlBody
+	// attachments[]
+	// includeUnsubscribeLink
+
+	// returns a promise
+
+	async send(recipients, options) {
+
+
+		if (!options.htmlBody)	// Always want a html body
+			options.htmlBody = (options.textBody || '').replace(/\r?\n/g, '<br>');
+
+		var msg = {
+			from: options.from || "",
+			subject: options.subject || "",
+			attachments: [],
+			includeUnsubscribeLink: options.includeUnsubscribeLink,
+			...(options.mailingLists ? {mailingLists: options.mailingLists} : {})
+		}
+
+		if (options.textBody) {
+			msg.textBodyKey = await this.writeKey(options.textBody, 'txt');
+		}
+
+		msg.htmlBodyKey = await this.writeKey(options.htmlBody, 'html');
+
+		for (let a of (options.attachments || [])) {
+			var da = {
+				filename: a.originalname,
+				contentType: a.mimetype
+			};
+			a.contentDisposition && (da.contentDisposition = a.contentDisposition);
+			a.cid && (da.cid = a.cid);
+
+			da.key = await this.writeKey(
+				Buffer.from(a.path ? await readFileAsync(a.path) : a.content).toString('base64'),
+				'attachment'
+			);
+			msg.attachments.push(da);
 		};
-		a.contentDisposition && (da.contentDisposition = a.contentDisposition);
-		a.cid && (da.cid = a.cid);
 
-		da.key = await writeKey(
-						a.path ? await readFileAsync(a.path) : a.content,
-						'attachment'
-				);
-		msg.attachments.push(da);
-	};
+		if (options.replyTo)
+			msg.replyTo = options.replyTo;
 
-	if (options.replyTo)
-		msg.replyTo = options.replyTo;
+		msg.recipientsKey = await this.writeKey(JSON.stringify(recipients), 'recipients');
 
-	msg.recipientsKey = await writeKey(JSON.stringify(recipients), 'recipients');
+		// Send it to queue here
+		if (!this.aC.ch)
+			throw new Error('No current AMQP channel available');
 
-	// Send it to queue here
-    if (!aC.ch)
-        throw new Error('No current AMQP channel available');
-	aC.ch.sendToQueue('email', new Buffer.from(JSON.stringify(msg)));
-}
+		this.aC.ch.sendToQueue('email', Buffer.from(JSON.stringify(msg)));
+	}
 
-function writeKey(v, type) {
-    let k = 'mail:' + uuid() + ':' + type;
-	return setAsync(k, v)
-		.then(() => expireAsync(k, 60*60*24))
-		.then(() => k);		// resolve to key name
+	async writeKey(v, type) {
+		let k = 'mail:' + uuid() + ':' + type;
+		await this.rClient.set(k, v);
+		await this.rClient.expire(k, 60 * 60 * 24);
+		return k;
+	}
 }

package/lib/winston-mslogger.js

@@ -1,18 +1,9 @@
 'use strict';
 
 const util = require('util');
-const {ConnectionManagerClass} = require('@johnmmackey/amqp-utils');
 
-module.exports = function(winston, serviceName, existingConnectionManager) {
+module.exports = function(winston, serviceName, cm) {
 
-    var cm;
-
-    if(existingConnectionManager) {
-        cm = existingConnectionManager;
-    } else {
-        cm = new ConnectionManagerClass();
-        cm.connect();
-    }
     cm.addConfig(ch => {
         ch.assertQueue('logger', { durable: true });
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@johnmmackey/ms-utils",
-  "version": "3.3.3",
+  "version": "4.1.0",
   "description": "Utility functions for Microservice Architecture",
   "main": "index.js",
   "scripts": {
@@ -14,9 +14,9 @@
   "license": "ISC",
   "homepage": "https://bitbucket.org/52westlabs/ms-utils#readme",
   "dependencies": {
-    "@johnmmackey/amqp-utils": "^1.3.2",
-    "etcd3": "^1.1.0",
-    "redis": "^3.0.2",
-    "uuid": "^8.3.2"
+    "dotenv": "^16.4.7",
+    "etcd3": "^1.1.2",
+    "redis": "^4.6.12",
+    "uuid": "^9.0.1"
   }
 }

package/tests/priorityTest.js

@@ -0,0 +1,9 @@
+const { Config } = require('../index.js');
+
+( async () => {
+    console.log('env: before network load', process.env)
+    let config = await Config.load('mailrelay')
+    console.log('env: after network and file load', process.env)
+
+
+})()