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
|
/**
* File system utilities.
* @module app/utils/file_utils
*/
import filesystem from "fs";
import parseCSV from "csv-parse";
import stringifyCSVCallback from "csv-stringify";
import archiver from "archiver";
import { streamToBuffer } from "@jorgeferrero/stream-to-buffer";
import StreamArray from "stream-json/streamers/StreamArray";
import { chain } from "stream-chain";
import zlib from "zlib";
// eslint-disable-next-line no-control-regex
const SANITIZE_CSV_INITIALS = new RegExp("^[-=+@\\x09\\x0D]");
/**
* Helper function to load CSV from a file
* @param {string} inputFile path to the file
* @return {Promise} promise which will resolve with the parsed CSV
*/
const csvReadOptions = {
columns: true,
};
export const loadCSV = (inputFile, options = {}) =>
new Promise((resolve, reject) => {
if (!filesystem.existsSync(inputFile)) {
return reject("inputFile does not exist");
}
const csvOptions = {
...csvReadOptions,
...options,
};
filesystem.readFile(inputFile, "utf8", (error, text) => {
if (error) {
return reject(`Error reading file: ${error}`);
}
try {
parseCSV(text, csvOptions, function (err, data) {
if (err) {
return reject("Error parsing JSON");
}
resolve(data);
});
} catch {
reject("Error parsing JSON");
}
});
});
/**
* Helper function to stringify an array-of-arrays to a CSV (with Promise interface)
* @param {Array[]} rows array of arrays
* @return {Promise} promise which will resolve with the stringified CSV
*/
export const stringifyCSV = (rows) =>
new Promise((resolve, reject) => {
stringifyCSVCallback(rows, (error, output) => {
if (error) {
reject(error);
} else {
resolve(output);
}
});
});
/**
* Helper function to attempt to mitigate malicious CSV data
* @param {Array[]} rows array of arrays
* @return {Array[]} the sanitized input
*/
export const sanitizeCSV = (rows) =>
rows.map((row) =>
row.map((cell) =>
cell && typeof cell === "string" && cell.match(SANITIZE_CSV_INITIALS)
? "'" + cell
: cell
)
);
/**
* Given a list of files containing CSV, return a binary ZIP
* @param {array} files list of files
* @param {array} files[].data CSV data (array of arrays)
* @param {array} files[].filename filename corresponding to this CSV
* @return {string} the output ZIP file
*/
export const zipCSVs = async (files) => {
const archive = archiver("zip", {
zlib: { level: 9 }, // Compression level. 0 = store uncompressed, 9 = most compression
});
await Promise.all(
files.map(async (file) => {
const csvString = await stringifyCSV(sanitizeCSV(file.data));
archive.append(csvString, { name: file.filename });
})
);
archive.finalize();
return await streamToBuffer(archive);
};
/**
* Helper function to load JSON from a file
* @param {string} inputFile path to the file
* @return {Promise} promise which will resolve with the parsed JSON
*/
export const loadJSON = (inputFile) =>
new Promise((resolve, reject) => {
if (!filesystem.existsSync(inputFile)) {
return reject("inputFile does not exist");
}
filesystem.readFile(inputFile, "utf8", (error, text) => {
if (error) {
return reject(`Error reading file: ${error}`);
}
try {
const data = JSON.parse(text);
resolve(data);
} catch {
reject("Error parsing JSON");
}
});
});
const writeFileOptions = {
replace: true,
};
/**
* Helper to write a string to a file
* @param {string} outputFile the file to write to
* @param {string|string[]} data the data to write
* @param {Object} options options, by default will overwrite the existing file
* @return {Promise} promise which will resolve when the file is saved
*/
export const writeFile = (outputFile, data, options = {}) => {
options = { ...writeFileOptions, ...options };
return new Promise((resolve, reject) => {
if (filesystem.existsSync(outputFile) && !options.replace) {
return reject("outputFile exists");
}
if (Array.isArray(data)) {
data = data.join("\n");
}
filesystem.writeFile(outputFile, data, { encoding: "utf8" }, (error) => {
if (error) {
return reject(`Error writing file: ${error}`);
}
resolve();
});
});
};
const writeJSONOptions = {
...writeFileOptions,
indent: true,
};
/**
* Helper to write JSON data to a file
* @param {string} outputFile the file to write to
* @param {Object} data the data to write
* @param {Object} options options, by default will overwrite the existing file
* @return {Promise} promise which will resolve when the file is saved
*/
export const writeJSON = (outputFile, data, options = {}) => {
options = { ...writeJSONOptions, ...options };
return new Promise((resolve, reject) => {
let json;
try {
if (options.indent) {
json = JSON.stringify(data, false, 2);
} else {
json = JSON.stringify(data);
}
} catch {
return reject("couldn't stringify JSON");
}
writeFile(outputFile, json, options).then(resolve).catch(reject);
});
};
/**
* Helper function to map over a JSON file, possibly gzipped
* @param {string} input the input file to be loaded
* @param {function} mapper the mapper function
* @param {object} state the master state object
*/
export async function mapJSONFile(input, mapper, state) {
return new Promise((resolve, reject) => {
let pipeline = chain(
[filesystem.createReadStream(input)]
.concat(input.match(/\.gz$/) ? [zlib.createGunzip()] : [])
.concat([
StreamArray.withParser(),
async (record) => {
await mapper(record.key, record.value, state);
},
])
);
pipeline.on("data", () => {});
pipeline.on("end", () => {
console.log(`Loaded ${input} ${state.dryrun ? " (dryrun)" : ""}`);
resolve();
});
pipeline.on("error", (error) => {
console.error(error);
reject();
});
});
}
|
