[Heartbeat Service] More null service protections added to triggerHeartBeat #7789
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
🦋 Changeset detectedLatest commit: e2a206a The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Size Report 1Affected Products
Test Logs |
Size Analysis Report 1This report is too large (141,122 characters) to be displayed here in a GitHub comment. Please use the below link to see the full report on Google Cloud Storage.Test Logs |
DellaBitta
commented
Nov 16, 2023
| @@ -90,6 +90,10 @@ export class HeartbeatServiceImpl implements HeartbeatService { | |||
| const date = getUTCDateString(); | |||
| if (this._heartbeatsCache?.heartbeats == null) { | |||
| this._heartbeatsCache = await this._heartbeatsCachePromise; | |||
| // If we failed to construct a heartbeats cache, then return immediately. | |||
| if (this._heartbeatsCache?.heartbeats == null) { | |||
There was a problem hiding this comment.
@hsubox76 perhaps this should just check if heartbeatsCache === null?
There was a problem hiding this comment.
I think the root problem is here:
or even one function back (readHeartbeatsFromIndexedDB). It's checking to see if whatever comes back from indexedDB is falsy but if it's (as I suspect) an empty object, this will go wrong. We have to make sure that whatever gets returned from this read() function is an object with a heartbeats property which is an array (e.g., matches typeHeartbeatsInIndexedDB), otherwise we are lying to typescript and so it can't protect us by catching errors further downstream.
There was a problem hiding this comment.
Ok, I updated the read() method (below) to ensure the returned object has a heartbeats field.
There was a problem hiding this comment.
I don't think this check should be needed anymore after the other change but I guess it doesn't hurt to be safe.
There was a problem hiding this comment.
Yeah, I feel like keeping it place just in case.
hsubox76
approved these changes
Nov 20, 2023
| @@ -90,6 +90,10 @@ export class HeartbeatServiceImpl implements HeartbeatService { | |||
| const date = getUTCDateString(); | |||
| if (this._heartbeatsCache?.heartbeats == null) { | |||
| this._heartbeatsCache = await this._heartbeatsCachePromise; | |||
| // If we failed to construct a heartbeats cache, then return immediately. | |||
| if (this._heartbeatsCache?.heartbeats == null) { | |||
There was a problem hiding this comment.
I don't think this check should be needed anymore after the other change but I guess it doesn't hurt to be safe.
DellaBitta
requested review from
lisajian,
prameshj,
renkelvin and
sam-gc
as code owners
Changeset File Check ✅
|
Merged
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Discussion
Users are reporting furhter issues with the heartbeat service returning a null cache on Opera. There's a case in
triggerHeartBeatwhich the code assumes that the cache was created properly.Add a check to ensure that the cache exists, and if not, returns immediately.
Testing
CI.
API Changes
N/A.