Small improvements for Android backup + custom behavior when quota exceeded

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

@@ -0,0 +1,36 @@
+diff --git a/node_modules/react-native-background-upload/android/src/main/java/com/vydia/RNUploader/GlobalRequestObserverDelegate.kt b/node_modules/react-native-background-upload/android/src/main/java/com/vydia/RNUploader/GlobalRequestObserverDelegate.kt
+index c89d495..5da9d14 100644
+--- a/node_modules/react-native-background-upload/android/src/main/java/com/vydia/RNUploader/GlobalRequestObserverDelegate.kt
++++ b/node_modules/react-native-background-upload/android/src/main/java/com/vydia/RNUploader/GlobalRequestObserverDelegate.kt
+@@ -9,6 +9,7 @@ import com.facebook.react.modules.core.DeviceEventManagerModule.RCTDeviceEventEm
+ import net.gotev.uploadservice.data.UploadInfo
+ 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
+     // Make sure we do not try to call getMessage() on a null object
+     if (exception != null) {
+       params.putString("error", exception.message)
++      if (exception is UploadError) {
++        params.putInt("responseCode", exception.serverResponse.code)
++        params.putString("responseBody", String(exception.serverResponse.body, Charsets.US_ASCII))
++      }
+     } else {
+       params.putString("error", "Unknown exception")
+     }
+diff --git a/node_modules/react-native-background-upload/index.d.ts b/node_modules/react-native-background-upload/index.d.ts
+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
+     }
+
+     export interface CompletedData extends EventData {

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

@@ -0,0 +1,18 @@
+export class BackupError extends Error {
+  statusCode: number | undefined
+
+  constructor(message: string, statusCode: number | undefined) {
+    const stringifiedMessage = JSON.stringify({
+      message,
+      statusCode
+    })
+
+    super(stringifiedMessage)
+    this.name = 'BackupError'
+    this.statusCode = statusCode
+  }
+}
+
+export const STACK_ERRORS_INTERRUPTING_BACKUP = [
+  413 // quota exceeded
+]

src/app/domain/backup/helpers/file.spec.ts

@@ -0,0 +1,37 @@
+import {
+  getPathExtension,
+  getPathWithoutExtension,
+  getPathWithoutFilename
+} from '/app/domain/backup/helpers'
+
+describe('file helper', () => {
+  describe('getPathExtension', () => {
+    it.each([
+      ['IMG_001.heic', 'heic'],
+      ['/Folder/IMG_001.heic', 'heic'],
+      ['IMG_001.heic.mov', 'mov']
+    ])('with %p should return %p', (path, result) => {
+      expect(getPathExtension(path)).toBe(result)
+    })
+  })
+
+  describe('getPathWithoutExtension', () => {
+    it.each([
+      ['IMG_001.heic', 'IMG_001'],
+      ['/Folder/IMG_001.heic', '/Folder/IMG_001'],
+      ['IMG_001.heic.mov', 'IMG_001.heic']
+    ])('with %p should return %p', (path, result) => {
+      expect(getPathWithoutExtension(path)).toBe(result)
+    })
+  })
+
+  describe('getPathWithoutFilename', () => {
+    it.each([
+      ['IMG_001.heic', ''],
+      ['/Folder/IMG_001.heic', '/Folder'],
+      ['/Folder/Directory/IMG_001.heic', '/Folder/Directory']
+    ])('with %p should return %p', (path, result) => {
+      expect(getPathWithoutFilename(path)).toBe(result)
+    })
+  })
+})

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

@@ -0,0 +1,11 @@
+export const getPathExtension = (path: string): string => {
+  return path.substring(path.lastIndexOf('.') + 1)
+}
+
+export const getPathWithoutExtension = (path: string): string => {
+  return path.substring(0, path.lastIndexOf('.'))
+}
+
+export const getPathWithoutFilename = (path: string): string => {
+  return path.substring(0, path.lastIndexOf('/'))
+}

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

@@ -0,0 +1,2 @@
+export * from '/app/domain/backup/helpers/error'
+export * from '/app/domain/backup/helpers/file'

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

@@ -9,6 +9,11 @@ import RNFS from 'react-native-fs'
 
 import { Media, BackupedMedia, Album } from '/app/domain/backup/models'
 import { getLocalBackupConfig } from '/app/domain/backup/services/manageLocalBackupConfig'
+import {
+  getPathWithoutExtension,
+  getPathWithoutFilename
+} from '/app/domain/backup/helpers'
+import { t } from '/locales/i18n'
 
 import type CozyClient from 'cozy-client'
 
@@ -36,7 +41,7 @@ export const getMimeType = (media: Media): string => {
   const guessedMimeType = mime.getType(media.name)
 
   if (guessedMimeType === null) {
-    throw new Error('File is not supported for backup')
+    throw new Error(t('services.backup.errors.fileNotSupported'))
   }
 
   return guessedMimeType
@@ -52,16 +57,14 @@ export const getRemotePath = (uri: string): string => {
     const uriWithExternalStorageDirectoryPathRemoved =
       uriWithProtocolRemoved.replace(RNFS.ExternalStorageDirectoryPath, '')
 
-    const uriWithFilenameRemoved =
-      uriWithExternalStorageDirectoryPathRemoved.substring(
-        0,
-        uriWithExternalStorageDirectoryPathRemoved.lastIndexOf('/')
-      )
+    const uriWithFilenameRemoved = getPathWithoutFilename(
+      uriWithExternalStorageDirectoryPathRemoved
+    )
 
     return uriWithFilenameRemoved
   }
 
-  throw new Error('Platform is not supported for backup')
+  throw new Error(t('services.backup.errors.platformNotSupported'))
 }
 
 export const formatMediasFromPhotoIdentifier = (
@@ -83,7 +86,7 @@ export const formatMediasFromPhotoIdentifier = (
   if (subTypes.includes('PhotoLive')) {
     return [
       {
-        name: filename.substring(0, filename.lastIndexOf('.')) + '.MOV',
+        name: getPathWithoutExtension(filename) + '.MOV',
         path: uri,
         remotePath: getRemotePath(uri),
         type: 'video',

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

@@ -1,3 +1,4 @@
+import type CozyClient from 'cozy-client'
 import Minilog from 'cozy-minilog'
 
 import {
@@ -12,8 +13,7 @@ import {
   storeUserPersistedData,
   UserPersistedStorageKeys
 } from '/libs/localStore'
-
-import type CozyClient from 'cozy-client'
+import { t } from '/locales/i18n'
 
 const log = Minilog('💿 Backup')
 
@@ -45,7 +45,7 @@ export const getLocalBackupConfig = async (
   )
 
   if (backupConfig === null) {
-    throw new Error('Local backup config has not been initialized')
+    throw new Error(t('services.backup.errors.configNotInitialized'))
   }
 
   return backupConfig

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

@@ -6,6 +6,7 @@ import {
   NATIVE_PERMISSIONS,
   NativePermissionStatus
 } from '/app/domain/nativePermissions'
+import { t } from '/locales/i18n'
 
 export const checkBackupPermissions =
   async (): Promise<NativePermissionStatus> => {
@@ -33,7 +34,7 @@ export const checkBackupPermissions =
       )
     }
 
-    throw new Error('Platform is not supported for backup')
+    throw new Error(t('services.backup.errors.platformNotSupported'))
   }
 
 export const requestBackupPermissions =
@@ -62,5 +63,5 @@ export const requestBackupPermissions =
       )
     }
 
-    throw new Error('Platform is not supported for backup')
+    throw new Error(t('services.backup.errors.platformNotSupported'))
   }

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

@@ -14,13 +14,14 @@ import {
   File,
   FilesQueryAllResult
 } from '/app/domain/backup/queries'
+import { getPathWithoutFilename } from '/app/domain/backup/helpers'
+import { t } from '/locales/i18n'
 
 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 BACKUP_ROOT_PATH = '/Sauvegardé depuis mon mobile'
 
 interface BackupFolder {
   _id: string
@@ -128,7 +129,7 @@ export const createRemoteBackupFolder = async (
     data: { _id: backupRootId }
   } = await client
     .collection(DOCTYPE_FILES)
-    .createDirectoryByPath(BACKUP_ROOT_PATH)
+    .createDirectoryByPath(t('services.backup.backupRootPath'))
 
   const backupFolderAttributes = {
     type: 'directory',
@@ -184,9 +185,8 @@ const formatBackupedMedia = (
     ''
   )
 
-  const pathWithFilenameRemoved = pathWithBackupFolderRemoved.substring(
-    0,
-    pathWithBackupFolderRemoved.lastIndexOf('/')
+  const pathWithFilenameRemoved = getPathWithoutFilename(
+    pathWithBackupFolderRemoved
   )
 
   return {

src/app/domain/backup/services/uploadMedia.android.ts

@@ -5,8 +5,9 @@ import RNBackgroundUpload, {
 
 import { getMimeType } from '/app/domain/backup/services/getMedias'
 import { Media, UploadMediaResult } from '/app/domain/backup/models/Media'
+import { t } from '/locales/i18n'
 
-import CozyClient, { IOCozyFile } from 'cozy-client'
+import CozyClient, { StackErrors, IOCozyFile } from 'cozy-client'
 
 let currentUploadId: string | undefined
 
@@ -40,7 +41,33 @@ export const uploadMedia = async (
         }`
       },
       notification: {
-        enabled: false
+        enabled: true,
+        autoClear: true,
+        onProgressTitle: t('services.backup.notifications.onProgressTitle'),
+        onProgressMessage: t(
+          'services.backup.notifications.onProgressMessage',
+          {
+            filename: media.name
+          }
+        ),
+        onCompleteTitle: t('services.backup.notifications.onCompleteTitle'),
+        onCompleteMessage: t(
+          'services.backup.notifications.onCompleteMessage',
+          {
+            filename: media.name
+          }
+        ),
+        onErrorTitle: t('services.backup.notifications.onErrorTitle'),
+        onErrorMessage: t('services.backup.notifications.onErrorMessage', {
+          filename: media.name
+        }),
+        onCancelledTitle: t('services.backup.notifications.onCancelledTitle'),
+        onCancelledMessage: t(
+          'services.backup.notifications.onCancelledMessage',
+          {
+            filename: media.name
+          }
+        )
       }
     } as UploadOptions
 
@@ -49,16 +76,10 @@ export const uploadMedia = async (
         setCurrentUploadId(uploadId)
 
         RNBackgroundUpload.addListener('error', uploadId, error => {
-          // RNBackgroundUpload does not return status code and response body...
+          const { errors } = JSON.parse(error.responseBody) as StackErrors
           reject({
-            statusCode: -1,
-            errors: [
-              {
-                status: -1,
-                title: error.error,
-                detail: error.error
-              }
-            ]
+            statusCode: error.responseCode,
+            errors
           })
         })
         RNBackgroundUpload.addListener('cancelled', uploadId, data => {

src/app/domain/backup/services/uploadMedia.ios.spec.ts

@@ -0,0 +1,14 @@
+import { getVideoPathFromLivePhoto } from '/app/domain/backup/services/uploadMedia.ios'
+
+describe('uploadMedia.ios', () => {
+  describe('getVideoPathFromLivePhoto', () => {
+    it.each([
+      ['IMG_001.HEIC', 'IMG_001.MOV'],
+      ['FullSizeRender.heic', 'FullSizeRender.mov'],
+      ['/Folder/IMG_001.HEIC', '/Folder/IMG_001.MOV'],
+      ['/Folder/FullSizeRender.heic', '/Folder/FullSizeRender.mov']
+    ])('with %p should return %p', (path, result) => {
+      expect(getVideoPathFromLivePhoto(path)).toBe(result)
+    })
+  })
+})

src/app/domain/backup/services/uploadMedia.ios.ts

@@ -4,11 +4,24 @@ import RNFileSystem from 'react-native-fs'
 
 import { getMimeType } from '/app/domain/backup/services/getMedias'
 import { Media, UploadMediaResult } from '/app/domain/backup/models/Media'
+import {
+  getPathExtension,
+  getPathWithoutExtension
+} from '/app/domain/backup/helpers'
+import { t } from '/locales/i18n'
 
 import CozyClient, { StackErrors, IOCozyFile } from 'cozy-client'
 
-const getVideoPathFromLivePhoto = (photoPath: string): string => {
-  return photoPath.substring(0, photoPath.lastIndexOf('.')) + '.MOV'
+export const getVideoPathFromLivePhoto = (photoPath: string): string => {
+  const extension = getPathExtension(photoPath)
+
+  if (extension === extension.toUpperCase()) {
+    // Path is something like IMG_001.MOV
+    return getPathWithoutExtension(photoPath) + '.MOV'
+  } else {
+    // When Live Photo has been modified, path is something like FullSizeRender.mov
+    return getPathWithoutExtension(photoPath) + '.mov'
+  }
 }
 
 const getRealFilepath = async (media: Media): Promise<string> => {
@@ -17,7 +30,7 @@ const getRealFilepath = async (media: Media): Promise<string> => {
   let filepath = data.node.image.filepath
 
   if (filepath === null) {
-    throw new Error('Impossible to get a real filepath')
+    throw new Error(t('services.backup.errors.fileNotFound'))
   }
 
   filepath = filepath.replace('file://', '')