feat: Move SearchEngine to cozy-dataproxy library

jest-setup.ts

@@ -1 +1,2 @@
 import '@testing-library/jest-dom';
+import 'cross-fetch/polyfill';

jest.config.ts

@@ -26,6 +26,8 @@ export default {
     '\\.(css|less|scss|sass)$': '<rootDir>/tests/__mocks__/styleMock.js',
     "^@/(.*)$": "<rootDir>/src/$1",
     "^manifest.webapp$": ["<rootDir>/manifest.webapp"],
+    // Force module uuid to resolve with the CJS entry point, because Jest does not support package.json.exports. See https://github.com/uuidjs/uuid/issues/451
+    "uuid": require.resolve('uuid'),
   },
   resetMocks: true
 };

package.json

@@ -14,12 +14,13 @@
   "dependencies": {
     "comlink": "^4.4.1",
     "cozy-app-publish": "^0.34.0",
-    "cozy-client": "^50.1.0",
+    "cozy-client": "^50.3.1",
+    "cozy-dataproxy-lib": "^1.1.1",
     "cozy-device-helper": "^3.1.0",
     "cozy-flags": "^4.0.0",
     "cozy-logger": "^1.10.4",
     "cozy-minilog": "^3.3.1",
-    "cozy-pouch-link": "^50.1.0",
+    "cozy-pouch-link": "^50.3.1",
     "cozy-realtime": "^5.0.2",
     "cozy-tsconfig": "^1.2.0",
     "flexsearch": "^0.7.43",
@@ -43,6 +44,7 @@
     "@types/sharedworker": "^0.0.126",
     "@typescript-eslint/eslint-plugin": "^7.1.0",
     "@typescript-eslint/parser": "^7.1.0",
+    "cross-fetch": "^4.0.0",
     "eslint": "8.57.1",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-import": "2.29.1",

src/App.tsx

@@ -13,7 +13,7 @@ Minilog.enable()
 
 const App = (): JSX.Element => {
   const client = useClient()
-  const { workerState } = useSharedWorker()
+  const { worker, workerState } = useSharedWorker()
 
   return (
     <div className="content">
@@ -28,6 +28,13 @@ const App = (): JSX.Element => {
           </p>
         )
       })}
+      <button
+        onClick={() => {
+          worker.forceSyncPouch()
+        }}
+      >
+        Force sync
+      </button>
     </div>
   )
 }

src/consts.ts

@@ -0,0 +1,8 @@
+export const REPLICATION_DEBOUNCE = 30 * 1000 // 30s
+export const REPLICATION_DEBOUNCE_MAX_DELAY = 600 * 1000 // 10min
+
+export const FILES_DOCTYPE = 'io.cozy.files'
+export const CONTACTS_DOCTYPE = 'io.cozy.contacts'
+export const APPS_DOCTYPE = 'io.cozy.apps'
+
+export const LOCALSTORAGE_KEY_DELETING_DATA = 'deletingLocalData'

src/dataproxy/common/DataProxyInterface.ts

@@ -1,11 +1,10 @@
 import type { InstanceOptions } from 'cozy-client'
 import type { ClientCapabilities } from 'cozy-client/types/types'
 
