Merge pull request #10 from oracle/Offset-mismatches,-reference-errors

mig8447 · web-flow · commit 94829edfe201 · 2023-10-30T18:27:44.000-06:00
Offset mismatches, reference errors
diff --git a/README.md b/README.md
@@ -82,7 +82,7 @@ npm run example-cli -- ./test/department_employees.quicksql
 The QSQL to DDL translator is the product's core component, It allows users
 to transform a QSQL string into an Oracle SQL string.
 
-The Quick SQL Syntax is documented [here](./quicksql.md)
+The Quick SQL Syntax is documented [here](./doc/quicksql.md)
 
 See below for examples of how to use this library.
 
diff --git a/doc/error_diagnostics.md b/doc/error_diagnostics.md
@@ -0,0 +1,89 @@
+# Error Diagnostics
+
+# API
+
+Error diagnostics procedure is called like this
+
+
+    let output = ddl.errorMsgs(`dept
+       col1
+     "is this table or misaligned column?"`);
+
+
+It returns an array of the Error objects
+
+
+    function SyntaxError( message, from, to, severity ) {
+        this.from = from;
+        this.to = to;
+        if( to == null )
+            this.to = new Offset(from.line, from.depth+1);
+        this.message = message;
+        this.severity = severity;   // warning or error
+        if( severity == null )
+            this.severity = 'error';
+    }
+
+
+where error message offsets are stuctured as follows
+
+
+    function Offset( line, depth ) {
+        this.line = line;     // 0-based
+        this.depth = depth;   // 0-based
+    }
+
+
+# Error Types
+
+## Misaligned Attributes
+
+Indentation refers to the spaces at the beginning of a code line. Where in most of the other other programming languages the indentation in code is for readability only, QSQL uses indentation to define QSQL tree/forest structure. Parent-child relationship in this tree is interpreted as ether table containing list of columns, or as 2 tables related with referential integrity key constraint. 
+
+Inconsistent indentation is detected, with the error message designed to resolve any confusion.
+
+## Invalid Object references
+
+### Invalid Table reference in a View
+
+Exanple:
+
+    dept
+        name
+
+    view customer_view customer   
+
+
+Here the `customer` table (or view) is missing.
+
+### Invalid foreign key
+
+Exanple:
+
+    department
+        name
+    empployee
+        dept /fk dept   
+
+Here the `dept` table (or view) is missing.
+
+### Duplicate ID
+
+Since identity columns are generated by default, specifying them explictly like this
+
+    dept
+        id
+
+would be diagnosed an error.
+
+### Misconstructed column type
+
+QSQL also recognizes syntactically invalid column types like this
+
+    dept
+        name vc-200
+        name vc0
+
+
+
+
diff --git a/doc/quicksql.md b/doc/quicksql.md
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@oracle/quicksql",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Quick SQL to DDL translator and GUI",
   "main": "src/index.js",
   "type": "module",
