chore(splinter): initial commit

Author: psteinroe

.github/workflows/pull_request.yml

@@ -272,6 +272,8 @@ jobs:
         run: cargo run -p xtask_codegen -- configuration
       - name: Run the bindings codegen
         run: cargo run -p xtask_codegen -- bindings
+      - name: Run the splinter codegen
+        run: cargo run -p xtask_codegen -- splinter
       - name: Run the docs codegen
         run: cargo run -p docs_codegen
       - name: Check for git diff -- run "just ready" if you see an error

Cargo.lock

@@ -82,6 +82,7 @@ pgls_query                  = { path = "./crates/pgls_query", version = "0.0.0"
 pgls_query_ext              = { path = "./crates/pgls_query_ext", version = "0.0.0" }
 pgls_query_macros           = { path = "./crates/pgls_query_macros", version = "0.0.0" }
 pgls_schema_cache           = { path = "./crates/pgls_schema_cache", version = "0.0.0" }
+pgls_splinter               = { path = "./crates/pgls_splinter", version = "0.0.0" }
 pgls_statement_splitter     = { path = "./crates/pgls_statement_splitter", version = "0.0.0" }
 pgls_suppressions           = { path = "./crates/pgls_suppressions", version = "0.0.0" }
 pgls_text_edit              = { path = "./crates/pgls_text_edit", version = "0.0.0" }

Cargo.toml

@@ -47,6 +47,30 @@ define_categories! {
     "lint/safety/runningStatementWhileHoldingAccessExclusive": "https://pg-language-server.com/latest/rules/running-statement-while-holding-access-exclusive",
     "lint/safety/transactionNesting": "https://pg-language-server.com/latest/rules/transaction-nesting",
     // end lint rules
+    // splinter rules start
+    "dblint/splinter/authRlsInitplan": "https://supabase.com/docs/guides/database/database-linter?lint=0003_auth_rls_initplan",
+    "dblint/splinter/authUsersExposed": "https://supabase.com/docs/guides/database/database-linter?lint=0002_auth_users_exposed",
+    "dblint/splinter/duplicateIndex": "https://supabase.com/docs/guides/database/database-linter?lint=0009_duplicate_index",
+    "dblint/splinter/extensionInPublic": "https://supabase.com/docs/guides/database/database-linter?lint=0014_extension_in_public",
+    "dblint/splinter/extensionVersionsOutdated": "https://supabase.com/docs/guides/database/database-linter?lint=0022_extension_versions_outdated",
+    "dblint/splinter/fkeyToAuthUnique": "https://supabase.com/docs/guides/database/database-linter?lint=0021_fkey_to_auth_unique",
+    "dblint/splinter/foreignTableInApi": "https://supabase.com/docs/guides/database/database-linter?lint=0017_foreign_table_in_api",
+    "dblint/splinter/functionSearchPathMutable": "https://supabase.com/docs/guides/database/database-linter?lint=0011_function_search_path_mutable",
+    "dblint/splinter/insecureQueueExposedInApi": "https://supabase.com/docs/guides/database/database-linter?lint=0019_insecure_queue_exposed_in_api",
+    "dblint/splinter/materializedViewInApi": "https://supabase.com/docs/guides/database/database-linter?lint=0016_materialized_view_in_api",
+    "dblint/splinter/multiplePermissivePolicies": "https://supabase.com/docs/guides/database/database-linter?lint=0006_multiple_permissive_policies",
+    "dblint/splinter/noPrimaryKey": "https://supabase.com/docs/guides/database/database-linter?lint=0004_no_primary_key",
+    "dblint/splinter/policyExistsRlsDisabled": "https://supabase.com/docs/guides/database/database-linter?lint=0007_policy_exists_rls_disabled",
+    "dblint/splinter/rlsDisabledInPublic": "https://supabase.com/docs/guides/database/database-linter?lint=0013_rls_disabled_in_public",
+    "dblint/splinter/rlsEnabledNoPolicy": "https://supabase.com/docs/guides/database/database-linter?lint=0008_rls_enabled_no_policy",
+    "dblint/splinter/rlsReferencesUserMetadata": "https://supabase.com/docs/guides/database/database-linter?lint=0015_rls_references_user_metadata",
+    "dblint/splinter/securityDefinerView": "https://supabase.com/docs/guides/database/database-linter?lint=0010_security_definer_view",
+    "dblint/splinter/tableBloat": "https://supabase.com/docs/guides/database/database-linter?lint=0020_table_bloat",
+    "dblint/splinter/unindexedForeignKeys": "https://supabase.com/docs/guides/database/database-linter?lint=0001_unindexed_foreign_keys",
+    "dblint/splinter/unknown": "https://pg-language-server.com/latest",
+    "dblint/splinter/unsupportedRegTypes": "https://supabase.com/docs/guides/database/database-linter?lint=unsupported_reg_types",
+    "dblint/splinter/unusedIndex": "https://supabase.com/docs/guides/database/database-linter?lint=0005_unused_index",
+    // splinter rules end
     ;
     // General categories
     "stdin",
@@ -68,5 +92,9 @@ define_categories! {
     "lint",
     "lint/performance",
     "lint/safety",
+    // splinter groups start
+    "dblint",
+    "dblint/splinter",
+    // splinter groups end
     // Lint groups end
-}
+}

crates/pgls_diagnostics_categories/src/categories.rs

@@ -0,0 +1,28 @@
+[package]
+authors.workspace    = true
+categories.workspace = true
+description          = "<DESCRIPTION>"
+edition.workspace    = true
+homepage.workspace   = true
+keywords.workspace   = true
+license.workspace    = true
+name                 = "pgls_splinter"
+repository.workspace = true
+version              = "0.0.0"
+
+[dependencies]
+pgls_diagnostics.workspace = true
+serde.workspace            = true
+serde_json.workspace       = true
+sqlx.workspace             = true
+
+[build-dependencies]
+ureq = "2.10"
+
+[dev-dependencies]
+insta.workspace           = true
+pgls_console.workspace    = true
+pgls_test_utils.workspace = true
+
+[lib]
+doctest = false

crates/pgls_splinter/.sqlx/query-b869d517301aaf69d382f092c09d5a53712d68afd273423f9310cd793586f532.json

@@ -0,0 +1 @@
+- implement ignore / include and config. try to refactor existing analyser infrastructure to be re-used.

crates/pgls_splinter/Cargo.toml

@@ -0,0 +1,109 @@
+use std::env;
+use std::fs;
+use std::path::Path;
+
+// Update this commit SHA to pull in a new version of splinter.sql
+const SPLINTER_COMMIT_SHA: &str = "27ea2ece65464213e466cd969cc61b6940d16219";
+
+fn main() {
+    let out_dir = env::var("CARGO_MANIFEST_DIR").unwrap();
+    let vendor_dir = Path::new(&out_dir).join("vendor");
+    let sql_file = vendor_dir.join("splinter.sql");
+    let sha_file = vendor_dir.join("COMMIT_SHA.txt");
+
+    // Create vendor directory if it doesn't exist
+    if !vendor_dir.exists() {
+        fs::create_dir_all(&vendor_dir).expect("Failed to create vendor directory");
+    }
+
+    // Check if we need to download
+    let needs_download = if !sql_file.exists() || !sha_file.exists() {
+        true
+    } else {
+        // Check if stored SHA matches current constant
+        let stored_sha = fs::read_to_string(&sha_file)
+            .expect("Failed to read COMMIT_SHA.txt")
+            .trim()
+            .to_string();
+        stored_sha != SPLINTER_COMMIT_SHA
+    };
+
+    if needs_download {
+        println!(
+            "cargo:warning=Downloading splinter.sql from GitHub (commit: {SPLINTER_COMMIT_SHA})"
+        );
+        download_and_process_sql(&sql_file);
+        fs::write(&sha_file, SPLINTER_COMMIT_SHA).expect("Failed to write COMMIT_SHA.txt");
+    }
+
+    // Tell cargo to rerun if build.rs or SHA file changes
+    println!("cargo:rerun-if-changed=build.rs");
+    println!("cargo:rerun-if-changed=vendor/COMMIT_SHA.txt");
+}
+
+fn download_and_process_sql(dest_path: &Path) {
+    let url = format!(
+        "https://raw.githubusercontent.com/supabase/splinter/{SPLINTER_COMMIT_SHA}/splinter.sql"
+    );
+
+    // Download the file
+    let response = ureq::get(&url)
+        .call()
+        .expect("Failed to download splinter.sql");
+
+    let content = response
+        .into_string()
+        .expect("Failed to read response body");
+
+    // Remove the SET LOCAL search_path section
+    let mut processed_content = remove_set_search_path(&content);
+
+    // Add "!" suffix to column aliases for sqlx non-null checking
+    processed_content = add_not_null_markers(&processed_content);
+
+    // Write to destination
+    fs::write(dest_path, processed_content).expect("Failed to write splinter.sql");
+
+    println!("cargo:warning=Successfully downloaded and processed splinter.sql");
+}
+
+fn remove_set_search_path(content: &str) -> String {
+    content
+        .lines()
+        .filter(|line| {
+            let trimmed = line.trim();
+            !trimmed.to_lowercase().starts_with("set local search_path")
+        })
+        .collect::<Vec<_>>()
+        .join("\n")
+}
+
+fn add_not_null_markers(content: &str) -> String {
+    // Add "!" suffix to all column aliases to mark them as non-null for sqlx
+    // This transforms patterns like: 'value' as name
+    // Into: 'value' as "name!"
+
+    let columns_to_mark = [
+        "name",
+        "title",
+        "level",
+        "facing",
+        "categories",
+        "description",
+        "detail",
+        "remediation",
+        "metadata",
+        "cache_key",
+    ];
+
+    let mut result = content.to_string();
+
+    for column in &columns_to_mark {
+        // Match patterns like: as name, as name)
+        let pattern_comma = format!(" as {column}");
+        let replacement_comma = format!(" as \"{column}!\"");
+        result = result.replace(&pattern_comma, &replacement_comma);
+    }
+
+    result
+}

crates/pgls_splinter/TODO.md

@@ -0,0 +1,101 @@
+use pgls_diagnostics::{Category, Severity, category};
+use serde_json::Value;
+
+use crate::{SplinterAdvices, SplinterDiagnostic, SplinterQueryResult};
+
+impl From<SplinterQueryResult> for SplinterDiagnostic {
+    fn from(result: SplinterQueryResult) -> Self {
+        let severity = parse_severity(&result.level);
+
+        // Extract common fields from metadata
+        let (schema, object_name, object_type, additional_metadata) =
+            extract_metadata_fields(&result.metadata);
+
+        SplinterDiagnostic {
+            category: rule_name_to_category(&result.name),
+            message: result.detail.into(),
+            severity,
+            advices: SplinterAdvices {
+                description: result.description,
+                schema,
+                object_name,
+                object_type,
+                remediation_url: result.remediation,
+                additional_metadata,
+            },
+        }
+    }
+}
+
+/// Parse severity level from the query result
+fn parse_severity(level: &str) -> Severity {
+    match level {
+        "INFO" => Severity::Information,
+        "WARN" => Severity::Warning,
+        "ERROR" => Severity::Error,
+        _ => Severity::Information, // default to info
+    }
+}
+
+/// Convert rule name to a Category
+/// Note: Rule names use snake_case, but categories use camelCase
+fn rule_name_to_category(name: &str) -> &'static Category {
+    match name {
+        "unindexed_foreign_keys" => category!("dblint/splinter/unindexedForeignKeys"),
+        "auth_users_exposed" => category!("dblint/splinter/authUsersExposed"),
+        "auth_rls_initplan" => category!("dblint/splinter/authRlsInitplan"),
+        "no_primary_key" => category!("dblint/splinter/noPrimaryKey"),
+        "unused_index" => category!("dblint/splinter/unusedIndex"),
+        "multiple_permissive_policies" => category!("dblint/splinter/multiplePermissivePolicies"),
+        "policy_exists_rls_disabled" => category!("dblint/splinter/policyExistsRlsDisabled"),
+        "rls_enabled_no_policy" => category!("dblint/splinter/rlsEnabledNoPolicy"),
+        "duplicate_index" => category!("dblint/splinter/duplicateIndex"),
+        "security_definer_view" => category!("dblint/splinter/securityDefinerView"),
+        "function_search_path_mutable" => category!("dblint/splinter/functionSearchPathMutable"),
+        "rls_disabled_in_public" => category!("dblint/splinter/rlsDisabledInPublic"),
+        "extension_in_public" => category!("dblint/splinter/extensionInPublic"),
+        "rls_references_user_metadata" => category!("dblint/splinter/rlsReferencesUserMetadata"),
+        "materialized_view_in_api" => category!("dblint/splinter/materializedViewInApi"),
+        "foreign_table_in_api" => category!("dblint/splinter/foreignTableInApi"),
+        "unsupported_reg_types" => category!("dblint/splinter/unsupportedRegTypes"),
+        "insecure_queue_exposed_in_api" => category!("dblint/splinter/insecureQueueExposedInApi"),
+        "table_bloat" => category!("dblint/splinter/tableBloat"),
+        "fkey_to_auth_unique" => category!("dblint/splinter/fkeyToAuthUnique"),
+        "extension_versions_outdated" => category!("dblint/splinter/extensionVersionsOutdated"),
+        _ => category!("dblint/splinter/unknown"),
+    }
+}
+
+/// Extract common metadata fields and return the rest as additional_metadata
+fn extract_metadata_fields(
+    metadata: &Value,
+) -> (
+    Option<String>,
+    Option<String>,
+    Option<String>,
+    Option<Value>,
+) {
+    if let Some(obj) = metadata.as_object() {
+        let schema = obj.get("schema").and_then(|v| v.as_str()).map(String::from);
+
+        let object_name = obj.get("name").and_then(|v| v.as_str()).map(String::from);
+
+        let object_type = obj.get("type").and_then(|v| v.as_str()).map(String::from);
+
+        // Create a new object without the common fields
+        let mut additional = obj.clone();
+        additional.remove("schema");
+        additional.remove("name");
+        additional.remove("type");
+
+        let additional_metadata = if additional.is_empty() {
+            None
+        } else {
+            Some(Value::Object(additional))
+        };
+
+        (schema, object_name, object_type, additional_metadata)
+    } else {
+        (None, None, None, Some(metadata.clone()))
+    }
+}