Merge TimeIndex + Sleep/Workouts #37
Merged
Conversation
This file contains 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
# *Adding Time Index To HealthKit Sample Uploads*
## ♻️ Current situation & Problem
As we are transitioning the backend to an architecture that doesn't
depend on cloud functions and periodic featurization, we are working on
efficient data fetching queries in Firebase. Many HealthKit data types
are associated with a time _range_, not a timestamp. This complicates
Firebase queries since queries like
```
collection.where(filter=("timeRange.start", "<=", queryEnd)
.where(filter=FieldFilter("timeRange.end", ">=", queryStart))
```
are not permitted due to inequality filters on multiple properties.
Instead, I am proposing adding the following fields to each HealthKit
upload:
```
time.range: bool // whether the sample is a time range or time stamp type
// if time.range = false, not .end properties are set
time.year.start, time.year.end: int
time.month.start, time.month.end: int
time.day.start, time.day.end: int
time.hour.start, time.hour.end: int
time.minute.start, time.minute.end: int
time.second.start, time.second.end: int
time.dayMin.start, time.dayMin.end: int // how many total minutes have elapsed, between [0, 1439]
time.15minBucket.start, time.15minBucket.end // which 15 min bucket the sample falls into, between [0,95]
```
in addition, we will also have ranges for each time index component,
such as
```
time.15minBucket.range = [45, 46, 47] // sample falls between 11:15-12:00
```
which will allow us to make efficient Firebase [array membership
queries](https://firebase.google.com/docs/firestore/query-data/queries#array_membership)
## ⚙️ Release Notes
* Added a function `constructTimeIndex` in a new
`PrismaStandard+TimeIndex.swift` that computes the necessary time fields
## 📚 Documentation
N/A
## ✅ Testing
N/A
## 📝 Code of Conduct & Contributing Guidelines
By submitting creating this pull request, you agree to follow our [Code
of
Conduct](https://github.com/CS342/.github/blob/main/CODE_OF_CONDUCT.md)
and [Contributing
Guidelines](https://github.com/CS342/.github/blob/main/CONTRIBUTING.md):
- [x] I agree to follow the [Code of
Conduct](https://github.com/CS342/.github/blob/main/CODE_OF_CONDUCT.md)
and [Contributing
Guidelines](https://github.com/CS342/.github/blob/main/CONTRIBUTING.md).
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #37 +/- ##
==========================================
- Coverage 36.19% 35.85% -0.34%
==========================================
Files 43 44 +1
Lines 1622 1699 +77
==========================================
+ Hits 587 609 +22
- Misses 1035 1090 +55
... and 2 files with indirect coverage changes Continue to review full report in Codecov by Sentry.
|
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.
No description provided.