Backup: Lots of fixes, refactoring and documentation

android/app/build.gradle

@@ -239,6 +239,19 @@ dependencies {
             because("kotlin-stdlib-jdk8 is now a part of kotlin-stdlib")
         }
     }
+    implementation(project(":react-native-background-upload")) {
+        exclude group: 'com.squareup.okhttp3', module: 'okhttp'
+    }
+    implementation 'com.squareup.okhttp3:okhttp:5.0.0-alpha.1'
+    configurations.all {
+    resolutionStrategy.eachDependency { DependencyResolveDetails details ->
+        if (details.requested.group == 'com.squareup.okhttp3' && details.requested.name == 'okhttp') {
+            if (details.requested.name == 'net.gotev:uploadservice-okhttp') {
+                details.useVersion 'com.squareup.okhttp3:okhttp:5.0.0-alpha.1'
+            }
+        }
+    }
+}
 }
 
 // Run this once to be able to run the application with BUCK

android/build.gradle

@@ -45,3 +45,7 @@ allprojects {
     // A temporary workaround for that is to disable Javadoc generation for all modules
     // tasks.withType(Javadoc).all { enabled = false }
 }
+
+subprojects {
+    task allDeps(type: DependencyReportTask) {}
+}

patches/react-native-background-upload+6.6.0.patch

@@ -7,7 +7,7 @@ index c89d495..5da9d14 100644
  import net.gotev.uploadservice.network.ServerResponse
  import net.gotev.uploadservice.observer.request.RequestObserverDelegate
 +import net.gotev.uploadservice.exceptions.UploadError
