apache-airflow-providers-fab 2.4.4rc1__py3-none-any.whl → 3.0.0__py3-none-any.whl

airflow/providers/fab/auth_manager/views/user.py

@@ -24,7 +24,6 @@ from flask_appbuilder.security.views import (
     UserDBModelView,
     UserLDAPModelView,
     UserOAuthModelView,
-    UserOIDModelView,
     UserRemoteUserModelView,
 )
 
@@ -122,10 +121,6 @@ class CustomUserOAuthModelView(MultiResourceUserMixin, UserOAuthModelView):
     """Customize permission names for FAB's builtin UserOAuthModelView."""
 
 
-class CustomUserOIDModelView(MultiResourceUserMixin, UserOIDModelView):
-    """Customize permission names for FAB's builtin UserOIDModelView."""
-
-
 class CustomUserRemoteUserModelView(MultiResourceUserMixin, UserRemoteUserModelView):
     """Customize permission names for FAB's builtin UserRemoteUserModelView."""
 
@@ -180,6 +175,17 @@ class CustomUserDBModelView(MultiResourceUserMixin, UserDBModelView):
         "userinfoedit": "read",
     }
 
+    add_columns = [
+        "first_name",
+        "last_name",
+        "username",
+        "active",
+        "email",
+        "roles",
+        "password",
+        "conf_password",
+    ]
+
     base_permissions = [
         permissions.ACTION_CAN_CREATE,
         permissions.ACTION_CAN_READ,

airflow/providers/fab/migrations/versions/0001_1_4_0_create_ab_tables_if_missing.py

@@ -121,6 +121,7 @@ def upgrade() -> None:
         sa.Column("name", sa.String(length=250), nullable=False),
         sa.PrimaryKeyConstraint("id", name=op.f("ab_view_menu_pkey")),
         sa.UniqueConstraint("name", name=op.f("ab_view_menu_name_uq")),
+        if_not_exists=True,
     )
     op.create_table(
         "ab_group_role",
@@ -138,8 +139,8 @@ def upgrade() -> None:
         if_not_exists=True,
     )
     with op.batch_alter_table("ab_group_role", schema=None) as batch_op:
-        batch_op.create_index("idx_group_id", ["group_id"], unique=False)
-        batch_op.create_index("idx_group_role_id", ["role_id"], unique=False)
+        batch_op.create_index("idx_group_id", ["group_id"], unique=False, if_not_exists=True)
+        batch_op.create_index("idx_group_role_id", ["role_id"], unique=False, if_not_exists=True)
 
     op.create_table(
         "ab_permission_view",
@@ -174,8 +175,8 @@ def upgrade() -> None:
         if_not_exists=True,
     )
     with op.batch_alter_table("ab_user_group", schema=None) as batch_op:
