[DQL] Detecting DQL Expression files (#132)

* [DQL] Detecting DQL Expression files

In cases where a DQL expression is written in a DQL file, the inspection will suggest renaming it into the `.dqlexpr` file.

* Resolving code review issues

Author: dorian-krefft-dt

CHANGELOG.md

@@ -45,6 +45,7 @@
 - Added missing quick fixes for inspections:
   - Dropping DQL commands and functions for unknown & experimental expressions
   - Renaming the DQL file to `.dqlpart` when an invalid command context is detected (only for `.dql` files)
+  - Renaming the DQL file to `.dqlexpr` when the DQL file contains an expression without the command context
 - Adding a Dynatrace Query Console view that allows the user to execute DQL queries without opening a DQL file.
   You can open the console via the `Tools` -> `Services` -> `Dynatrace Query Console` menu or by clicking the dedicated
   button in the `Services` tab.

src/main/java/pl/thedeem/intellij/dql/completion/DQLExternalCompletionContributor.java

@@ -7,6 +7,7 @@
 import pl.thedeem.intellij.dql.DQLUtil;
 import pl.thedeem.intellij.dql.completion.engines.DQLDynatraceAutocomplete;
 import pl.thedeem.intellij.dql.settings.DQLSettings;
+import pl.thedeem.intellij.dqlexpr.DQLExprFileType;
 
 public class DQLExternalCompletionContributor extends CompletionContributor {
 
@@ -15,7 +16,9 @@ public DQLExternalCompletionContributor() {
                 new CompletionProvider<>() {
                     public void addCompletions(@NotNull CompletionParameters parameters, @NotNull ProcessingContext context, @NotNull CompletionResultSet resultSet) {
                         PsiFile file = parameters.getOriginalFile();
-                        if (DQLUtil.isPartialFile(file) || !DQLSettings.getInstance().isUseDynatraceAutocompleteEnabled()) {
+                        if (!DQLSettings.getInstance().isUseDynatraceAutocompleteEnabled()
+                                || DQLUtil.isPartialFile(file)
+                                || DQLExprFileType.INSTANCE.equals(file.getFileType())) {
                             return;
                         }
                         new DQLDynatraceAutocomplete().autocomplete(parameters, resultSet);

src/main/java/pl/thedeem/intellij/dql/inspections/commands/PotentialExpressionFileInspection.java

@@ -0,0 +1,66 @@
+package pl.thedeem.intellij.dql.inspections.commands;
+
+import com.intellij.codeInspection.LocalInspectionTool;
+import com.intellij.codeInspection.ProblemHighlightType;
+import com.intellij.codeInspection.ProblemsHolder;
+import com.intellij.psi.*;
+import com.intellij.psi.util.PsiTreeUtil;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import pl.thedeem.intellij.dql.DQLBundle;
+import pl.thedeem.intellij.dql.DQLFile;
+import pl.thedeem.intellij.dql.inspections.fixes.RenameFileQuickFix;
+import pl.thedeem.intellij.dql.psi.DQLCommand;
+import pl.thedeem.intellij.dql.psi.DQLQuery;
+import pl.thedeem.intellij.dqlexpr.DQLExprLanguage;
+
+public class PotentialExpressionFileInspection extends LocalInspectionTool {
+    @Override
+    public @NotNull PsiElementVisitor buildVisitor(@NotNull ProblemsHolder holder, boolean isOnTheFly) {
+        return new PsiElementVisitor() {
+            @Override
+            public void visitFile(@NotNull PsiFile file) {
+                super.visitFile(file);
+
+                if (!(file instanceof DQLFile)) {
+                    return;
+                }
+
+                PsiElement content = findPotentialDQLExpressionContent(file);
+                if (content != null && isValidExpressionFile(file)) {
+                    holder.registerProblem(
+                            content,
+                            DQLBundle.message("inspection.potentialExpressionFile.detected"),
+                            ProblemHighlightType.WARNING,
+                            new RenameFileQuickFix(file.getName().replaceFirst("(?i)\\.dql$", ".dqlexpr"))
+                    );
+                }
+            }
+        };
+    }
+
+    private @Nullable PsiElement findPotentialDQLExpressionContent(@NotNull PsiFile file) {
+        DQLQuery query = PsiTreeUtil.getChildOfType(file, DQLQuery.class);
+        if (query == null) {
+            return PsiTreeUtil.getChildOfType(file, PsiErrorElement.class);
+        }
+        DQLCommand[] commands = PsiTreeUtil.getChildrenOfType(query, DQLCommand.class);
+        if (commands == null || commands.length != 1) {
+            return null;
+        }
+        DQLCommand command = commands[0];
+        if (command.getDefinition() != null) {
+            return null;
+        }
+
+        return command;
+    }
+
+    private boolean isValidExpressionFile(@NotNull PsiFile file) {
+        PsiFile dqlExprFile = PsiFileFactory.getInstance(file.getProject())
+                .createFileFromText("temp.dqlexpr", DQLExprLanguage.INSTANCE, file.getText());
+        PsiErrorElement[] errors = PsiTreeUtil.getChildrenOfType(dqlExprFile, PsiErrorElement.class);
+        return errors == null || errors.length == 0;
+    }
+}
+

src/main/java/pl/thedeem/intellij/dql/inspections/external/DQLVerificationAnnotator.java

@@ -30,6 +30,7 @@
 import pl.thedeem.intellij.dql.settings.DQLSettings;
 import pl.thedeem.intellij.dql.settings.tenants.DynatraceTenant;
 import pl.thedeem.intellij.dql.settings.tenants.DynatraceTenantsService;
+import pl.thedeem.intellij.dqlexpr.DQLExprFileType;
 
 import java.io.IOException;
 import java.net.ConnectException;
@@ -129,6 +130,7 @@ private TextRange getTextRange(DQLVerifyResponse.DQLVerifyNotification notificat
     private boolean canPerformExternalValidation(Input input) {
         // We cannot do any annotations on partial files, as they will not be valid either way
         return !DQLUtil.isPartialFile(input.file)
+                && !DQLExprFileType.INSTANCE.equals(input.file.getFileType())
                 && DQLSettings.getInstance().isPerformingLiveValidationEnabled();
     }
 

src/main/java/pl/thedeem/intellij/dql/inspections/fixes/RenameFileQuickFix.java

@@ -17,7 +17,7 @@ public class RenameFileQuickFix implements LocalQuickFix {
     public RenameFileQuickFix(@NotNull String proposedName) {
         this.proposedName = proposedName;
     }
-    
+
     @Override
     public @NotNull IntentionPreviewInfo generatePreview(@NotNull Project project, @NotNull ProblemDescriptor previewDescriptor) {
         return IntentionPreviewInfo.EMPTY;
@@ -28,6 +28,11 @@ public RenameFileQuickFix(@NotNull String proposedName) {
         return DQLBundle.message("inspection.command.context.fixes.renameFile", proposedName);
     }
 
+    @Override
+    public boolean startInWriteAction() {
+        return false;
+    }
+
     @Override
     public void applyFix(@NotNull Project project, @NotNull ProblemDescriptor descriptor) {
         PsiElement element = descriptor.getPsiElement();

src/main/resources/META-INF/plugin.xml

@@ -163,6 +163,11 @@
                          groupKey="inspection.groups.dql" key="inspection.function.duplicatedParameters.display.name"
                          implementationClass="pl.thedeem.intellij.dql.inspections.functions.DuplicatedFunctionParameterInspection"/>
         <!-- Command validations -->
+        <localInspection language="DQL" bundle="messages.DQLBundle" shortName="DQLPotentialExpressionFile"
+                         enabledByDefault="true"
+                         level="WARNING"
+                         groupKey="inspection.groups.dql" key="inspection.potentialExpressionFile.display.name"
+                         implementationClass="pl.thedeem.intellij.dql.inspections.commands.PotentialExpressionFileInspection"/>
         <localInspection language="DQL" bundle="messages.DQLBundle" shortName="DQLUnknownCommand"
                          enabledByDefault="true"
                          level="ERROR"

src/main/resources/inspectionDescriptions/DQLPotentialExpressionFile.html

@@ -0,0 +1,24 @@
+<html lang="en">
+<body>
+Detects when a DQL file contains expressions that don't parse as valid DQL queries.
+
+<p>
+    This inspection identifies files where the content fails to parse as a valid DQL query,
+    but would be valid as a DQL expression. Such cases can be properly parsed as a separate language, which this
+    plugin does support for files with the <code>.dqlexpr</code> extension.
+</p>
+
+<p>
+    The inspection validates that the file content would parse correctly as a DQL expression before suggesting
+    the conversion. This ensures that converting the file will resolve the parsing errors.
+</p>
+<pre><code>
+not matchesValue(field, "something") and matchesPhrase(field2, "somethingelse")
+</code></pre>
+
+<p>
+    The inspection will suggest converting the file to use the <code>.dqlexpr</code> extension
+    to properly support expression-only syntax.
+</p>
+</body>
+</html>

src/main/resources/messages/DQLBundle.properties

@@ -253,7 +253,9 @@ inspection.command.context.invalidStartingCommand=The command {0} cannot be used
 inspection.command.context.pipeNotAllowed=DQL query cannot start with "|" symbol. If this is a partial DQL, rename the file to "*.partial.dql"
 inspection.command.context.invalidExtensionCommand=The command {0} cannot be used as a DQL query extension
 inspection.command.context.missingPipe=DQL statements must be separated by the "|" symbol
-inspection.command.context.fixes.renameFile=Move to a partial file: {0}
+inspection.command.context.fixes.renameFile=Rename the file to {0}
+inspection.potentialExpressionFile.display.name=Potential DQL expression file
+inspection.potentialExpressionFile.detected=This file does not contain a valid DQL query. If it contains only a DQL expression without the command context, it should be a DQL Expression File.
 inspection.command.body.display.name=Missing command parameters
 inspection.command.body.missingRequiredParameters=The command {0} is missing the required parameters: {1}
 inspection.command.duplicatedParameters.display.name=Duplicated command parameter