fix block persistence bug

Author: ntietje1

convex/_generated/api.d.ts

@@ -24,6 +24,7 @@ import type * as blockShares_mutations from "../blockShares/mutations.js";
 import type * as blockShares_queries from "../blockShares/queries.js";
 import type * as blockShares_types from "../blockShares/types.js";
 import type * as blocks_blockSchemas from "../blocks/blockSchemas.js";
+import type * as blocks_functions_ensureBlocksPersisted from "../blocks/functions/ensureBlocksPersisted.js";
 import type * as blocks_functions_extractPlainText from "../blocks/functions/extractPlainText.js";
 import type * as blocks_functions_findBlockByBlockNoteId from "../blocks/functions/findBlockByBlockNoteId.js";
 import type * as blocks_functions_flattenBlocks from "../blocks/functions/flattenBlocks.js";
@@ -239,6 +240,7 @@ declare const fullApi: ApiFromModules<{
   "blockShares/queries": typeof blockShares_queries;
   "blockShares/types": typeof blockShares_types;
   "blocks/blockSchemas": typeof blocks_blockSchemas;
+  "blocks/functions/ensureBlocksPersisted": typeof blocks_functions_ensureBlocksPersisted;
   "blocks/functions/extractPlainText": typeof blocks_functions_extractPlainText;
   "blocks/functions/findBlockByBlockNoteId": typeof blocks_functions_findBlockByBlockNoteId;
   "blocks/functions/flattenBlocks": typeof blocks_functions_flattenBlocks;

convex/_test/factories.helper.ts

@@ -2,6 +2,8 @@ import { CAMPAIGN_MEMBER_ROLE, CAMPAIGN_MEMBER_STATUS } from '../campaigns/types
 import { SIDEBAR_ITEM_LOCATION, SIDEBAR_ITEM_TYPES } from '../sidebarItems/types/baseTypes'
 import { SHARE_STATUS } from '../blockShares/types'
 import { slugify } from '../common/slug'
+import { makeYjsUpdateWithBlocks } from '../yjsSync/__tests__/makeYjsUpdate.helper'
+import type { TestBlock } from '../yjsSync/__tests__/makeYjsUpdate.helper'
 import type { TestConvex } from 'convex-test'
 import type { Id } from '../_generated/dataModel'
 import type schema from '../schema'
@@ -552,3 +554,25 @@ export async function setupFolderTree(
     }
   }
 }
+
+export async function syncBlocksToYjs(
+  t: T,
+  noteId: Id<'sidebarItems'>,
+  blocks: Array<TestBlock>,
+): Promise<void> {
+  const update = makeYjsUpdateWithBlocks(blocks)
+  await t.run(async (ctx) => {
+    const latest = await ctx.db
+      .query('yjsUpdates')
+      .withIndex('by_document_seq', (q: any) => q.eq('documentId', noteId))
+      .order('desc')
+      .first()
+    const seq = (latest?.seq ?? -1) + 1
+    await ctx.db.insert('yjsUpdates', {
+      documentId: noteId,
+      update,
+      seq,
+      isSnapshot: false,
+    })
+  })
+}

convex/blockShares/__tests__/blockShares.test.ts

@@ -11,6 +11,7 @@ import {
   createBlockShare,
   createNote,
   createSidebarShare,
+  syncBlocksToYjs,
 } from '../../_test/factories.helper'
 import { expectNotFound, expectPermissionDenied } from '../../_test/assertions.helper'
 import { api } from '../../_generated/api'
