feat: Architectural improvements and module decomposition#53
Merged
feat: Architectural improvements and module decomposition#53
Conversation
## Item 7: Path Validation - Add path_validation.py with PathValidator class - TOCTOU-safe file reading via _safe_read_sql_file() - Symlink protection with opt-in allow_symlinks parameter - Windows reserved name detection - Unicode normalization for homoglyph attack prevention - 100% test coverage (71 tests) ## Item 10: Prompt Injection Mitigation - Add prompt_sanitization.py with 4-layer defense - Input sanitization with tag escaping (not removal) - Unicode NFKC normalization for Cyrillic bypass prevention - Output validation with semantic relevance checking - sqlglot-based SQL validation for destructive operations - Environment variable CLGRAPH_DISABLE_PROMPT_SANITIZATION for debugging - 95% test coverage (100 tests) ## Item 9: File Splitting - Extract lineage_utils.py from lineage_builder.py (~592 lines) - Extract sql_column_tracer.py from lineage_builder.py (~296 lines) - Extract tvf_registry.py from query_parser.py (~72 lines) - Maintain backward compatibility via re-exports ## Item 8: Pipeline Decomposition - Extract LineageTracer component (~400 lines) - Extract MetadataManager component (~185 lines) - Extract PipelineValidator component (~169 lines) - Extract SubpipelineBuilder component (~183 lines) - Pipeline now uses facade pattern with lazy initialization - All 1,052 existing tests pass without modification File size reductions: - pipeline.py: 2,795 → 2,426 lines - lineage_builder.py: 3,419 → 2,666 lines - query_parser.py: 2,354 → 2,313 lines
mingjerli
force-pushed
the
fix/mechanical-review-fixes
branch
from
a1b2e5f to
9715afd
Compare
6 tasks
Move factory method bodies (create_from_tuples, create_from_dict, create_from_sql_list, create_from_sql_string, create_from_json, create_from_json_file, create_from_sql_files, create_empty, and the generate_query_id helper) to a new pipeline_factory module. Pipeline classmethods are retained as thin delegators to preserve the public API. Internal cross-calls within pipeline_factory use local functions directly to avoid circular imports.
Move 5 pure methods from RecursiveLineageBuilder to a standalone module: parse_aggregate_spec, get_aggregate_func_name, infer_aggregate_return_type, has_star_in_aggregate, unit_has_fully_resolved_columns. Add 63 unit tests with 81% coverage for the new module.
Extract the five branching strategies from the 356-line _trace_column_dependencies method into focused strategy functions in src/clgraph/trace_strategies.py: - trace_star_passthrough: SELECT * / star column handling - trace_aggregate_star: COUNT(*) and aggregates with * - trace_set_operation: UNION/INTERSECT/EXCEPT column edges - trace_merge_columns: MERGE statement column tracking - trace_regular_columns: Normal column refs with UNNEST/TVF/VALUES sub-cases The builder method is now a compact ~45-line dispatcher. Resolution methods (_resolve_source_unit, _resolve_base_table_name, _find_column_in_unit, _get_default_from_table) stay on the builder and are passed as callables to strategy functions to avoid coupling. Adds tests/test_trace_strategies.py with 17 behavior-preserving tests exercising all five branches via the public RecursiveLineageBuilder API. 1027 passed, 40 skipped.
mingjerli
changed the title
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR combines architectural security improvements (Items 7, 10) with a comprehensive module decomposition of the two largest files in the codebase.
Security & Validation (original PR #53 scope)
path_validation.py) — TOCTOU-safe file reading, symlink protection, Windows reserved name detection, Unicode normalizationprompt_sanitization.py) — 4-layer defense with input sanitization, Unicode NFKC normalization, output validation, sqlglot-based SQL validationModule Decomposition (new)
Decomposes
pipeline.py(2,795 → 1,247 lines) andlineage_builder.py(3,419 → 1,366 lines) into focused, independently testable modules:pipeline_lineage_builder.pypipeline_factory.pyPipeline.from_*factory methodslineage_tracer.pynode_factory.pytrace_strategies.pycolumn_extractor.pyaggregate_parser.pylineage_utils.pysql_column_tracer.pytvf_registry.pymetadata_manager.pypipeline_validator.pysubpipeline_builder.pyApproach
File Size Reductions
pipeline.pylineage_builder.pyquery_parser.pyTest plan
ruff checkandruff formatcleanfrom clgraph import Pipeline, SQLColumnTracer, PipelineLineageBuilder