Added --inspect.SuspensionTimeout option. (GR-54751)

Author: entlicher

docs/tools/chrome-debugger.md

@@ -92,6 +92,7 @@ information and launch the debugger. Launch debugging via the printed WSS URL di
 * `--inspect.WaitAttached=(true|false)` when true, no guest language source code is executed until the inspector client is attached. Unlike `--inspect.Suspend=true`, the execution is resumed right
 after the client is attached. This assures that no execution is missed by the
 inspector client. It is `false` by default.
+* `--inspect.SuspensionTimeout` sets a timeout of a debugger suspension. The debugger session is disconnected after the timeout expires. The timeout value consists of a positive integer value followed by a chronological time unit. For example, '15m' or '10s'. Valid time units are 'ms' for milliseconds, 's' for seconds, 'm' for minutes, 'h' for hours, and 'd' for days. There is no timeout set by default.
 
 ### Advanced Debug Options
 The following options are for language experts and language developers:

tools/CHANGELOG.md

@@ -7,6 +7,7 @@ This changelog summarizes major changes between Truffle Tools versions.
 * GR-52742: `CPUSamplerData#getDataList()` was introduced and returns all data collected by the sampler as a list of `CPUSamplerData`. For each context on the engine, including the ones that were already collected, there is a corresponding element in the list. `CPUSamplerData#getContextIndex()` returns the index of the data in the list.
 * GR-53035: Added CPUSampler support for gathering any async stack trace information for each sample, enabled by default. Introduced configuration option `--cpusampler.GatherAsyncStackTrace=true|false`, and corresponding API [`CPUSampler#setGatherAsyncStackTrace`](https://www.graalvm.org/tools/javadoc/com/oracle/truffle/tools/profiler/CPUSampler.html#setGatherAsyncStackTrace(boolean)), to allow disabling async stack trace sampling again.
 * GR-53035: `StackTraceEntry#isInlined()` is no longer deprecated.
+* GR-54751: `--inspect.SuspensionTimeout` option added to set a timeout of a debugger suspension. The debugger session is disconnected after the timeout expires.
 
 ## Version 23.0.0
 * GR-41407: Added new option `--dap.SourcePath` to allow to resolve sources with relative paths.

tools/src/com.oracle.truffle.tools.chromeinspector.test/src/com/oracle/truffle/tools/chromeinspector/test/InspectorMessageTransportTest.java

@@ -240,6 +240,24 @@ public void inspectorCloseAfterDisposeTest() {
         }
     }
 
