Merge pull request #124 from myty/bugfix/undefined-window-in-network-information-utils

Add check for undefined window and navigator as well as tests

Author: myty

src/utilities/network-information-utils.test.ts

@@ -4,10 +4,17 @@ import buildNetworkInformationUtils, {
 } from "./network-information-utils";
 
 const setupSut = (options?: {
+    buildNavigator?: boolean;
+    buildWindow?: boolean;
     connectionProperty?: string;
     onLine?: boolean;
 }): typeof NetworkInformationUtils => {
-    const { connectionProperty, onLine = false } = options ?? {};
+    const {
+        buildNavigator = true,
+        buildWindow = true,
+        connectionProperty,
+        onLine = false,
+    } = options ?? {};
 
     const buildMockNavigator = (): Navigator => {
         const isOnline = onLine ?? navigator.onLine;
@@ -23,9 +30,10 @@ const setupSut = (options?: {
         return { ...navigator, onLine: isOnline };
     };
 
-    const navigator = buildMockNavigator();
+    const navigator = buildNavigator ? buildMockNavigator() : undefined;
+    const window = buildWindow ? ({ navigator } as Window) : undefined;
 
-    return buildNetworkInformationUtils(navigator);
+    return buildNetworkInformationUtils(window);
 };
 
 describe("NetworkInformationUtils", () => {
@@ -53,6 +61,28 @@ describe("NetworkInformationUtils", () => {
             }
         );
 
+        test("when window.navigator is undefined, it returns undefined", () => {
+            // Arrange
+            const sut = setupSut({ buildNavigator: false });
+
+            // Act
+            const connection = sut.getNavigatorConnection();
+
+            // Assert
+            expect(connection).toBeUndefined();
+        });
+
+        test("when window is undefined, it returns undefined", () => {
+            // Arrange
+            const sut = setupSut({ buildWindow: false });
+
+            // Act
+            const connection = sut.getNavigatorConnection();
+
+            // Assert
+            expect(connection).toBeUndefined();
+        });
+
         test("when window.navigator does not have a known connection property, it returns undefined", () => {
             // Arrange
             const sut = setupSut();
@@ -113,6 +143,28 @@ describe("NetworkInformationUtils", () => {
                 expect(networkConnection.isOnline).toEqual(onLine);
             }
         );
+
+        test("when navigator is undefined, it returns undefined", () => {
+            // Arrange
+            const sut = setupSut({ buildNavigator: false });
+
+            // Act
+            const networkConnection = sut.getNetworkConnection();
+
+            // Assert
+            expect(networkConnection).toBeUndefined();
+        });
+
+        describe("when window is undefined, it returns undefined", () => {
+            // Arrange
+            const sut = setupSut({ buildWindow: false });
+
+            // Act
+            const networkConnection = sut.getNetworkConnection();
+
+            // Assert
+            expect(networkConnection).toBeUndefined();
+        });
     });
 
     // #endregion getNetworkConnection

src/utilities/network-information-utils.ts

@@ -1,28 +1,35 @@
+import { NetworkConnection } from "../interfaces/network-connection";
 import { NetworkInformation } from "../interfaces/network-information";
 import { Navigator } from "../types/navigator";
 
 // -----------------------------------------------------------------------------------------
 // #region Functions
 // -----------------------------------------------------------------------------------------
 
-export default function buildNetworkInformationUtils(navigator: Navigator) {
+export default function buildNetworkInformationUtils(window?: Window) {
+    const navigator: Navigator | undefined = window?.navigator;
+
     return {
         /**
          * Returns a NavigatorConnection object if one exists
          */
         getNavigatorConnection(): NetworkInformation | undefined {
             return (
-                navigator.connection ??
-                navigator.mozConnection ??
-                navigator.webkitConnection ??
+                navigator?.connection ??
+                navigator?.mozConnection ??
+                navigator?.webkitConnection ??
                 undefined
             );
         },
 
         /**
          * Returns a `NetworkConnection` object which is an aggregate of `navigator.connection` and `navigator.onLine`
          */
-        getNetworkConnection() {
+        getNetworkConnection(): NetworkConnection | undefined {
+            if (navigator == null) {
+                return undefined;
+            }
+
             const { onLine: isOnline } = navigator;
             const navigatorConnection = this.getNavigatorConnection() ?? {};
 
@@ -40,8 +47,6 @@ export default function buildNetworkInformationUtils(navigator: Navigator) {
 // #region Exports
 // -----------------------------------------------------------------------------------------
 
-export const NetworkInformationUtils = buildNetworkInformationUtils(
-    window.navigator
-);
+export const NetworkInformationUtils = buildNetworkInformationUtils(window);
 
 // #endregion Exports