-        batch_op.create_index("idx_user_group_id", ["group_id"], unique=False)
-        batch_op.create_index("idx_user_id", ["user_id"], unique=False)
+        batch_op.create_index("idx_user_group_id", ["group_id"], unique=False, if_not_exists=True)
+        batch_op.create_index("idx_user_id", ["user_id"], unique=False, if_not_exists=True)
 
     op.create_table(
         "ab_user_role",

airflow/providers/fab/www/app.py

@@ -21,7 +21,7 @@ from datetime import timedelta
 from os.path import isabs
 
 from flask import Flask
-from flask_appbuilder import SQLA
+from flask_sqlalchemy import SQLAlchemy
 from flask_wtf.csrf import CSRFProtect
 from sqlalchemy.engine.url import make_url
 
@@ -84,9 +84,8 @@ def create_app(enable_plugins: bool):
 
     csrf.init_app(flask_app)
 
-    db = SQLA()
+    db = SQLAlchemy(flask_app)
     db.session = settings.Session
-    db.init_app(flask_app)
 
     configure_logging()
     configure_manifest_files(flask_app)
@@ -107,8 +106,8 @@ def create_app(enable_plugins: bool):
         elif isinstance(get_auth_manager(), FabAuthManager):
             init_api_auth_provider(flask_app)
             init_api_error_handlers(flask_app)
+            init_airflow_session_interface(flask_app, db)
         init_jinja_globals(flask_app, enable_plugins=enable_plugins)
-        init_airflow_session_interface(flask_app)
         init_wsgi_middleware(flask_app)
     return flask_app
 

airflow/providers/fab/www/extensions/init_appbuilder.py

@@ -80,8 +80,6 @@ class AirflowAppBuilder:
     """This is the base class for all the framework."""
 
     baseviews: list[BaseView | Session] = []
-    # Flask app
-    app = None
     # Database Session
     session = None
     # Security Manager Class
@@ -149,7 +147,6 @@ class AirflowAppBuilder:
         self.indexview = indexview
         self.static_folder = static_folder
         self.static_url_path = static_url_path
-        self.app = app
         self.enable_plugins = enable_plugins
         self.update_perms = conf.getboolean("fab", "UPDATE_FAB_PERMS")
         self.auth_rate_limited = conf.getboolean("fab", "AUTH_RATE_LIMITED")
@@ -164,6 +161,7 @@ class AirflowAppBuilder:
         :param app:
         :param session: The SQLAlchemy session
         """
+        log.info("Initializing AppBuilder")
         app.config.setdefault("APP_NAME", "F.A.B.")
         app.config.setdefault("APP_THEME", "")
         app.config.setdefault("APP_ICON", "")
@@ -176,8 +174,6 @@ class AirflowAppBuilder:
         app.config.setdefault("AUTH_RATE_LIMITED", self.auth_rate_limited)
         app.config.setdefault("AUTH_RATE_LIMIT", self.auth_rate_limit)
 
-        self.app = app
-
         self.base_template = app.config.get("FAB_BASE_TEMPLATE", self.base_template)
         self.static_folder = app.config.get("FAB_STATIC_FOLDER", self.static_folder)
         self.static_url_path = app.config.get("FAB_STATIC_URL_PATH", self.static_url_path)
@@ -228,24 +224,19 @@ class AirflowAppBuilder:
         app.extensions["appbuilder"] = self
 
     @property
-    def get_app(self):
-        """
-        Get current or configured flask app.
-
-        :return: Flask App
-        """
-        if self.app:
-            return self.app
+    def app(self) -> Flask:
+        log.warning(
+            "appbuilder.app is deprecated and will be removed in a future version. Use current_app instead"
+        )
         return current_app
 
     @property
-    def get_session(self):
-        """
-        Get the current sqlalchemy session.
-
-        :return: SQLAlchemy Session
-        """
-        return self.session
+    def get_app(self) -> Flask:
+        log.warning(
+            "appbuilder.get_app is deprecated and will be removed in a future version. "
+            "Use current_app instead"
+        )
+        return self.app
 
     @property
     def app_name(self):
@@ -254,7 +245,7 @@ class AirflowAppBuilder:
 
         :return: String with app name
         """
-        return self.get_app.config["APP_NAME"]
+        return current_app.config["APP_NAME"]
 
     @property
     def app_theme(self):
@@ -263,7 +254,7 @@ class AirflowAppBuilder:
 
         :return: String app theme name
         """
-        return self.get_app.config["APP_THEME"]
+        return current_app.config["APP_THEME"]
 
     @property
     def app_icon(self):
@@ -272,11 +263,11 @@ class AirflowAppBuilder:
 
         :return: String with relative app icon location
         """
-        return self.get_app.config["APP_ICON"]
+        return current_app.config["APP_ICON"]
 
     @property
     def languages(self):
-        return self.get_app.config["LANGUAGES"]
+        return current_app.config["LANGUAGES"]
 
     @property
     def version(self):
@@ -288,7 +279,7 @@ class AirflowAppBuilder:
         return __version__
 
     def _add_global_filters(self):
-        self.template_filters = TemplateFilters(self.get_app, self.sm)
+        self.template_filters = TemplateFilters(current_app, self.sm)
 
     def _add_global_static(self):
         bp = Blueprint(
@@ -299,7 +290,7 @@ class AirflowAppBuilder:
             static_folder=self.static_folder,
             static_url_path=self.static_url_path,
         )
-        self.get_app.register_blueprint(bp)
+        current_app.register_blueprint(bp)
 
     def _add_admin_views(self):
         """Register indexview, utilview (back function), babel views and Security views."""
@@ -328,8 +319,6 @@ class AirflowAppBuilder:
                     log.error(LOGMSG_ERR_FAB_ADDON_PROCESS, addon, e)
 
     def _check_and_init(self, baseview):
-        if hasattr(baseview, "datamodel"):
-            baseview.datamodel.session = self.session
         if callable(baseview):
             baseview = baseview()
         return baseview
@@ -409,16 +398,15 @@ class AirflowAppBuilder:
             appbuilder.add_link("google", href="www.google.com", icon="fa-google-plus")
         """
         baseview = self._check_and_init(baseview)
-        log.info(LOGMSG_INF_FAB_ADD_VIEW, baseview.__class__.__name__, name)
+        log.debug(LOGMSG_INF_FAB_ADD_VIEW, baseview.__class__.__name__, name)
 
         if not self._view_exists(baseview):
             baseview.appbuilder = self
             self.baseviews.append(baseview)
             self._process_inner_views()
-            if self.app:
-                self.register_blueprint(baseview)
-                self._add_permission(baseview)
-                self.add_limits(baseview)
+            self.register_blueprint(baseview)
+            self._add_permission(baseview)
+            self.add_limits(baseview)
         self.add_link(
             name=name,
             href=href,
@@ -512,15 +500,14 @@ class AirflowAppBuilder:
         :param baseview: A BaseView type class instantiated.
         """
         baseview = self._check_and_init(baseview)
-        log.info(LOGMSG_INF_FAB_ADD_VIEW, baseview.__class__.__name__, "")
+        log.debug(LOGMSG_INF_FAB_ADD_VIEW, baseview.__class__.__name__, "")
 
         if not self._view_exists(baseview):
             baseview.appbuilder = self
             self.baseviews.append(baseview)
             self._process_inner_views()
-            if self.app:
-                self.register_blueprint(baseview, endpoint=endpoint, static_folder=static_folder)
-                self._add_permission(baseview)
+            self.register_blueprint(baseview, endpoint=endpoint, static_folder=static_folder)
+            self._add_permission(baseview)
         else:
             log.warning(LOGMSG_WAR_FAB_VIEW_EXISTS, baseview.__class__.__name__)
         return baseview
@@ -588,7 +575,7 @@ class AirflowAppBuilder:
                         self._add_permissions_menu(item.name, update_perms=update_perms)
 
     def register_blueprint(self, baseview, endpoint=None, static_folder=None):
-        self.get_app.register_blueprint(
+        current_app.register_blueprint(
             baseview.create_blueprint(self, endpoint=endpoint, static_folder=static_folder)
         )
 
@@ -607,7 +594,7 @@ def init_appbuilder(app: Flask, enable_plugins: bool) -> AirflowAppBuilder:
     """Init `Flask App Builder <https://flask-appbuilder.readthedocs.io/en/latest/>`__."""
     return AirflowAppBuilder(
         app=app,
-        session=settings.Session,
+        session=settings.Session(),
         base_template="airflow/main.html",
         enable_plugins=enable_plugins,
     )

airflow/providers/fab/www/extensions/init_session.py

@@ -26,7 +26,7 @@ from airflow.providers.fab.www.session import (
 )
 
 
-def init_airflow_session_interface(app):
+def init_airflow_session_interface(app, db):
     """Set airflow session interface."""
     config = app.config.copy()
     selected_backend = conf.get("fab", "SESSION_BACKEND")
@@ -47,7 +47,7 @@ def init_airflow_session_interface(app):
     elif selected_backend == "database":
         app.session_interface = AirflowDatabaseSessionInterface(
             app=app,
-            db=None,
+            client=db,
             permanent=permanent_cookie,
             # Typically these would be configurable with Flask-Session,
             # but we will set them explicitly instead as they don't make

airflow/providers/fab/www/security_appless.py

@@ -34,7 +34,7 @@ class FakeAppBuilder:
     """
 
     def __init__(self, session: Session | None = None) -> None:
-        self.get_session = session
+        self.session = session
 
 
 class ApplessAirflowSecurityManager(FabAirflowSecurityManagerOverride):
@@ -42,3 +42,8 @@ class ApplessAirflowSecurityManager(FabAirflowSecurityManagerOverride):
 
     def __init__(self, session: Session | None = None):
         self.appbuilder = FakeAppBuilder(session)
+        self._session = session
+
+    @property
+    def session(self):
+        return self._session

airflow/providers/fab/www/security_manager.py

@@ -18,12 +18,12 @@ from __future__ import annotations
 
 from collections.abc import Callable
 
-from flask import g
+from flask import current_app, g
 from flask_limiter import Limiter
 from flask_limiter.util import get_remote_address
 
 from airflow.api_fastapi.app import get_auth_manager
-from airflow.providers.fab.www.utils import CustomSQLAInterface, get_method_from_fab_action_map
+from airflow.providers.fab.www.utils import get_method_from_fab_action_map
 from airflow.utils.log.logging_mixin import LoggingMixin
 
 EXISTING_ROLES = {
@@ -50,15 +50,6 @@ class AirflowSecurityManagerV2(LoggingMixin):
         # Setup Flask-Limiter
         self.limiter = self.create_limiter()
 
-        # Go and fix up the SQLAInterface used from the stock one to our subclass.
-        # This is needed to support the "hack" where we had to edit
-        # FieldConverter.conversion_table in place in utils
-        for attr in dir(self):
-            if attr.endswith("view"):
-                view = getattr(self, attr, None)
-                if view and getattr(view, "datamodel", None):
-                    view.datamodel = CustomSQLAInterface(view.datamodel.obj)
-
     @staticmethod
     def before_request():
         """Run hook before request."""
@@ -66,9 +57,8 @@ class AirflowSecurityManagerV2(LoggingMixin):
             g.user = get_auth_manager().get_user()
 
     def create_limiter(self) -> Limiter:
-        app = self.appbuilder.get_app
-        limiter = Limiter(key_func=app.config.get("RATELIMIT_KEY_FUNC", get_remote_address))
-        limiter.init_app(app)
+        limiter = Limiter(key_func=current_app.config.get("RATELIMIT_KEY_FUNC", get_remote_address))
+        limiter.init_app(current_app)
         return limiter
 
     def has_access(

airflow/providers/fab/www/session.py

@@ -16,18 +16,41 @@
 # under the License.
 from __future__ import annotations
 
+import msgspec
 from flask import request
 from flask.sessions import SecureCookieSessionInterface
-from flask_session.sessions import SqlAlchemySessionInterface
+from flask_babel import LazyString
+from flask_session.sqlalchemy import SqlAlchemySessionInterface
+
+
+class _LazySafeSerializer:
+    def encode(self, session_dict):
+        encoder = msgspec.msgpack.Encoder(
+            enc_hook=lambda obj: str(obj) if isinstance(obj, LazyString) else obj
+        )
+
+        return encoder.encode(dict(session_dict))
+
+    def decode(self, data):
+        decoder = msgspec.msgpack.Decoder()
+
+        return decoder.decode(data)
+
+    def _default(self, obj):
+        if isinstance(obj, LazyString):
+            return str(obj)
+        raise TypeError(f"Unsupported type: {type(obj)}")
 
 
 class SessionExemptMixin:
     """Exempt certain blueprints/paths from autogenerated sessions."""
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.serializer = _LazySafeSerializer()
+
     def save_session(self, *args, **kwargs):
         """Prevent creating session from REST API and health requests."""
-        if request.blueprint == "/api/v1":
-            return None
         if request.path == "/health":
             return None
         return super().save_session(*args, **kwargs)

airflow/providers/fab/www/utils.py

@@ -18,15 +18,7 @@
 from __future__ import annotations
 
 import logging
-from typing import TYPE_CHECKING, Any
-
-from flask_appbuilder.models.filters import BaseFilter
-from flask_appbuilder.models.sqla import filters as fab_sqlafilters
-from flask_appbuilder.models.sqla.filters import get_field_setup_query, set_value_to_type
-from flask_appbuilder.models.sqla.interface import SQLAInterface
-from flask_babel import lazy_gettext
-from sqlalchemy import types
-from sqlalchemy.ext.associationproxy import AssociationProxy
+from typing import TYPE_CHECKING
 
 from airflow.api_fastapi.app import get_auth_manager
 from airflow.configuration import conf
@@ -37,11 +29,8 @@ from airflow.providers.fab.www.security.permissions import (
     ACTION_CAN_EDIT,
     ACTION_CAN_READ,
 )
-from airflow.utils import timezone
 
 if TYPE_CHECKING:
-    from sqlalchemy.orm.session import Session
-
     try:
         from airflow.api_fastapi.auth.managers.base_auth_manager import ExtendedResourceMethod
     except ImportError:
@@ -95,199 +84,3 @@ def get_method_from_fab_action_map():
     return {
         **{v: k for k, v in _MAP_METHOD_NAME_TO_FAB_ACTION_NAME.items()},
     }
-
-
-class UtcAwareFilterMixin:
-    """Mixin for filter for UTC time."""
-
-    def apply(self, query, value):
-        """Apply the filter."""
-        if isinstance(value, str) and not value.strip():
-            value = None
-        else:
-            value = timezone.parse(value, timezone=timezone.utc)
-
-        return super().apply(query, value)
-
-
-class FilterIsNull(BaseFilter):
-    """Is null filter."""
-
-    name = lazy_gettext("Is Null")
-    arg_name = "emp"
-
-    def apply(self, query, value):
-        query, field = get_field_setup_query(query, self.model, self.column_name)
-        value = set_value_to_type(self.datamodel, self.column_name, None)
-        return query.filter(field == value)
-
-
-class FilterIsNotNull(BaseFilter):
-    """Is not null filter."""
-
-    name = lazy_gettext("Is not Null")
-    arg_name = "nemp"
-
-    def apply(self, query, value):
-        query, field = get_field_setup_query(query, self.model, self.column_name)
-        value = set_value_to_type(self.datamodel, self.column_name, None)
-        return query.filter(field != value)
-
-
-class FilterGreaterOrEqual(BaseFilter):
-    """Greater than or Equal filter."""
-
-    name = lazy_gettext("Greater than or Equal")
-    arg_name = "gte"
-
-    def apply(self, query, value):
-        query, field = get_field_setup_query(query, self.model, self.column_name)
-        value = set_value_to_type(self.datamodel, self.column_name, value)
-
-        if value is None:
-            return query
-
-        return query.filter(field >= value)
-
-
-class FilterSmallerOrEqual(BaseFilter):
-    """Smaller than or Equal filter."""
-
-    name = lazy_gettext("Smaller than or Equal")
-    arg_name = "lte"
-
-    def apply(self, query, value):
-        query, field = get_field_setup_query(query, self.model, self.column_name)
-        value = set_value_to_type(self.datamodel, self.column_name, value)
-
-        if value is None:
-            return query
-
-        return query.filter(field <= value)
-
-
-class UtcAwareFilterSmallerOrEqual(UtcAwareFilterMixin, FilterSmallerOrEqual):
-    """Smaller than or Equal filter for UTC time."""
-
-
-class UtcAwareFilterGreaterOrEqual(UtcAwareFilterMixin, FilterGreaterOrEqual):
-    """Greater than or Equal filter for UTC time."""
-
-
-class UtcAwareFilterEqual(UtcAwareFilterMixin, fab_sqlafilters.FilterEqual):
-    """Equality filter for UTC time."""
-
-
-class UtcAwareFilterGreater(UtcAwareFilterMixin, fab_sqlafilters.FilterGreater):
-    """Greater Than filter for UTC time."""
-
-
-class UtcAwareFilterSmaller(UtcAwareFilterMixin, fab_sqlafilters.FilterSmaller):
-    """Smaller Than filter for UTC time."""
-
-
-class UtcAwareFilterNotEqual(UtcAwareFilterMixin, fab_sqlafilters.FilterNotEqual):
-    """Not Equal To filter for UTC time."""
-
-
-class AirflowFilterConverter(fab_sqlafilters.SQLAFilterConverter):
-    """Retrieve conversion tables for Airflow-specific filters."""
-
-    conversion_table = (
-        (
-            "is_utcdatetime",
-            [
-                UtcAwareFilterEqual,
-                UtcAwareFilterGreater,
-                UtcAwareFilterSmaller,
-                UtcAwareFilterNotEqual,
-                UtcAwareFilterSmallerOrEqual,
-                UtcAwareFilterGreaterOrEqual,
-            ],
-        ),
-        # FAB will try to create filters for extendedjson fields even though we
-        # exclude them from all UI, so we add this here to make it ignore them.
-        ("is_extendedjson", []),
-        ("is_json", []),
-        *fab_sqlafilters.SQLAFilterConverter.conversion_table,
-    )
-
-    def __init__(self, datamodel):
-        super().__init__(datamodel)
-
-        for _, filters in self.conversion_table:
-            if FilterIsNull not in filters:
-                filters.append(FilterIsNull)
-            if FilterIsNotNull not in filters:
-                filters.append(FilterIsNotNull)
-
-
-class CustomSQLAInterface(SQLAInterface):
-    """
-    FAB does not know how to handle columns with leading underscores because they are not supported by WTForm.
-
-    This hack will remove the leading '_' from the key to lookup the column names.
-    """
-
-    def __init__(self, obj, session: Session | None = None):
-        super().__init__(obj, session=session)
-
-        def clean_column_names():
-            if self.list_properties:
-                self.list_properties = {k.lstrip("_"): v for k, v in self.list_properties.items()}
-            if self.list_columns:
-                self.list_columns = {k.lstrip("_"): v for k, v in self.list_columns.items()}
-
-        clean_column_names()
-        # Support for AssociationProxy in search and list columns
-        for obj_attr, desc in self.obj.__mapper__.all_orm_descriptors.items():
-            if isinstance(desc, AssociationProxy):
-                proxy_instance = getattr(self.obj, obj_attr)
-                if hasattr(proxy_instance.remote_attr.prop, "columns"):
-                    self.list_columns[obj_attr] = proxy_instance.remote_attr.prop.columns[0]
-                    self.list_properties[obj_attr] = proxy_instance.remote_attr.prop
-
-    def is_utcdatetime(self, col_name):
-        """Check if the datetime is a UTC one."""
-        from airflow.utils.sqlalchemy import UtcDateTime
-
-        if col_name in self.list_columns:
-            obj = self.list_columns[col_name].type
-            return (
-                isinstance(obj, UtcDateTime)
-                or isinstance(obj, types.TypeDecorator)
-                and isinstance(obj.impl, UtcDateTime)
-            )
-        return False
-
-    def is_extendedjson(self, col_name):
-        """Check if it is a special extended JSON type."""
-        from airflow.utils.sqlalchemy import ExtendedJSON
-
-        if col_name in self.list_columns:
-            obj = self.list_columns[col_name].type
-            return (
-                isinstance(obj, ExtendedJSON)
-                or isinstance(obj, types.TypeDecorator)
-                and isinstance(obj.impl, ExtendedJSON)
-            )
-        return False
-
-    def is_json(self, col_name):
-        """Check if it is a JSON type."""
-        from sqlalchemy import JSON
-
-        if col_name in self.list_columns:
-            obj = self.list_columns[col_name].type
-            return (
-                isinstance(obj, JSON) or isinstance(obj, types.TypeDecorator) and isinstance(obj.impl, JSON)
-            )
-        return False
-
-    def get_col_default(self, col_name: str) -> Any:
-        if col_name not in self.list_columns:
-            # Handle AssociationProxy etc, or anything that isn't a "real" column
-            return None
-        return super().get_col_default(col_name)
-
-    filter_converter_class = AirflowFilterConverter