uranusjr commented on code in PR #72369: URL: https://github.com/apache/airflow/pull/72369#discussion_r3988868024
########## task-sdk/src/airflow/sdk/importers/zip_importer.py: ########## @@ -0,0 +1,293 @@ +# 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. +"""Zip archive DAG importer.""" + +from __future__ import annotations + +import contextlib +import logging +import sys +import tempfile +import threading +import zipfile +from dataclasses import dataclass, field +from pathlib import Path +from typing import TYPE_CHECKING, Any + +from airflow.sdk.exceptions import AirflowConfigException +from airflow.sdk.importers.base import ( + AbstractDagImporter, + DagDefinition, + DagImporterRegistry, + DagImportError, + DagImportResult, + DagSourceCode, + _get_importer_extensions, + _normalize_extensions, + _parse_importer_specs, + find_file_dag_definitions, + get_file_suffix, +) + +if TYPE_CHECKING: + from collections.abc import Generator, Iterator + + from airflow.dag_processing.bundles.base import BaseDagBundle # noqa: SDK002 + +log = logging.getLogger(__name__) + +_sys_path_lock = threading.Lock() + + [email protected] +def _temporary_sys_path(path: str) -> Generator[None, None, None]: + """Safely prepend a path to sys.path with synchronization and restoration.""" + with _sys_path_lock: + already_present = path in sys.path + if not already_present: + sys.path.insert(0, path) + try: + yield + finally: + if not already_present: + with contextlib.suppress(ValueError): + sys.path.remove(path) + + +@dataclass +class ZipFileDagDefinition(DagDefinition): + """A DAG definition backed by a file inside a ZIP archive.""" + + zip_path: Path + file_path: str + _content: bytes | None = field(default=None, repr=False, compare=False) + + @property + def freshness_token(self) -> str: + try: + stat = self.zip_path.stat() + except OSError: + return "" + return f"{stat.st_mtime_ns}-{stat.st_size}-{self.file_path}" + + def get_relative_loc(self, root: Path | None = None) -> str: + if root is not None: + with contextlib.suppress(ValueError): + return f"{self.zip_path.relative_to(root)}:{self.file_path}" + return f"{self.zip_path}:{self.file_path}" + + def read_bytes(self) -> bytes: + if self._content is None: + with zipfile.ZipFile(self.zip_path) as z: + self._content = z.read(self.file_path) + return self._content + + @contextlib.contextmanager + def as_file(self) -> Generator[Path, None, None]: + suffix = Path(self.file_path).suffix + with tempfile.NamedTemporaryFile(suffix=suffix, delete=False) as f: + f.write(self.read_bytes()) + temp_path = Path(f.name) + try: + yield temp_path + finally: + with contextlib.suppress(OSError): + temp_path.unlink() + + def __repr__(self) -> str: + return f"{self.zip_path}:{self.file_path}" + + +class ZipImporter(AbstractDagImporter): + """Composite importer responsible for routing archive members to internal importers.""" + + supported_extensions = [".zip"] + + def __init__( + self, + internal_importers: dict[str, AbstractDagImporter | dict[str, Any]] + | list[dict[str, Any]] + | None = None, + extensions: list[str] | None = None, + ) -> None: + if extensions is not None: + self.supported_extensions = _normalize_extensions(extensions) + self._internal_extension_importers: dict[str, AbstractDagImporter] = {} + self._ordered_internal_importers: list[AbstractDagImporter] = [] + + if internal_importers is None: + from airflow.sdk.importers.python_importer import PythonDagImporter + + self._register_internal(PythonDagImporter()) + elif isinstance(internal_importers, list): + specs = _parse_importer_specs(internal_importers, context="internal_importers of ZipImporter") + for spec in specs: + importer = DagImporterRegistry._instantiate_spec(spec) + self._register_internal(importer, extensions=spec.extensions) + elif isinstance(internal_importers, dict): + for ext, cfg in internal_importers.items(): + if isinstance(cfg, AbstractDagImporter): + self._register_internal(cfg, extensions=[ext]) + elif isinstance(cfg, dict): + specs = _parse_importer_specs( + [cfg], context=f"internal_importers configuration for extension '{ext}'" + ) + importer = DagImporterRegistry._instantiate_spec(specs[0]) + self._register_internal(importer, extensions=specs[0].extensions or [ext]) + else: + raise AirflowConfigException( + f"Invalid internal importer configuration for extension '{ext}': " + f"expected AbstractDagImporter or dictionary, got {type(cfg).__name__}." + ) + else: + raise AirflowConfigException( + f"Field 'internal_importers' must be a list or dictionary, got {type(internal_importers).__name__}." + ) + + def can_handle(self, definition: DagDefinition | str | Path) -> bool: + """Check if this importer can handle the given definition based on file extension.""" + suffix = get_file_suffix(definition) + return suffix in self.supported_extensions if suffix else False + + def list_dag_definitions( + self, + bundle: BaseDagBundle, + *, + safe_mode: bool = True, + ) -> Iterator[DagDefinition]: + """List zip archive DAG definitions in a bundle matching supported extensions.""" + yield from find_file_dag_definitions(bundle.path, self.supported_extensions) + + def import_definition( + self, + definition: DagDefinition, + bundle: BaseDagBundle, + *, + safe_mode: bool = True, + ) -> DagImportResult: + """ + Import DAGs from a ZIP archive by routing its members to internal importers. + + The archive itself is placed on ``sys.path`` so Python imports between + members resolve via ``zipimport``. A real file is materialized on demand + with :meth:`.as_file()` for internal importers. + """ + result = DagImportResult(definition=definition) + + with definition.as_file() as local_zip_path: + try: + with zipfile.ZipFile(local_zip_path) as z: + member_names = z.namelist() + except Exception as e: + result.errors.append( + DagImportError( + source_reference=definition.get_relative_loc(bundle.path), + message=f"Failed to read ZIP archive: {e}", + error_type="zip_read_error", + ) + ) + return result + + with _temporary_sys_path(str(local_zip_path)): + for member_name in member_names: + if member_name.endswith("/") or member_name.startswith("__MACOSX/"): + continue + # ZipSlip defence: reject traversal or absolute member names. + member_path = Path(member_name) + if member_path.is_absolute() or ".." in member_path.parts: + log.warning( + "Skipping zip member %r in %s: directory traversal patterns detected", + member_name, + definition, + ) + continue + + importer = self._get_internal_importer(member_name) + if importer is None: + continue + + nested_def = ZipFileDagDefinition(zip_path=local_zip_path, file_path=member_name) + if not importer.can_handle(nested_def): + continue + + member_result = importer.import_definition(nested_def, bundle, safe_mode=safe_mode) + result.dags.extend(member_result.dags) + result.errors.extend(member_result.errors) + result.warnings.extend(member_result.warnings) + result.skipped_definitions.extend(member_result.skipped_definitions) + result.dependencies.extend(member_result.dependencies) + + return result + + def get_source_code(self, definition: DagDefinition) -> DagSourceCode: + if isinstance(definition, ZipFileDagDefinition): + importer = self._get_internal_importer(definition.file_path) + if importer is not None: + return importer.get_source_code(definition) + raise ValueError(f"No internal importer registered for zip member {definition.file_path}") Review Comment: I removed much of the logic here. We should not make this too complicated; a dag file should be just a file (a single member in the zip), no funny things involved. Similar to how we resolved the stub-impl SDK topic by not doing anything special. -- 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]
