Backup: Lots of fixes, refactoring and documentation

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

@@ -130,6 +130,10 @@ declare module 'cozy-client' {
     ) => Promise<{ included: { attributes: unknown }[] }>
     createDirectoryByPath: (path: string) => Promise<FileCollectionGetResult>
     ensureDirectoryExists: (path: string) => Promise<string>
+    getDirectoryOrCreate: (
+      name: string,
+      parentDirectory: object
+    ) => Promise<FileCollectionGetResult>
     createFileMetadata: (metadata: object) => Promise<{ data: { id: string } }>
     addReferencesTo: (references: object, dirs: object[]) => Promise<void>
     // eslint-disable-next-line @typescript-eslint/no-explicit-any

src/app/domain/backup/services/manageRemoteBackupConfig.ts

@@ -22,6 +22,15 @@ import { IOCozyFile } from 'cozy-client/types/types'
 const DOCTYPE_APPS = 'io.cozy.apps'
 const DOCTYPE_FILES = 'io.cozy.files'
 const BACKUP_REF = `io.cozy.apps/photos/mobile`
+const PHOTOS_REF = `io.cozy.apps/photos`
+
+interface Folder {
+  _id: string
+  attributes: {
+    name: string
+    path: string
+  }
+}
 
 interface BackupFolder {
   _id: string
@@ -119,17 +128,65 @@ const createRemoteBackupFolderWithConflictStrategy = async (
   }
 }
 
+export const getOrCreatePhotosMagicFolder = async (
+  client: CozyClient
+): Promise<Folder> => {
+  const { included } = await client.collection(DOCTYPE_FILES).findReferencedBy({
+    _type: DOCTYPE_APPS,
+    _id: PHOTOS_REF
+  })
+
+  let photosMagicFolders = included as Folder[]
+
+  photosMagicFolders = photosMagicFolders.filter(
+    folder => !isInTrash(folder.attributes.path)
+  )
+
+  if (photosMagicFolders.length > 0) {
+    return photosMagicFolders[0]
+  }
+
+  const { data: newPhotosMagicFolder } = await client
+    .collection(DOCTYPE_FILES)
+    .createDirectoryByPath('/Photos')
+
+  await client.collection(DOCTYPE_FILES).addReferencesTo(
+    {
+      _id: PHOTOS_REF,
+      _type: DOCTYPE_APPS
+    },
+    [
+      {
+        _id: newPhotosMagicFolder._id
+      }
+    ]
+  )
+
+  return {
+    _id: newPhotosMagicFolder._id,
+    attributes: {
+      name: newPhotosMagicFolder.name,
+      path: newPhotosMagicFolder.path
+    }
+  }
+}
+
 export const createRemoteBackupFolder = async (
   client: CozyClient
 ): Promise<RemoteBackupConfig> => {
   const deviceName = await getDeviceName()
   const deviceId = await getDeviceId()
 
+  const photosMagicFolder = await getOrCreatePhotosMagicFolder(client)
+
   const {
     data: { _id: backupRootId }
   } = await client
     .collection(DOCTYPE_FILES)
-    .createDirectoryByPath(t('services.backup.backupRootPath'))
+    .getDirectoryOrCreate(
+      t('services.backup.backupRootName'),
+      photosMagicFolder
+    )
 
   const backupFolderAttributes = {
     type: 'directory',

src/locales/en.json

@@ -80,7 +80,7 @@
   },
   "services": {
     "backup": {
-      "backupRootPath": "/Mobile backup",
+      "backupRootName": "Mobile backup",
       "notifications": {
         "onProgressTitle": "Uploading",
         "onProgressMessage": "{{filename}} is being uploaded",

src/locales/es.json

@@ -69,7 +69,7 @@
   },
   "services": {
     "backup": {
-      "backupRootPath": "/Copiado desde mi móvil",
+      "backupRootName": "Copiado desde mi móvil",
       "errors": {
         "fileNotFound": "Archivo no encontrado",
         "fileNotSupported": "Archivo no compatible con la copia de seguridad",

src/locales/fr.json

@@ -80,7 +80,7 @@
   },
   "services": {
     "backup": {
-      "backupRootPath": "/Sauvegardé depuis mon mobile",
+      "backupRootName": "Sauvegardé depuis mon mobile",
       "notifications": {
         "onProgressTitle": "Envoi en cours",
         "onProgressMessage": "{{filename}} est en cours de sauvegarde",