Skip to content

Latest commit

 

History

History
356 lines (253 loc) · 22.9 KB

CHANGELOG.md

File metadata and controls

356 lines (253 loc) · 22.9 KB

Changelog

All notable changes to Q Welcome will be documented in this file.

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

[Unreleased]

Added

  • Tap-First Template Library - Added whole-card template selection, long-press previews, compact overflow actions, tag filtering, search, Rename, and a clear active-template indicator for faster field use.
  • Template Selection Test Coverage - Added persistence and Compose coverage for recency ordering, Undo, invalid templates, tags, Rename, IME focus, and lifecycle event ownership.

Changed

  • Focused Template Editor - Reworked the template editor into a dedicated message workspace with placeholder insertion, keyboard-safe controls, tag management, validation feedback, and unsaved-change protection.
  • Template Recency and Undo - Persist template last-used timestamps and provide a transaction-safe Undo action after changing the active template.

Fixed

  • Import Template Restore - Restore an imported active template without incorrectly recording it as a local template use.

[2.7.3] - 2026-04-18

Added

  • UI Tests for Template Editor - Added comprehensive automated UI tests for the Template Editor screen ensuring reliable validation, character limit handling, and discard dialog behavior.

Changed

  • Dependency Updates - Updated various core dependencies to their latest stable versions for 2026:
    • Kotlin 2.3.20
    • Compose BOM 2026.03.01
    • Android Gradle Plugin 9.1.1
    • Navigation Compose 2.9.7
    • Firebase BOM 34.12.0
    • Protobuf 4.34.1
  • Gradle 10 Compatibility - Resolved various deprecation warnings including multi-string dependency notation in the proto module and deprecated ClipboardManager APIs.

Fixed

  • Code Quality Cleanup - Fixed multiple Kotlin compiler warnings, removed unnecessary non-null assertions, and migrated to modern LocalClipboard APIs (Note: Navigator.kt continues to use the standard system ClipboardManager as it operates outside the Compose context).

[2.7.2] - 2026-02-18

Fixed

  • QR Sheet Reappear Bug - QR code bottom sheet no longer silently reopens after a user clears the SSID or password and then re-enters valid values; sheet state is now managed in the ViewModel with an automatic guard that resets the sheet whenever QR conditions become invalid
  • QR Enabled Logic Centralized - Moved qrEnabled computation from the composable into CustomerIntakeUiState as a derived property and showQrSheet into ViewModel state, making both testable and consistently enforced across all state transitions

Changed

  • AGP 9.0.0 → 9.0.1 - Updated Android Gradle Plugin to latest patch release
  • Kotlin 2.0.21 → 2.2.10 - Updated Kotlin to latest release
  • Gradle 9.1.0 → 9.2.1 - Updated Gradle wrapper distribution

Documentation

  • Release Guide Phase 0 - Documented the required pre-release flow: all fix/feature PRs must be merged into master before the release branch is cut

[2.7.1] - 2026-02-12

Fixed

  • Template Editor Keyboard Overlap - Replaced dialog-based template editing with a dedicated full-screen editor route so keyboard insets no longer hide editor actions, while preserving validation and unsaved-change protections

[2.7.0] - 2026-02-11

Added

  • Template Tags and Filtering - Added template tags in the editor, tag suggestions, and tag filter chips in template management for faster organization and lookup
  • Template Count Soft-Limit Warning - Added a dismissible warning banner when template count exceeds 20 to help keep the app responsive with large template sets
  • Recent Share Targets - Added recent share target memory and quick-share actions in export so frequently used apps are one tap away

Changed

  • Share Flow Enhancements - Improved sharing with optional subjects, direct share-to-app support, and chooser target tracking to streamline repeat exports
  • Import/Export Roadmap Organization - Moved JSON import/export roadmap and related archived planning docs under docs/ARCHIVE for clearer documentation structure
  • Build Docs Clarity - Updated README build/test instructions for Windows and Unix workflows, including Gradle daemon metadata notes

Fixed

  • Share Target Error Handling - Hardened share target resolution and fallback behavior to avoid failures when apps are unavailable or restricted
  • Imported Default Template Selection - Fixed default template activation after import when conflict resolution remaps template IDs

