Merge pull request #34245 from overleaf/mj-unsaved-docs-context

[web] Move unsaved docs monitoring to context GitOrigin-RevId: 6d2c778efb7a52616ba1a1d52c617d8170a7f798
2026-11-14 14:13:43 +01:00 · 2026-09-17 11:22:28 +00:00
parent c4104f3bd7
commit df4e336399
5 changed files with 324 additions and 122 deletions
@@ -0,0 +1,142 @@
+import { FC, useState } from 'react'
+import { EditorManagerContext } from '@/features/ide-react/context/editor-manager-context'
+import { IdeReactContext } from '@/features/ide-react/context/ide-react-context'
+import { UnsavedDocsProvider } from '@/features/ide-react/context/unsaved-docs-context'
+import { IdeEventEmitter } from '@/features/ide-react/create-ide-event-emitter'
+import type { DocumentContainer } from '@/features/ide-react/editor/document-container'
+import type { PermissionsLevel } from '@/features/ide-react/types/permissions'
+
+function makeDocStub(
+  docId: string,
+  {
+    inflightAt = null,
+    pendingAt = null,
+  }: { inflightAt?: number | null; pendingAt?: number | null } = {}
+): Partial<DocumentContainer> {
+  return {
+    doc_id: docId,
+    getInflightOpCreatedAt: () => inflightAt ?? undefined,
+    getPendingOpCreatedAt: () => pendingAt ?? undefined,
+    hasBufferedOps: () => inflightAt != null || pendingAt != null,
+    pollSavedStatus: () => inflightAt == null && pendingAt == null,
+  }
+}
+
+function makeOpenDocsStub(
+  docsWithUnsavedOps: Partial<DocumentContainer>[] = []
+) {
+  return {
+    unsavedDocs: () => docsWithUnsavedOps,
+    hasUnsavedChanges: () => docsWithUnsavedOps.length > 0,
+    getUnsavedOpsSize: () => ({ pendingOpsLength: 0, inflightOpsLength: 0 }),
+  }
+}
+
+function mount(
+  openDocs = makeOpenDocsStub(),
+  onSetPermissionsLevel: (level: PermissionsLevel) => void = () => {}
+) {
+  const debugTimers = { current: {} as Record<string, number> }
+
+  const Wrapper: FC = () => {
+    const [contextValue] = useState(() => ({
+      projectId: 'test-project',
+      eventEmitter: new IdeEventEmitter(),
+      startedFreeTrial: false,
+      setStartedFreeTrial: () => {},
+      reportError: () => {},
+      projectJoined: true,
+      permissionsLevel: 'owner' as PermissionsLevel,
+      setPermissionsLevel: onSetPermissionsLevel,
+      setOutOfSync: () => {},
+    }))
+
+    return (
+      <IdeReactContext.Provider value={contextValue}>
+        <EditorManagerContext.Provider value={{ openDocs, debugTimers } as any}>
+          <UnsavedDocsProvider />
+        </EditorManagerContext.Provider>
+      </IdeReactContext.Provider>
+    )
+  }
+
+  cy.mount(<Wrapper />)
+}
+
+describe('<UnsavedDocsProvider />', function () {
+  beforeEach(function () {
+    cy.clock()
+  })
+
+  it('locks the editor when a doc exceeds MAX_UNSAVED_SECONDS', function () {
+    const setPermissionsLevel = cy.stub().as('setPermissionsLevel')
+    const now = performance.now()
+    const openDocs = makeOpenDocsStub([
+      makeDocStub('doc1', { pendingAt: now - 31_000 }),
+    ])
+
+    mount(openDocs, setPermissionsLevel)
+    cy.tick(1000)
+
+    cy.get('@setPermissionsLevel').should('have.been.calledWith', 'readOnly')
+  })
+
+  it('does not lock the editor before MAX_UNSAVED_SECONDS', function () {
+    const setPermissionsLevel = cy.stub().as('setPermissionsLevel')
+    const now = performance.now()
+    const openDocs = makeOpenDocsStub([
+      makeDocStub('doc1', { pendingAt: now - 29_000 }),
+    ])
+
+    mount(openDocs, setPermissionsLevel)
+    cy.tick(1000)
+
+    cy.get('@setPermissionsLevel').should('not.have.been.called')
+  })
+
+  it('restores permissions when all docs are saved after locking', function () {
+    const setPermissionsLevel = cy.stub().as('setPermissionsLevel')
+    const now = performance.now()
+    const openDocs = makeOpenDocsStub([
+      makeDocStub('doc1', { pendingAt: now - 31_000 }),
+    ])
+
+    mount(openDocs, setPermissionsLevel)
+    cy.tick(1000)
+
+    cy.get('@setPermissionsLevel')
+      .should('have.been.calledWith', 'readOnly')
+      .then(() => {
+        openDocs.unsavedDocs = () => []
+        openDocs.hasUnsavedChanges = () => false
+      })
+
+    cy.tick(1000)
+
+    cy.get('@setPermissionsLevel').should('have.been.calledWith', 'owner')
+  })
+
+  it('calls event.preventDefault() on beforeunload when there are unsaved changes', function () {
+    const openDocs = makeOpenDocsStub([
+      makeDocStub('doc1', { pendingAt: performance.now() - 5_000 }),
+    ])
+
+    mount(openDocs)
+
+    cy.window().then(win => {
+      const event = new win.Event('beforeunload', { cancelable: true })
+      win.dispatchEvent(event)
+      expect(event.defaultPrevented).to.be.true
+    })
+  })
+
+  it('does not prevent beforeunload when all docs are saved', function () {
+    mount()
+
+    cy.window().then(win => {
+      const event = new win.Event('beforeunload', { cancelable: true })
+      win.dispatchEvent(event)
+      expect(event.defaultPrevented).to.be.false
+    })
+  })
+})