-
Notifications
You must be signed in to change notification settings - Fork 7
Switch SiS demo to OAuth session token auth #63
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
j-seuren
wants to merge
5
commits into
JetBrains:main
from
j-seuren:j-seuren/sis-oauth-session-token-auth
Closed
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
b205799
Switch SiS demo to OAuth session token auth
j-seuren aff4c77
Move imports to top of file in app.py
j-seuren 6f9132a
Add externalbrowser auth default for local dev
j-seuren a770004
Hide API key value from UI when provided via environment variable
j-seuren 3dd583e
Patch DuckDB Snowflake adapter for SiS OAuth and add SNOWFLAKE_HOST
j-seuren File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5 changes: 2 additions & 3 deletions
5
examples/demo-snowflake-project/databao/domains/root/src/snowflake.yaml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,8 @@ | ||
| type: snowflake | ||
| name: snowflake | ||
| connection: | ||
| account: {{ env_var('SNOWFLAKE_DS_ACCOUNT') }} | ||
| account: {{ env_var('SNOWFLAKE_ACCOUNT') }} | ||
| warehouse: {{ env_var('SNOWFLAKE_DS_WAREHOUSE') }} | ||
| database: {{ env_var('SNOWFLAKE_DS_DATABASE') }} | ||
| user: {{ env_var('SNOWFLAKE_DS_USER') }} | ||
| auth: | ||
| password: {{ env_var('SNOWFLAKE_DS_PASSWORD') }} | ||
| authenticator: externalbrowser |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,9 +2,16 @@ | |
| import logging | ||
| import os | ||
| import sys | ||
| from collections.abc import Generator | ||
| from contextlib import contextmanager | ||
| from pathlib import Path | ||
| from typing import Any | ||
|
|
||
| import snowflake.connector | ||
| import streamlit as st | ||
| from databao_context_engine.plugins.databases.snowflake.snowflake_introspector import ( | ||
| SnowflakeIntrospector, | ||
| ) | ||
|
|
||
| from databao_cli.ui.app import main | ||
|
|
||
|
|
@@ -13,18 +20,17 @@ | |
| SNOWFLAKE_SECRETS: dict[str, str] = { | ||
| "openai_api_key": "OPENAI_API_KEY", | ||
| "anthropic_api_key": "ANTHROPIC_API_KEY", | ||
| "snowflake_ds_account": "SNOWFLAKE_DS_ACCOUNT", | ||
| "snowflake_ds_warehouse": "SNOWFLAKE_DS_WAREHOUSE", | ||
| "snowflake_ds_database": "SNOWFLAKE_DS_DATABASE", | ||
| "snowflake_ds_user": "SNOWFLAKE_DS_USER", | ||
| "snowflake_ds_password": "SNOWFLAKE_DS_PASSWORD", | ||
| } | ||
|
|
||
| SESSION_TOKEN_PATH = Path("/snowflake/session/token") | ||
|
|
||
| ADBC_LIB = "libadbc_driver_snowflake.so" | ||
|
|
||
|
|
||
| def _is_running_in_snowflake() -> bool: | ||
| return Path("/snowflake/session/token").exists() | ||
| return SESSION_TOKEN_PATH.exists() | ||
|
|
||
|
|
||
| def _ensure_adbc_driver() -> None: | ||
|
|
@@ -72,9 +78,46 @@ def _load_snowflake_secrets() -> None: | |
| logger.warning("Failed to load secret '%s'", secret_name, exc_info=True) | ||
|
|
||
|
|
||
| def _patch_snowflake_introspector_for_sis() -> None: | ||
| """Monkey-patch SnowflakeIntrospector._connect for Streamlit-in-Snowflake (SiS). | ||
|
|
||
| In SiS, the runtime maintains an OAuth session token at | ||
| /snowflake/session/token. We re-read it on every connection to avoid expiry | ||
| (tokens are valid ~1 hour, the file refreshes every few minutes). | ||
|
|
||
| DCE's _connect must return a context manager because BaseIntrospector uses | ||
| ``with self._connect(file_config) as conn:``. | ||
| """ | ||
| @contextmanager | ||
| def _sis_connect(self: Any, file_config: Any, *, catalog: str | None = None) -> Generator[Any, None, None]: | ||
| token = SESSION_TOKEN_PATH.read_text().strip() | ||
| snowflake.connector.paramstyle = "qmark" | ||
| kwargs = file_config.connection.to_snowflake_kwargs() | ||
|
Comment on lines
+117
to
+118
|
||
| # Replace any existing auth params with OAuth token | ||
| kwargs.pop("password", None) | ||
| kwargs.pop("private_key", None) | ||
| kwargs.pop("private_key_file", None) | ||
| kwargs.pop("private_key_file_pwd", None) | ||
| kwargs.pop("authenticator", None) | ||
| kwargs.pop("token", None) | ||
| kwargs["authenticator"] = "oauth" | ||
| kwargs["token"] = token | ||
| if catalog: | ||
| kwargs["database"] = catalog | ||
| conn = snowflake.connector.connect(**kwargs) | ||
| try: | ||
| yield conn | ||
| finally: | ||
| conn.close() | ||
|
|
||
| SnowflakeIntrospector._connect = _sis_connect # type: ignore[assignment] | ||
| logger.info("Patched SnowflakeIntrospector._connect for SiS OAuth token auth") | ||
|
Comment on lines
+139
to
+140
|
||
|
|
||
|
|
||
| _ensure_adbc_driver() | ||
| if _is_running_in_snowflake(): | ||
| _load_snowflake_secrets() | ||
| _patch_snowflake_introspector_for_sis() | ||
|
|
||
| if "--project-dir" not in sys.argv: | ||
| sys.argv.extend(["--project-dir", "examples/demo-snowflake-project"]) | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
SESSION_TOKEN_PATH.read_text().strip()can raise (e.g., transient file-not-found/permission issues) and can also produce an empty token; either case will currently bubble up as a low-level exception or a confusing connector auth failure. Consider catchingOSError/decode errors, validating the token is non-empty, and raising/logging a clear message that the SiS OAuth session token could not be read from/snowflake/session/token.