VS Code: Validate generated code

.github/workflows/ts-tests.yml

@@ -23,11 +23,6 @@ jobs:
           java-version: 11
       - name: Setup Node.js environment
         uses: actions/setup-node@v2.1.2
-      - name: Cache .pnpm-store
-        uses: actions/cache@v1
-        with:
-          path: ~/.pnpm-store
-          key: ${{ runner.os }}-node${{ matrix.node-version }}-${{ hashFiles('**/pnpm-lock.yaml') }}
       - name: Install pnpm
         run: sudo npm i -g pnpm
       - name: Install Dependencies Ubuntu

org.lflang.diagram/src/org/lflang/diagram/lsp/LFLanguageServerExtension.java

@@ -45,10 +45,14 @@ private GeneratorResult buildWithProgress(LanguageClient client, String uri, boo
         }
         Progress progress = new Progress(client, "Build \"" + parsedUri.lastSegment() + "\"", mustComplete);
         progress.begin();
-        GeneratorResult result = builder.run(
-            parsedUri, mustComplete, progress::report, progress.getCancelIndicator()
-        );
-        progress.end(result.getUserMessage());
+        GeneratorResult result = null;
+        try {
+            result = builder.run(
+                parsedUri, mustComplete, progress::report, progress.getCancelIndicator()
+            );
+        } finally {
+            progress.end(result == null ? "An internal error occurred." : result.getUserMessage());
+        }
         return result;
     }
 
@@ -81,7 +85,13 @@ public CompletableFuture<String> build(String uri) {
             "Please wait for the Lingua Franca language server to be fully initialized."
         );
         return CompletableFuture.supplyAsync(
-            () -> buildWithProgress(client, uri, true).getUserMessage()
+            () -> {
+                try {
+                    return buildWithProgress(client, uri, true).getUserMessage();
+                } catch (Exception e) {
+                    return "An internal error occurred:\n" + e;
+                }
+            }
         );
     }
 

org.lflang.targetplatform/org.lflang.targetplatform.target

@@ -30,6 +30,9 @@
       <unit id="org.aopalliance" version="0.0.0"/>
       <unit id="org.eclipse.xtext.sdk.feature.group" version="0.0.0"/>
       <unit id="org.eclipse.tm.terminal.feature.feature.group" version="0.0.0"/>
+      <unit id="com.fasterxml.jackson.core.jackson-core" version="0.0.0"/>
+      <unit id="com.fasterxml.jackson.core.jackson-annotations" version="0.0.0"/>
+      <unit id="com.fasterxml.jackson.core.jackson-databind" version="0.0.0"/>
       <repository location="http://download.eclipse.org/releases/2021-06"/>
     </location>
     <location includeAllPlatforms="false" includeConfigurePhase="true" includeMode="planner" includeSource="false" type="InstallableUnit">

org.lflang/META-INF/MANIFEST.MF

@@ -19,7 +19,10 @@ Require-Bundle: org.eclipse.xtext,
  org.eclipse.xtend.lib.macro,
  org.apache.commons.cli;bundle-version="1.4",
  org.jetbrains.kotlin.bundled-compiler;resolution:=optional,
- org.eclipse.lsp4j;bundle-version="0.10.0"
+ org.eclipse.lsp4j;bundle-version="0.10.0",
+ com.fasterxml.jackson.core.jackson-core,
+ com.fasterxml.jackson.core.jackson-annotations,
+ com.fasterxml.jackson.core.jackson-databind
 Bundle-RequiredExecutionEnvironment: JavaSE-11
 Export-Package: org.lflang,
  org.lflang.generator,

org.lflang/build.gradle

@@ -9,7 +9,9 @@ dependencies {
     implementation group: 'org.eclipse.emf', name: 'org.eclipse.emf.mwe2.launch', version: '2.12.1'
     // https://mvnrepository.com/artifact/org.eclipse.lsp4j/org.eclipse.lsp4j
     implementation group: 'org.eclipse.lsp4j', name: 'org.eclipse.lsp4j', version: '0.10.0'
-
+    implementation group: 'com.fasterxml.jackson.core', name: 'jackson-core', version: '2.12.4'
+    implementation group: 'com.fasterxml.jackson.core', name: 'jackson-annotations', version: '2.12.4'
+    implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.12.4'
 }
 
 configurations {

org.lflang/src/lib/ts/.eslintrc.json

@@ -0,0 +1,11 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/eslint-recommended",
+    "plugin:@typescript-eslint/recommended"
+  ]
+}

