Skip to content

Add auto-updater API to Electron server #213

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

Merged
merged 6 commits into from
May 8, 2025
Merged

Add auto-updater API to Electron server #213

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
16c233e
Add auto-updater API to Electron server
WINBIGFOX Apr 26, 2025
1920ff6
Merge remote-tracking branch 'origin/main' into add-auto-updater-api
WINBIGFOX Apr 28, 2025
00ce033
Add download-progress listener to autoUpdater
WINBIGFOX Apr 28, 2025
1de495c
Update api.test.ts
WINBIGFOX Apr 28, 2025
3b68c51
Refactor electron-updater imports for consistency and clarity
WINBIGFOX Apr 30, 2025
63326ae
Merge remote-tracking branch 'origin/add-auto-updater-api' into add-a…
WINBIGFOX Apr 30, 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
2 changes: 2 additions & 0 deletions resources/js/electron-plugin/dist/server/api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import middleware from "./api/middleware.js";
import clipboardRoutes from "./api/clipboard.js";
import alertRoutes from "./api/alert.js";
import appRoutes from "./api/app.js";
import autoUpdaterRoutes from "./api/autoUpdater.js";
import screenRoutes from "./api/screen.js";
import dialogRoutes from "./api/dialog.js";
import debugRoutes from "./api/debug.js";
Expand Down Expand Up @@ -44,6 +45,7 @@ function startAPIServer(randomSecret) {
httpServer.use("/api/clipboard", clipboardRoutes);
httpServer.use("/api/alert", alertRoutes);
httpServer.use("/api/app", appRoutes);
httpServer.use("/api/auto-updater", autoUpdaterRoutes);
httpServer.use("/api/screen", screenRoutes);
httpServer.use("/api/dialog", dialogRoutes);
httpServer.use("/api/system", systemRoutes);
Expand Down
49 changes: 49 additions & 0 deletions resources/js/electron-plugin/dist/server/api/autoUpdater.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
import express from "express";
import electronUpdater from "electron-updater";
import { notifyLaravel } from "../utils.js";
const router = express.Router();
const { autoUpdater } = electronUpdater;
router.post("/check-for-updates", (req, res) => {
autoUpdater.checkForUpdates();
Copy link
Contributor

Choose a reason for hiding this comment

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

Idea: If you add a guard clause here you might be able to prevent the download from happening multiple times.

Set a Boolean & make sure to reset it when the download finishes/fails

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 don't think it's such a bad idea, but I don't know how reliably it will work.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah it def needs some manual testing. We can always add it later if we want. What do you think @SRWieZ ?

res.sendStatus(200);
});
router.post("/quit-and-install", (req, res) => {
autoUpdater.quitAndInstall();
res.sendStatus(200);
});
autoUpdater.addListener("checking-for-update", () => {
notifyLaravel("events", {
event: `\\Native\\Laravel\\Events\\AutoUpdater\\CheckingForUpdate`,
});
});
autoUpdater.addListener("update-available", () => {
notifyLaravel("events", {
event: `\\Native\\Laravel\\Events\\AutoUpdater\\UpdateAvailable`,
});
});
autoUpdater.addListener("update-not-available", () => {
notifyLaravel("events", {
event: `\\Native\\Laravel\\Events\\AutoUpdater\\UpdateNotAvailable`,
});
});
autoUpdater.addListener("error", (error) => {
notifyLaravel("events", {
event: `\\Native\\Laravel\\Events\\AutoUpdater\\Error`,
payload: {
error: error,
},
});
});
autoUpdater.addListener("update-downloaded", (event) => {
notifyLaravel("events", {
event: `\\Native\\Laravel\\Events\\AutoUpdater\\UpdateDownloaded`,
payload: {
version: event.version,
downloadedFile: event.downloadedFile,
releaseDate: event.releaseDate,
releaseNotes: event.releaseNotes,
releaseName: event.releaseName,
},
});
});
export default router;
2 changes: 2 additions & 0 deletions resources/js/electron-plugin/src/server/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import middleware from "./api/middleware.js";
import clipboardRoutes from "./api/clipboard.js";
import alertRoutes from "./api/alert.js";
import appRoutes from "./api/app.js";
import autoUpdaterRoutes from "./api/autoUpdater.js";
import screenRoutes from "./api/screen.js";
import dialogRoutes from "./api/dialog.js";
import debugRoutes from "./api/debug.js";
Expand Down Expand Up @@ -43,6 +44,7 @@ async function startAPIServer(randomSecret: string): Promise<APIProcess> {
httpServer.use("/api/clipboard", clipboardRoutes);
httpServer.use("/api/alert", alertRoutes);
httpServer.use("/api/app", appRoutes);
httpServer.use("/api/auto-updater", autoUpdaterRoutes);
httpServer.use("/api/screen", screenRoutes);
httpServer.use("/api/dialog", dialogRoutes);
httpServer.use("/api/system", systemRoutes);
Expand Down
59 changes: 59 additions & 0 deletions resources/js/electron-plugin/src/server/api/autoUpdater.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
import express from "express";
import electronUpdater, { UpdateDownloadedEvent } from "electron-updater";
import { notifyLaravel } from "../utils.js";

const router = express.Router();
const { autoUpdater } = electronUpdater;

Check failure on line 6 in resources/js/electron-plugin/src/server/api/autoUpdater.ts

View workflow job for this annotation

GitHub Actions / test

tests/api.test.ts 

TypeError: Cannot read properties of undefined (reading 'getVersion')
 ❯ ElectronAppAdapter.get version [as version] ../node_modules/electron-updater/src/ElectronAppAdapter.ts:12:21
 ❯ new AppUpdater ../node_modules/electron-updater/src/AppUpdater.ts:256:43
 ❯ new BaseUpdater ../node_modules/electron-updater/src/BaseUpdater.ts:11:5
 ❯ new AppImageUpdater ../node_modules/electron-updater/src/AppImageUpdater.ts:15:5
 ❯ doLoadAutoUpdater ../node_modules/electron-updater/src/main.ts:31:20
 ❯ Object.get [as autoUpdater] ../node_modules/electron-updater/src/main.ts:66:28
 ❯ src/server/api/autoUpdater.ts:6:9

router.post("/check-for-updates", (req, res) => {
autoUpdater.checkForUpdates();
res.sendStatus(200);
});

router.post("/quit-and-install", (req, res) => {
autoUpdater.quitAndInstall();
res.sendStatus(200);
});

autoUpdater.addListener("checking-for-update", () => {
notifyLaravel("events", {
event: `\\Native\\Laravel\\Events\\AutoUpdater\\CheckingForUpdate`,
});
});

autoUpdater.addListener("update-available", () => {
notifyLaravel("events", {
event: `\\Native\\Laravel\\Events\\AutoUpdater\\UpdateAvailable`,
});
});

autoUpdater.addListener("update-not-available", () => {
notifyLaravel("events", {
event: `\\Native\\Laravel\\Events\\AutoUpdater\\UpdateNotAvailable`,
});
});

autoUpdater.addListener("error", (error) => {
notifyLaravel("events", {
event: `\\Native\\Laravel\\Events\\AutoUpdater\\Error`,
payload: {
error: error,
},
});
});

autoUpdater.addListener("update-downloaded", (event: UpdateDownloadedEvent) => {
notifyLaravel("events", {
event: `\\Native\\Laravel\\Events\\AutoUpdater\\UpdateDownloaded`,
payload: {
version: event.version,
downloadedFile: event.downloadedFile,
releaseDate: event.releaseDate,
releaseNotes: event.releaseNotes,
releaseName: event.releaseName,
},
});
},
);

export default router;
Loading