Add dev menu to import local backup

_locales/en/messages.json

@@ -287,6 +287,10 @@
     "messageformat": "Set Up as Standalone Device",
     "description": "Only available on development modes, menu option to open up the standalone device setup sequence"
   },
+  "icu:menuStageLocalBackupForImport": {
+    "messageformat": "Stage Local Backup for Import…",
+    "description": "Only available on development modes before linking. Menu option to open file browser to pick a local backup folder for import during link."
+  },
   "icu:messageContextMenuButton": {
     "messageformat": "More actions",
     "description": "Label for context button next to each message"
@@ -6660,14 +6664,6 @@
     "messageformat": "Export local encrypted backup to a folder and validate it",
     "description": "Description of the internal local backup export tool"
   },
-  "icu:Preferences__internal__import-local-backup": {
-    "messageformat": "Import…",
-    "description": "Button to run internal local backup import tool"
-  },
-  "icu:Preferences__internal__import-local-backup--description": {
-    "messageformat": "Stage a local encrypted backup for import on link",
-    "description": "Description of the internal local backup export tool"
-  },
   "icu:Preferences__internal__validate-backup--description": {
     "messageformat": "Export encrypted backup to memory and run validation suite on it",
     "description": "Description of the internal backup validation tool"

app/main.ts

@@ -100,7 +100,7 @@ import type { CreateTemplateOptionsType } from './menu';
 import { createTemplate } from './menu';
 import { installFileHandler, installWebHandler } from './protocol_filter';
 import OS from '../ts/util/os/osMain';
-import { isProduction } from '../ts/util/version';
+import { isNightly, isProduction } from '../ts/util/version';
 import { clearTimeoutIfNecessary } from '../ts/util/clearTimeoutIfNecessary';
 import { toggleMaximizedBrowserWindow } from '../ts/util/toggleMaximizedBrowserWindow';
 import { ChallengeMainHandler } from '../ts/main/challengeMain';
@@ -1259,6 +1259,12 @@ function setupAsStandalone() {
   }
 }
 
