fix(node): Time zone handling for cron
#11225
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
The `cron` package uses `timeZone`, while Sentry internally uses `timezone`. This caused Sentry cron jobs to be incorrectly upserted with no time zone information. Because of the use of the `...(timeZone ? { timeZone } : undefined)` idiom, TypeScript type checking did not catch the mistake.
I kept `cron`'s `timeZone` capitalization within Sentry's instrumentation and changed from the `...(timeZone ? { timeZone } : undefined)` idiom so TypeScript could catch mistakes of this sort. (Passing an undefined `timezone` appears to be okay, because Sentry's `node-cron` instrumentation does it.)
Closed
timfish
approved these changes
Mar 21, 2024
Lms24
approved these changes
Mar 21, 2024
|
Will backport this for v7 - release will come out soon! |
AbhiPrasad
pushed a commit
that referenced
this pull request
Mar 21, 2024
The `cron` package uses `timeZone`, while Sentry internally uses
`timezone`. This caused Sentry cron jobs to be incorrectly upserted with
no time zone information. Because of the use of the `...(timeZone ? {
timeZone } : undefined)` idiom, TypeScript type checking did not catch
the mistake.
I kept `cron`'s `timeZone` capitalization within Sentry's
instrumentation and changed from the `...(timeZone ? { timeZone } :
undefined)` idiom so TypeScript could catch mistakes of this sort.
(Passing an undefined `timezone` appears to be okay, because Sentry's
`node-cron` instrumentation does it.)
cadesalaberry
pushed a commit
to cadesalaberry/sentry-javascript
that referenced
this pull request
Apr 19, 2024
The `cron` package uses `timeZone`, while Sentry internally uses
`timezone`. This caused Sentry cron jobs to be incorrectly upserted with
no time zone information. Because of the use of the `...(timeZone ? {
timeZone } : undefined)` idiom, TypeScript type checking did not catch
the mistake.
I kept `cron`'s `timeZone` capitalization within Sentry's
instrumentation and changed from the `...(timeZone ? { timeZone } :
undefined)` idiom so TypeScript could catch mistakes of this sort.
(Passing an undefined `timezone` appears to be okay, because Sentry's
`node-cron` instrumentation does it.)
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.
The
cronpackage usestimeZone, while Sentry internally usestimezone. This caused Sentry cron jobs to be incorrectly upserted with no time zone information. Because of the use of the...(timeZone ? { timeZone } : undefined)idiom, TypeScript type checking did not catch the mistake.I kept
cron'stimeZonecapitalization within Sentry's instrumentation and changed from the...(timeZone ? { timeZone } : undefined)idiom so TypeScript could catch mistakes of this sort. (Passing an undefinedtimezoneappears to be okay, because Sentry'snode-croninstrumentation does it.)yarn lint) & (yarn test).