packages/drive-store/utils/transfer.ts

   1 import { ProgressBarStatus } from '../components/TransferManager/ProgressBar';
   2 import type { Transfer, TransferSummary, TransfersStats } from '../components/TransferManager/transfer';
   3 import { TransferState } from '../components/TransferManager/transfer';
   4
   5 export const isTransferFinished = ({ state }: { state: TransferState }) =>
   6     [TransferState.Error, TransferState.Canceled, TransferState.Skipped, TransferState.Done].includes(state);
   7
   8 export const isTransferActive = ({ state }: { state: TransferState }) =>
   9     [
  10         TransferState.Pending,
  11         TransferState.Initializing,
  12         TransferState.Conflict,
  13         TransferState.SignatureIssue,
  14         TransferState.Progress,
  15         TransferState.Finalizing,
  16     ].includes(state);
  17
  18 export const isTransferFailed = ({ state }: { state: TransferState }) =>
  19     [TransferState.Error, TransferState.Canceled].includes(state);
  20
  21 export const isTransferDone = ({ state }: { state: TransferState }) => state === TransferState.Done;
  22
  23 export const isTransferError = ({ state }: { state: TransferState }) =>
  24     state === TransferState.Error || state === TransferState.NetworkError;
  25
  26 export const isTransferCanceled = ({ state }: { state: TransferState }) => state === TransferState.Canceled;
  27
  28 export const isTransferSkipped = ({ state }: { state: TransferState }) => state === TransferState.Skipped;
  29
  30 export const isTransferConflict = ({ state }: { state: TransferState }) => state === TransferState.Conflict;
  31
  32 export const isTransferSignatureIssue = ({ state }: { state: TransferState }) => state === TransferState.SignatureIssue;
  33
  34 export const isTransferProgress = ({ state }: { state: TransferState }) => state === TransferState.Progress;
  35
  36 export const isTransferInitializing = ({ state }: { state: TransferState }) => state === TransferState.Initializing;
  37
  38 export const isTransferManuallyPaused = ({ state }: { state: TransferState }) => state === TransferState.Paused;
  39
  40 export const isTransferPaused = ({ state }: { state: TransferState }) =>
  41     state === TransferState.Paused || state === TransferState.NetworkError;
  42
  43 export const isTransferPausedByConnection = ({ state }: { state: TransferState }) =>
  44     state === TransferState.NetworkError;
  45
  46 export const isTransferPending = ({ state }: { state: TransferState }) => state === TransferState.Pending;
  47
  48 export const isTransferFinalizing = ({ state }: { state: TransferState }) => state === TransferState.Finalizing;
  49
  50 export const isTransferOngoing = ({ state }: { state: TransferState }) => {
  51     return ![
  52         TransferState.Error,
  53         TransferState.Canceled,
  54         TransferState.Skipped,
  55         TransferState.Done,
  56         TransferState.Finalizing,
  57     ].includes(state);
  58 };
  59
  60 export const isTransferCancelError = (error: Error) => error.name === 'TransferCancel' || error.name === 'AbortError';
  61 export const isPhotosDisabledUploadError = (error: Error) => error.name === 'PhotosUploadDisabled';
  62 export const isTransferRetry = (error: Error) => error.name === 'TransferRetry';
  63 export const isTransferSkipError = (error: Error) => error.name === 'TransferSkipped';
  64
  65 export const getProgressBarStatus = (transferState: TransferState): ProgressBarStatus => {
  66     return (
  67         (
  68             {
  69                 [TransferState.Done]: ProgressBarStatus.Success,
  70                 [TransferState.Canceled]: ProgressBarStatus.Disabled,
  71                 [TransferState.Error]: ProgressBarStatus.Error,
  72             } as any
  73         )[transferState] || ProgressBarStatus.Running
  74     );
  75 };
  76
  77 export const calculateProgress = (stats: TransfersStats, transfers: Transfer[]) => {
  78     /**
  79      * Returns a transfer summary while compensating for empty files.
  80      * We consider empty files as 1 byte to avoid constant 0% progress
  81      * along the trasfer with multiple empty files.
  82      */
  83     function transferSummaryReducer(acc: TransferSummary, transfer: Transfer): TransferSummary {
  84         const emptyFileCompensationInBytes = 1;
  85         if (transfer.meta.size === 0) {
  86             if (transfer.state === TransferState.Done) {
  87                 acc.progress += emptyFileCompensationInBytes;
  88             }
  89             acc.size += emptyFileCompensationInBytes;
  90         } else {
  91             acc.size += transfer.meta.size || 0;
  92             acc.progress +=
  93                 (transfer.state === TransferState.Done ? transfer.meta.size : stats[transfer.id]?.progress) || 0;
  94         }
  95
  96         return acc;
  97     }
  98
  99     const { progress, size } = transfers.reduce(transferSummaryReducer, { progress: 0, size: 0 });
 100
 101     return Math.floor(100 * (progress / (size || 1)));
 102 };