@wojtekmaj/react-hooks/src/useCurrentPosition.spec.ts

A collection of React Hooks.

import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { renderHook, act } from '@testing-library/react';

import useCurrentPosition from './useCurrentPosition.js';

import type { Mock } from 'vitest';

const itIfWindowDefined = it.runIf(typeof window !== 'undefined');

describe('useCurrentPosition()', () => {
  let getCurrentPosition: Mock;
  let watchPosition: Mock;

  beforeEach(() => {
    if (typeof window !== 'undefined') {
      getCurrentPosition = vi.fn();
      watchPosition = vi.fn();

      const geolocation: Partial<Geolocation> = {
        getCurrentPosition,
        watchPosition,
        clearWatch: vi.fn(),
      };

      Object.defineProperty(navigator, 'geolocation', {
        configurable: true,
        enumerable: true,
        get: () => undefined,
      });

      vi.spyOn(navigator, 'geolocation', 'get').mockReturnValue(geolocation as Geolocation);
    }
  });

  afterEach(() => {
    vi.clearAllMocks();
  });

  it('should return null initially', () => {
    const { result } = renderHook(() => useCurrentPosition());

    expect(result.current).toBe(null);
  });

  itIfWindowDefined('should get initial position', () => {
    renderHook(() => useCurrentPosition());

    expect(getCurrentPosition).toHaveBeenCalledTimes(1);
  });

  itIfWindowDefined('should subscribe to position changes', () => {
    renderHook(() => useCurrentPosition());

    expect(watchPosition).toHaveBeenCalledTimes(1);
  });

  itIfWindowDefined('should update the flag when getCurrentPosition listener is called', () => {
    let listener: PositionCallback;
    getCurrentPosition.mockImplementationOnce((successCallback) => {
      listener = successCallback;

      return () => null;
    });

    const { result } = renderHook(() => useCurrentPosition());

    act(() => {
      listener({
        coords: {
          accuracy: 0,
          altitude: 0,
          altitudeAccuracy: 0,
          heading: 0,
          latitude: 0,
          longitude: 0,
          speed: 0,
        },
        timestamp: 0,
      });
    });

    expect(result.current).toEqual({
      accuracy: 0,
      altitude: 0,
      altitudeAccuracy: 0,
      heading: 0,
      latitude: 0,
      longitude: 0,
      speed: 0,
    });
  });

  itIfWindowDefined('should update the flag when watchPosition listener is called', () => {
    let listener: PositionCallback;
    watchPosition.mockImplementationOnce((successCallback) => {
      listener = successCallback;

      return () => 0;
    });

    const { result } = renderHook(() => useCurrentPosition());

    act(() => {
      listener({
        coords: {
          accuracy: 0,
          altitude: 0,
          altitudeAccuracy: 0,
          heading: 0,
          latitude: 0,
          longitude: 0,
          speed: 0,
        },
        timestamp: 0,
      });
    });

    expect(result.current).toEqual({
      accuracy: 0,
      altitude: 0,
      altitudeAccuracy: 0,
      heading: 0,
      latitude: 0,
      longitude: 0,
      speed: 0,
    });
  });
});