Ghost/ghost/members-csv/lib/parse.js
Naz c0a415e0e1
Added strict header mapping parsing
refs https://github.com/TryGhost/Toolbox/issues/430

- Previously the CSV parser had "map whatever you can and pass on unknown properties further" approach to CSV parsing. This logic has led to unwanted fields leaking through CSV imports - messy, dangerous.
- The strict mapping rules act as a "validator" to the user input, only passing through the fields we expect explicitly - safer clean cut solution with no unintended side-effects.
2022-10-19 18:10:40 +08:00

97 lines
3.0 KiB
JavaScript

const Promise = require('bluebird');
const pump = require('pump');
const papaparse = require('papaparse');
const fs = require('fs-extra');
/**
*
* @param {string} path - The path to the CSV to prepare
* @param {Object.<string, string>} headerMapping - An object whose keys are headers in the input CSV and values are the header to replace it with
* @param {Array<string>} [defaultLabels] - A list of labels to apply to every parsed member row
* @returns
*/
module.exports = (path, headerMapping, defaultLabels = []) => {
return new Promise(function (resolve, reject) {
const csvFileStream = fs.createReadStream(path);
const csvParserStream = papaparse.parse(papaparse.NODE_STREAM_INPUT, {
header: true,
transformHeader(_header) {
if (!headerMapping || !Reflect.has(headerMapping, _header)) {
return undefined;
}
return headerMapping[_header];
},
transform(value, header) {
if (header === 'labels') {
if (value && typeof value === 'string') {
return value.split(',').map(name => ({name}));
}
}
if (header === 'products') {
if (value && typeof value === 'string') {
return value.split(',').map(name => ({name}));
}
}
if (header === 'subscribed') {
return value.toLowerCase() !== 'false';
}
if (header === 'complimentary_plan') {
return value.toLowerCase() === 'true';
}
if (value === '') {
return null;
}
if (value === 'undefined') {
return null;
}
if (value.toLowerCase() === 'false') {
return false;
}
if (value.toLowerCase() === 'true') {
return true;
}
return value;
}
});
const rows = [];
const parsedCSVStream = pump(csvFileStream, csvParserStream, (err) => {
if (err) {
return reject(err);
}
resolve(rows);
});
parsedCSVStream.on('data', (row) => {
// unmapped columns end up being assigned to 'undefined' property
// in the transformHeader stage, those should be removed completely
if (Reflect.has(row, 'undefined')) {
delete row.undefined;
}
// skip a rows with no data
if (!Object.keys(row).length){
return;
}
if (row.labels) {
row.labels = row.labels.concat(defaultLabels);
} else {
row.labels = defaultLabels;
}
rows.push(row);
});
});
};