[2.6.1] - 2026-02-10

Fixed

  • App Installer Robustness - Enhanced install intent creation to verify install activity exists before launching, preventing crashes on devices without package managers
  • SHA256 Digest Parsing - Fixed extractSha256Hex() to handle case-insensitive "sha256:"/"SHA256:" prefix normalization for better digest compatibility
  • Signer Set Validation - Fixed signerSetsMatch() to correctly handle empty installer or archive signer sets, returning false instead of throwing exceptions
  • Update Installation Message - Corrected error message resource reference to display appropriate "update installation unavailable" message instead of browser error text

Changed

  • Installer Intent Creation - Refactored to use setDataAndType() with MIME type constant for more robust APK installation handling

[2.6.0] - 2026-02-09

Added

  • In-App Updater - Implemented GitHub-based automatic update checking and installation for users outside the Play Store with DownloadManager integration, signer fingerprint validation, and background download support
  • AppUpdater Interface - New abstraction layer for update operations enabling testable update flows and dependency injection in ViewModels
  • GitHubAppUpdater Implementation - Production updater service handling GitHub release API queries, APK download management, and secure package installation with full signer verification
  • UpdateChecker Enhancements - Expanded release parsing to extract APK download URLs, file sizes, and publication timestamps for comprehensive update metadata
  • Update UI in Settings - Added update checking, download progress, and install prompts in SettingsScreen with visual indicators for available updates and download status
  • FakeAppUpdater Test Double - Created test implementation of AppUpdater for isolated ViewModel and UI testing without network or system dependencies
  • Compose UI Tests for Update Dialog - Added SettingsScreenUpdateDialogTest covering update available/checking/error states, download progress, and install prompts
  • Comprehensive Updater Unit Tests - Created GitHubAppUpdaterTest (301 lines) with tests for download status parsing, signer validation, and update metadata extraction
  • UpdateChecker Test Coverage - Expanded UpdateCheckerTest with edge cases for empty assets, non-APK files, and malformed release responses

Changed

  • SettingsViewModel Update State Management - Enhanced with UpdateState sealed class (Idle/Checking/Available/Error), download progress tracking, and lifecycle-aware download status polling
  • Settings Screen Layout - Reorganized to accommodate update checking UI with polished error handling, download progress bars, and install action buttons
  • AndroidManifest Permissions - Added REQUEST_INSTALL_PACKAGES permission and package visibility queries for Android 11+ install intent compatibility
  • FileProvider Configuration - Created file_paths.xml with external downloads path mapping for secure APK file sharing during installation

Fixed

  • Test Cursor Mocking - Replaced framework MatrixCursor with fully mocked Cursor in GitHubAppUpdaterTest to ensure reliable unit test execution without Robolectric
  • Compose Lint Error - Pre-captured stringResource() values before LaunchedEffect blocks in SettingsScreen to satisfy LocalContextGetResourceValueCall lint rule
  • APK Signer Key Rotation - Enhanced getSignerFingerprints to include signingCertificateHistory for apps using Android key rotation, preventing false rejections of valid upgrades
  • DownloadManager Roaming - Set setAllowedOverRoaming(false) to prevent unexpected data charges for users on roaming networks
  • Exception Handling Specificity - Replaced broad Exception catches with targeted IOException and IllegalArgumentException handlers in updater code for precise error diagnosis

[2.5.0] - 2026-02-09

Added

  • Comprehensive Test Coverage - Added Compose UI tests for CustomerIntakeScreen with 144 test cases, DataStore migration tests, and ViewModel tests for Import and Settings screens ensuring robust functionality across the app
  • FakeNavigator and FakeSoundPlayer Test Utilities - Created test doubles for improved test isolation and behavior verification in unit and integration tests
  • SoundPlayer Interface - New abstraction layer for audio feedback decoupling UI components from concrete SoundManager implementation for improved testability
  • WiFi Validation Rules - Centralized validation constants and logic in dedicated WifiValidationRules utility for consistent WiFi SSID and password validation across the app
  • Modular Import/Export Services - Split monolithic ImportExportRepository into focused services: ExportService, ImportValidationService, and ImportApplyService for better maintainability
  • Settings Store Mappers - Extracted proto mapping logic into dedicated SettingsStoreMappers module separating data transformation from storage operations
  • DataStore Migration Module - Moved Preferences-to-Proto migration logic into standalone PreferencesToProtoMigration class with comprehensive error handling
  • Template Metadata Fields - Added sortOrder and tags fields to Template proto for future customization and categorization features

