2133

pending completion

Build # 2133

Build Type

push

travis-ci

Committed by

tripu

Commit Message

<a href="https://github.com/w3c/echidna/commit/<a class=hub.com/w3c/echidna/commit/4630bb40e5363279090bfbc758a504d2f92f62d6">4630bb40e<a href="https://github.com/w3c/echidna/commit/4630bb40e5363279090bfbc758a504d2f92f62d6">">Commit </a><a class="double-link" href="https://github.com/w3c/echidna/commit/<a class="double-link" href="https://github.com/w3c/echidna/commit/0876bec967ff15d75d9c9fa6d69d892cc45775a2">0876bec96</a>">0876bec96</a><a href="https://github.com/w3c/echidna/commit/4630bb40e5363279090bfbc758a504d2f92f62d6"> bis

Run Details

118 of 402 branches covered (29.35%)

7 of 7 new or added lines in 2 files covered. (100.0%)

367 of 798 relevant lines covered (45.99%)

5.04 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/lib/mailer.js

/* eslint-disable no-console */

'use strict';

const fs = require('fs');
const nodemailer = require('nodemailer');
const meta = require('../package');
const Orchestrator = require('./orchestrator');
const SpecberusWrapper = require('./specberus-wrapper');
const mailTemplatesDir = `${__dirname}/../assets/mail-templates/`;
const fields = ['TITLE', 'SHORTNAME', 'TYPE', 'URL', 'ID', 'TIMESTAMP', 'ECHIDNA', 'SPECBERUS', 'SOURCE', 'ENCODEDSOURCE', 'ERRORS'];
const pubrulesInstance = 'https://www.w3.org/pubrules/doc/rules/?profile=';

var templateTextFailure;
var templateTextSuccess;
var templateMarkupFailure;
var templateMarkupSuccess;

let transporter = nodemailer.createTransport({
    sendmail: true,
    newline: 'unix',
    path: '/usr/sbin/sendmail',
});

const formatErrors = (s, profile) => {
  var result = '  👎 Unspecified error\n';

  if (s) {
    result = '';

    if (s.history && s.history.facts) {
      const sortedFacts = s.history.facts.toArray().sort((a, b) => {
        if (a.time < b.time)
          return -1;
        else if (b.time < a.time)
          return 1;
        else
          return 0;
      });

      for (let h of sortedFacts) {
        result += `    ${h.fact}\n`;
      }
    }

    if (s.jobs) {
      s.jobs.forEach((j) => {
        console.log(JSON.stringify(j, null, 2));
        if (Orchestrator.STATUS_FAILURE === j.get('status') || Orchestrator.STATUS_ERROR === j.get('status'))
          if (j.errors)
            j.errors.forEach((e) => {
              if ('string' === typeof e)
                result += `  👎 ${e}\n`;
              else if ('object' === typeof e) {
                if (e.extra && e.extra.message)
                  result += `  👎 ${e.extra.message}\n`;
                else if (e.key)
                  result += `  👎 Error code “${e.key}”.\n`;
                if (e.type && e.type.rule && profile)
                  result += `      ⮡ cf ${pubrulesInstance}${profile}#${e.type.rule}\n`;
              }
            });
      });
    }
  }

  return result;
};

const extractFields = (s, json) => ({
  TITLE: s.results ? s.results.get('metadata').get('title') : '[unknown]',
  SHORTNAME: s.results ? s.results.get('metadata').get('shortname') : '[unknown]',
  TYPE: s.results ? s.results.get('metadata').get('profile') : '[unknown]',
  URL: s.url ? s.url : '[unknown]',
  ID: s.id ? s.id : '[unknown]',
  TIMESTAMP: new Date().toString(),
  ECHIDNA: s.version ? s.version : meta.version,
  SPECBERUS: s['version-specberus'] ? s['version-specberus'] : SpecberusWrapper.version,
  SOURCE: s.url ? s.url : (s.tar ? `“${s.tar}”` : 'a spec'),
  ENCODEDSOURCE: encodeURIComponent(s.url ? `\`${s.url}\`` : (s.tar ? `\`${s.tar}\`` : 'a spec')),
  ERRORS: formatErrors(json, s.results ? s.results.get('metadata').get('profile') : null)
});

