-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Offline events are cached in the browser with localforage.
- Loading branch information
1 parent
a19e33e
commit b0d0260
Showing
4 changed files
with
155 additions
and
1 deletion.
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,99 @@ | ||
| import { addGlobalEventProcessor, getCurrentHub } from '@sentry/core'; | ||
| import { captureEvent } from '@sentry/minimal'; | ||
| import { Event, Integration } from '@sentry/types'; | ||
| import { getGlobalObject, uuid4 } from '@sentry/utils'; | ||
| import * as localforage from 'localforage'; | ||
|
|
||
| /** | ||
| * cache offline errors and send when connected | ||
| */ | ||
| export class Offline implements Integration { | ||
| /** | ||
| * @inheritDoc | ||
| */ | ||
| public static id: string = 'Offline'; | ||
|
|
||
| /** | ||
| * @inheritDoc | ||
| */ | ||
| public readonly name: string = Offline.id; | ||
|
|
||
| /** | ||
| * event cache | ||
| */ | ||
| public offlineEventStore: LocalForage; | ||
|
|
||
| /** | ||
| * @inheritDoc | ||
| */ | ||
| public constructor() { | ||
| this.offlineEventStore = localforage.createInstance({ | ||
| name: 'sentry/offlineEventStore', | ||
| }); | ||
|
|
||
| getGlobalObject<Window>().addEventListener('online', () => { | ||
| this._sendEvents().catch(() => { | ||
| // todo: handle localforage error | ||
| }); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * @inheritDoc | ||
| */ | ||
| public setupOnce(): void { | ||
| addGlobalEventProcessor(async (event: Event) => { | ||
| if (getCurrentHub().getIntegration(Offline)) { | ||
| const global = getGlobalObject<Window>(); | ||
|
|
||
| // cache if we are positively offline | ||
| if ('navigator' in global && 'onLine' in global.navigator && !global.navigator.onLine) { | ||
| try { | ||
| await this._cacheEvent(event); | ||
| } catch (error) { | ||
| // todo: handle localforage error | ||
| } | ||
|
|
||
| // return null on success or failure, because being offline will still result in an error | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| return event; | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * cache an event to send later | ||
| * @param event an event | ||
| */ | ||
| private async _cacheEvent(event: Event): Promise<Event> { | ||
| return this.offlineEventStore.setItem(uuid4(), event); | ||
| } | ||
|
|
||
| /** | ||
| * purge event from cache | ||
| */ | ||
| private async _purgeEvent(cacheKey: string): Promise<void> { | ||
| return this.offlineEventStore.removeItem(cacheKey); | ||
| } | ||
|
|
||
| /** | ||
| * send all events | ||
| */ | ||
| private async _sendEvents(): Promise<void> { | ||
| return this.offlineEventStore.iterate((event, cacheKey, _index) => { | ||
| try { | ||
| const newEventId = captureEvent(event); | ||
|
|
||
| if (newEventId) { | ||
| this._purgeEvent(cacheKey) | ||
| .then(_ => _) | ||
| .catch(_ => _); | ||
| } | ||
| } catch (error) { | ||
| // handle JSON.parse error | ||
| } | ||
| }); | ||
| } | ||
| } |
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