Changed

  • SoundManager Lifecycle Management - Wired SoundManager to ProcessLifecycleOwner in QWelcomeApplication for automatic cleanup when app backgrounds, preventing audio resource leaks
  • UI Sound Decoupling - Replaced direct SoundManager calls in UI components with SoundPlayer interface via CompositionLocal, enabling dependency injection and testable sound feedback
  • Refactored Large Composables - Split 489-line CustomerIntakeScreen into focused sub-composables (GradientHeader, form components) improving readability and maintainability
  • Template List Screen Reorganization - Restructured TemplateListScreen with improved layout, better error messaging, and enhanced user feedback
  • Import/Export Error Handling - Comprehensive error message localization and improved validation feedback across import and export workflows
  • AppViewModelFactory Optimization - Cached ViewModelFactory instance using remember {} in MainActivity preventing unnecessary recreations on recomposition
  • Replaced Material Components Theme - Switched from Theme.MaterialComponents.DayNight.NoActionBar to Theme.AppCompat.DayNight.NoActionBar in themes.xml removing unused Material View dependency
  • Updated AppCompat Dependency - Removed direct com.google.android.material:material usage, added explicit androidx.appcompat:appcompat:1.7.1 via version catalog
  • UiEvent Sealed Classes - Converted sealed class instances from object to data object following Kotlin 1.9+ best practices for better debugging output

Fixed

  • Import ViewModel String Resource - Corrected string resource reference in ImportViewModel error handling
  • Settings ViewModel Externalization - Moved hardcoded strings to string resources for proper localization support
  • Export Status Emoji - Removed unnecessary emoji from export status string for cleaner UI presentation

Removed

  • ExampleInstrumentedTest.kt - Removed default Android Studio placeholder test file
  • Unused View Material Dependency - Eliminated dependency on com.google.android.material:material reducing APK size and build complexity

[2.4.0] - 2026-02-08

Added

  • String Resources for Localization - Migrated all hardcoded UI strings to strings.xml across CustomerIntakeScreen, SettingsScreen, NeonComponents, QrCodeBottomSheet, ExportScreen, ImportScreen, and TemplateListScreen with comprehensive accessibility support including content descriptions for screen readers
  • NeonDropdownMenuBox Component - New cyberpunk-styled dropdown wrapper component that encapsulates Material3 ExposedDropdownMenuBox with experimental API annotations, providing reusable dropdown functionality with consistent theming
  • NeonTopAppBar Component - New cyberpunk-styled top app bar wrapper component that encapsulates Material3 TopAppBar with experimental API annotations, ensuring consistent navigation bar styling across screens
  • SoundManager Lifecycle Management - App-level lifecycle observer in QWelcomeApplication for automatic SoundManager restart on app foreground and shutdown on background with comprehensive error handling and Crashlytics logging
  • Lifecycle Process Dependency - Added androidx.lifecycle:lifecycle-process for ProcessLifecycleOwner support in app lifecycle management