+    @Test
+    public void inspectorTimeoutTest() {
+        Session session = new Session(true);
+        DebuggerEndpoint endpoint = new DebuggerEndpoint("simplePath" + SecureInspectorPathGenerator.getToken(), null);
+        try (Engine engine = endpoint.onOpen(session, Engine.newBuilder().option("inspect.SuspensionTimeout", "1s"))) {
+            try (Context context = Context.newBuilder().engine(engine).build()) {
+                context.eval("sl", "function main() {\n  x = 1;\n  return x;\n}");
+            }
+        }
+        int numMessages = MESSAGES_TO_BACKEND.length + MESSAGES_TO_CLIENT.length - 2;
+        Assert.assertEquals(session.messages.toString(), numMessages, session.messages.size());
+        assertMessages(session.messages, MESSAGES_TO_BACKEND.length - 1, MESSAGES_TO_CLIENT.length - 2);
+        String timeoutMessage = session.messages.get(numMessages - 1);
+        String expectedMessage = "2C{\"method\":\"Runtime.consoleAPICalled\",\"params\":{\"args\":[{\"type\":\"string\"," +
+                        "\"value\":\"Timeout of 1000ms as specified via '--inspect.SuspensionTimeout' was reached. The debugger session is disconnected.\"}]";
+        Assert.assertTrue(timeoutMessage, timeoutMessage.startsWith(expectedMessage));
+    }
+
     @Test
     public void inspectorContextClosedTest() throws IOException, InterruptedException {
         Session session = new Session(null);
@@ -303,6 +321,11 @@ private static final class Session {
             this.rc = rc;
         }
 
+        Session(boolean skipResume) {
+            remote.setSkipResume(skipResume);
+            this.rc = null;
+        }
+
         BasicRemote getBasicRemote() {
             return remote;
         }
@@ -341,11 +364,16 @@ private static final class BasicRemote {
         Session.MsgHandler handler;
         private final List<String> messages;
         private boolean didStep = false;
+        private boolean skipResume;
 
         BasicRemote(List<String> messages) {
             this.messages = messages;
         }
 
+        private void setSkipResume(boolean skipResume) {
+            this.skipResume = skipResume;
+        }
+
         void sendText(String text) throws IOException {
             if (!text.startsWith("{\"method\":\"Debugger.scriptParsed\"")) {
                 synchronized (messages) {
@@ -357,7 +385,7 @@ void sendText(String text) throws IOException {
                 if (!didStep) {
                     handler.onMessage("{\"id\":50,\"method\":\"Debugger.stepOver\"}");
                     didStep = true;
-                } else {
+                } else if (!skipResume) {
                     handler.onMessage("{\"id\":100,\"method\":\"Debugger.resume\"}");
                     didStep = false;
                 }
@@ -383,8 +411,12 @@ void setOpenCountLimit(int openCountLimit) {
         }
 
         public Engine onOpen(final Session session) {
+            return onOpen(session, Engine.newBuilder());
+        }
+
+        public Engine onOpen(final Session session, Engine.Builder engineBuilder) {
             assert this != null;
-            Engine.Builder engineBuilder = Engine.newBuilder().serverTransport(new EndpointMessageTransport(session)).option("inspect", PORT);
+            engineBuilder.serverTransport(new EndpointMessageTransport(session)).option("inspect", PORT);
             if (path != null) {
                 engineBuilder.option("inspect.Path", path);
             }

tools/src/com.oracle.truffle.tools.chromeinspector.test/src/com/oracle/truffle/tools/chromeinspector/test/InspectorTestInstrument.java

@@ -48,7 +48,7 @@ public final class InspectorTestInstrument extends TruffleInstrument {
     protected void onCreate(final Env env) {
         env.registerService(new InspectSessionInfoProvider() {
             @Override
-            public InspectSessionInfo getSessionInfo(final boolean suspend, final boolean inspectInternal, final boolean inspectInitialization, final List<URI> sourcePath) {
+            public InspectSessionInfo getSessionInfo(final boolean suspend, final boolean inspectInternal, final boolean inspectInitialization, final List<URI> sourcePath, Long suspensionTimeout) {
                 return new InspectSessionInfo() {
 
                     private InspectServerSession iss;
@@ -57,9 +57,10 @@ public InspectSessionInfo getSessionInfo(final boolean suspend, final boolean in
                     private long id;
 
                     InspectSessionInfo init() {
-                        this.context = new InspectorExecutionContext("test", inspectInternal, inspectInitialization, env, sourcePath, new PrintWriter(env.err(), true));
+                        PrintWriter err = new PrintWriter(env.err(), true);
+                        this.context = new InspectorExecutionContext("test", inspectInternal, inspectInitialization, env, sourcePath, err, err, suspensionTimeout);
                         this.connectionWatcher = new ConnectionWatcher();
-                        this.iss = InspectServerSession.create(context, suspend, connectionWatcher);
+                        this.iss = InspectServerSession.create(context, suspend, connectionWatcher, () -> this.iss.dispose());
                         lastServerSession = new WeakReference<>(iss);
                         this.id = context.getId();
                         // Fake connection open
@@ -104,7 +105,7 @@ protected void onFinalize(Env env) {
 }
 
 interface InspectSessionInfoProvider {
-    InspectSessionInfo getSessionInfo(boolean suspend, boolean inspectInternal, boolean inspectInitialization, List<URI> sourcePath);
+    InspectSessionInfo getSessionInfo(boolean suspend, boolean inspectInternal, boolean inspectInitialization, List<URI> sourcePath, Long suspensionTimeout);
 }
 
 interface InspectSessionInfo {

tools/src/com.oracle.truffle.tools.chromeinspector.test/src/com/oracle/truffle/tools/chromeinspector/test/InspectorTester.java

@@ -66,19 +66,16 @@ public static InspectorTester start(boolean suspend) throws InterruptedException
     }
 
     public static InspectorTester start(boolean suspend, final boolean inspectInternal, final boolean inspectInitialization) throws InterruptedException {
-        return start(suspend, inspectInternal, inspectInitialization, Collections.emptyList());
+        return start(new Options(suspend, inspectInternal, inspectInitialization));
     }
 
-    public static InspectorTester start(boolean suspend, final boolean inspectInternal, final boolean inspectInitialization, List<URI> sourcePath) throws InterruptedException {
-        return start(suspend, inspectInternal, inspectInitialization, sourcePath, null);
-    }
-
-    public static InspectorTester start(boolean suspend, final boolean inspectInternal, final boolean inspectInitialization, List<URI> sourcePath, Consumer<Context> prolog)
+    public static InspectorTester start(Options options)
                     throws InterruptedException {
         RemoteObject.resetIDs();
         ExceptionDetails.resetIDs();
         InspectorExecutionContext.resetIDs();
-        InspectExecThread exec = new InspectExecThread(suspend, inspectInternal, inspectInitialization, sourcePath, prolog);
+        InspectExecThread exec = new InspectExecThread(options.isSuspend(), options.isInspectInternal(), options.isInspectInitialization(), options.getSourcePath(), options.getProlog(),
+                        options.getSuspensionTimeout());
         exec.start();
         exec.initialized.acquire();
         return new InspectorTester(exec);
@@ -263,13 +260,88 @@ public String receiveMessages(boolean ignoreNotMatched, String... messageParts)
         return allMessages.toString();
     }
 
+    public static final class Options {
+
+        private boolean suspend;
+        private boolean inspectInternal;
+        private boolean inspectInitialization;
+        private List<URI> sourcePath = Collections.emptyList();
+        private Consumer<Context> prolog;
+        private Long suspensionTimeout;
+
+        public Options(boolean suspend) {
+            this.suspend = suspend;
+        }
+
+        public Options(boolean suspend, final boolean inspectInternal, final boolean inspectInitialization) {
+            this.suspend = suspend;
+            this.inspectInternal = inspectInternal;
+            this.inspectInitialization = inspectInitialization;
+        }
+
+        public boolean isSuspend() {
+            return suspend;
+        }
+
+        public Options setSuspend(boolean suspend) {
+            this.suspend = suspend;
+            return this;
+        }
+
+        public boolean isInspectInternal() {
+            return inspectInternal;
+        }
+
+        public Options setInspectInternal(boolean inspectInternal) {
+            this.inspectInternal = inspectInternal;
+            return this;
+        }
+
+        public boolean isInspectInitialization() {
+            return inspectInitialization;
+        }
+
+        public Options setInspectInitialization(boolean inspectInitialization) {
+            this.inspectInitialization = inspectInitialization;
+            return this;
+        }
+
+        public List<URI> getSourcePath() {
+            return sourcePath;
+        }
+
+        public Options setSourcePath(List<URI> sourcePath) {
+            this.sourcePath = sourcePath;
+            return this;
+        }
+
+        public Consumer<Context> getProlog() {
+            return prolog;
+        }
+
+        public Options setProlog(Consumer<Context> prolog) {
+            this.prolog = prolog;
+            return this;
+        }
+
+        public Long getSuspensionTimeout() {
+            return suspensionTimeout;
+        }
+
+        public Options setSuspensionTimeout(Long suspensionTimeout) {
+            this.suspensionTimeout = suspensionTimeout;
+            return this;
+        }
+    }
+
     private static class InspectExecThread extends Thread implements MessageEndpoint {
 
         private final boolean suspend;
         private final boolean inspectInternal;
         private final boolean inspectInitialization;
         private final List<URI> sourcePath;
         private final Consumer<Context> prolog;
+        private final Long suspensionTimeout;
         private InspectServerSession inspect;
         private ConnectionWatcher connectionWatcher;
         private long contextId;
@@ -284,13 +356,14 @@ private static class InspectExecThread extends Thread implements MessageEndpoint
         final ProxyOutputStream err = new ProxyOutputStream(System.err);
         private final EnginesGCedTest.GCCheck gcCheck;
 
-        InspectExecThread(boolean suspend, final boolean inspectInternal, final boolean inspectInitialization, List<URI> sourcePath, Consumer<Context> prolog) {
+        InspectExecThread(boolean suspend, final boolean inspectInternal, final boolean inspectInitialization, List<URI> sourcePath, Consumer<Context> prolog, Long suspensionTimeout) {
             super("Inspector Executor");
             this.suspend = suspend;
             this.inspectInternal = inspectInternal;
             this.inspectInitialization = inspectInitialization;
             this.sourcePath = sourcePath;
             this.prolog = prolog;
+            this.suspensionTimeout = suspensionTimeout;
             this.gcCheck = new EnginesGCedTest.GCCheck();
         }
 
@@ -304,7 +377,7 @@ public void run() {
             }
             Instrument testInstrument = engine.getInstruments().get(InspectorTestInstrument.ID);
             InspectSessionInfoProvider sessionInfoProvider = testInstrument.lookup(InspectSessionInfoProvider.class);
-            InspectSessionInfo sessionInfo = sessionInfoProvider.getSessionInfo(suspend, inspectInternal, inspectInitialization, sourcePath);
+            InspectSessionInfo sessionInfo = sessionInfoProvider.getSessionInfo(suspend, inspectInternal, inspectInitialization, sourcePath, suspensionTimeout);
             inspect = sessionInfo.getInspectServerSession();
             try {
                 connectionWatcher = sessionInfo.getConnectionWatcher();

tools/src/com.oracle.truffle.tools.chromeinspector.test/src/com/oracle/truffle/tools/chromeinspector/test/RelativeSourceInspectDebugTest.java

@@ -119,7 +119,7 @@ public void testSourcePath() throws Exception {
             resolvedURI[2] = fs.getPath(folderInZip3, relativePath[2]).toUri();
         }
 
-        InspectorTester tester = InspectorTester.start(true, false, false, Arrays.asList(sourcePathURI));
+        InspectorTester tester = InspectorTester.start(new InspectorTester.Options(true, false, false).setSourcePath(Arrays.asList(sourcePathURI)));
         tester.sendMessage("{\"id\":1,\"method\":\"Runtime.enable\"}");
         assertEquals("{\"result\":{},\"id\":1}", tester.getMessages(true).trim());
         tester.sendMessage("{\"id\":2,\"method\":\"Debugger.enable\"}");
@@ -303,7 +303,7 @@ private static void testBreakpoints(int sectionLine, int sectionColumn, int bpLi
         ProxyLanguage.setDelegate(language);
         Source source = Source.create(ProxyLanguage.ID, sourceContent);
 
-        InspectorTester tester = InspectorTester.start(false, false, false, Collections.singletonList(sourcePathURI));
+        InspectorTester tester = InspectorTester.start(new InspectorTester.Options(false, false, false).setSourcePath(Collections.singletonList(sourcePathURI)));
         tester.sendMessage("{\"id\":1,\"method\":\"Runtime.enable\"}");
         assertEquals("{\"result\":{},\"id\":1}", tester.getMessages(true).trim());
         tester.sendMessage("{\"id\":2,\"method\":\"Debugger.enable\"}");
@@ -365,7 +365,7 @@ public void testEagerSourceLoad() throws Exception {
         Files.write(filePath, sourceContent.getBytes());
         String fileURI = filePath.toUri().toString();
 
-        InspectorTester tester = InspectorTester.start(true, false, false, Collections.singletonList(sourcePathURI), (context) -> {
+        InspectorTester tester = InspectorTester.start(new InspectorTester.Options(true, false, false).setSourcePath(Collections.singletonList(sourcePathURI)).setProlog((context) -> {
             TestDebugNoContentLanguage language = new TestDebugNoContentLanguage(relativePathProlog1, true, true);
             ProxyLanguage.setDelegate(language);
             Source sourceProlog = Source.create(ProxyLanguage.ID, sourceContent);
@@ -375,7 +375,7 @@ public void testEagerSourceLoad() throws Exception {
             ProxyLanguage.setDelegate(language);
             sourceProlog = Source.create(ProxyLanguage.ID, "relative source2\nVarB");
             context.eval(sourceProlog);
-        });
+        }));
 
         tester.sendMessage("{\"id\":1,\"method\":\"Runtime.enable\"}");
         assertEquals("{\"result\":{},\"id\":1}", tester.getMessages(true).trim());