Fix OAuth2 userinfo request crash when endpoint is present but None

[dpage]

Summary

• OAuth2Authentication.get_user_profile() guarded the userinfo request with 'OAUTH2_USERINFO_ENDPOINT' not in self.oauth2_config[...], which tests key presence, not truthiness. config.py's shipped OAUTH2_CONFIG template entry ships 'OAUTH2_USERINFO_ENDPOINT': None, so a config copied from that template (as documented) has the key present with a None value — the check passes, and the code proceeds to call client.get(None), raising requests.exceptions.MissingSchema: Invalid URL 'None' instead of skipping the call (for an OIDC provider that supplies claims via ID token / discovery) or logging the intended "not configured" message.
• Changed the check to test truthiness (if not self.oauth2_config[...].get('OAUTH2_USERINFO_ENDPOINT')), so an explicit None is treated the same as an absent key.

Test plan

• Added web/pgadmin/authenticate/tests/test_oauth2_userinfo_endpoint.py, exercising get_user_profile() directly with a config carrying OAUTH2_USERINFO_ENDPOINT: None, asserting the userinfo client is never called.
• Confirmed the test fails against the pre-fix not in check and passes with the fix.
• pycodestyle clean on the changed/added files.

Closes #10349

Summary by CodeRabbit

• Bug Fixes

  • Improved OAuth2 authentication handling when the user information endpoint is missing or unavailable.
  • Prevented unnecessary requests to unavailable endpoints, returning an empty profile instead.

• Tests

  • Added regression coverage for OAuth2 configurations without a user information endpoint.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 5e40e68e-aa75-4716-9c3f-c17911e2377d

📥 Commits

Reviewing files that changed from the base of the PR and between bc58657 and 9f77a12.

📒 Files selected for processing (2)

• web/pgadmin/authenticate/oauth2.py
• web/pgadmin/authenticate/tests/test_oauth2_userinfo_endpoint.py

Included review availability: Your plan provides up to 8 included reviews per hour; 6 remain after this review.

---

Walkthrough

The OAuth2 profile lookup now treats a missing or falsy OAUTH2_USERINFO_ENDPOINT as unavailable. A regression test verifies that an explicit None value returns an empty profile without making an HTTP request.

Changes

OAuth2 user-info handling

Layer / File(s)	Summary
Guard unavailable endpoints and add regression coverage web/pgadmin/authenticate/oauth2.py, web/pgadmin/authenticate/tests/test_oauth2_userinfo_endpoint.py	The endpoint check now handles missing or falsy values. The regression test verifies that None returns {} without calling the HTTP client.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 11055

This PR prevents an invalid userinfo request when the endpoint is explicitly unset and adds coverage for that behavior; no actionable merge-blocking risk remains.

Suggested reviewers: asheshv

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 3 functions across 2 files.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly describes the OAuth2 crash caused by a userinfo endpoint set to None.
Linked Issues check	✅ Passed	The change satisfies issue #10349 by treating a missing or None OAUTH2_USERINFO_ENDPOINT as unconfigured and adding a regression test that confirms no HTTP request occurs.
Out of Scope Changes check	✅ Passed	All changes support issue #10349. The implementation change and regression test are directly related to the reported OAuth2 crash.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[asheshv]

Reviewed the fix — it's correct, and the security side checks out.

config.py:864 really does ship OAUTH2_USERINFO_ENDPOINT as None, so the old "is the key present?" check was asking the wrong question. Confirmed the key thing too: when the endpoint is missing or None, login is denied rather than let through. No path trusts an unverified claim. Before this fix the same paths crashed instead — ugly, but also safe. So no security regression either way.

One thing to fix, in the test rather than the code:

web/pgadmin/authenticate/tests/test_oauth2_userinfo_endpoint.py:32 — the test breaks when run on its own.
sys.modules['pgadmin.authenticate.oauth2'] assumes the module was already imported. Run the module by itself, the way the docs describe, and it blows up:

python regression/runtests.py --pkg authenticate --modules test_oauth2_userinfo_endpoint
→ ERROR: KeyError: 'pgadmin.authenticate.oauth2'
→ FAILED (errors=1)

It only passes today because running the whole authenticate package causes a neighbouring test to import the module first. Swapping the lookup for importlib.import_module('pgadmin.authenticate.oauth2') fixes it — that still returns the already-loaded module when there is one, so the re-import concern in the comment is preserved. Verified: isolated run passes, full package still 17 passing.

Minor, take or leave:

• :57-58 — the comment says the pre-fix failure was requests.exceptions.MissingSchema, but since mock_client is a MagicMock nothing actually raises; the real pre-fix failure is an AssertionError. The test proves the guard works, not that the crash happened. Worth rewording so the next reader isn't misled.
• oauth2.py:692 and :603 — exactly the same "key exists" vs "value is set" mistake for OAUTH2_LOGOUT_URL and OAUTH2_ADDITIONAL_CLAIMS, both also shipped as None. Not exploitable (guarded downstream), but it'd be nice to convert them in the same commit rather than leave the inconsistency behind.
• oauth2.py:745 — still uses a direct [...] lookup where the rest of the method uses .get(client, {}). Free consistency win.

[kundansable]

Tested on my local environment, functionality is working as expected.