@playpilot/tpi 3.3.3 → 3.4.0-beta.1

package/src/tests/routes/components/Editorial/EditorItem.test.js

@@ -26,7 +26,7 @@ describe('EditorItem.svelte', () => {
   it('Should highlight and unhighlight the matching link when component is hovered', async () => {
     document.body.innerHTML = '<p>This is a sentence with an injection.</p>'
 
-    injectLinksInDocument(Array.from(document.querySelectorAll('p')), linkInjections)
+    injectLinksInDocument(Array.from(document.querySelectorAll('p')), () => null, linkInjections)
 
     const { getAllByText, container } = render(EditorItem, { linkInjection })
 
@@ -41,7 +41,7 @@ describe('EditorItem.svelte', () => {
     document.body.innerHTML = '<p>This is a sentence with an injection.</p>'
 
     const linkInjectionWithAfterArticle = { ...linkInjection, in_text: true, after_article: true }
-    injectLinksInDocument(Array.from(document.querySelectorAll('p')), { aiInjections: [linkInjectionWithAfterArticle], manualInjections: [] })
+    injectLinksInDocument(Array.from(document.querySelectorAll('p')), () => null, { aiInjections: [linkInjectionWithAfterArticle], manualInjections: [] })
 
     const { container } = render(EditorItem, { linkInjection })
 
@@ -54,7 +54,7 @@ describe('EditorItem.svelte', () => {
 
     const failedInjection = generateInjection('This is a sentence', 'fail')
 
-    injectLinksInDocument(Array.from(document.querySelectorAll('p')), { aiInjections: [], manualInjections: [failedInjection] })
+    injectLinksInDocument(Array.from(document.querySelectorAll('p')), () => null, { aiInjections: [], manualInjections: [failedInjection] })
 
     const { container } = render(EditorItem, { linkInjection })
 
@@ -65,7 +65,7 @@ describe('EditorItem.svelte', () => {
   it('Should scroll matching link into view when component is clicked', async () => {
     document.body.innerHTML = '<p>This is a sentence with an injection.</p>'
 
-    injectLinksInDocument(Array.from(document.querySelectorAll('p')), linkInjections)
+    injectLinksInDocument(Array.from(document.querySelectorAll('p')), () => null, linkInjections)
 
     const { container } = render(EditorItem, { linkInjection })
 
@@ -76,7 +76,7 @@ describe('EditorItem.svelte', () => {
   it('Should not scroll matching link into view when component is clicked but there is no matching injection', async () => {
     document.body.innerHTML = '<main><p>This has no matching injections.</p></main>'
 
-    injectLinksInDocument(Array.from(document.querySelectorAll('main p')), linkInjections)
+    injectLinksInDocument(Array.from(document.querySelectorAll('main p')), () => null, linkInjections)
 
     const { container } = render(EditorItem, { linkInjection })
 
@@ -87,7 +87,7 @@ describe('EditorItem.svelte', () => {
   it('Should not scroll matching link into view when component is clicked on button or input', async () => {
     document.body.innerHTML = '<p>This is a sentence with an injection.</p>'
 
-    injectLinksInDocument(Array.from(document.querySelectorAll('p')), linkInjections)
+    injectLinksInDocument(Array.from(document.querySelectorAll('p')), () => null, linkInjections)
 
     const { container } = render(EditorItem, { linkInjection })
 
@@ -101,7 +101,7 @@ describe('EditorItem.svelte', () => {
   it('Should highlight element in editor when hovering element on page', async () => {
     document.body.innerHTML = '<p>This is a sentence with an injection.</p>'
 
-    injectLinksInDocument(Array.from(document.querySelectorAll('p')), linkInjections)
+    injectLinksInDocument(Array.from(document.querySelectorAll('p')), () => null, linkInjections)
 
     await new Promise(res => setTimeout(res))
 

package/src/tests/routes/components/Editorial/Session.test.js

@@ -0,0 +1,80 @@
+import { fireEvent, render, waitFor  } from '@testing-library/svelte'
+import { beforeEach, describe, expect, it, vi } from 'vitest'
+
+import Session from '../../../../routes/components/Editorial/Session.svelte'
+import { fetchAsSession, isAllowedToEdit, saveCurrentSession } from '$lib/session'
+
+// @ts-ignore
+vi.mock(import('$lib/session'), async (importOriginal) => {
+  const actual = await importOriginal()
+  return {
+    ...actual,
+    fetchAsSession: vi.fn(() => {}),
+    saveCurrentSession: vi.fn(() => {}),
+    sessionPollPeriodMilliseconds: 500,
+    isAllowedToEdit: vi.fn(() => true),
+  }
+})
+
+describe('Session.svelte', () => {
+  const onallow = vi.fn()
+  const ondisallow = vi.fn()
+
+  beforeEach(() => {
+    vi.resetAllMocks()
+  })
+
+  it('Should call fetchAsSession on mount', () => {
+    render(Session)
+    expect(fetchAsSession).toHaveBeenCalled()
+  })
+
+  it('Should continously poll fetchAsSession', async () => {
+    render(Session)
+
+    await waitFor(() => expect(fetchAsSession).toHaveBeenCalledTimes(2))
+    await waitFor(() => expect(fetchAsSession).toHaveBeenCalledTimes(3))
+    await waitFor(() => expect(fetchAsSession).toHaveBeenCalledTimes(4))
+  })
+
+  it('Should not show alert and call given onallow function when user is allowed to edit', async () => {
+    vi.mocked(fetchAsSession).mockResolvedValueOnce({ automation_enabled: true, injections_enabled: true })
+    vi.mocked(isAllowedToEdit).mockReturnValueOnce(true)
+
+    const { queryByText } = render(Session, { onallow, ondisallow })
+
+    expect(queryByText('Someone else is currently editing this document.')).not.toBeTruthy()
+
+    await waitFor(() => {
+      expect(onallow).toHaveBeenCalled()
+      expect(ondisallow).not.toHaveBeenCalled()
+    })
+  })
+
+  it('Should show alert and call given ondisallow function if user is not allowed to edit', async () => {
+    vi.mocked(fetchAsSession).mockResolvedValueOnce({ automation_enabled: true, injections_enabled: true })
+    vi.mocked(isAllowedToEdit).mockReturnValueOnce(false)
+
+    const { getByText } = render(Session, { onallow, ondisallow })
+
+    await waitFor(() => {
+      expect(getByText('Someone else is currently editing this document.')).toBeTruthy()
+      expect(onallow).not.toHaveBeenCalled()
+      expect(ondisallow).toHaveBeenCalled()
+    })
+  })
+
+  it('Should call given ontakeover function when button is alert is clicked', async () => {
+    vi.mocked(fetchAsSession).mockResolvedValueOnce({ automation_enabled: true, injections_enabled: true })
+    vi.mocked(isAllowedToEdit).mockReturnValueOnce(false)
+
+    const ontakeover = vi.fn()
+    const { getByText } = render(Session, { onallow, ondisallow, ontakeover })
+
+    await waitFor(() => getByText('Take over editing'))
+    await fireEvent.click(getByText('Take over editing'))
+
+    expect(ontakeover).toHaveBeenCalled()
+    expect(saveCurrentSession).toHaveBeenCalled()
+  })
+})

package/src/tests/setup.js

@@ -1,12 +1,9 @@
 import { cleanup } from '@testing-library/svelte'
 import { afterEach, beforeAll, beforeEach, vi } from 'vitest'
 
-vi.mock('svelte/transition')
-
 // https://github.com/jsdom/jsdom/issues/3429#issuecomment-1936128876
 const mockAnimations = () => {
   Element.prototype.animate ??= vi.fn().mockReturnValue({
-    onfinish: null,
     finished: Promise.resolve(),
     cancel: vi.fn(),
     startTime: null,
@@ -35,8 +32,31 @@ const mockLocalStorage = () => {
   }
 }
 
+const mockSessionStorage = () => {
+  /** @type {Record<string, string>} */
+  let store = {}
+
+  // @ts-ignore
+  ;(window).sessionStorage = {
+    getItem: function (key) {
+      return store[key] || null
+    },
+    setItem: function (key, value) {
+      store[key] = value.toString()
+    },
+    removeItem: function (key) {
+      delete store[key]
+    },
+    clear: function () {
+      store = {}
+    },
+  }
+}
+
 beforeAll(() => {
+  mockAnimations()
   mockLocalStorage()
+  mockSessionStorage()
 })
 
 beforeEach(() => {
@@ -48,8 +68,6 @@ beforeEach(() => {
 
   window.HTMLElement.prototype.scrollIntoView = vi.fn()
   localStorage.clear()
-
-  mockAnimations()
 })
 
 afterEach(() => {

package/src/lib/event.ts

@@ -1,6 +0,0 @@
-/**
- * Returns true when user performs event that should open a link in a new tab
- */
-export function isHoldingSpecialKey(event: MouseEvent) {
-  return event.ctrlKey || event.metaKey || event.button !== 0
-}

package/src/lib/viewTransition.ts

@@ -1,25 +0,0 @@
-/**
- * Play a view transition if supported. We remove the view transition name from the old element and add it to the new.
- * If not support, simply call the callback.
- * A condition can be passed to optionally only call the callback without the view transition.
- */
-export function playFallbackViewTransition(callback: Function, condition: boolean): void {
-  console.log(condition)
-  if (!document.startViewTransition || !condition) {
-    callback()
-    return
-  }
-
-  document.startViewTransition(() => {
-    const viewTransitionOldElement = document.querySelector('[data-view-transition-old]') as HTMLElement
-    if (!viewTransitionOldElement) return
-
-    const viewTransitionName = window.getComputedStyle(viewTransitionOldElement).getPropertyValue('view-transition-name')
-    viewTransitionOldElement.style.viewTransitionName = 'none'
-
-    callback()
-
-    const viewTransitionNewElement = document.querySelector('[data-view-transition-new]') as HTMLElement
-    if (viewTransitionNewElement) viewTransitionNewElement.style.viewTransitionName = viewTransitionName
-  })
-}

package/src/tests/lib/event.test.js

@@ -1,22 +0,0 @@
-import { describe, it, expect } from 'vitest'
-import { isHoldingSpecialKey } from '$lib/event'
-
-describe('event.js', () => {
-  describe('isHoldingSpecialKey', () => {
-    it('Should return true when holding special key', () => {
-      // @ts-ignore
-      expect(isHoldingSpecialKey({ ctrlKey: true, button: 0 })).toBe(true)
-      // @ts-ignore
-      expect(isHoldingSpecialKey({ metaKey: true, button: 0 })).toBe(true)
-      // @ts-ignore
-      expect(isHoldingSpecialKey({ button: 1 })).toBe(true)
-    })
-
-    it('Should return false when not holding special kew', () => {
-      // @ts-ignore
-      expect(isHoldingSpecialKey({ ctrlKey: false, metaKey: false, button: 0 })).toBe(false)
-      // @ts-ignore
-      expect(isHoldingSpecialKey({ button: 0 })).toBe(false)
-    })
-  })
-})

package/src/tests/lib/viewTransition.test.js

@@ -1,13 +0,0 @@
-import { describe, it, expect, vi } from 'vitest'
-import { playFallbackViewTransition } from '$lib/viewTransition'
-
-describe('viewTransition.js', () => {
-  describe('playFallbackViewTransition', () => {
-    it('Should call callback', () => {
-      const mock = vi.fn()
-      playFallbackViewTransition(mock)
-
-      expect(mock).toHaveBeenCalled()
-    })
-  })
-})