@@ -24,6 +25,7 @@ describe('setBlocksShareStatus', () => {
     const dmAuth = asDm(ctx)
     const { noteId } = await createNote(t, ctx.campaignId, ctx.dm.profile._id)
     const { blockNoteId } = await createBlock(t, noteId, ctx.campaignId, ctx.dm.profile._id)
+    await syncBlocksToYjs(t, noteId, [{ id: blockNoteId, type: 'paragraph' }])
 
     await dmAuth.mutation(api.blockShares.mutations.setBlocksShareStatus, {
       campaignId: ctx.campaignId,
@@ -48,6 +50,7 @@ describe('setBlocksShareStatus', () => {
     const { blockNoteId } = await createBlock(t, noteId, ctx.campaignId, ctx.dm.profile._id, {
       shareStatus: 'all_shared',
     })
+    await syncBlocksToYjs(t, noteId, [{ id: blockNoteId, type: 'paragraph' }])
 
     await dmAuth.mutation(api.blockShares.mutations.setBlocksShareStatus, {
       campaignId: ctx.campaignId,
@@ -70,6 +73,7 @@ describe('setBlocksShareStatus', () => {
     const dmAuth = asDm(ctx)
     const { noteId } = await createNote(t, ctx.campaignId, ctx.dm.profile._id)
     const { blockNoteId } = await createBlock(t, noteId, ctx.campaignId, ctx.dm.profile._id)
+    await syncBlocksToYjs(t, noteId, [{ id: blockNoteId, type: 'paragraph' }])
 
     await dmAuth.mutation(api.blockShares.mutations.setBlocksShareStatus, {
       campaignId: ctx.campaignId,
@@ -126,6 +130,7 @@ describe('shareBlocks', () => {
     const dmAuth = asDm(ctx)
     const { noteId } = await createNote(t, ctx.campaignId, ctx.dm.profile._id)
     const { blockNoteId } = await createBlock(t, noteId, ctx.campaignId, ctx.dm.profile._id)
+    await syncBlocksToYjs(t, noteId, [{ id: blockNoteId, type: 'paragraph' }])
 
     await dmAuth.mutation(api.blockShares.mutations.shareBlocks, {
       campaignId: ctx.campaignId,

convex/blockShares/__tests__/blockSharesWithNestedBlocks.test.ts

@@ -5,6 +5,7 @@ import {
   createBlock,
   createBlockShare,
   createNote,
+  syncBlocksToYjs,
   testBlockNoteId,
 } from '../../_test/factories.helper'
 import { api } from '../../_generated/api'
@@ -28,6 +29,13 @@ describe('share mutations with nested blocks', () => {
       depth: 1,
       parentBlockId: testBlockNoteId('root'),
     })
+    await syncBlocksToYjs(t, noteId, [
+      {
+        id: testBlockNoteId('root'),
+        type: 'paragraph',
+        children: [{ id: testBlockNoteId('child'), type: 'paragraph' }],
+      },
+    ])
 
     await dmAuth.mutation(api.blockShares.mutations.shareBlocks, {
       campaignId: ctx.campaignId,
@@ -67,6 +75,19 @@ describe('share mutations with nested blocks', () => {
       depth: 2,
       parentBlockId: testBlockNoteId('depth-1'),
     })
+    await syncBlocksToYjs(t, noteId, [
+      {
+        id: testBlockNoteId('depth-0'),
+        type: 'paragraph',
+        children: [
+          {
+            id: testBlockNoteId('depth-1'),
+            type: 'paragraph',
+            children: [{ id: testBlockNoteId('depth-2'), type: 'paragraph' }],
+          },
+        ],
+      },
+    ])
 
     await dmAuth.mutation(api.blockShares.mutations.setBlocksShareStatus, {
       campaignId: ctx.campaignId,
@@ -111,6 +132,13 @@ describe('share mutations with nested blocks', () => {
       parentBlockId: testBlockNoteId('some-parent'),
       shareStatus: 'individually_shared',
     })
+    await syncBlocksToYjs(t, noteId, [
+      {
+        id: testBlockNoteId('some-parent'),
+        type: 'paragraph',
+        children: [{ id: testBlockNoteId('nested'), type: 'paragraph' }],
+      },
+    ])
 
     await createBlockShare(t, ctx.dm.profile._id, {
       campaignId: ctx.campaignId,

convex/blockShares/__tests__/blockSharingWorkflows.test.ts

@@ -1,7 +1,12 @@
 import { describe, expect, it } from 'vitest'
 import { createTestContext } from '../../_test/setup.helper'
 import { asDm, setupMultiPlayerContext } from '../../_test/identities.helper'
-import { createBlock, createNote, createSidebarShare } from '../../_test/factories.helper'
+import {
+  createBlock,
+  createNote,
+  createSidebarShare,
+  syncBlocksToYjs,
+} from '../../_test/factories.helper'
 import { api } from '../../_generated/api'
 
 describe('block sharing workflows', () => {
@@ -17,6 +22,10 @@ describe('block sharing workflows', () => {
       const note = await createNote(t, ctx.campaignId, ctx.dm.profile._id)
       const block1 = await createBlock(t, note.noteId, ctx.campaignId, ctx.dm.profile._id)
       const block2 = await createBlock(t, note.noteId, ctx.campaignId, ctx.dm.profile._id)
+      await syncBlocksToYjs(t, note.noteId, [
+        { id: block1.blockNoteId, type: 'paragraph' },
+        { id: block2.blockNoteId, type: 'paragraph' },
+      ])
 
       await createSidebarShare(t, ctx.dm.profile._id, {
         campaignId: ctx.campaignId,
@@ -105,6 +114,7 @@ describe('block sharing workflows', () => {
 
       const note = await createNote(t, ctx.campaignId, ctx.dm.profile._id)
       const block = await createBlock(t, note.noteId, ctx.campaignId, ctx.dm.profile._id)
+      await syncBlocksToYjs(t, note.noteId, [{ id: block.blockNoteId, type: 'paragraph' }])
 
       await createSidebarShare(t, ctx.dm.profile._id, {
         campaignId: ctx.campaignId,
@@ -216,6 +226,7 @@ describe('block sharing workflows', () => {
 
       const note = await createNote(t, ctx.campaignId, ctx.dm.profile._id)
       const block = await createBlock(t, note.noteId, ctx.campaignId, ctx.dm.profile._id)
+      await syncBlocksToYjs(t, note.noteId, [{ id: block.blockNoteId, type: 'paragraph' }])
 
       await createSidebarShare(t, ctx.dm.profile._id, {
         campaignId: ctx.campaignId,
@@ -278,6 +289,7 @@ describe('block sharing workflows', () => {
 
       const note = await createNote(t, ctx.campaignId, ctx.dm.profile._id)
       const block = await createBlock(t, note.noteId, ctx.campaignId, ctx.dm.profile._id)
+      await syncBlocksToYjs(t, note.noteId, [{ id: block.blockNoteId, type: 'paragraph' }])
 
       await dmAuth.mutation(api.blockShares.mutations.setBlocksShareStatus, {
         campaignId: ctx.campaignId,

convex/blockShares/functions/setBlocksShareStatus.ts

@@ -6,6 +6,7 @@ import { EDIT_HISTORY_ACTION } from '../../editHistory/types'
 import { SIDEBAR_ITEM_TYPES } from '../../sidebarItems/types/baseTypes'
 import { setBlockShareStatusHelper } from './blockShareMutations'
 import { getSidebarItem } from '../../sidebarItems/functions/getSidebarItem'
+import { ensureBlocksPersisted } from '../../blocks/functions/ensureBlocksPersisted'
 import { ERROR_CODE, throwClientError } from '../../errors'
 import type { CampaignMutationCtx } from '../../functions'
 import type { Id } from '../../_generated/dataModel'
@@ -36,6 +37,8 @@ export const setBlocksShareStatus = async (
     requiredLevel: PERMISSION_LEVEL.FULL_ACCESS,
   })
 
+  await ensureBlocksPersisted(ctx, { noteId })
+
   await asyncMap(blockNoteIds, (blockNoteId) =>
     setBlockShareStatusHelper(ctx, {
       note,

convex/blockShares/functions/shareBlocks.ts

@@ -6,6 +6,7 @@ import { EDIT_HISTORY_ACTION } from '../../editHistory/types'
 import { SIDEBAR_ITEM_TYPES } from '../../sidebarItems/types/baseTypes'
 import { shareBlockWithMemberHelper } from './blockShareMutations'
 import { getSidebarItem } from '../../sidebarItems/functions/getSidebarItem'
+import { ensureBlocksPersisted } from '../../blocks/functions/ensureBlocksPersisted'
 import { ERROR_CODE, throwClientError } from '../../errors'
 import type { CampaignMutationCtx } from '../../functions'
 import type { Id } from '../../_generated/dataModel'
@@ -31,6 +32,8 @@ export const shareBlocks = async (
     requiredLevel: PERMISSION_LEVEL.FULL_ACCESS,
   })
 
+  await ensureBlocksPersisted(ctx, { noteId })
+
   await asyncMap(blockNoteIds, (blockNoteId) =>
     shareBlockWithMemberHelper(ctx, {
       note,

convex/blocks/functions/ensureBlocksPersisted.ts

@@ -0,0 +1,18 @@
+import { reconstructYDoc } from '../../yjsSync/functions/reconstructYDoc'
+import { yDocToBlocks } from '../../notes/blocknote'
+import { saveAllBlocksForNote } from './saveAllBlocksForNote'
+import type { CampaignMutationCtx } from '../../functions'
+import type { Id } from '../../_generated/dataModel'
+
+export async function ensureBlocksPersisted(
+  ctx: CampaignMutationCtx,
+  { noteId }: { noteId: Id<'sidebarItems'> },
+): Promise<void> {
+  const { doc } = await reconstructYDoc(ctx, noteId)
+  try {
+    const blocks = yDocToBlocks(doc, 'document')
+    await saveAllBlocksForNote(ctx, { noteId, content: blocks })
+  } finally {
+    doc.destroy()
+  }
+}

convex/notes/__tests__/noteWorkflows.test.ts

@@ -11,6 +11,7 @@ import {
   createFolder,
   createNote,
   createSidebarShare,
+  syncBlocksToYjs,
   testBlockNoteId,
 } from '../../_test/factories.helper'
 import { api } from '../../_generated/api'
@@ -30,6 +31,9 @@ describe('note lifecycle: create, share, edit, block sharing', () => {
     const block = await createBlock(t, note.noteId, ctx.campaignId, ctx.dm.profile._id, {
       blockNoteId: testBlockNoteId('secret-block'),
     })
+    await syncBlocksToYjs(t, note.noteId, [
+      { id: testBlockNoteId('secret-block'), type: 'paragraph' },
+    ])
 
     await createSidebarShare(t, ctx.dm.profile._id, {
       campaignId: ctx.campaignId,
@@ -92,6 +96,9 @@ describe('note lifecycle: create, share, edit, block sharing', () => {
     const block = await createBlock(t, note.noteId, ctx.campaignId, ctx.dm.profile._id, {
       blockNoteId: testBlockNoteId('revocable-block'),
     })
+    await syncBlocksToYjs(t, note.noteId, [
+      { id: testBlockNoteId('revocable-block'), type: 'paragraph' },
+    ])
 
     await createSidebarShare(t, ctx.dm.profile._id, {
       campaignId: ctx.campaignId,
@@ -161,6 +168,7 @@ describe('note lifecycle: create, share, edit, block sharing', () => {
     const block = await createBlock(t, noteId, ctx.campaignId, ctx.dm.profile._id, {
       blockNoteId: testBlockNoteId('nested-block'),
     })
+    await syncBlocksToYjs(t, noteId, [{ id: testBlockNoteId('nested-block'), type: 'paragraph' }])
 
     const playerNoteWithBlocks = await playerAuth.query(api.notes.queries.getNote, {
       campaignId: ctx.campaignId,
@@ -228,6 +236,9 @@ describe('note lifecycle: create, share, edit, block sharing', () => {
     const block = await createBlock(t, note.noteId, ctx.campaignId, ctx.dm.profile._id, {
       blockNoteId: testBlockNoteId('transition-block'),
     })
+    await syncBlocksToYjs(t, note.noteId, [
+      { id: testBlockNoteId('transition-block'), type: 'paragraph' },
+    ])
 
     await createSidebarShare(t, ctx.dm.profile._id, {
       campaignId: ctx.campaignId,
@@ -304,6 +315,16 @@ describe('note lifecycle: create, share, edit, block sharing', () => {
       parentBlockId: testBlockNoteId('root'),
       position: 1,
     })
+    await syncBlocksToYjs(t, note.noteId, [
+      {
+        id: testBlockNoteId('root'),
+        type: 'paragraph',
+        children: [
+          { id: testBlockNoteId('shared-child'), type: 'paragraph' },
+          { id: testBlockNoteId('unshared-child'), type: 'paragraph' },
+        ],
+      },
+    ])
 
     await createSidebarShare(t, ctx.dm.profile._id, {
       campaignId: ctx.campaignId,

convex/notes/mutations.ts

@@ -1,12 +1,10 @@
 import { v } from 'convex/values'
 import { campaignMutation } from '../functions'
 import { customBlockValidator } from '../blocks/schema'
-import { saveAllBlocksForNote } from '../blocks/functions/saveAllBlocksForNote'
+import { ensureBlocksPersisted } from '../blocks/functions/ensureBlocksPersisted'
 import { checkYjsWriteAccess } from '../yjsSync/functions/checkYjsAccess'
-import { reconstructYDoc } from '../yjsSync/functions/reconstructYDoc'
 import { createNote as createNoteFn } from './functions/createNote'
 import { updateNote as updateNoteFn } from './functions/updateNote'
-import { yDocToBlocks } from './blocknote'
 import type { Id } from '../_generated/dataModel'
 
 export const updateNote = campaignMutation({
@@ -60,18 +58,7 @@ export const persistNoteBlocks = campaignMutation({
   returns: v.null(),
   handler: async (ctx, { documentId }) => {
     await checkYjsWriteAccess(ctx, documentId)
-
-    const { doc } = await reconstructYDoc(ctx, documentId)
-    try {
-      const blocks = yDocToBlocks(doc, 'document')
-
-      await saveAllBlocksForNote(ctx, {
-        noteId: documentId,
-        content: blocks,
-      })
-    } finally {
-      doc.destroy()
-    }
+    await ensureBlocksPersisted(ctx, { noteId: documentId })
 
     return null
   },