Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.8.9] - 2025-12-06

Fixed

Electron Client Stability

  • Large File Upload Crash Fix: Fixed crashes during large file uploads (multi-GB files)

    • Added global error handlers (uncaughtException, unhandledRejection) to prevent app crashes

    • Added event.sender.isDestroyed() check before sending IPC progress updates

    • Implemented stream backpressure handling with pause/resume for file uploads

    • Properly positioned request error handlers to clean up file streams on errors

    • App now remains stable when uploading files of any size

Added

Electron Client Testing

  • Playwright E2E Test Suite: Comprehensive automated tests for the Electron client

    • Tests login form display, authentication, directory selection, file upload, and logout

    • Invalid credentials error handling test

    • Crash detection during uploads

    • Support for large file uploads with progress monitoring

    • Uses DEV_TEST_USER and DEV_TEST_PASSWORD from .env file

    • Run with: npm run test or npm run test:headed

Changed

  • Test Configuration: Added Playwright dependencies and test scripts to package.json

    • @playwright/test, dotenv, @types/dotenv added to devDependencies

    • New npm scripts: test, test:headed, test:debug, test:report

Refactored

  • Server Code Organization: Extracted routes and templates for better maintainability

    • Created routers/ module with separate files for api_keys, files, pages, users, admin

    • Moved HTML templates to templates.py module

    • Reduced main.py size by ~1100 lines

[0.5.1] - 2025-01-06

Fixed

  • Configuration Priority: Fixed critical bug where ppserver.toml values were overriding environment variables

    • Environment variables now correctly take precedence over TOML configuration

    • Proper priority order: env vars > TOML > defaults

    • Rewrote Settings.__init__() to check environment variables first

    • Fixes issues with test environments and containerized deployments

  • Server Startup: Fixed UnboundLocalError crash caused by local os import after usage

    • Moved import os to module-level imports in main.py

  • E2E Test Suite: Fixed and re-enabled test_e2e_real_server_and_client_with_upload

    • Corrected storage path assumptions to match actual storage backend structure

    • Test now passes successfully in isolation

    • Storage backend uses single-level subdirectory: storage/XX/SHA256 (not storage/XX/XX/SHA256)

Changed

  • Updated configuration loading in config.py to properly respect environment variable precedence

  • Cleaned up redundant local imports in main.py

[0.5.0] - 2025-11-05

Added

Electron Desktop GUI

  • Cross-Platform Desktop Application: New Electron-based GUI client built with TypeScript

    • Native macOS, Windows, and Linux support

    • Proper application branding with “PutPlace Client” menu name

    • Custom application menu with standard macOS items

    • Packaged .app bundle with correct Info.plist metadata

    • DMG installer for easy distribution

  • Authentication & Security:

    • JWT-based authentication (replaced API key authentication)

    • User login and registration forms

    • Password visibility toggle with eye icon

    • Session persistence using localStorage

    • Secure IPC communication with context isolation

  • User Interface Features:

    • Native directory picker dialog

    • Exclude patterns manager with wildcard support

    • Real-time progress tracking with statistics

    • Color-coded log output (success, error, warning, info)

    • System information display (hostname, IP address)

    • Settings persistence between sessions

  • Build & Development Tools:

    • invoke gui-electron - Launch packaged app (recommended)

    • invoke gui-electron-package - Package app into .app bundle and DMG

    • invoke gui-electron-build - Build TypeScript source

    • invoke gui-electron-test-install - Semi-automated installation testing

      • Automated mode (--automated flag) for CI/CD

      • Automatic app quit after testing

      • Full cleanup of app data and preferences

  • Documentation:

    • Updated README with Electron GUI usage

    • Added installation and testing instructions

    • Documented new invoke tasks

Changed

  • GUI Client: Replaced Kivy GUI with Electron + TypeScript implementation

    • Better cross-platform support

    • More native look and feel

    • Easier to maintain and extend

    • Modern web technologies (HTML, CSS, TypeScript)

