Re: [oauth] Stabilize the libpq-oauth ABI (and allow alternative implementations?)

From: Jacob Champion <jacob(dot)champion(at)enterprisedb(dot)com>
To: Chao Li <li(dot)evan(dot)chao(at)gmail(dot)com>
Cc: PostgreSQL Hackers <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: [oauth] Stabilize the libpq-oauth ABI (and allow alternative implementations?)
Date: 2025-12-16 17:40:44
Message-ID: CAOYmi+mwzS4xfgomL1Lte+W1hRk+zahhZLnRMDJ8nYxoHUWt_w@mail.gmail.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Thu, Dec 11, 2025 at 11:43 PM Chao Li <li(dot)evan(dot)chao(at)gmail(dot)com> wrote:
> This is a solid patch set. Only a few small comments:

Thanks for the review!

> The commit message has explained why SOCKTYPE is temporary and the reason why adding prefix “PG_” is to avoid collisions. But I don’t think code readers will always read commit messages, given the macro is a local and temporary, why adding a prefix starting with a underscore, like “_PQ_SOCKTYPE”, which explicitly indicates the macro is kinda private.

_PQ_SOCKTYPE is reserved (starts with _P), but I could add more
explanatory comments if you think that'd be useful. See v2-0001, which
now includes an explanation of the signature in the documentation.

The hard part is that I don't want to require all Windows clients of
libpq-fe.h to have to depend on Winsock; that's the only reason for
this oddity. Otherwise I'd declare PGsocket as the public version of
our internal pgsocket and call it a day.

> + * Helper for handling user flow failures. If the implementation put anything
> + * into request->error, it's added to conn->errorMessage here.
> ```
>
> Typo: put -> puts

Past tense was my intent, but I've reworded to avoid any garden paths:
"If anything was put into request->error, it's added to
conn->errorMessage here."

> “*/“ in the end of the comment line seems a typo.

Thanks, no idea why I did that.

> "(prefer v2, below, instead)" looks confusing to me, though I can understand what it means. Maybe make it clearer, like “(v2 is preferred; see below)"

Done.

--

v2 makes these changes and rebases over latest HEAD. I'll plan to get
0001-3 in this week; probably tomorrow.

Open questions remain:
1) 0004: Any objections to putting PQExpBuffer into libpq-fe.h?
2) 0004: Thoughts on the v2 inheritance struct style as opposed to
relying on implementations to double-check the struct length?
3) 0005: Should I add the thread lock to an init() API, or expose a
new PQgetThreadLock() that other code can use?
4) 0007: [all of it]

My personal thoughts on these:
1) it's fine
2) it's a coin flip for me; inheritance is ugly, length magic is scary
3) I like the idea of PQgetThreadLock() so that we don't have to
inject it everywhere it could possibly be needed

Thanks,
--Jacob

Attachment Content-Type Size
since-v1.diff.txt text/plain 11.2 KB
v2-0001-libpq-fe.h-Don-t-claim-SOCKTYPE-in-the-global-nam.patch application/octet-stream 4.6 KB
v2-0002-libpq-oauth-use-correct-c_args-in-meson.build.patch application/octet-stream 1.3 KB
v2-0003-oauth_validator-Avoid-races-in-log_check.patch application/octet-stream 3.2 KB
v2-0004-libpq-Introduce-PQAUTHDATA_OAUTH_BEARER_TOKEN_V2.patch application/octet-stream 25.2 KB
v2-0005-libpq-oauth-Use-the-PGoauthBearerRequestV2-API.patch application/octet-stream 44.1 KB
v2-0006-libpq-oauth-Never-link-against-libpq-s-encoding-f.patch application/octet-stream 3.1 KB
v2-0007-WIP-Introduce-third-party-OAuth-flow-plugins.patch application/octet-stream 36.1 KB

In response to

Browse pgsql-hackers by date

  From Date Subject
Next Message Andres Freund 2025-12-16 17:45:17 Re: Replace is_publishable_class() with relispublishable column in pg_class
Previous Message Robert Haas 2025-12-16 17:32:22 Re: Parallel query: Use TopTransactionContext for ReinitializeParallelDSM()