Skip to content

Feat: Stop Looking for updates #178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Feat: Stop Looking for updates #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
98ee7d7
feat: start/stop updater
ArthurLobopro Feb 14, 2025
ac9ee2e
Update test.yml
ArthurLobopro Feb 14, 2025
e24e128
fix: update tests to be async
ArthurLobopro Feb 14, 2025
f464595
refactor: turn updateElectronApp sync again
ArthurLobopro Feb 26, 2025
08a389c
Revert "fix: update tests to be async"
ArthurLobopro Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ on:
schedule:
- cron: '0 22 * * 3'
workflow_call:
workflow_dispatch:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so anyone that forks the repo can run the tests locally in the fork

Could you just have this in your fork and avoid upstreaming it? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I needed upstream this to run the tests easier locally here. This grants me the power to run anytime the tests, I only use Linux and my hardware can't run VMs. So the only way I can test it in other platforms is using Github Actions. If you want I can remove it, but only when the other needed changes were done


permissions:
contents: read
Expand Down
58 changes: 47 additions & 11 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,13 @@ export interface IUpdateElectronAppOptions<L = ILogger> {
readonly onNotifyUser?: (info: IUpdateInfo) => void;
}

export interface IUpdater {
readonly isSupported: boolean;
readonly isLookingForUpdates: boolean;
readonly stopLookingForUpdates: () => void;
readonly startLookingForUpdates: () => void;
}

// eslint-disable-next-line @typescript-eslint/no-require-imports
const pkg = require('../package.json');
const userAgent = format('%s/%s (%s: %s)', pkg.name, pkg.version, os.platform(), os.arch());
Expand All @@ -128,7 +135,7 @@ const isHttpsUrl = (maybeURL: string) => {
}
};

export function updateElectronApp(opts: IUpdateElectronAppOptions = {}) {
export function updateElectronApp(opts: IUpdateElectronAppOptions = {}): IUpdater {
// check for bad input early, so it will be logged during development
const safeOpts = validateInput(opts);

Expand All @@ -141,25 +148,36 @@ export function updateElectronApp(opts: IUpdateElectronAppOptions = {}) {
} else {
console.log(message);
}
return;

//Return Updater but does not start
return makeUpdater(safeOpts);
}

const updater = makeUpdater(safeOpts);

if (app.isReady()) {
initUpdater(safeOpts);
updater.startLookingForUpdates();
} else {
app.on('ready', () => initUpdater(safeOpts));
app.on('ready', () => updater.startLookingForUpdates());
}

return updater;
}

function initUpdater(opts: ReturnType<typeof validateInput>) {
function makeUpdater(opts: ReturnType<typeof validateInput>): IUpdater {
const { updateSource, updateInterval, logger } = opts;

// exit early on unsupported platforms, e.g. `linux`
if (!supportedPlatforms.includes(process?.platform)) {
log(
`Electron's autoUpdater does not support the '${process.platform}' platform. Ref: https://www.electronjs.org/docs/latest/api/auto-updater#platform-notices`,
);
return;
return {
isSupported: false,
isLookingForUpdates: false,
stopLookingForUpdates: () => {},
startLookingForUpdates: () => {},
};
}

let feedURL: string;
Expand Down Expand Up @@ -241,11 +259,29 @@ function initUpdater(opts: ReturnType<typeof validateInput>) {
);
}

// check for updates right away and keep checking later
autoUpdater.checkForUpdates();
setInterval(() => {
autoUpdater.checkForUpdates();
}, ms(updateInterval));
let intervalID: ReturnType<typeof setInterval>;
let isLookingForUpdates = false;

return {
isSupported: true,
get isLookingForUpdates() {
return isLookingForUpdates;
},
stopLookingForUpdates() {
if (isLookingForUpdates) {
clearInterval(intervalID);
isLookingForUpdates = false;
}
},
startLookingForUpdates() {
if (!isLookingForUpdates) {
intervalID = setInterval(() => {
autoUpdater.checkForUpdates();
}, ms(updateInterval));
isLookingForUpdates = true;
}
},
};
}

/**
Expand Down