feat: Add support for shared drive files search

Author: doubleface

package.json

@@ -22,7 +22,7 @@
     "cozy-logger": "^1.10.4",
     "cozy-minilog": "^3.3.1",
     "cozy-pouch-link": "^60.10.1",
-    "cozy-realtime": "^5.7.0",
+    "cozy-realtime": "^5.8.0",
     "cozy-tsconfig": "^1.2.0",
     "flexsearch": "^0.7.43",
     "lodash": "^4.17.21",

src/@types/cozy-client.d.ts

@@ -165,6 +165,7 @@ declare module 'cozy-client' {
     addReferencesTo: (references: object, dirs: object[]) => Promise<void>
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     launch: (trigger: any) => any
+    fetchSharedDrives: () => Promise<{ data: Array<{ id: string }> }>
   }
 
   export default class CozyClient {

src/consts.ts

@@ -8,5 +8,6 @@ export const ACCOUNTS_DOCTYPE = 'io.cozy.accounts'
 export const KONNECTORS_DOCTYPE = 'io.cozy.konnectors'
 export const TRIGGERS_DOCTYPE = 'io.cozy.triggers'
 export const SETTINGS_DOCTYPE = 'io.cozy.settings'
+export const SHARED_DRIVE_FILE_DOCTYPE = 'io.cozy.files.shareddrives'
 
 export const LOCALSTORAGE_KEY_DELETING_DATA = 'deletingLocalData'

src/dataproxy/common/DataProxyInterface.ts

@@ -13,13 +13,18 @@ export interface SearchOptions {
 
 export interface DataProxyWorker {
   search: (query: string, options: SearchOptions) => unknown
-  setup: (clientData: ClientData) => Promise<void>
+  setup: (
+    clientData: ClientData,
+    options?: { sharedDriveIds: string[] }
+  ) => Promise<void>
   forceSyncPouch: () => void
   requestLink: (
     definition: QueryDefinition | Mutation,
     options?: QueryOptions | MutationOptions
   ) => Promise<unknown>
   reconnectRealtime: () => void
+  addSharedDrive: (driveId: string) => void
+  removeSharedDrive: (driveId: string) => void
 }
 
 export interface DataProxyWorkerPartialState {

src/dataproxy/worker/SharedWorkerProvider.tsx

@@ -14,6 +14,47 @@ import { removeStaleLocalData } from '@/dataproxy/worker/data'
 
 const log = Minilog('👷‍♂️ [SharedWorkerProvider]')
 
+// Event payload received from cozy realtime for io.cozy.files
+type FilesRealtimeEvent = {
+  dir_id: string
+  class: string
+  referenced_by?: Array<{ id?: string }>
+}
+
+function isFilesRealtimeEvent(value: unknown): value is FilesRealtimeEvent {
+  if (!value || typeof value !== 'object') return false
+  const v = value as Record<string, unknown>
+  return (
+    typeof v.dir_id === 'string' &&
+    typeof v.class === 'string' &&
+    (v.referenced_by === undefined || Array.isArray(v.referenced_by))
+  )
+}
+
+interface Realtime {
+  subscribe: (
+    event: 'created' | 'deleted' | 'updated',
+    doctype: string,
+    handler: (event: unknown) => void
+  ) => void
+  unsubscribe: (
+    event: 'created' | 'deleted' | 'updated',
+    doctype: string,
+    handler: (event: unknown) => void
+  ) => void
+}
+
+function hasRealtimePlugin(
+  plugins: unknown
+): plugins is { realtime: Realtime } {
+  return (
+    !!plugins &&
+    typeof plugins === 'object' &&
+    'realtime' in (plugins as Record<string, unknown>) &&
+    typeof (plugins as { realtime?: unknown }).realtime === 'object'
+  )
+}
+
 export const SharedWorkerContext = React.createContext<
   DataProxyWorkerContext | undefined
 >(undefined)
@@ -41,13 +82,71 @@ export const SharedWorkerProvider = React.memo(
     const [tabCount, setTabCount] = useState(0)
     const client = useClient()
 
+    useEffect(() => {
+      if (!client) return
+
+      if (!hasRealtimePlugin(client.plugins)) {
+        throw new Error(
+          'You must include the realtime plugin to use RealTimeQueries'
+        )
+      }
+      const realtime = client.plugins.realtime
+
+      if (!realtime) {
+        throw new Error(
+          'You must include the realtime plugin to use RealTimeQueries'
+        )
+      }
+
+      const handleFileCreated = (event: unknown): void => {
+        if (!isFilesRealtimeEvent(event)) return
+        if (
+          event.dir_id === 'io.cozy.files.shared-drives-dir' &&
+          event.class === 'shortcut'
+        ) {
+          const driveId = event?.referenced_by?.[0]?.id
+          if (driveId) {
+            log.info(`Shared drive ${driveId} created`)
+            worker?.addSharedDrive(driveId)
+          }
+        }
+      }
+      const handleFileDeleted = (event: unknown): void => {
+        if (!isFilesRealtimeEvent(event)) return
+        if (
+          event.dir_id === 'io.cozy.files.shared-drives-dir' &&
+          event.class === 'shortcut'
+        ) {
+          const driveId = event?.referenced_by?.[0]?.id
+          if (driveId) {
+            log.info(`Shared drive ${driveId} deleted`)
+            worker?.removeSharedDrive(driveId)
+          }
+        }
+      }
+      realtime.subscribe('created', 'io.cozy.files', handleFileCreated)
+      realtime.subscribe('deleted', 'io.cozy.files', handleFileDeleted)
+      return (): void => {
+        realtime.unsubscribe('created', 'io.cozy.files', handleFileCreated)
+        realtime.unsubscribe('deleted', 'io.cozy.files', handleFileDeleted)
+      }
+    }, [client, worker])
+
     useEffect(() => {
       if (!client) return
 
       const doAsync = async (): Promise<void> => {
         // Cleanup any remaining local data
         await removeStaleLocalData()
 
+        const { data: sharedDrives } = await client
+          .collection('io.cozy.sharings')
+          .fetchSharedDrives()
+
+        const sharedDriveIds: string[] = sharedDrives.map(
+          (drive: { id: string }) => drive.id
+        )
+
         log.debug('Init SharedWorker')
 
         let obj: Comlink.Remote<DataProxyWorker>
@@ -78,14 +177,17 @@ export const SharedWorkerProvider = React.memo(
         log.debug('Provide CozyClient data to Worker')
         const { uri, token } = client.getStackClient()
 
-        await obj.setup({
-          uri,
-          token: token.token,
-          instanceOptions: client.instanceOptions,
-          capabilities: client.capabilities,
-          useRemoteData
-        })
-        setWorker(() => obj)
+        await obj.setup(
+          {
+            uri,
+            token: token.token,
+            instanceOptions: client.instanceOptions,
+            capabilities: client.capabilities,
+            useRemoteData
+          },
+          { sharedDriveIds } as { sharedDriveIds: string[] }
+        )
+        setWorker((): Comlink.Remote<DataProxyWorker> => obj)
       }
 
       doAsync()

src/dataproxy/worker/worker.ts

@@ -19,6 +19,7 @@ import {
   KONNECTORS_DOCTYPE,
   TRIGGERS_DOCTYPE,
   SETTINGS_DOCTYPE,
+  SHARED_DRIVE_FILE_DOCTYPE,
   REPLICATION_DEBOUNCE,
   REPLICATION_DEBOUNCE_MAX_DELAY
 } from '@/consts'
@@ -45,7 +46,12 @@ let searchEngine: SearchEngine
 const broadcastChannel = new BroadcastChannel('DATA_PROXY_BROADCAST_CHANANEL')
 
 const dataProxy: DataProxyWorker = {
-  setup: async (clientData: ClientData) => {
+  setup: async (
+    clientData: ClientData,
+    options: { sharedDriveIds: string[] } = { sharedDriveIds: [] } as {
+      sharedDriveIds: string[]
+    }
+  ) => {
     log.debug('Received data for setting up client')
     if (client) return
     updateState()
@@ -71,28 +77,23 @@ const dataProxy: DataProxyWorker = {
           adapter: 'indexeddb'
         }
       },
-      doctypesReplicationOptions: {
-        [FILES_DOCTYPE]: {
-          strategy: 'fromRemote'
-        },
-        [CONTACTS_DOCTYPE]: {
-          strategy: 'fromRemote'
-        },
-        [APPS_DOCTYPE]: {
-          strategy: 'fromRemote'
-        },
-        [ACCOUNTS_DOCTYPE]: {
-          strategy: 'fromRemote'
-        },
-        [KONNECTORS_DOCTYPE]: {
-          strategy: 'fromRemote'
-        },
-        [TRIGGERS_DOCTYPE]: {
-          strategy: 'fromRemote'
-        },
-        [SETTINGS_DOCTYPE]: {
-          strategy: 'fromRemote'
-        }
+      doctypesReplicationOptions: {}
+    }
+
+    if (options?.sharedDriveIds?.length > 0) {
+      pouchLinkOptions.doctypes.push(
+        ...options?.sharedDriveIds?.map(
+          id => `${SHARED_DRIVE_FILE_DOCTYPE}-${id}`
+        )
+      )
+      pouchLinkOptions.doctypesReplicationOptions = {
+        ...pouchLinkOptions.doctypesReplicationOptions,
+        ...Object.fromEntries(
+          options?.sharedDriveIds?.map(id => [
+            `${SHARED_DRIVE_FILE_DOCTYPE}-${id}`,
+            { strategy: 'fromRemote', driveId: id }
+          ])
+        )
       }
     }
 
@@ -185,6 +186,46 @@ const dataProxy: DataProxyWorker = {
       dataProxy.forceSyncPouch()
       searchEngine.init() // Init again to refresh indexes
     }
+  },
+
+  addSharedDrive: async (driveId: string) => {
+    log.debug(`Worker: Adding shared drive ${driveId}`)
+    if (!client) {
+      throw new Error('Client is required to add a shared drive')
+    }
+    const pouchLink = getPouchLink(client)
+    if (pouchLink) {
+      const doctype = `${SHARED_DRIVE_FILE_DOCTYPE}-${driveId}`
+      const options = { strategy: 'fromRemote', driveId }
+      if (pouchLink.addDoctype) {
+        pouchLink.addDoctype(doctype, options)
+        pouchLink.startReplicationWithDebounce()
+      }
+    }
+
+    if (!searchEngine) {
+      throw new Error('SearchEngine is not initialized')
+    }
+
+    searchEngine.addSharedDrive(driveId)
+  },
+
+  removeSharedDrive: (driveId: string) => {
+    log.debug(`Worker: Removing shared drive ${driveId}`)
+    if (!client) {
+      throw new Error('Client is required to remove a shared drive')
+    }
+    const pouchLink = getPouchLink(client)
+    if (pouchLink) {
+      const doctype = `${SHARED_DRIVE_FILE_DOCTYPE}-${driveId}`
+      pouchLink.removeDoctype(doctype)
+    }
+
+    if (!searchEngine) {
+      throw new Error('SearchEngine is not initialized')
+    }
+
+    searchEngine.removeSharedDrive(driveId)
   }
 }
 

src/targets/browser/setupApp.ts

@@ -3,6 +3,7 @@ import { createRoot } from 'react-dom/client'
 
 import CozyClient from 'cozy-client'
 import flag from 'cozy-flags'
+import { RealtimePlugin } from 'cozy-realtime'
 
 import schema from '@/doctypes'
 
@@ -59,6 +60,7 @@ export const setupApp = memoize(() => {
   const root = createRoot(container)
   const client = makeClient(container)
   client.registerPlugin(flag.plugin, null)
+  client.registerPlugin(RealtimePlugin)
 
   return { root, client }
 })

yarn.lock

@@ -2385,10 +2385,10 @@ cozy-pouch-link@^60.10.1:
     pouchdb-browser "^7.2.2"
     pouchdb-find "^7.2.2"
 
-cozy-realtime@^5.7.0:
-  version "5.7.0"
-  resolved "https://registry.yarnpkg.com/cozy-realtime/-/cozy-realtime-5.7.0.tgz#df3bf3124d8291fd2bb0ec2dd69addd8ec0b7a63"
-  integrity sha512-v1iev1qydt8jgWpjdmI2XsDMghzQvQESi4po6jnW3IISJzLKffJwKxySKtz2OSngRZ7l2wEznLTgALv2sL8y4A==
+cozy-realtime@^5.8.0:
+  version "5.8.0"
+  resolved "https://registry.yarnpkg.com/cozy-realtime/-/cozy-realtime-5.8.0.tgz#88af55ce680da4e263b9514e20062fb5097a4c11"
+  integrity sha512-B/308fMd+RFKj4VBsefqmaCnbata+ToJxCXAqMaD9iYbkW1sE7BoLN7CqyU9YPrQUZsZAqZ2/7rc30ugh4zaGw==
   dependencies:
     "@cozy/minilog" "^1.0.0"