Merge pull request #13 from JetBrains/local-run

Add local run capability + Self-Hosted support + UX and UI improvements
JetBrains · Jun 17, 2024 · f478614 · f478614
2 parents cf0ac32 + 1453c85
commit f478614
Show file tree

Hide file tree

Showing 62 changed files with 3,945 additions and 814 deletions.
diff --git a/src/main/kotlin/org/jetbrains/qodana/SarifLanguageServer.kt b/src/main/kotlin/org/jetbrains/qodana/SarifLanguageServer.kt
@@ -1,19 +1,23 @@
 package org.jetbrains.qodana
 
-import org.apache.logging.log4j.LogManager
-import org.eclipse.lsp4j.*
-import org.eclipse.lsp4j.services.LanguageClient
-import org.eclipse.lsp4j.services.LanguageClientAware
-import java.util.concurrent.CompletableFuture
-import kotlin.system.exitProcess
-import kotlinx.coroutines.*
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.FlowPreview
 import kotlinx.coroutines.channels.Channel
 import kotlinx.coroutines.channels.Channel.Factory.UNLIMITED
 import kotlinx.coroutines.flow.consumeAsFlow
 import kotlinx.coroutines.flow.debounce
 import kotlinx.coroutines.flow.merge
+import kotlinx.coroutines.launch
+import org.apache.logging.log4j.LogManager
+import org.eclipse.lsp4j.*
+import org.eclipse.lsp4j.services.LanguageClient
+import org.eclipse.lsp4j.services.LanguageClientAware
 import org.jetbrains.annotations.VisibleForTesting
 import java.nio.file.Path
