Add titles to lints (#72)

* add titles to lints * add title to lint interface doc
supabase · May 9, 2024 · 95f050c · 95f050c
1 parent e2a6622
commit 95f050c
Show file tree

Hide file tree

Showing 34 changed files with 165 additions and 134 deletions.
diff --git a/README.md b/README.md
@@ -27,6 +27,7 @@ If you are only interested in linting a project, a single query containing the l
 Each lint creates a view that returns a common interface. The interface is:
 
 - name (text) not null -- Name of the lint
+- title (text) not null -- Human readable title of the lint
 - level (text) not null -- The level of issue. One of ERROR/WARN/INFO
 - facing (text) not null -- Is it an internal (to supabase) or an external (user centric)  lint. One of INTERNAL/EXTERNAL
 - categories (text[]) not null -- Relevant tags for the issue. Any/All of SECURITY/PERFORMANCE (list may grow)

diff --git a/lints/0001_unindexed_foreign_keys.sql b/lints/0001_unindexed_foreign_keys.sql
@@ -33,6 +33,7 @@ index_ as (
 )
 select
     'unindexed_foreign_keys' as name,
+    'Unindexed foreign keys' as title,
     'INFO' as level,
     'EXTERNAL' as facing,
     array['PERFORMANCE'] as categories,

diff --git a/lints/0002_auth_users_exposed.sql b/lints/0002_auth_users_exposed.sql
@@ -2,6 +2,7 @@ create view lint."0002_auth_users_exposed" as
 
 select
     'auth_users_exposed' as name,
+    'Exposed Auth Users' as title,
     'ERROR' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,

diff --git a/lints/0003_auth_rls_initplan.sql b/lints/0003_auth_rls_initplan.sql
@@ -30,6 +30,7 @@ with policies as (
 )
 select
     'auth_rls_initplan' as name,
+    'Auth RLS Initialization Plan' as title,
     'WARN' as level,
     'EXTERNAL' as facing,
     array['PERFORMANCE'] as categories,

diff --git a/lints/0004_no_primary_key.sql b/lints/0004_no_primary_key.sql
@@ -2,6 +2,7 @@ create view lint."0004_no_primary_key" as
 
 select
     'no_primary_key' as name,
+    'No Primary Key' as title,
     'INFO' as level,
     'EXTERNAL' as facing,
     array['PERFORMANCE'] as categories,

diff --git a/lints/0005_unused_index.sql b/lints/0005_unused_index.sql
@@ -2,6 +2,7 @@ create view lint."0005_unused_index" as
 
 select
     'unused_index' as name,
+    'Unused Index' as title,
     'INFO' as level,
     'EXTERNAL' as facing,
     array['PERFORMANCE'] as categories,

diff --git a/lints/0006_multiple_permissive_policies.sql b/lints/0006_multiple_permissive_policies.sql
@@ -2,6 +2,7 @@ create view lint."0006_multiple_permissive_policies" as
 
 select
     'multiple_permissive_policies' as name,
+    'Multiple Permissive Policies' as title,
     'WARN' as level,
     'EXTERNAL' as facing,
     array['PERFORMANCE'] as categories,

diff --git a/lints/0007_policy_exists_rls_disabled.sql b/lints/0007_policy_exists_rls_disabled.sql
@@ -2,6 +2,7 @@ create view lint."0007_policy_exists_rls_disabled" as
 
 select
     'policy_exists_rls_disabled' as name,
+    'Policy Exists RLS Disabled' as title,
     'ERROR' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,

diff --git a/lints/0008_rls_enabled_no_policy.sql b/lints/0008_rls_enabled_no_policy.sql
@@ -2,6 +2,7 @@ create view lint."0008_rls_enabled_no_policy" as
 
 select
     'rls_enabled_no_policy' as name,
+    'RLS Enabled No Policy' as title,
     'INFO' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,

diff --git a/lints/0009_duplicate_index.sql b/lints/0009_duplicate_index.sql
@@ -2,6 +2,7 @@ create view lint."0009_duplicate_index" as
 
 select
     'duplicate_index' as name,
+    'Duplicate Index' as title,
     'WARN' as level,
     'EXTERNAL' as facing,
     array['PERFORMANCE'] as categories,

diff --git a/lints/0010_security_definer_view.sql b/lints/0010_security_definer_view.sql
@@ -2,6 +2,7 @@ create view lint."0010_security_definer_view" as
 
 select
     'security_definer_view' as name,
+    'Security Definer View' as title,
     'ERROR' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,

diff --git a/lints/0011_function_search_path_mutable.sql b/lints/0011_function_search_path_mutable.sql
@@ -2,6 +2,7 @@ create view lint."0011_function_search_path_mutable" as
 
 select
     'function_search_path_mutable' as name,
+    'Function Search Path Mutable' as title,
     'WARN' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,

diff --git a/lints/0013_rls_disabled_in_public.sql b/lints/0013_rls_disabled_in_public.sql
@@ -2,6 +2,7 @@ create view lint."0013_rls_disabled_in_public" as
 
 select
     'rls_disabled_in_public' as name,
+    'RLS Disabled in Public' as title,
     'ERROR' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,

diff --git a/lints/0014_extension_in_public.sql b/lints/0014_extension_in_public.sql
@@ -2,6 +2,7 @@ create view lint."0014_extension_in_public" as
 
 select
     'extension_in_public' as name,
+    'Extension in Public' as title,
     'WARN' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,

diff --git a/lints/0015_rls_references_user_metadata.sql b/lints/0015_rls_references_user_metadata.sql
@@ -20,6 +20,7 @@ with policies as (
 )
 select
     'rls_references_user_metadata' as name,
+    'RLS references user metadata' as title,
     'ERROR' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,

diff --git a/lints/0016_materialized_view_in_api.sql b/lints/0016_materialized_view_in_api.sql
@@ -2,6 +2,7 @@ create view lint."0016_materialized_view_in_api" as
 
 select
     'materialized_view_in_api' as name,
+    'Materialized View in API' as title,
     'WARN' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,

diff --git a/splinter.json b/splinter.json
diff --git a/splinter.sql b/splinter.sql
@@ -34,6 +34,7 @@ index_ as (
 )
 select
     'unindexed_foreign_keys' as name,
+    'Unindexed foreign keys' as title,
     'INFO' as level,
     'EXTERNAL' as facing,
     array['PERFORMANCE'] as categories,
@@ -75,6 +76,7 @@ union all
 (
 select
     'auth_users_exposed' as name,
+    'Exposed Auth Users' as title,
     'ERROR' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,
@@ -191,6 +193,7 @@ with policies as (
 )
 select
     'auth_rls_initplan' as name,
+    'Auth RLS Initialization Plan' as title,
     'WARN' as level,
     'EXTERNAL' as facing,
     array['PERFORMANCE'] as categories,
@@ -254,6 +257,7 @@ union all
 (
 select
     'no_primary_key' as name,
+    'No Primary Key' as title,
     'INFO' as level,
     'EXTERNAL' as facing,
     array['PERFORMANCE'] as categories,
@@ -299,6 +303,7 @@ union all
 (
 select
     'unused_index' as name,
+    'Unused Index' as title,
     'INFO' as level,
     'EXTERNAL' as facing,
     array['PERFORMANCE'] as categories,
@@ -341,6 +346,7 @@ union all
 (
 select
     'multiple_permissive_policies' as name,
+    'Multiple Permissive Policies' as title,
     'WARN' as level,
     'EXTERNAL' as facing,
     array['PERFORMANCE'] as categories,
@@ -413,6 +419,7 @@ union all
 (
 select
     'policy_exists_rls_disabled' as name,
+    'Policy Exists RLS Disabled' as title,
     'ERROR' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,
@@ -458,6 +465,7 @@ union all
 (
 select
     'rls_enabled_no_policy' as name,
+    'RLS Enabled No Policy' as title,
     'INFO' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,
@@ -503,6 +511,7 @@ union all
 (
 select
     'duplicate_index' as name,
+    'Duplicate Index' as title,
     'WARN' as level,
     'EXTERNAL' as facing,
     array['PERFORMANCE'] as categories,
@@ -557,6 +566,7 @@ union all
 (
 select
     'security_definer_view' as name,
+    'Security Definer View' as title,
     'ERROR' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,
@@ -608,6 +618,7 @@ union all
 (
 select
     'function_search_path_mutable' as name,
+    'Function Search Path Mutable' as title,
     'WARN' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,
@@ -647,6 +658,7 @@ union all
 (
 select
     'rls_disabled_in_public' as name,
+    'RLS Disabled in Public' as title,
     'ERROR' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,
@@ -687,6 +699,7 @@ union all
 (
 select
     'extension_in_public' as name,
+    'Extension in Public' as title,
     'WARN' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,
@@ -738,6 +751,7 @@ with policies as (
 )
 select
     'rls_references_user_metadata' as name,
+    'RLS references user metadata' as title,
     'ERROR' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,
@@ -774,6 +788,7 @@ union all
 (
 select
     'materialized_view_in_api' as name,
+    'Materialized View in API' as title,
     'WARN' as level,
     'EXTERNAL' as facing,
     array['SECURITY'] as categories,

diff --git a/test/expected/0001_unindexed_foreign_keys.out b/test/expected/0001_unindexed_foreign_keys.out
@@ -11,16 +11,16 @@ begin;
         aaa_id int references public.aaa(id) -- no index
     );
     select * from lint."0001_unindexed_foreign_keys";
-          name          | level |  facing  |  categories   |                                             description                                             |                                                               detail                                                                |                                        remediation                                         |                                                 metadata                                                  |                     cache_key                     
-------------------------+-------+----------+---------------+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+---------------------------------------------------
- unindexed_foreign_keys | INFO  | EXTERNAL | {PERFORMANCE} | Identifies foreign key constraints without a covering index, which can impact database performance. | Table \`public.bbb\` has a foreign key \`bbb_aaa_id_fkey\` without a covering index. This can lead to suboptimal query performance. | https://supabase.com/docs/guides/database/database-linter?lint=0001_unindexed_foreign_keys | {"name": "bbb", "type": "table", "schema": "public", "fkey_name": "bbb_aaa_id_fkey", "fkey_columns": [2]} | unindexed_foreign_keys_public_bbb_bbb_aaa_id_fkey
+          name          |         title          | level |  facing  |  categories   |                                             description                                             |                                                               detail                                                                |                                        remediation                                         |                                                 metadata                                                  |                     cache_key                     
+------------------------+------------------------+-------+----------+---------------+-----------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------+---------------------------------------------------
+ unindexed_foreign_keys | Unindexed foreign keys | INFO  | EXTERNAL | {PERFORMANCE} | Identifies foreign key constraints without a covering index, which can impact database performance. | Table \`public.bbb\` has a foreign key \`bbb_aaa_id_fkey\` without a covering index. This can lead to suboptimal query performance. | https://supabase.com/docs/guides/database/database-linter?lint=0001_unindexed_foreign_keys | {"name": "bbb", "type": "table", "schema": "public", "fkey_name": "bbb_aaa_id_fkey", "fkey_columns": [2]} | unindexed_foreign_keys_public_bbb_bbb_aaa_id_fkey
 (1 row)
 
     -- When a covering index is created, the error goes away
     create index on public.bbb(aaa_id);
     select * from lint."0001_unindexed_foreign_keys";
- name | level | facing | categories | description | detail | remediation | metadata | cache_key 
-------+-------+--------+------------+-------------+--------+-------------+----------+-----------
+ name | title | level | facing | categories | description | detail | remediation | metadata | cache_key 
+------+-------+-------+--------+------------+-------------+--------+-------------+----------+-----------
 (0 rows)
 
     rollback to savepoint a;
@@ -38,25 +38,25 @@ begin;
         foreign key (foo, bar) references public.aaa(foo, bar)
     );
     select * from lint."0001_unindexed_foreign_keys";
-          name          | level |  facing  |  categories   |                                             description                                             |                                                                detail                                                                |                                        remediation                                         |                                                   metadata                                                    |                     cache_key                      
-------------------------+-------+----------+---------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------
- unindexed_foreign_keys | INFO  | EXTERNAL | {PERFORMANCE} | Identifies foreign key constraints without a covering index, which can impact database performance. | Table \`public.bbb\` has a foreign key \`bbb_foo_bar_fkey\` without a covering index. This can lead to suboptimal query performance. | https://supabase.com/docs/guides/database/database-linter?lint=0001_unindexed_foreign_keys | {"name": "bbb", "type": "table", "schema": "public", "fkey_name": "bbb_foo_bar_fkey", "fkey_columns": [2, 3]} | unindexed_foreign_keys_public_bbb_bbb_foo_bar_fkey
+          name          |         title          | level |  facing  |  categories   |                                             description                                             |                                                                detail                                                                |                                        remediation                                         |                                                   metadata                                                    |                     cache_key                      
+------------------------+------------------------+-------+----------+---------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------
+ unindexed_foreign_keys | Unindexed foreign keys | INFO  | EXTERNAL | {PERFORMANCE} | Identifies foreign key constraints without a covering index, which can impact database performance. | Table \`public.bbb\` has a foreign key \`bbb_foo_bar_fkey\` without a covering index. This can lead to suboptimal query performance. | https://supabase.com/docs/guides/database/database-linter?lint=0001_unindexed_foreign_keys | {"name": "bbb", "type": "table", "schema": "public", "fkey_name": "bbb_foo_bar_fkey", "fkey_columns": [2, 3]} | unindexed_foreign_keys_public_bbb_bbb_foo_bar_fkey
 (1 row)
 
     -- Confirm that an index on the correct columns but in the wrong order
     -- does NOT resolve the issue
     create index on public.bbb(bar, foo);
     select * from lint."0001_unindexed_foreign_keys";
-          name          | level |  facing  |  categories   |                                             description                                             |                                                                detail                                                                |                                        remediation                                         |                                                   metadata                                                    |                     cache_key                      
-------------------------+-------+----------+---------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------
- unindexed_foreign_keys | INFO  | EXTERNAL | {PERFORMANCE} | Identifies foreign key constraints without a covering index, which can impact database performance. | Table \`public.bbb\` has a foreign key \`bbb_foo_bar_fkey\` without a covering index. This can lead to suboptimal query performance. | https://supabase.com/docs/guides/database/database-linter?lint=0001_unindexed_foreign_keys | {"name": "bbb", "type": "table", "schema": "public", "fkey_name": "bbb_foo_bar_fkey", "fkey_columns": [2, 3]} | unindexed_foreign_keys_public_bbb_bbb_foo_bar_fkey
+          name          |         title          | level |  facing  |  categories   |                                             description                                             |                                                                detail                                                                |                                        remediation                                         |                                                   metadata                                                    |                     cache_key                      
+------------------------+------------------------+-------+----------+---------------+-----------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+----------------------------------------------------
+ unindexed_foreign_keys | Unindexed foreign keys | INFO  | EXTERNAL | {PERFORMANCE} | Identifies foreign key constraints without a covering index, which can impact database performance. | Table \`public.bbb\` has a foreign key \`bbb_foo_bar_fkey\` without a covering index. This can lead to suboptimal query performance. | https://supabase.com/docs/guides/database/database-linter?lint=0001_unindexed_foreign_keys | {"name": "bbb", "type": "table", "schema": "public", "fkey_name": "bbb_foo_bar_fkey", "fkey_columns": [2, 3]} | unindexed_foreign_keys_public_bbb_bbb_foo_bar_fkey
 (1 row)
 
     -- When we create a multi-column index in the correct order the issue is resolved
     create index on public.bbb(foo, bar);
     select * from lint."0001_unindexed_foreign_keys";
- name | level | facing | categories | description | detail | remediation | metadata | cache_key 
-------+-------+--------+------------+-------------+--------+-------------+----------+-----------
+ name | title | level | facing | categories | description | detail | remediation | metadata | cache_key 
+------+-------+-------+--------+------------+-------------+--------+-------------+----------+-----------
 (0 rows)
 
 rollback;