+function stageLocalBackupForImport() {
+  if (mainWindow) {
+    mainWindow.webContents.send('stage-local-backup-for-import');
+  }
+}
+
 let screenShareWindow: BrowserWindow | undefined;
 async function showScreenShareWindow(sourceName: string | undefined) {
   if (screenShareWindow) {
@@ -2309,12 +2315,14 @@ app.on('ready', async () => {
 
 function setupMenu(options?: Partial<CreateTemplateOptionsType>) {
   const { platform } = process;
+  const version = app.getVersion();
   menuOptions = {
     // options
     development,
     devTools: defaultWebPrefs.devTools,
     includeSetup: false,
-    isProduction: isProduction(app.getVersion()),
+    isNightly: isNightly(version),
+    isProduction: isProduction(version),
     platform,
 
     // actions
@@ -2327,6 +2335,7 @@ function setupMenu(options?: Partial<CreateTemplateOptionsType>) {
     openSupportPage,
     setupAsNewDevice,
     setupAsStandalone,
+    stageLocalBackupForImport,
     showAbout,
     showDebugLog: showDebugLogWindow,
     showCallingDevTools: showCallingDevToolsWindow,
@@ -2359,6 +2368,7 @@ function setupMenu(options?: Partial<CreateTemplateOptionsType>) {
     development: menuOptions.development,
     devTools: menuOptions.devTools,
     includeSetup: menuOptions.includeSetup,
+    isNightly: menuOptions.isNightly,
     isProduction: menuOptions.isProduction,
     platform: menuOptions.platform,
   });
@@ -3198,6 +3208,7 @@ ipc.handle('getMenuOptions', async () => {
     development: menuOptions?.development ?? false,
     devTools: menuOptions?.devTools ?? false,
     includeSetup: menuOptions?.includeSetup ?? false,
+    isNightly: menuOptions?.isNightly ?? false,
     isProduction: menuOptions?.isProduction ?? true,
     platform: menuOptions?.platform ?? 'unknown',
   };

app/menu.ts

@@ -32,6 +32,7 @@ export const createTemplate = (
     platform,
     setupAsNewDevice,
     setupAsStandalone,
+    stageLocalBackupForImport,
     forceUpdate,
     showAbout,
     showDebugLog,
@@ -225,6 +226,13 @@ export const createTemplate = (
 
     if (Array.isArray(fileMenu.submenu)) {
       // These are in reverse order, since we're prepending them one at a time
+      if (options.isNightly) {
+        fileMenu.submenu.unshift({
+          label: i18n('icu:menuStageLocalBackupForImport'),
+          click: stageLocalBackupForImport,
+        });
+      }
+
       if (options.development) {
         fileMenu.submenu.unshift({
           label: i18n('icu:menuSetupAsStandalone'),

ts/background.ts

@@ -1357,6 +1357,10 @@ export async function startApp(): Promise<void> {
     window.reduxActions.app.openStandalone();
   });
 
+  window.Whisper.events.on('stageLocalBackupForImport', () => {
+    drop(backupsService._internalStageLocalBackupForImport());
+  });
+
   window.Whisper.events.on('openSettingsTab', () => {
     window.reduxActions.nav.changeNavTab(NavTab.Settings);
   });

ts/components/Preferences.stories.tsx

@@ -200,13 +200,6 @@ export default {
         result: exportLocalBackupResult,
       };
     },
-    importLocalBackup: async () => {
-      return {
-        success: true,
-        error: undefined,
-        snapshotDir: exportLocalBackupResult.snapshotDir,
-      };
-    },
     makeSyncRequest: action('makeSyncRequest'),
     onAudioNotificationsChange: action('onAudioNotificationsChange'),
     onAutoConvertEmojiChange: action('onAutoConvertEmojiChange'),

ts/components/Preferences.tsx

@@ -73,7 +73,6 @@ import {
 import { PreferencesBackups } from './PreferencesBackups';
 import { PreferencesInternal } from './PreferencesInternal';
 import { FunEmojiLocalizationProvider } from './fun/FunEmojiLocalizationProvider';
-import type { ValidateLocalBackupStructureResultType } from '../services/backups/util/localBackup';
 import { NavTabsToggle } from './NavTabs';
 import type { UnreadStats } from '../util/countUnreadStats';
 
@@ -173,7 +172,6 @@ type PropsFunctionType = {
   editCustomColor: (colorId: string, color: CustomColorType) => unknown;
   exportLocalBackup: () => Promise<BackupValidationResultType>;
   getConversationsWithCustomColor: (colorId: string) => Array<ConversationType>;
-  importLocalBackup: () => Promise<ValidateLocalBackupStructureResultType>;
   makeSyncRequest: () => unknown;
   onStartUpdate: () => unknown;
   refreshCloudBackupStatus: () => void;
@@ -330,7 +328,6 @@ export function Preferences({
   hasTextFormatting,
   hasTypingIndicators,
   i18n,
-  importLocalBackup,
   initialPage = Page.General,
   initialSpellCheckSetting,
   isAutoDownloadUpdatesSupported,
@@ -1836,7 +1833,6 @@ export function Preferences({
       <PreferencesInternal
         i18n={i18n}
         exportLocalBackup={exportLocalBackup}
-        importLocalBackup={importLocalBackup}
         validateBackup={validateBackup}
       />
     );

ts/components/PreferencesInternal.tsx

@@ -7,7 +7,6 @@ import { toLogFormat } from '../types/errors';
 import { formatFileSize } from '../util/formatFileSize';
 import { SECOND } from '../util/durations';
 import type { ValidationResultType as BackupValidationResultType } from '../services/backups';
-import type { ValidateLocalBackupStructureResultType } from '../services/backups/util/localBackup';
 import { SettingsRow, SettingsControl } from './PreferencesUtil';
 import { Button, ButtonVariant } from './Button';
 import { Spinner } from './Spinner';
@@ -15,21 +14,16 @@ import { Spinner } from './Spinner';
 export function PreferencesInternal({
   i18n,
   exportLocalBackup: doExportLocalBackup,
-  importLocalBackup: doImportLocalBackup,
   validateBackup: doValidateBackup,
 }: {
   i18n: LocalizerType;
   exportLocalBackup: () => Promise<BackupValidationResultType>;
-  importLocalBackup: () => Promise<ValidateLocalBackupStructureResultType>;
   validateBackup: () => Promise<BackupValidationResultType>;
 }): JSX.Element {
   const [isExportPending, setIsExportPending] = useState(false);
   const [exportResult, setExportResult] = useState<
     BackupValidationResultType | undefined
   >();
-  const [importResult, setImportResult] = useState<
-    ValidateLocalBackupStructureResultType | undefined
-  >();
 
   const [isValidationPending, setIsValidationPending] = useState(false);
   const [validationResult, setValidationResult] = useState<
@@ -110,49 +104,6 @@ export function PreferencesInternal({
     }
   }, [doExportLocalBackup]);
 
-  const importLocalBackup = useCallback(async () => {
-    setImportResult(undefined);
-    try {
-      setImportResult(await doImportLocalBackup());
-    } catch (error) {
-      setImportResult({
-        success: false,
-        error: toLogFormat(error),
-        snapshotDir: undefined,
-      });
-    }
-  }, [doImportLocalBackup]);
-
-  const renderImportResult = useCallback(
-    (
-      didImportResult: ValidateLocalBackupStructureResultType | undefined
-    ): JSX.Element | undefined => {
-      if (didImportResult == null) {
-        return;
-      }
-
-      const { success, error, snapshotDir } = didImportResult;
-      if (success) {
-        return (
-          <div className="Preferences--internal--validate-backup--result">
-            <pre>
-              <code>{`Staged: ${snapshotDir}\n\nPlease link to finish import.`}</code>
-            </pre>
-          </div>
-        );
-      }
-
-      return (
-        <div className="Preferences--internal--validate-backup--error">
-          <pre>
-            <code>{`Failed: ${error}`}</code>
-          </pre>
-        </div>
-      );
-    },
-    []
-  );
-
   return (
     <>
       <div className="Preferences__title Preferences__title--internal">
@@ -209,22 +160,6 @@ export function PreferencesInternal({
         />
 
         {renderValidationResult(exportResult)}
-
-        <SettingsControl
-          left={i18n(
-            'icu:Preferences__internal__import-local-backup--description'
-          )}
-          right={
-            <Button
-              variant={ButtonVariant.Secondary}
-              onClick={importLocalBackup}
-            >
-              {i18n('icu:Preferences__internal__import-local-backup')}
-            </Button>
-          }
-        />
-
-        {renderImportResult(importResult)}
       </SettingsRow>
     </>
   );

ts/state/ducks/user.ts

@@ -148,6 +148,7 @@ export function getEmptyState(): UserStateType {
       development: false,
       devTools: false,
       includeSetup: false,
+      isNightly: false,
       isProduction: true,
       platform: 'unknown',
     },

ts/state/smart/Preferences.tsx

@@ -151,8 +151,6 @@ export function SmartPreferences(): JSX.Element {
 
   const validateBackup = () => backupsService._internalValidate();
   const exportLocalBackup = () => backupsService._internalExportLocalBackup();
-  const importLocalBackup = () =>
-    backupsService._internalStageLocalBackupForImport();
   const doDeleteAllData = () => renderClearingDataView();
   const refreshCloudBackupStatus =
     window.Signal.Services.backups.throttledFetchCloudBackupStatus;
@@ -633,7 +631,6 @@ export function SmartPreferences(): JSX.Element {
         hasTextFormatting={hasTextFormatting}
         hasTypingIndicators={hasTypingIndicators}
         i18n={i18n}
-        importLocalBackup={importLocalBackup}
         initialSpellCheckSetting={initialSpellCheckSetting}
         isAutoDownloadUpdatesSupported={isAutoDownloadUpdatesSupported}
         isAutoLaunchSupported={isAutoLaunchSupported}

ts/test-node/app/menu_test.ts

@@ -26,6 +26,7 @@ const showCallingDevTools = stub();
 const showKeyboardShortcuts = stub();
 const showSettings = stub();
 const showWindow = stub();
+const stageLocalBackupForImport = stub();
 const zoomIn = stub();
 const zoomOut = stub();
 const zoomReset = stub();
@@ -233,6 +234,7 @@ describe('createTemplate', () => {
     showKeyboardShortcuts,
     showSettings,
     showWindow,
+    stageLocalBackupForImport,
     zoomIn,
     zoomOut,
     zoomReset,
@@ -245,6 +247,7 @@ describe('createTemplate', () => {
           development: false,
           devTools: true,
           includeSetup: false,
+          isNightly: false,
           isProduction: true,
           platform,
           ...actions,
@@ -259,6 +262,7 @@ describe('createTemplate', () => {
           development: false,
           devTools: true,
           includeSetup: true,
+          isNightly: false,
           isProduction: true,
           platform,
           ...actions,

ts/types/menu.ts

@@ -9,6 +9,7 @@ export type MenuOptionsType = Readonly<{
   development: boolean;
   devTools: boolean;
   includeSetup: boolean;
+  isNightly: boolean;
   isProduction: boolean;
   platform: string;
 }>;
@@ -29,6 +30,7 @@ export type MenuActionsType = Readonly<{
   showKeyboardShortcuts: () => unknown;
   showSettings: () => unknown;
   showWindow: () => unknown;
+  stageLocalBackupForImport: () => unknown;
   zoomIn: () => unknown;
   zoomOut: () => unknown;
   zoomReset: () => unknown;

ts/windows/main/phase1-ipc.ts

@@ -279,6 +279,10 @@ ipc.on('set-up-as-standalone', () => {
   window.Whisper.events.trigger('setupAsStandalone');
 });
 
+ipc.on('stage-local-backup-for-import', () => {
+  window.Whisper.events.trigger('stageLocalBackupForImport');
+});
+
 ipc.on('challenge:response', (_event, response) => {
   window.Whisper.events.trigger('challengeResponse', response);
 });

ts/windows/main/preload_test.ts

@@ -115,6 +115,7 @@ window.testUtilities = {
         development: false,
         devTools: false,
         includeSetup: false,
+        isNightly: false,
         isProduction: false,
         platform: 'test',
       },