Skip to content
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

Prompt to update once per week per new version, or when app restarted #77

Merged
merged 1 commit into from
Nov 19, 2024
Merged

Prompt to update once per week per new version, or when app restarted #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 1 addition & 36 deletions electron/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import {
shell,
Tray,
} from "electron";
import { autoUpdater } from "electron-updater";

import type { DomainPreferenceType, FilterType } from "./utils/constants";
import { AppsManager } from "./helpers/apps-manager";
Expand Down Expand Up @@ -43,40 +42,6 @@ process.env.ELECTRON_DIR = app.isPackaged

const isMacOS = process.platform === "darwin";

autoUpdater.setFeedURL({
provider: "github",
owner: "wakatime",
repo: "desktop-wakatime",
});
autoUpdater.autoDownload = true;
autoUpdater.autoInstallOnAppQuit = true;
autoUpdater.autoRunAppAfterInstall = true;

autoUpdater.on("checking-for-update", () => {
Logging.instance().log("Checking for update");
});
autoUpdater.on("update-available", async (res) => {
Logging.instance().log(
`Update available. Version: ${res.version}, Files: ${res.files.map((file) => file.url).join(", ")}`,
);
await autoUpdater.downloadUpdate();
});
autoUpdater.on("update-downloaded", (res) => {
Logging.instance().log(
`Update Downloaded. Downloaded file: ${res.downloadedFile}, Version: ${res.version}, `,
);
autoUpdater.quitAndInstall();
});
autoUpdater.on("update-not-available", () => {
Logging.instance().log("Update not available");
});
autoUpdater.on("update-cancelled", () => {
Logging.instance().log("Update cancelled");
});
autoUpdater.on("error", (err) => {
Logging.instance().log(`electron-updater error. Error: ${err.message}`);
});

let settingsWindow: BrowserWindow | null = null;
let monitoredAppsWindow: BrowserWindow | null = null;
let tray: Tray | null = null;
Expand Down Expand Up @@ -387,7 +352,7 @@ ipcMain.on(IpcKeys.autoUpdateEnabled, (event) => {
ipcMain.on(IpcKeys.setAutoUpdateEnabled, (_, value) => {
PropertiesManager.autoUpdateEnabled = value;
if (value) {
autoUpdater.checkForUpdatesAndNotify();
wakatime?.checkForUpdates();
}
});

Expand Down
79 changes: 70 additions & 9 deletions electron/watchers/wakatime.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
import type { Category, EntityType } from "../utils/types";
import { LogLevel, Logging } from "../utils/logging";
import { Notification, Tray, app, shell } from "electron";
import { exec, getCLIPath, getDeepLinkUrl, getPlatfrom } from "../utils";
import { WindowInfo } from "@miniben90/x-win";
import { app, Notification, shell, Tray } from "electron";
import isDev from "electron-is-dev";
import { autoUpdater } from "electron-updater";

import type { Category, EntityType } from "../utils/types";
import type { AppData } from "../utils/validators";
import { AppsManager } from "../helpers/apps-manager";
import { ConfigFile } from "../helpers/config-file";
import { DeepLink } from "../utils/constants";
import { Dependencies } from "../helpers/dependencies";
import { MonitoringManager } from "../helpers/monitoring-manager";
import { PropertiesManager } from "../helpers/properties-manager";
import { SettingsManager } from "../helpers/settings-manager";
import { WindowInfo } from "@miniben90/x-win";
import { autoUpdater } from "electron-updater";
import isDev from "electron-is-dev";
import { exec, getCLIPath, getDeepLinkUrl, getPlatfrom } from "../utils";
import { DeepLink } from "../utils/constants";
import { Logging, LogLevel } from "../utils/logging";

export class Wakatime {
private lastEntitiy = "";
Expand All @@ -24,6 +24,8 @@ export class Wakatime {
private tray?: Tray | null;
private versionString: string;
private lastCheckedForUpdates: number = 0;
private lastPromptedToUpdateAt: number = 0;
private lastPromptedToUpdateVersion: string = "";

constructor() {
const version = `${getPlatfrom()}-wakatime/${app.getVersion()}`;
Expand All @@ -47,6 +49,7 @@ export class Wakatime {
SettingsManager.registerAsLogInItem();
}

this.setupAutoUpdater();
this.checkForUpdates();

Dependencies.installDependencies();
Expand Down Expand Up @@ -246,11 +249,69 @@ export class Wakatime {
}
}

public setupAutoUpdater() {
autoUpdater.setFeedURL({
provider: "github",
owner: "wakatime",
repo: "desktop-wakatime",
});
autoUpdater.autoDownload = true;
autoUpdater.autoInstallOnAppQuit = true;
autoUpdater.autoRunAppAfterInstall = true;

autoUpdater.on("checking-for-update", () => {
Logging.instance().log("Checking for update");
});
autoUpdater.on("update-available", async (res) => {
Logging.instance().log(
`Update available. Version: ${res.version}, Files: ${res.files.map((file) => file.url).join(", ")}`,
);
if (!this.canPromptToUpdate(res.version)) {
Logging.instance().log(
"Already prompted to update this version recently, will download again in a week.",
);
return;
}
await autoUpdater.downloadUpdate();
});
autoUpdater.on("update-downloaded", (res) => {
Logging.instance().log(
`Update Downloaded. Downloaded file: ${res.downloadedFile}, Version: ${res.version}, `,
);
if (!this.canPromptToUpdate(res.version)) {
Logging.instance().log(
"Already prompted to update this version recently, will ask again in a week.",
);
return;
}

this.lastPromptedToUpdateVersion = res.version;
this.lastPromptedToUpdateAt = Date.now();
autoUpdater.quitAndInstall();
});
autoUpdater.on("update-not-available", () => {
Logging.instance().log("Update not available");
});
autoUpdater.on("update-cancelled", () => {
Logging.instance().log("Update cancelled");
});
autoUpdater.on("error", (err) => {
Logging.instance().log(`electron-updater error. Error: ${err.message}`);
});
}

// Only prompt for same version once per week, or if app is restarted
private canPromptToUpdate(newVersion: string) {
if (this.lastPromptedToUpdateAt + 604800 * 1000 < Date.now()) return true;
if (this.lastPromptedToUpdateVersion !== newVersion) return true;
return false;
}

public async checkForUpdates() {
if (!PropertiesManager.autoUpdateEnabled || isDev) return;
if (this.lastCheckedForUpdates + 600 * 1000 > Date.now()) return;

autoUpdater.checkForUpdatesAndNotify();
await autoUpdater.checkForUpdatesAndNotify();
}

pluginString(appData?: AppData, windowInfo?: WindowInfo) {
Expand Down
Loading