Merge pull request #102 from kaaveland/draw-random-example-on-web

Bake example scripts into `eugene` executable and improve demo

.github/workflows/run_tests.yml

@@ -10,6 +10,7 @@ on:
 
 env:
   CARGO_TERM_COLOR: always
+  RUST_BACKTRACE: "1"
 jobs:
   run_tests_ubuntu:
     runs-on: ubuntu-latest

eugene-web/src/webapp.rs

@@ -1,5 +1,7 @@
+use crate::webapp;
 use axum::routing::{get, post};
 use axum::Router;
+use eugene::hint_data::ALL;
 
 pub mod error;
 pub mod index;
@@ -9,10 +11,17 @@ pub mod lint_raw;
 pub mod requestlog;
 pub mod templates;
 
+async fn random_sql() -> Result<impl axum::response::IntoResponse, webapp::error::WebAppError> {
+    let n: usize = rand::random();
+    let choice = n % ALL.len();
+    Ok(ALL[choice].bad_example)
+}
+
 pub fn routes() -> Router {
     Router::new()
         .route("/", get(index::render_index))
         .route("/lint.html", post(lint_html::lint_html))
         .route("/lint.json", post(lint_json::json_lint_handler))
         .route("/lint.raw", post(lint_raw::raw_lint_handler))
+        .route("/random.sql", get(random_sql))
 }

eugene/docs/src/hints/E1/index.md

@@ -14,46 +14,39 @@
 
 ```sql
 -- 1.sql
-
 create table authors(
     id integer generated always as identity
         primary key,
     name text
 );
 
 -- 2.sql
-
 set local lock_timeout = '2s';
 alter table authors
     add constraint name_not_null
         check (name is not null);
-
 ```
 
 ## Safer migration
 
 ```sql
 -- 1.sql
-
 create table authors(
     id integer generated always as identity
         primary key,
     name text
 );
 
 -- 2.sql
-
 set local lock_timeout = '2s';
 alter table authors
     add constraint name_not_null
         check (name is not null) not valid;
 
 -- 3.sql
-
 set local lock_timeout = '2s';
 alter table authors
     validate constraint name_not_null;
-
 ```
 
 ## Eugene report examples

eugene/docs/src/hints/E1/safer_lint.md

@@ -9,6 +9,7 @@ The migration script passed all the checks ✅
 ### Statement number 1
 #### SQL
 ```sql
+-- 1.sql
 create table authors(
     id integer generated always as identity
         primary key,
@@ -28,6 +29,7 @@ The migration script passed all the checks ✅
 ### Statement number 1
 #### SQL
 ```sql
+-- 2.sql
 set local lock_timeout = '2s'
 ```
 No checks matched for this statement. ✅
@@ -51,6 +53,7 @@ The migration script passed all the checks ✅
 ### Statement number 1
 #### SQL
 ```sql
+-- 3.sql
 set local lock_timeout = '2s'
 ```
 No checks matched for this statement. ✅

eugene/docs/src/hints/E1/safer_trace.md

@@ -7,6 +7,7 @@
 #### SQL
 
 ```sql
