generateParsers.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524
  1. // Licensed to Cloudera, Inc. under one
  2. // or more contributor license agreements. See the NOTICE file
  3. // distributed with this work for additional information
  4. // regarding copyright ownership. Cloudera, Inc. licenses this file
  5. // to you under the Apache License, Version 2.0 (the
  6. // "License"); you may not use this file except in compliance
  7. // with the License. You may obtain a copy of the License at
  8. //
  9. // http://www.apache.org/licenses/LICENSE-2.0
  10. //
  11. // Unless required by applicable law or agreed to in writing, software
  12. // distributed under the License is distributed on an "AS IS" BASIS,
  13. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. // See the License for the specific language governing permissions and
  15. // limitations under the License.
  16. /* eslint-disable no-restricted-syntax */
  17. const fs = require('fs');
  18. const cli = require('jison/lib/cli');
  19. const LICENSE =
  20. '// Licensed to Cloudera, Inc. under one\n' +
  21. '// or more contributor license agreements. See the NOTICE file\n' +
  22. '// distributed with this work for additional information\n' +
  23. '// regarding copyright ownership. Cloudera, Inc. licenses this file\n' +
  24. '// to you under the Apache License, Version 2.0 (the\n' +
  25. '// "License"); you may not use this file except in compliance\n' +
  26. '// with the License. You may obtain a copy of the License at\n' +
  27. '//\n' +
  28. '// http://www.apache.org/licenses/LICENSE-2.0\n' +
  29. '//\n' +
  30. '// Unless required by applicable law or agreed to in writing, software\n' +
  31. '// distributed under the License is distributed on an "AS IS" BASIS,\n' +
  32. '// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n' +
  33. '// See the License for the specific language governing permissions and\n' +
  34. '// limitations under the License.\n';
  35. const SQL_STATEMENTS_PARSER_JSDOC =
  36. '/**\n' +
  37. ' * @param {string} input\n' +
  38. ' *\n' +
  39. ' * @return {SqlStatementsParserResult}\n' +
  40. ' */\n';
  41. const PARSER_FOLDER = '../../desktop/core/src/desktop/js/parse/sql/';
  42. const OUTPUT_FOLDER = '../../desktop/core/src/desktop/js/parse/';
  43. const JISON_FOLDER = '../../desktop/core/src/desktop/js/parse/jison/';
  44. const SQL_PARSER_REPOSITORY_PATH =
  45. '../../desktop/core/src/desktop/js/parse/sql/sqlParserRepository.ts';
  46. const SYNTAX_PARSER_IMPORT_TEMPLATE =
  47. ' KEY: () => import(/* webpackChunkName: "KEY-parser" */ \'./KEY/KEYSyntaxParser\')';
  48. const AUTOCOMPLETE_PARSER_IMPORT_TEMPLATE =
  49. ' KEY: () => import(/* webpackChunkName: "KEY-parser" */ \'./KEY/KEYAutocompleteParser\')';
  50. const parserDefinitions = {
  51. globalSearchParser: {
  52. sources: ['globalSearchParser.jison'],
  53. target: 'globalSearchParser.jison',
  54. outputFolder: OUTPUT_FOLDER,
  55. afterParse: contents =>
  56. new Promise(resolve => {
  57. resolve(
  58. LICENSE +
  59. contents.replace(
  60. 'var globalSearchParser = ',
  61. "import SqlParseSupport from 'parse/sqlParseSupport';\n\nvar globalSearchParser = "
  62. ) +
  63. '\nexport default globalSearchParser;\n'
  64. );
  65. })
  66. },
  67. solrFormulaParser: {
  68. sources: ['solrFormulaParser.jison'],
  69. target: 'solrFormulaParser.jison',
  70. outputFolder: OUTPUT_FOLDER,
  71. afterParse: contents =>
  72. new Promise(resolve => {
  73. resolve(LICENSE + contents + 'export default solrFormulaParser;\n');
  74. })
  75. },
  76. solrQueryParser: {
  77. sources: ['solrQueryParser.jison'],
  78. target: 'solrQueryParser.jison',
  79. outputFolder: OUTPUT_FOLDER,
  80. afterParse: contents =>
  81. new Promise(resolve => {
  82. resolve(LICENSE + contents + 'export default solrQueryParser;\n');
  83. })
  84. },
  85. sqlStatementsParser: {
  86. sources: ['sqlStatementsParser.jison'],
  87. target: 'sqlStatementsParser.jison',
  88. outputFolder: OUTPUT_FOLDER,
  89. afterParse: contents =>
  90. new Promise(resolve => {
  91. resolve(
  92. LICENSE +
  93. contents.replace(
  94. 'parse: function parse',
  95. SQL_STATEMENTS_PARSER_JSDOC + 'parse: function parse'
  96. ) +
  97. 'export default sqlStatementsParser;\n'
  98. );
  99. })
  100. },
  101. hplsqlStatementsParser: {
  102. sources: ['hplsqlStatementsParser.jison'],
  103. target: 'hplsqlStatementsParser.jison',
  104. outputFolder: OUTPUT_FOLDER,
  105. afterParse: contents =>
  106. new Promise(resolve => {
  107. resolve(
  108. LICENSE +
  109. contents.replace(
  110. 'parse: function parse',
  111. SQL_STATEMENTS_PARSER_JSDOC + 'parse: function parse'
  112. ) +
  113. 'export default hplsqlStatementsParser;\n'
  114. );
  115. })
  116. }
  117. };
  118. const mkdir = path =>
  119. new Promise((resolve, reject) => {
  120. if (fs.existsSync(path)) {
  121. resolve();
  122. } else {
  123. fs.mkdir(path, err => {
  124. if (err) {
  125. reject(err);
  126. }
  127. resolve();
  128. });
  129. }
  130. });
  131. const readFile = path =>
  132. new Promise((resolve, reject) => {
  133. fs.readFile(path, (err, buf) => {
  134. if (err) {
  135. reject(err);
  136. }
  137. resolve(buf ? buf.toString() : '');
  138. });
  139. });
  140. const writeFile = (path, contents) =>
  141. new Promise((resolve, reject) => {
  142. fs.writeFile(path, contents, err => {
  143. if (err) {
  144. reject();
  145. }
  146. resolve();
  147. });
  148. });
  149. const copyFile = (source, destination, contentsCallback) =>
  150. new Promise((resolve, reject) => {
  151. readFile(source)
  152. .then(contents => {
  153. writeFile(destination, contentsCallback ? contentsCallback(contents) : contents)
  154. .then(resolve)
  155. .catch(reject);
  156. })
  157. .catch(reject);
  158. });
  159. const deleteFile = path => {
  160. fs.unlinkSync(path);
  161. };
  162. const generateParser = parserName =>
  163. new Promise((resolve, reject) => {
  164. const parserConfig = parserDefinitions[parserName];
  165. const concatPromise = new Promise((resolve, reject) => {
  166. if (parserConfig.sources.length > 1 && parserConfig.target) {
  167. console.log('Concatenating files...');
  168. const promises = parserConfig.sources.map(fileName => readFile(JISON_FOLDER + fileName));
  169. Promise.all(promises)
  170. .then(contents => {
  171. writeFile(JISON_FOLDER + parserConfig.target, contents.join('')).then(() => {
  172. resolve(JISON_FOLDER + parserConfig.target);
  173. });
  174. })
  175. .catch(reject);
  176. } else if (parserConfig.sources.length === 1) {
  177. resolve(JISON_FOLDER + parserConfig.sources[0]);
  178. } else {
  179. reject('No jison source specified');
  180. }
  181. });
  182. concatPromise
  183. .then(targetPath => {
  184. const options = {
  185. file: targetPath,
  186. 'module-type': 'js'
  187. };
  188. if (parserConfig.lexer) {
  189. options['lexfile'] = JISON_FOLDER + parserConfig.lexer;
  190. }
  191. console.log('Generating parser...');
  192. try {
  193. cli.main(options);
  194. } catch (err) {
  195. console.error('Failed calling jison cli');
  196. throw err;
  197. }
  198. if (parserConfig.sources.length > 1) {
  199. deleteFile(targetPath); // Remove concatenated file
  200. }
  201. console.log('Adjusting JS...');
  202. const generatedJsFileName = parserConfig.target
  203. .replace('.jison', '.js')
  204. .replace(/^.*\/([^/]+)$/, '$1');
  205. console.log(generatedJsFileName);
  206. readFile(generatedJsFileName)
  207. .then(contents => {
  208. parserConfig
  209. .afterParse(contents)
  210. .then(finalContents => {
  211. writeFile(parserConfig.outputFolder + generatedJsFileName, finalContents)
  212. .then(() => {
  213. deleteFile(generatedJsFileName);
  214. resolve();
  215. })
  216. .catch(reject);
  217. })
  218. .catch(reject);
  219. })
  220. .catch(reject);
  221. })
  222. .catch(reject);
  223. });
  224. let parsersToGenerate = [];
  225. const invalid = [];
  226. let all = false;
  227. const listDir = folder =>
  228. new Promise(resolve => {
  229. fs.readdir(folder, (err, files) => {
  230. resolve(files);
  231. });
  232. });
  233. const addParserDefinition = (sources, dialect, autocomplete, lexer) => {
  234. const parserName = dialect + (autocomplete ? 'AutocompleteParser' : 'SyntaxParser');
  235. const parserDefinition = {
  236. sources: sources,
  237. lexer: 'sql/' + dialect + '/' + lexer,
  238. target: 'sql/' + dialect + '/' + parserName + '.jison',
  239. sqlParser: autocomplete ? 'AUTOCOMPLETE' : 'SYNTAX',
  240. outputFolder: OUTPUT_FOLDER + 'sql/' + dialect + '/',
  241. afterParse: contents =>
  242. new Promise(resolve => {
  243. resolve(
  244. LICENSE +
  245. contents
  246. .replace(
  247. 'var ' + parserName + ' = ',
  248. "import SqlParseSupport from 'parse/sql/" +
  249. dialect +
  250. "/sqlParseSupport';\n\nvar " +
  251. parserName +
  252. ' = '
  253. )
  254. .replace(
  255. 'loc: yyloc,',
  256. "loc: lexer.yylloc, ruleId: stack.slice(stack.length - 2, stack.length).join(''),"
  257. ) +
  258. '\nexport default ' +
  259. parserName +
  260. ';\n'
  261. );
  262. })
  263. };
  264. parserDefinitions[parserName] = parserDefinition;
  265. };
  266. const addParsersFromStructure = (structure, dialect) => {
  267. addParserDefinition(
  268. structure.autocomplete.map(source => 'sql/' + dialect + '/' + source),
  269. dialect,
  270. true,
  271. structure.lexer
  272. );
  273. addParserDefinition(
  274. structure.syntax.map(source => 'sql/' + dialect + '/' + source),
  275. dialect,
  276. false,
  277. structure.lexer
  278. );
  279. };
  280. const identifySqlParsers = () =>
  281. new Promise(resolve => {
  282. listDir(JISON_FOLDER + 'sql').then(files => {
  283. const promises = [];
  284. files.forEach(folder => {
  285. promises.push(
  286. listDir(JISON_FOLDER + 'sql/' + folder).then(async jisonFiles => {
  287. if (jisonFiles.find(fileName => fileName === 'structure.json')) {
  288. const structure = JSON.parse(
  289. await readFile(JISON_FOLDER + 'sql/' + folder + '/structure.json')
  290. );
  291. addParsersFromStructure(structure, folder);
  292. } else {
  293. console.log(
  294. "Warn: Could not find 'structure.jisonlex' in " +
  295. JISON_FOLDER +
  296. 'sql/' +
  297. folder +
  298. '/'
  299. );
  300. }
  301. })
  302. );
  303. });
  304. Promise.all(promises).then(resolve);
  305. });
  306. });
  307. const copyTests = (source, target) =>
  308. new Promise((resolve, reject) => {
  309. const replaceRegexp = new RegExp(source + '(Autocomplete|Syntax)Parser', 'g');
  310. mkdir(PARSER_FOLDER + target)
  311. .then(() => {
  312. mkdir(PARSER_FOLDER + target + '/test')
  313. .then(() => {
  314. listDir(PARSER_FOLDER + source + '/test')
  315. .then(testFiles => {
  316. const copyPromises = [];
  317. testFiles.forEach(testFile => {
  318. copyPromises.push(
  319. copyFile(
  320. PARSER_FOLDER + source + '/test/' + testFile,
  321. PARSER_FOLDER + target + '/test/' + testFile.replace(source, target),
  322. contents => contents.replace(replaceRegexp, target + '$1Parser')
  323. )
  324. );
  325. });
  326. Promise.all(copyPromises).then(resolve).catch(reject);
  327. })
  328. .catch(reject);
  329. })
  330. .catch(reject);
  331. })
  332. .catch(reject);
  333. });
  334. const prepareForNewParser = () =>
  335. new Promise((resolve, reject) => {
  336. if (process.argv.length === 3 && process.argv[0] === '-new') {
  337. process.argv.shift();
  338. const source = process.argv.shift();
  339. const target = process.argv.shift();
  340. console.log("Generating new parser '" + target + "' based on '" + source + "'...");
  341. process.argv.push(target);
  342. if (
  343. !Object.keys(parserDefinitions).some(key => {
  344. if (key.indexOf(source) === 0) {
  345. copyTests(source, target)
  346. .then(() => {
  347. mkdir(JISON_FOLDER + 'sql/' + target)
  348. .then(() => {
  349. listDir(JISON_FOLDER + 'sql/' + source).then(files => {
  350. const copyPromises = [];
  351. files.forEach(file => {
  352. copyPromises.push(
  353. copyFile(
  354. JISON_FOLDER + 'sql/' + source + '/' + file,
  355. JISON_FOLDER + 'sql/' + target + '/' + file
  356. )
  357. );
  358. });
  359. Promise.all(copyPromises).then(() => {
  360. const autocompleteSources = [
  361. 'sql/' + target + '/autocomplete_header.jison'
  362. ];
  363. const syntaxSources = ['sql/' + target + '/syntax_header.jison'];
  364. files.forEach(file => {
  365. if (file.indexOf('sql_') === 0) {
  366. autocompleteSources.push('sql/' + target + '/' + file);
  367. syntaxSources.push('sql/' + target + '/' + file);
  368. }
  369. });
  370. autocompleteSources.push('sql/' + target + '/autocomplete_footer.jison');
  371. syntaxSources.push('sql/' + target + '/syntax_footer.jison');
  372. mkdir(PARSER_FOLDER + target).then(() => {
  373. copyFile(
  374. PARSER_FOLDER + source + '/sqlParseSupport.js',
  375. PARSER_FOLDER + target + '/sqlParseSupport.js',
  376. contents =>
  377. contents.replace(
  378. /parser\.yy\.activeDialect = '[^']+';'/g,
  379. "parser.yy.activeDialect = '" + target + "';"
  380. )
  381. ).then(() => {
  382. identifySqlParsers().then(resolve).catch(reject);
  383. });
  384. });
  385. });
  386. });
  387. })
  388. .catch(err => {
  389. console.log(err);
  390. });
  391. })
  392. .catch(reject);
  393. return true;
  394. }
  395. })
  396. ) {
  397. reject("No existing parser found for '" + source + "'");
  398. }
  399. } else {
  400. resolve();
  401. }
  402. });
  403. identifySqlParsers().then(() => {
  404. process.argv.shift();
  405. process.argv.shift();
  406. prepareForNewParser().then(() => {
  407. process.argv.forEach(arg => {
  408. if (arg === 'all') {
  409. all = true;
  410. } else if (parserDefinitions[arg]) {
  411. parsersToGenerate.push(arg);
  412. } else {
  413. let prefixFound = false;
  414. Object.keys(parserDefinitions).forEach(key => {
  415. if (key.indexOf(arg) === 0) {
  416. prefixFound = true;
  417. parsersToGenerate.push(key);
  418. }
  419. });
  420. if (!prefixFound) {
  421. invalid.push(arg);
  422. }
  423. }
  424. });
  425. if (all) {
  426. parsersToGenerate = Object.keys(parserDefinitions);
  427. }
  428. if (invalid.length) {
  429. console.log("No parser config found for: '" + invalid.join("', '") + "'");
  430. console.log(
  431. '\nPossible options are:\n ' +
  432. ['all'].concat(Object.keys(parserDefinitions)).join('\n ') +
  433. '\n'
  434. );
  435. return;
  436. }
  437. const parserCount = parsersToGenerate.length;
  438. let idx = 0;
  439. const generateRecursive = () => {
  440. idx++;
  441. if (parsersToGenerate.length) {
  442. const parserName = parsersToGenerate.pop();
  443. if (parserCount > 1) {
  444. console.log("Generating '" + parserName + "' (" + idx + '/' + parserCount + ')...');
  445. } else {
  446. console.log("Generating '" + parserName + "'...");
  447. }
  448. generateParser(parserName)
  449. .then(generateRecursive)
  450. .catch(error => {
  451. console.log(error);
  452. console.log('FAIL!');
  453. });
  454. } else {
  455. const autocompParsers = [];
  456. const syntaxParsers = [];
  457. console.log('Updating sqlParserRepository.ts...');
  458. Object.keys(parserDefinitions).forEach(key => {
  459. if (parserDefinitions[key].sqlParser === 'AUTOCOMPLETE') {
  460. autocompParsers.push(
  461. AUTOCOMPLETE_PARSER_IMPORT_TEMPLATE.replace(
  462. /KEY/g,
  463. key.replace('AutocompleteParser', '')
  464. )
  465. );
  466. } else if (parserDefinitions[key].sqlParser === 'SYNTAX') {
  467. syntaxParsers.push(
  468. SYNTAX_PARSER_IMPORT_TEMPLATE.replace(/KEY/g, key.replace('SyntaxParser', ''))
  469. );
  470. }
  471. });
  472. readFile(SQL_PARSER_REPOSITORY_PATH).then(contents => {
  473. contents = contents.replace(
  474. /const SYNTAX_MODULES = [^}]+}/,
  475. 'const SYNTAX_MODULES = {\n' + syntaxParsers.sort().join(',\n') + '\n}'
  476. );
  477. contents = contents.replace(
  478. /const AUTOCOMPLETE_MODULES = [^}]+}/,
  479. 'const AUTOCOMPLETE_MODULES = {\n' + autocompParsers.sort().join(',\n') + '\n}'
  480. );
  481. writeFile(SQL_PARSER_REPOSITORY_PATH, contents).then(() => {
  482. console.log('Done!\n');
  483. });
  484. });
  485. }
  486. };
  487. generateRecursive();
  488. });
  489. });
  490. /* eslint-enable no-restricted-syntax */