feat: plpgsql check (#469)

adds support for plpgsql_check. the approach is even simpler as
described in the issue: if we encounter a create function statement, we
start a transaction, run the statement, then run plpgsql_check on it,
and then rollback the transaction.

the remaining code is just about translating the location information we
get from the extension into a good range.

todo:
- [x] integrate into workspace api
- [x] to get span, move from the first word / occurrence in the line to
the next semicolon
- [x] handle return trigger by checking for all variations
- [x] make sure we do not report create fn syntax errors if
plpgsql_check is enabled
- [x] check why "not a known variable" is not getting the right span

closes #190

Author: psteinroe

.github/workflows/pull_request.yml

@@ -79,15 +79,6 @@ jobs:
   lint:
     name: Lint Project
     runs-on: ubuntu-latest
-    services:
-      postgres:
-        image: postgres:latest
-        env:
-          POSTGRES_USER: postgres
-          POSTGRES_PASSWORD: postgres
-          POSTGRES_DB: postgres
-        ports:
-          - 5432:5432
     steps:
       - name: Checkout PR Branch
         uses: actions/checkout@v4
@@ -103,6 +94,24 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+      # we need to use the same database as we do locally for sqlx prepare to output the same hashes
+      - name: Build and start PostgreSQL with plpgsql_check
+        run: |
+          docker build -t postgres-plpgsql-check:latest .
+          docker run -d --name postgres \
+            -e POSTGRES_USER=postgres \
+            -e POSTGRES_PASSWORD=postgres \
+            -e POSTGRES_DB=postgres \
+            -p 5432:5432 \
+            postgres-plpgsql-check:latest
+          # Wait for postgres to be ready
+          for _ in {1..30}; do
+            if docker exec postgres pg_isready -U postgres; then
+              break
+            fi
+            sleep 1
+          done
+
       - name: Setup sqlx-cli
         run: cargo install sqlx-cli
 
@@ -154,13 +163,37 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      # running containers via `services` only works on linux
-      # https://github.com/actions/runner/issues/1866
-      - name: Setup postgres
+      # For Linux, use custom Docker image with plpgsql_check
+      - name: Build and start PostgreSQL with plpgsql_check
+        if: runner.os == 'Linux'
+        run: |
+          docker build -t postgres-plpgsql-check:latest .
+          docker run -d --name postgres \
+            -e POSTGRES_USER=postgres \
+            -e POSTGRES_PASSWORD=postgres \
+            -e POSTGRES_DB=postgres \
+            -p 5432:5432 \
+            postgres-plpgsql-check:latest
+          # Wait for postgres to be ready
+          for _ in {1..30}; do
+            if docker exec postgres pg_isready -U postgres; then
+              break
+            fi
+            sleep 1
+          done
+      # For Windows, use the action since PostgreSQL Docker image doesn't support Windows containers
+      - name: Setup postgres (Windows)
+        if: runner.os == 'Windows'
         id: postgres
         uses: ikalnytskyi/action-setup-postgres@v7
       - name: Print Roles
-        run: psql ${{ steps.postgres.outputs.connection-uri }} -c "select rolname from pg_roles;"
+        run: |
+          if [[ "$RUNNER_OS" == "Linux" ]]; then
+            docker exec postgres psql -U postgres -c "select rolname from pg_roles;"
+          else
+            psql ${{ steps.postgres.outputs.connection-uri }} -c "select rolname from pg_roles;"
+          fi
+        shell: bash
       - name: Run tests
         run: cargo test --workspace
 

.sqlx/query-277e47bf46f8331549f55c8a0ebae6f3075c4f754cd379b0555c205fff95a95c.json

@@ -76,6 +76,7 @@ pgt_lexer                  = { path = "./crates/pgt_lexer", version = "0.0.0" }
 pgt_lexer_codegen          = { path = "./crates/pgt_lexer_codegen", version = "0.0.0" }
 pgt_lsp                    = { path = "./crates/pgt_lsp", version = "0.0.0" }
 pgt_markup                 = { path = "./crates/pgt_markup", version = "0.0.0" }
+pgt_plpgsql_check          = { path = "./crates/pgt_plpgsql_check", version = "0.0.0" }
 pgt_query                  = { path = "./crates/pgt_query", version = "0.0.0" }
 pgt_query_ext              = { path = "./crates/pgt_query_ext", version = "0.0.0" }
 pgt_query_macros           = { path = "./crates/pgt_query_macros", version = "0.0.0" }

.sqlx/query-4ea19fee016f1daeafdc466647d117910b19f540f19393b76aa6434e9d1d8502.json

@@ -0,0 +1,16 @@
+FROM postgres:15
+
+# Install build dependencies
+RUN apt-get update && \
+    apt-get install -y postgresql-server-dev-15 gcc make git && \
+    cd /tmp && \
+    git clone https://github.com/okbob/plpgsql_check.git && \
+    cd plpgsql_check && \
+    make && \
+    make install && \
+    apt-get remove -y postgresql-server-dev-15 gcc make git && \
+    apt-get autoremove -y && \
+    rm -rf /tmp/plpgsql_check /var/lib/apt/lists/*
+
+# Add initialization script directly
+RUN echo "CREATE EXTENSION IF NOT EXISTS plpgsql_check;" > /docker-entrypoint-initdb.d/01-create-extension.sql

.sqlx/query-df57cc22f7d63847abce1d0d15675ba8951faa1be2ea6b2bf6714b1aa9127a6f.json

@@ -32,6 +32,7 @@ define_categories! {
     "flags/invalid",
     "project",
     "typecheck",
+    "plpgsql_check",
     "internalError/panic",
     "syntax",
     "dummy",

Cargo.lock

@@ -0,0 +1,30 @@
+[package]
+authors.workspace    = true
+categories.workspace = true
+description          = "<DESCRIPTION>"
+edition.workspace    = true
+homepage.workspace   = true
+keywords.workspace   = true
+license.workspace    = true
+name                 = "pgt_plpgsql_check"
+repository.workspace = true
+version              = "0.0.0"
+
+
+[dependencies]
+pgt_console      = { workspace = true }
+pgt_diagnostics  = { workspace = true }
+pgt_query        = { workspace = true }
+pgt_query_ext    = { workspace = true }
+pgt_schema_cache = { workspace = true }
+pgt_text_size    = { workspace = true }
+regex            = { workspace = true }
+serde            = { workspace = true }
+serde_json       = { workspace = true }
+sqlx             = { workspace = true }
+tree-sitter      = { workspace = true }
+
+[dev-dependencies]
+pgt_test_utils = { workspace = true }
+
+[lib]