Merge pull request #7 from AperturePlus/develop

Develop

Author: AperturePlus

electron/main.ts

@@ -1,20 +1,44 @@
 import {
   app,
   BrowserWindow,
+  dialog,
   ipcMain,
   Menu,
   nativeTheme,
   shell,
 } from "electron";
+import * as https from "https";
 import path from "path";
 
 const APP_ID = "com.lite.sqlearner";
 const isDev = Boolean(process.env.VITE_DEV_SERVER_URL);
 const isWindows = process.platform === "win32";
 const isMac = process.platform === "darwin";
+const RELEASES_PAGE_URL = "https://github.com/AperturePlus/lite-sqlearner/releases";
+const RELEASES_API_URL =
+  "https://api.github.com/repos/AperturePlus/lite-sqlearner/releases/latest";
+const AUTO_UPDATE_CHECK_DELAY_MS = 5000;
 let mainWindow: BrowserWindow | null = null;
+let updateCheckInProgress = false;
+let latestPromptedVersion = "";
 
 type ThemeMode = "light" | "dark";
+type UpdateCheckStatus = "update-available" | "up-to-date" | "error" | "checking";
+
+interface UpdateCheckResult {
+  status: UpdateCheckStatus;
+  currentVersion: string;
+  latestVersion?: string;
+  releaseUrl?: string;
+  releaseName?: string;
+  message?: string;
+}
+
+interface GithubReleasePayload {
+  tag_name?: string;
+  html_url?: string;
+  name?: string;
+}
 
 const getWindowPalette = (theme: ThemeMode) => {
   if (theme === "dark") {
@@ -47,6 +71,248 @@ const applyWindowTheme = (window: BrowserWindow, theme: ThemeMode) => {
   }
 };
 
+const normalizeVersion = (version: string): string =>
+  version.trim().replace(/^v/i, "");
+
+const parseVersion = (version: string) => {
+  const normalized = normalizeVersion(version);
+  const [corePart, prereleasePart] = normalized.split("-", 2);
+  const coreSegments = corePart
+    .split(".")
+    .filter(Boolean)
+    .map((segment) => {
+      const value = Number.parseInt(segment, 10);
+      return Number.isNaN(value) ? 0 : value;
+    });
+  const prereleaseSegments = prereleasePart
+    ? prereleasePart
+        .split(".")
+        .filter(Boolean)
+        .map((segment) => {
+          if (/^\d+$/.test(segment)) {
+            return Number.parseInt(segment, 10);
+          }
+          return segment.toLowerCase();
+        })
+    : [];
+  return { coreSegments, prereleaseSegments };
+};
+
+const comparePrerelease = (left: Array<number | string>, right: Array<number | string>) => {
+  if (left.length === 0 && right.length === 0) {
+    return 0;
+  }
+  if (left.length === 0) {
+    return 1;
+  }
+  if (right.length === 0) {
+    return -1;
+  }
+
+  const maxLength = Math.max(left.length, right.length);
+  for (let index = 0; index < maxLength; index += 1) {
+    const leftSegment = left[index];
+    const rightSegment = right[index];
+
+    if (leftSegment == null && rightSegment == null) {
+      return 0;
+    }
+    if (leftSegment == null) {
+      return -1;
+    }
+    if (rightSegment == null) {
+      return 1;
+    }
+    if (leftSegment === rightSegment) {
+      continue;
+    }
+
+    if (typeof leftSegment === "number" && typeof rightSegment === "number") {
+      return leftSegment > rightSegment ? 1 : -1;
+    }
+    if (typeof leftSegment === "number" && typeof rightSegment === "string") {
+      return -1;
+    }
+    if (typeof leftSegment === "string" && typeof rightSegment === "number") {
+      return 1;
+    }
+    if (leftSegment > rightSegment) {
+      return 1;
+    }
+    if (leftSegment < rightSegment) {
+      return -1;
+    }
+  }
+
+  return 0;
+};
+
+const compareVersions = (leftVersion: string, rightVersion: string) => {
+  const left = parseVersion(leftVersion);
+  const right = parseVersion(rightVersion);
+  const maxLength = Math.max(left.coreSegments.length, right.coreSegments.length, 3);
+
+  for (let index = 0; index < maxLength; index += 1) {
+    const leftValue = left.coreSegments[index] ?? 0;
+    const rightValue = right.coreSegments[index] ?? 0;
+    if (leftValue === rightValue) {
+      continue;
+    }
+    return leftValue > rightValue ? 1 : -1;
+  }
+
+  return comparePrerelease(left.prereleaseSegments, right.prereleaseSegments);
+};
+
+const getErrorMessage = (error: unknown) => {
+  if (error instanceof Error) {
+    return error.message;
+  }
+  return String(error ?? "Unknown error");
+};
+
+const fetchLatestRelease = (): Promise<GithubReleasePayload> =>
+  new Promise((resolve, reject) => {
+    const request = https.request(
+      RELEASES_API_URL,
+      {
+        method: "GET",
+        headers: {
+          "User-Agent": `Lite-SQLearner/${app.getVersion()}`,
+          Accept: "application/vnd.github+json",
+        },
+      },
+      (response) => {
+        const statusCode = response.statusCode ?? 0;
+        let rawData = "";
+        response.setEncoding("utf8");
+        response.on("data", (chunk: string) => {
+          rawData += chunk;
+        });
+        response.on("end", () => {
+          if (statusCode < 200 || statusCode >= 300) {
+            reject(new Error(`GitHub API request failed (${statusCode})`));
+            return;
+          }
+          try {
+            const parsed = JSON.parse(rawData) as GithubReleasePayload;
+            resolve(parsed);
+          } catch (_error) {
+            reject(new Error("Failed to parse release metadata"));
+          }
+        });
+      }
+    );
+
+    request.setTimeout(12000, () => {
+      request.destroy(new Error("Update check timed out"));
+    });
+
+    request.on("error", (error) => {
+      reject(error);
+    });
+
+    request.end();
+  });
+
+const isZhLocale = () => app.getLocale().toLowerCase().startsWith("zh");
+
+const promptUpdateDialog = async (update: UpdateCheckResult) => {
+  if (update.status !== "update-available") {
+    return;
+  }
+  if (!mainWindow || mainWindow.isDestroyed()) {
+    return;
+  }
+
+  const zhLocale = isZhLocale();
+  const { response } = await dialog.showMessageBox(mainWindow, {
+    type: "info",
+    title: zhLocale ? "发现新版本" : "Update Available",
+    message: zhLocale
+      ? `检测到新版本 v${update.latestVersion}`
+      : `A new version (v${update.latestVersion}) is available`,
+    detail: zhLocale
+      ? `当前版本：v${update.currentVersion}\n最新版本：v${update.latestVersion}\n是否前往发布页下载更新？`
+      : `Current version: v${update.currentVersion}\nLatest version: v${update.latestVersion}\nOpen the releases page to download the update?`,
+    buttons: zhLocale ? ["前往下载", "稍后"] : ["Open Releases", "Later"],
+    defaultId: 0,
+    cancelId: 1,
+    noLink: true,
+  });
+
+  if (response === 0 && update.releaseUrl) {
+    void shell.openExternal(update.releaseUrl);
+  }
+};
+
+const runUpdateCheck = async (manual: boolean): Promise<UpdateCheckResult> => {
+  if (updateCheckInProgress) {
+    return {
+      status: "checking",
+      currentVersion: app.getVersion(),
+      message: "Update check is already running",
+    };
+  }
+
+  updateCheckInProgress = true;
+  try {
+    const currentVersion = normalizeVersion(app.getVersion());
+    const latestRelease = await fetchLatestRelease();
+    const latestVersion = normalizeVersion(latestRelease.tag_name || "");
+    const releaseUrl = latestRelease.html_url || RELEASES_PAGE_URL;
+
+    if (!latestVersion) {
+      throw new Error("Latest release version is missing");
+    }
+
+    const hasUpdate = compareVersions(latestVersion, currentVersion) > 0;
+    if (!hasUpdate) {
+      return {
+        status: "up-to-date",
+        currentVersion,
+        latestVersion,
+        releaseUrl,
+        releaseName: latestRelease.name,
+      };
+    }
+
+    const result: UpdateCheckResult = {
+      status: "update-available",
+      currentVersion,
+      latestVersion,
+      releaseUrl,
+      releaseName: latestRelease.name,
+    };
+
+    const shouldPrompt = manual || latestPromptedVersion !== latestVersion;
+    if (shouldPrompt) {
+      latestPromptedVersion = latestVersion;
+      await promptUpdateDialog(result);
+    }
+
+    return result;
+  } catch (error) {
+    return {
+      status: "error",
+      currentVersion: normalizeVersion(app.getVersion()),
+      message: getErrorMessage(error),
+    };
+  } finally {
+    updateCheckInProgress = false;
+  }
+};
+
+const scheduleAutoUpdateCheck = () => {
+  if (isDev || !app.isPackaged) {
+    return;
+  }
+
+  setTimeout(() => {
+    void runUpdateCheck(false);
+  }, AUTO_UPDATE_CHECK_DELAY_MS);
+};
+
 if (isWindows) {
   app.setAppUserModelId(APP_ID);
 }
@@ -145,6 +411,18 @@ if (gotTheLock) {
       const firstPreferred = preferredLanguages[0];
       return firstPreferred || app.getLocale() || "en-US";
     });
