-
Notifications
You must be signed in to change notification settings - Fork 0
/
integration.js
399 lines (343 loc) · 10.7 KB
/
integration.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
'use strict';
const nodemailer = require('nodemailer');
const Email = require('email-templates');
const fs = require('fs');
const { promisify } = require('util');
const readdir = promisify(fs.readdir);
const FORMS_DIRECTORY = './forms';
let Logger;
let smtpClient = null;
let emailer = null;
let forms = [];
let formsByFileName = {};
let previousFormSelection = '';
const formDefaults = {
input: {
required: false,
placeholder: '',
description: '',
default: ''
},
select: {
required: false
},
textarea: {
required: false,
placeholder: '',
description: '',
default: '',
rows: 10
}
};
const formRequiredFields = {
input: ['label'],
select: ['label'],
textarea: ['label'],
block: ['text'],
links: ['links']
};
function startup(logger) {
Logger = logger;
}
function maybeInitSmtp(options) {
if (
(options.deliveryMethod.value === 'email' || options.deliveryMethod.value === 'emailAndLog') &&
smtpClient === null
) {
Logger.info('Initializing SMTP Client');
setupSmtpClient(options);
}
}
function maybeSetupTemplateBuilder() {
if (emailer === null) {
Logger.info('Initializing Template Builder');
setupTemplateBuilder();
}
}
function doLookup(entities, options, cb) {
Logger.trace({ entities, options }, 'doLookup');
maybeInitSmtp(options);
maybeSetupTemplateBuilder();
try {
maybeLoadForms(options);
} catch (loadError) {
let jsonError = parseErrorToReadableJSON(loadError);
Logger.error({ jsonError }, 'Error loading interface');
return cb(jsonError);
}
let lookupResults = [];
entities.forEach((entityObj) => {
if (!options.privateIpOnly || (options.privateIpOnly && entityObj.isIP && entityObj.isPrivateIP)) {
lookupResults.push({
entity: entityObj,
isVolatile: true,
data: {
summary: [options.summaryTag],
details: {
target: entityObj.value,
forms
}
}
});
}
});
Logger.trace({ lookupResults }, 'Lookup Results from doLookup');
cb(null, lookupResults);
}
function setupSmtpClient(options) {
const smtpOptions = {
host: options.smtpHost,
port: options.smtpPort
};
if (options.smtpUser && options.smtpPassword) {
smtpOptions.auth = {
type: 'login',
user: options.smtpUser,
pass: options.smtpPassword
};
}
if (options.smtpConnectionSecurity.value === 'tls') {
// Forces TLS when initially connecting.
smtpOptions.secure = true;
}
if (options.smtpConnectionSecurity.value === 'none') {
// Uses STARTTLS if available
smtpOptions.secure = false;
}
if (options.smtpConnectionSecurity.value === 'starttls') {
// Forces usage of STARTTLS even if the server does not advertise support for it.
// Messages will not be sent in clear text
smtpOptions.secure = false;
smtpOptions.requireTLS = true;
}
Logger.trace({ smtpOptions }, 'SMTP Options');
smtpClient = nodemailer.createTransport(smtpOptions);
}
function setupTemplateBuilder() {
emailer = new Email({
views: {
root: './email-templates',
options: {
extension: 'hbs'
}
}
});
}
function getRecipient(fileName, recipient, options) {
if (recipient) {
return recipient;
} else if (formsByFileName[fileName] && formsByFileName[fileName].recipient) {
return formsByFileName[fileName].recipient;
} else {
return options.recipient;
}
}
function getEmailSubject(fileName) {
if (formsByFileName[fileName] && formsByFileName[fileName].subject) {
Logger.info({ fileName, subject: formsByFileName[fileName].subject }, 'Using custom subject');
return formsByFileName[fileName].subject;
} else {
return 'Polarity Form Submission';
}
}
async function getTemplate({ user, entity, integrationData, formName, fields, fileName }) {
let subject = getEmailSubject(fileName);
Logger.trace({ user, entity, integrationData, formName, fields, fileName, subject }, 'Building template');
const template = await emailer.renderAll('rfi-hbs', {
integrationData,
entity,
user,
formName,
fields,
subject
});
return template;
}
async function sendEmail(template, user, fileName, recipient, options) {
const emailSettings = {
text: template.text,
from: options.sender.length > 0 ? options.sender : `"${user.fullName}" <${user.email}>`,
to: getRecipient(fileName, recipient, options),
subject: template.subject,
html: template.html
};
Logger.debug({ emailSettings, fn: 'send' }, 'Sending Email');
return new Promise((resolve, reject) => {
smtpClient.sendMail(emailSettings, (err, result) => {
if (err) {
Logger.error(err, 'Error sending email');
reject(err);
} else {
Logger.trace({ result }, 'Result');
resolve();
}
});
});
}
function maybeLoadForms(options) {
if (forms.length === 0 || previousFormSelection !== options.forms) {
forms = [];
formsByFileName = {};
options.forms
.split(',')
.map((form) => form.trim())
.forEach((formName) => {
const form = require(`${FORMS_DIRECTORY}/${formName}.json`);
if (!Array.isArray(form.elements)) {
throw {
detail: `The form "${formName}" does not have an "elements" property defined. Please add an "elements" property to the form and try again.`
};
}
form.elements = form.elements.map((element, elementIndex) => {
if (!element.type) {
Logger.error(
{ element, elementIndex },
`The form element at index "${elementIndex}" from "${interfaceName}.json" does not have a "type" property defined. Please add a "type" to the element and try again.`
);
throw {
elementIndex,
element,
detail: `The form element at index "${elementIndex}" from "${interfaceName}.json" does not have a "type" property defined. Please add a "type" to the element and try again.`
};
}
validateRequiredFields(element.type, Object.keys(element));
return Object.assign({}, formDefaults[element.type], element);
});
form.fileName = formName;
forms.push(form);
formsByFileName[formName] = form;
});
previousFormSelection = options.forms;
Logger.trace({ forms }, 'Forms Loaded');
}
}
function validateRequiredFields(elementType, availableFields) {
const requiredFields = formRequiredFields[elementType];
if (!requiredFields) {
throw {
detail: `The form element of type "${elementType}" is not supported. Please use one of the following types: ${Object.keys(
formRequiredFields
).join(', ')}`
};
}
requiredFields.forEach((requiredField) => {
if (!availableFields.includes(requiredField)) {
Logger.error(
{ elementType, availableFields, requiredField },
`The form element is missing the required field: ${requiredField}`
);
throw {
elementType,
availableFields,
requiredField,
detail: `The form element is missing the required field: ${requiredField}`
};
}
});
}
async function getAvailableForms() {
const fileNames = await readdir(FORMS_DIRECTORY);
return fileNames.reduce((accum, fileName) => {
if (fileName.endsWith('.json')) {
accum.push(fileName.slice(0, -5));
}
return accum;
}, []);
}
const parseErrorToReadableJSON = (error) => JSON.parse(JSON.stringify(error, Object.getOwnPropertyNames(error)));
async function onMessage(payload, options, cb) {
Logger.trace({ payload }, 'onMessage');
maybeInitSmtp(options);
maybeSetupTemplateBuilder();
try {
const template = await getTemplate(payload, options);
if (options.deliveryMethod.value === 'email' || options.deliveryMethod.value === 'emailAndLog') {
await sendEmail(template, payload.user, payload.fileName, payload.recipient, options);
}
if (options.deliveryMethod.value === 'log' || options.deliveryMethod.value === 'emailAndLog') {
Logger.info(template.text, 'Form submitted');
}
cb(null, {
detail: 'Success'
});
} catch (sendEmailError) {
const jsonError = parseErrorToReadableJSON(sendEmailError);
Logger.error({ error: jsonError }, 'Error submitting form');
cb({
detail: 'Error encountered submitting form',
error: jsonError
});
}
}
async function validateSmtpOptions(userOptions) {
return new Promise((resolve, reject) => {
let errors = [];
let formattedOptions = {};
for (const option in userOptions) {
formattedOptions[option] = userOptions[option].value;
}
setupSmtpClient(formattedOptions);
setupTemplateBuilder();
Logger.trace({ formattedOptions }, 'Validating SMTP Options');
smtpClient.verify((smtpError, success) => {
if (smtpError) {
let smtpKeys = ['smtpHost', 'smtpPort', 'smtpConnectionSecurity'];
if (userOptions.smtpUser.value.length > 0 || userOptions.smtpPassword.value.length > 0) {
smtpKeys.push('smtpUser', 'smtpPassword');
}
smtpKeys.forEach((key) => {
errors.push({
key,
message: `SMTP Connection Error: ${smtpError}`
});
});
Logger.error({ smtpError, polarityErrors: errors }, 'Got an error back');
}
resolve(errors);
});
});
}
async function validateOptions(userOptions, cb) {
Logger.trace({ userOptions }, 'Validating Options');
let errors = [];
if (
typeof userOptions.recipient.value !== 'string' ||
(typeof userOptions.recipient.value === 'string' && userOptions.recipient.value.length === 0)
) {
errors.push({
key: 'recipient',
message: 'You must provide a default recipient email address'
});
}
if (
typeof userOptions.forms.value !== 'string' ||
(typeof userOptions.forms.value === 'string' && userOptions.forms.value.length === 0)
) {
errors.push({
key: 'forms',
message: 'You must provide a valid forms name'
});
} else {
const availableForms = await getAvailableForms();
Logger.trace({ availableForms }, 'Available forms');
let forms = userOptions.forms.value.split(',').map((form) => form.trim());
forms.forEach((form) => {
if (!availableForms.includes(form)) {
errors.push({
key: 'forms',
message: `${form} is not a valid form name. Valid names are: ${availableForms.join(', ')}`
});
}
});
}
if (userOptions.deliveryMethod.value.value === 'email' || userOptions.deliveryMethod.value.value === 'emailAndLog') {
errors = errors.concat(await validateSmtpOptions(userOptions));
}
cb(null, errors);
}
module.exports = {
startup,
doLookup,
onMessage,
validateOptions
};