Technical

  • Electron application structure:

    • src/main.ts - Main process with IPC handlers

    • src/preload.ts - Secure IPC bridge

    • src/renderer/ - UI components (HTML, CSS, TypeScript)

  • electron-builder configuration for packaging

  • TypeScript compilation with strict type checking

  • Automated testing with installation/uninstallation verification

[0.4.2] - 2025-10-30

Changed

  • License: Changed from MIT to Apache License 2.0

  • Project Description: Updated to “File and Metadata storage system”

  • Documentation: Added Apache 2.0 license badge to README

[0.4.1] - 2025-10-30

Fixed

  • Documentation Code Examples: Corrected all code examples in documentation to use actual API field names

    • Fixed incorrect field names: size → file_size, permissions → file_mode, owner → file_uid, group → file_gid

    • Fixed timestamp format: ISO 8601 strings → Unix timestamps (float)

    • Fixed async/await syntax in test examples

    • Affected files: docs/development.md, docs/api-reference.md, docs/troubleshooting.md

  • Test Infrastructure: Fixed parallel test execution race conditions

    • Switched from global variable modification to FastAPI dependency overrides

    • Added per-worker database isolation for thread-safe parallel testing

    • Fixed test_e2e_duplicate_files_different_hosts intermittent failure

  • Server Management: Fixed ppserver restart reliability

    • Added port availability checking with 10-second timeout

    • Prevents “address already in use” errors during restart

    • Fixed test_ppserver_restart test failure

Changed

  • Authentication System: Refactored to use dependency injection

    • Added get_auth_db() helper function for database dependency

    • Updated get_current_api_key() and get_optional_api_key() to use proper dependency injection

    • Improves testability and thread-safety for parallel test execution

[0.4.0] - 2025-01-17

Added

Web Interface Enhancements

  • File Cloning Detection: Added clone button next to info button for files with identical SHA256 hashes

    • Shows count of duplicate files in user’s collection

    • Displays all clones across all users (cross-user clone detection)

    • Modal with detailed table showing hostname, filepath, size, and status

    • Special handling for zero-length files (shows “0” disabled button)

    • Non-zero files always have active clone button for discovering epoch files

Epoch File Management

  • Epoch File Highlighting: First uploaded file with content (epoch file) is visually distinguished

    • Green background highlighting (#d4edda)

    • Green left border (4px) and bottom border (2px)

    • Green “EPOCH” badge for clear identification

    • Automatic sorting: epoch file first, then metadata-only files

    • Cross-user epoch file linking: metadata files can now link to epoch files uploaded by other users

Visual Improvements

  • Zero-Length File Indicators: Special icon (📭) for empty files

  • Improved Modal Layout:

    • Increased modal width from 700px to 1200px for better visibility

    • Added scrolling support for long file lists

    • Fixed table layout with proper column widths

    • Word wrapping for long file paths

    • Responsive design with max-height constraints

Client Improvements

  • Graceful Interrupt Handling: ppclient now handles Ctrl-C cleanly

    • Finishes processing current file before exiting

    • Displays partial completion status

    • Shows count of remaining unprocessed files

    • Second Ctrl-C forces immediate termination

    • Proper exit codes for automation/scripting

Changed

  • Clone detection now queries all files across all users, not just current user’s files

  • Clone button is now always active for non-zero-length files (removed disabled state for single files)

  • Modal content area now uses flexbox layout for better scrolling behavior

Technical

  • Added new API endpoint: GET /api/clones/{sha256} - Retrieve all files with identical SHA256 across all users

  • Added new database method: get_files_by_sha256() - Query files by SHA256 hash with epoch file sorting

  • Added signal handling (SIGINT) to ppclient for graceful shutdown

  • Improved CSS styling for modal dialogs and table layouts

[0.3.0] - Previous Release

Features

  • File metadata storage with SHA256 hashing

  • User authentication with JWT tokens

  • API key management via web interface

  • Multiple storage backends (local filesystem, AWS S3)

  • Web-based file browser with tree layout

  • File details modal with comprehensive metadata

  • TOML-based configuration

  • MongoDB database integration

  • Comprehensive test suite (115+ tests)

Note: This is the first release with a formal changelog. Previous changes are summarized under version 0.3.0.