Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: disable network checker if navigator is unavailable #876

Merged
merged 2 commits into from
Sep 18, 2024
Merged

fix: disable network checker if navigator is unavailable #876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e0456e
fix: disable network checker if navigator is unavailable
izaaz Sep 17, 2024
ac29dec
chore: default offline to false
izaaz Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions packages/analytics-browser/src/plugins/network-connectivity-checker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,14 @@ export const networkConnectivityCheckerPlugin = (): BeforePlugin => {
};

const setup = async (config: BrowserConfig, amplitude: BrowserClient) => {
if (typeof navigator === 'undefined') {
config.loggerProvider.debug(
'Network connectivity checker plugin is disabled because navigator is not available.',
);
config.offline = false;
izaaz marked this conversation as resolved.
Show resolved Hide resolved
return;
}

config.offline = !navigator.onLine;

addNetworkListener('online', () => {
Expand Down
13 changes: 13 additions & 0 deletions packages/analytics-browser/test/plugins/network-connectivity-checker.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,17 @@ describe('networkConnectivityCheckerPlugin', () => {
expect(removeEventListenerSpy).toHaveBeenCalledWith('online', expect.any(Function));
expect(removeEventListenerSpy).toHaveBeenCalledWith('offline', expect.any(Function));
});

test('should do nothing when not on a browser', async () => {
const plugin = networkConnectivityCheckerPlugin();
// @ts-expect-error we are mocking a node.js environment
jest.spyOn(window, 'navigator', 'get').mockReturnValue(undefined);
const addEventListenerSpy = jest.spyOn(window, 'addEventListener');

await plugin.setup?.(config, amplitude);

expect(config.offline).toEqual(false);
expect(addEventListenerSpy).not.toHaveBeenCalled();
addEventListenerSpy.mockRestore();
});
});
Loading