Skip to content

Commit

Permalink
fix: Breaking change in MachineAuthProvider constructor (#25532)
Browse files Browse the repository at this point in the history
  • Loading branch information
kgabryje committed Oct 11, 2023
1 parent 050543a commit cef68f8
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
1 change: 0 additions & 1 deletion superset/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -1355,7 +1355,6 @@ def EMAIL_HEADER_MUTATOR( # pylint: disable=invalid-name,unused-argument
# webdriver (when using Selenium) or browser context (when using Playwright - see
# PLAYWRIGHT_REPORTS_AND_THUMBNAILS feature flag)
WEBDRIVER_AUTH_FUNC = None
BROWSER_CONTEXT_AUTH_FUNC = None

# Any config options to be passed as-is to the webdriver
WEBDRIVER_CONFIGURATION: dict[Any, Any] = {"service_log_path": "/dev/null"}
Expand Down
17 changes: 9 additions & 8 deletions superset/utils/machine_auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,16 @@
class MachineAuthProvider:
def __init__(
self,
auth_webdriver_func_override: Callable[[WebDriver, User], WebDriver],
auth_context_func_override: Callable[[BrowserContext, User], BrowserContext],
auth_webdriver_func_override: Callable[
[WebDriver | BrowserContext, User], WebDriver | BrowserContext
]
| None = None,
):
# This is here in order to allow for the authenticate_webdriver
# or authenticate_browser_context (if PLAYWRIGHT_REPORTS_AND_THUMBNAILS is
# enabled) func to be overridden via config, as opposed to the entire
# provider implementation
self._auth_webdriver_func_override = auth_webdriver_func_override
self._auth_context_func_override = auth_context_func_override

def authenticate_webdriver(
self,
Expand All @@ -63,7 +64,7 @@ def authenticate_webdriver(
:return: The WebDriver passed in (fluent)
"""
# Short-circuit this method if we have an override configured
if self._auth_webdriver_func_override: # type: ignore
if self._auth_webdriver_func_override:
return self._auth_webdriver_func_override(driver, user)

# Setting cookies requires doing a request first
Expand All @@ -82,8 +83,8 @@ def authenticate_browser_context(
user: User,
) -> BrowserContext:
# Short-circuit this method if we have an override configured
if self._auth_context_func_override: # type: ignore
return self._auth_context_func_override(browser_context, user)
if self._auth_webdriver_func_override:
return self._auth_webdriver_func_override(browser_context, user)

url = urlparse(current_app.config["WEBDRIVER_BASEURL"])

Expand Down Expand Up @@ -145,12 +146,12 @@ def get_auth_cookies(user: User) -> dict[str, str]:

class MachineAuthProviderFactory:
def __init__(self) -> None:
self._auth_provider = None
self._auth_provider: MachineAuthProvider | None = None

def init_app(self, app: Flask) -> None:
self._auth_provider = load_class_from_name(
app.config["MACHINE_AUTH_PROVIDER_CLASS"]
)(app.config["WEBDRIVER_AUTH_FUNC"], app.config["BROWSER_CONTEXT_AUTH_FUNC"])
)(app.config["WEBDRIVER_AUTH_FUNC"])

@property
def instance(self) -> MachineAuthProvider:
Expand Down

0 comments on commit cef68f8

Please sign in to comment.