feat: limit entry to synced doc block using awareness store flag (toe…

…verything#6239)
donteatfriedrice · Feb 20, 2024 · 134cc0b · 134cc0b
1 parent f4e551a
commit 134cc0b
Show file tree

Hide file tree

Showing 10 changed files with 140 additions and 87 deletions.
diff --git a/packages/blocks/src/_common/components/embed-card/embed-card-toolbar.ts b/packages/blocks/src/_common/components/embed-card/embed-card-toolbar.ts
@@ -233,6 +233,16 @@ export class EmbedCardToolbar extends WithDisposable(LitElement) {
   }
 
   private get _canConvertToEmbedView() {
+    // synced doc entry controlled by awareness flag
+    if (isEmbedLinkedDocBlock(this._model)) {
+      const isSyncedDocEnabled = this._model.page.awarenessStore.getFlag(
+        'enable_synced_doc_block'
+      );
+      if (!isSyncedDocEnabled) {
+        return false;
+      }
+    }
+
     return (
       'convertToEmbed' in this.block || this._embedOptions?.viewType === 'embed'
     );

diff --git a/packages/blocks/src/_common/inline/presets/nodes/reference-node/reference-popup.ts b/packages/blocks/src/_common/inline/presets/nodes/reference-node/reference-popup.ts
@@ -6,7 +6,7 @@ import type { InlineRange } from '@blocksuite/inline';
 import type { BlockElement } from '@blocksuite/lit';
 import { WithDisposable } from '@blocksuite/lit';
 import { computePosition, flip, inline, offset, shift } from '@floating-ui/dom';
-import { html, LitElement } from 'lit';
+import { html, LitElement, nothing } from 'lit';
 import { customElement, property, query } from 'lit/decorators.js';
 
 import type { PageBlockComponent } from '../../../../../page-block/types.js';
@@ -108,6 +108,12 @@ export class ReferencePopup extends WithDisposable(LitElement) {
     return std;
   }
 
+  get page() {
+    const page = this.blockElement.page;
+    assertExists(page);
+    return page;
+  }
+
   private _openPage() {
     const refPageId = this.referencePageId;
     const blockElement = this.blockElement;
@@ -189,6 +195,11 @@ export class ReferencePopup extends WithDisposable(LitElement) {
   }
 
   override render() {
+    // synced doc entry controlled by awareness flag
+    const isSyncedDocEnabled = this.page.awarenessStore.getFlag(
+      'enable_synced_doc_block'
+    );
+
     return html`
       <div class="overlay-root blocksuite-overlay">
         <div class="affine-reference-popover-container">
@@ -222,15 +233,21 @@ export class ReferencePopup extends WithDisposable(LitElement) {
                 <affine-tooltip .offset=${12}>${'Card view'}</affine-tooltip>
               </icon-button>
 
-              <icon-button
-                size="24px"
-                class="affine-reference-popover-view-selector-button embed"
-                hover="false"
-                @click=${() => this._convertToEmbedView()}
-              >
-                ${EmbedWebIcon}
-                <affine-tooltip .offset=${12}>${'Embed view'}</affine-tooltip>
-              </icon-button>
+              ${isSyncedDocEnabled
+                ? html`
+                    <icon-button
+                      size="24px"
+                      class="affine-reference-popover-view-selector-button embed"
+                      hover="false"
+                      @click=${() => this._convertToEmbedView()}
+                    >
+                      ${EmbedWebIcon}
+                      <affine-tooltip .offset=${12}
+                        >${'Embed view'}</affine-tooltip
+                      >
+                    </icon-button>
+                  `
+                : nothing}
             </div>
 
             <span class="affine-reference-popover-dividing-line"></span>

diff --git a/packages/blocks/src/embed-linked-doc-block/embed-linked-doc-block.ts b/packages/blocks/src/embed-linked-doc-block/embed-linked-doc-block.ts
@@ -204,6 +204,14 @@ export class EmbedLinkedDocBlockComponent extends EmbedBlockElement<
   convertToEmbed = () => {
     const { page, pageId, caption, xywh } = this.model;
 
+    // synced doc entry controlled by awareness flag
+    const isSyncedDocEnabled = page.awarenessStore.getFlag(
+      'enable_synced_doc_block'
+    );
+    if (!isSyncedDocEnabled) {
+      return;
+    }
+
     if (this.isInSurface) {
       const style = 'syncedDoc';
       const bound = Bound.deserialize(xywh);

diff --git a/...s/blocks/src/page-block/edgeless/components/component-toolbar/change-embed-card-button.ts b/...s/blocks/src/page-block/edgeless/components/component-toolbar/change-embed-card-button.ts
@@ -311,6 +311,17 @@ export class EdgelessChangeEmbedCardButton extends WithDisposable(LitElement) {
 
   private get _canConvertToEmbedView() {
     const block = this._blockElement;
+
+    // synced doc entry controlled by awareness flag
+    if (!!block && isEmbedLinkedDocBlock(block.model)) {
+      const isSyncedDocEnabled = block.page.awarenessStore.getFlag(
+        'enable_synced_doc_block'
+      );
+      if (!isSyncedDocEnabled) {
+        return false;
+      }
+    }
+
     return (
       (block && 'convertToEmbed' in block) ||
       this._embedOptions?.viewType === 'embed'

diff --git a/packages/framework/global/index.d.ts b/packages/framework/global/index.d.ts
@@ -1,4 +1,5 @@
 declare type BlockSuiteFlags = {
+  enable_synced_doc_block: boolean;
   enable_legacy_validation: boolean;
   enable_expand_database_block: boolean;
   enable_bultin_ledits: boolean;

diff --git a/packages/framework/store/src/workspace/store.ts b/packages/framework/store/src/workspace/store.ts
@@ -64,6 +64,7 @@ export interface StoreOptions<
 }
 
 const FLAGS_PRESET = {
+  enable_synced_doc_block: false,
   enable_legacy_validation: true,
   enable_expand_database_block: false,
   enable_bultin_ledits: false,

diff --git a/packages/playground/apps/default/utils/workspace.ts b/packages/playground/apps/default/utils/workspace.ts
@@ -55,6 +55,7 @@ export async function createDefaultPageWorkspace() {
     docSources,
     awarenessSources,
     defaultFlags: {
+      enable_synced_doc_block: true,
       enable_bultin_ledits: true,
     },
   };

diff --git a/packages/playground/apps/starter/data/synced.ts b/packages/playground/apps/starter/data/synced.ts
@@ -71,83 +71,85 @@ export const synced: InitFn = (workspace: Workspace, id: string) => {
       page: pageMain,
       noteId,
       markdown: syncedPageMarkdown,
-    }).catch(console.error);
-
-    // Add synced block - self
-    pageMain.addBlock(
-      'affine:paragraph',
-      {
-        text: new Text('Cyclic / Matryoshka synced block 👇'),
-        type: 'h4',
-      },
-      noteId
-    );
-
-    // Add synced block - self
-    pageMain.addBlock(
-      'affine:embed-synced-doc',
-      {
-        pageId: id,
-      },
-      noteId
-    );
-
-    // Add synced block - page view
-    pageMain.addBlock(
-      'affine:embed-synced-doc',
-      {
-        pageId: 'synced-page',
-      },
-      noteId
-    );
-
-    // Add synced block - edgeless view
-    pageMain.addBlock(
-      'affine:embed-synced-doc',
-      {
-        pageId: 'synced-edgeless',
-      },
-      noteId
-    );
-
-    // Add synced block - page view
-    pageMain.addBlock(
-      'affine:embed-synced-doc',
-      {
-        pageId: 'synced-page',
-        xywh: '[-1000, 0, 752, 455]',
-      },
-      surfaceId
-    );
-
-    // Add synced block - edgeless view
-    pageMain.addBlock(
-      'affine:embed-synced-doc',
-      {
-        pageId: 'synced-edgeless',
-        xywh: '[-1000, 500, 752, 455]',
-      },
-      surfaceId
-    );
-
-    // Add synced block - self
-    pageMain.addBlock(
-      'affine:embed-synced-doc',
-      {
-        pageId: id,
-        xywh: '[-1000, 1000, 752, 455]',
-      },
-      surfaceId
-    );
-
-    // Add synced block - self
-    pageMain.addBlock(
-      'affine:embed-synced-doc',
-      {
-        pageId: 'deleted-page',
-      },
-      noteId
-    );
+    })
+      .then(() => {
+        // Add synced block - self
+        pageMain.addBlock(
+          'affine:paragraph',
+          {
+            text: new Text('Cyclic / Matryoshka synced block 👇'),
+            type: 'h4',
+          },
+          noteId
+        );
+
+        // Add synced block - self
+        pageMain.addBlock(
+          'affine:embed-synced-doc',
+          {
+            pageId: id,
+          },
+          noteId
+        );
+
+        // Add synced block - page view
+        pageMain.addBlock(
+          'affine:embed-synced-doc',
+          {
+            pageId: 'synced-page',
+          },
+          noteId
+        );
+
+        // Add synced block - edgeless view
+        pageMain.addBlock(
+          'affine:embed-synced-doc',
+          {
+            pageId: 'synced-edgeless',
+          },
+          noteId
+        );
+
+        // Add synced block - page view
+        pageMain.addBlock(
+          'affine:embed-synced-doc',
+          {
+            pageId: 'synced-page',
+            xywh: '[-1000, 0, 752, 455]',
+          },
+          surfaceId
+        );
+
+        // Add synced block - edgeless view
+        pageMain.addBlock(
+          'affine:embed-synced-doc',
+          {
+            pageId: 'synced-edgeless',
+            xywh: '[-1000, 500, 752, 455]',
+          },
+          surfaceId
+        );
+
+        // Add synced block - self
+        pageMain.addBlock(
+          'affine:embed-synced-doc',
+          {
+            pageId: id,
+            xywh: '[-1000, 1000, 752, 455]',
+          },
+          surfaceId
+        );
+
+        // Add synced block - self
+        pageMain.addBlock(
+          'affine:embed-synced-doc',
+          {
+            pageId: 'deleted-page',
+          },
+          noteId
+        );
+      })
+      .catch(console.error);
   });
 
   pageSyncedEdgeless.resetHistory();

diff --git a/packages/playground/apps/starter/utils/workspace.ts b/packages/playground/apps/starter/utils/workspace.ts
@@ -59,6 +59,7 @@ export function createStarterPageWorkspace() {
     idGenerator,
     blobStorages,
     defaultFlags: {
+      enable_synced_doc_block: true,
       enable_bultin_ledits: featureArgs.includes('ledits'),
     },
     awarenessSources: [new BroadcastChannelAwarenessSource()],

diff --git a/packages/presets/src/__tests__/utils/setup.ts b/packages/presets/src/__tests__/utils/setup.ts
@@ -27,6 +27,7 @@ function createWorkspaceOptions() {
     idGenerator,
     blobStorages,
     defaultFlags: {
+      enable_synced_doc_block: true,
       enable_transformer_clipboard: true,
       enable_bultin_ledits: true,
       readonly: {