const interpolateTemplate = (t, v) => {
  var result = t;

  console.log('interpolate before: ' + t);

  for (var f of fields) {
    result = result.replace(new RegExp(`@${f}`, 'gi'), v[f]);
  }

  console.log('interpolate after: ' + result);
  return result;
};

const prepareTemplates = () => {
  fs.readFile(`${mailTemplatesDir}failure.txt`, (err1, txtFailure) => {
    if (err1)
      throw new Error(`Cannot read plain-text mail template for failures: “${err1}”`);
    else
      fs.readFile(`${mailTemplatesDir}success.txt`, (err2, txtSuccess) => {
        if (err2)
          throw new Error(`Cannot read plain-text mail template for successes: “${err2}”`);
        else
          fs.readFile(`${mailTemplatesDir}failure.html`, (err3, markupFailure) => {
            if (err3)
              throw new Error(`Cannot read markup mail template for failures: “${err3}”`);
            else
              fs.readFile(`${mailTemplatesDir}success.html`, (err4, markupSuccess) => {
                if (err4)
                  throw new Error(`Cannot read markup mail template for successes: “${err4}”`);
                else {
                  templateTextFailure = String(txtFailure);
                  templateTextSuccess = String(txtSuccess);
                  templateMarkupFailure = String(markupFailure);
                  templateMarkupSuccess = String(markupSuccess);
                }
              });
          });
      });
  });
};

const composeSubject = (success, state, url) => {
  var result = '[Echidna] ';

  if (success)
    result += `✔️ Success: ${state.get('metadata').get('thisVersion')}`;
  else
    result += `✗ Failure: ${url}`;

  return result;
};

const composeTextBody = (success, state, json) => {
  var result;

  if (success)
    result = templateTextSuccess;
  else
    result = templateTextFailure;

  result = interpolateTemplate(result, extractFields(json, state));

  return result;
};

const composeHTMLBody = (success, state, json) => {
  var result;

  if (success)
    result = templateMarkupSuccess;
  else
    result = templateMarkupFailure;

  result = interpolateTemplate(result, extractFields(json, state));

  return result;
};

/**
 * Send e-mail notification about a publication job.
 *
 * @param id - job ID.
 * @param state - orchestrator state.
 * @param json - JSON data about the request.
 * @param url - URL (or TAR filename) that was to be published.
 */

