Merge pull request #50559 from angelozerr/qute_debug_in_jar

Use Qute Template#getSource() in Qute debugger

Author: mkouba

independent-projects/qute/debug/src/main/java/io/quarkus/qute/debug/Debugger.java

@@ -9,6 +9,7 @@
 import org.eclipse.lsp4j.debug.Scope;
 import org.eclipse.lsp4j.debug.Source;
 import org.eclipse.lsp4j.debug.SourceBreakpoint;
+import org.eclipse.lsp4j.debug.SourceResponse;
 import org.eclipse.lsp4j.debug.StackFrame;
 import org.eclipse.lsp4j.debug.StackTraceResponse;
 import org.eclipse.lsp4j.debug.Thread;
@@ -142,6 +143,15 @@ public interface Debugger {
      */
     CompletableFuture<CompletionsResponse> completions(CompletionsArguments args);
 
+    /**
+     * Returns the source code template for a given source reference.
+     *
+     * @param sourceReference the source reference
+     *
+     * @return the source code template for a given source reference
+     */
+    SourceResponse getSourceReference(int sourceReference);
+
     /**
      * Registers a debugger listener to receive debug events.
      *
@@ -169,4 +179,5 @@ public interface Debugger {
      * @return {@code true} if enabled, {@code false} otherwise
      */
     boolean isEnabled();
+
 }

independent-projects/qute/debug/src/main/java/io/quarkus/qute/debug/adapter/DebugServerAdapter.java

@@ -25,7 +25,9 @@
 import org.eclipse.lsp4j.debug.SetExceptionBreakpointsArguments;
 import org.eclipse.lsp4j.debug.SetExceptionBreakpointsResponse;
 import org.eclipse.lsp4j.debug.Source;
+import org.eclipse.lsp4j.debug.SourceArguments;
 import org.eclipse.lsp4j.debug.SourceBreakpoint;
+import org.eclipse.lsp4j.debug.SourceResponse;
 import org.eclipse.lsp4j.debug.StackTraceArguments;
 import org.eclipse.lsp4j.debug.StackTraceResponse;
 import org.eclipse.lsp4j.debug.StepInArguments;
@@ -325,6 +327,15 @@ public CompletableFuture<CompletionsResponse> completions(CompletionsArguments a
         return agent.completions(args);
     }
 
+    @Override
+    public CompletableFuture<SourceResponse> source(SourceArguments args) {
+        return CompletableFuture.supplyAsync(() -> {
+            var source = args.getSource();
+            return agent.getSourceReference(source != null && source.getSourceReference() != null ? source.getSourceReference()
+                    : args.getSourceReference());
+        });
+    }
+
     /**
      * Handles a stopped event and notifies the client.
      *

independent-projects/qute/debug/src/main/java/io/quarkus/qute/debug/agent/DebuggeeAgent.java

@@ -3,9 +3,9 @@
 import static io.quarkus.qute.debug.agent.RemoteStackFrame.EMPTY_STACK_FRAMES;
 import static io.quarkus.qute.debug.agent.scopes.RemoteScope.EMPTY_SCOPES;
 
+import java.net.URI;
 import java.util.ArrayList;
 import java.util.Collection;
-import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Map;
 import java.util.Set;
@@ -21,6 +21,7 @@
 import org.eclipse.lsp4j.debug.Scope;
 import org.eclipse.lsp4j.debug.Source;
 import org.eclipse.lsp4j.debug.SourceBreakpoint;
+import org.eclipse.lsp4j.debug.SourceResponse;
 import org.eclipse.lsp4j.debug.StackTraceResponse;
 import org.eclipse.lsp4j.debug.Thread;
 import org.eclipse.lsp4j.debug.Variable;
@@ -32,8 +33,12 @@
 import io.quarkus.qute.debug.StoppedEvent;
 import io.quarkus.qute.debug.ThreadEvent;
 import io.quarkus.qute.debug.ThreadEvent.ThreadStatus;
+import io.quarkus.qute.debug.agent.breakpoints.BreakpointsRegistry;
+import io.quarkus.qute.debug.agent.breakpoints.RemoteBreakpoint;
 import io.quarkus.qute.debug.agent.completions.CompletionSupport;
 import io.quarkus.qute.debug.agent.evaluations.EvaluationSupport;
+import io.quarkus.qute.debug.agent.source.SourceReferenceRegistry;
+import io.quarkus.qute.debug.agent.source.SourceTemplateRegistry;
 import io.quarkus.qute.debug.agent.variables.VariablesRegistry;
 import io.quarkus.qute.trace.ResolveEvent;
 import io.quarkus.qute.trace.TemplateEvent;
@@ -59,8 +64,8 @@ public class DebuggeeAgent implements Debugger {
      */
     private final DebuggerTraceListener debugListener;
 
