Fix invalid database entries with all null sensor fields (fixes #95) #98
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
- Remove point markers from chart for cleaner visualization - Add chart selection support with hover interaction - Display value tooltip and vertical rule when hovering over chart - Show point marker only at selected position
Resolves #95 This fix prevents EntityStorageItem objects with all sensor fields set to nil from being written to the database. Empty items were previously created when HomeKit characteristic reading failed, polluting the database with meaningless data. Changes: - Add hasNoSensorData validation method to EntityStorageItem to detect items with all nil sensor fields - Add validation in EntityStorageDbRepository.add() that throws EntityStorageError.invalidData for empty items - Update HomeManager to catch and handle validation errors gracefully with debug-level logging - Update HMCharacteristic.getEntityStorageItem() to return nil instead of creating empty EntityStorageItem when errors occur - Add comprehensive unit tests for validation logic covering all 16 sensor field types - Add EntityStorageError.invalidData case for validation failures The fix implements defense in depth: 1. Source layer (HMCharacteristic): Returns nil on error instead of creating empty items 2. Persistence layer (EntityStorageDbRepository): Validates items before database write 3. Application layer (HomeManager): Handles validation errors without triggering assertions All tests pass and Swift package builds successfully.
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.
Summary
Fixes #95 - Prevents invalid database entries where all sensor fields are null by implementing validation at multiple layers.
Problem
The database was being polluted with entries where all sensor field columns are null. This occurred when HomeKit characteristic reading failed but the fallback
EntityStorageItem(entityId: entityId)was still written to the database.Solution
Implemented defense in depth across three layers:
HMCharacteristic.swift): Returnsnilon errors instead of creating empty itemsEntityStorageDbRepository.swift): Validates items before database writesHomeManager.swift): Gracefully handles validation errorsChanges
EntityStorageError.invalidDataerror typehasNoSensorDatacomputed property to validate all 16 sensor fieldsnilinstead of empty items on errorsTest Results
Test Plan
hasNoSensorDatafor all sensor typesFiles Changed
Sources/HAModels/EntityStorageItem.swift- Validation logicSources/Server/Models/EntityStorageDbRepository.swift- Repository validationSources/HAApplicationLayer/HomeManager.swift- Error handlingSources/Adapter/Extensions/HMCharacteristic.swift- Return nil on errorsTests/HomeAutomationKitTests/EntityStorageItemTests.swift- Unit tests (new)Tests/ServerTests/EntityStorageDbRepositoryTests.swift- Integration tests