ansi escapes in custom source markers (#12435)

* make .rs.scalar() after extrating `html`ness * AceAnnotation.html() * rework LintItem.asAceAnnotations() so that they either have html or text * LintItem may have html or text, not raw * handle AceAnnotation.html * don't treat `class = "html"` in custom source markers
rstudio · Jan 6, 2023 · c78e9d4 · c78e9d4 · netique · Jan 19, 2023
1 parent 23c27fe
commit c78e9d4
Show file tree

Hide file tree

Showing 9 changed files with 57 additions and 32 deletions.
diff --git a/src/cpp/r/R/Api.R b/src/cpp/r/R/Api.R
@@ -222,10 +222,6 @@
 
       # normalize paths
       markers$file <- .rs.normalizePath(markers$file, mustWork = TRUE)
-
-      # check for html
-      markers$messageHTML <- inherits(markers$message, "html")
-
    } else if (is.list(markers)) {
       markers <- lapply(markers, function(marker) {
          markerTypes <- c("error", "warning", "box", "info", "style", "usage")
@@ -245,8 +241,7 @@
          marker$line <- .rs.scalar(as.numeric(marker$line))
          marker$column <- .rs.scalar(as.numeric(marker$column))
          marker$message <- .rs.scalar(marker$message)
-         marker$messageHTML <- .rs.scalar(inherits(marker$message, "html"))
-
+
          marker
       })
    } else {

diff --git a/src/cpp/session/modules/SessionDiagnostics.R b/src/cpp/session/modules/SessionDiagnostics.R
@@ -96,8 +96,7 @@
          file = file,
          line = x$start.row,
          column = x$start.column,
-         message = x$message,
-         messageHTML = FALSE
+         message = x$message
       )
    })
 })

diff --git a/src/cpp/session/modules/SessionMarkers.cpp b/src/cpp/session/modules/SessionMarkers.cpp
@@ -391,15 +391,13 @@ SEXP rs_sourceMarkers(SEXP nameSEXP,
             std::string path;
             double line, column;
             std::string message;
-            bool messageHTML;
             Error error = json::readObject(
                markerJson.getObject(),
                "type", type,
                "file", path,
                "line", line,
                "column", column,
-               "message", message,
-               "messageHTML", messageHTML);
+               "message", message);
             if (error)
             {
                LOG_ERROR(error);
@@ -411,7 +409,7 @@ SEXP rs_sourceMarkers(SEXP nameSEXP,
                 FilePath(path),
                 safe_convert::numberTo<double, int>(line, 1),
                 safe_convert::numberTo<double, int>(column, 1),
-                core::html_utils::HTML(message, messageHTML),
+                core::html_utils::HTML(message, false),
                 true,
                 true);
 

diff --git a/...src/org/rstudio/studio/client/workbench/views/output/lint/DiagnosticsBackgroundPopup.java b/...src/org/rstudio/studio/client/workbench/views/output/lint/DiagnosticsBackgroundPopup.java
@@ -42,7 +42,7 @@
 import com.google.gwt.user.client.Event;
 import com.google.gwt.user.client.Event.NativePreviewEvent;
 import com.google.gwt.user.client.Event.NativePreviewHandler;
-import com.google.gwt.user.client.ui.Label;
+import com.google.gwt.user.client.ui.HTML;
 import com.google.gwt.user.client.ui.PopupPanel;
 import com.google.gwt.user.client.ui.PopupPanel.PositionCallback;
 
@@ -202,7 +202,11 @@ private void displayMarkerDiagnostics(Marker marker)
              marker.getRange().getEnd().getRow() >= row)
          {
             activeMarker_ = marker;
-            showPopup(annotation.text(), marker.getRange());
+            String text = annotation.html();
+            if (StringUtil.isNullOrEmpty(text))
+               text = annotation.text();
+            showPopup(text, marker.getRange());
+
             return;
          }
       }
@@ -226,7 +230,7 @@ public void onCursorChanged(CursorChangedEvent event)
             }
          });
          addStyleName(RES.styles().popup());
-         setWidget(new Label(text));
+         setWidget(new HTML(text));
       }
 
       private final Range range_;

diff --git a/src/gwt/src/org/rstudio/studio/client/workbench/views/output/lint/LintMarkers.java b/src/gwt/src/org/rstudio/studio/client/workbench/views/output/lint/LintMarkers.java
@@ -40,6 +40,7 @@ public AceAnnotation asAceAnnotation()
          return AceAnnotation.create(
                anchor_.getRow(),
                anchor_.getColumn(),
+               annotation_.html(),
                annotation_.text(),
                annotation_.type());
       }

