open report.html and log.html with internal documentation server

d-biehl · d-biehl · commit e86d9bc3d80e · 2022-09-29T14:20:31.000+02:00
diff --git a/robotcode/language_server/robotframework/parts/code_action.py b/robotcode/language_server/robotframework/parts/code_action.py
@@ -6,19 +6,23 @@
 import traceback
 import urllib.parse
 from concurrent.futures import ProcessPoolExecutor
+from dataclasses import dataclass
 from http.server import SimpleHTTPRequestHandler, ThreadingHTTPServer
 from threading import Thread
 from typing import TYPE_CHECKING, Any, List, Optional, Tuple, Union, cast
 from urllib.parse import parse_qs, urlparse
 
+from ....jsonrpc2.protocol import rpc_method
 from ....utils.logging import LoggingDescriptor
 from ....utils.net import find_free_port
+from ....utils.uri import Uri
 from ...common.decorators import code_action_kinds, language_id
 from ...common.lsp_types import (
     CodeAction,
     CodeActionContext,
     CodeActionKinds,
     Command,
+    Model,
     Range,
 )
 from ...common.text_document import TextDocument
@@ -39,6 +43,12 @@
 
 from .protocol_part import RobotLanguageServerProtocolPart
 
+
+@dataclass(repr=False)
+class ConvertUriParams(Model):
+    uri: str
+
+
 HTML_ERROR_TEMPLATE = Template(
     """\n
 <!doctype html>
@@ -337,3 +347,17 @@ async def build_url(
         url = f"{base_url}" f"/?&{params}" f"{f'#{target}' if target else ''}"
 
         return url
+
+    @rpc_method(name="robot/documentationServer/convertUri", param_type=ConvertUriParams)
+    @_logger.call
+    async def _convert_uri(self, uri: str, *args: Any, **kwargs: Any) -> Optional[str]:
+        real_uri = Uri(uri)
+
+        folder = self.parent.workspace.get_workspace_folder(real_uri)
+
+        if folder:
+            path = real_uri.to_path().relative_to(folder.uri.to_path())
+
+            return f"http://localhost:{self._documentation_server_port}/{path}"
+
+        return None
diff --git a/vscode-client/debugmanager.ts b/vscode-client/debugmanager.ts
@@ -8,29 +8,6 @@ import { CONFIG_SECTION } from "./config";
 import { LanguageClientsManager, toVsCodeRange } from "./languageclientsmanger";
 import { WeakValueSet } from "./utils";
 
-async function openPreviewOrExternal(uri: vscode.Uri) {
-  let livePreviewResult = false;
-  try {
-    const ex = vscode.extensions.getExtension("ms-vscode.live-server");
-    if (ex) {
-      await ex.activate();
-      if ((await vscode.commands.getCommands()).includes("livePreview.start.preview.atFile")) {
-        await vscode.commands.executeCommand("livePreview.start.preview.atFile", uri);
-        livePreviewResult = true;
-      }
-    }
-  } catch {
-    livePreviewResult = false;
-  }
-
-  if (!livePreviewResult) {
-    vscode.env.openExternal(uri).then(
-      () => undefined,
-      () => undefined
-    );
-  }
-}
-
 const DEBUG_ADAPTER_DEFAULT_TCP_PORT = 6611;
 const DEBUG_ADAPTER_DEFAULT_HOST = "127.0.0.1";
 
@@ -285,12 +262,7 @@ export class DebugManager {
               break;
             }
             case "robotExited": {
-              await DebugManager.OnRobotExited(
-                event.session,
-                event.body.outputFile,
-                event.body.logFile,
-                event.body.reportFile
-              );
+              await this.OnRobotExited(event.session, event.body.outputFile, event.body.logFile, event.body.reportFile);
               break;
             }
           }
@@ -446,16 +418,16 @@ export class DebugManager {
     }
   }
 
-  private static async OnRobotExited(
+  private async OnRobotExited(
     session: vscode.DebugSession,
     _outputFile?: string,
     logFile?: string,
     reportFile?: string
   ): Promise<void> {
     if (session.configuration?.openOutputAfterRun === "report" && reportFile) {
-      await openPreviewOrExternal(vscode.Uri.file(reportFile));
+      await this.languageClientsManager.openUriInDocumentationView(vscode.Uri.file(reportFile));
     } else if (session.configuration?.openOutputAfterRun === "log" && logFile) {
-      await openPreviewOrExternal(vscode.Uri.file(logFile));
+      await this.languageClientsManager.openUriInDocumentationView(vscode.Uri.file(logFile));
     }
   }
 }
diff --git a/vscode-client/extension.ts b/vscode-client/extension.ts
@@ -60,26 +60,7 @@ export async function activateAsync(context: vscode.ExtensionContext): Promise<v
         return [];
       },
       async handleTerminalLink(link: TerminalLink) {
-        let livePreviewResult = false;
-        try {
-          const ex = vscode.extensions.getExtension("ms-vscode.live-server");
-          if (ex) {
-            await ex.activate();
-            if ((await vscode.commands.getCommands()).includes("livePreview.start.preview.atFile")) {
-              await vscode.commands.executeCommand("livePreview.start.preview.atFile", vscode.Uri.file(link.path));
-              livePreviewResult = true;
-            }
-          }
-        } catch {
-          livePreviewResult = false;
-        }
-
-        if (!livePreviewResult) {
-          vscode.env.openExternal(vscode.Uri.file(link.path)).then(
-            () => undefined,
-            () => undefined
-          );
-        }
+        await languageClientManger.openUriInDocumentationView(vscode.Uri.file(link.path));
       },
     })
   );
diff --git a/vscode-client/languageclientsmanger.ts b/vscode-client/languageclientsmanger.ts
@@ -618,6 +618,45 @@ export class LanguageClientsManager {
     );
   }
 
+  public async openUriInDocumentationView(uri: vscode.Uri): Promise<void> {
+    const doc_uri = await this.convertToDocumententationUri(uri);
+    if (doc_uri) {
+      await vscode.commands.executeCommand("robotcode.showDocumentation", doc_uri.toString(true));
+    } else {
+      vscode.env.openExternal(uri).then(
+        () => undefined,
+        () => undefined
+      );
+    }
+  }
+
+  public async convertToDocumententationUri(
+    uri: vscode.Uri,
+    token?: vscode.CancellationToken
+  ): Promise<vscode.Uri | undefined> {
+    const client = await this.getLanguageClientForResource(uri);
+
+    if (!client) return;
+
+    return (
+      (token
+        ? vscode.Uri.parse(
+            await client.sendRequest<string>(
+              "robot/documentationServer/convertUri",
+              {
+                uri: uri.toString(),
+              },
+              token
+            )
+          )
+        : vscode.Uri.parse(
+            await client.sendRequest<string>("robot/documentationServer/convertUri", {
+              uri: uri.toString(),
+            })
+          )) ?? undefined
+    );
+  }
+
   public async getEvaluatableExpression(
     document: vscode.TextDocument,
     position: Position,
