-
Notifications
You must be signed in to change notification settings - Fork 16.4k
Deprecate BackfillDetails and use DagAcccessEntity.Run for backfill p… #61400
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
Open
pierrejeambrun
wants to merge
5
commits into
apache:main
Choose a base branch
from
astronomer:deprecate-backfill-detail-and-use-run-perms-for-backfill
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
f66faa4
Deprecate BackfillDetails and use DagAcccessEntity.Run for backfill p…
pierrejeambrun 67e5d97
Add the significant newsfragment
pierrejeambrun 0e892a7
Address code review
pierrejeambrun 57f9c9b
Update newsfragment
pierrejeambrun 9ae1916
Fix CI
pierrejeambrun 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| AuthManager Backfill permissions are now handled by the ``requires_access_dag`` on the ``DagAccessEntity.Run`` | ||
|
|
||
| ``is_authorized_backfill`` of the ``BaseAuthManager`` interface has been removed. Core will no longer call this method and their | ||
| provider counterpart implementation will be marked as deprecated. | ||
| Permissions for backfill operations are now checked against the ``DagAccessEntity.Run`` permission using the existing | ||
| ``requires_access_dag`` decorator. In other words, if a user has permission to run a DAG, they can perform backfill operations on it. | ||
|
|
||
| Please update your security policies to ensure that users who need to perform backfill operations have the appropriate ``DagAccessEntity.Run`` permissions. (Users | ||
| having the Backfill permissions without having the DagRun ones will no longer be able to perform backfill operations without any update) | ||
|
|
||
| * Types of change | ||
|
|
||
| * [ ] Dag changes | ||
| * [ ] Config changes | ||
| * [x] API changes | ||
| * [ ] CLI changes | ||
| * [x] Behaviour changes | ||
| * [ ] Plugin changes | ||
| * [ ] Dependency changes | ||
| * [ ] Code interface changes |
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
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
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 |
|---|---|---|
|
|
@@ -16,16 +16,17 @@ | |
| # under the License. | ||
| from __future__ import annotations | ||
|
|
||
| from collections.abc import Callable | ||
| from collections.abc import Callable, Coroutine | ||
| from json import JSONDecodeError | ||
| from pathlib import Path | ||
| from typing import TYPE_CHECKING, Annotated, cast | ||
| from typing import TYPE_CHECKING, Annotated, Any, cast | ||
| from urllib.parse import ParseResult, unquote, urljoin, urlparse | ||
|
|
||
| from fastapi import Depends, HTTPException, Request, status | ||
| from fastapi.security import HTTPAuthorizationCredentials, HTTPBearer, OAuth2PasswordBearer | ||
| from jwt import ExpiredSignatureError, InvalidTokenError | ||
| from pydantic import NonNegativeInt | ||
| from sqlalchemy import or_ | ||
| from sqlalchemy import or_, select | ||
| from sqlalchemy.orm import Session | ||
|
|
||
| from airflow.api_fastapi.app import get_auth_manager | ||
| from airflow.api_fastapi.auth.managers.base_auth_manager import ( | ||
|
|
@@ -42,14 +43,14 @@ | |
| AccessView, | ||
| AssetAliasDetails, | ||
| AssetDetails, | ||
| BackfillDetails, | ||
| ConfigurationDetails, | ||
| ConnectionDetails, | ||
| DagAccessEntity, | ||
| DagDetails, | ||
| PoolDetails, | ||
| VariableDetails, | ||
| ) | ||
| from airflow.api_fastapi.common.db.common import SessionDep | ||
| from airflow.api_fastapi.core_api.base import OrmClause | ||
| from airflow.api_fastapi.core_api.datamodels.common import ( | ||
| BulkAction, | ||
|
|
@@ -64,6 +65,7 @@ | |
| from airflow.api_fastapi.core_api.datamodels.variables import VariableBody | ||
| from airflow.configuration import conf | ||
| from airflow.models import Connection, Pool, Variable | ||
| from airflow.models.backfill import Backfill | ||
| from airflow.models.dag import DagModel, DagRun, DagTag | ||
| from airflow.models.dagwarning import DagWarning | ||
| from airflow.models.log import Log | ||
|
|
@@ -146,14 +148,21 @@ async def get_user( | |
|
|
||
|
|
||
| def requires_access_dag( | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you cover these changes in unit tests as well? |
||
| method: ResourceMethod, access_entity: DagAccessEntity | None = None | ||
| method: ResourceMethod, | ||
| access_entity: DagAccessEntity | None = None, | ||
| param_dag_id: str | None = None, | ||
| ) -> Callable[[Request, BaseUser], None]: | ||
| def inner( | ||
| request: Request, | ||
| user: GetUserDep, | ||
| ) -> None: | ||
| dag_id = request.path_params.get("dag_id") or request.query_params.get("dag_id") | ||
| dag_id = dag_id if dag_id != "~" else None | ||
| # Required for the closure to capture the dag_id but still be able to mutate it. | ||
| # Prevent from using a nonlocal statement causing test failures. | ||
| dag_id = param_dag_id | ||
| if dag_id is None: | ||
| dag_id = request.path_params.get("dag_id") or request.query_params.get("dag_id") | ||
| dag_id = dag_id if dag_id != "~" else None | ||
|
|
||
| team_name = DagModel.get_team_name(dag_id) if dag_id else None | ||
|
|
||
| _requires_access( | ||
|
|
@@ -263,17 +272,35 @@ def depends_permitted_dags_filter( | |
| ] | ||
|
|
||
|
|
||
| def requires_access_backfill(method: ResourceMethod) -> Callable[[Request, BaseUser], None]: | ||
| def inner( | ||
| def requires_access_backfill( | ||
| method: ResourceMethod, | ||
| ) -> Callable[[Request, BaseUser, Session], Coroutine[Any, Any, None]]: | ||
| """Wrap ``requires_access_dag`` and extract the dag_id from the backfill_id.""" | ||
|
|
||
| async def inner( | ||
| request: Request, | ||
| user: GetUserDep, | ||
| session: SessionDep, | ||
| ) -> None: | ||
| backfill_id: NonNegativeInt | None = request.path_params.get("backfill_id") | ||
|
|
||
| _requires_access( | ||
| is_authorized_callback=lambda: get_auth_manager().is_authorized_backfill( | ||
| method=method, details=BackfillDetails(id=backfill_id), user=user | ||
| ), | ||
| dag_id = None | ||
|
|
||
| # Try to retrieve the dag_id from the backfill_id path param | ||
| backfill_id = request.path_params.get("backfill_id") | ||
| if backfill_id is not None: | ||
| backfill = session.scalars(select(Backfill).where(Backfill.id == backfill_id)).one_or_none() | ||
| dag_id = backfill.dag_id if backfill else None | ||
|
|
||
| # Try to retrieve the dag_id from the request body (POST backfill) | ||
pierrejeambrun marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if dag_id is None: | ||
| try: | ||
| dag_id = (await request.json()).get("dag_id") | ||
| except JSONDecodeError: | ||
| # Not a json body, ignore | ||
| pass | ||
|
|
||
| requires_access_dag(method, DagAccessEntity.RUN, dag_id)( | ||
| request, | ||
| user, | ||
| ) | ||
|
|
||
| return inner | ||
|
|
||
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
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
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.
Uh oh!
There was an error while loading. Please reload this page.