+-- 1.sql
 create table authors(
     id integer generated always as identity
         primary key,
@@ -33,6 +34,7 @@ No new locks taken by this statement.
 #### SQL
 
 ```sql
+-- 2.sql
 set local lock_timeout = '2s'
 ```
 
@@ -77,6 +79,7 @@ No locks held at the start of this statement.
 #### SQL
 
 ```sql
+-- 3.sql
 set local lock_timeout = '2s'
 ```
 

eugene/docs/src/hints/E1/unsafe_lint.md

@@ -9,6 +9,7 @@ The migration script passed all the checks ✅
 ### Statement number 1
 #### SQL
 ```sql
+-- 1.sql
 create table authors(
     id integer generated always as identity
         primary key,
@@ -28,6 +29,7 @@ The migration script did not pass all the checks ❌
 ### Statement number 1
 #### SQL
 ```sql
+-- 2.sql
 set local lock_timeout = '2s'
 ```
 No checks matched for this statement. ✅

eugene/docs/src/hints/E1/unsafe_trace.md

@@ -7,6 +7,7 @@
 #### SQL
 
 ```sql
+-- 1.sql
 create table authors(
     id integer generated always as identity
         primary key,
@@ -33,6 +34,7 @@ No new locks taken by this statement.
 #### SQL
 
 ```sql
+-- 2.sql
 set local lock_timeout = '2s'
 ```
 

eugene/docs/src/hints/E10/index.md

@@ -14,7 +14,6 @@
 
 ```sql
 -- 1.sql
-
 create table prices (
     id integer generated always as identity
         primary key,
@@ -28,22 +27,19 @@ create table authors (
 );
 
 -- 2.sql
-
 set local lock_timeout = '2s';
 alter table authors add column meta jsonb;
 
 -- eugene: ignore E5, E4
 -- causes table rewrite, but this example isnt't about that
 alter table prices
     alter price set data type bigint;
-
 ```
 
 ## Safer migration
 
 ```sql
 -- 1.sql
-
 create table prices (
     id integer generated always as identity
         primary key,
@@ -57,19 +53,16 @@ create table authors (
 );
 
 -- 2.sql
-
 set local lock_timeout = '2s';
 alter table authors
     add column meta jsonb;
 
 -- 3.sql
-
 set local lock_timeout = '2s';
 -- eugene: ignore E5, E4
 -- causes table rewrite, but this example isnt't about that
 alter table prices
     alter price set data type bigint;
-
 ```
 
 ## Eugene report examples

eugene/docs/src/hints/E10/safer_lint.md

@@ -9,6 +9,7 @@ The migration script passed all the checks ✅
 ### Statement number 1
 #### SQL
 ```sql
+-- 1.sql
 create table prices (
     id integer generated always as identity
         primary key,
@@ -38,6 +39,7 @@ The migration script passed all the checks ✅
 ### Statement number 1
 #### SQL
 ```sql
+-- 2.sql
 set local lock_timeout = '2s'
 ```
 No checks matched for this statement. ✅
@@ -60,6 +62,7 @@ The migration script passed all the checks ✅
 ### Statement number 1
 #### SQL
 ```sql
+-- 3.sql
 set local lock_timeout = '2s'
 ```
 No checks matched for this statement. ✅

eugene/docs/src/hints/E10/safer_trace.md

@@ -7,6 +7,7 @@
 #### SQL
 
 ```sql
+-- 1.sql
 create table prices (
     id integer generated always as identity
         primary key,
@@ -55,6 +56,7 @@ No new locks taken by this statement.
 #### SQL
 
 ```sql
+-- 2.sql
 set local lock_timeout = '2s'
 ```
 
@@ -98,6 +100,7 @@ No locks held at the start of this statement.
 #### SQL
 
 ```sql
+-- 3.sql
 set local lock_timeout = '2s'
 ```
 

eugene/docs/src/hints/E10/unsafe_lint.md

@@ -9,6 +9,7 @@ The migration script passed all the checks ✅
 ### Statement number 1
 #### SQL
 ```sql
+-- 1.sql
 create table prices (
     id integer generated always as identity
         primary key,
@@ -38,6 +39,7 @@ The migration script passed all the checks ✅
 ### Statement number 1
 #### SQL
 ```sql
+-- 2.sql
 set local lock_timeout = '2s'
 ```
 No checks matched for this statement. ✅

eugene/docs/src/hints/E10/unsafe_trace.md

@@ -7,6 +7,7 @@
 #### SQL
 
 ```sql
+-- 1.sql
 create table prices (
     id integer generated always as identity
         primary key,
@@ -55,6 +56,7 @@ No new locks taken by this statement.
 #### SQL
 
 ```sql
+-- 2.sql
 set local lock_timeout = '2s'
 ```
 

eugene/docs/src/hints/E11/index.md

@@ -14,17 +14,14 @@
 
 ```sql
 -- 1.sql
-
 create table prices (
     price int not null
 );
 
 -- 2.sql
-
 set local lock_timeout = '2s';
 alter table prices
     add column id serial;
-
 ```
 
 ## Safer migration

eugene/docs/src/hints/E11/unsafe_lint.md

@@ -9,6 +9,7 @@ The migration script passed all the checks ✅
 ### Statement number 1
 #### SQL
 ```sql
+-- 1.sql
 create table prices (
     price int not null
 )
@@ -26,6 +27,7 @@ The migration script did not pass all the checks ❌
 ### Statement number 1
 #### SQL
 ```sql
+-- 2.sql
 set local lock_timeout = '2s'
 ```
 No checks matched for this statement. ✅

eugene/docs/src/hints/E11/unsafe_trace.md

@@ -7,6 +7,7 @@
 #### SQL
 
 ```sql
+-- 1.sql
 create table prices (
     price int not null
 )
@@ -31,6 +32,7 @@ No new locks taken by this statement.
 #### SQL
 
 ```sql
+-- 2.sql
 set local lock_timeout = '2s'
 ```
 

eugene/docs/src/hints/E2/index.md

@@ -14,53 +14,45 @@
 
 ```sql
 -- 1.sql
-
 create table authors(
     id integer generated always as identity
         primary key,
     name text
 );
 
 -- 2.sql
-
 set local lock_timeout = '2s';
 alter table authors
     alter column name set not null;
-
 ```
 
 ## Safer migration
 
 ```sql
 -- 1.sql
-
 create table authors(
     id integer generated always as identity
         primary key,
     name text
 );
 
 -- 2.sql
-
 set local lock_timeout = '2s';
 alter table authors
     add constraint check_name_not_null
         check (name is not null) not valid;
 
 -- 3.sql
-
 set local lock_timeout = '2s';
 alter table authors
     validate constraint check_name_not_null;
 
 -- 4.sql
-
 set local lock_timeout = '2s';
 -- eugene trace knows name has a valid not null check, but eugene lint doesn't
 -- eugene: ignore E2
 alter table authors
     alter name set not null;
-
 ```
 
 ## Eugene report examples