- 
+
  class GlobalRequestObserverDelegate(reactContext: ReactApplicationContext) : RequestObserverDelegate {
    private val TAG = "UploadReceiver"
 @@ -28,6 +29,10 @@ class GlobalRequestObserverDelegate(reactContext: ReactApplicationContext) : Req
@@ -26,11 +26,11 @@ index 8b2a07c..80cff93 100644
 --- a/node_modules/react-native-background-upload/index.d.ts
 +++ b/node_modules/react-native-background-upload/index.d.ts
 @@ -11,6 +11,8 @@ declare module "react-native-background-upload" {
- 
+
      export interface ErrorData extends EventData {
          error: string
-+        responseCode: number
-+        responseBody: string
++        responseCode?: number
++        responseBody?: string
      }
- 
+
      export interface CompletedData extends EventData {

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.js

@@ -30,6 +30,7 @@ import { useCookieResyncOnResume } from '/hooks/useCookieResyncOnResume'
 import { useCozyEnvironmentOverride } from '/hooks/useCozyEnvironmentOverride'
 import { useNotifications } from '/hooks/useNotifications'
 import { useSynchronizeOnInit } from '/hooks/useSynchronizeOnInit'
+import { useInitBackup } from '/app/domain/backup/hooks'
 import { useNetService } from '/libs/services/NetService'
 import { withSentry } from '/libs/monitoring/Sentry'
 import { ThemeProvider } from '/app/theme/ThemeProvider'
@@ -50,6 +51,7 @@ const App = ({ setClient }) => {
   useSynchronizeOnInit()
   useNetService(client)
   useInitI18n(client)
+  useInitBackup(client)
 
   const { initialRoute, isLoading } = useAppBootstrap(client)
 

src/app/domain/backup/helpers/error.ts

@@ -1,3 +1,5 @@
+import { UploadError } from '/app/domain/upload/models'
+
 export class BackupError extends Error {
   statusCode: number | undefined
 
@@ -13,6 +15,23 @@ export class BackupError extends Error {
   }
 }
 
-export const STACK_ERRORS_INTERRUPTING_BACKUP = [
-  413 // quota exceeded
-]
+export const isUploadError = (error: unknown): error is UploadError => {
+  return (
+    typeof error === 'object' &&
+    error !== null &&
+    'statusCode' in error &&
+    'errors' in error &&
+    Array.isArray(error.errors)
+  )
+}
+
+export const isQuotaExceededError = (error: UploadError): boolean => {
+  return (
+    error.statusCode === 413 &&
+    error.errors[0]?.detail === 'The file is too big and exceeds the disk quota'
+  )
+}
+
+export const isFatalError = (error: UploadError): boolean => {
+  return isQuotaExceededError(error)
+}

src/app/domain/backup/hooks/index.ts

@@ -0,0 +1 @@
+export * from '/app/domain/backup/hooks/useInitBackup'

src/app/domain/backup/hooks/useInitBackup.tsx

@@ -0,0 +1,33 @@
+import { useEffect } from 'react'
+
+import { useClient } from 'cozy-client'
+
+import {
+  getLocalBackupConfig,
+  setBackupAsToDo
+} from '/app/domain/backup/services/manageLocalBackupConfig'
+
+import Minilog from 'cozy-minilog'
+
+const log = Minilog('💿 Backup')
+
+export const useInitBackup = (): void => {
+  const client = useClient()
+
+  useEffect(() => {
+    const checkAndFixIfBackupStuckInRunning = async (): Promise<void> => {
+      if (!client) {
+        return
+      }
+
+      const backupConfig = await getLocalBackupConfig(client)
+
+      if (backupConfig.currentBackup.status === 'running') {
+        log.debug('A running backup has been set as to do.')
+        await setBackupAsToDo(client)
+      }
+    }
+
+    void checkAndFixIfBackupStuckInRunning()
+  }, [client])
+}

src/app/domain/backup/models/Media.ts

@@ -1,5 +1,3 @@
-import { StackErrors, IOCozyFile } from 'cozy-client'
-
 import { Album } from '/app/domain/backup/models'
 
 /**
@@ -18,25 +16,19 @@ export interface Media {
   subType?: 'PhotoLive'
   mimeType?: string
   creationDate: number
+  modificationDate: number
   albums: Album[]
+  fileSize: number | null
 }
 
 /**
  * A selection of media metadata stored locally to identify if a media has already been backuped
  * @member {string} name
  * @member {string} remotePath e.g. /Sauvegardé depuis mon mobile/My Android/Download
+ * @member {string} remoteName e.g. IMG_001 (1).jpg (added only if different from name)
  */
 export interface BackupedMedia {
   name: string
   remotePath: string
-}
-
-export type UploadMediaError = {
-  statusCode: number
-} & StackErrors
-
-// These type is incomplete there is more information in data
-export interface UploadMediaResult {
-  statusCode: number
-  data: IOCozyFile
+  remoteName?: string
 }

src/app/domain/backup/services/getMedias.spec.ts

@@ -43,7 +43,7 @@ describe('formatMediasFromPhotoIdentifier', () => {
         group_name: 'Pictures',
         image: {
           extension: 'jpg',
-          fileSize: null,
+          fileSize: 1234,
           filename: 'IMG_20230519_204453.jpg',
           height: null,
           orientation: null,
@@ -70,7 +70,9 @@ describe('formatMediasFromPhotoIdentifier', () => {
         remotePath: '/Pictures',
         type: 'image',
         mimeType: 'image/jpeg',
+        fileSize: 1234,
         creationDate: 1684521894234,
+        modificationDate: 1684521894000,
         albums: [{ name: 'Pictures' }]
       }
     ])
@@ -84,7 +86,7 @@ describe('formatMediasFromPhotoIdentifier', () => {
         group_name: ['Pictures'],
         image: {
           extension: 'heic',
-          fileSize: null,
+          fileSize: 1234,
           filename: 'IMG_0744.HEIC',
           height: null,
           playableDuration: null,
@@ -109,8 +111,10 @@ describe('formatMediasFromPhotoIdentifier', () => {
         path: 'ph://5FD84686-207F-40F1-BCE8-3A837275B0E3/L0/001',
         remotePath: '/',
         type: 'image',
+        fileSize: 1234,
         mimeType: undefined,
         creationDate: 1682604478599,
+        modificationDate: 1688756699463.186,
         albums: [{ name: 'Pictures' }]
       }
     ])
@@ -124,7 +128,7 @@ describe('formatMediasFromPhotoIdentifier', () => {
         group_name: ['Pictures'],
         image: {
           extension: 'heic',
-          fileSize: null,
+          fileSize: 1234,
           filename: 'IMG_0744.HEIC',
           height: null,
           playableDuration: null,
@@ -152,7 +156,9 @@ describe('formatMediasFromPhotoIdentifier', () => {
         subType: 'PhotoLive',
         mimeType: undefined,
         creationDate: 1682604478599,
-        albums: [{ name: 'Pictures' }]
+        modificationDate: 1688756699463.186,
+        albums: [{ name: 'Pictures' }],
+        fileSize: null
       },
       {
         name: 'IMG_0744.HEIC',
@@ -161,7 +167,9 @@ describe('formatMediasFromPhotoIdentifier', () => {
         type: 'image',
         subType: 'PhotoLive',
         mimeType: undefined,
+        fileSize: 1234,
         creationDate: 1682604478599,
+        modificationDate: 1688756699463.186,
         albums: [{ name: 'Pictures' }]
       }
     ])

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

@@ -27,9 +27,8 @@ const getPhotoIdentifiersPage = async (
   const photoIdentifiersPage = await CameraRoll.getPhotos({
     first: MEDIAS_BY_PAGE,
     after: after,
-    include: ['filename', 'fileExtension']
+    include: ['filename', 'fileExtension', 'fileSize']
   })
-
   return photoIdentifiersPage
 }
 
@@ -72,10 +71,11 @@ export const formatMediasFromPhotoIdentifier = (
 ): Media[] => {
   const {
     node: {
-      image: { filename, uri },
+      image: { filename, uri, fileSize },
       type,
       subTypes,
-      timestamp
+      timestamp,
+      modificationTimestamp
     }
   } = photoIdentifier
 
@@ -92,7 +92,9 @@ export const formatMediasFromPhotoIdentifier = (
         type: 'video',
         subType: 'PhotoLive',
         creationDate: timestamp * 1000,
-        albums
+        modificationDate: modificationTimestamp * 1000,
+        albums,
+        fileSize: null
       },
       {
         name: filename,
@@ -101,7 +103,9 @@ export const formatMediasFromPhotoIdentifier = (
         type: 'image',
         subType: 'PhotoLive',
         creationDate: timestamp * 1000,
-        albums
+        modificationDate: modificationTimestamp * 1000,
+        albums,
+        fileSize
       }
     ]
   }
@@ -114,7 +118,9 @@ export const formatMediasFromPhotoIdentifier = (
       type: type.includes('image') ? 'image' : 'video',
       mimeType: Platform.OS == 'android' ? type : undefined,
       creationDate: timestamp * 1000,
-      albums
+      modificationDate: modificationTimestamp * 1000,
+      albums,
+      fileSize
     }
   ]
 }

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

@@ -1,4 +1,5 @@
 import { CameraRoll } from '@react-native-camera-roll/camera-roll'
+import { Platform } from 'react-native'
 
 import { Album, BackupedAlbum } from '/app/domain/backup/models'
 import { getLocalBackupConfig } from '/app/domain/backup/services/manageLocalBackupConfig'
@@ -11,6 +12,10 @@ import {
 
 import type CozyClient from 'cozy-client'
 
+export const areAlbumsEnabled = (): boolean => {
+  return Platform.OS === 'ios'
+}
+
 export const getAlbums = async (): Promise<Album[]> => {
   const cameraRollAlbums = await CameraRoll.getAlbums()
 

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

@@ -7,9 +7,11 @@ import {
   setBackupAsReady,
   setBackupAsRunning,
   setBackupAsDone,
-  saveAlbums
+  saveAlbums,
+  updateRemoteBackupConfigLocally
 } from '/app/domain/backup/services/manageLocalBackupConfig'
 import {
+  areAlbumsEnabled,
   getAlbums,
   createRemoteAlbums,
   fetchBackupedAlbums
@@ -22,7 +24,7 @@ import {
 import {
   cancelUpload,
   getCurrentUploadId
-} from '/app/domain/backup/services/uploadMedia'
+} from '/app/domain/upload/services/upload'
 import {
   fetchDeviceRemoteBackupConfig,
   fetchBackupedMedias,
@@ -66,11 +68,13 @@ export const prepareBackup = async (
 
   void onProgress(await getBackupInfo(client))
 
-  const albums = await getAlbums()
+  if (areAlbumsEnabled()) {
+    const albums = await getAlbums()
 
-  const createdAlbums = await createRemoteAlbums(client, albums)
+    const createdAlbums = await createRemoteAlbums(client, albums)
 
-  await saveAlbums(client, createdAlbums)
+    await saveAlbums(client, createdAlbums)
+  }
 
   const mediasToBackup = await getMediasToBackup(client)
 
@@ -89,6 +93,8 @@ export const startBackup = async (
 ): Promise<BackupInfo> => {
   log.debug('Backup started')
 
+  await updateRemoteBackupConfigLocally(client)
+
   const localBackupConfig = await getLocalBackupConfig(client)
 
   await setBackupAsRunning(client)