amoghrajesh opened a new pull request, #63968:
URL: https://github.com/apache/airflow/pull/63968
<!-- SPDX-License-Identifier: Apache-2.0
https://www.apache.org/licenses/LICENSE-2.0 -->
<!--
Thank you for contributing!
Please provide above a brief description of the changes made in this pull
request.
Write a good git commit message following this guide:
http://chris.beams.io/posts/git-commit/
Please make sure that your code changes are covered with tests.
And in case of new features or big changes remember to adjust the
documentation.
Feel free to ping (in general) for the review if you do not see reaction for
a few days
(72 Hours is the minimum reaction time you can expect from volunteers) - we
sometimes miss notifications.
In case of an existing issue, reference it using one of the following:
* closes: #ISSUE
* related: #ISSUE
-->
---
##### Was generative AI tooling used to co-author this PR?
<!--
If generative AI tooling has been used in the process of authoring this PR,
please
change below checkbox to `[X]` followed by the name of the tool, uncomment
the "Generated-by".
-->
- [ ] Yes (please specify the tool below)
<!--
Generated-by: [Tool Name] following [the
guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#gen-ai-assisted-contributions)
-->
The hook failed whenever any datamodel file changed without a version file,
including internal-only changes (validators, docstrings) that don't affect the
API contract leading to some false positives as seen in
https://github.com/apache/airflow/pull/63916 for example.
The solution would be to rework the hook to compare the generated openapi
schema from `main` with the schema
from the current branch (where changes are made). If they match, the change
can be thought of as internal-only and the hook passes. If they differ, the API
contract changed and a version update is required. This is a much more robust
way of doing things and is promising too.
Testing:
1. Internal changes:
```diff
diff --git
a/airflow-core/src/airflow/api_fastapi/execution_api/datamodels/taskinstance.py
b/airflow-core/src/airflow/api_fastapi/execution_api/datamodels/taskinstance.py
index 890314171b..9ab4ad32ed 100644
---
a/airflow-core/src/airflow/api_fastapi/execution_api/datamodels/taskinstance.py
+++
b/airflow-core/src/airflow/api_fastapi/execution_api/datamodels/taskinstance.py
@@ -320,7 +320,7 @@ class DagRun(StrictBaseModel):
# Check if this is a SQLAlchemy model by looking for the inspection
interface
try:
- insp: InstanceState = sa_inspect(data)
+ insp = sa_inspect(data)
except NoInspectionAvailable:
# Not a SQLAlchemy object, return as-is for Pydantic to handle
return data
```
Hook response:
```
(airflow) ~/D/O/r/airflow ❯❯❯ python
scripts/ci/prek/check_execution_api_versions.py
execution-api-prek-hook ✭ ✚ ◼
Schema unchanged: Datamodel changes do not affect API contract.
```
2. Actual changes:
```diff
---
a/airflow-core/src/airflow/api_fastapi/execution_api/datamodels/taskinstance.py
+++
b/airflow-core/src/airflow/api_fastapi/execution_api/datamodels/taskinstance.py
@@ -304,7 +304,7 @@ class DagRun(StrictBaseModel):
conf: dict[str, Any] | None = None
triggering_user_name: str | None = None
consumed_asset_events: list[AssetEventDagRunReference]
- partition_key: str | None
+ partition_key: str
note: str | None = None
@model_validator(mode="before")
```
Hook response:
```
(airflow) ~/D/O/r/airflow ❯❯❯ python
scripts/ci/prek/check_execution_api_versions.py
execution-api-prek-hook ✭ ✚ ◼
ERROR: Execution API schema has changed but no version file was updated.
The following datamodel files were changed:
-
airflow-core/src/airflow/api_fastapi/execution_api/datamodels/taskinstance.py
Schema diff against origin/main detected differences.
Please add or update a version file under:
airflow-core/src/airflow/api_fastapi/execution_api/versions/
See contributing-docs/19_execution_api_versioning.rst for details.
```
---
* Read the **[Pull Request
Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)**
for more information. Note: commit author/co-author name and email in commits
become permanently public when merged.
* For fundamental code changes, an Airflow Improvement Proposal
([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals))
is needed.
* When adding dependency, check compliance with the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
* For significant user-facing changes create newsfragment:
`{pr_number}.significant.rst`, in
[airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
You can add this file in a follow-up commit after the PR is created so you
know the PR number.
--
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]
