delay evaluation of chunk exec queue if R is executing code

jmcphers · jmcphers · commit 8396834f5894 · 2016-05-18T21:27:30.000-07:00
diff --git a/src/cpp/session/modules/rmarkdown/SessionRMarkdown.cpp b/src/cpp/session/modules/rmarkdown/SessionRMarkdown.cpp
@@ -63,6 +63,12 @@ namespace session {
 
 namespace {
 
+enum 
+{
+   RExecutionReady = 0,
+   RExecutionBusy  = 1
+};
+
 std::string projectBuildDir()
 {
    return string_utils::utf8ToSystem(
@@ -1186,7 +1192,7 @@ Error getRmdTemplate(const json::JsonRpcRequest& request,
 
 
 Error prepareForRmdChunkExecution(const json::JsonRpcRequest& request,
-                                  json::JsonRpcResponse*)
+                                  json::JsonRpcResponse* pResponse)
 {
    // read id param
    std::string id;
@@ -1216,6 +1222,13 @@ Error prepareForRmdChunkExecution(const json::JsonRpcRequest& request,
       }
    }
 
+   // indicate to the client whether R currently has executing code on the
+   // stack
+   json::Object result;
+   result["state"] = r::getGlobalContext()->nextcontext == NULL ?
+      RExecutionReady : RExecutionBusy;
+   pResponse->setResult(result);
+
    return Success();
 }
 
diff --git a/src/gwt/src/org/rstudio/studio/client/rmarkdown/model/RMarkdownServerOperations.java b/src/gwt/src/org/rstudio/studio/client/rmarkdown/model/RMarkdownServerOperations.java
@@ -65,7 +65,7 @@ void getRmdTemplate(String templatePath,
    public String getFileUrl(FileSystemItem file);
    
    void prepareForRmdChunkExecution(String id,
-                                    ServerRequestCallback<Void> requestCallback);
+                ServerRequestCallback<RmdExecutionState> requestCallback);
 
    void getRmdOutputInfo(String target,
                 ServerRequestCallback<RmdOutputInfo> resultCallback);
diff --git a/src/gwt/src/org/rstudio/studio/client/rmarkdown/model/RmdExecutionState.java b/src/gwt/src/org/rstudio/studio/client/rmarkdown/model/RmdExecutionState.java
@@ -0,0 +1,31 @@
+/*
+ * RmdExecutionState.java
+ *
+ * Copyright (C) 2009-15 by RStudio, Inc.
+ *
+ * Unless you have received this program directly from RStudio pursuant
+ * to the terms of a commercial license agreement with RStudio, then
+ * this program is licensed to you under the terms of version 3 of the
+ * GNU Affero General Public License. This program is distributed WITHOUT
+ * ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,
+ * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the
+ * AGPL (http://www.gnu.org/licenses/agpl-3.0.txt) for more details.
+ *
+ */
+package org.rstudio.studio.client.rmarkdown.model;
+
+import com.google.gwt.core.client.JavaScriptObject;
+
+public class RmdExecutionState extends JavaScriptObject
+{
+   protected RmdExecutionState()
+   {
+   }
+   
+   public final native int getState() /*-{
+      return this.state;
+   }-*/;
+   
+   public static final int STATE_READY = 0;
+   public static final int STATE_BUSY  = 1;
+}
diff --git a/src/gwt/src/org/rstudio/studio/client/server/remote/RemoteServer.java b/src/gwt/src/org/rstudio/studio/client/server/remote/RemoteServer.java
@@ -98,6 +98,7 @@
 import org.rstudio.studio.client.rmarkdown.model.RMarkdownContext;
 import org.rstudio.studio.client.rmarkdown.model.RmdChunkOptions;
 import org.rstudio.studio.client.rmarkdown.model.RmdCreatedTemplate;
+import org.rstudio.studio.client.rmarkdown.model.RmdExecutionState;
 import org.rstudio.studio.client.rmarkdown.model.RmdOutputInfo;
 import org.rstudio.studio.client.rmarkdown.model.RmdTemplateContent;
 import org.rstudio.studio.client.rmarkdown.model.RmdYamlData;
@@ -4190,8 +4191,8 @@ public void getRmdTemplate(String templatePath,
    
    @Override
    public void prepareForRmdChunkExecution(
-                                String id,
-                                ServerRequestCallback<Void> requestCallback)
+         String id,
+         ServerRequestCallback<RmdExecutionState> requestCallback)
    {
       sendRequest(RPC_SCOPE, 
                   "prepare_for_rmd_chunk_execution", 
diff --git a/src/gwt/src/org/rstudio/studio/client/workbench/views/source/editors/text/TextEditingTargetRMarkdownHelper.java b/src/gwt/src/org/rstudio/studio/client/workbench/views/source/editors/text/TextEditingTargetRMarkdownHelper.java
@@ -54,6 +54,7 @@
 import org.rstudio.studio.client.rmarkdown.model.RMarkdownServerOperations;
 import org.rstudio.studio.client.rmarkdown.model.RmdChosenTemplate;
 import org.rstudio.studio.client.rmarkdown.model.RmdCreatedTemplate;
+import org.rstudio.studio.client.rmarkdown.model.RmdExecutionState;
 import org.rstudio.studio.client.rmarkdown.model.RmdFrontMatter;
 import org.rstudio.studio.client.rmarkdown.model.RmdFrontMatterOutputOptions;
 import org.rstudio.studio.client.rmarkdown.model.RmdOutputFormat;
@@ -68,7 +69,6 @@
 import org.rstudio.studio.client.server.ServerError;
 import org.rstudio.studio.client.server.ServerRequestCallback;
 import org.rstudio.studio.client.server.Void;
-import org.rstudio.studio.client.server.VoidServerRequestCallback;
 import org.rstudio.studio.client.workbench.WorkbenchContext;
 import org.rstudio.studio.client.workbench.model.Session;
 import org.rstudio.studio.client.workbench.prefs.model.UIPrefs;
@@ -330,13 +330,19 @@ public void prepareForRmdChunkExecution(String id,
       if (useRMarkdownV2(contents))
       {
          server_.prepareForRmdChunkExecution(id, 
-                                             new VoidServerRequestCallback() {
-            
+            new ServerRequestCallback<RmdExecutionState>() 
+         {
             @Override
-            protected void onCompleted()
+            public void onResponseReceived(RmdExecutionState state)
             {
                onExecuteChunk.execute();
             }
+
+            @Override
+            public void onError(ServerError error)
+            {
+               Debug.logError(error);
+            }
          });
       }
       else
diff --git a/src/gwt/src/org/rstudio/studio/client/workbench/views/source/editors/text/rmd/TextEditingTargetNotebook.java b/src/gwt/src/org/rstudio/studio/client/workbench/views/source/editors/text/rmd/TextEditingTargetNotebook.java
@@ -33,6 +33,7 @@
 import org.rstudio.studio.client.application.events.RestartStatusEvent;
 import org.rstudio.studio.client.common.FilePathUtils;
 import org.rstudio.studio.client.common.GlobalDisplay;
+import org.rstudio.studio.client.common.Value;
 import org.rstudio.studio.client.common.dependencies.DependencyManager;
 import org.rstudio.studio.client.common.dependencies.model.Dependency;
 import org.rstudio.studio.client.rmarkdown.RmdOutput;
@@ -45,6 +46,7 @@
 import org.rstudio.studio.client.rmarkdown.model.RmdChunkOptions;
 import org.rstudio.studio.client.rmarkdown.model.RmdChunkOutput;
 import org.rstudio.studio.client.rmarkdown.model.RmdChunkOutputUnit;
+import org.rstudio.studio.client.rmarkdown.model.RmdExecutionState;
 import org.rstudio.studio.client.server.ServerError;
 import org.rstudio.studio.client.server.ServerRequestCallback;
 import org.rstudio.studio.client.server.VoidServerRequestCallback;
@@ -54,6 +56,8 @@
 import org.rstudio.studio.client.workbench.prefs.model.UIPrefs;
 import org.rstudio.studio.client.workbench.views.console.ConsoleResources;
 import org.rstudio.studio.client.workbench.views.console.events.ConsoleHistoryAddedEvent;
+import org.rstudio.studio.client.workbench.views.console.events.ConsolePromptEvent;
+import org.rstudio.studio.client.workbench.views.console.events.ConsolePromptHandler;
 import org.rstudio.studio.client.workbench.views.console.events.ConsoleWriteInputEvent;
 import org.rstudio.studio.client.workbench.views.console.events.ConsoleWriteInputHandler;
 import org.rstudio.studio.client.workbench.views.console.model.ConsoleServerOperations;
@@ -520,12 +524,34 @@ public void execute()
          public void execute()
          {
             server_.prepareForRmdChunkExecution(docUpdateSentinel_.getId(), 
-               new ServerRequestCallback<Void>()
+               new ServerRequestCallback<RmdExecutionState>()
                {
                   @Override
-                  public void onResponseReceived(Void v)
+                  public void onResponseReceived(RmdExecutionState state)
                   {
-                     completeEval.execute();
+                     if (state.getState() == RmdExecutionState.STATE_BUSY)
+                     {
+                        // if R has code on the stack, wait for the next console
+                        // prompt
+                        final Value<HandlerRegistration> handler = 
+                              new Value<HandlerRegistration>(null);
+                        handler.setValue(events_.addHandler(
+                              ConsolePromptEvent.TYPE,
+                              new ConsolePromptHandler()
+                              {
+                                 @Override
+                                 public void onConsolePrompt(
+                                       ConsolePromptEvent event)
+                                 {
+                                    handler.getValue().removeHandler();
+                                    completeEval.execute();
+                                 }
+                              }));
+                     }
+                     else
+                     {
+                        completeEval.execute();
+                     }
                   }
 
                   @Override

Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,12 @@ namespace session {`
`63`	`63`
`64`	`64`	`namespace {`
`65`	`65`
	`66`	`+enum`
	`67`	`+{`
	`68`	`+ RExecutionReady = 0,`
	`69`	`+ RExecutionBusy = 1`
	`70`	`+};`
	`71`	`+`
`66`	`72`	`std::string projectBuildDir()`
`67`	`73`	`{`
`68`	`74`	`return string_utils::utf8ToSystem(`
`@@ -1186,7 +1192,7 @@ Error getRmdTemplate(const json::JsonRpcRequest& request,`
`1186`	`1192`
`1187`	`1193`
`1188`	`1194`	`Error prepareForRmdChunkExecution(const json::JsonRpcRequest& request,`
`1189`		`- json::JsonRpcResponse*)`
	`1195`	`+ json::JsonRpcResponse* pResponse)`
`1190`	`1196`	`{`
`1191`	`1197`	`// read id param`
`1192`	`1198`	`std::string id;`
`@@ -1216,6 +1222,13 @@ Error prepareForRmdChunkExecution(const json::JsonRpcRequest& request,`
`1216`	`1222`	`}`
`1217`	`1223`	`}`
`1218`	`1224`
	`1225`	`+ // indicate to the client whether R currently has executing code on the`
	`1226`	`+ // stack`
	`1227`	`+ json::Object result;`
	`1228`	`+ result["state"] = r::getGlobalContext()->nextcontext == NULL ?`
	`1229`	`+ RExecutionReady : RExecutionBusy;`
	`1230`	`+ pResponse->setResult(result);`
	`1231`	`+`
`1219`	`1232`	`return Success();`
`1220`	`1233`	`}`
`1221`	`1234`