diff --git a/src/ddl.js b/src/ddl.js
@@ -444,7 +444,7 @@ const ddl = (function () {
             this.toDDL(input, options);
             this.options = JSON.parse(JSON.stringify(this.appliedOptions));
 
-            const ret = errorMsgs.findErrors(this);
+            const ret = errorMsgs.findErrors(this, input);
  
             this.appliedOptions = JSON.parse(JSON.stringify(this.options));
             this.resetOptions();
diff --git a/src/errorMsgs.js b/src/errorMsgs.js
@@ -1,49 +1,206 @@
+import split_str from './split_str.js';
 
 const findErrors = (function () {
 
-    function ErrorMsg( line, offset, message ) {
-        this.line = line;
-        this.offset = offset;
+    function SyntaxError( message, from, to, severity ) {
+        this.from = from;
+        this.to = to;
+        if( to == null )
+            this.to = new Offset(from.line, from.depth+1);
         this.message = message;
+        this.severity = severity;   // warning or error
+        if( severity == null )
+            this.severity = 'error';
+    }
+
+    function Offset( line, depth ) {
+        this.line = line;     // 0-based
+        this.depth = depth;   // 0-based
     }
     
-    function checkSyntax( ddlInstance ) {
+    function checkSyntax( ddlInstance, input ) {
         const ddl = ddlInstance;
 
         let ret = [];
 
+        const lines = input.split("\n");
+    
+        ret = ret.concat(line_mismatch(lines));
         const descendants = ddl.descendants();
  
         for( let i = 0; i < descendants.length; i++ ) {
             const node = descendants[i];
             if( ddl.optionEQvalue('genpk', true) && descendants[i].parseName() == 'id' ) {
                 const depth = node.content.toLowerCase().indexOf('id');
-                ret.push(new ErrorMsg( node.line, depth, messages.duplicateId));
+                ret.push(new SyntaxError( messages.duplicateId, new Offset(node.line, depth) ));
                 continue;
             }
             const src2 = node.src[2];
             if( 2 < node.src.length && src2.value == '-' ) {
                 const depth = src2.begin;
-                ret.push(new ErrorMsg( node.line,depth, messages.invalidDatatype));
+                ret.push(new SyntaxError(  messages.invalidDatatype, new Offset(node.line,depth) ));
                 continue;
             }
             const src1 = node.src[1];
             if( 1 < node.src.length && 0 < src1.value.indexOf('0') ) {
                 const depth = src1.begin;
-                ret.push(new ErrorMsg( node.line,depth, messages.invalidDatatype));
+                ret.push(new SyntaxError( messages.invalidDatatype, new Offset(node.line,depth) ));
                 continue;
             }
+
+            ret = ret.concat(ref_error_in_view(ddl,node));
+            ret = ret.concat(fk_ref_error(ddl,node));
         }
 
         return ret;
     }
 
+    function ref_error_in_view( ddl, node ) {
+        var ret  = [];
+        
+        var line = node.content.toLowerCase();
+        if( node.parseType() == 'view' ) {
+            var chunks = split_str(line,' '); //line.split(' ');
+            let pos = 0;
+            for( var j = 0; j < chunks.length; j++ ) { 
+                pos += chunks[j].length;
+                if( chunks[j] == ' ' ) 
+                    continue;
+                if( chunks[j] == 'view' ) 
+                    continue;
+                if( j == 1 ) 
+                    continue;
+               var tbl = ddl.find(chunks[j]);
+                if( tbl == null ) {
+                    ret.push( new SyntaxError(
+                        messages.undefinedObject+chunks[j],
+                        new Offset(node.line, pos-chunks[j].length)
+                    ));
+                }
+            }
+        }
+        return ret;
+    }
+    
+    function fk_ref_error( ddl, node ) {
+        var ret  = [];
+        var line = node.content.toLowerCase();
+        if( 0 < line.indexOf("/fk") || 0 < line.indexOf("/reference") ) {
+            let chunks = split_str(line,' '); //line.split(' ');
+            let pos = 0;
+            let refIsNext = false;
+            for( var j = 0; j < chunks.length; j++ ) { 
+                pos += chunks[j].length;
+                if( chunks[j] == ' ' )
+                    continue;
+                if( chunks[j] == "/fk" || 0 == chunks[j].indexOf("/reference") ) {
+                    refIsNext = true;
+                    continue;
+                }
+                if( !refIsNext )
+                    continue;
+                var tbl = ddl.find(chunks[j]);
+                if(  tbl == null ) {
+                    ret.push( new SyntaxError(
+                        messages.undefinedObject+chunks[j],
+                        new Offset(node.line, pos-chunks[j].length)
+                    ));                   
+                    break;
+                }
+            }
+        }
+    return ret;
+    }
+    
+    function line_mismatch( lines ) {
+        var ret  = [];
+        
+        var indent = guessIndent( lines )
+        
+        for( var i = 1; i < lines.length; i++ ) {
+            var priorline = lines[i-1];
+            var line = lines[i];
+            
+            var priorIndent = depth(priorline);
+            var lineIndent = depth(line);
+            
+            if( lineIndent == 0 )
+                continue;
+           
+            if( priorIndent < lineIndent && lineIndent < priorIndent+indent )
+                ret.push(new SyntaxError(
+                    messages.misalignedAttribute+indent,
+                    new Offset(i, lineIndent)
+                )
+            );
+        }
+    
+        return ret;
+    }
     return checkSyntax;
 }());
 
+
+
+function guessIndent( lines ) {    	
+    let depths = [];
+
+    for( var i = 0; i < lines.length; i++ ) {
+        var line = lines[i];
+        depths[i] = depth(line);
+    }
+
+    let frequencies = [];
+    for( let i = 0; i < depths.length; i++ ) {
+        let j = parentIndex(depths, i);
+        if( j != null ) {
+            let f = frequencies[depths[i]-depths[j]];
+            if( f == null )
+                f = 0;
+            frequencies[depths[i]-depths[j]] = f+1;
+        }
+    }
+
+    let indent = null;
+    for( let i in frequencies ) {
+        if( indent == null || frequencies[indent] <= frequencies[i] )
+            indent = i; 
+    }
+    return indent;
+
+}
+
+function depth( line ) {
+    var chunks = line.split(/ |\t/);
+    var offset = 0;
+    for( var j = 0; j < chunks.length; j++ ) {
+        var chunk = chunks[j];
+        if( "\t" == chunk ) {
+            offset += 4; //TODO;
+        }
+        if( "" == chunk  ) {
+            offset++;
+            continue;
+        }
+        if( !/[^.a-zA-Z0-9_"]/.test(chunk) ) 
+            return offset;
+    }
+    return 0;
+}
+
+function parentIndex( depths, lineNo ) {
+    for( let i = lineNo; 0 <= i; i-- ) 
+        if( depths[i] < depths[lineNo] )
+            return i;
+    return null;
+}
+
+
 const messages = {
     duplicateId: 'Explicit ID column conflicts with genpk',
     invalidDatatype: 'Invalid Datatype',
+    undefinedObject: 'Undefined Object: ',
+    misalignedAttribute: 'Misaligned Table or Column; apparent indent = ',
 }
 
 export default {findErrors, messages};
diff --git a/test/error_msg_tests.js b/test/error_msg_tests.js
@@ -4,18 +4,25 @@ import errorMsgs from '../src/errorMsgs.js'
 
 function checkError(msgList, line, offset, msg) {
     for( const i in msgList ) {
-        if( msgList[i].line == line && msgList[i].offset == offset && msgList[i].message == msg )
+        if( msgList[i].from.line == line && msgList[i].from.depth == offset && msgList[i].message == msg ) {
             return;
+        }
     }
     throw new Error('Test failed for "'+msg+'" @line= '+line);
 }    
 
-var output;
-var input;
+export function checkNoError(msgList, msgPrefix) {
+    for( const i in msgList ) {
+        if( msgList[i].message.indexOf(msgPrefix) == 0 ) {
+            throw new Error('Test failed for "'+msg);
+        }
+    }   
+}    
+
 
 export default function error_msg_tests() {
 
-    output = ddl.errorMsgs(`dept
+    let output = ddl.errorMsgs(`dept
     id
     `);
     checkError(output, 1, 4, errorMsgs.messages.duplicateId);
@@ -26,6 +33,35 @@ export default function error_msg_tests() {
     `);
     checkError(output, 1, 4+4+2+1, errorMsgs.messages.invalidDatatype);
     checkError(output, 2, 4+4+1, errorMsgs.messages.invalidDatatype);
+    checkNoError(output, errorMsgs.messages.misalignedAttribute);
+
+    output = ddl.errorMsgs(`dept
+    name
+customer
+    dept /fk department    
+    `);
+    checkError(output, 3, 4+4+1+3+1, errorMsgs.messages.undefinedObject+'department');
+    checkNoError(output, errorMsgs.messages.misalignedAttribute);
+
+    output = ddl.errorMsgs(`dept
+    name
+view customer_view customer
+    `);
+    checkError(output, 2, 4+1+13+1, errorMsgs.messages.undefinedObject+'customer');
+    checkNoError(output, errorMsgs.messages.misalignedAttribute);
+
+    output = ddl.errorMsgs(`dept
+   col1
+    "is this table or misaligned column?"
+    `);
+    checkError(output, 2, 4, errorMsgs.messages.misalignedAttribute+"3");
+
+    output = ddl.errorMsgs(`dept
+   col1
+   col2
+    "is this table or misaligned column?"
+    `);
+    checkError(output, 3, 4, errorMsgs.messages.misalignedAttribute+"3");
 
 }
 
diff --git a/test/regression_test.js b/test/regression_test.js

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@oracle/quicksql",`
`3`		`- "version": "1.1.1",`
	`3`	`+ "version": "1.1.2",`
`4`	`4`	`"description": "Quick SQL to DDL translator and GUI",`
`5`	`5`	`"main": "src/index.js",`
`6`	`6`	`"type": "module",`