supabase / supautils

89%

LAST BUILD ON BRANCH master

branch: SELECT

CHANGE BRANCH

x

Sync Branches

• No branch selected
• 140-bk
• 18beta1
• add-hint
• bench
• bs/clang-format
• bs/release-deb
• cache-lookup
• cassert
• chore/bump-xpg
• chore/ci
• chore/ci-again
• chore/ci-bundling
• chore/clang-format-macos-compat
• chore/macos-ci-pg-versions
• chore/readme-update-commands
• chore/upload-tar-xz
• compat16
• cov
• docs/supautils-prefix
• etienne/block-copy-program
• event_trigger_function_owner_check
• evtrig-test
• evtrigs-cont
• fix-docs
• fix-pgxs
• fix/handle-exceptions-during-su-switch
• fix/redefine-disable-program
• fix/run-custom-scripts-on-non-privileged-extensions
• immutable-check-constraint
• log-detail
• log-skipped
• macos
• make_superuser_boolean
• master
• module-magic-ext
• nickb/fix_supautils_hook
• nxpg-v2
• pgmq
• ref-alterowner
• ref-extensions
• ref1
• revert-disable-copy
• style-fix-macos
• superevtrigs
• test/custom-scripts-non-privileged-ext
• upgrade-github-actions-node24
• upgrade-github-actions-node24-general

Build # 23022592194

Build Type

push

github

Committed by web-flow

Commit Message

feat: add hint when GRANT privilege is missing (#178)

Whenever we hit an ERRCODE_INSUFFICIENT_PRIVILEGE, we give a hint for
the precise privilege missing for the current role.

Simple SELECT:

```sql
select from hint_target;
ERROR:  permission denied for table hint_target
HINT:  Grant the required privileges to the current role with: GRANT SELECT ON public.hint_target TO hint_role;
```

If multiple privileges are missing on an upsert:

```sql
insert into hint_target(id)
values (1)
on conflict (id) do update set id = excluded.id;
ERROR:  permission denied for table hint_target
HINT:  Grant the required privileges to the current role with: GRANT SELECT, INSERT, UPDATE ON public.hint_target TO hint_role;
```

NOTES:

- This is done by adding an ExecutorStart_hook which only purpose is to
  catch the ERRCODE_INSUFFICIENT_PRIVILEGE error and override the empty
  privilege.
- Also adds a loadtest for a simple select to ensure the perf loss is not great (the impact is around 1-2%, mostly due to the `is_hint_role` check)
- Hints for views under pg 18 are not working and left as TODO, hints for views on all the previous versions work normally

Run Details

92 of 101 new or added lines in 2 files covered. (91.09%)

1 existing line in 1 file now uncovered.

1102 of 1243 relevant lines covered (88.66%)

31.94 hits per line