Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 bun.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions packages/app/src/components/settings-general.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -149,13 +149,12 @@ export const SettingsGeneral: Component = () => {
}

const actions =
platform.update && platform.restart
platform.update
? [
{
label: language.t("toast.update.action.installRestart"),
onClick: async () => {
await platform.update!()
await platform.restart!()
},
},
{
Expand Down
2 changes: 1 addition & 1 deletion packages/app/src/context/platform.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ type PickerPaths = string | string[] | null
type OpenDirectoryPickerOptions = { title?: string; multiple?: boolean }
type OpenFilePickerOptions = { title?: string; multiple?: boolean; accept?: string[]; extensions?: string[] }
type SaveFilePickerOptions = { title?: string; defaultPath?: string }
type UpdateFailureReason = "check" | "download" | "metadata"
type UpdateFailureReason = "check" | "download" | "metadata" | "cache"
export type UpdateInfo =
| { updateAvailable: false; status: "disabled" | "none" | "busy"; version?: undefined }
| { updateAvailable: true; status: "ready"; version: string }
Expand Down
3 changes: 1 addition & 2 deletions packages/app/src/pages/error.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -264,10 +264,9 @@ export const ErrorPage: Component<ErrorPageProps> = (props) => {
}

async function installUpdate() {
if (!platform.update || !platform.restart) return
if (!platform.update) return
await platform
.update()
.then(() => platform.restart!())
.then(() => setStore({ actionError: undefined, actionMessage: undefined }))
.catch((err) => {
setStore({ actionError: formatError(err, language.t), actionMessage: undefined })
Expand Down
3 changes: 1 addition & 2 deletions packages/app/src/pages/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ export default function Layout(props: ParentProps) {

const useUpdatePolling = () =>
onMount(() => {
if (!platform.checkUpdate || !platform.update || !platform.restart) return
if (!platform.checkUpdate || !platform.update) return

let toastId: number | undefined
let interval: ReturnType<typeof setInterval> | undefined
Expand All @@ -386,7 +386,6 @@ export default function Layout(props: ParentProps) {
label: language.t("toast.update.action.installRestart"),
onClick: async () => {
await platform.update!()
await platform.restart!()
},
},
{
Expand Down
29 changes: 29 additions & 0 deletions packages/app/src/pages/update-install-flow-source.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import { readFileSync } from "node:fs"
import { describe, expect, test } from "bun:test"

const layout = readFileSync(new URL("./layout.tsx", import.meta.url), "utf8")
const errorPage = readFileSync(new URL("./error.tsx", import.meta.url), "utf8")
const settings = readFileSync(new URL("../components/settings-general.tsx", import.meta.url), "utf8")
const platform = readFileSync(new URL("../context/platform.tsx", import.meta.url), "utf8")

describe("update install renderer contracts", () => {
test("renderer install actions do not relaunch after platform update", () => {
expect(layout).not.toMatch(/await\s+platform\.restart!\(\)/)
expect(settings).not.toMatch(/await\s+platform\.restart!\(\)/)
expect(errorPage).not.toMatch(/await\s+platform\.restart!\(\)/)
expect(layout).not.toMatch(/\.then\(\(\)\s*=>\s*platform\.restart!\(\)\)/)
expect(settings).not.toMatch(/\.then\(\(\)\s*=>\s*platform\.restart!\(\)\)/)
expect(errorPage).not.toMatch(/\.then\(\(\)\s*=>\s*platform\.restart!\(\)\)/)
})
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Comment thread
coderabbitai[bot] marked this conversation as resolved.

test("renderer update prompts only require platform update", () => {
expect(layout).toContain("if (!platform.checkUpdate || !platform.update) return")
expect(layout).not.toContain("if (!platform.checkUpdate || !platform.update || !platform.restart) return")
expect(settings).toContain("platform.update")
expect(settings).not.toContain("platform.update && platform.restart")
})

test("cache update failures are part of the renderer-facing type", () => {
expect(platform).toContain('"check" | "download" | "metadata" | "cache"')
})
})
4 changes: 3 additions & 1 deletion packages/desktop-electron/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@
"electron-store": "^10",
"electron-updater": "^6",
"electron-window-state": "^5.0.3",
"marked": "^15"
"marked": "^15",
"semver": "^7.6.0"
},
"devDependencies": {
"@actions/artifact": "4.0.0",
Expand All @@ -45,6 +46,7 @@
"@solid-primitives/storage": "catalog:",
"@solidjs/meta": "catalog:",
"@solidjs/router": "0.15.4",
"@types/semver": "catalog:",
"@types/bun": "catalog:",
"@types/node": "catalog:",
"@typescript/native-preview": "catalog:",
Expand Down
19 changes: 16 additions & 3 deletions packages/desktop-electron/scripts/write-app-update-config.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { existsSync, mkdtempSync, readFileSync, rmSync } from "node:fs"
import { tmpdir } from "node:os"
import { join } from "node:path"

import { UPDATER_CACHE_DIR_NAME } from "../src/main/updater-cache"
import { serializeAppUpdateConfig, writeAppUpdateConfig } from "./write-app-update-config"

const roots: string[] = []
Expand All @@ -26,12 +27,23 @@ describe("write-app-update-config", () => {
"owner: Astro-Han",
"repo: pawwork",
"channel: latest",
"updaterCacheDirName: pawwork-updater",
`updaterCacheDirName: ${UPDATER_CACHE_DIR_NAME}`,
"",
].join("\n"),
)
})

test("serializes updater cache dir from the shared constant", () => {
expect(
serializeAppUpdateConfig({
provider: "github",
owner: "Astro-Han",
repo: "pawwork",
channel: "latest",
}),
).toContain(`updaterCacheDirName: ${UPDATER_CACHE_DIR_NAME}`)
})
Comment thread
Astro-Han marked this conversation as resolved.

test("serializes beta GitHub updater config", () => {
expect(
serializeAppUpdateConfig({
Expand Down Expand Up @@ -65,7 +77,8 @@ describe("write-app-update-config", () => {
).toBe(true)

const configPath = join(root, "PawWork.app", "Contents", "Resources", "app-update.yml")
expect(readFileSync(configPath, "utf8")).toContain("repo: pawwork")
expect(readFileSync(configPath, "utf8")).toContain("updaterCacheDirName: pawwork-updater")
const config = readFileSync(configPath, "utf8")
expect(config).toContain("repo: pawwork")
expect(config).toContain(`updaterCacheDirName: ${UPDATER_CACHE_DIR_NAME}`)
})
})
4 changes: 2 additions & 2 deletions packages/desktop-electron/scripts/write-app-update-config.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
import { mkdir, writeFile } from "node:fs/promises"
import { join } from "node:path"

import { UPDATER_CACHE_DIR_NAME } from "../src/main/updater-cache"

export type GitHubPublishConfig = {
provider: "github"
owner: string
repo: string
channel: string
}

const UPDATER_CACHE_DIR_NAME = "pawwork-updater"

export function serializeAppUpdateConfig(publish: GitHubPublishConfig) {
return [
"provider: github",
Expand Down
27 changes: 27 additions & 0 deletions packages/desktop-electron/src/main/index-updater-source.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import { readFileSync } from "node:fs"
import { describe, expect, test } from "bun:test"

const source = readFileSync(new URL("./index.ts", import.meta.url), "utf8")

describe("main updater source contracts", () => {
test("disables stable downgrades after assigning latest channel", () => {
const channelIndex = source.search(/autoUpdater\.channel\s*=\s*"latest"/)
const downgradeIndex = source.search(/autoUpdater\.allowDowngrade\s*=\s*false/)
expect(channelIndex).toBeGreaterThanOrEqual(0)
expect(downgradeIndex).toBeGreaterThan(channelIndex)
expect(source).not.toContain("autoUpdater.allowDowngrade = true")
})

test("disables auto install on quit only on macOS", () => {
expect(source).toContain('autoUpdater.autoInstallOnAppQuit = process.platform !== "darwin"')
expect(source).not.toContain("autoUpdater.autoInstallOnAppQuit = false")
})

test("strict pending cleanup uses shared updater cache helper and propagates rm errors", () => {
expect(source).toContain('import { pendingUpdateCacheDir } from "./updater-cache"')
expect(source).toContain("await rm(pendingUpdateCacheDir(), { recursive: true, force: true })")
expect(source).not.toMatch(
/rm\(pendingUpdateCacheDir\(\),\s*\{\s*recursive:\s*true,\s*force:\s*true\s*\}\)\s*\.catch\(\(\)\s*=>/,
)
})
Comment thread
coderabbitai[bot] marked this conversation as resolved.
})
12 changes: 10 additions & 2 deletions packages/desktop-electron/src/main/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { randomUUID } from "node:crypto"
import { EventEmitter } from "node:events"
import { mkdirSync, writeFileSync } from "node:fs"
import { rm } from "node:fs/promises"
import { createServer } from "node:net"
import os, { homedir } from "node:os"
import { dirname, join } from "node:path"
Expand Down Expand Up @@ -61,6 +62,7 @@ import { readStoredMenuLocale, writeStoredMenuLocale } from "./menu-i18n"
import { getDefaultServerUrl, getWslConfig, setDefaultServerUrl, setWslConfig, spawnLocalServer } from "./server"
import { PAWWORK_RUNTIME } from "./runtime-namespace"
import { createUpdaterController } from "./updater"
import { pendingUpdateCacheDir } from "./updater-cache"
import { updaterDialogLabels } from "./updater-dialog-labels"
import {
createLoadingWindow,
Expand Down Expand Up @@ -106,6 +108,7 @@ const updater = createUpdaterController({
currentVersion: () => app.getVersion(),
checkForUpdates: () => autoUpdater.checkForUpdates(),
downloadUpdate: () => autoUpdater.downloadUpdate(),
clearPendingUpdate: clearPendingUpdate,
quitAndInstall: () => {
killSidecar()
autoUpdater.quitAndInstall()
Expand Down Expand Up @@ -544,18 +547,23 @@ async function getSidecarPort() {
})
}

async function clearPendingUpdate() {
await rm(pendingUpdateCacheDir(), { recursive: true, force: true })
}

function setupAutoUpdater() {
if (!UPDATER_ENABLED) return
autoUpdater.logger = logger
autoUpdater.channel = "latest"
autoUpdater.allowPrerelease = false
autoUpdater.allowDowngrade = true
autoUpdater.allowDowngrade = false
autoUpdater.autoDownload = false
autoUpdater.autoInstallOnAppQuit = true
autoUpdater.autoInstallOnAppQuit = process.platform !== "darwin"
logger.log("auto updater configured", {
channel: autoUpdater.channel,
allowPrerelease: autoUpdater.allowPrerelease,
allowDowngrade: autoUpdater.allowDowngrade,
autoInstallOnAppQuit: autoUpdater.autoInstallOnAppQuit,
currentVersion: app.getVersion(),
})
}
Expand Down
79 changes: 79 additions & 0 deletions packages/desktop-electron/src/main/updater-cache.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
import { describe, expect, test } from "bun:test"
import { getAppCacheDir, pendingUpdateCacheDir, UPDATER_CACHE_DIR_NAME } from "./updater-cache"

describe("updater cache path", () => {
test("uses the same updater cache dir name as app-update.yml", () => {
expect(UPDATER_CACHE_DIR_NAME).toBe("pawwork-updater")
})

test("resolves macOS pending cache from the user library cache root", () => {
expect(getAppCacheDir({ platform: "darwin", homedir: "/Users/demo", env: {} })).toBe("/Users/demo/Library/Caches")
expect(pendingUpdateCacheDir({ platform: "darwin", homedir: "/Users/demo", env: {} })).toBe(
"/Users/demo/Library/Caches/pawwork-updater/pending",
)
})

test("resolves Windows pending cache from LOCALAPPDATA when present", () => {
expect(
pendingUpdateCacheDir({
platform: "win32",
homedir: "C:\\Users\\demo",
env: { LOCALAPPDATA: "C:\\Users\\demo\\AppData\\Local" },
}),
).toBe("C:\\Users\\demo\\AppData\\Local\\pawwork-updater\\pending")
})

test("resolves Windows pending cache from localappdata casing when present", () => {
expect(
pendingUpdateCacheDir({
platform: "win32",
homedir: "C:\\Users\\demo",
env: { localappdata: "D:\\Cache" },
}),
).toBe("D:\\Cache\\pawwork-updater\\pending")
})

test("falls back to AppData\\Local on Windows when LOCALAPPDATA is missing", () => {
expect(pendingUpdateCacheDir({ platform: "win32", homedir: "C:\\Users\\demo", env: {} })).toBe(
"C:\\Users\\demo\\AppData\\Local\\pawwork-updater\\pending",
)
})

test("ignores relative Windows cache roots from env", () => {
expect(
pendingUpdateCacheDir({
platform: "win32",
homedir: "C:\\Users\\demo",
env: { LOCALAPPDATA: "relative-cache" },
}),
).toBe("C:\\Users\\demo\\AppData\\Local\\pawwork-updater\\pending")
})

test("uses lowercase Windows cache root when uppercase env is relative", () => {
expect(
pendingUpdateCacheDir({
platform: "win32",
homedir: "C:\\Users\\demo",
env: { LOCALAPPDATA: "relative-cache", localappdata: "D:\\Cache" },
}),
).toBe("D:\\Cache\\pawwork-updater\\pending")
})

test("resolves Linux pending cache from XDG_CACHE_HOME when present", () => {
expect(
pendingUpdateCacheDir({ platform: "linux", homedir: "/home/demo", env: { XDG_CACHE_HOME: "/tmp/cache" } }),
).toBe("/tmp/cache/pawwork-updater/pending")
})

test("falls back to ~/.cache on Linux when XDG_CACHE_HOME is missing", () => {
expect(pendingUpdateCacheDir({ platform: "linux", homedir: "/home/demo", env: {} })).toBe(
"/home/demo/.cache/pawwork-updater/pending",
)
})
Comment thread
Astro-Han marked this conversation as resolved.

test("ignores relative Linux cache roots from env", () => {
expect(
pendingUpdateCacheDir({ platform: "linux", homedir: "/home/demo", env: { XDG_CACHE_HOME: "relative-cache" } }),
).toBe("/home/demo/.cache/pawwork-updater/pending")
})
})
44 changes: 44 additions & 0 deletions packages/desktop-electron/src/main/updater-cache.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
import { homedir as currentHomedir } from "node:os"
import path from "node:path"

export const UPDATER_CACHE_DIR_NAME = "pawwork-updater"

type CacheInput = {
platform?: NodeJS.Platform
homedir?: string
env?: NodeJS.ProcessEnv
}

function pathForPlatform(platform: NodeJS.Platform) {
return platform === "win32" ? path.win32 : path.posix
}

function firstAbsolutePath(
platformPath: typeof path.posix | typeof path.win32,
fallback: string,
...values: Array<string | undefined>
) {
return values.find((value) => value && platformPath.isAbsolute(value)) ?? fallback
}

export function getAppCacheDir(input: CacheInput = {}) {
const platform = input.platform ?? process.platform
const homedir = input.homedir ?? currentHomedir()
const env = input.env ?? process.env
const platformPath = pathForPlatform(platform)

if (platform === "win32")
return firstAbsolutePath(
platformPath,
platformPath.join(homedir, "AppData", "Local"),
env.LOCALAPPDATA,
env.localappdata,
)
if (platform === "darwin") return platformPath.join(homedir, "Library", "Caches")
return firstAbsolutePath(platformPath, platformPath.join(homedir, ".cache"), env.XDG_CACHE_HOME)
}

export function pendingUpdateCacheDir(input: CacheInput = {}) {
const platform = input.platform ?? process.platform
return pathForPlatform(platform).join(getAppCacheDir(input), UPDATER_CACHE_DIR_NAME, "pending")
}
Loading
Loading