truncate timezone ID only if it is too long #311
Merged
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
jhoule86
commented
Feb 9, 2025
| normalizedZone | ||
| ) | ||
|
|
||
| Logging.i("Sending current time to watch: $now, timezone: ${normalizedZone}, offset: $timezoneOffsetMinutes") |
Contributor
Author
There was a problem hiding this comment.
Moving the log down to this line is admittedly trivial, but I felt that it helped the flow of the code, and prepares for the potential change to
Logging.i("Sending current time to watch: ${updateTimePacket}")
if/when there is a good toString implemented.
jhoule86
commented
Feb 9, 2025
| val normalizedZone = timezone.id | ||
| if (normalizedZone.length > MAX_TIMEZONE_NAME_LENGTH) { | ||
| normalizedZone = timezone.id.take(MAX_TIMEZONE_NAME_LENGTH) | ||
| Logging.i("Time Zone ${timezone.id} exceeds maximum value length and has been truncated to ${normalizedZone}") |
Contributor
Author
There was a problem hiding this comment.
Since this truncation
- is a recent addition - a436039
- most likely is an edge case
I felt it was worth being noisy about it in this separate log, instead of trying to shoehorn it into the existing log.
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.
This is an attempt at improving the efficiency and readability of the recently introduced Time Zone truncation code and its accompanying logs.
The current code in
masterwill always be callingtimezone.id.take(MAX_TIMEZONE_NAME_LENGTH)twice, for all Time Zones:The proposed code enforces consistency between the log and the packet sent to the watch, and only does costly String operations when absolutely necessary, by checking the length against the maximum.