import React from 'react'; import Enzyme, { shallow, mount } from 'enzyme'; import Adapter from '@wojtekmaj/enzyme-adapter-react-17'; import { createFakeGoogleReference, createFakeMapInstance, } from '../../test/mockGoogleMaps'; import GoogleMaps from '../GoogleMaps'; import GoogleMapsContext from '../GoogleMapsContext'; Enzyme.configure({ adapter: new Adapter() }); describe('GoogleMaps', () => { const defaultProps = { google: createFakeGoogleReference(), initialZoom: 1, initialPosition: { lat: 0, lng: 0, }, mapOptions: {}, onChange: () => {}, onIdle: () => {}, shouldUpdate: () => true, position: null, boundingBox: null, }; const simulateMapReadyEvent = (google) => { google.maps.event.addListenerOnce.mock.calls[0][2](); }; const simulateEvent = (fn, eventName, event) => { fn.addListener.mock.calls.find((call) => call.includes(eventName))[1]( event ); }; it('expect render correctly without the map rendered', () => { const props = { ...defaultProps, }; const wrapper = shallow(
This is the children
); expect(wrapper).toMatchSnapshot(); expect(wrapper.find('[testId]').exists()).toBe(false); }); it('expect render correctly with the map rendered', () => { const google = createFakeGoogleReference(); const props = { ...defaultProps, google, }; const wrapper = shallow(
This is the children
); expect(wrapper).toMatchSnapshot(); expect(wrapper.find('[testId]').exists()).toBe(false); simulateMapReadyEvent(google); expect(wrapper).toMatchSnapshot(); expect(wrapper.find('[testId]').exists()).toBe(true); }); describe('creation', () => { it('expect to create the GoogleMaps on didMount with the default options', () => { const google = createFakeGoogleReference(); const props = { ...defaultProps, google, }; mount(); expect(google.maps.Map).toHaveBeenCalledTimes(1); expect(google.maps.Map).toHaveBeenCalledWith(expect.any(HTMLDivElement), { mapTypeControl: false, fullscreenControl: false, streetViewControl: false, clickableIcons: false, zoomControlOptions: { position: 'left:top', }, }); }); it('expect to create the GoogleMaps on didMount with the given options', () => { const google = createFakeGoogleReference(); const props = { ...defaultProps, mapOptions: { streetViewControl: true, otherOptionToPass: false, }, google, }; mount(); expect(google.maps.Map).toHaveBeenCalledTimes(1); expect(google.maps.Map).toHaveBeenCalledWith(expect.any(HTMLDivElement), { mapTypeControl: false, fullscreenControl: false, streetViewControl: true, clickableIcons: false, otherOptionToPass: false, zoomControlOptions: { position: 'left:top', }, }); }); it('expect to listen "idle" event once to setup the rest of the listeners', () => { const mapInstance = createFakeMapInstance(); const google = createFakeGoogleReference({ mapInstance, }); const props = { ...defaultProps, google, }; const wrapper = shallow(); expect(google.maps.event.addListenerOnce).toHaveBeenCalledTimes(1); expect(google.maps.event.addListenerOnce).toHaveBeenCalledWith( mapInstance, 'idle', expect.any(Function) ); expect(wrapper.instance().listeners).toHaveLength(1); }); it('expect to setup the rest of the listener when the map is ready', () => { const mapInstance = createFakeMapInstance(); const google = createFakeGoogleReference({ mapInstance, }); const props = { ...defaultProps, google, }; const wrapper = shallow(); simulateMapReadyEvent(google); expect(mapInstance.addListener).toHaveBeenCalledWith( 'center_changed', expect.any(Function) ); expect(mapInstance.addListener).toHaveBeenCalledWith( 'zoom_changed', expect.any(Function) ); expect(mapInstance.addListener).toHaveBeenCalledWith( 'dragstart', expect.any(Function) ); expect(mapInstance.addListener).toHaveBeenCalledWith( 'idle', expect.any(Function) ); expect(wrapper.instance().listeners).toHaveLength(4); }); }); describe('events', () => { it('expect to trigger idle callback', () => { const mapInstance = createFakeMapInstance(); const google = createFakeGoogleReference({ mapInstance, }); const props = { ...defaultProps, onIdle: jest.fn(), google, }; shallow(); simulateMapReadyEvent(google); expect(props.onIdle).toHaveBeenCalledTimes(0); simulateEvent(mapInstance, 'idle'); expect(props.onIdle).toHaveBeenCalledTimes(1); expect(props.onIdle).toHaveBeenCalledWith({ instance: mapInstance, }); }); it('expect to not trigger idle callback on programmatic interaction', () => { const mapInstance = createFakeMapInstance(); const google = createFakeGoogleReference({ mapInstance, }); const props = { ...defaultProps, onIdle: jest.fn(), google, }; const wrapper = shallow(); simulateMapReadyEvent(google); // Simulate fitBounds wrapper.instance().isUserInteraction = false; expect(props.onIdle).toHaveBeenCalledTimes(0); simulateEvent(mapInstance, 'idle'); expect(props.onIdle).toHaveBeenCalledTimes(0); }); ['center_changed', 'zoom_changed', 'dragstart'].forEach((eventName) => { it(`expect to call change callback on "${eventName}"`, () => { const mapInstance = createFakeMapInstance(); const google = createFakeGoogleReference({ mapInstance, }); const props = { ...defaultProps, onChange: jest.fn(), google, }; shallow(); simulateMapReadyEvent(google); expect(props.onChange).toHaveBeenCalledTimes(0); simulateEvent(mapInstance, eventName); expect(props.onChange).toHaveBeenCalledTimes(1); }); it(`expect to not call change callback on "${eventName}" with programmatic interaction`, () => { const mapInstance = createFakeMapInstance(); const google = createFakeGoogleReference({ mapInstance, }); const props = { ...defaultProps, onChange: jest.fn(), google, }; const wrapper = shallow(); simulateMapReadyEvent(google); expect(props.onChange).toHaveBeenCalledTimes(0); // Simulate fitBounds wrapper.instance().isUserInteraction = false; simulateEvent(mapInstance, eventName); expect(props.onChange).toHaveBeenCalledTimes(0); }); }); }); describe('context', () => { it('expect to not expose the context when the map is not ready', () => { const google = createFakeGoogleReference({}); const props = { ...defaultProps, google, }; const wrapper = shallow( {() => null} ); expect(wrapper.find(GoogleMapsContext.Consumer).exists()).toBe(false); }); it('expect to expose the context only when the map is created', () => { const google = createFakeGoogleReference({}); const props = { ...defaultProps, google, }; const wrapper = shallow( {() => null} ); simulateMapReadyEvent(google); expect(wrapper.find(GoogleMapsContext.Consumer).exists()).toBe(true); }); it('expect to expose the map instance through context only when created', () => { const mapInstance = createFakeMapInstance(); const google = createFakeGoogleReference({ mapInstance, }); const props = { ...defaultProps, google, }; const renderFn = jest.fn(() => null); mount( {renderFn} ); simulateMapReadyEvent(google); expect(renderFn).toHaveBeenCalledWith({ google, instance: mapInstance }); }); }); describe('update', () => { it('expect to call fitBounds on didUpdate when boundingBox is provided', () => { const mapInstance = createFakeMapInstance(); const google = createFakeGoogleReference({ mapInstance, }); const props = { ...defaultProps, google, }; const wrapper = shallow(
This is the children
); simulateMapReadyEvent(google); expect(mapInstance.fitBounds).toHaveBeenCalledTimes(0); expect(mapInstance.setZoom).toHaveBeenCalledTimes(1); // cDM expect(mapInstance.setCenter).toHaveBeenCalledTimes(1); // cDM wrapper.setProps({ boundingBoxPadding: 0, boundingBox: { northEast: { lat: 14, lng: 14, }, southWest: { lat: 10, lng: 10, }, }, }); expect(mapInstance.fitBounds).toHaveBeenCalledTimes(1); expect(mapInstance.fitBounds).toHaveBeenCalledWith( expect.objectContaining({ northEast: { lat: 10, lng: 10, }, southWest: { lat: 14, lng: 14, }, }), 0 ); expect(mapInstance.setZoom).toHaveBeenCalledTimes(1); // cDM expect(mapInstance.setCenter).toHaveBeenCalledTimes(1); // cDM }); it('expect not to call fitBounds on didUpdate when boundingBox equal to previous', () => { const mapInstance = createFakeMapInstance(); const google = createFakeGoogleReference({ mapInstance, }); const props = { ...defaultProps, google, }; const wrapper = shallow(
This is the children
); simulateMapReadyEvent(google); expect(mapInstance.fitBounds).toHaveBeenCalledTimes(0); expect(mapInstance.setZoom).toHaveBeenCalledTimes(1); // cDM expect(mapInstance.setCenter).toHaveBeenCalledTimes(1); // cDM wrapper.setProps({ boundingBoxPadding: 0, boundingBox: { northEast: { lat: 10, lng: 10, }, southWest: { lat: 14, lng: 14, }, }, }); expect(mapInstance.fitBounds).toHaveBeenCalledTimes(1); expect(mapInstance.fitBounds).toHaveBeenCalledWith( expect.objectContaining({ northEast: { lat: 14, lng: 14, }, southWest: { lat: 10, lng: 10, }, }), 0 ); expect(mapInstance.setZoom).toHaveBeenCalledTimes(1); // cDM expect(mapInstance.setCenter).toHaveBeenCalledTimes(1); // cDM mapInstance.getBounds.mockImplementation( () => new google.maps.LatLngBounds( { lat: 14, lng: 14 }, { lat: 10, lng: 10 } ) ); wrapper.setProps({ boundingBoxPadding: 0, boundingBox: { northEast: { lat: 10, lng: 10, }, southWest: { lat: 14, lng: 14, }, }, }); expect(mapInstance.fitBounds).toHaveBeenCalledTimes(1); }); it('expect to call setCenter & setZoom when boundingBox is not provided', () => { const mapInstance = createFakeMapInstance(); const google = createFakeGoogleReference({ mapInstance, }); google.maps.LatLngBounds.mockImplementation((sw, ne) => ({ northEast: ne, southWest: sw, })); const props = { ...defaultProps, google, }; const wrapper = shallow(
This is the children
); simulateMapReadyEvent(google); expect(mapInstance.fitBounds).toHaveBeenCalledTimes(0); expect(mapInstance.setZoom).toHaveBeenCalledTimes(1); // cDM expect(mapInstance.setCenter).toHaveBeenCalledTimes(1); // cDM wrapper.setProps(); expect(mapInstance.fitBounds).toHaveBeenCalledTimes(0); expect(mapInstance.setZoom).toHaveBeenCalledTimes(2); // cDM + cDU expect(mapInstance.setZoom).toHaveBeenCalledWith(1); expect(mapInstance.setCenter).toHaveBeenCalledTimes(2); // cDM + cDU expect(mapInstance.setCenter).toHaveBeenCalledWith({ lat: 0, lng: 0, }); }); it('expect to prevent the map update when shouldUpdate return false', () => { const mapInstance = createFakeMapInstance(); const google = createFakeGoogleReference({ mapInstance, }); const props = { ...defaultProps, shouldUpdate: () => false, google, }; const wrapper = shallow(
This is the children
); simulateMapReadyEvent(google); simulateEvent(mapInstance, 'center_changed'); expect(mapInstance.fitBounds).toHaveBeenCalledTimes(0); expect(mapInstance.setZoom).toHaveBeenCalledTimes(0); expect(mapInstance.setCenter).toHaveBeenCalledTimes(0); wrapper.setProps(); expect(mapInstance.fitBounds).toHaveBeenCalledTimes(0); expect(mapInstance.setZoom).toHaveBeenCalledTimes(0); expect(mapInstance.setCenter).toHaveBeenCalledTimes(0); }); it('expect to still render the children when shouldUpdate return false', () => { const mapInstance = createFakeMapInstance(); const google = createFakeGoogleReference({ mapInstance, }); const props = { ...defaultProps, shouldUpdate: () => false, google, }; const wrapper = shallow(
This is the children
); simulateMapReadyEvent(google); simulateEvent(mapInstance, 'center_changed'); expect(wrapper.find('.children')).toMatchSnapshot(); wrapper.setProps({ children:
This is the children updated
, }); expect(wrapper.find('.children')).toMatchSnapshot(); }); }); describe('delete', () => { it('expect to remove all the listeners', () => { const mapInstance = createFakeMapInstance(); const google = createFakeGoogleReference({ mapInstance, }); const props = { ...defaultProps, google, }; const wrapper = shallow(); simulateMapReadyEvent(google); expect(wrapper.instance().listeners).toHaveLength(4); const internalListeners = wrapper.instance().listeners.slice(); wrapper.unmount(); internalListeners.forEach((listener) => { expect(listener.remove).toHaveBeenCalledTimes(1); }); }); }); });