-
Notifications
You must be signed in to change notification settings - Fork 30
/
AsyncArgdownApplication.ts
337 lines (324 loc) · 10 KB
/
AsyncArgdownApplication.ts
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
"use strict";
import defaultsDeep from "lodash.defaultsdeep";
import isFunction from "lodash.isfunction";
import isString from "lodash.isstring";
import isEmpty from "lodash.isempty";
import isObject from "lodash.isobject";
import cloneDeep from "lodash.clonedeep";
import {
ArgdownApplication,
IArgdownRequest,
IArgdownResponse,
ArgdownPluginError
} from "@argdown/core";
import { isAsyncPlugin } from "./IAsyncArgdownPlugin";
import path from "path";
import chokidar from "chokidar";
import glob from "glob";
import { promisify } from "util";
import importFresh from "import-fresh";
import { readFile } from "fs";
const readFileAsync = promisify(readFile);
export class AsyncArgdownApplication extends ArgdownApplication {
async runAsync(
request: IArgdownRequest,
response?: IArgdownResponse
): Promise<IArgdownResponse> {
let processorsToRun: string[] = [];
this.logger.setLevel("error");
let resp: IArgdownResponse = response || {};
let req = request;
if (req) {
if (req.logLevel) {
this.logger.setLevel(req.logLevel);
}
if (req.process) {
if (Array.isArray(req.process)) {
processorsToRun = req.process;
} else if (
isString(req.process) &&
req.processes &&
req.processes[req.process]
) {
const processObj = req.processes[req.process];
req = defaultsDeep({}, processObj, req);
if (isString(req.process)) {
processorsToRun = this.defaultProcesses[req.process];
} else if (req.process && req.process.constructor === Array) {
processorsToRun = <string[]>req.process;
}
} else if (isString(req.process)) {
processorsToRun = this.defaultProcesses[req.process];
}
}
}
if (isEmpty(processorsToRun)) {
this.logger.log(
"error",
"[AsyncArgdownApplication]: No processors to run."
);
return resp;
}
const exceptions: Error[] = [];
resp.exceptions = exceptions;
for (let processorId of processorsToRun) {
let cancelProcessor = false;
let processor = this.processors[processorId];
if (!processor) {
this.logger.log(
"error",
"[AsyncArgdownApplication]: Processor not found: " + processorId
);
continue;
}
this.logger.log(
"verbose",
"[AsyncArgdownApplication]: Running processor: " + processorId
);
for (let plugin of processor.plugins) {
if (isFunction(plugin.prepare)) {
this.logger.log(
"verbose",
"[AsyncArgdownApplication]: Preparing plugin: " + plugin.name
);
try {
plugin.prepare(req, resp, this.logger);
} catch (e) {
if (req.throwExceptions) {
throw e;
} else if (e instanceof ArgdownPluginError) {
e.processor = processorId;
exceptions.push(e);
cancelProcessor = true;
this.logger.log("warning", `Processor ${processorId} canceled.`);
break;
}
}
}
}
if (cancelProcessor) {
break;
}
if (resp.ast && processor.walker) {
try {
processor.walker.walk(req, resp, this.logger);
} catch (e) {
if (req.throwExceptions) {
throw e;
} else if (e instanceof ArgdownPluginError) {
e.processor = processorId;
cancelProcessor = true;
exceptions.push(e);
this.logger.log(
"warning",
`[ArgdownApplication]: Processor ${processorId} canceled.`
);
break;
}
}
}
if (cancelProcessor) {
break;
}
for (let plugin of processor.plugins) {
this.logger.log(
"verbose",
"[AsyncArgdownApplication]: Running plugin: " + plugin.name
);
try {
if (isAsyncPlugin(plugin)) {
await plugin.runAsync(req, resp, this.logger);
} else if (isFunction(plugin.run)) {
plugin.run(req, resp, this.logger);
}
} catch (e) {
if (req.throwExceptions) {
throw e;
} else if (e instanceof ArgdownPluginError) {
e.processor = processorId;
cancelProcessor = true;
this.logger.log("warning", `Processor ${processorId} canceled.`);
exceptions.push(e);
break;
}
}
}
if (cancelProcessor) {
break;
}
}
if (req.logExceptions === undefined || req.logExceptions) {
for (let exception of exceptions) {
let msg = exception.stack || exception.message;
if (exception instanceof ArgdownPluginError) {
msg = `[${exception.processor}/${exception.plugin}]: ${msg}`;
}
this.logger.log("error", msg);
}
}
return resp;
}
load = async (
request: IArgdownRequest
): Promise<IArgdownResponse[] | undefined> => {
const processObj =
request.processes && isString(request.process)
? request.processes[request.process]
: undefined;
let req = request;
if (processObj) {
req = defaultsDeep({}, processObj, req);
}
let inputGlob = req.inputPath || "./*.argdown";
const ignoreFiles = req.ignore || [
"**/_*", // Exclude files starting with '_'.
"**/_*/**" // Exclude entire directories starting with '_'.
];
if (
req.logger &&
isFunction(req.logger.log) &&
isFunction(req.logger.setLevel)
) {
if (!this.defaultLogger) {
this.defaultLogger = this.logger;
}
this.logger = req.logger;
} else if (this.defaultLogger) {
this.logger = this.defaultLogger;
}
if (!req.rootPath) {
req.rootPath = process.cwd();
}
if (req.logLevel) {
this.logger.setLevel(req.logLevel);
}
if (req.plugins) {
for (let pluginData of req.plugins) {
if (isObject(pluginData.plugin) && isString(pluginData.processor)) {
this.addPlugin(pluginData.plugin, pluginData.processor);
}
}
}
if (req.input && !req.inputPath) {
await this.runAsync(cloneDeep(request));
return;
}
const $ = this;
let absoluteInputGlob = path.resolve(req.rootPath, inputGlob);
const loadOptions: chokidar.WatchOptions = {};
if (ignoreFiles) {
// error in WatchOptions type declaration: option is called "ignore", not "ignored":
(<any>loadOptions).ignore = ignoreFiles;
}
if (req.watch) {
const watcher = chokidar.watch(absoluteInputGlob, loadOptions);
const watcherRequest = cloneDeep(req);
watcherRequest.watch = false;
watcher
.on("add", path => {
this.logger.log("verbose", `File ${path} has been added.`);
watcherRequest.inputPath = path;
$.load(watcherRequest);
})
.on("change", path => {
this.logger.log("verbose", `File ${path} has been changed.`);
watcherRequest.inputPath = path;
$.load(watcherRequest);
})
.on("unlink", path => {
this.logger.log("verbose", `File ${path} has been removed.`);
});
} else {
let files: string[] = await new Promise<string[]>((resolve, reject) => {
glob(
absoluteInputGlob,
loadOptions,
(er: Error | null, files: string[]) => {
if (er) {
reject(er);
}
resolve(files);
}
);
});
const promises = [];
if (files.length == 0) {
throw new ArgdownPluginError(
"AsyncArgdownApplication.load",
"no-files-found",
`No Argdown files found at: '${absoluteInputGlob}'`
);
}
for (let file of files) {
const requestForFile = cloneDeep(request);
requestForFile.inputPath = file;
promises.push(this.runAsync(requestForFile));
}
// Remove plugins added by request
if (req.plugins) {
for (let pluginData of req.plugins) {
this.removePlugin(pluginData.plugin, pluginData.processor);
}
}
return await Promise.all(promises);
}
return;
};
loadConfig = async (filePath?: string): Promise<IArgdownRequest> => {
let config: IArgdownRequest = {};
filePath = filePath || "argdown.config.json"; // json is default because it can be loaded asynchronously
filePath = path.resolve(process.cwd(), filePath);
const extension = path.extname(filePath);
// We use non-blocking IO for JSON config files
if (extension === ".json") {
try {
const buffer = await readFileAsync(filePath, "utf8");
config = JSON.parse(buffer);
} catch (e) {
if (e instanceof Error) {
this.logger.log(
"verbose",
"[AsyncArgdownApplication]: No config found: " + e.toString()
);
}
}
} else if (extension === ".js") {
// For Js config files we have to use loadJSFile which is synchronous
try {
let jsModuleExports = loadJSFile(filePath);
if (jsModuleExports.config) {
config = jsModuleExports.config;
} else {
// let's try the default export
config = jsModuleExports;
}
} catch (e) {
if (e instanceof Error) {
this.logger.log(
"verbose",
"[AsyncArgdownApplication]: No config found: " + e.toString()
);
}
}
}
return config;
};
}
/**
* Taken from eslint: https://github.com/eslint/eslint/blob/master/lib/config/config-file.js
* Loads a JavaScript configuration from a file.
* @param {string} filePath The filename to load.
* @returns {Object} The configuration object from the file.
* @throws {Error} If the file cannot be read.
* @private
*/
const loadJSFile = (filePath: string) => {
try {
return importFresh(filePath);
} catch (e) {
if (e instanceof Error) {
e.message = `Cannot read file: ${filePath}\nError: ${e.message}`;
}
throw e;
}
};