org.lflang/src/lib/ts/package.json

@@ -26,6 +26,9 @@
         "@babel/preset-typescript": "^7.8.3",
         "@types/google-protobuf": "^3.7.4",
         "@types/node": "^13.9.2",
+        "@typescript-eslint/eslint-plugin": "^5.8.1",
+        "@typescript-eslint/parser": "^5.8.1",
+        "eslint": "^8.5.0",
         "typescript": "^3.8.3",
         "ts-protoc-gen": "^0.12.0"
     },

org.lflang/src/org/lflang/ASTUtils.xtend

@@ -575,6 +575,19 @@ class ASTUtils {
      * @return Textual representation of the given argument.
      */
     def static String toText(Code code) {
+        return CodeMap.Correspondence.tag(code, toUntaggedText(code), true)
+    }
+
+    /**
+     * Translate the given code into its textual representation
+     * without any tags inserted.
+     * @param code AST node to render as string.
+     * @return Textual representation of the given argument.
+     */
+    def private static String toUntaggedText(Code code) {
+        // FIXME: This function should not be necessary, but it is because we currently
+        //  parse the content of code blocks in the validator and generator. See #810, #657.
+        var text = ""
         if (code !== null) {
             val node = NodeModelUtils.getNode(code)
             if (node !== null) {
@@ -591,35 +604,17 @@ class ASTUtils {
                 str = str.substring(start + 2, end)
                 if (str.split('\n').length > 1) {
                     // multi line code
-                    return str.trimCodeBlock
+                    text = str.trimCodeBlock
                 } else {
                     // single line code
-                    return str.trim
-                }    
+                    text = str.trim
+                }
             } else if (code.body !== null) {
                 // Code must have been added as a simple string.
-                return code.body.toString
+                text = code.body.toString
             }
         }
-        return ""
-    }
-
-    /**
-     * Translate the given code into its textual representation,
-     * with a tag inserted to establish this representation's
-     * correspondence to the generated code. This tag is an
-     * implementation detail that is internal to the code
-     * generator.
-     * @param code the AST node to render as a string
-     * @return a textual representation of {@code code}
-     */
-    def static String toTaggedText(Code code) {
-        // FIXME: Duplicates work already done in
-        //  GeneratorBase::prSourceLineNumber. It does not
-        //  make sense for both methods to persist in the
-        //  code base at once.
-        val text = toText(code)
-        return CodeMap.Correspondence.tag(code, text, true)
+        return text
     }
 
     def static toText(TypeParm t) {
@@ -910,7 +905,7 @@ class ASTUtils {
     }
 
     def static boolean isZero(Code code) {
-        if (code !== null && code.toText.isZero) {
+        if (code !== null && code.toUntaggedText.isZero) {
             return true
         }
         return false
@@ -951,7 +946,7 @@ class ASTUtils {
      * @return True if the given code is an integer, false otherwise.
      */
 	def static boolean isInteger(Code code) {
-        return code.toText.isInteger
+        return code.toUntaggedText.isInteger
     }
 
     /**

org.lflang/src/org/lflang/AstExtensions.kt

@@ -144,13 +144,6 @@ val StateVar.isOfTimeType: Boolean get() = JavaAstUtils.isOfTimeType(this)
  */
 fun Code.toText(): String = ASTUtils.toText(this)
 
-/**
- * Translate this code element into its tagged textual
- * representation.
- * @see ASTUtils.toTaggedText
- */
-fun Code.toTaggedText(): String = ASTUtils.toTaggedText(this)
-
 /**
  * Translate this code element into its textual representation.
  * @see ASTUtils.toText

org.lflang/src/org/lflang/ErrorReporter.java

@@ -3,6 +3,9 @@
 import java.nio.file.Path;
 
 import org.eclipse.emf.ecore.EObject;
+import org.eclipse.lsp4j.DiagnosticSeverity;
+
+import org.lflang.generator.Position;
 
 /**
  * Interface for reporting errors.
@@ -55,7 +58,7 @@ public interface ErrorReporter {
      * Report an error at the specified line within a file.
      *
      * @param message The error message.
-     * @param line    The line number to report at.
+     * @param line    The one-based line number to report at.
      * @param file    The file to report at.
      * @return a string that describes the error.
      */
@@ -66,12 +69,59 @@ public interface ErrorReporter {
      * Report a warning at the specified line within a file.
      *
      * @param message The error message.
-     * @param line    The line number to report at.
+     * @param line    The one-based line number to report at.
      * @param file    The file to report at.
      * @return a string that describes the warning.
      */
     String reportWarning(Path file, Integer line, String message);
 
+    /**
+     * Report a message of severity {@code severity}.
+     * @param severity the severity of the message
+     * @param message the message to send to the IDE
+     * @return a string that describes the diagnostic
+     */
+    default String report(DiagnosticSeverity severity, String message) {
+        switch (severity) {
+        case Error:
+            return reportError(message);
+        case Warning:
+        case Hint:
+        case Information:  // FIXME: Information -> warning?? If this results in false alarms from LFC, we should expand API.
+        default:
+            return reportWarning(message);
+        }
+    }
+
+    /**
+     * Report a message of severity {@code severity} that
+     * pertains to line {@code line} of an LF source file.
+     * @param severity the severity of the message
+     * @param message the message to send to the IDE
+     * @param line the one-based line number associated
+     *             with the message
+     * @return a string that describes the diagnostic
+     */
+    default String report(DiagnosticSeverity severity, String message, int line) {
+        return report(severity, message);
+    }
+
+    /**
+     * Report a message of severity {@code severity} that
+     * pertains to the range [{@code startPos}, {@code endPos})
+     * of an LF source file.
+     * @param severity the severity of the message
+     * @param message the message to send to the IDE
+     * @param startPos the position of the first character
+     *                 of the range of interest
+     * @param endPos the position immediately AFTER the
+     *               final character of the range of
+     *               interest
+     * @return a string that describes the diagnostic
+     */
+    default String report(DiagnosticSeverity severity, String message, Position startPos, Position endPos) {
+        return report(severity, message);
+    }
 
     /**
      * Check if errors where reported.

org.lflang/src/org/lflang/generator/ActionInstance.java

@@ -26,11 +26,9 @@ STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 
 package org.lflang.generator;
 
-import org.lflang.JavaAstUtils;
 import org.lflang.TimeValue;
 import org.lflang.lf.Action;
 import org.lflang.lf.ActionOrigin;
-import org.lflang.lf.Parameter;
 
 /**
  * Instance of an action.

org.lflang/src/org/lflang/generator/CodeMap.java

@@ -30,7 +30,7 @@ public static class Correspondence {
             "/\\*Correspondence: (?<lfRange>%s) \\-> (?<generatedRange>%s) \\(src=(?<path>%s)\\)\\*/",
             Position.removeNamedCapturingGroups(Range.PATTERN),
             Position.removeNamedCapturingGroups(Range.PATTERN),
-            ".*"
+            ".*?"
         ));
 
         // TODO(peter): Add "private final boolean verbatim;" and make corresponding enhancements
@@ -153,21 +153,12 @@ public static String tag(EObject astNode, String representation, boolean verbati
             Position lfStart = Position.fromOneBased(
                 oneBasedLfLineAndColumn.getLine(), oneBasedLfLineAndColumn.getColumn()
             );
-            Position lfDisplacement;
-            final Position generatedCodeDisplacement = Position.displacementOf(representation);
             final Path lfPath = Path.of(astNode.eResource().getURI().path());
-            if (verbatim) {
-                lfStart = lfStart.plus(Position.displacementOf(
-                    node.getText().substring(0, indexOf(node.getText(), representation))
-                ));
-                lfDisplacement = generatedCodeDisplacement;
-            } else {
-                lfDisplacement = Position.displacementOf(node.getText());
-            }
+            if (verbatim) lfStart = lfStart.plus(node.getText().substring(0, indexOf(node.getText(), representation)));
             return new Correspondence(
                 lfPath,
-                new Range(lfStart, lfStart.plus(lfDisplacement)),
-                new Range(Position.ORIGIN, generatedCodeDisplacement)
+                new Range(lfStart, lfStart.plus(verbatim ? representation : node.getText())),
+                new Range(Position.ORIGIN, Position.displacementOf(representation))
             ) + representation;
         }