fix: deduplicate enum imports when merging grouped and individual imports #2945
+77
−5
Conversation
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
When regenerating entities with --expanded-format and preserve_user_modifications,
duplicate enum imports are created when the old file has grouped imports like:
use super::sea_orm_active_enums::{Status, Category};
And the new file generates individual imports:
use super::sea_orm_active_enums::Status;
use super::sea_orm_active_enums::Category;
The result incorrectly includes both the grouped and individual imports.
The bug occurs because structural equality (HashSet<ItemUse>) is used to
deduplicate imports instead of semantic comparison of actual import paths.
This test is marked with #[should_panic] and will pass normally once fixed.
Previously, import deduplication used structural equality (HashSet<ItemUse>)
which failed to recognize that grouped imports like:
use super::sea_orm_active_enums::{Status, Category};
And individual imports like:
use super::sea_orm_active_enums::Status;
use super::sea_orm_active_enums::Category;
represent the same import paths and should be deduplicated.
This fix:
- Adds normalize_use_paths() to flatten use statements into canonical paths
- Changes Merger.seen_use from HashSet<ItemUse> to seen_paths: HashSet<String>
- Updates deduplication logic to track individual import paths semantically
- Use statements are included only if they contain at least one new path
The implementation uses a simple nested function to recursively collect paths
from the UseTree, handling Path, Name, Rename, Glob, and Group variants.
All existing tests pass, and the new test now passes without #[should_panic].
lmurri
force-pushed
the
fix/duplicate-enum-imports
branch
from
87dacc5 to
61021c6
Compare
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.
PR Info
New Features
N/A
Bug Fixes
--expanded-formatOriginal Bug Analysis
When using
sea-orm-cli generate entitywith--expanded-formatandpreserve_user_modificationsenabled, duplicate enum imports were created if the old file had grouped imports and the new file generated individual imports.For example, if the old file had:
And the new file generated:
The merge would incorrectly produce all three import lines instead of just the two individual imports.
Root Cause
The merge logic used structural equality (
HashSet<ItemUse>) to deduplicate imports. This failed to recognize that grouped imports and individual imports for the same paths are semantically equivalent and should be deduplicated.Fix
normalize_use_paths()function to flatten use statements into canonical import pathsHashSet<ItemUse>toHashSet<String>for semantic path comparisonBreaking Changes
N/A — this fix maintains backward compatibility while improving merge behavior.
Changes
sea-orm-codegen/src/merge/mod.rs:duplicate_enum_imports_grouped_vs_individual