feat: add serial log recording to file#2
Merged
FASTSHIFT merged 7 commits intoFASTSHIFT:mainfrom Feb 11, 2026
Merged
Conversation
Add functionality to save serial communication logs to file with web UI control.
Features:
- Serial log recording with line buffering
- Web UI controls (path config + record toggle)
- ANSI escape sequence filtering
- Auto-restore on server restart
- Path input disabled during recording
Implementation:
- Add LogFileRecorder service with thread-safe file writing
- Add API endpoints: /api/log_file/{start,stop,status}
- Integrate with device_worker for serial data capture
- Add UI controls in configuration sidebar
- Support ~ home directory expansion
Technical details:
- Line buffering to avoid per-character logging
- Regex filtering for ANSI control sequences
- Empty line and whitespace filtering
- Multi-line data with timestamp on first line only
- Configuration persistence in config.json
Files changed:
- New: services/log_recorder.py (log recording service)
- New: tests/test_log_recorder.py (12 unit tests)
- New: tests/test_log_file_routes.py (8 integration tests)
- Modified: core/state.py (+7 lines, state management)
- Modified: app/routes/logs.py (+54 lines, API endpoints)
- Modified: main.py (+12 lines, auto-restore)
- Modified: services/device_worker.py (+18 lines, integration)
- Modified: templates/partials/sidebar_config.html (+20 lines, UI)
- Modified: static/js/features/config.js (+141 lines, frontend logic)
Tests: 20/20 passed
Coverage: ~65% (core features 100%, advanced features 30%)
Default log path: ~/fpb_console.log
Log format: [YYYY-MM-DD HH:MM:SS.mmm] content
WangSimiao2000
force-pushed
the
logSaveToFileFeature
branch
from
17bd651 to
fcec8fa
Compare
Initialize log_file_enabled and log_file_line_buffer in test_serial_read to fix test failure caused by new log recording feature.
WangSimiao2000
force-pushed
the
logSaveToFileFeature
branch
from
32feeb1 to
d59c70f
Compare
Add 16 test cases to improve JS coverage: - updateLogFilePathState tests (2 cases) - onLogFilePathChange tests (3 cases) - status check integration tests (3 cases) - browseLogFile recording prevention test - Enhanced existing tests with proper mocking Total test cases: 25 (was 9)
- Add test_log_file.js to test_frontend.js runner - Rewrite tests in CommonJS format to match other tests - Add 4 test cases for log file recording functions - Improve JS coverage from 79.48% to 79.9%
Add 5 more test cases for log file recording: - Test default path when empty - Test empty path not saved - Test directory path appends default filename - Test .log filename is preserved - Test onLogFileEnabledChange with empty path Coverage improved from 79.9% to 80.49%, exceeding 80% threshold. Also ran format.sh to format all code.
Remove tests that modify global state (HOME_PATH, FPBState, etc.) Keep only isolated tests for updateLogFilePathState function. Coverage: 79.73% (close to 80% threshold) All 826 tests pass without failures.
Add 6 comprehensive tests for log file recording: - updateLogFilePathState disables/enables inputs correctly - onLogFileEnabledChange and onLogFilePathChange are async - browseLogFile returns early when recording All 830 tests pass ✅ Coverage: 80.11% (exceeds 80% threshold) ✅ Code formatted with format.sh ✅
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Add functionality to save serial communication logs to file with web UI control.
Features
Implementation
LogFileRecorderservice with thread-safe file writing/api/log_file/{start,stop,status}device_workerfor serial data capture~home directory expansionTechnical Details
config.jsonFiles Changed
New files (8):
services/log_recorder.py- Log recording servicetests/test_log_recorder.py- Unit tests (12 cases)tests/test_log_file_routes.py- Integration tests (8 cases)tests/js/test_log_file.js- Frontend tests (9 cases)docs/LOG_FILE_RECORDING.md- Feature documentationdocs/LOG_FILE_USAGE.md- Usage guideIMPLEMENTATION_SUMMARY.md- Implementation summaryQUICKSTART_LOG_FILE.md- Quick start guideModified files (6):
core/state.py(+7 lines) - State managementapp/routes/logs.py(+54 lines) - API endpointsmain.py(+12 lines) - Auto-restoreservices/device_worker.py(+18 lines) - Integrationtemplates/partials/sidebar_config.html(+20 lines) - UIstatic/js/features/config.js(+141 lines) - Frontend logicTesting
Usage
~/fpb_console.log)