const sendMessage = (id, state, json, url, ccEmail) => {
  const success = (Orchestrator.STATUS_SUCCESS === state.get('status'));
  // https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/email#Basic_validation
  var re =  /^[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/i;
  var additionalEmails = ",";
  if (ccEmail)
    additionalEmails += ccEmail.split(/[\s,;\t\n]+/).filter( e => re.test(e)).join(',');

  const message = {
    from: 'Echidna <sysbot+echidna@w3.org>',
    to: global.MAILING_LIST + additionalEmails,
    subject: composeSubject(success, state, url),
    text: composeTextBody(success, state, json),
    replyTo: global.MAIL_SENDER
  };

  if (global.SEND_HTML)
    message.html = composeHTMLBody(success, state, json);

  if (global.ATTACH_JSON) {
    message.text = message.text.replace(new RegExp('@ATTACHMENT'), ' (and in the file attached)');
    message.attachments = [
      {
        filename: `${id}.json`,
        content: json
      }
    ];
  }
  else
    message.text = message.text.replace(new RegExp('@ATTACHMENT'), '');

  transporter.sendMail(message, (error, info) => {
    if (error)
      return console.log(error);
    console.log(`Message ${info.messageId} sent: ${info.response}`);
  });
};

prepareTemplates();

module.exports.sendMessage = sendMessage;

1	/* eslint-disable no-console */
2
3	'use strict';
4
5	const fs = require('fs');	×
6	const nodemailer = require('nodemailer');	×
7	const meta = require('../package');	×
8	const Orchestrator = require('./orchestrator');	×
9	const SpecberusWrapper = require('./specberus-wrapper');	×
10	const mailTemplatesDir = `${__dirname}/../assets/mail-templates/`;	×
11	const fields = ['TITLE', 'SHORTNAME', 'TYPE', 'URL', 'ID', 'TIMESTAMP', 'ECHIDNA', 'SPECBERUS', 'SOURCE', 'ENCODEDSOURCE', 'ERRORS'];	×
12	const pubrulesInstance = 'https://www.w3.org/pubrules/doc/rules/?profile=';	×
13
14	var templateTextFailure;	×
15	var templateTextSuccess;	×
16	var templateMarkupFailure;	×
17	var templateMarkupSuccess;	×
18
19	let transporter = nodemailer.createTransport({	×
20	sendmail: true,
21	newline: 'unix',
22	path: '/usr/sbin/sendmail',
23	});
24
25	const formatErrors = (s, profile) => {	×
26	var result = ' 👎 Unspecified error\n';	×
27
28	if (s) {	×
29	result = '';	×
30
31	if (s.history && s.history.facts) {	×
32	const sortedFacts = s.history.facts.toArray().sort((a, b) => {	×
33	if (a.time < b.time)	×
34	return -1;	×
35	else if (b.time < a.time)	×
36	return 1;	×
37	else
38	return 0;	×
39	});
40
41	for (let h of sortedFacts) {	×
42	result += ` ${h.fact}\n`;	×
43	}
44	}
45
46	if (s.jobs) {	×
47	s.jobs.forEach((j) => {	×
48	console.log(JSON.stringify(j, null, 2));	×
49	if (Orchestrator.STATUS_FAILURE === j.get('status') \|\| Orchestrator.STATUS_ERROR === j.get('status'))	×
50	if (j.errors)	×
51	j.errors.forEach((e) => {	×
52	if ('string' === typeof e)	×
53	result += ` 👎 ${e}\n`;	×
54	else if ('object' === typeof e) {	×
55	if (e.extra && e.extra.message)	×
56	result += ` 👎 ${e.extra.message}\n`;	×
57	else if (e.key)	×
58	result += ` 👎 Error code “${e.key}”.\n`;	×
59	if (e.type && e.type.rule && profile)	×
60	result += ` ⮡ cf ${pubrulesInstance}${profile}#${e.type.rule}\n`;	×
61	}
62	});
63	});
64	}
65	}
66
67	return result;	×
68	};
69
70	const extractFields = (s, json) => ({	×
71	TITLE: s.results ? s.results.get('metadata').get('title') : '[unknown]',	×
72	SHORTNAME: s.results ? s.results.get('metadata').get('shortname') : '[unknown]',	×
73	TYPE: s.results ? s.results.get('metadata').get('profile') : '[unknown]',	×
74	URL: s.url ? s.url : '[unknown]',	×
75	ID: s.id ? s.id : '[unknown]',	×
76	TIMESTAMP: new Date().toString(),
77	ECHIDNA: s.version ? s.version : meta.version,	×
78	SPECBERUS: s['version-specberus'] ? s['version-specberus'] : SpecberusWrapper.version,	×
79	SOURCE: s.url ? s.url : (s.tar ? `“${s.tar}”` : 'a spec'),	×
80	ENCODEDSOURCE: encodeURIComponent(s.url ? `\`${s.url}\`` : (s.tar ? `\`${s.tar}\`` : 'a spec')),	×
81	ERRORS: formatErrors(json, s.results ? s.results.get('metadata').get('profile') : null)	×
82	});
83
84	const interpolateTemplate = (t, v) => {	×
85	var result = t;	×
86
87	console.log('interpolate before: ' + t);	×
88
89	for (var f of fields) {	×
90	result = result.replace(new RegExp(`@${f}`, 'gi'), v[f]);	×
91	}
92
93	console.log('interpolate after: ' + result);	×
94	return result;	×
95	};
96
97	const prepareTemplates = () => {	×
98	fs.readFile(`${mailTemplatesDir}failure.txt`, (err1, txtFailure) => {	×
99	if (err1)	×
100	throw new Error(`Cannot read plain-text mail template for failures: “${err1}”`);	×
101	else
102	fs.readFile(`${mailTemplatesDir}success.txt`, (err2, txtSuccess) => {	×
103	if (err2)	×
104	throw new Error(`Cannot read plain-text mail template for successes: “${err2}”`);	×
105	else
106	fs.readFile(`${mailTemplatesDir}failure.html`, (err3, markupFailure) => {	×
107	if (err3)	×
108	throw new Error(`Cannot read markup mail template for failures: “${err3}”`);	×
109	else
110	fs.readFile(`${mailTemplatesDir}success.html`, (err4, markupSuccess) => {	×
111	if (err4)	×
112	throw new Error(`Cannot read markup mail template for successes: “${err4}”`);	×
113	else {
114	templateTextFailure = String(txtFailure);	×
115	templateTextSuccess = String(txtSuccess);	×
116	templateMarkupFailure = String(markupFailure);	×
117	templateMarkupSuccess = String(markupSuccess);	×
118	}
119	});
120	});
121	});
122	});
123	};
124
125	const composeSubject = (success, state, url) => {	×
126	var result = '[Echidna] ';	×
127
128	if (success)	×
129	result += `✔️ Success: ${state.get('metadata').get('thisVersion')}`;	×
130	else
131	result += `✗ Failure: ${url}`;	×
132
133	return result;	×
134	};
135
136	const composeTextBody = (success, state, json) => {	×
137	var result;	×
138
139	if (success)	×
140	result = templateTextSuccess;	×
141	else
142	result = templateTextFailure;	×
143
144	result = interpolateTemplate(result, extractFields(json, state));	×
145
146	return result;	×
147	};
148
149	const composeHTMLBody = (success, state, json) => {	×
150	var result;	×
151
152	if (success)	×
153	result = templateMarkupSuccess;	×
154	else
155	result = templateMarkupFailure;	×
156
157	result = interpolateTemplate(result, extractFields(json, state));	×
158
159	return result;	×
160	};
161
162	/**
163	* Send e-mail notification about a publication job.
164	*
165	* @param id - job ID.
166	* @param state - orchestrator state.
167	* @param json - JSON data about the request.
168	* @param url - URL (or TAR filename) that was to be published.
169	*/
170
171	const sendMessage = (id, state, json, url, ccEmail) => {	×
172	const success = (Orchestrator.STATUS_SUCCESS === state.get('status'));	×
173	// https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/email#Basic_validation
174	var re = /^[a-zA-Z0-9.!#$%&'+\/=?^_`{\|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)$/i;	×
175	var additionalEmails = ",";	×
176	if (ccEmail)	×
177	additionalEmails += ccEmail.split(/[\s,;\t\n]+/).filter( e => re.test(e)).join(',');	×
178
179	const message = {	×
180	from: 'Echidna <sysbot+echidna@w3.org>',
181	to: global.MAILING_LIST + additionalEmails,
182	subject: composeSubject(success, state, url),
183	text: composeTextBody(success, state, json),
184	replyTo: global.MAIL_SENDER
185	};
186
187	if (global.SEND_HTML)	×
188	message.html = composeHTMLBody(success, state, json);	×
189
190	if (global.ATTACH_JSON) {	×
191	message.text = message.text.replace(new RegExp('@ATTACHMENT'), ' (and in the file attached)');	×
192	message.attachments = [	×
193	{
194	filename: `${id}.json`,
195	content: json
196	}
197	];
198	}
199	else
200	message.text = message.text.replace(new RegExp('@ATTACHMENT'), '');	×
201
202	transporter.sendMail(message, (error, info) => {	×
203	if (error)	×
204	return console.log(error);	×
205	console.log(`Message ${info.messageId} sent: ${info.response}`);	×
206	});
207	};
208
209	prepareTemplates();	×
210
211	module.exports.sendMessage = sendMessage;	×

w3c / echidna / 2133

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous