refactor: allow dispatching other event types in tests

Author: sqs

src/hoverifier.test.ts

@@ -17,7 +17,7 @@ import { HoverOverlayProps } from './HoverOverlay'
 import { findPositionsFromEvents } from './positions'
 import { CodeViewProps, DOM } from './testutils/dom'
 import { createHoverMerged, createStubHoverFetcher, createStubJumpURLFetcher } from './testutils/lsp'
-import { clickPositionImpure } from './testutils/mouse'
+import { dispatchMouseEventAtPositionImpure } from './testutils/mouse'
 import { LOADING } from './types'
 
 describe('Hoverifier', () => {
@@ -104,7 +104,7 @@ describe('Hoverifier', () => {
 
                 // Click https://sourcegraph.sgdev.org/github.com/gorilla/mux@cb4698366aa625048f3b815af6a0dea8aef9280a/-/blob/mux.go#L24:6
                 cold(inputDiagram).subscribe(() =>
-                    clickPositionImpure(codeView, {
+                    dispatchMouseEventAtPositionImpure('click', codeView, {
                         line: 24,
                         character: 6,
                     })
@@ -186,7 +186,7 @@ describe('Hoverifier', () => {
                 }
 
                 cold(inputDiagram).subscribe(() =>
-                    clickPositionImpure(codeView, {
+                    dispatchMouseEventAtPositionImpure('click', codeView, {
                         line: 1,
                         character: 1,
                     })

src/positions.test.ts

@@ -4,7 +4,7 @@ import { TestScheduler } from 'rxjs/testing'
 import { Position } from 'vscode-languageserver-types'
 
 import { CodeViewProps, DOM } from './testutils/dom'
-import { clickPositionImpure } from './testutils/mouse'
+import { dispatchMouseEventAtPositionImpure } from './testutils/mouse'
 
 import { propertyIsDefined } from './helpers'
 import { findPositionsFromEvents } from './positions'
@@ -48,7 +48,9 @@ describe('positions', () => {
                     map(({ position: { line, character } }) => ({ line, character }))
                 )
 
-                cold<Position>(diagram, positions).subscribe(position => clickPositionImpure(codeView, position))
+                cold<Position>(diagram, positions).subscribe(position =>
+                    dispatchMouseEventAtPositionImpure('click', codeView, position)
+                )
 
                 expectObservable(clickedTokens).toBe(diagram, tokens)
             })

src/testutils/mouse.ts

@@ -8,7 +8,7 @@ interface Coordinates {
     y: number
 }
 
-export const createMouseEvent = (type: string) => (coords: Coordinates) => {
+export const createMouseEvent = (type: string, coords: Coordinates) => {
     const event = new MouseEvent(type, {
         clientX: coords.x,
         clientY: coords.y,
@@ -18,20 +18,22 @@ export const createMouseEvent = (type: string) => (coords: Coordinates) => {
     return event
 }
 
-export const createMouseMoveEvent = createMouseEvent('mousemove')
-export const createClickEvent = createMouseEvent('click')
-
 const invalidPosition = ({ line, character }: Position, message: string) =>
     `Invalid postion L${line}:${character}. ${message}. Remember, LSP Positions are 0-indexed.`
 
 /**
- * Click the given position in a code element. This is impure because the current hoverifier implementation
- * requires the click event to come from the already tokenized DOM elements. Ideally we would not rely on this at all.
+ * Dispatch a mouse event at the given position in a code element. This is impure because the current hoverifier
+ * implementation requires the click event to come from the already tokenized DOM elements. Ideally we would not
+ * rely on this at all.
  *
  * @param codeViewProps the codeViewProps props from the test cases.
- * @param position the position to click.
+ * @param position the position of the event.
  */
-export const clickPositionImpure = ({ codeView, getCodeElementFromLineNumber }: CodeViewProps, position: Position) => {
+export const dispatchMouseEventAtPositionImpure = (
+    eventType: 'click' | 'mouseover' | 'mousemove',
+    { codeView, getCodeElementFromLineNumber }: CodeViewProps,
+    position: Position
+) => {
     const line = getCodeElementFromLineNumber(codeView, position.line)
     if (!line) {
         throw new Error(invalidPosition(position, 'Line not found'))
@@ -52,7 +54,7 @@ export const clickPositionImpure = ({ codeView, getCodeElementFromLineNumber }:
             const rect = line.getBoundingClientRect()
             const { top, height, left, width } = rect
 
-            const event = createClickEvent({
+            const event = createMouseEvent(eventType, {
                 x: left + width / 2,
                 y: top + height / 2,
             })
@@ -88,7 +90,7 @@ export const clickPosition = ({ codeView, getCodeElementFromLineNumber }: CodeVi
     const top = rect.top
     const height = rect.height
 
-    const event = createClickEvent({
+    const event = createMouseEvent('click', {
         x: left + width / 2,
         y: top + height / 2,
     })