There can be more than Notion and Miro. AFFiNE(pronounced [ə‘fain]) is a next-gen knowledge base that brings planning, sorting and creating all together. Privacy first, open-source, customizable and ready to use.
TypeScript appcrdteditorelectronknowledge-basemarkdownmironotesnotionnotion-alternativerustrust-langrust-languagetabletableviewwhiteboardwikiworkspace
chore(core): add event tracking for attachments (#9198)
fundond7983c50e3b2
diff --git a/packages/frontend/core/src/components/attachment-viewer/pdf-viewer.tsx b/packages/frontend/core/src/components/attachment-viewer/pdf-viewer.tsxindex 4de7630160..ceeffbf75f 100644--- a/packages/frontend/core/src/components/attachment-viewer/pdf-viewer.tsx+++ b/packages/frontend/core/src/components/attachment-viewer/pdf-viewer.tsx@@ -17,6 +17,7 @@ import {Scroller,ScrollSeekPlaceholder,} from '@affine/core/modules/pdf/views';+import track from '@affine/track';import type { AttachmentBlockModel } from '@blocksuite/affine/blocks';import { CollapseIcon, ExpandIcon } from '@blocksuite/icons/rc';import { useLiveData, useService } from '@toeverything/infra';@@ -202,6 +203,12 @@ const PDFViewerInner = ({ pdf, state }: PDFViewerInnerProps) => {function PDFViewerStatus({ pdf }: { pdf: PDF }) {const state = useLiveData(pdf.state$);+ useEffect(() => {+ if (state.status !== PDFStatus.Error) return;++ track.$.attachment.$.openPDFRendererFail();+ }, [state]);+if (state?.status !== PDFStatus.Opened) {return <LoadingSvg />;}diff --git a/packages/frontend/core/src/modules/peek-view/entities/peek-view.ts b/packages/frontend/core/src/modules/peek-view/entities/peek-view.tsindex 4bbab3a550..c8ac94f6a0 100644--- a/packages/frontend/core/src/modules/peek-view/entities/peek-view.ts+++ b/packages/frontend/core/src/modules/peek-view/entities/peek-view.ts@@ -55,7 +55,7 @@ export type ImagePeekViewInfo = {export type AttachmentPeekViewInfo = {type: 'attachment';- docRef: DocReferenceInfo;+ docRef: DocReferenceInfo & { filetype?: string };};export type AIChatBlockPeekViewInfo = {@@ -173,6 +173,7 @@ function resolvePeekInfoFromPeekTarget(docRef: {docId: blockModel.doc.id,blockIds: [blockModel.id],+ filetype: blockModel.type,},};} else if (isImageBlockModel(blockModel)) {diff --git a/packages/frontend/core/src/modules/peek-view/view/peek-view-controls.tsx b/packages/frontend/core/src/modules/peek-view/view/peek-view-controls.tsxindex 1d8e141e9e..c79bc258e3 100644--- a/packages/frontend/core/src/modules/peek-view/view/peek-view-controls.tsx+++ b/packages/frontend/core/src/modules/peek-view/view/peek-view-controls.tsx@@ -1,5 +1,6 @@import { IconButton } from '@affine/component';import { useI18n } from '@affine/i18n';+import track from '@affine/track';import type { DocMode } from '@blocksuite/affine/blocks';import {CloseIcon,@@ -16,12 +17,16 @@ import {type ReactElement,type SVGAttributes,useCallback,+ useEffect,useMemo,} from 'react';import { WorkspaceDialogService } from '../../dialogs';import { WorkbenchService } from '../../workbench';-import type { DocReferenceInfo } from '../entities/peek-view';+import type {+ AttachmentPeekViewInfo,+ DocReferenceInfo,+} from '../entities/peek-view';import { PeekViewService } from '../services/peek-view';import * as styles from './peek-view-controls.css';@@ -154,33 +159,44 @@ export const DocPeekViewControls = ({);};+type AttachmentPeekViewControls = HTMLAttributes<HTMLDivElement> & {+ mode?: DocMode;+ docRef: AttachmentPeekViewInfo['docRef'];+};+export const AttachmentPeekViewControls = ({docRef,className,...rest-}: DocPeekViewControlsProps) => {+}: AttachmentPeekViewControls) => {+ const { docId, blockIds: [blockId] = [], filetype: type } = docRef;const peekView = useService(PeekViewService).peekView;const workbench = useService(WorkbenchService).workbench;const t = useI18n();+const controls = useMemo(() => {- return [+ const controls = [{icon: <CloseIcon />,nameKey: 'close',name: t['com.affine.peek-view-controls.close'](),onClick: () => peekView.close(),},+ ];+ if (!type) return controls;++ return [+ ...controls,// TODO(@fundon): needs to be implemented on mobileBUILD_CONFIG.isDesktopEdition && {icon: <ExpandFullIcon />,name: t['com.affine.peek-view-controls.open-attachment'](),nameKey: 'open',onClick: () => {- const { docId, blockIds: [blockId] = [] } = docRef;- if (docId && blockId) {- workbench.openAttachment(docId, blockId);- }+ workbench.openAttachment(docId, blockId);peekView.close(false);++ track.$.attachment.$.openAttachmentInFullscreen({ type });},},{@@ -188,11 +204,10 @@ export const AttachmentPeekViewControls = ({nameKey: 'new-tab',name: t['com.affine.peek-view-controls.open-attachment-in-new-tab'](),onClick: () => {- const { docId, blockIds: [blockId] = [] } = docRef;- if (docId && blockId) {- workbench.openAttachment(docId, blockId, { at: 'new-tab' });- }+ workbench.openAttachment(docId, blockId, { at: 'new-tab' });peekView.close(false);++ track.$.attachment.$.openAttachmentInNewTab({ type });},},BUILD_CONFIG.isElectron && {@@ -202,15 +217,21 @@ export const AttachmentPeekViewControls = ({'com.affine.peek-view-controls.open-attachment-in-split-view'](),onClick: () => {- const { docId, blockIds: [blockId] = [] } = docRef;- if (docId && blockId) {- workbench.openAttachment(docId, blockId, { at: 'beside' });- }+ workbench.openAttachment(docId, blockId, { at: 'beside' });peekView.close(false);++ track.$.attachment.$.openAttachmentInSplitView({ type });},},].filter((opt): opt is ControlButtonProps => Boolean(opt));- }, [t, peekView, workbench, docRef]);+ }, [t, peekView, workbench, docId, blockId, type]);++ useEffect(() => {+ if (type === undefined) return;++ track.$.attachment.$.openAttachmentInPeekView({ type });+ }, [type]);+return (<div {...rest} className={clsx(styles.root, className)}>{controls.map(option => (diff --git a/packages/frontend/track/src/events.ts b/packages/frontend/track/src/events.tsindex 638d540067..8d2554622a 100644--- a/packages/frontend/track/src/events.ts+++ b/packages/frontend/track/src/events.ts@@ -116,6 +116,15 @@ type PaymentEvents =| 'confirmResumingSubscription';// END SECTION+// SECTION: attachment+type AttachmentEvents =+ | 'openAttachmentInFullscreen'+ | 'openAttachmentInNewTab'+ | 'openAttachmentInPeekView'+ | 'openAttachmentInSplitView'+ | 'openPDFRendererFail';+// END SECTION+type UserEvents =| GeneralEvents| AppEvents@@ -130,7 +139,8 @@ type UserEvents =| AuthEvents| AccountEvents| PaymentEvents- | DNDEvents;+ | DNDEvents+ | AttachmentEvents;interface PageDivision {[page: string]: {[segment: string]: {@@ -284,6 +294,15 @@ const PageEvents = {importModal: ['open'],snapshot: ['import', 'export'],},+ attachment: {+ $: [+ 'openAttachmentInFullscreen',+ 'openAttachmentInNewTab',+ 'openAttachmentInPeekView',+ 'openAttachmentInSplitView',+ 'openPDFRendererFail',+ ],+ },},doc: {editor: {@@ -353,6 +372,10 @@ type PaymentEventArgs = {recurring: string;};+type AttachmentEventArgs = {+ type: string; // file type+};+type TabActionControlType =| 'click'| 'dnd'@@ -435,6 +458,10 @@ export type EventArgs = {linkDoc: { type: string; journal: boolean };drop: { type: string };dragStart: { type: string };+ openAttachmentInFullscreen: AttachmentEventArgs;+ openAttachmentInNewTab: AttachmentEventArgs;+ openAttachmentInPeekView: AttachmentEventArgs;+ openAttachmentInSplitView: AttachmentEventArgs;};// for type checking