+import java.util.concurrent.CompletableFuture
+import java.util.concurrent.ConcurrentHashMap
+import kotlin.system.exitProcess
 
 @OptIn(FlowPreview::class)
 class SarifLanguageServer: ExtendedLanguageServer, LanguageClientAware {
@@ -22,7 +26,10 @@ class SarifLanguageServer: ExtendedLanguageServer, LanguageClientAware {
     }
 
     private val workspaceService = SarifWorkspaceService()
-    private var clientCapabilities: ClientCapabilities? = null
+    private val serverCapabilities = ServerCapabilities().apply {
+        setTextDocumentSync(TextDocumentSyncKind.Incremental)
+        diagnosticProvider = DiagnosticRegistrationOptions()
+    }
     private val scope = CoroutineScope(Dispatchers.IO)
     private val requestChannel = Channel<IRequest>(UNLIMITED)
     private val debouncedChannel = Channel<IRequest>(UNLIMITED)
@@ -32,7 +39,6 @@ class SarifLanguageServer: ExtendedLanguageServer, LanguageClientAware {
         System.getProperty("os.name").lowercase().contains("win"),
         scope)
     private val textDocumentService = SarifTextDocumentService(state)
-    private var exitCode = -1
     init {
         scope.launch {
             merge(requestChannel.consumeAsFlow(), debouncedChannel.consumeAsFlow().debounce(DebounceInterval)).collect {
@@ -73,16 +79,24 @@ class SarifLanguageServer: ExtendedLanguageServer, LanguageClientAware {
         return future
     }
 
-    override fun initialize(params: InitializeParams?): CompletableFuture<InitializeResult> {
-        logger.info("server/initialize")
-        return CompletableFuture.supplyAsync {
-            val capabilities = ServerCapabilities().apply {
-                setTextDocumentSync(TextDocumentSyncKind.Incremental)
-                diagnosticProvider = DiagnosticRegistrationOptions()
+    override fun closeReport(): CompletableFuture<Unit> {
+        logger.info("server/closeReport")
+        val future = CompletableFuture<Unit>()
+
+        scope.launch {
+            try {
+                requestChannel.send(CloseReport())
+                future.complete(Unit)
+            } catch (ex: Exception) {
+                future.completeExceptionally(ex)
             }
-            clientCapabilities = params?.capabilities
-            InitializeResult(capabilities)
         }
+        return future
+    }
+
+    override fun initialize(params: InitializeParams?): CompletableFuture<InitializeResult> {
+        logger.info("server/initialize")
+        return CompletableFuture.completedFuture(InitializeResult(serverCapabilities))
     }
 
     override fun setTrace(params: SetTraceParams?) {
@@ -91,18 +105,19 @@ class SarifLanguageServer: ExtendedLanguageServer, LanguageClientAware {
 
     override fun shutdown(): CompletableFuture<Any> {
         logger.info("server/shutdown")
-        return CompletableFuture.supplyAsync {
-
-        }
+        requestChannel.close()
+        debouncedChannel.close()
+        return CompletableFuture.completedFuture(null)
     }
 
     override fun exit() {
         logger.info("server/exit")
-        exitProcess(exitCode)
+        exitProcess(0)
     }
 
     override fun connect(client: LanguageClient?) {
         logger.info("server/connect")
+//        logger.info("$client")
         state.languageClient = client
     }
 
@@ -121,7 +136,7 @@ class SarifLanguageServer: ExtendedLanguageServer, LanguageClientAware {
                            var sarifRevision: Lazy<String?>? = null,
                            var repoFolder: Path? = null,
                            var gitLocator: Lazy<GitLocator?>? = null,
-                           val openFileCache: MutableMap<String, String> = mutableMapOf(),
+                           val openFileCache: MutableMap<String, String> = ConcurrentHashMap(),
                            var repositoryFileCache: MutableMap<String, String>? = null
     )
 }
diff --git a/src/main/kotlin/org/jetbrains/qodana/SarifTextDocumentService.kt b/src/main/kotlin/org/jetbrains/qodana/SarifTextDocumentService.kt
@@ -4,6 +4,7 @@ import kotlinx.coroutines.*
 import org.apache.logging.log4j.LogManager
 import org.eclipse.lsp4j.*
 import org.eclipse.lsp4j.services.TextDocumentService
+import java.net.URI
 import java.net.URL
 import java.nio.file.Paths
 import java.util.concurrent.CompletableFuture
@@ -16,6 +17,7 @@ class SarifTextDocumentService(private val state: SarifLanguageServer.ServerStat
     override fun didOpen(params: DidOpenTextDocumentParams) {
         logger.trace("text/didOpen {fileUri: '${params.textDocument?.uri}'}")
         val url = params.textDocument?.uri ?: return
+        if (!isFileScheme(url)) return
         state.scope.launch {
             state.requestChannel.send(OpenFile(url, params.textDocument?.text ?: Paths.get(URL(url).toURI()).toFile().readText()))
             state.debounceChannel.send(RemapDiagnostics(url))
@@ -29,6 +31,7 @@ class SarifTextDocumentService(private val state: SarifLanguageServer.ServerStat
     override fun didChange(params: DidChangeTextDocumentParams) {
         logger.trace("text/didChange {fileUri: '${params.textDocument?.uri}'}")
         val url = params.textDocument?.uri ?: return
+        if (!isFileScheme(url)) return
         state.scope.launch {
             state.requestChannel.send(UpdateFile(url, params.contentChanges))
             state.debounceChannel.send(RemapDiagnostics(url))
@@ -38,6 +41,7 @@ class SarifTextDocumentService(private val state: SarifLanguageServer.ServerStat
     override fun didClose(params: DidCloseTextDocumentParams) {
         logger.trace("text/didClose {fileUri: '${params.textDocument?.uri}'}")
         val url = params.textDocument?.uri ?: return
+        if (!isFileScheme(url)) return
         state.scope.launch {
             state.requestChannel.send(CloseFile(url))
         }
@@ -46,9 +50,15 @@ class SarifTextDocumentService(private val state: SarifLanguageServer.ServerStat
     override fun didSave(params: DidSaveTextDocumentParams) {
         logger.trace("text/didSave {fileUri: '${params.textDocument?.uri}'}")
         val url = params.textDocument?.uri ?: return
+        if (!isFileScheme(url)) return
         state.scope.launch {
             state.requestChannel.send(OpenFile(url, Paths.get(URL(url).toURI()).toFile().readText()))
             state.debounceChannel.send(RemapDiagnostics(url))
         }
     }
+
+    private fun isFileScheme(uriString: String): Boolean {
+        val uri = URI(uriString)
+        return uri.scheme == "file"
+    }
 }
diff --git a/src/main/kotlin/org/jetbrains/qodana/extensions.kt b/src/main/kotlin/org/jetbrains/qodana/extensions.kt
@@ -14,6 +14,9 @@ interface ExtendedLanguageServer : LanguageServer {
 
     @JsonRequest
     fun setSarifFile(params: SetSarifFileParams) : CompletableFuture<Unit>
+
+    @JsonRequest
+    fun closeReport() : CompletableFuture<Unit>
 }
 
 data class SetSourceLocationParams(val path: String)

diff --git a/src/main/kotlin/org/jetbrains/qodana/requests.kt b/src/main/kotlin/org/jetbrains/qodana/requests.kt
@@ -17,6 +17,7 @@ import java.io.FileReader
 import java.net.URL
 import java.nio.file.Path
 import java.nio.file.Paths
+import java.util.concurrent.ConcurrentHashMap
 import kotlin.io.path.exists
 import kotlin.text.StringBuilder
 
@@ -49,8 +50,8 @@ class SarifFile(private val path: String, private val showBaselineIssues: Boolea
         state.sarifLocation = path
         val diags = computeDiagnosticsAsIs(showBaselineIssues)
         val oldFiles = state.diagnostic?.keys ?: emptyList()
-        state.diagnostic = diags.toMap(mutableMapOf())
-        state.repositoryFileCache = mutableMapOf()
+        state.diagnostic = diags.toMap(ConcurrentHashMap())
+        state.repositoryFileCache = ConcurrentHashMap()
         state.sarifRevision = lazy { getRevisionId(path) }
         state.gitLocator?.value?.close()
         state.gitLocator = lazy {
@@ -267,6 +268,16 @@ class CloseFile(private val uri: String): IRequest {
     }
 }
 
+class CloseReport : IRequest {
+    override suspend fun execute(state: SarifLanguageServer.ServerState) {
+        val oldFiles = state.diagnostic?.keys ?: emptyList()
+        state.diagnostic = null
+        for (file in oldFiles) {
+            state.requestChannel.send(AnnounceDiagnostics(file, emptyList()))
+        }
+    }
+}
+
 
 fun getProblems(sarifPath: String): Sequence<Result> = sequence {
     FileReader(sarifPath).use { fileReader ->

diff --git a/vscode/qodana/.vscode/launch.json b/vscode/qodana/.vscode/launch.json
@@ -13,7 +13,8 @@
 				"--extensionDevelopmentPath=${workspaceFolder}"
 			],
 			"env": {
-				"QODANA_DEBUG": "true"
+				"QODANA_DEBUG": "true",
+				"EXTENSION_DEBUG": "false"
 			},
 			"outFiles": [
 				"${workspaceFolder}/out/**/*.js"

diff --git a/vscode/qodana/media/link.js b/vscode/qodana/media/link.js
@@ -0,0 +1,15 @@
+//@ts-check
+
+// This script will be run within the webview itself
+// It cannot access the main VS Code APIs directly.
+(function () {
+    const vscode = acquireVsCodeApi();
+
+    document.querySelector('.unlink-button').addEventListener('click', () => {
+        vscode.postMessage({ type: 'unlink' });
+    });
+
+    document.querySelector('.open-report-button').addEventListener('click', () => {
+        vscode.postMessage({ type: 'openReport' });
+    });
+}());
diff --git a/vscode/qodana/media/login.js b/vscode/qodana/media/login.js
@@ -0,0 +1,35 @@
+//@ts-check
+
+// This script will be run within the webview itself
+// It cannot access the main VS Code APIs directly.
+(function () {
+    const vscode = acquireVsCodeApi();
+
+    document.querySelector('.login-button').addEventListener('click', () => {
+        vscode.postMessage({ type: myConstants.COMMAND_LOG_IN });
+    });
+
+    document.querySelector('.self-hosted-button').addEventListener('click', () => {
+        vscode.postMessage({ type: myConstants.COMMAND_LOG_IN_CUSTOM_SERVER });
+    });
+
+    // noinspection DuplicatedCode
+    document.querySelector('.close-report-button').addEventListener('click', () => {
+        vscode.postMessage({ type: myConstants.COMMAND_CLOSE_REPORT });
+    });
+
+    window.addEventListener('message', event => {
+        const message = event.data; // Here 'data' contains information sent from extension.
+        switch (message.type) {
+            case 'hide':
+                let element = document.querySelector(message.data);
+                if (element && message.visible === false) {
+                    element.classList.add('hide-element');
+                } else if (element) {
+                    element.classList.remove('hide-element');
+                }
+                break;
+        }
+    });
+
+}());
diff --git a/vscode/qodana/media/main.css b/vscode/qodana/media/main.css
@@ -0,0 +1,7 @@
+body {
+    background-color: transparent;
+}
+
+.hide-element {
+    display: none;
+}
diff --git a/vscode/qodana/media/qodana-bw.svg b/vscode/qodana/media/qodana-bw.svg
diff --git a/vscode/qodana/media/reset.css b/vscode/qodana/media/reset.css
@@ -0,0 +1,30 @@
+html {
+    box-sizing: border-box;
+    font-size: 13px;
+}
+
+*,
+*:before,
+*:after {
+    box-sizing: inherit;
+}
+
+body,
+h1,
+h2,
+h3,
+h4,
+h5,
+h6,
+p,
+ol,
+ul {
+    margin: 0;
+    padding: 0;
+    font-weight: normal;
+}
+
+img {
+    max-width: 100%;
+    height: auto;
+}
diff --git a/vscode/qodana/media/runLocally.js b/vscode/qodana/media/runLocally.js
@@ -0,0 +1,15 @@
+//@ts-check
+
+// This script will be run within the webview itself
+// It cannot access the main VS Code APIs directly.
+(function () {
+    const vscode = acquireVsCodeApi();
+
+    document.querySelector('.run-locally-button').addEventListener('click', () => {
+        vscode.postMessage({ type: myConstants.COMMAND_RUN_LOCALLY });
+    });
+
+    document.querySelector('.view-history-button').addEventListener('click', () => {
+        vscode.postMessage({ type: myConstants.COMMAND_OPEN_LOCAL_REPORT });
+    });
+}());
diff --git a/vscode/qodana/media/settings.js b/vscode/qodana/media/settings.js
@@ -0,0 +1,30 @@
+//@ts-check
+
+// This script will be run within the webview itself
+// It cannot access the main VS Code APIs directly.
+(function () {
+    const vscode = acquireVsCodeApi();
+
+    document.querySelector('.logout-button').addEventListener('click', () => {
+        vscode.postMessage({ type: myConstants.COMMAND_LOG_OUT });
+    });
+
+    // noinspection DuplicatedCode
+    document.querySelector('.close-report-button').addEventListener('click', () => {
+        vscode.postMessage({ type: myConstants.COMMAND_CLOSE_REPORT });
+    });
+
+    window.addEventListener('message', event => {
+        const message = event.data; // Here 'data' contains information sent from extension.
+        switch (message.type) {
+            case 'hide':
+                let element = document.querySelector(message.data);
+                if (element && message.visible === false) {
+                    element.classList.add('hide-element');
+                } else if (element) {
+                    element.classList.remove('hide-element');
+                }
+                break;
+        }
+    });
+}());