diagnostics: improve compiler path handling and add ProjectResolver (#173)

Author: wenxuanjun

src/server/diagnostics.v

@@ -15,8 +15,9 @@ pub fn (mut ls LanguageServer) run_diagnostics_in_bg(uri lsp.DocumentUri) {
 
 pub fn (mut ls LanguageServer) run_diagnostics(uri lsp.DocumentUri) {
 	watch := time.new_stopwatch(auto_start: true)
+	project_root := ls.project_resolver.resolve(uri)
 	ls.reporter.clear(uri)
-	ls.reporter.run_all_inspections(uri)
+	ls.reporter.run_all_inspections(uri, project_root)
 	ls.reporter.publish(mut ls.writer, uri)
 
 	loglib.with_fields({
@@ -31,11 +32,11 @@ mut:
 	reports       map[lsp.DocumentUri][]inspections.Report
 }
 
-fn (mut d DiagnosticReporter) run_all_inspections(uri lsp.DocumentUri) {
+fn (mut d DiagnosticReporter) run_all_inspections(uri lsp.DocumentUri, project_root string) {
 	mut source := compiler.CompilerReportsSource{
 		compiler_path: d.compiler_path
 	}
-	d.reports[uri] = source.process(uri)
+	d.reports[uri] = source.process(uri, project_root)
 }
 
 fn (mut d DiagnosticReporter) clear(uri lsp.DocumentUri) {

src/server/features_did_change_watched_files.v

@@ -2,10 +2,12 @@ module server
 
 import lsp
 import loglib
+import os
 
 pub fn (mut ls LanguageServer) did_change_watched_files(params lsp.DidChangeWatchedFilesParams) {
 	changes := params.changes
 	mut is_rename := false
+	mut structure_changed := false
 
 	// NOTE:
 	// 1. Renaming a file returns two events: one "created" event for the
@@ -17,6 +19,12 @@ pub fn (mut ls LanguageServer) did_change_watched_files(params lsp.DidChangeWatc
 	//    but with no "deleted" event prior to it.
 	for i, change in changes {
 		change_uri := change.uri.normalize()
+
+		filename := os.file_name(change_uri.path())
+		if filename == 'v.mod' || filename == '.git' {
+			structure_changed = true
+		}
+
 		match change.typ {
 			.created {
 				if next_change := changes[i + 1] {
@@ -75,4 +83,13 @@ pub fn (mut ls LanguageServer) did_change_watched_files(params lsp.DidChangeWatc
 
 		ls.client.log_message(change.str(), .info)
 	}
+
+	if structure_changed {
+		loglib.info('Project structure changed, clearing project root cache')
+		ls.project_resolver.clear()
+
+		for uri, _ in ls.opened_files {
+			ls.run_diagnostics_in_bg(uri)
+		}
+	}
 }

src/server/general.v

@@ -13,6 +13,7 @@ import server.protocol
 import server.semantic
 import server.progress
 import server.intentions
+import server.workspace
 
 // initialize sends the server capabilities to the client
 pub fn (mut ls LanguageServer) initialize(params lsp.InitializeParams, mut wr ResponseWriter) lsp.InitializeResult {
@@ -23,6 +24,7 @@ pub fn (mut ls LanguageServer) initialize(params lsp.InitializeParams, mut wr Re
 
 	ls.root_uri = params.root_uri
 	ls.status = .initialized
+	ls.project_resolver = workspace.ProjectResolver.new(ls.root_uri.path())
 
 	ls.progress.support_work_done_progress = params.capabilities.window.work_done_progress
 	options := params.initialization_options

src/server/inspections/compiler/CompilerReportsSource.v

@@ -8,7 +8,7 @@ pub:
 	compiler_path string
 }
 
-pub fn (mut c CompilerReportsSource) process(uri lsp.DocumentUri) []inspections.Report {
-	reports := exec_compiler_diagnostics(c.compiler_path, uri) or { return [] }
+pub fn (mut c CompilerReportsSource) process(uri lsp.DocumentUri, project_root string) []inspections.Report {
+	reports := exec_compiler_diagnostics(c.compiler_path, uri, project_root) or { return [] }
 	return reports
 }

src/server/inspections/compiler/utils.v

@@ -57,13 +57,12 @@ fn parse_compiler_diagnostic(msg string) ?inspections.Report {
 	}
 }
 
-fn exec_compiler_diagnostics(compiler_path string, uri lsp.DocumentUri) ?[]inspections.Report {
-	dir_path := uri.dir_path()
+fn exec_compiler_diagnostics(compiler_path string, uri lsp.DocumentUri, project_root string) ?[]inspections.Report {
 	filepath := uri.path()
-	is_module := !filepath.ends_with('.vv')
-	input_path := if is_module { dir_path } else { filepath }
+	is_script := filepath.ends_with('.vsh') || filepath.ends_with('.vv')
 
-	res := os.execute('${compiler_path} -enable-globals -shared -check ${input_path}')
+	check_target := if is_script { filepath } else { project_root }
+	res := os.execute('${compiler_path} -enable-globals -shared -check ${check_target}')
 
 	if res.exit_code == 0 {
 		return none
@@ -72,6 +71,7 @@ fn exec_compiler_diagnostics(compiler_path string, uri lsp.DocumentUri) ?[]inspe
 	output_lines := res.output.split_into_lines().map(term.strip_ansi(it))
 	errors := split_lines_to_errors(output_lines)
 
+	current_file_abs := os.real_path(filepath)
 	mut reports := []inspections.Report{}
 
 	for error in errors {
@@ -82,29 +82,14 @@ fn exec_compiler_diagnostics(compiler_path string, uri lsp.DocumentUri) ?[]inspe
 			continue
 		}
 
-		file_dir_path := os.dir(report.filepath)
-
-		report_filepath := if os.is_abs_path(file_dir_path) {
-			// do nothing
-			report.filepath
-		} else if file_dir_path == '..' {
-			os.join_path_single(dir_path, report.filepath)
-		} else if start_idx := dir_path.last_index(file_dir_path) {
-			// reported file appears to be in a subdirectory of dir_path
-			dir_path[..start_idx] + report.filepath
-		} else {
-			// reported file appears to be in a parent directory of dir_path
-			os.join_path_single(dir_path, report.filepath)
-		}
-
-		// ignore errors in other files
-		if report_filepath != uri.path() {
+		report_file_abs := os.real_path(report.filepath)
+		if os.to_slash(report_file_abs) != os.to_slash(current_file_abs) {
 			continue
 		}
 
 		reports << inspections.Report{
 			...report
-			filepath: report_filepath
+			filepath: filepath
 		}
 	}
 	return reports

src/server/language_server.v

@@ -11,6 +11,7 @@ import loglib
 import server.progress
 import server.protocol
 import server.intentions
+import server.workspace
 
 pub enum ServerStatus {
 	off
@@ -77,6 +78,8 @@ pub mut:
 	progress &progress.Tracker = unsafe { nil }
 	// indexing_mng is used to manage indexing.
 	indexing_mng analyzer.IndexingManager
+	// project_resolver is used to resolve the project root for a given file.
+	project_resolver &workspace.ProjectResolver = unsafe { nil }
 }
 
 pub fn LanguageServer.new(indexing analyzer.IndexingManager) &LanguageServer {

src/server/workspace/ProjectResolver.v

@@ -0,0 +1,66 @@
+module workspace
+
+import os
+import lsp
+
+pub struct ProjectResolver {
+	workspace_root string
+mut:
+	cache shared map[string]string
+}
+
+pub fn ProjectResolver.new(workspace_root string) &ProjectResolver {
+	return &ProjectResolver{
+		workspace_root: os.real_path(workspace_root)
+		cache:          map[string]string{}
+	}
+}
+
+pub fn (mut p ProjectResolver) resolve(uri lsp.DocumentUri) string {
+	filepath := os.real_path(uri.path())
+	dir := os.dir(filepath)
+
+	rlock p.cache {
+		if cached := p.cache[dir] {
+			return cached
+		}
+	}
+
+	root := p.find_root(dir)
+
+	lock p.cache {
+		p.cache[dir] = root
+	}
+
+	return root
+}
+
+pub fn (mut p ProjectResolver) clear() {
+	lock p.cache {
+		p.cache.clear()
+	}
+}
+
+fn (p &ProjectResolver) find_root(start_dir string) string {
+	mut curr := start_dir
+	home_dir := os.home_dir()
+
+	for {
+		if os.exists(os.join_path(curr, 'v.mod')) || os.is_dir(os.join_path(curr, '.git'))
+			|| curr == p.workspace_root {
+			return curr
+		}
+
+		parent := os.dir(curr)
+		if curr == home_dir || parent == curr {
+			break
+		}
+		curr = parent
+	}
+
+	return if start_dir.starts_with(p.workspace_root) {
+		p.workspace_root
+	} else {
+		start_dir
+	}
+}