SpeziStorage

[pauljohanneskraft]

SpeziStorage

♻️ Current situation & Problem

This pull request adds SpeziStorage functionality to this repository.

⚙️ Release Notes

Add a bullet point list summary of the feature and possible migration guides if this is a breaking change so this section can be added to the release notes.
Include code snippets that provide examples of the feature implemented or links to the documentation if it appends or changes the public interface.

📚 Documentation

Please ensure that you properly document any additions in conformance to Spezi Documentation Guide.
You can use this section to describe your solution, but we encourage contributors to document your reasoning and changes using in-line documentation.

✅ Testing

Please ensure that the PR meets the testing requirements set by CodeCov and that new functionality is appropriately tested.
This section describes important information about the tests and why some elements might not be testable.

📝 Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

• I agree to follow the Code of Conduct and Contributing Guidelines.

[codecov]

Codecov Report

Attention: Patch coverage is 86.60714% with 30 lines in your changes missing coverage. Please review.

Project coverage is 39.50%. Comparing base (0148cf3) to head (9da53d7).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
...stanford/spezi/modules/storage/local/KeyStorage.kt	75.00%	3 Missing and 8 partials ⚠️
...zi/modules/storage/credential/CredentialStorage.kt	82.86%	4 Missing and 2 partials ⚠️
...anford/spezi/modules/storage/local/LocalStorage.kt	92.73%	1 Missing and 3 partials ⚠️
...d/spezi/modules/storage/key/KeyValueStorageImpl.kt	90.33%	1 Missing and 2 partials ⚠️
...ezi/modules/storage/key/InMemoryKeyValueStorage.kt	71.43%	2 Missing ⚠️
...i/core/bluetooth/domain/BLEPairedDevicesStorage.kt	75.00%	0 Missing and 1 partial ⚠️
...pezi/modules/storage/credential/CredentialTypes.kt	85.72%	1 Missing ⚠️
...stanford/spezi/modules/storage/di/StorageModule.kt	90.00%	1 Missing ⚠️
...d/spezi/modules/storage/key/KeyValueStorageType.kt	66.67%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main     #108      +/-   ##
============================================
+ Coverage     38.91%   39.50%   +0.60%     
+ Complexity      797      768      -29     
============================================
  Files           256      261       +5     
  Lines         10358    10388      +30     
  Branches       1442     1457      +15     
============================================
+ Hits           4030     4103      +73     
+ Misses         5946     5916      -30     
+ Partials        382      369      -13     

Flag	Coverage Δ
uitests	33.45% <86.82%> (+2.65%)	⬆️
unittests	33.45% <75.00%> (-0.04%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...ord/spezi/modules/storage/credential/Credential.kt	100.00% <100.00%> (ø)
...pezi/modules/storage/key/KeyValueStorageFactory.kt	100.00% <100.00%> (ø)
...spezi/modules/storage/local/LocalStorageSetting.kt	100.00% <100.00%> (ø)
...i/core/bluetooth/domain/BLEPairedDevicesStorage.kt	98.42% <75.00%> (+1.23%)	⬆️
...pezi/modules/storage/credential/CredentialTypes.kt	85.72% <85.72%> (ø)
...stanford/spezi/modules/storage/di/StorageModule.kt	90.91% <90.00%> (+90.91%)	⬆️
...d/spezi/modules/storage/key/KeyValueStorageType.kt	66.67% <66.67%> (ø)
...ezi/modules/storage/key/InMemoryKeyValueStorage.kt	93.34% <71.43%> (-6.66%)	⬇️
...d/spezi/modules/storage/key/KeyValueStorageImpl.kt	90.33% <90.33%> (ø)
...anford/spezi/modules/storage/local/LocalStorage.kt	92.73% <92.73%> (ø)
... and 2 more

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0148cf3...9da53d7. Read the comment docs.

[pauljohanneskraft]

Currently, Android uses a different encryption mechanism than iOS for the files, but otherwise it pretty much follows the existing interface from iOS (couldn't find an exact match fast). I left out some of the platform-specific features of iOS (accessGroups, userPresence check, secure enclave, etc), if you know about Android-specific features that should be integrated or could replace the equivalent(s) in iOS, let me know!

[Basler182]

from my point of view, everything looks great in terms of code. regarding api adaptation to iOS, you and eldi are deeper into it. thank you for the adjustments and the implementation of the feedback. good work @pauljohanneskraft & @eldcn