adjust server/ide crate api boundaries (#282)

Author: joshuadavidthomas

crates/djls-ide/src/context.rs

@@ -1,74 +1,41 @@
 use djls_source::File;
 use djls_source::Offset;
-use djls_source::Span;
 use djls_templates::parse_template;
 use djls_templates::Node;
 
-pub struct OffsetContext {
-    pub file: File,
-    pub offset: Offset,
-    pub span: Span,
-    pub kind: ContextKind,
-}
-
-pub enum ContextKind {
+pub(crate) enum OffsetContext {
     TemplateReference(String),
     None,
 }
 
 impl OffsetContext {
-    pub fn from_offset(db: &dyn djls_semantic::Db, file: File, offset: Offset) -> Self {
+    pub(crate) fn from_offset(db: &dyn djls_semantic::Db, file: File, offset: Offset) -> Self {
         let Some(nodelist) = parse_template(db, file) else {
-            return Self {
-                file,
-                offset,
-                span: Span::new(offset.get(), 0),
-                kind: ContextKind::None,
-            };
+            return Self::None;
         };
 
         for node in nodelist.nodelist(db) {
             if !node.full_span().contains(offset) {
                 continue;
             }
 
-            let span = node.full_span();
-            let context = match node {
-                Node::Tag { name, bits, .. } if Self::is_loader_tag(name) => {
-                    Self::extract_template_name(bits)
-                        .map_or(ContextKind::None, ContextKind::TemplateReference)
+            return match node {
+                Node::Tag { name, bits, .. } if matches!(name.as_str(), "extends" | "include") => {
+                    bits.first()
+                        .map(|s| {
+                            s.trim()
+                                .trim_start_matches('"')
+                                .trim_end_matches('"')
+                                .trim_start_matches('\'')
+                                .trim_end_matches('\'')
+                                .to_string()
+                        })
+                        .map_or(Self::None, Self::TemplateReference)
                 }
-                _ => ContextKind::None,
-            };
-
-            return Self {
-                file,
-                offset,
-                span,
-                kind: context,
+                _ => Self::None,
             };
         }
 
-        Self {
-            file,
-            offset,
-            span: Span::new(offset.get(), 0),
-            kind: ContextKind::None,
-        }
-    }
-
-    fn is_loader_tag(tag_name: &str) -> bool {
-        matches!(tag_name, "extends" | "include")
-    }
-
-    fn extract_template_name(bits: &[String]) -> Option<String> {
-        bits.first().map(|s| {
-            s.trim()
-                .trim_start_matches('"')
-                .trim_end_matches('"')
-                .trim_start_matches('\'')
-                .trim_end_matches('\'')
-                .to_string()
-        })
+        Self::None
     }
 }

crates/djls-ide/src/lib.rs

@@ -6,8 +6,6 @@ mod navigation;
 mod snippets;
 
 pub use completions::handle_completion;
-pub use context::ContextKind;
-pub use context::OffsetContext;
 pub use diagnostics::collect_diagnostics;
 pub use navigation::find_references;
 pub use navigation::goto_definition;

crates/djls-ide/src/navigation.rs

@@ -1,21 +1,23 @@
 use djls_semantic::resolve_template;
 use djls_semantic::ResolveResult;
+use djls_source::File;
+use djls_source::Offset;
 use tower_lsp_server::lsp_types;
 
+use crate::context::OffsetContext;
 use crate::ext::SpanExt;
 use crate::ext::Utf8PathExt;
-use crate::ContextKind;
-use crate::OffsetContext;
 
 pub fn goto_definition(
     db: &dyn djls_semantic::Db,
-    context: &OffsetContext,
+    file: File,
+    offset: Offset,
 ) -> Option<lsp_types::GotoDefinitionResponse> {
-    match &context.kind {
-        ContextKind::TemplateReference(template_name) => {
+    match OffsetContext::from_offset(db, file, offset) {
+        OffsetContext::TemplateReference(template_name) => {
             tracing::debug!("Found template reference: '{}'", template_name);
 
-            match resolve_template(db, template_name) {
+            match resolve_template(db, &template_name) {
                 ResolveResult::Found(template) => {
                     let path = template.path_buf(db);
                     tracing::debug!("Resolved template to: {}", path);
@@ -33,22 +35,23 @@ pub fn goto_definition(
                 }
             }
         }
-        ContextKind::None => None,
+        OffsetContext::None => None,
     }
 }
 
 pub fn find_references(
     db: &dyn djls_semantic::Db,
-    context: &OffsetContext,
+    file: File,
+    offset: Offset,
 ) -> Option<Vec<lsp_types::Location>> {
-    match &context.kind {
-        ContextKind::TemplateReference(template_name) => {
+    match OffsetContext::from_offset(db, file, offset) {
+        OffsetContext::TemplateReference(template_name) => {
             tracing::debug!(
                 "Cursor is inside extends/include tag referencing: '{}'",
                 template_name
             );
 
-            let references = djls_semantic::find_references_to_template(db, template_name);
+            let references = djls_semantic::find_references_to_template(db, &template_name);
 
             let locations: Vec<lsp_types::Location> = references
                 .iter()
@@ -69,6 +72,6 @@ pub fn find_references(
                 Some(locations)
             }
         }
-        ContextKind::None => None,
+        OffsetContext::None => None,
     }
 }

crates/djls-server/src/server.rs

@@ -334,47 +334,23 @@ impl LanguageServer for DjangoLanguageServer {
             params.text_document.uri
         );
 
-        let Some(url) = params.text_document.uri.to_url() else {
-            return Ok(lsp_types::DocumentDiagnosticReportResult::Report(
-                lsp_types::DocumentDiagnosticReport::Full(
-                    lsp_types::RelatedFullDocumentDiagnosticReport {
-                        related_documents: None,
-                        full_document_diagnostic_report: lsp_types::FullDocumentDiagnosticReport {
-                            result_id: None,
-                            items: vec![],
-                        },
-                    },
-                ),
-            ));
-        };
-
-        let path: Utf8PathBuf = url.path().into();
-
-        // Only provide diagnostics for template files
-        if FileKind::from(&path) != FileKind::Template {
-            return Ok(lsp_types::DocumentDiagnosticReportResult::Report(
-                lsp_types::DocumentDiagnosticReport::Full(
-                    lsp_types::RelatedFullDocumentDiagnosticReport {
-                        related_documents: None,
-                        full_document_diagnostic_report: lsp_types::FullDocumentDiagnosticReport {
-                            result_id: None,
-                            items: vec![],
-                        },
-                    },
-                ),
-            ));
-        }
-
-        // Get diagnostics from the database
-        let diagnostics: Vec<lsp_types::Diagnostic> = self
-            .with_session_mut(|session| {
-                session.with_db_mut(|db| {
-                    let file = db.get_or_create_file(&path);
-                    let nodelist = djls_templates::parse_template(db, file);
-                    djls_ide::collect_diagnostics(db, file, nodelist)
+        let diagnostics = match params.text_document.uri.to_url().filter(|url| {
+            let path: Utf8PathBuf = url.path().into();
+            FileKind::from(&path) == FileKind::Template
+        }) {
+            Some(url) => {
+                let path: Utf8PathBuf = url.path().into();
+                self.with_session_mut(move |session| {
+                    session.with_db_mut(|db| {
+                        let file = db.get_or_create_file(&path);
+                        let nodelist = djls_templates::parse_template(db, file);
+                        djls_ide::collect_diagnostics(db, file, nodelist)
+                    })
                 })
-            })
-            .await;
+                .await
+            }
+            None => vec![],
+        };
 
         Ok(lsp_types::DocumentDiagnosticReportResult::Report(
             lsp_types::DocumentDiagnosticReport::Full(
@@ -402,15 +378,14 @@ impl LanguageServer for DjangoLanguageServer {
                         .text_document_position_params
                         .text_document
                         .to_file(db)?;
-                    let line_index = file.line_index(db);
                     let source = file.source(db);
+                    let line_index = file.line_index(db);
                     let offset = params.text_document_position_params.position.to_offset(
                         source.as_str(),
                         line_index,
                         encoding,
                     );
-                    let context = djls_ide::OffsetContext::from_offset(db, file, offset);
-                    djls_ide::goto_definition(db, &context)
+                    djls_ide::goto_definition(db, file, offset)
                 })
             })
             .await;
@@ -428,15 +403,14 @@ impl LanguageServer for DjangoLanguageServer {
 
                 session.with_db_mut(|db| {
                     let file = params.text_document_position.text_document.to_file(db)?;
-                    let line_index = file.line_index(db);
                     let source = file.source(db);
+                    let line_index = file.line_index(db);
                     let offset = params.text_document_position.position.to_offset(
                         source.as_str(),
                         line_index,
                         encoding,
                     );
-                    let context = djls_ide::OffsetContext::from_offset(db, file, offset);
-                    djls_ide::find_references(db, &context)
+                    djls_ide::find_references(db, file, offset)
                 })
             })
             .await;