+    ipcMain.handle("app:check-for-updates", () => runUpdateCheck(true));
+    ipcMain.handle("app:open-external", (_event, targetUrl: string) => {
+      if (typeof targetUrl !== "string") {
+        return false;
+      }
+      const normalizedUrl = targetUrl.trim();
+      if (!/^https?:\/\//i.test(normalizedUrl)) {
+        return false;
+      }
+      void shell.openExternal(normalizedUrl);
+      return true;
+    });
     ipcMain.on("app:set-window-theme", (_event, theme: ThemeMode) => {
       if (!mainWindow || mainWindow.isDestroyed()) {
         return;
@@ -156,6 +434,7 @@ if (gotTheLock) {
     });
 
     createWindow();
+    scheduleAutoUpdateCheck();
     app.on("activate", () => {
       if (BrowserWindow.getAllWindows().length === 0) {
         createWindow();

electron/preload.ts

@@ -3,6 +3,8 @@ import { contextBridge, ipcRenderer } from "electron";
 contextBridge.exposeInMainWorld("electron", {
   platform: process.platform,
   getSystemLocale: () => ipcRenderer.invoke("app:get-system-locale"),
+  checkForUpdates: () => ipcRenderer.invoke("app:check-for-updates"),
+  openExternal: (url: string) => ipcRenderer.invoke("app:open-external", url),
   setWindowTheme: (theme: "light" | "dark") =>
     ipcRenderer.send("app:set-window-theme", theme),
 });

package.json

@@ -1,7 +1,7 @@
 {
   "name": "lite-sqlearner",
   "private": true,
-  "version": "0.0.1",
+  "version": "0.2.0",
   "description": "An interactive, gamified SQL learning desktop application",
   "author": "Lite-SQLearner Team",
   "main": "dist-electron/main.js",
@@ -101,10 +101,11 @@
     "vue-router": "4"
   },
   "devDependencies": {
+    "@types/node": "^22.0.0",
     "@types/sql.js": "^1.4.3",
     "@typescript-eslint/eslint-plugin": "^5.23.0",
     "@typescript-eslint/parser": "^5.23.0",
-    "@vitejs/plugin-vue": "^3.0.3",
+    "@vitejs/plugin-vue": "^6.0.4",
     "concurrently": "^8.2.2",
     "cross-env": "^7.0.3",
     "electron": "^31.0.2",
@@ -121,8 +122,8 @@
     "prettier": "^2.7.1",
     "sharp": "^0.34.5",
     "typescript": "^5.9.3",
-    "vite": "^3.0.7",
-    "vue-tsc": "^0.39.5",
+    "vite": "^7.3.1",
+    "vue-tsc": "^3.2.5",
     "wait-on": "^7.2.0"
   }
 }