Merge pull request #153 from codefori/feature/runner_parameter_ux

Host parameters treated like snippets

Author: worksofliam

src/language/sql/document.ts

@@ -1,9 +1,9 @@
 import Statement from "./statement";
 import SQLTokeniser from "./tokens";
-import { Definition, IRange, StatementGroup, StatementType, StatementTypeWord, Token } from "./types";
+import { Definition, IRange, ParsedEmbeddedStatement, StatementGroup, StatementType, StatementTypeWord, Token } from "./types";
 
 export default class Document {
-  private content: string;
+  content: string;
   statements: Statement[];
 
   constructor(content: string) {
@@ -167,23 +167,27 @@ export default class Document {
     })
   }
 
-  removeEmbeddedAreas(statement: Statement) {
-    const ranges = statement.getEmbeddedStatementAreas();
+  removeEmbeddedAreas(statement: Statement, snippetString?: boolean): ParsedEmbeddedStatement {
+    const areas = statement.getEmbeddedStatementAreas();
 
+    const totalParameters = areas.filter(a => a.type === `marker`).length;
     let newContent = this.content.substring(statement.range.start, statement.range.end);
     let parameterCount = 0;
 
     const startRange = statement.range.start;
 
     // We do it in reverse so the substring ranges doesn't change
-    for (let x = ranges.length-1; x >= 0; x--) {
-      const area = ranges[x];
+    for (let x = areas.length-1; x >= 0; x--) {
+      const area = areas[x];
 
       let start = area.range.start - startRange, end = area.range.end - startRange;
 
       switch (area.type) {
         case `marker`:
-          newContent = newContent.substring(0, start) + `?` + newContent.substring(end);
+          const markerContent = newContent.substring(start, end);
+
+          newContent = newContent.substring(0, start) + (snippetString ? `\${${totalParameters-parameterCount}:${markerContent}}` : `?`) + newContent.substring(end) + (snippetString ? `$0` : ``);
+      
           parameterCount++;
           break;
 
@@ -194,6 +198,7 @@ export default class Document {
     }
 
     return {
+      changed: areas.length > 0,
       content: newContent,
       parameterCount
     };

src/language/sql/statement.ts

@@ -460,19 +460,33 @@ export default class Statement {
 
 	/** 
 	 * Gets areas of statement that are likely from embedded statements
+	 * EXEC SQL
 	 * INTO area
 	 * Host variables
-	 * EXEC SQL
+	 * DECLARE .. CURSOR FOR
 	 */
 	getEmbeddedStatementAreas() {
 		let ranges: {type: "remove"|"marker", range: IRange}[] = [];
 		let intoClause: Token|undefined;
+		let declareStmt: Token|undefined;
 
 		for (let i = 0; i < this.tokens.length; i++) {
 			const currentToken = this.tokens[i];
 
 			switch (currentToken.type) {
+				case `statementType`:
+					if (declareStmt) continue;
+
+					// If we're in a DECLARE, it's likely a cursor definition
+					if (currentToken.value.toLowerCase() === `declare`) {
+						declareStmt = currentToken;
+					}
+					break;
+
 				case `clause`:
+					if (declareStmt) continue;
+
+					// We need to remove the INTO clause completely.
 					if (currentToken.value.toLowerCase() === `into`) {
 						intoClause = currentToken;
 					} else if (intoClause) {
@@ -492,6 +506,7 @@ export default class Statement {
 
 				case `questionmark`:
 					if (intoClause) continue;
+					if (declareStmt) continue;
 
 					ranges.push({
 						type: `marker`,
@@ -501,11 +516,16 @@ export default class Statement {
 
 				case `colon`:
 					if (intoClause) continue;
+					if (declareStmt) continue;
 
 					let nextMustBe: "word"|"dot" = `word`;
 					let followingTokenI = i+1;
 					let endToken: Token;
 
+					// Handles when we have a host variable
+					// This logic supports qualified host variables
+					// i.e. :myvar or :mystruct.subf
+
 					let followingToken = this.tokens[followingTokenI];
 					while (followingToken && followingToken.type === nextMustBe) {
 						switch (followingToken.type) {
@@ -535,6 +555,7 @@ export default class Statement {
 
 				default:
 					if (i === 0 && tokenIs(currentToken, `word`, `EXEC`)) {
+						// We check and remove the starting `EXEC SQL`
 						if (tokenIs(this.tokens[i+1], `word`, `SQL`)) {
 							ranges.push({
 								type: `remove`,
@@ -544,6 +565,19 @@ export default class Statement {
 								}
 							});
 						}
+					} else 
+					if (declareStmt && tokenIs(currentToken, `keyword`, `FOR`)) {
+						// If we're a DECLARE, and we found the FOR keyword, the next
+						// set of tokens should be the select.
+						ranges.push({
+							type: `remove`,
+							range: {
+								start: declareStmt.range.start,
+								end: currentToken.range.end
+							}
+						});
+
+						declareStmt = undefined;
 					}
 					break;
 			}

src/language/sql/tests/statements.test.ts

@@ -1267,4 +1267,51 @@ describe(`Parameter statement tests`, () => {
     const result = document.removeEmbeddedAreas(statement);
     expect(result.content).toBe(`select x,y from sample where x = ?`);
   });
+
+  test(`Exec with basic DECLARE`, () => {
+    const lines = [
+      `EXEC SQL DECLARE empCur CURSOR FOR`,
+      `  SELECT EMPNO, FIRSTNME, LASTNAME, JOB`,
+      `  FROM EMPLOYEE`,
+      `  WHERE WORKDEPT = :DEPTNO`,
+    ].join(`\n`);
+
+    const document = new Document(lines);
+    const statements = document.statements;
+    expect(statements.length).toBe(1);
+
+    const statement = statements[0];
+
+    const result = document.removeEmbeddedAreas(statement);
+    expect(result.parameterCount).toBe(1);
+    expect(result.content).toBe([
+      `  SELECT EMPNO, FIRSTNME, LASTNAME, JOB`,
+      `  FROM EMPLOYEE`,
+      `  WHERE WORKDEPT = ?`
+    ].join(`\n`));
+  });
+
+  test(`Exec with basic DECLARE`, () => {
+    const lines = [
+      `EXEC SQL`,
+      `DECLARE cursor-name SCROLL CURSOR FOR`,
+      `SELECT column-1, column-2`,
+      `  FROM table-name`,
+      `  WHERE column-1 = expression`,
+    ].join(`\n`);
+
+    const document = new Document(lines);
+    const statements = document.statements;
+    expect(statements.length).toBe(1);
+
+    const statement = statements[0];
+
+    const result = document.removeEmbeddedAreas(statement);
+    expect(result.parameterCount).toBe(0);
+    expect(result.content).toBe([
+      `SELECT column-1, column-2`,
+      `  FROM table-name`,
+      `  WHERE column-1 = expression`,
+    ].join(`\n`));
+  });
 });

src/language/sql/types.ts

@@ -97,4 +97,10 @@ export interface StatementGroup {
 export interface Definition extends ObjectRef {
 	range: IRange;
 	children: Definition[];
+}
+
+export interface ParsedEmbeddedStatement {
+	changed: boolean;
+	content: string;
+	parameterCount: number;
 }