Changed

  • WiFi Validation Refactoring - Centralized SSID and password validation logic in WifiQrGenerator utility, removing duplicate validation code from CustomerIntakeViewModel and improving maintainability
  • Experimental API Isolation - Removed @OptIn(ExperimentalMaterial3Api::class) annotations from screen composables (CustomerIntakeScreen, SettingsScreen) by encapsulating experimental APIs in dedicated wrapper components
  • AppViewModelFactory Optimization - Use remember {} in MainActivity to cache ViewModelFactory instance, preventing unnecessary recreations on recomposition
  • Lifecycle Version Consolidation - Unified lifecycle dependency versions in libs.versions.toml using single lifecycle = "2.10.0" reference instead of separate version entries for runtime, viewmodel-compose, and process artifacts
  • Build Configuration - Enabled Gradle parallel builds in gradle.properties and added KotlinJvmCompile configuration in app/build.gradle.kts for explicit JVM target specification
  • Error Handling - Enhanced SoundManager lifecycle error handling to pass exceptions directly to Crashlytics with contextual logging instead of RuntimeException wrapping, preserving original exception types for better diagnostics
  • Code Organization - Moved companion object placement in QWelcomeApplication to end of class per Kotlin style conventions
  • Import Structure - Migrated wildcard imports to explicit imports in SettingsScreen for improved code clarity
  • Sealed Class Instances - Converted object to data object for UiEvent sealed class instances following Kotlin best practices
  • Bump Script Changelog Handling - Fixed PowerShell bump-version.ps1 to properly move [Unreleased] entries to version headings using state machine approach, replacing broken regex-based implementation

Fixed

  • Accessibility - Added comprehensive content descriptions for all interactive UI elements including buttons, icons, dropdowns, and navigation elements to improve screen reader support
  • Annotation Placement - Relocated @OptIn annotations from file level to function level for better code clarity and reduced annotation scope

Removed

  • ExampleUnitTest.kt - Removed unused placeholder test file from test source set

[2.3.3] - 2026-02-07

Added

  • Comprehensive Haptic Feedback - All interactive UI elements now provide tactile feedback for improved user experience:
    • Back navigation buttons across all screens
    • Template list actions (create, edit, duplicate, delete)
    • Export screen checkboxes and export option cards
    • Settings screen buttons (save, discard, check for updates)
    • Customer intake dropdown menu items and network toggle
    • Template variable copy buttons
    • Search field clear button
  • Release Documentation - Added comprehensive docs/RELEASE_GUIDE.md with step-by-step release workflow for AI agents
  • Import Size Validation - Enhanced import size limit messaging with dedicated formatBytesAsMb() helper
  • Enhanced Error Logging - Added stack trace logging for QR code save/share failures and file save errors for better diagnostics

Changed

  • Consolidated duplicate SecurityException/IOException handling in export file save flow
  • Updated Copilot instructions to reference release guide documentation

Fixed

  • Code Quality - Removed excessive trailing blank lines in UpdateChecker.kt

[2.3.1] - 2026-02-02

Fixed

  • Tech Profile Import Sync - Settings screen now immediately displays imported tech profile data (name, title, dept) without requiring navigation away and back
  • Legacy JSON Support - Added backward compatibility for older exports using "area" field instead of "dept"

Changed

  • Added LaunchedEffect in SettingsScreen to sync local state with imported data
  • Enhanced ExportedTechProfile with fallback logic for area/dept fields

[2.3.0] - 2026-02-01

Added

  • Real-time Placeholder Validation - Template editor shows missing required placeholders as you type
  • Discard Changes Dialog - Confirmation prompt when dismissing editor with unsaved changes
  • Template Search - Filter templates by name in the template list
  • Interactive Placeholder Chips - Tap chips to insert placeholders at cursor position
  • Keyboard Navigation - Name field → Next → focuses Content field in template editor
  • Template.sortOrder field for custom template ordering (default pinned at top)
  • Template.tags field for future categorization features
  • Template.findMissingPlaceholders() with whitespace-tolerant regex validation
  • Template.hasRequiredPlaceholders() convenience helper
  • InteractivePlaceholderChip component with haptic feedback
  • CollapsiblePlaceholderChips FlowRow component with expand/collapse
  • PlaceholderLabels object for short display labels
  • TemplateTest with 16 test cases for placeholder validation
  • docs/WEB_PORTAL_README.md for companion config generator web tool

Changed

  • Template Editor Dialog - Increased height to 85% for comfortable editing
  • Template Cards - Compact layout with always-visible action icons (edit, duplicate, delete)
  • Settings Screen - Removed inline template editing, now links to dedicated Templates screen
  • TemplateListViewModel validates required placeholders before save
  • TemplateListUiState now includes searchQuery and validationError fields

Removed

  • Inline template editing from Settings screen (~200 lines of code)
  • safeTruncate() helper function (no longer needed)

