session-desktop/ts/updater/updater.ts

/* eslint-disable @typescript-eslint/no-misused-promises */
/* eslint-disable no-console */
import { app, type BrowserWindow } from 'electron';
import { autoUpdater, DOWNLOAD_PROGRESS, type UpdateInfo } from 'electron-updater';
import * as fs from 'fs-extra';
import * as path from 'path';
import { gt as isVersionGreaterThan, parse as parseVersion } from 'semver';

import { filesize } from 'filesize';
import { windowMarkShouldQuit } from '../node/window_state';

import { DURATION, UPDATER_INTERVAL_MS } from '../session/constants';
import { showCannotUpdateDialog, showDownloadUpdateDialog, showUpdateDialog } from './common';
import { getLatestRelease } from '../node/latest_desktop_release';
import { Errors } from '../types/Errors';
import type { LoggerType } from '../util/logger/Logging';

let isUpdating = false;
let downloadIgnored = false;
let interval: NodeJS.Timeout | undefined;
let stopped = false;

autoUpdater.on(DOWNLOAD_PROGRESS, eventDownloadProgress => {
  console.log(
    `[updater] downloading ${filesize(eventDownloadProgress.transferred, { base: 10 })}/${filesize(eventDownloadProgress.total, { base: 10 })}`
  );
});

export async function start(getMainWindow: () => BrowserWindow | null, logger: LoggerType) {
  if (interval) {
    logger.info('[updater] auto-update: Already running');

    return;
  }

  logger.info('[updater] auto-update: starting checks...');

  autoUpdater.logger = logger;
  autoUpdater.autoDownload = false;

  interval = global.setInterval(async () => {
    try {
      await checkForUpdates(getMainWindow, logger);
    } catch (error) {
      logger.error('[updater] auto-update: error:', Errors.toString(error));
    }
  }, UPDATER_INTERVAL_MS); // trigger and try to update every 10 minutes to let the file gets downloaded if we are updating
  stopped = false;

  global.setTimeout(async () => {
    try {
      await checkForUpdates(getMainWindow, logger);
    } catch (error) {
      logger.error('[updater] auto-update: error:', Errors.toString(error));
    }
  }, 2 * DURATION.MINUTES); // we do checks from the file server every 2 minutes.
}

export function stop() {
  if (interval) {
    clearInterval(interval);
    interval = undefined;
  }
  stopped = true;
}

/**
 * We return false in some steps to show the process was interrupted
 * @note exported for testing purposes only
 * */
