Fix #69 Fix semantic tokens of a comment embedded in an ENV

If an ENV instruction spans multiple lines and an embedded comment appears before any declared variables, the semantic token calculation will get stuck in an infinite loop. This has now been fixed with an upgrade to dockerfile-ast. Signed-off-by: Remy Suen <[email protected]>
rcjsuen · Jun 18, 2020 · c57882f · c57882f
1 parent 3297d23
commit c57882f
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 4 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -20,7 +20,7 @@
     "node": "*"
   },
   "dependencies": {
-    "dockerfile-ast": "0.0.25",
+    "dockerfile-ast": "0.0.27",
     "dockerfile-utils": "0.0.16",
     "vscode-languageserver-protocol": "^3.15.3",
     "vscode-languageserver-types": "^3.15.1"

diff --git a/test/dockerSemanticTokens.test.ts b/test/dockerSemanticTokens.test.ts
@@ -1550,6 +1550,31 @@ describe("Dockerfile Semantic Token tests", () => {
                 assertEdit(tokens.data, SemanticTokenTypes.parameter, 25, 0, 5, 2);
                 assertEdit(tokens.data, SemanticTokenTypes.parameter, 30, 0, 3, 4);
             });
+
+            it("multiline ENV instruction with only a comment", () => {
+                let content = "ENV \\\n# common variables:";
+                let tokens = computeSemanticTokens(content);
+                assert.equal(15, tokens.data.length);
+                assertEdit(tokens.data, SemanticTokenTypes.keyword, 0, 0, 0, 3);
+                assertEdit(tokens.data, SemanticTokenTypes.macro, 5, 0, 4, 1);
+                assertEdit(tokens.data, SemanticTokenTypes.comment, 10, 1, 0, 19);
+            });
+
+            it("multiline ENV instruction with a comment its variables", () => {
+                let content = "ENV \\\n# common variables:\n  ENV1=something \\\n  ENV2=999";
+                let tokens = computeSemanticTokens(content);
+                assert.equal(50, tokens.data.length);
+                assertEdit(tokens.data, SemanticTokenTypes.keyword, 0, 0, 0, 3);
+                assertEdit(tokens.data, SemanticTokenTypes.macro, 5, 0, 4, 1);
+                assertEdit(tokens.data, SemanticTokenTypes.comment, 10, 1, 0, 19);
+                assertEdit(tokens.data, SemanticTokenTypes.variable, 15, 1, 2, 4, [SemanticTokenModifiers.declaration]);
+                assertEdit(tokens.data, SemanticTokenTypes.operator, 20, 0, 4, 1);
+                assertEdit(tokens.data, SemanticTokenTypes.parameter, 25, 0, 1, 9);
+                assertEdit(tokens.data, SemanticTokenTypes.macro, 30, 0, 10, 1);
+                assertEdit(tokens.data, SemanticTokenTypes.variable, 35, 1, 2, 4, [SemanticTokenModifiers.declaration]);
+                assertEdit(tokens.data, SemanticTokenTypes.operator, 40, 0, 4, 1);
+                assertEdit(tokens.data, SemanticTokenTypes.parameter, 45, 0, 1, 3);
+            });
         });
     });
 });