Merge pull request #247 from Trivadis/feature/issue-244-timeout

Add timeout parameter in standalone formatter

Author: PhilippSalvisberg

README.md

@@ -6,8 +6,8 @@ This repository provides formatter settings for the [coding style rules](https:/
 
 Settings are primarily provided for
 
-- [Oracle SQLcl, Version 22.3.0](https://www.oracle.com/tools/downloads/sqlcl-downloads.html)
-- [Oracle SQL Developer, Version 22.2.1](https://www.oracle.com/tools/downloads/sqldev-downloads.html) (requires `dbtools-common.jar` from SQLcl 22.3.0)
+- [Oracle SQLcl, Version 22.4.0](https://www.oracle.com/tools/downloads/sqlcl-downloads.html)
+- [Oracle SQL Developer, Version 22.2.1](https://www.oracle.com/tools/downloads/sqldev-downloads.html) (requires `dbtools-common.jar` from SQLcl 22.4.0, however, this breaks the code completion feature)
 
 These settings have been defined and tested with the product versions mentioned above. They might not work in other versions.
 

settings/sql_developer/trivadis_custom_format.arbori

@@ -17,7 +17,7 @@
 include "std.arbori"
 
 /**
- * Lightweight Formatter for SQL Developer and SQLcl, version 22.3.1-SNAPSHOT
+ * Lightweight Formatter for SQL Developer and SQLcl, version 22.4.0-SNAPSHOT
  * The idea is to keep the code formatted "as is" and apply chosen formatting rules only.
  *
  * The Arbori program is processed from top to bottom.

sqlcl/README.md

@@ -6,7 +6,7 @@ You can apply the formatter settings in SQL Developer. Another option is to appl
 
 ## Why not Use `FORMAT FILE`?
 
-Yes, you can use the built-in `FORMAT FILE` command. Here's the help output from SQLcl 22.3.0:
+Yes, you can use the built-in `FORMAT FILE` command. Here's the help output from SQLcl 22.4.0:
 
 ```
 FORMAT
@@ -28,7 +28,7 @@ We recommend you download, clone, or fork this repository when you plan to use [
 However, [`format.js`](format.js) also works as a standalone script. Here's the usage:
 
 ```
-Trivadis PL/SQL & SQL Formatter (format.js), version 22.3.0
+Trivadis PL/SQL & SQL Formatter (format.js), version 22.4.0
 
 usage: script format.js <rootPath> [options]
 
@@ -69,7 +69,7 @@ script (...)/plsql-formatter-settings/sqlcl/format.js --register
 Afterwards you can type `tvdformat` to get this usage help:
 
 ```
-Trivadis PL/SQL & SQL Formatter (tvdformat), version 22.2.1
+Trivadis PL/SQL & SQL Formatter (tvdformat), version 22.4.0
 
 usage: tvdformat <rootPath> [options]
 

sqlcl/format.js

@@ -51,7 +51,7 @@ var javaSqlEarley = Java.type("oracle.dbtools.parser.plsql.SqlEarley");
 var javaProgram = Java.type("oracle.dbtools.arbori.Program");
 
 var getVersion = function() {
-    return "22.3.1-SNAPSHOT";
+    return "22.4.0-SNAPSHOT";
 }
 
 var getFiles = function (rootPath, extensions, ignoreMatcher) {
@@ -162,19 +162,39 @@ var getConfiguredFormatter = function (xmlPath, arboriPath) {
     return formatter;
 }
 
+var formatInSandbox = function(formatter, original, timeout) {
+    if (timeout === 0) {
+        // run formatter without timeout
+        return formatter.format(original);
+    } else {
+        // run formatter in a thread with a given timeout in seconds
+        // requires SandboxedFormatter which is not available when running within SQLcl
+        var javaSandboxedFormatter = Java.type("com.trivadis.plsql.formatter.sandbox.SandboxedFormatter");
+        return javaSandboxedFormatter.format(formatter, original, timeout);
+    }
+}
+
 var hasParseErrors = function (content, consoleOutput) {
     var newContent = "\n" + content; // ensure correct line number in case of an error
     var tokens = javaLexer.parse(newContent);
-    var parsed = new javaParsed(newContent, tokens, javaSqlEarley.getInstance(), Java.to(["sql_statements"], "java.lang.String[]"));
-    var syntaxError = parsed.getSyntaxError();
-    if (syntaxError != null && syntaxError.getMessage() != null) {
+    try {
+        var parsed = new javaParsed(newContent, tokens, javaSqlEarley.getInstance(), Java.to(["sql_statements"], "java.lang.String[]"));
+        var syntaxError = parsed.getSyntaxError();
+        if (syntaxError != null && syntaxError.getMessage() != null) {
+            if (consoleOutput) {
+                ctx.write(syntaxError.getDetailedMessage());
+                ctx.write("... ");
+            }
+            return true;
+        }
+        return false;
+    } catch (e) {
         if (consoleOutput) {
-            ctx.write(syntaxError.getDetailedMessage());
+            ctx.write("Internal during parse: " + e.getMessage());
             ctx.write("... ");
         }
         return true;
     }
-    return false;
 }
 
 var readFile = function (file) {
@@ -236,6 +256,10 @@ var printUsage = function (asCommand, standalone) {
     ctx.write("                  serr=all reports all syntax errors\n");
     ctx.write("                  serr=ext reports syntax errors for files defined with ext option\n");
     ctx.write("                  serr=mext reports syntax errors for files defined with mext option\n");
+    if (standalone) {
+        ctx.write("  timeout=<sec>   time in seconds to wait for the completion of the formatting for a file.\n");
+        ctx.write("                  the default value is 0 seconds, which means no timeout.\n");
+    }
     ctx.write("  --help, -h,     print this help screen and exit\n")
     ctx.write("  --version, -v   print version and exit\n")
     if (!asCommand && !standalone) {
@@ -310,6 +334,7 @@ var processAndValidateArgs = function (args) {
     var ignorePath = null;
     var ignoreMatcher = null;
     var serr = null;
+    var timeout = null;
     var files = [];
     var result = function (valid) {
         return {
@@ -321,6 +346,7 @@ var processAndValidateArgs = function (args) {
             arboriPath: arboriPath,
             ignoreMatcher: ignoreMatcher,
             serr: serr,
+            timeout: timeout,
             valid: valid
         };
     }
@@ -383,6 +409,9 @@ var processAndValidateArgs = function (args) {
             if (typeof configJson.serr !== 'undefined') {
                 serr = configJson.serr.toLowerCase();
             }
+            if (typeof configJson.timeout !== 'undefined') {
+                timeout = configJson.timeout;
+            }
             if (typeof configJson.files !== 'undefined') {
                 if (!Array.isArray(configJson.files)) {
                     ctx.write("files in " + rootPath + " is not an array.\n\n");
@@ -447,6 +476,10 @@ var processAndValidateArgs = function (args) {
             serr = args[i].substring(5).toLowerCase();
             continue;
         }
+        if (args[i].toLowerCase().indexOf("timeout=") === 0) {
+            timeout = args[i].substring(8);
+            continue;
+        }
         ctx.write("invalid argument " + args[i] + ".\n\n");
         return result(false);
     }
@@ -506,17 +539,35 @@ var processAndValidateArgs = function (args) {
             return result(false);
         }
     }
+    if (timeout == null) {
+        timeout = 0;
+    } else {
+        if (isNaN(timeout)) {
+            ctx.write("timeout must be a number.\n\n");
+            return result(false);
+        }
+        timeout = Number(timeout);
+        if (timeout < 0) {
+            ctx.write("timeout cannot be less than zero.\n\n");
+            return result(false);
+        }
+        var standalone = javaSystem.getProperty('tvdformat.standalone') != null;
+        if (!standalone) {
+            ctx.write("timeout is not supported in SQLcl, use the standalone formatter tvdformat.\n\n")
+            return result(false);
+        }
+    }
     return result(true);
 }
 
-var formatBuffer = function (formatter) {
+var formatBuffer = function (formatter, timeout) {
     ctx.write("Formatting SQLcl buffer... ");
     ctx.getOutputStream().flush();
     var original = ctx.getSQLPlusBuffer().getBufferSafe().getBuffer();
     if (hasParseErrors(original, true)) {
         ctx.write("skipped.\n");
     } else {
-        var formatted = javaArrays.asList(formatter.format(original).split("\n"));
+        var formatted = javaArrays.asList(formatInSandbox(formatter, original, timeout).split("\n"));
         ctx.getSQLPlusBuffer().getBufferSafe().resetBuffer(formatted);
         ctx.write("done.\n");
         ctx.write(ctx.getSQLPlusBuffer().getBufferSafe().list(false));
@@ -552,7 +603,7 @@ var detectCharset = function(content) {
     return null;
 }
 
-var formatMarkdownFile = function (file, formatter, serr) {
+var formatMarkdownFile = function (file, formatter, serr, timeout) {
     var bytes = javaFiles.readAllBytes(file);
     var charset = detectCharset(bytes);
     if (charset == null) {
@@ -577,7 +628,7 @@ var formatMarkdownFile = function (file, formatter, serr) {
                 result += original.substring(m.start(2), m.end(3));
             } else {
                 ctx.write("done... ")
-                result += formatter.format(m.group(2));
+                result += formatInSandbox(formatter, m.group(2), timeout);
                 result += original.substring(m.end(2), m.end(3));
             }
             pos = m.end(3);
@@ -602,7 +653,7 @@ var getLineSeparator = function (input) {
     return lineSep;
 }
 
-var formatFile = function (file, formatter, serr) {
+var formatFile = function (file, formatter, serr, timeout) {
     var bytes = javaFiles.readAllBytes(file);
     var charset = detectCharset(bytes);
     if (charset == null) {
@@ -616,20 +667,20 @@ var formatFile = function (file, formatter, serr) {
         if (hasParseErrors(original, consoleOutput)) {
             ctx.write("skipped.\n");
         } else {
-            writeFile(file, formatter.format(original) + getLineSeparator(original), charset);
+            writeFile(file, formatInSandbox(formatter, original, timeout) + getLineSeparator(original), charset);
             ctx.write("done.\n");
         }
     }
 }
 
-var formatFiles = function (files, formatter, markdownExtensions, serr) {
+var formatFiles = function (files, formatter, markdownExtensions, serr, timeout) {
     for (var i = 0; i < files.length; i++) {
         ctx.write("Formatting file " + (i + 1) + " of " + files.length + ": " + files[i].toString() + "... ");
         ctx.getOutputStream().flush();
         if (isMarkdownFile(files[i], markdownExtensions)) {
-            formatMarkdownFile(files[i], formatter, serr);
+            formatMarkdownFile(files[i], formatter, serr, timeout);
         } else {
-            formatFile(files[i], formatter, serr);
+            formatFile(files[i], formatter, serr, timeout);
         }
         ctx.getOutputStream().flush();
     }
@@ -675,15 +726,15 @@ var run = function (args) {
         } else {
             var formatter = getConfiguredFormatter(options.xmlPath, options.arboriPath);
             if (options.rootPath === "*") {
-                formatBuffer(formatter);
+                formatBuffer(formatter, options.timeout);
             } else {
                 var files;
                 if (options.files.length > 0) {
                     files = getRelevantFiles(options.files, options.extensions, options.ignoreMatcher);
                 } else {
                     files = getFiles(options.rootPath, options.extensions, options.ignoreMatcher);
                 }
-                formatFiles(files, formatter, options.markdownExtensions, options.serr);
+                formatFiles(files, formatter, options.markdownExtensions, options.serr, options.timeout);
             }
         }
     }

standalone/README.md

@@ -51,10 +51,10 @@ The parameters are the same as for the [executable JAR](#executable-jar).
 
 ## How to Build
 
-1. [Download](https://www.oracle.com/tools/downloads/sqlcl-downloads.html) and install SQLcl 22.3.0
-2. [Download](https://github.com/graalvm/graalvm-ce-builds/releases) and install the GraalVM JDK 17 22.2.0
-3. Go to the `bin` directory of the GraalVM JDK and run `./gu install js native-image`, if you want to produce a native image. For native image on Windows you need to [download](https://visualstudio.microsoft.com/downloads/) Visual Studio Community 2022 and install the C++ compiler. Use `x64 Native Tools Command Prompt for VS 2022` to get a terminal window with the correct environment.
-4. [Download](https://maven.apache.org/download.cgi) and install Apache Maven 3.8.6
+1. [Download](https://www.oracle.com/tools/downloads/sqlcl-downloads.html) and install SQLcl 22.4.0
+2. [Download](https://github.com/graalvm/graalvm-ce-builds/releases) and install the GraalVM JDK 17 22.3.1
+3. Go to the `bin` directory of the GraalVM JDK and run `./gu install js native-image visualvm`. For native image on Windows you need to [download](https://visualstudio.microsoft.com/downloads/) Visual Studio Community 2022 and install the C++ compiler. Use `x64 Native Tools Command Prompt for VS 2022` to get a terminal window with the correct environment.
+4. [Download](https://maven.apache.org/download.cgi) and install Apache Maven 3.9.1
 5. [Download](https://git-scm.com/downloads) and install a git command line client
 6. Clone the plsql-formatter-settings repository. The repository uses symbolic links. On Windows you have to use `git clone -c core.symlinks=true https://github.com/Trivadis/plsql-formatter-settings.git` as Administrator to make it work. See also [Symbolic Links in Windows](https://github.com/git-for-windows/git/wiki/Symbolic-Links) for more information.
 7. Open a terminal window in the plsql-formatter-settings root folder and type

standalone/install_sqlcl_libs.sh

@@ -15,7 +15,7 @@ if ! test -f "${SQLCL_LIBDIR}/dbtools-common.jar"; then
 fi
 
 # define common Maven properties
-SQLCL_VERSION="22.3.0"
+SQLCL_VERSION="22.4.0"
 
 # install JAR files in local Maven repository, these libs are not available in public Maven repositories
 mvn install:install-file -Dfile=$SQLCL_LIBDIR/dbtools-common.jar \

standalone/pom.xml

@@ -6,17 +6,17 @@
     <!-- The Basics -->
     <groupId>com.trivadis.plsql.formatter</groupId>
     <artifactId>tvdformat</artifactId>
-    <version>22.3.1-SNAPSHOT</version>
+    <version>22.4.1-SNAPSHOT</version>
     <packaging>jar</packaging>
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <jdk.version>11</jdk.version>
         <jdk.test.version>17</jdk.test.version>
-        <sqlcl.version>22.3.0</sqlcl.version>
-        <graalvm.version>22.2.0</graalvm.version>
-        <native.maven.plugin.version>0.9.13</native.maven.plugin.version>
+        <sqlcl.version>22.4.0</sqlcl.version>
+        <graalvm.version>22.3.1</graalvm.version>
+        <native.maven.plugin.version>0.9.20</native.maven.plugin.version>
         <reflections.version>0.10.2</reflections.version>
-        <slf4j.version>1.7.36</slf4j.version>
+        <slf4j.version>2.0.7</slf4j.version>
         <javassist.version>3.29.2-GA</javassist.version>
         <skip.native>true</skip.native>
         <disable.logging>true</disable.logging>
@@ -82,7 +82,7 @@
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter</artifactId>
-            <version>5.9.0</version>
+            <version>5.9.2</version>
             <scope>test</scope>
         </dependency>
         <dependency>

standalone/src/main/java/com/trivadis/plsql/formatter/sandbox/SandboxedFormatter.java

@@ -0,0 +1,40 @@
+package com.trivadis.plsql.formatter.sandbox;
+
+import oracle.dbtools.app.Format;
+
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.Future;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+
+public class SandboxedFormatter {
+    public static Format copy(Format original) {
+        Format formatter = new Format();
+        formatter.options.putAll(original.options);
+        return formatter;
+    }
+
+    public static String format(Format formatter, String original, Integer timeout) {
+        ExecutorService executor = Executors.newSingleThreadExecutor();
+        Format newFormatter = formatter;
+        if (formatter.options.containsKey("timeout")) {
+            // it is costly to create a new formatter, so we do that only when needed.
+            formatter.options.remove("timeout");
+            newFormatter = copy(formatter);
+        }
+        Future<String> future = executor.submit(new SandboxedFormatterTask(newFormatter, original));
+        String result;
+        try {
+            result = future.get(timeout, TimeUnit.SECONDS);
+        } catch (TimeoutException | InterruptedException | ExecutionException e) {
+            future.cancel(true);
+            System.out.print("timeout... ");
+            formatter.options.put("timeout", true);
+            result = original;
+        }
+        executor.shutdown();
+        return result;
+    }
+}

standalone/src/main/java/com/trivadis/plsql/formatter/sandbox/SandboxedFormatterTask.java

@@ -0,0 +1,20 @@
+package com.trivadis.plsql.formatter.sandbox;
+
+import oracle.dbtools.app.Format;
+
+import java.util.concurrent.Callable;
+
+public class SandboxedFormatterTask implements Callable<String> {
+    final Format formatter;
+    final String original;
+
+    public SandboxedFormatterTask(Format formatter, String original) {
+        this.formatter = formatter;
+        this.original = original;
+    }
+
+    @Override
+    public String call() throws Exception {
+        return formatter.format(original);
+    }
+}