-
Notifications
You must be signed in to change notification settings - Fork 9
/
cli.ts
228 lines (210 loc) · 9.03 KB
/
cli.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
#!/usr/bin/env node
import crypto from "crypto";
import fs from "fs";
import path from "path";
import spawn from "await-spawn";
import flattenDeep from "lodash.flattendeep";
import ts from "typescript";
import { program } from "commander";
import shq from "shell-quote";
import {
default_mock,
default_cost_pattern,
default_tags,
default_command,
merge_defaults,
get_all_ts_files,
report,
TsSqlPluginConfig,
trim_middle_comments,
} from "./lib/utils";
import { make_fake_expression } from "./lib/make_fake_expression";
import { directiveRegex, parseDirectives } from "./lib/directiveParser";
import { addToSqlCache, existsInSqlCache } from './lib/cache';
program
.option("-w, --watch", `watch mode of cli`)
.option("-p, --project <string>", "ts project path where tsconfig.json is in", "./")
.option("-e, --exclude <regexp>", "regexp to exclude files", "node_modules")
.option("--emit_dir <path>", "where sqls will be emitted")
// ! --mock, --error_cost, --warn_cost, --info_cost, --cost_pattern, --tags, --command are the same as plugin options
// ! do not use commander default option value, to use the options in tsconfig.json
.option(
"-m, --mock <string>",
`string to mock the values in the fake sqls, you can override it with: sql.mock<'null'>(any_value) (default: "${default_mock}")`,
)
.option("--error_cost <number>", `throw error if explain cost exceeds treshold`)
.option("--warn_cost <number>", `log warning if explain cost exceeds treshold`)
.option("--info_cost <number>", `log info if explain cost exceeds treshold`)
.option(
"--cost_pattern <regexp>",
`regexp to extract cost from command stdout, make sure the number is the first capturing group (default: "/${default_cost_pattern.source}/")`,
// (str, pv) => new RegExp(str || pv),
// default_cost_pattern.source as any as RegExp
)
.option(
"-t, --tags <string>",
`tags you used in you ts file (default: "${Object.entries(default_tags)
.map(it => it.join("="))
.join(",")}")`,
(str, pv) => {
return Object.fromEntries(str.split(",").map(s => s.split("=")));
// return [(pv as any) as string, str]
// .map((it) => Object.fromEntries(it.split(",").map((s) => s.split("="))))
// .reduce((acc, cv) => ({ ...acc, ...cv }), {}) as typeof default_tags;
},
// (Object.entries(default_tags)
// .map((it) => it.join("="))
// .join(",") as any) as typeof default_tags
)
.option(
"-c, --command <string>",
`command to be run to explain the fake sql (default: "${default_command}")` /* default_command */,
)
.description(
`Explain all your sqls in your code to test them. \n\nEg: ts-sql-plugin -p ./my_ts_projet/tsconfig.json -c 'psql -c'`,
)
.action(async () => {
let cli_config: any = program.opts();
if (typeof cli_config.command !== "string") {
cli_config.command = undefined;
}
cli_config.exclude = new RegExp(cli_config.exclude);
const ts_config_path = ts.findConfigFile(cli_config.project, ts.sys.fileExists, "tsconfig.json");
if (!ts_config_path) {
throw new Error("Could not find a valid 'tsconfig.json'.");
}
const { config: ts_config } = ts.parseConfigFileTextToJson(
ts_config_path,
await fs.promises.readFile(ts_config_path, { encoding: "utf8" }),
);
let plugin_config: TsSqlPluginConfig = (ts_config.compilerOptions.plugins as any[])?.find(
it => it.name === "ts-sql-plugin",
);
plugin_config = merge_defaults(plugin_config, cli_config);
const cost_pattern = new RegExp(plugin_config.cost_pattern!);
const initProgram = ts.createProgram(get_all_ts_files(path.dirname(ts_config_path)), ts_config.compilerOptions);
let fake_expression = make_fake_expression(initProgram.getTypeChecker(), plugin_config.tags);
if (cli_config.watch) {
const watchHost = ts.createWatchCompilerHost(ts_config_path, undefined, ts.sys);
const watchProgram = ts.createWatchProgram(watchHost);
const onChangeFile = (fileName: string) => {
const file = watchProgram.getProgram().getSourceFile(fileName);
if (file) {
fake_expression = make_fake_expression(
watchProgram.getProgram().getProgram().getTypeChecker(),
plugin_config.tags,
);
delint(file);
}
};
const watchFile = (sourceFile: ts.SourceFile) => {
watchHost.watchFile(sourceFile.fileName, (fileName, event) => {
if (event !== ts.FileWatcherEventKind.Deleted) {
onChangeFile(fileName);
}
});
};
const source_files = watchProgram
.getProgram()
.getSourceFiles()
.filter(it => !cli_config.exclude.test(it.fileName));
source_files.forEach(watchFile);
source_files.forEach(it => onChangeFile(it.fileName));
return;
}
let has_error = false;
let report_errors: [sourceFile: ts.SourceFile, node: ts.Node, message: string, level?: 1 | 2][] = [];
console.log("-- Start init sql check and emit...");
for (const file of initProgram.getSourceFiles().filter(f => !cli_config.exclude.test(f.fileName))) {
await delint(file);
}
if (has_error) {
console.error("\n\n-- Your code can not pass all sql test!!!\n");
report_errors.forEach(args => report(...args));
process.exit(1);
}
console.log("\n\n-- Init sql check and emit finished.\n");
function recursiveAllChildrenNodes(node: ts.Node): ts.Node[] {
return (node.getChildren().map(n => [n, ...recursiveAllChildrenNodes(n)]) as unknown) as ts.Node[];
}
async function delint(sourceFile: ts.SourceFile) {
const treeNodes = recursiveAllChildrenNodes(sourceFile);
const sqlTagNodes = flattenDeep(treeNodes).filter(
(n): n is ts.TaggedTemplateExpression =>
n.kind === ts.SyntaxKind.TaggedTemplateExpression &&
(n as ts.TaggedTemplateExpression).tag.getText() === plugin_config.tags.sql,
);
await Promise.all(sqlTagNodes.map(delintNode));
async function delintNode(node: ts.TaggedTemplateExpression) {
let query_configs = fake_expression(node);
for (const qc of query_configs) {
let s: string = trim_middle_comments(qc.text).replace(/\?\?/gm, plugin_config.mock);
const directives = parseDirectives(s);
if (cli_config.emit_dir) {
const emit_directive = directives.find(d => d.directive === "emit");
if (emit_directive) {
const fileName = (emit_directive.arg as string) ?? crypto.createHash("sha1").update(s).digest("hex");
const filePath = `${cli_config.emit_dir}/${fileName}.sql`;
try {
fs.writeFileSync(filePath, s + ";");
} catch (err) {
console.log(`-- Emit Error occured, when emitting file "${filePath}"`);
}
}
}
console.log(`\n\n-- EXPLAIN\n${s};`);
const [_command, ..._command_args] = (shq
.parse(plugin_config.command)
.concat("EXPLAIN " + s) as any) as string[];
if (existsInSqlCache(_command, _command_args)) {
continue;
}
const p = await spawn(_command, _command_args).catch((e: Error & { stderr: string }) => e);
const stdout = p.toString();
if (p instanceof Error) {
has_error = true;
report(sourceFile, node, p.stderr);
report_errors.push([sourceFile, node, p.stderr, 2]);
break;
}
if (
(plugin_config.error_cost || plugin_config.warn_cost || plugin_config.info_cost) &&
!directives.some(d => d.directive === "ignore-cost")
) {
const match = stdout.match(cost_pattern);
if (match) {
const [_, cost_str] = match;
const cost = Number(cost_str);
if (cost > plugin_config.error_cost!) {
has_error = true;
report(sourceFile, node, `Error: explain cost is too high: ${cost}\n${s}`, 2);
report_errors.push([sourceFile, node, `Error: explain cost is too high: ${cost}\n${s}`, 2]);
break;
} else if (cost > plugin_config.warn_cost!) {
report(sourceFile, node, `Warn: explain cost is at warning: ${cost}\n${s}`, 2);
} else if (cost > plugin_config.info_cost!) {
report(sourceFile, node, `Info: explain cost is ok: ${cost}\n${s}`, 1);
}
} else {
has_error = true;
report(
sourceFile,
node,
`Error: can not extract cost with cost_pattern: ${cost_pattern.source}\n${stdout}\n${s}`,
2,
);
report_errors.push([
sourceFile,
node,
`Error: can not extract cost with cost_pattern: ${cost_pattern.source}\n${stdout}\n${s}`,
2,
]);
break;
}
}
addToSqlCache(_command, _command_args);
}
}
}
})
.parseAsync(process.argv);