Feature/handle non renderable content 1067 #1095
Open
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
- Add new diff types for non-renderable content - Implement smart content detection with isNonRenderableType() - Auto-select file preview for Excel, Word, ZIP files etc. - Maintain existing behavior for renderable content (HTML, PDF, images) Addresses edgi-govdata-archiving#1067
- Display file metadata (name, type, size, hash, capture time) - Provide 'View Raw File' and 'Download File' buttons - Show clear warning about non-renderable content - Responsive design with clean styling - Extract filename from URLs gracefully Addresses edgi-govdata-archiving#1067
- Compare two non-renderable files side-by-side
- Uses FilePreview components for consistent display
- Maintains existing side-by-side layout patterns
- Clear version labeling ('From Version', 'To Version')
Addresses edgi-govdata-archiving#1067
- Import FilePreview and SideBySideFilePreview components - Add render cases for FILE_PREVIEW and SIDE_BY_SIDE_FILE_PREVIEW diff types - Pass appropriate props (page, version, diffData) to components - Maintain existing rendering logic for other diff types Addresses edgi-govdata-archiving#1067
- Add defaultFilePreviewDiffType constant - Update ensureValidDiffType() to detect non-renderable content - Auto-default to SIDE_BY_SIDE_FILE_PREVIEW for Excel, Word, ZIP files - Maintain SIDE_BY_SIDE_RENDERED default for HTML, images, etc. - Ensures optimal user experience without manual selection Addresses edgi-govdata-archiving#1067
- FilePreview component tests: file info display, buttons, warnings - SideBySideFilePreview component tests: dual preview rendering - Smart content detection tests: Excel→FilePreview, HTML→Traditional - Test edge cases: missing filenames, various media types - All tests pass (93/93 total, +14 new tests) Addresses edgi-govdata-archiving#1067
- Comprehensive overview of file preview feature - Details all components, files, and functionality added - Documents testing approach and results - Explains file type handling and user experience improvements - Reference for future maintenance and enhancements Addresses edgi-govdata-archiving#1067
|
@Mr0grog Implementation is complete and fully tested. Happy to address or iterate on any feedback/questions/concerns. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #1067
Summary
This PR introduces new
FilePreviewandSideBySideFilePreviewReact components to enhance the diff view experience for non-renderable file types (e.g.,.xlsx,.docx,.zip). Instead of attempting to render these files inline—which previously caused automatic downloads and blank comparison windows—the UI now displays comprehensive file metadata and provides clear action buttons. This dramatically improves the user experience when reviewing unsupported file formats.Changes
FILE_PREVIEWandSIDE_BY_SIDE_FILE_PREVIEWconstants indiff-types.jsisNonRenderableType()to automatically detect non-renderable filesChangeViewandDiffViewto use new components with smart defaultsProblem Solved
Before: Excel files (.xlsx) triggered browser downloads and left blank comparison screens
After: Clean file information display with "View Raw File" and "Download File" buttons
Testing
File Types Affected
Non-Renderable (now uses File Preview):
.xlsx,.docx,.pptx, etc..zip,.tar.gz, etc.Renderable (unchanged behavior):
Notes
SIDE_BY_SIDE_FILE_PREVIEW