-export type { SearchIndexes } from '@/search/types'
-
 export interface DataProxyWorker {
   search: (query: string) => unknown
   setup: (clientData: ClientData) => Promise<void>
+  forceSyncPouch: () => void
 }
 
 export interface DataProxyWorkerPartialState {

src/dataproxy/worker/shared-worker.ts

@@ -1,18 +1,25 @@
 import * as Comlink from 'comlink'
 
 import CozyClient from 'cozy-client'
+import { SearchEngine } from 'cozy-dataproxy-lib'
 import Minilog from 'cozy-minilog'
 import PouchLink from 'cozy-pouch-link'
 
+import {
+  FILES_DOCTYPE,
+  CONTACTS_DOCTYPE,
+  APPS_DOCTYPE,
+  REPLICATION_DEBOUNCE,
+  REPLICATION_DEBOUNCE_MAX_DELAY
+} from '@/consts'
 import {
   ClientData,
   DataProxyWorker,
   DataProxyWorkerPartialState
 } from '@/dataproxy/common/DataProxyInterface'
 import { platformWorker } from '@/dataproxy/worker/platformWorker'
 import schema from '@/doctypes'
-import SearchEngine from '@/search/SearchEngine'
-import { FILES_DOCTYPE, CONTACTS_DOCTYPE, APPS_DOCTYPE } from '@/search/consts'
+import { getPouchLink } from '@/helpers/client'
 
 const log = Minilog('👷‍♂️ [shared-worker]')
 Minilog.enable()
@@ -32,6 +39,8 @@ const dataProxy: DataProxyWorker = {
       doctypes: [FILES_DOCTYPE, CONTACTS_DOCTYPE, APPS_DOCTYPE],
       initialSync: true,
       periodicSync: false,
+      syncDebounceDelayInMs: REPLICATION_DEBOUNCE,
+      syncDebounceMaxDelayInMs: REPLICATION_DEBOUNCE_MAX_DELAY,
       platform: { ...platformWorker },
       doctypesReplicationOptions: {
         [FILES_DOCTYPE]: {
@@ -80,6 +89,18 @@ const dataProxy: DataProxyWorker = {
     const endSearchTime = performance.now()
     log.debug(`Search took ${endSearchTime - startSearchTime} ms`)
     return results
+  },
+
+  forceSyncPouch: () => {
+    if (!client) {
+      throw new Error(
+        'Client is required to execute a forceSyncPouch, please initialize CozyClient'
+      )
+    }
+    const pouchLink = getPouchLink(client)
+    if (pouchLink) {
+      pouchLink.startReplication()
+    }
   }
 }
 

src/dataproxy/worker/utils.ts

@@ -1,6 +1,6 @@
 import Minilog from 'cozy-minilog'
 
-import { LOCALSTORAGE_KEY_DELETING_DATA } from '@/search/consts'
+import { LOCALSTORAGE_KEY_DELETING_DATA } from '@/consts'
 const log = Minilog('👷‍♂️ [Worker utils]')
 
 const deleteDatabases = async (): Promise<void> => {

src/helpers/client.spec.ts

@@ -0,0 +1,41 @@
+import CozyClient from 'cozy-client'
+import PouchLink from 'cozy-pouch-link'
+import { LinkPlatform } from 'cozy-pouch-link/types/types'
+
+import { getPouchLink } from '@/helpers/client'
+
+test('should retrieve PouchLink from client', () => {
+  const pouchLinkOptions = {
+    doctypes: ['io.cozy.files'],
+    initialSync: true,
+    periodicSync: false,
+    platform: {} as LinkPlatform,
+    doctypesReplicationOptions: {
+      'io.cozy.files': {
+        strategy: 'fromRemote'
+      }
+    }
+  }
+  const pouchLink = new PouchLink(pouchLinkOptions)
+  const client = new CozyClient({
+    links: [pouchLink]
+  })
+
+  const result = getPouchLink(client)
+
+  expect(result).toBe(pouchLink)
+})
+
+test('should return null if no client', () => {
+  const result = getPouchLink(undefined)
+
+  expect(result).toBe(null)
+})
+
+test('should return null if no PouchLink found', () => {
+  const client = new CozyClient()
+
+  const result = getPouchLink(client)
+
+  expect(result).toBe(null)
+})

src/search/helpers/client.ts → src/helpers/client.ts

@@ -1,7 +1,7 @@
 import CozyClient from 'cozy-client'
 import PouchLink from 'cozy-pouch-link'
 
-export const getPouchLink = (client: CozyClient): PouchLink | null => {
+export const getPouchLink = (client?: CozyClient): PouchLink | null => {
   if (!client) {
     return null
   }