-    /** Breakpoints mapped by template ID and line number. */
-    private final Map<String, Map<Integer, RemoteBreakpoint>> breakpoints;
+    /** Breakpoints registry */
+    private final BreakpointsRegistry breakpointsRegistry;
 
     /** Currently active debuggee threads mapped by thread ID. */
     private final Map<Integer, RemoteThread> debuggees;
@@ -78,7 +83,10 @@ public class DebuggeeAgent implements Debugger {
     private final VariablesRegistry variablesRegistry;
 
     /** Registry mapping Qute templates to DAP {@link Source} objects. */
-    private final SourceTemplateRegistry sourceTemplateRegistry;
+    private final Map<Engine, SourceTemplateRegistry> sourceTemplateRegistry;
+
+    /** Source reference registry (used to retrieve template content from JAR) */
+    private final SourceReferenceRegistry sourceReferenceRegistry;
 
     /** The set of Qute engines being tracked for debugging. */
     private final Set<Engine> trackedEngine;
@@ -99,11 +107,12 @@ public class DebuggeeAgent implements Debugger {
      */
     public DebuggeeAgent() {
         this.debugListener = new DebuggerTraceListener(this);
-        this.breakpoints = new ConcurrentHashMap<>();
         this.debuggees = new ConcurrentHashMap<>();
         this.listeners = new ArrayList<>();
         this.variablesRegistry = new VariablesRegistry();
-        this.sourceTemplateRegistry = new SourceTemplateRegistry();
+        this.breakpointsRegistry = new BreakpointsRegistry();
+        this.sourceTemplateRegistry = new ConcurrentHashMap<>();
+        this.sourceReferenceRegistry = new SourceReferenceRegistry();
         this.trackedEngine = new HashSet<>();
         this.enginesWithDebugListener = new HashSet<>();
         this.evaluationSupport = new EvaluationSupport(this);
@@ -221,30 +230,7 @@ private RemoteThread getRemoteThread(int threadId) {
 
     @Override
     public Breakpoint[] setBreakpoints(SourceBreakpoint[] sourceBreakpoints, Source source) {
-        sourceTemplateRegistry.registerSource(source);
-        String templateId = sourceTemplateRegistry.getTemplateId(source);
-        Map<Integer, RemoteBreakpoint> templateBreakpoints = templateId != null
-                ? this.breakpoints.computeIfAbsent(templateId, k -> new HashMap<>())
-                : null;
-        if (templateBreakpoints != null) {
-            templateBreakpoints.clear();
-        }
-
-        Breakpoint[] result = new Breakpoint[sourceBreakpoints.length];
-        for (int i = 0; i < sourceBreakpoints.length; i++) {
-            SourceBreakpoint sourceBreakpoint = sourceBreakpoints[i];
-            int line = sourceBreakpoint.getLine();
-            String condition = sourceBreakpoint.getCondition();
-            RemoteBreakpoint breakpoint = new RemoteBreakpoint(source, line, condition);
-            if (templateBreakpoints != null) {
-                templateBreakpoints.put(line, breakpoint);
-                breakpoint.setVerified(true);
-            } else {
-                breakpoint.setVerified(false);
-            }
-            result[i] = breakpoint;
-        }
-        return result;
+        return breakpointsRegistry.setBreakpoints(sourceBreakpoints, source);
     }
 
     @Override
@@ -260,21 +246,15 @@ public Thread[] getThreads() {
     /**
      * Retrieves a breakpoint for the given template and line number.
      *
+     * @param sourceUri
+     *
      * @param templateId the template identifier.
      * @param line the line number.
+     * @param engine
      * @return the matching breakpoint, or {@code null} if none exists.
      */
-    RemoteBreakpoint getBreakpoint(String templateId, int line) {
-        Map<Integer, RemoteBreakpoint> templateBreakpoints = this.breakpoints.get(templateId);
-        if (templateBreakpoints == null) {
-            for (var fileExtension : sourceTemplateRegistry.getFileExtensions()) {
-                templateBreakpoints = this.breakpoints.get(templateId + fileExtension);
-                if (templateBreakpoints != null) {
-                    break;
-                }
-            }
-        }
-        return templateBreakpoints != null ? templateBreakpoints.get(line) : null;
+    RemoteBreakpoint getBreakpoint(URI sourceUri, String templateId, int line, Engine engine) {
+        return breakpointsRegistry.resolveBreakpoint(sourceUri, templateId, line, getSourceTemplateRegistry(engine));
     }
 
     @Override
@@ -368,7 +348,9 @@ public void unlockAllDebuggeeThreads() {
     public void terminate() {
         try {
             unlockAllDebuggeeThreads();
-            this.breakpoints.clear();
+            this.sourceTemplateRegistry.clear();
+            this.sourceReferenceRegistry.reset();
+            this.breakpointsRegistry.reset();
         } finally {
             fireTerminateEvent();
         }
@@ -411,6 +393,11 @@ public CompletableFuture<CompletionsResponse> completions(CompletionsArguments a
         return completionSupport.completions(args);
     }
 
+    @Override
+    public SourceResponse getSourceReference(int sourceReference) {
+        return sourceReferenceRegistry.getSourceReference(sourceReference);
+    }
+
     @Override
     public StackTraceResponse getStackFrames(int threadId, Integer startFrame, Integer levels) {
         StackTraceResponse response = new StackTraceResponse();
@@ -474,8 +461,9 @@ public VariablesRegistry getVariablesRegistry() {
         return variablesRegistry;
     }
 
-    public SourceTemplateRegistry getSourceTemplateRegistry() {
-        return sourceTemplateRegistry;
+    public SourceTemplateRegistry getSourceTemplateRegistry(Engine engine) {
+        return this.sourceTemplateRegistry.computeIfAbsent(engine,
+                k -> new SourceTemplateRegistry(breakpointsRegistry, sourceReferenceRegistry, engine));
     }
 
     @Override
@@ -516,5 +504,7 @@ public boolean isEnabled() {
      */
     public void reset() {
         unlockAllDebuggeeThreads();
+        this.sourceTemplateRegistry.clear();
+        this.sourceReferenceRegistry.reset();
     }
 }

independent-projects/qute/debug/src/main/java/io/quarkus/qute/debug/agent/RemoteStackFrame.java

@@ -1,5 +1,6 @@
 package io.quarkus.qute.debug.agent;
 
+import java.net.URI;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.concurrent.CompletableFuture;
@@ -17,15 +18,18 @@
 import io.quarkus.qute.debug.agent.scopes.LocalsScope;
 import io.quarkus.qute.debug.agent.scopes.NamespaceResolversScope;
 import io.quarkus.qute.debug.agent.scopes.RemoteScope;
+import io.quarkus.qute.debug.agent.source.RemoteSource;
+import io.quarkus.qute.debug.agent.source.SourceTemplateRegistry;
 import io.quarkus.qute.debug.agent.variables.VariablesRegistry;
 import io.quarkus.qute.trace.ResolveEvent;
 
 /**
  * Represents a single stack frame in the Qute debugging process.
  * <p>
- * A {@link RemoteStackFrame} corresponds to the evaluation of a {@link TemplateNode}
- * at runtime. It stores contextual information such as the variables in scope,
- * the template being executed, and the current execution state.
+ * A {@link RemoteStackFrame} corresponds to the evaluation of a
+ * {@link TemplateNode} at runtime. It stores contextual information such as the
+ * variables in scope, the template being executed, and the current execution
+ * state.
  * </p>
  *
  * <p>
@@ -46,7 +50,8 @@ public class RemoteStackFrame extends StackFrame {
     private static final AtomicInteger frameIdCounter = new AtomicInteger();
 
     /**
-     * The previous frame in the call stack, or {@code null} if this is the first frame.
+     * The previous frame in the call stack, or {@code null} if this is the first
+     * frame.
      */
     private final transient RemoteStackFrame previousFrame;
 
@@ -73,7 +78,8 @@ public class RemoteStackFrame extends StackFrame {
     /**
      * Creates a new {@link RemoteStackFrame}.
      *
-     * @param event the resolve event describing the current execution
+     * @param event the resolve event describing the current
+     *        execution
      * @param previousFrame the previous stack frame, may be {@code null}
      * @param sourceTemplateRegistry registry for mapping templates to debug sources
      * @param variablesRegistry the registry for managing variables
@@ -90,7 +96,8 @@ public RemoteStackFrame(ResolveEvent event, RemoteStackFrame previousFrame,
         super.setLine(line);
         this.templateId = event.getTemplateNode().getOrigin().getTemplateId();
         super.setSource(
-                sourceTemplateRegistry.getSource(templateId, previousFrame != null ? previousFrame.getSource() : null));
+                sourceTemplateRegistry.getSource(templateId,
+                        previousFrame != null ? previousFrame.getSource() : null));
     }
 
     /**
@@ -102,6 +109,21 @@ public String getTemplateId() {
         return templateId;
     }
 
+    /**
+     * Returns the template Uri associated with this frame and null otherwise.
+     *
+     * @return the template Uri associated with this frame and null otherwise.
+     */
+    public URI getTemplateUri() {
+        var source = getSource();
+        return source != null ? source.getUri() : null;
+    }
+
+    @Override
+    public RemoteSource getSource() {
+        return (RemoteSource) super.getSource();
+    }
+
     /**
      * Returns the previous stack frame, or {@code null} if none exists.
      *
@@ -151,7 +173,8 @@ private Collection<RemoteScope> createScopes() {
      * Evaluates an expression in the current frame context.
      * <p>
      * If the expression contains conditional operators, it is parsed and evaluated
-     * as a conditional expression. Otherwise, it is treated as a simple Qute expression.
+     * as a conditional expression. Otherwise, it is treated as a simple Qute
+     * expression.
      * </p>
      *
      * @param expression the expression to evaluate
@@ -173,10 +196,12 @@ public CompletableFuture<Object> evaluate(String expression) {
     }
 
     /**
-     * Determines if a given expression should be treated as a conditional expression.
+     * Determines if a given expression should be treated as a conditional
+     * expression.
      *
      * @param expression the expression to test
-     * @return {@code true} if the expression contains conditional operators, {@code false} otherwise
+     * @return {@code true} if the expression contains conditional operators,
+     *         {@code false} otherwise
      */
     private static boolean isConditionExpression(String expression) {
         return expression.contains("!") || expression.contains(">") || expression.contains("gt")
@@ -191,7 +216,8 @@ private static boolean isConditionExpression(String expression) {
      * Evaluates a parsed conditional expression.
      *
      * @param ifNode the parsed {@link TemplateNode} representing the condition
-     * @param ignoreError whether to ignore evaluation errors and return {@code false}
+     * @param ignoreError whether to ignore evaluation errors and return
+     *        {@code false}
      * @return a {@link CompletableFuture} containing {@code true} or {@code false}
      */
     public CompletableFuture<Object> evaluateCondition(TemplateNode ifNode, boolean ignoreError) {

independent-projects/qute/debug/src/main/java/io/quarkus/qute/debug/agent/RemoteThread.java

@@ -1,5 +1,6 @@
 package io.quarkus.qute.debug.agent;
 
+import java.net.URI;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.function.Predicate;
@@ -13,6 +14,7 @@
 import io.quarkus.qute.debug.StoppedEvent.StoppedReason;
 import io.quarkus.qute.debug.ThreadEvent;
 import io.quarkus.qute.debug.ThreadEvent.ThreadStatus;
+import io.quarkus.qute.debug.agent.breakpoints.RemoteBreakpoint;
 import io.quarkus.qute.trace.ResolveEvent;
 
 /**
@@ -163,18 +165,20 @@ public void onTemplateNode(ResolveEvent event) {
             return;
         }
 
-        RemoteStackFrame frame = new RemoteStackFrame(event, getCurrentFrame(), agent.getSourceTemplateRegistry(),
+        var engine = event.getEngine();
+        RemoteStackFrame frame = new RemoteStackFrame(event, getCurrentFrame(), agent.getSourceTemplateRegistry(engine),
                 agent.getVariablesRegistry());
         this.frames.addFirst(frame);
         String templateId = frame.getTemplateId();
+        URI sourceUri = frame.getTemplateUri();
         RemoteStackFrame previous = frame.getPrevious();
 
         if (this.stopCondition != null && this.stopCondition.test(event.getTemplateNode())) {
             // suspend and wait because of step reason.
             this.suspendAndWait(StoppedReason.STEP);
         } else {
             int lineNumber = frame.getLine();
-            RemoteBreakpoint breakpoint = agent.getBreakpoint(templateId, lineNumber);
+            RemoteBreakpoint breakpoint = agent.getBreakpoint(sourceUri, templateId, lineNumber, engine);
             if (breakpoint != null // a breakpoint matches the frame line number
                     && (previous == null || !previous.getTemplateId().equals(templateId) || previous.getLine() != lineNumber
                             || event.getTemplateNode().isExpression())