Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor Line Processing in ImportUtil to Use Structured Response Format #31237

Closed
Tracked by #30882
jgambarios opened this issue Jan 27, 2025 · 1 comment · Fixed by #31294
Closed
Tracked by #30882

Refactor Line Processing in ImportUtil to Use Structured Response Format #31237

jgambarios opened this issue Jan 27, 2025 · 1 comment · Fixed by #31294
Labels
OKR : Core Features Owned by Will Priority : 2 High QA : Passed Internal Release : 25.02.12 Team : Scout Type : Task

Comments

@jgambarios
Copy link
Contributor

jgambarios commented Jan 27, 2025 •
edited
Loading

Parent Issue

#30882

Task

Refactor the line processing logic in ImportUtil.importLine() to use a structured response format while maintaining backward compatibility. This will improve error handling and make the import results more consistent and maintainable.

Technical Details:

  • Create new immutable model classes for line processing results
  • Implement class to encapsulate:
    • Content processing status
    • Field validation results
    • Relationship processing results
    • Validation messages
    • Content identifiers and metadata
  • Extract line processing logic into smaller, focused methods
  • Maintain backward compatibility with existing HashMap-based results
  • Add converter utility to transform between new and legacy formats

Proposed Objective

Core Features

Proposed Priority

Priority 2 - Important

Acceptance Criteria

  • Line processing logic refactored to use new model classes
  • All existing line processing functionality preserved
  • Converter utility implemented for legacy format compatibility
  • No breaking changes to existing API consumers
@jgambarios jgambarios self-assigned this Jan 27, 2025
@jgambarios jgambarios moved this from New to In Progress in dotCMS - Product Planning Jan 27, 2025
@jgambarios jgambarios mentioned this issue Jan 27, 2025
Closed
jgambarios added a commit that referenced this issue Jan 31, 2025
@jgambarios
#31237 Changed immutables package
d65dc53
jgambarios added a commit that referenced this issue Feb 1, 2025
@jgambarios
#31237 Refactoring the importLine method to improve response elements…
1a7fe1b 
…, also error and validation handling.
jgambarios added a commit that referenced this issue Feb 1, 2025
@jgambarios
#31237 Added missing javadoc
443a31d
@jgambarios jgambarios mentioned this issue Feb 1, 2025
Merged
@jgambarios jgambarios linked a pull request Feb 1, 2025 that will close this issue
Feat (Core): ImportUtil refactor to improve responses - second part #31294
Merged
jgambarios added a commit that referenced this issue Feb 1, 2025
@jgambarios
#31237 Fixes format of messages for legacy compatibility
2a1502f
jgambarios added a commit that referenced this issue Feb 4, 2025
@jgambarios
#31237 Refactor import utility methods to enhance content processing …
fcdf30f 
…and improve error handling
@rjvelazco rjvelazco moved this from In Progress to In Review in dotCMS - Product Planning Feb 7, 2025
github-merge-queue bot pushed a commit that referenced this issue Feb 10, 2025
@jgambarios
Feat (Core): ImportUtil refactor to improve responses - second part (#…
d35d18e 
…31294)

This PR is the second step in a larger effort to improve error handling
and response structures in the `ImportUtil` class. For this phase, we
focused specifically on line processing without modifying the existing
core logic.

### Changes Overview

* Added new structured validation response classes for better error
handling
* Introduced `LineImportResult` to encapsulate the import line results
* Created converter to maintain backward compatibility with existing
code
* Improved line importing validation code organization and readability
* Added comprehensive JavaDoc documentation

### What's Not Included
While working on this code, we identified several potential improvements
that were intentionally left for future iterations:

* Core import logic remains unchanged
* Legacy response format is still maintained for backward compatibility
* Existing error handling in other parts of the import process
* Performance optimizations opportunities
* Potential refactoring of data structures and helper classes

This PR is related to: #31237
@github-project-automation github-project-automation bot moved this from In Review to Done in dotCMS - Product Planning Feb 10, 2025
@jgambarios jgambarios reopened this Feb 10, 2025
@github-project-automation github-project-automation bot moved this from Done to Current Sprint Backlog in dotCMS - Product Planning Feb 10, 2025
@jgambarios jgambarios moved this from Current Sprint Backlog to Internal QA in dotCMS - Product Planning Feb 10, 2025
@jgambarios jgambarios removed their assignment Feb 10, 2025
@jgambarios jgambarios mentioned this issue Feb 11, 2025
Closed
6 tasks
@valentinogiardino valentinogiardino self-assigned this Feb 11, 2025
@valentinogiardino
Copy link
Contributor

IQA PASSED

Tested on dotcms/dotcms:trunk_c891857
A smoke test was performed using various content imports with different content types, fields, and data. The processing maintained its functionality, and no breaking changes were detected after the refactor.

@github-project-automation github-project-automation bot moved this from Internal QA to Done in dotCMS - Product Planning Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
OKR : Core Features Owned by Will Priority : 2 High QA : Passed Internal Release : 25.02.12 Team : Scout Type : Task
Projects
dotCMS - Product Planning
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Feat (Core): ImportUtil refactor to improve responses - second part dotCMS/core
3 participants
@jgambarios @rjvelazco @valentinogiardino