diff --git a/src/gwt/src/org/rstudio/studio/client/workbench/views/output/lint/model/AceAnnotation.java b/src/gwt/src/org/rstudio/studio/client/workbench/views/output/lint/model/AceAnnotation.java
@@ -22,18 +22,26 @@ protected AceAnnotation() {}
 
    public static native AceAnnotation create(int row,
                                              int column,
+                                             String html,
                                              String text,
                                              String type) /*-{
-      return {
+
+      var aceAnnotation = {
          row: row,
          column: column,
-         text: text,
          type: type
-      }
+      };
+      if (html) 
+         aceAnnotation.html = html;
+      else
+         aceAnnotation.text = text;
+
+      return aceAnnotation;
    }-*/;
 
    public final native int row() /*-{ return this.row; }-*/;
    public final native int column() /*-{ return this.column; }-*/;
    public final native String text() /*-{ return this.text; }-*/;
+   public final native String html() /*-{ return this.html; }-*/;
    public final native String type() /*-{ return this.type; }-*/;
 }
diff --git a/src/gwt/src/org/rstudio/studio/client/workbench/views/output/lint/model/LintItem.java b/src/gwt/src/org/rstudio/studio/client/workbench/views/output/lint/model/LintItem.java
@@ -36,7 +36,6 @@ public static final native LintItem create(int startRow,
          "end.row": endRow,
          "end.column": endColumn,
          "text": text,
-         "raw": text,
          "type": type
       };
                                 
@@ -74,6 +73,14 @@ public final native void setText(String text) /*-{
       this["text"] = text;
    }-*/;
 
+   public final native String getHtml() /*-{
+      return this["html"];
+   }-*/;
+
+   public final native void setHtml(String html) /*-{
+      this["html"] = html;
+   }-*/;
+
    public final native String getType() /*-{
       return this["type"];
    }-*/;
@@ -90,6 +97,7 @@ public final AceAnnotation asAceAnnotation()
       return AceAnnotation.create(
             getStartRow(),
             getStartColumn(),
+            getHtml(),
             getText(),
             getType());
    }
@@ -102,17 +110,23 @@ public static final native JsArray<AceAnnotation> asAceAnnotations(
       
       for (var key in items)
       {
-         var type = items[key]["type"];
+         var item = items[key];
+         var type = item["type"];
          if (type === "style" || type === "note")
             type = "info";
 
-         aceAnnotations.push({
-            row: items[key]["start.row"],
-            column: items[key]["start.column"],
-            html: items[key]["text"],
-            text: items[key]["raw"],
+         var annotation = {
+            row: item["start.row"],
+            column: item["start.column"],
             type: type
-         });
+         };
+         var html = item["html"]
+         if (html)
+            annotation.html = html;
+         else 
+            annotation.text = item["text"];
+         
+         aceAnnotations.push(annotation);
       }
       
       return aceAnnotations;

diff --git a/...wt/src/org/rstudio/studio/client/workbench/views/source/editors/text/AceEditorWidget.java b/...wt/src/org/rstudio/studio/client/workbench/views/source/editors/text/AceEditorWidget.java
@@ -1038,6 +1038,7 @@ public AceAnnotation asAceAnnotation()
          return AceAnnotation.create(
                anchor_.getRow(),
                anchor_.getColumn(),
+               annotation_.html(),
                annotation_.text(),
                annotation_.type());
       }

diff --git a/...studio/studio/client/workbench/views/source/editors/text/TextEditingTargetLintSource.java b/...studio/studio/client/workbench/views/source/editors/text/TextEditingTargetLintSource.java
@@ -18,6 +18,8 @@
 import com.google.gwt.dom.client.DivElement;
 import com.google.gwt.dom.client.Document;
 import com.google.gwt.user.client.Command;
+
+import org.rstudio.core.client.StringUtil;
 import org.rstudio.core.client.VirtualConsole;
 import org.rstudio.studio.client.RStudioGinjector;
 import org.rstudio.studio.client.common.filetypes.TextFileType;
@@ -98,14 +100,17 @@ public void showLint(JsArray<LintItem> lint)
       {
          for (int i = 0; i < lint.length(); i++) {
             LintItem lintItem = lint.get(i);
-            DivElement element = Document.get().createDivElement();
-            VirtualConsole vc = RStudioGinjector.INSTANCE.getVirtualConsoleFactory().create(element);
 
-            vc.setPreserveHTML(true);
-            vc.submit(lintItem.getText());
-            String renderedText = element.getInnerHTML();
+            if (StringUtil.isNullOrEmpty(lintItem.getHtml()))
+            {
+               DivElement element = Document.get().createDivElement();
+               VirtualConsole vc = RStudioGinjector.INSTANCE.getVirtualConsoleFactory().create(element);
 
-            lintItem.setText(renderedText);
+               vc.setPreserveHTML(true);
+               vc.submit(lintItem.getText());
+               String renderedText = element.getInnerHTML();
+               lintItem.setHtml(renderedText);
+            }
          }
 
          target_.getDocDisplay().showLint(lint);