Be resilient to invalid incrementalMac value

ts/components/Preferences.stories.tsx

@@ -192,17 +192,19 @@ export default {
     ),
     validateBackup: async () => {
       return {
-        totalBytes: 100,
+        result: {
-        stats: {
+          totalBytes: 100,
-          adHocCalls: 1,
+          stats: {
-          callLinks: 2,
+            adHocCalls: 1,
-          conversations: 3,
+            callLinks: 2,
-          chats: 4,
+            conversations: 3,
-          distributionLists: 5,
+            chats: 4,
-          messages: 6,
+            distributionLists: 5,
-          skippedMessages: 7,
+            messages: 6,
-          stickerPacks: 8,
+            skippedMessages: 7,
-          fixedDirectMessages: 9,
+            stickerPacks: 8,
+            fixedDirectMessages: 9,
+          },
         },
       };
     },

ts/components/Preferences.tsx

@@ -14,7 +14,7 @@ import classNames from 'classnames';
 import * as LocaleMatcher from '@formatjs/intl-localematcher';
 
 import type { MediaDeviceSettings } from '../types/Calling';
-import type { ExportResultType as BackupExportResultType } from '../services/backups';
+import type { ValidationResultType as BackupValidationResultType } from '../services/backups';
 import type {
   AutoDownloadAttachmentType,
   NotificationSettingType,
@@ -178,7 +178,7 @@ type PropsFunctionType = {
       value: CustomColorType;
     }
   ) => unknown;
-  validateBackup: () => Promise<BackupExportResultType>;
+  validateBackup: () => Promise<BackupValidationResultType>;
 
   // Change handlers
   onAudioNotificationsChange: CheckboxChangeHandlerType;

ts/components/PreferencesInternal.tsx

@@ -5,7 +5,7 @@ import React, { useState, useCallback } from 'react';
 import type { LocalizerType } from '../types/I18N';
 import { toLogFormat } from '../types/errors';
 import { formatFileSize } from '../util/formatFileSize';
-import type { ExportResultType as BackupExportResultType } from '../services/backups';
+import type { ValidationResultType as BackupValidationResultType } from '../services/backups';
 import { SettingsRow, SettingsControl } from './PreferencesUtil';
 import { Button, ButtonVariant } from './Button';
 import { Spinner } from './Spinner';
@@ -15,26 +15,20 @@ export function PreferencesInternal({
   validateBackup: doValidateBackup,
 }: {
   i18n: LocalizerType;
-  validateBackup: () => Promise<BackupExportResultType>;
+  validateBackup: () => Promise<BackupValidationResultType>;
 }): JSX.Element {
   const [isValidationPending, setIsValidationPending] = useState(false);
   const [validationResult, setValidationResult] = useState<
-    | {
+    BackupValidationResultType | undefined
-        result: BackupExportResultType;
-      }
-    | {
-        error: Error;
-      }
-    | undefined
   >();
 
   const validateBackup = useCallback(async () => {
     setIsValidationPending(true);
     setValidationResult(undefined);
     try {
-      setValidationResult({ result: await doValidateBackup() });
+      setValidationResult(await doValidateBackup());
     } catch (error) {
-      setValidationResult({ error });
+      setValidationResult({ error: toLogFormat(error) });
     } finally {
       setIsValidationPending(false);
     }
@@ -61,7 +55,7 @@ export function PreferencesInternal({
       validationElem = (
         <div className="Preferences--internal--validate-backup--error">
           <pre>
-            <code>{toLogFormat(error)}</code>
+            <code>{error}</code>
           </pre>
         </div>
       );

ts/services/backups/index.ts

@@ -52,7 +52,7 @@ import { BackupImportStream } from './import';
 import { getKeyMaterial } from './crypto';
 import { BackupCredentials } from './credentials';
 import { BackupAPI } from './api';
-import { validateBackup } from './validator';
+import { validateBackup, ValidationType } from './validator';
 import { BackupType } from './types';
 import {
   BackupInstallerError,
@@ -103,6 +103,15 @@ export type ExportResultType = Readonly<{
   stats: Readonly<StatsType>;
 }>;
 
+export type ValidationResultType = Readonly<
+  | {
+      result: ExportResultType;
+    }
+  | {
+      error: string;
+    }
+>;
+
 export class BackupsService {
   #isStarted = false;
   #isRunning: 'import' | 'export' | false = false;
@@ -322,26 +331,40 @@ export class BackupsService {
     );
 
     if (backupType === BackupType.Ciphertext) {
-      await validateBackup(() => new FileStream(path), totalBytes);
+      await validateBackup(
+        () => new FileStream(path),
+        totalBytes,
+        isTestOrMockEnvironment()
+          ? ValidationType.Internal
+          : ValidationType.Export
+      );
     }
 
     return totalBytes;
   }
 
   // Test harness
-  public async validate(
+  public async _internalValidate(
     backupLevel: BackupLevel = BackupLevel.Free,
     backupType = BackupType.Ciphertext
-  ): Promise<ExportResultType> {
+  ): Promise<ValidationResultType> {
     const { data, ...result } = await this.exportBackupData(
       backupLevel,
       backupType
     );
     const buffer = Buffer.from(data);
 
-    await validateBackup(() => new MemoryStream(buffer), buffer.byteLength);
+    try {
+      await validateBackup(
+        () => new MemoryStream(buffer),
+        buffer.byteLength,
+        ValidationType.Internal
+      );
 
-    return result;
+      return { result };
+    } catch (error) {
+      return { error: Errors.toLogFormat(error) };
+    }
   }
 
   // Test harness

ts/services/backups/util/filePointers.ts

@@ -180,9 +180,11 @@ export async function getFilePointerForAttachment({
 }> {
   const filePointerRootProps = new Backups.FilePointer({
     contentType: attachment.contentType,
-    incrementalMac: attachment.incrementalMac
+    // Resilience to invalid data in the database from internal testing
-      ? Bytes.fromBase64(attachment.incrementalMac)
+    incrementalMac:
-      : undefined,
+      typeof attachment.incrementalMac === 'string'
+        ? Bytes.fromBase64(attachment.incrementalMac)
+        : undefined,
     incrementalMacChunkSize: dropZero(attachment.chunkSize),
     fileName: attachment.fileName,
     width: attachment.width,

ts/services/backups/validator.ts

@@ -6,11 +6,17 @@ import type { InputStream } from '@signalapp/libsignal-client/dist/io';
 
 import { strictAssert } from '../../util/assert';
 import { toAciObject } from '../../util/ServiceId';
-import { isTestOrMockEnvironment } from '../../environment';
+import { missingCaseError } from '../../util/missingCaseError';
+
+export enum ValidationType {
+  Export = 'Export',
+  Internal = 'Internal',
+}
 
 export async function validateBackup(
   inputFactory: () => InputStream,
-  fileSize: number
+  fileSize: number,
+  type: ValidationType
 ): Promise<void> {
   const accountEntropy = window.storage.get('accountEntropyPool');
   strictAssert(accountEntropy, 'Account Entropy Pool not available');
@@ -28,12 +34,14 @@ export async function validateBackup(
     BigInt(fileSize)
   );
 
-  if (isTestOrMockEnvironment()) {
+  if (type === ValidationType.Internal) {
     strictAssert(
       outcome.ok,
       `Backup validation failed: ${outcome.errorMessage}`
     );
-  } else {
+  } else if (type === ValidationType.Export) {
     strictAssert(outcome.ok, 'Backup validation failed');
+  } else {
+    throw missingCaseError(type);
   }
 }

ts/util/createIPCEvents.ts

@@ -25,7 +25,7 @@ import { resolveUsernameByLinkBase64 } from '../services/username';
 import { writeProfile } from '../services/writeProfile';
 import {
   backupsService,
-  type ExportResultType as BackupExportResultType,
+  type ValidationResultType as BackupValidationResultType,
 } from '../services/backups';
 import { isInCall } from '../state/selectors/calling';
 import { getConversationsWithCustomColorSelector } from '../state/selectors/conversations';
@@ -164,7 +164,7 @@ export type IPCEventsCallbacksType = {
   unknownSignalLink: () => void;
   getCustomColors: () => Record<string, CustomColorType>;
   syncRequest: () => Promise<void>;
-  validateBackup: () => Promise<BackupExportResultType>;
+  validateBackup: () => Promise<BackupValidationResultType>;
   setGlobalDefaultConversationColor: (
     color: ConversationColorType,
     customColor?: { id: string; value: CustomColorType }
@@ -551,7 +551,8 @@ export function createIPCEvents(
       await sendSyncRequests();
       return contactSyncComplete;
     },
-    validateBackup: () => backupsService.validate(),
+    // Only for internal use
+    validateBackup: () => backupsService._internalValidate(),
     getLastSyncTime: () => window.storage.get('synced_at'),
     setLastSyncTime: value => window.storage.put('synced_at', value),
     getUniversalExpireTimer: () => universalExpireTimer.get(),