feat: Show diagnostic only for opened documents (#1965)

Author: Nurkambay

clients/cobol-lsp-vscode-extension/src/extension.ts

@@ -58,6 +58,10 @@ function initialize() {
   return { copyBooksDownloader, configurationWatcher };
 }
 
+export function getChannel(): vscode.OutputChannel {
+  return outputChannel;
+}
+
 export async function activate(
   context: vscode.ExtensionContext,
 ): Promise<__ExtensionApi & __AnalysisApi> {

clients/cobol-lsp-vscode-extension/src/services/ProcessorGroups.ts

@@ -18,7 +18,12 @@ import { Minimatch } from "minimatch";
 import { SettingsUtils } from "./util/SettingsUtils";
 import { globSync } from "glob";
 import { Uri } from "vscode";
-import { backwardSlashRegex, cleanWorkspaceFolder } from "./util/FSUtils";
+import {
+  backwardSlashRegex,
+  cleanWorkspaceFolder,
+  normalizePath,
+} from "./util/FSUtils";
+import { getChannel } from "../extension";
 
 const PROCESSOR_GROUP_FOLDER = ".cobolplugin";
 const PROCESSOR_GROUP_PGM = "pgm_conf.json";
@@ -28,25 +33,32 @@ export function loadProcessorGroupCopybookPaths(
   documentUri: string,
   dialectType: string,
 ): string[] {
-  return loadProcessorGroupSettings(
+  const result = loadProcessorGroupSettings(
     documentUri,
     "libs",
     [] as string[],
     dialectType,
   );
+  return result.map((s) => normalizePath(s));
 }
 
 export function loadProcessorGroupCopybookPathsConfig(
   item: { scopeUri: string },
   configObject: string[],
 ): string[] {
   const config = [
-    ...loadProcessorGroupSettings(item.scopeUri, "libs", [] as string[]),
+    ...loadProcessorGroupSettings(item.scopeUri, "libs", [] as string[]).map(
+      (s) => normalizePath(s),
+    ),
     ...configObject,
   ];
   return SettingsUtils.getWorkspaceFoldersPath(true)
-    .map((folder) => globSync(config.map(ele => ele.replace(backwardSlashRegex, "/")),
-     { cwd: cleanWorkspaceFolder(folder) }))
+    .map((folder) =>
+      globSync(
+        config.map((ele) => ele.replace(backwardSlashRegex, "/")),
+        { cwd: cleanWorkspaceFolder(folder) },
+      ),
+    )
     .reduce((acc, curVal) => {
       return acc.concat(curVal);
     }, []);

clients/cobol-lsp-vscode-extension/src/services/util/FSUtils.ts

@@ -19,6 +19,8 @@ import { globSync, hasMagic } from "glob";
 import * as urlUtil from "url";
 import { SettingsUtils } from "./SettingsUtils";
 import { Uri } from "vscode";
+import * as vscode from "vscode";
+import { getChannel } from "../../extension";
 
 /**
  * This method is responsible to return a valid URI without extension if the extension is not provided or an URI
@@ -62,7 +64,7 @@ export function getURIFrom(
 export function getURIFromResource(resource: string): urlUtil.URL[] {
   const uris: urlUtil.URL[] = [];
   for (const workspaceFolderPath of SettingsUtils.getWorkspaceFoldersPath()) {
-    const workspaceFolder = workspaceFolderPath.replace(/\/(.*:)/, "$1");
+    const workspaceFolder = cleanWorkspaceFolder(workspaceFolderPath);
     const uri = isAbsolute(resource)
       ? urlUtil.pathToFileURL(resource)
       : new urlUtil.URL(
@@ -88,6 +90,10 @@ export function searchCopybookInWorkspace(
   copybookFolders: string[],
   extensions: string[],
 ): string | undefined {
+  getChannel().appendLine(
+    "Search copybook using folders: " + copybookFolders.toString(),
+  );
+
   for (const workspaceFolderPath of SettingsUtils.getWorkspaceFoldersPath()) {
     const workspaceFolder = cleanWorkspaceFolder(workspaceFolderPath);
     for (const p of copybookFolders) {
@@ -114,6 +120,10 @@ export function cleanWorkspaceFolder(workspaceFolderPath: string) {
   return workspaceFolderPath.replace(/\/(.*:)/, "$1");
 }
 
+export function normalizePath(folder: string): string {
+  return vscode.Uri.file(folder).fsPath;
+}
+
 function globSearch(
   workspaceFolder: string,
   resource: string,

clients/cobol-lsp-vscode-extension/src/test/suite/lsp.spec.user1.test.ts

@@ -106,6 +106,8 @@ suite("Tests with USER1.cbl", function () {
       editor.document.uri,
       { tabSize: 4, insertSpaces: true },
     );
+    assert.strictEqual(result.length, 1);
+    
     helper.assertRangeIsEqual(
       result[0].range,
       new vscode.Range(pos(34, 57), pos(34, 65)),

server/common/src/main/java/org/eclipse/lsp/cobol/common/copybook/CopybookModel.java

@@ -15,13 +15,15 @@
 
 package org.eclipse.lsp.cobol.common.copybook;
 
-import lombok.Value;
+import lombok.AllArgsConstructor;
+import lombok.Data;
 
 /**
  * This value class represents a resolved copybook. It consists of the copybook name, its URI using
  * for positions and the content.
  */
-@Value
+@Data
+@AllArgsConstructor
 public class CopybookModel {
   CopybookId copybookId;
   CopybookName copybookName;

server/engine/src/main/java/org/eclipse/lsp/cobol/core/engine/symbols/SymbolsRepository.java

@@ -26,10 +26,9 @@
 import org.eclipse.lsp.cobol.common.symbols.CodeBlockReference;
 import org.eclipse.lsp.cobol.common.symbols.SymbolTable;
 import org.eclipse.lsp.cobol.common.utils.ImplicitCodeUtils;
-import org.eclipse.lsp.cobol.service.CobolDocumentModel;
 import org.eclipse.lsp.cobol.common.AnalysisResult;
 import org.eclipse.lsp4j.Location;
-import org.eclipse.lsp4j.TextDocumentPositionParams;
+import org.eclipse.lsp4j.Position;
 
 import java.util.*;
 import java.util.function.Predicate;
@@ -93,19 +92,16 @@ public Map<String, CodeBlockReference> getSectionMap(ProgramNode program) {
   /**
    * Find element using a position
    *
-   * @param document the document to search in
+   * @param uri the document uri
+   * @param result the document analysis result to search in
    * @param position the position to check
    * @return element at specified position
    */
-  public static Optional<Context> findElementByPosition(
-      CobolDocumentModel document, TextDocumentPositionParams position) {
-    AnalysisResult result = document.getAnalysisResult();
+  public static Optional<Context> findElementByPosition(String uri, AnalysisResult result, Position position) {
     if (result == null || result.getRootNode() == null) {
       return Optional.empty();
     }
-    Optional<Node> node =
-        findNodeByPosition(
-            result.getRootNode(), position.getTextDocument().getUri(), position.getPosition());
+    Optional<Node> node = findNodeByPosition(result.getRootNode(), uri, position);
 
     return node.filter(Context.class::isInstance)
         .map(Context.class::cast)