export async function checkForUpdates(
  getMainWindow: () => BrowserWindow | null,
  logger: LoggerType,
  force?: boolean
) {
  if (stopped || isUpdating || (downloadIgnored && !force)) {
    logger.info(
      `[updater] checkForUpdates is returning early stopped ${stopped} isUpdating ${isUpdating} downloadIgnored ${downloadIgnored}`
    );
    return false;
  }

  const canUpdate = await canAutoUpdate();
  logger.info('[updater] checkForUpdates canAutoUpdate', canUpdate);
  if (!canUpdate) {
    return false;
  }

  logger.info('[updater] checkForUpdates isUpdating', isUpdating);

  isUpdating = true;

  try {
    const [updateVersionFromFsFromRenderer, releaseChannelFromFsFromRenderer] = getLatestRelease();

    if (!updateVersionFromFsFromRenderer || !updateVersionFromFsFromRenderer?.length) {
      logger.info(
        '[updater] checkForUpdates getLatestRelease() has not been called by the renderer process yet. Skipping update check'
      );
      return false;
    }

    logger.info(
      `[updater] checkForUpdates updateVersionFromFsFromRenderer ${updateVersionFromFsFromRenderer} releaseChannelFromFsFromRenderer ${releaseChannelFromFsFromRenderer} allowPrerelease ${autoUpdater.allowPrerelease} allowDownload ${autoUpdater.allowDowngrade}`
    );

    const currentVersion = autoUpdater.currentVersion.toString();
    const isMoreRecent = isVersionGreaterThan(updateVersionFromFsFromRenderer, currentVersion);
    logger.info('[updater] checkForUpdates isMoreRecent', isMoreRecent);
    if (!isMoreRecent) {
      logger.info(
        `[updater] File server has no update so we are not looking for an update from github current:${currentVersion} fromFileServer:${updateVersionFromFsFromRenderer}`
      );
      return false;
    }

    // Get the update using electron-updater, this fetches from github
    const result = await autoUpdater.checkForUpdates();

    if (!result?.updateInfo) {
      logger.info('[updater] received no updateInfo in response from GitHub');
      return false;
    }

    logger.info(
      `[updater] checkForUpdates received response from GitHub at ${new Date().toISOString()} version: ${result?.updateInfo?.version}`
    );

    try {
      const hasUpdate = isUpdateAvailable(result.updateInfo);
      logger.info('[updater] hasUpdate:', hasUpdate);

      if (!hasUpdate) {
        logger.info('[updater] no update available');

        return false;
      }

      const mainWindow = getMainWindow();
      if (!mainWindow) {
        logger.error('[updater] cannot showDownloadUpdateDialog, mainWindow is unset');
        return false;
      }
      logger.info('[updater] showing download dialog...');

      const shouldDownload = await showDownloadUpdateDialog(mainWindow, result.updateInfo.version);
      logger.info('[updater] shouldDownload:', shouldDownload);

      if (!shouldDownload) {
        downloadIgnored = true;
        logger.info('[updater] download cancelled by user');
        return true;
      }

      await autoUpdater.downloadUpdate();
    } catch (error) {
      const mainWindow = getMainWindow();
      if (!mainWindow) {
        logger.error('[updater] cannot showDownloadUpdateDialog, mainWindow is unset');
        return false;
      }
      await showCannotUpdateDialog(mainWindow);
      throw error;
    }

    const window = getMainWindow();
    if (!window) {
      logger.error('[updater] cannot showDownloadUpdateDialog, mainWindow is unset');
      return false;
    }
    // Update downloaded successfully, we should ask the user to update
    logger.info('[updater] showing update dialog...');
    const shouldUpdate = await showUpdateDialog(window);
    if (!shouldUpdate) {
      return false;
    }

    logger.info('[updater] calling windowMarkShouldQuit then quitAndInstall...');
    windowMarkShouldQuit();
    autoUpdater.quitAndInstall();
    return true;
  } finally {
    isUpdating = false;
  }
}

function isUpdateAvailable(updateInfo: UpdateInfo): boolean {
  const updateVersion = parseVersion(updateInfo.version);
  if (!updateVersion) {
    console.error(
      '[updater] isUpdateAvailable could not parse update version:',
      updateInfo.version
    );
    return false;
  }

  // We need to convert this to string because typescript won't let us use types across submodules ....
  const currentVersion = autoUpdater.currentVersion.toString();

  const updateIsNewer = isVersionGreaterThan(updateVersion, currentVersion);
  console.log(
    `[updater] isUpdateAvailable updateIsNewer: ${updateIsNewer} updateVersion: ${updateVersion} currentVersion: ${currentVersion}`
  );
  return updateIsNewer;
}

/**
 * Check if we have the required files to auto update.
 * These files won't exist inside certain formats such as a linux deb file or when unpackaged e.g. running the dev app
 * @note exported for testing purposes only
 */
export async function canAutoUpdate(): Promise<boolean> {
  const isPackaged = app.isPackaged;

  // On a production app, we need to use resources path to check for the file
  if (isPackaged && !process.resourcesPath) {
    return false;
  }

  // Taken from: https://github.com/electron-userland/electron-builder/blob/d4feb6d3c8b008f8b455c761d654c8088f90d8fa/packages/electron-updater/src/ElectronAppAdapter.ts#L25
  const updateFile = isPackaged ? 'app-update.yml' : 'dev-app-update.yml';
  const basePath = isPackaged && process.resourcesPath ? process.resourcesPath : app.getAppPath();
  const appUpdateConfigPath = path.join(basePath, updateFile);

  return new Promise(resolve => {
    try {
      const exists = fs.existsSync(appUpdateConfigPath);
      resolve(exists);
    } catch (e) {
      resolve(false);
    }
  });
}