[2.2.0] - 2026-02-01

Added

  • Firebase Crashlytics - Production crash reporting with automatic stack traces (disabled in debug)
  • Open Network WiFi Support - Generate password-free QR codes for guest networks with WIFI:T:nopass format
  • Template Variables Sheet - Bottom sheet showing all available placeholders with copy-to-clipboard
  • Settings Rate Limiting - 60-second cooldown on update checks to prevent GitHub API abuse
  • Version Comparator - Full SemVer 2.0 support with proper pre-release and build metadata handling
  • Build-Logic Convention Plugins - Gradle convention plugins for centralized Android and Compose configuration
  • New string resources for update check feedback and WiFi labels
  • TimeProvider interface for testable, monotonic time sources
  • FakeTimeProvider for unit tests with manual time control
  • 3 new unit tests for auto-clear and process death scenarios

Changed

  • BREAKING: Jetpack Navigation Compose - Replaced manual Screen enum with type-safe @Serializable routes
  • Settings UI - Reorganized with Save button at top, dismissible update notifications, About section at bottom
  • Cyberpunk Theme - Added disabled state styling for NeonOutlinedField, Danger Zone uses NeonButton with error glow
  • Password Validation - Automatically skipped for open networks, enabling password-free WiFi configurations
  • QR Section - Shows "Open (No Password)" for unsecured networks instead of requiring password
  • Error Handling - Better browser failure handling and rate-limit detection for update checks
  • CustomerIntakeViewModel now uses SavedStateHandle to persist background timestamp
  • Navigator.copyToClipboard() now returns Boolean to indicate success/failure
  • All interval timing uses monotonic clock instead of wall clock

Fixed

  • Issue 2: Removed unused template_var_service_type string resource
  • Issue 3: Auto-clear timeout now persists across process death using SavedStateHandle
  • Issue 4: Switched to SystemClock.elapsedRealtime() for interval timing (immune to clock changes)
  • Issue 5: Added error handling and accurate feedback for clipboard operations
  • Rate-Limit Detection - Only treats HTTP 403 as rate-limited when X-RateLimit-Remaining: 0 header present
  • Version Comparison - Strips SemVer build metadata (+build) before parsing
  • Lifecycle Awareness - Settings events now collected with repeatOnLifecycle to prevent off-screen toasts
  • ProGuard Rules - Removed duplicate Firebase Crashlytics attribute rules
  • Build-Logic - Added package declaration and defensive checks for ApplicationExtension availability
  • Tech Signature Formatting - Consistent newline formatting between placeholder and auto-append paths

Technical

  • 20 comprehensive unit tests for VersionComparator (including build metadata handling)
  • 4 new tests for settings rate limiting
  • Navigation uses NavController for automatic back navigation handling
  • Convention plugins in build-logic/ for shared Gradle configuration

[2.1.0] - 2026-01-30

Added

  • Version bump script (scripts/bump-version.sh) for one-command releases
  • version.properties as single source of truth for app versioning
  • .gitattributes to enforce LF line endings for scripts

Changed

  • App version is now read dynamically from version.properties instead of hardcoded in build.gradle.kts
  • GitHub Actions release workflow now extracts real changelog content into the release body

Technical

  • ViewModel unit tests with test infrastructure
  • Updated dependencies for coroutinesTest, turbine, and mockk
  • Improved state collection with collectAsStateWithLifecycle
  • Cleaned up ProGuard rules and error handling in import/export screens

[1.0.0] - 2026-01-25

Added

  • Initial release of Q Welcome
  • Customer intake form with validation
  • SMS, Share, and Copy message options
  • WiFi QR code generation
  • Cyberpunk-themed UI with dark/light mode
  • Custom message templates
  • Template import/export functionality
  • Tech profile signature support
  • Auto-clear security feature (10-minute timeout)
  • Rate limiting to prevent accidental double-sends
  • Complete customer intake workflow
  • Template management system
  • Import/Export with JSON schema v1

Technical

  • MVVM architecture with Jetpack Compose
  • StateFlow for reactive state management
  • DataStore for local persistence
  • ProGuard rules for release builds