pierrejeambrun commented on code in PR #44416: URL: https://github.com/apache/airflow/pull/44416#discussion_r1860745056
########## airflow/api_fastapi/core_api/routes/public/dag_parsing.py: ########## @@ -0,0 +1,72 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +from collections.abc import Sequence +from typing import TYPE_CHECKING, Annotated + +from fastapi import Depends, HTTPException, Request, status +from fastapi.responses import Response +from itsdangerous import BadSignature, URLSafeSerializer +from sqlalchemy import exc, select +from sqlalchemy.orm import Session + +from airflow.api_fastapi.common.db.common import get_session +from airflow.api_fastapi.common.router import AirflowRouter +from airflow.api_fastapi.core_api.openapi.exceptions import create_openapi_http_exception_doc +from airflow.auth.managers.models.resource_details import DagDetails +from airflow.models.dag import DagModel +from airflow.models.dagbag import DagPriorityParsingRequest + +if TYPE_CHECKING: + from airflow.auth.managers.models.batch_apis import IsAuthorizedDagRequest + +dag_parsing_router = AirflowRouter(tags=["DAG Parsing"], prefix="/parseDagFile/{file_token}") + + +@dag_parsing_router.put( + "", + responses=create_openapi_http_exception_doc([status.HTTP_404_NOT_FOUND]), Review Comment: here you need to specify the status code to get an appropriate documentation: ```python status_code=status.HTTP_201_CREATED, ``` ########## airflow/api_fastapi/core_api/openapi/v1-generated.yaml: ########## @@ -5557,6 +5557,50 @@ paths: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' + /public/parseDagFile/{file_token}: + put: + tags: + - DAG Parsing + summary: Reparse Dag File + description: Request re-parsing a DAG file. + operationId: reparse_dag_file + parameters: + - name: file_token + in: path + required: true + schema: + type: string + title: File Token + responses: + '200': Review Comment: Response code is not correct, this should be `201` ########## airflow/api_fastapi/core_api/routes/public/dag_parsing.py: ########## @@ -0,0 +1,72 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +from collections.abc import Sequence +from typing import TYPE_CHECKING, Annotated + +from fastapi import Depends, HTTPException, Request, status +from fastapi.responses import Response +from itsdangerous import BadSignature, URLSafeSerializer +from sqlalchemy import exc, select +from sqlalchemy.orm import Session + +from airflow.api_fastapi.common.db.common import get_session +from airflow.api_fastapi.common.router import AirflowRouter +from airflow.api_fastapi.core_api.openapi.exceptions import create_openapi_http_exception_doc +from airflow.auth.managers.models.resource_details import DagDetails +from airflow.models.dag import DagModel +from airflow.models.dagbag import DagPriorityParsingRequest + +if TYPE_CHECKING: + from airflow.auth.managers.models.batch_apis import IsAuthorizedDagRequest + +dag_parsing_router = AirflowRouter(tags=["DAG Parsing"], prefix="/parseDagFile/{file_token}") + + +@dag_parsing_router.put( + "", + responses=create_openapi_http_exception_doc([status.HTTP_404_NOT_FOUND]), +) +def reparse_dag_file( + file_token: str, + session: Annotated[Session, Depends(get_session)], + request: Request, +) -> Response: + """Request re-parsing a DAG file.""" + secret_key = request.app.state.secret_key + auth_s = URLSafeSerializer(secret_key) + try: + path = auth_s.loads(file_token) + except BadSignature: + raise HTTPException(status.HTTP_404_NOT_FOUND, "File not found") + + requests: Sequence[IsAuthorizedDagRequest] = [ + {"method": "PUT", "details": DagDetails(id=dag_id)} + for dag_id in session.scalars(select(DagModel.dag_id).where(DagModel.fileloc == path)) + ] + if not requests: + raise HTTPException(status.HTTP_404_NOT_FOUND, "File not found") + + parsing_request = DagPriorityParsingRequest(fileloc=path) + session.add(parsing_request) + try: + session.commit() + except exc.IntegrityError: + session.rollback() + return Response("Duplicate request", status_code=status.HTTP_201_CREATED) + return Response(status_code=status.HTTP_201_CREATED) Review Comment: Above `status_code=status.HTTP_201_CREATED` will handle that automatically. you can just return nothing. ```suggestion ``` ########## airflow/api_fastapi/core_api/routes/public/dag_parsing.py: ########## @@ -0,0 +1,72 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +from collections.abc import Sequence +from typing import TYPE_CHECKING, Annotated + +from fastapi import Depends, HTTPException, Request, status +from fastapi.responses import Response +from itsdangerous import BadSignature, URLSafeSerializer +from sqlalchemy import exc, select +from sqlalchemy.orm import Session + +from airflow.api_fastapi.common.db.common import get_session +from airflow.api_fastapi.common.router import AirflowRouter +from airflow.api_fastapi.core_api.openapi.exceptions import create_openapi_http_exception_doc +from airflow.auth.managers.models.resource_details import DagDetails +from airflow.models.dag import DagModel +from airflow.models.dagbag import DagPriorityParsingRequest + +if TYPE_CHECKING: + from airflow.auth.managers.models.batch_apis import IsAuthorizedDagRequest + +dag_parsing_router = AirflowRouter(tags=["DAG Parsing"], prefix="/parseDagFile/{file_token}") + + +@dag_parsing_router.put( + "", + responses=create_openapi_http_exception_doc([status.HTTP_404_NOT_FOUND]), +) +def reparse_dag_file( + file_token: str, + session: Annotated[Session, Depends(get_session)], + request: Request, +) -> Response: Review Comment: Maybe ```suggestion ) -> None: ``` Works, but not sure. ########## airflow/api_fastapi/core_api/routes/public/dag_parsing.py: ########## @@ -0,0 +1,72 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +from collections.abc import Sequence +from typing import TYPE_CHECKING, Annotated + +from fastapi import Depends, HTTPException, Request, status +from fastapi.responses import Response +from itsdangerous import BadSignature, URLSafeSerializer +from sqlalchemy import exc, select +from sqlalchemy.orm import Session + +from airflow.api_fastapi.common.db.common import get_session +from airflow.api_fastapi.common.router import AirflowRouter +from airflow.api_fastapi.core_api.openapi.exceptions import create_openapi_http_exception_doc +from airflow.auth.managers.models.resource_details import DagDetails +from airflow.models.dag import DagModel +from airflow.models.dagbag import DagPriorityParsingRequest + +if TYPE_CHECKING: + from airflow.auth.managers.models.batch_apis import IsAuthorizedDagRequest + +dag_parsing_router = AirflowRouter(tags=["DAG Parsing"], prefix="/parseDagFile/{file_token}") + + +@dag_parsing_router.put( + "", + responses=create_openapi_http_exception_doc([status.HTTP_404_NOT_FOUND]), +) +def reparse_dag_file( + file_token: str, + session: Annotated[Session, Depends(get_session)], + request: Request, +) -> Response: + """Request re-parsing a DAG file.""" + secret_key = request.app.state.secret_key + auth_s = URLSafeSerializer(secret_key) + try: + path = auth_s.loads(file_token) + except BadSignature: + raise HTTPException(status.HTTP_404_NOT_FOUND, "File not found") + + requests: Sequence[IsAuthorizedDagRequest] = [ + {"method": "PUT", "details": DagDetails(id=dag_id)} + for dag_id in session.scalars(select(DagModel.dag_id).where(DagModel.fileloc == path)) + ] + if not requests: + raise HTTPException(status.HTTP_404_NOT_FOUND, "File not found") + + parsing_request = DagPriorityParsingRequest(fileloc=path) + session.add(parsing_request) + try: + session.commit() + except exc.IntegrityError: + session.rollback() + return Response("Duplicate request", status_code=status.HTTP_201_CREATED) Review Comment: Indeed, you can remove this bit, this will be handled directly by the global exception handler. ########## airflow/api_fastapi/core_api/routes/public/dag_parsing.py: ########## @@ -0,0 +1,72 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +from collections.abc import Sequence +from typing import TYPE_CHECKING, Annotated + +from fastapi import Depends, HTTPException, Request, status +from fastapi.responses import Response +from itsdangerous import BadSignature, URLSafeSerializer +from sqlalchemy import exc, select +from sqlalchemy.orm import Session + +from airflow.api_fastapi.common.db.common import get_session +from airflow.api_fastapi.common.router import AirflowRouter +from airflow.api_fastapi.core_api.openapi.exceptions import create_openapi_http_exception_doc +from airflow.auth.managers.models.resource_details import DagDetails +from airflow.models.dag import DagModel +from airflow.models.dagbag import DagPriorityParsingRequest + +if TYPE_CHECKING: + from airflow.auth.managers.models.batch_apis import IsAuthorizedDagRequest + +dag_parsing_router = AirflowRouter(tags=["DAG Parsing"], prefix="/parseDagFile/{file_token}") + + +@dag_parsing_router.put( + "", + responses=create_openapi_http_exception_doc([status.HTTP_404_NOT_FOUND]), +) +def reparse_dag_file( + file_token: str, + session: Annotated[Session, Depends(get_session)], + request: Request, +) -> Response: Review Comment: 201 are a specific case. ```suggestion ): ``` ########## tests/api_fastapi/core_api/routes/public/test_dag_parsing.py: ########## @@ -0,0 +1,80 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +from __future__ import annotations + +import os +from typing import TYPE_CHECKING + +import pytest +from sqlalchemy import select + +from airflow.models import DagBag +from airflow.models.dagbag import DagPriorityParsingRequest +from airflow.utils.session import provide_session + +from tests_common.test_utils.db import clear_db_dag_parsing_requests + +pytestmark = [pytest.mark.db_test, pytest.mark.skip_if_database_isolation_mode] + +if TYPE_CHECKING: + from airflow.models.dag import DAG + + +class TestDagParsingRequest: Review Comment: Just to be consistent with other test classes. ```suggestion class TestDagParsingEndpoint: ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
