feat: add auto start on startup option to user settings

Author: Aerilym

_locales/en/messages.json

@@ -969,6 +969,11 @@
   "supportDescription": "Having issues? Explore help articles or open a ticket with Session Support.",
   "supportGoTo": "Go to Support Page",
   "systemInformationDesktop": "System Information: {information}",
+  "settingsCannotChangeDesktop": "Cannot Update Setting",
+  "settingsStartCategoryDesktop": "Startup",
+  "launchOnStartDesktop": "Launch on Startup",
+  "launchOnStartDescriptionDesktop": "Launch Session automatically when your computer starts up.",
+  "launchOnStartupDisabledDesktop": "This setting is managed by your system on Linux. To have Session start automatically, please add it to your startup applications in your system settings.",
   "tapToRetry": "Tap to retry",
   "theContinue": "Continue",
   "theDefault": "Default",

preload.js

@@ -146,6 +146,28 @@ window.getStartInTray = async () => {
   });
 };
 
+window.setAutoStartEnabled = async autoStart =>
+  new Promise((resolve, reject) => {
+    ipc.once('set-auto-start-enabled-response', (_event, error) => {
+      if (error) {
+        reject(error);
+        return;
+      }
+      resolve();
+      return;
+    });
+    ipc.send('set-auto-start-enabled', autoStart);
+  });
+
+window.getAutoStartEnabled = async () => {
+  return new Promise(resolve => {
+    ipc.once('get-auto-start-enabled-response', (_event, value) => {
+      resolve(value);
+    });
+    ipc.send('get-auto-start-enabled');
+  });
+};
+
 window.getOpengroupPruning = async () => {
   return new Promise(resolve => {
     ipc.once('get-opengroup-pruning-response', (_event, value) => {

ts/components/dialog/LocalizedPopupDialog.tsx

@@ -50,15 +50,17 @@ export function LocalizedPopupDialog(props: LocalizedPopupDialogState) {
       </StyledScrollDescriptionContainer>
       <SpacerSM />
 
-      <ModalFlexContainer>
-        <SessionButton
-          buttonType={SessionButtonType.Simple}
-          onClick={onClose}
-          dataTestId="session-confirm-ok-button"
-        >
-          {tr('okay')}
-        </SessionButton>
-      </ModalFlexContainer>
+      {!props.hideOkayButton ? (
+        <ModalFlexContainer>
+          <SessionButton
+            buttonType={SessionButtonType.Simple}
+            onClick={onClose}
+            dataTestId="session-confirm-ok-button"
+          >
+            {tr('okay')}
+          </SessionButton>
+        </ModalFlexContainer>
+      ) : null}
       <SpacerXS />
     </SessionWrapperModal>
   );

ts/components/dialog/user-settings/components/SettingsToggleBasic.tsx

@@ -1,21 +1,49 @@
-import type { SettingsToggles } from 'react';
+import { useCallback, type SettingsToggles } from 'react';
+import { useDispatch } from 'react-redux';
 import { PanelButtonTextWithSubText } from '../../../buttons/panel/PanelButton';
 import { PanelToggleButton } from '../../../buttons/panel/PanelToggleButton';
 import { type TrArgs } from '../../../../localization/localeTools';
+import { showLocalizedPopupDialog } from '../../LocalizedPopupDialog';
 
-export function SettingsToggleBasic({
-  active,
-  baseDataTestId,
-  onClick,
-  text,
-  subText,
-}: {
+type UnavailableProps = {
+  unavailable: boolean;
+  modalReasonTitle: TrArgs;
+  modalReasonDescription: TrArgs;
+};
+
+type SettingsToggleBasicProps = {
   text: TrArgs;
   subText: TrArgs;
   baseDataTestId: SettingsToggles;
   active: boolean;
+  unavailableProps?: UnavailableProps;
   onClick: () => Promise<void>;
-}) {
+};
+
+export function SettingsToggleBasic({
+  text,
+  subText,
+  baseDataTestId,
+  active,
+  onClick,
+  unavailableProps,
+}: SettingsToggleBasicProps) {
+  const dispatch = useDispatch();
+
+  const handleClick = useCallback(async () => {
+    if (!unavailableProps?.unavailable) {
+      return onClick();
+    }
+    return showLocalizedPopupDialog(
+      {
+        title: unavailableProps?.modalReasonTitle,
+        description: unavailableProps?.modalReasonDescription,
+        hideOkayButton: true,
+      },
+      dispatch
+    );
+  }, [unavailableProps, dispatch, onClick]);
+
   return (
     <PanelToggleButton
       textElement={
@@ -27,7 +55,7 @@ export function SettingsToggleBasic({
         />
       }
       active={active}
-      onClick={onClick}
+      onClick={handleClick}
       toggleDataTestId={`${baseDataTestId}-settings-toggle`}
       rowDataTestId={`${baseDataTestId}-settings-row`}
     />

ts/components/dialog/user-settings/pages/PreferencesSettingsPage.tsx

@@ -22,6 +22,7 @@ import { SettingsKey } from '../../../../data/settings-key';
 import { ToastUtils } from '../../../../session/utils';
 import { PanelRadioButton } from '../../../buttons/panel/PanelRadioButton';
 import { useHasEnterSendEnabled } from '../../../../state/selectors/settings';
+import { isLinux } from '../../../../OS';
 
 async function toggleStartInTray() {
   try {
@@ -38,6 +39,19 @@ async function toggleStartInTray() {
   }
 }
 
+async function toggleAutoStart() {
+  try {
+    const currentSettings = await window.getAutoStartEnabled();
+    const newValue = !currentSettings;
+
+    // make sure to write it here too, as this is the value used on the UI to mark the toggle as true/false
+    await window.setSettingValue(SettingsKey.settingsAutoStart, newValue);
+    await window.setAutoStartEnabled(newValue);
+  } catch (e) {
+    window.log.warn('auto start change error:', e);
+  }
+}
+
 function SendWithShiftEnter() {
   const initialSetting = useHasEnterSendEnabled();
   const selectedWithSettingTrue = 'enterForNewLine';
@@ -100,6 +114,11 @@ export function PreferencesSettingsPage(modalState: UserSettingsModalState) {
   const closeAction = useUserSettingsCloseAction(modalState);
   const title = useUserSettingsTitle(modalState);
   const isStartInTrayActive = Boolean(window.getSettingValue(SettingsKey.settingsStartInTray));
+
+  const platformIsLinux = isLinux();
+  const isAutoStartActive = platformIsLinux
+    ? false
+    : Boolean(window.getSettingValue(SettingsKey.settingsAutoStart));
   const forceUpdate = useUpdate();
 
   return (
@@ -144,6 +163,24 @@ export function PreferencesSettingsPage(modalState: UserSettingsModalState) {
           active={isStartInTrayActive}
         />
       </PanelButtonGroup>
+      <PanelLabelWithDescription title={{ token: 'settingsStartCategoryDesktop' }} />
+      <PanelButtonGroup>
+        <SettingsToggleBasic
+          baseDataTestId="auto-start"
+          text={{ token: 'launchOnStartDesktop' }}
+          subText={{ token: 'launchOnStartDescriptionDesktop' }}
+          onClick={async () => {
+            await toggleAutoStart();
+            forceUpdate();
+          }}
+          active={isAutoStartActive}
+          unavailableProps={{
+            unavailable: platformIsLinux,
+            modalReasonTitle: { token: 'settingsCannotChangeDesktop' },
+            modalReasonDescription: { token: 'launchOnStartupDisabledDesktop' },
+          }}
+        />
+      </PanelButtonGroup>
       <SendWithShiftEnter />
     </SessionWrapperModal>
   );

ts/data/settings-key.ts

@@ -7,6 +7,7 @@ const settingsSpellCheck = 'spell-check';
 const settingsLinkPreview = 'link-preview-setting';
 const hasBlindedMsgRequestsEnabled = 'hasBlindedMsgRequestsEnabled';
 const settingsStartInTray = 'start-in-tray-setting';
+const settingsAutoStart = 'auto-start-setting';
 const settingsOpengroupPruning = 'prune-setting';
 const settingsNotification = 'notification-setting';
 const settingsAudioNotification = 'audio-notification-setting';
@@ -31,6 +32,7 @@ export const SettingsKey = {
   settingsSpellCheck,
   settingsLinkPreview,
   settingsStartInTray,
+  settingsAutoStart,
   settingsOpengroupPruning,
   hasBlindedMsgRequestsEnabled,
   settingsNotification,

ts/mains/main_node.ts

@@ -1023,6 +1023,60 @@ ipc.on('get-start-in-tray', event => {
   }
 });
 
+ipc.on('set-auto-start-enabled', (event, newValue) => {
+  try {
+    userConfig.set('autoStart', newValue);
+
+    // Set the login item settings based on the platform
+    if (process.platform === 'darwin') {
+      // macOS
+      app.setLoginItemSettings({
+        openAtLogin: newValue,
+        openAsHidden: false,
+      });
+    } else if (process.platform === 'win32') {
+      // Windows - For Squirrel-based apps, we need to handle the stub launcher - https://www.electronjs.org/docs/latest/api/app/#appsetloginitemsettingssettings-macos-windows
+      const appFolder = path.dirname(process.execPath);
+      const ourExeName = path.basename(process.execPath);
+      const stubLauncher = path.resolve(appFolder, '..', ourExeName);
+
+      app.setLoginItemSettings({
+        openAtLogin: newValue,
+        path: stubLauncher,
+        args: [],
+      });
+    } else {
+      // Linux and other platforms - basic support
+      app.setLoginItemSettings({
+        openAtLogin: newValue,
+      });
+    }
+
+    event.sender.send('set-auto-start-enabled-response', null);
+  } catch (e) {
+    event.sender.send('set-auto-start-enabled-response', e);
+  }
+});
+
+ipc.on('get-auto-start-enabled', event => {
+  try {
+    const configVal = userConfig.get('autoStart');
+
+    if (configVal !== undefined) {
+      event.sender.send('get-auto-start-enabled-response', configVal);
+      return;
+    }
+
+    const loginSettings = app.getLoginItemSettings();
+    const isEnabled = loginSettings.openAtLogin;
+
+    userConfig.set('autoStart', isEnabled);
+    event.sender.send('get-auto-start-enabled-response', isEnabled);
+  } catch (e) {
+    event.sender.send('get-auto-start-enabled-response', false);
+  }
+});
+
 ipcMain.on('update-badge-count', (_event, count) => {
   if (app.isReady()) {
     app.setBadgeCount(isNumber(count) && isFinite(count) && count >= 0 ? count : 0);

ts/react.d.ts

@@ -95,6 +95,7 @@ declare module 'react' {
     | 'conversation-trimming'
     | 'auto-update'
     | 'auto-dark-mode'
+    | 'auto-start'
     | 'hide-menu-bar';
 
   type SettingsRadio =

ts/state/ducks/modalDialog.tsx

@@ -55,6 +55,7 @@ export type OpenUrlModalState = { urlToOpen: string } | null;
 export type LocalizedPopupDialogState = {
   title: TrArgs;
   description: TrArgs;
+  hideOkayButton?: boolean;
 } | null;
 export type SessionProInfoState = { variant: SessionProInfoVariant } | null;
 

ts/window.d.ts

@@ -74,6 +74,8 @@ declare global {
     }) => Promise<void>;
     setStartInTray: (val: boolean) => Promise<void>;
     getStartInTray: () => Promise<boolean>;
+    setAutoStartEnabled: (val: boolean) => Promise<void>;
+    getAutoStartEnabled: () => Promise<boolean>;
     getOpengroupPruning: () => Promise<boolean>;
     setOpengroupPruning: (val: boolean) => Promise<void>;
     closeAbout: () => void;