Refactor validation to BlockTree and tagspec semantics only (#266)

Author: joshuadavidthomas

Cargo.lock

@@ -6,6 +6,7 @@ edition = "2021"
 [dependencies]
 djls-source = { workspace = true }
 djls-templates = { workspace = true }
+djls-semantic = { workspace = true }
 
 camino = { workspace = true }
 divan = { workspace = true }
@@ -15,5 +16,9 @@ salsa = { workspace = true }
 name = "parser"
 harness = false
 
+[[bench]]
+name = "semantic"
+harness = false
+
 [lints]
 workspace = true

crates/djls-bench/Cargo.toml

@@ -0,0 +1,111 @@
+use divan::Bencher;
+use djls_bench::template_fixtures;
+use djls_bench::Db;
+use djls_bench::TemplateFixture;
+
+fn main() {
+    divan::main();
+}
+
+#[divan::bench(args = template_fixtures())]
+fn build_block_tree(bencher: Bencher, fixture: &TemplateFixture) {
+    let mut db = Db::new();
+    let file = db.file_with_contents(fixture.path.clone(), &fixture.source);
+
+    let _ = djls_templates::parse_template(&db, file).unwrap();
+
+    bencher.bench_local(move || {
+        if let Some(nodelist) = djls_templates::parse_template(&db, file) {
+            let tree = djls_semantic::build_block_tree(&db, nodelist);
+            divan::black_box(tree.roots(&db).len());
+        }
+    });
+}
+
+#[divan::bench(args = template_fixtures())]
+fn build_semantic_forest(bencher: Bencher, fixture: &TemplateFixture) {
+    let mut db = Db::new();
+    let file = db.file_with_contents(fixture.path.clone(), &fixture.source);
+
+    if let Some(nodelist) = djls_templates::parse_template(&db, file) {
+        let _ = djls_semantic::build_block_tree(&db, nodelist);
+    }
+
+    bencher.bench_local(move || {
+        if let Some(nodelist) = djls_templates::parse_template(&db, file) {
+            let tree = djls_semantic::build_block_tree(&db, nodelist);
+            let forest = djls_semantic::build_semantic_forest(&db, tree, nodelist);
+            divan::black_box(forest.roots(&db).len());
+        }
+    });
+}
+
+#[divan::bench(args = template_fixtures())]
+fn validate_template(bencher: Bencher, fixture: &TemplateFixture) {
+    let mut db = Db::new();
+    let file = db.file_with_contents(fixture.path.clone(), &fixture.source);
+
+    let _ = djls_templates::parse_template(&db, file);
+
+    bencher.bench_local(move || {
+        if let Some(nodelist) = djls_templates::parse_template(&db, file) {
+            djls_semantic::validate_nodelist(&db, nodelist);
+        }
+    });
+}
+
+#[divan::bench]
+fn validate_all_templates(bencher: Bencher) {
+    let fixtures = template_fixtures();
+    let mut db = Db::new();
+
+    let files: Vec<_> = fixtures
+        .iter()
+        .map(|fixture| {
+            let file = db.file_with_contents(fixture.path.clone(), &fixture.source);
+            // Warm up the parse cache
+            let _ = djls_templates::parse_template(&db, file);
+            file
+        })
+        .collect();
+
+    bencher.bench_local(move || {
+        for file in &files {
+            if let Some(nodelist) = djls_templates::parse_template(&db, *file) {
+                djls_semantic::validate_nodelist(&db, nodelist);
+            }
+        }
+    });
+}
+
+#[divan::bench(args = template_fixtures())]
+fn validate_template_incremental_bench(bencher: Bencher, fixture: &TemplateFixture) {
+    let mut db = Db::new();
+    let file = db.file_with_contents(fixture.path.clone(), &fixture.source);
+
+    if let Some(nodelist) = djls_templates::parse_template(&db, file) {
+        djls_semantic::validate_nodelist(&db, nodelist);
+    }
+
+    let original = fixture.source.clone();
+    let modified = {
+        let mut text = original.clone();
+        text.push(' ');
+        text
+    };
+
+    let mut revision = 1_u64;
+    let mut use_modified = true;
+
+    bencher.bench_local(move || {
+        let contents = if use_modified { &modified } else { &original };
+        use_modified = !use_modified;
+
+        db.set_file_contents(file, contents, revision);
+        revision = revision.wrapping_add(1);
+
+        if let Some(nodelist) = djls_templates::parse_template(&db, file) {
+            djls_semantic::validate_nodelist(&db, nodelist);
+        }
+    });
+}

crates/djls-bench/benches/semantic.rs

@@ -3,6 +3,10 @@ use std::sync::Arc;
 
 use camino::Utf8Path;
 use camino::Utf8PathBuf;
+use djls_semantic::django_builtin_specs;
+use djls_semantic::Db as SemanticDb;
+use djls_semantic::TagIndex;
+use djls_semantic::TagSpecs;
 use djls_source::Db as SourceDb;
 use djls_source::File;
 use djls_source::FxDashMap;
@@ -59,3 +63,14 @@ impl SourceDb for Db {
 
 #[salsa::db]
 impl TemplateDb for Db {}
+
+#[salsa::db]
+impl SemanticDb for Db {
+    fn tag_specs(&self) -> TagSpecs {
+        django_builtin_specs()
+    }
+
+    fn tag_index(&self) -> TagIndex<'_> {
+        TagIndex::from_specs(self)
+    }
+}

crates/djls-bench/src/db.rs

@@ -62,7 +62,10 @@ impl DiagnosticError for ValidationError {
             | ValidationError::OrphanedTag { span, .. }
             | ValidationError::UnmatchedBlockName { span, .. }
             | ValidationError::MissingRequiredArguments { span, .. }
-            | ValidationError::TooManyArguments { span, .. } => Some(span.into()),
+            | ValidationError::TooManyArguments { span, .. }
+            | ValidationError::MissingArgument { span, .. }
+            | ValidationError::InvalidLiteralArgument { span, .. }
+            | ValidationError::InvalidArgumentChoice { span, .. } => Some(span.into()),
         }
     }
 
@@ -72,8 +75,11 @@ impl DiagnosticError for ValidationError {
             ValidationError::UnbalancedStructure { .. } => "S101",
             ValidationError::OrphanedTag { .. } => "S102",
             ValidationError::UnmatchedBlockName { .. } => "S103",
-            ValidationError::MissingRequiredArguments { .. } => "S104",
+            ValidationError::MissingRequiredArguments { .. }
+            | ValidationError::MissingArgument { .. } => "S104",
             ValidationError::TooManyArguments { .. } => "S105",
+            ValidationError::InvalidLiteralArgument { .. } => "S106",
+            ValidationError::InvalidArgumentChoice { .. } => "S107",
         }
     }
 }

crates/djls-ide/src/diagnostics.rs

@@ -2,3 +2,22 @@ mod builder;
 mod grammar;
 mod snapshot;
 mod tree;
+
+use builder::BlockTreeBuilder;
+pub use grammar::TagIndex;
+pub(crate) use tree::BlockId;
+pub(crate) use tree::BlockNode;
+pub(crate) use tree::BlockTree;
+pub(crate) use tree::BranchKind;
+
+use crate::db::Db;
+use crate::traits::SemanticModel;
+
+#[salsa::tracked]
+pub fn build_block_tree<'db>(
+    db: &'db dyn Db,
+    nodelist: djls_templates::NodeList<'db>,
+) -> BlockTree<'db> {
+    let builder = BlockTreeBuilder::new(db, db.tag_index());
+    builder.model(db, nodelist)
+}