Skip to content

Latest commit

 

History

History
249 lines (204 loc) · 8.43 KB

BUGS.md

File metadata and controls

249 lines (204 loc) · 8.43 KB
Raw

Known Issues and Technical Debt

This document tracks known issues and deprecated packages in the current boilerplate setup.

Deprecated Packages

Client Dependencies

  1. ESLint (v8.57.1)

    • Status: Deprecated
    • Issue: This version is no longer supported
    • Fix: Update to latest version as per ESLint version support
    • Priority: Medium

  2. @humanwhocodes/config-array (v0.13.0)

    • Status: Deprecated
    • Issue: Package is outdated
    • Fix: Replace with @eslint/config-array
    • Priority: Low

  3. @humanwhocodes/object-schema (v2.0.3)

    • Status: Deprecated
    • Issue: Package is outdated
    • Fix: Replace with @eslint/object-schema
    • Priority: Low

Dependency Conflicts

  1. TypeScript ESLint Plugin
    • Issue: Peer dependency conflicts between @typescript-eslint/eslint-plugin and its parser
    • Current Workaround: Using --legacy-peer-deps
    • Proper Fix Needed: Align versions of @typescript-eslint/eslint-plugin and @typescript-eslint/parser
    • Priority: High

Development Environment

  1. Vite Global Installation
    • Issue: Permission issues with global package linking
    • Current Workaround: Using local node_modules binaries
    • Future Consideration: Better development environment setup
    • Priority: Low

File Upload System Issues

Known Limitations

  1. File Preview

    • Text files show only first 128 characters
    • PDF preview functionality fully implemented with:
      • Text extraction
      • Page count display
      • First 128 characters preview
    • Large PDFs may cause performance issues
    • Preview container size fixed, may truncate content

  2. File Size

    • Maximum file size limited to 10MB
    • Progress indicator implemented for file uploads and conversions
    • Potential memory issues with multiple large files

  3. File Conversion

    • PDF conversion currently not supported (both to and from PDF)
    • HTML to markdown conversion provides basic text extraction only
    • Complex HTML to PDF conversion needs improvement for formatting

  4. Browser Compatibility

    • File preview may not work in older browsers
    • Drag and drop functionality requires modern browser support
    • CSS animations may not work in all browsers

Recent Improvements

  1. Preview Container
    • Fixed: Empty state visibility
    • Fixed: Preview container always visible
    • Fixed: Consistent UI across all states
    • Fixed: Proper scrolling behavior for file previews

Potential Issues

  1. Memory Management

    • Large files may cause performance issues
    • Multiple file previews could impact browser performance
    • Memory leaks possible if component unmounts during upload

  2. Error Handling

    • Network errors during upload need better handling
    • Some error messages may not be user-friendly
    • Error boundary may not catch all edge cases

  3. User Experience

    • Loading states implemented with progress indicators
    • Drag and drop zone could be more intuitive
    • File type validation messages could be clearer

Future Improvements

  1. Performance

    • Implement file chunking for large uploads
    • Add compression for image previews
    • Optimize memory usage for multiple files
    • Implement PDF content caching

  2. Features

    • Implement PDF conversion support
    • Add PDF zoom functionality
    • Implement text encoding detection
    • Add code syntax highlighting
    • Support more text-based file formats
    • Add preview zoom functionality

  3. User Interface

    • Enhance drag and drop visual feedback
    • Further improve error message presentation
    • Optimize preview container layout for different file types

File Size Display

Known Issues

  • File sizes above 4GB may not display correctly due to JavaScript number precision limitations
  • Some browsers may report incorrect file sizes for files larger than 2GB
  • File size calculation might be affected by system-specific file attributes

Warnings

  • Large file handling may cause performance issues in the preview generation
  • Memory usage increases with the number of large files being previewed simultaneously

File Preview System

Known Issues

  1. PDF Preview

    • Large PDFs (>10MB) may cause performance issues
    • Complex PDF layouts may result in inconsistent text extraction
    • Scanned PDFs without OCR won't show text content
    • Memory usage increases with multiple PDF previews
    • Some PDF fonts may not render correctly in preview
    • PDF preview limited to first 128 characters

  2. Text Files

    • Text files show only first 128 characters
    • Some text encodings may not display correctly
    • No syntax highlighting for code files
    • Preview container size fixed, may truncate content

  3. Performance

    • Multiple large files may cause UI lag
    • PDF processing can be CPU intensive
    • Memory leaks possible with many PDF previews
    • Worker initialization may fail in poor network conditions

Development Warnings

  1. Package Dependencies

  2. Build Process

    • Vite postinstall script requires sudo permissions
    • PDF.js worker path resolution sensitive to build configuration
    • Development server may need restart after PDF.js changes

Future Improvements

  1. PDF Handling

    • Implement PDF text content caching
    • Add full PDF content preview
    • Support PDF page navigation
    • Add PDF thumbnail generation
    • Implement text search within PDFs
    • Add zoom functionality
    • Optimize memory usage for large PDFs
    • Add progress indicator for PDF processing

  2. Performance Optimization

    • Implement lazy loading for PDF preview
    • Add file size checks before processing
    • Implement worker pool for PDF processing
    • Add compression for preview content
    • Optimize memory usage for multiple files

  3. User Experience

    • Add loading indicators for PDF processing
    • Improve error messages for failed previews
    • Add retry mechanism for failed worker initialization
    • Implement preview size controls
    • Add file type icons for better visualization

File Conversion System

Critical Issues

  1. PDF Conversion Limitations

    • Issue: PDF to other format conversions not yet implemented
    • Impact: Users cannot convert from PDF to markdown or HTML
    • Status: To be implemented
    • Workaround: None currently available

  2. HTML to Markdown Conversion

    • Issue: Basic text extraction only, formatting not preserved
    • Impact: Loss of HTML structure and styling in markdown output
    • Status: In progress
    • Workaround: Manual formatting after conversion

Warnings

  1. HTML to PDF Conversion

    • Issue: Complex HTML layouts may not render correctly
    • Impact: PDF output might not match HTML layout exactly
    • Status: Needs improvement
    • Workaround: Use simpler HTML structures for better results

  2. Large File Handling

    • Issue: Memory usage spikes with large files
    • Impact: Potential performance issues with files over 10MB
    • Status: Monitoring
    • Workaround: Split large files before conversion

File Conversion Issues

PDF Conversion

  1. PDF Generation Failure

    • Status: Critical
    • Issue: Cannot convert files to PDF format due to character encoding issues
    • Error: "WinAnsi cannot encode "├" (0x251c)"
    • Affects: HTML to PDF and Markdown to PDF conversions
    • Root Cause: Character encoding incompatibility in PDF generation library
    • Workaround: Currently no workaround available
    • Fix: Investigate alternative PDF generation libraries or implement proper character encoding
    • Priority: High

  2. PDF Reading

    • Status: Critical
    • Issue: Cannot convert PDF files to other formats
    • Affects: PDF to HTML and PDF to Markdown conversions
    • Root Cause: PDF parsing functionality not implemented
    • Fix: Implement PDF parsing using pdf.js or similar library
    • Priority: High

Character Encoding

  1. Special Characters
    • Status: Major
    • Issue: Special characters cause conversion failures
    • Affects: Primarily PDF conversion
    • Fix: Implement proper character encoding handling
    • Priority: High

Resolution Timeline

Short Term

  • Update ESLint to supported version
  • Resolve TypeScript ESLint plugin conflicts

Long Term

  • Update remaining deprecated packages
  • Improve development environment setup