fix(desktop): fall back from invalid releases

Author: waleedlatif1

apps/desktop/README.md

@@ -171,7 +171,7 @@ Raw local file bytes are never exposed through the preload bridge and cannot be
 
 ## Auto-update, channels, rollout, rollback
 
-- `electron-updater` reads the deployment's `/api/desktop/update` feed; production resolves stable releases from `simstudioai/sim`, while dev/staging resolve prereleases from `simstudioai/sim-desktop-releases`. Artifact downloads go directly to GitHub and deltas use `.zip.blockmap`. Sim validates every candidate before starting its download. Install is prompt-based (Restart and update / Later; Later installs on quit) — never forced mid-session.
+- `electron-updater` reads the deployment's `/api/desktop/update` feed; production resolves stable releases from `simstudioai/sim`, while dev/staging resolve prereleases from `simstudioai/sim-desktop-releases`. Artifact downloads go directly to GitHub and deltas use `.zip.blockmap`. Sim validates every candidate before starting its download. Developer ID builds installed under `/Applications` use a prompt (Restart and update / Later; Later installs on quit); other packaged builds offer a validated installer download — never forced mid-session.
 - Streams: production follows stable `X.Y.Z` releases, dev follows `-dev.N`, and staging follows `-staging.N`. The feed still recognizes legacy `-alpha.N`/`-beta.N` releases during migration.
 - Staged rollout: after publishing, edit `stagingPercentage: 10` into the release's `latest-mac.yml`, then raise as crash metrics stay clean.
 - Rollback: a pulled release must be superseded by a **higher** version — users on the broken build will not reinstall an equal one. (A blocked-versions kill-switch was removed as unwired dead code; reintroduce it in `updater.ts` if a remote config source ever exists to feed it.)

apps/desktop/src/main/updater.test.ts

@@ -353,6 +353,37 @@ describe('initUpdater state machine', () => {
     expect(autoUpdaterMock.quitAndInstall).toHaveBeenCalledTimes(1)
   })
 
+  it('does not install when the updater fails during pre-install teardown', async () => {
+    let finishTeardown: (() => void) | undefined
+    const setRelaunchPending = vi.fn()
+    const { handle } = await createUpdater({
+      beforeInstall: () =>
+        new Promise<void>((resolve) => {
+          finishTeardown = resolve
+        }),
+      setRelaunchPending,
+    })
+
+    handle.check()
+    await vi.advanceTimersByTimeAsync(0)
+    emit('update-available', { version: '2.0.0' })
+    emit('update-downloaded', { version: '2.0.0' })
+    vi.mocked(dialog.showMessageBox).mockResolvedValueOnce({
+      response: 1,
+      checkboxChecked: false,
+    })
+    handle.install()
+    await vi.advanceTimersByTimeAsync(0)
+
+    emit('error', new Error('native staging failed'))
+    finishTeardown?.()
+    await vi.advanceTimersByTimeAsync(0)
+
+    expect(handle.getState()).toEqual({ status: 'error', version: '2.0.0' })
+    expect(setRelaunchPending).not.toHaveBeenCalledWith(true)
+    expect(autoUpdaterMock.quitAndInstall).not.toHaveBeenCalled()
+  })
+
   it('bypasses renderer unload guards only after teardown succeeds', async () => {
     const setRelaunchPending = vi.fn()
     vi.mocked(dialog.showMessageBox).mockResolvedValueOnce({

apps/desktop/src/main/updater.ts

@@ -394,12 +394,17 @@ export function initUpdater(deps: UpdaterDeps): UpdaterHandle {
     let installInFlight = false
     let installConfirmationInFlight = false
 
-    const quitAndInstall = () => {
+    const quitAndInstall = (version: string | undefined) => {
       if (installInFlight) return
       installInFlight = true
       void Promise.resolve()
         .then(() => deps.beforeInstall?.())
         .then(() => {
+          if (state.status !== 'ready' || state.version !== version) {
+            autoUpdater.autoInstallOnAppQuit = false
+            installInFlight = false
+            return
+          }
           deps.setRelaunchPending?.(true)
           autoUpdater.quitAndInstall()
         })
@@ -435,7 +440,7 @@ export function initUpdater(deps: UpdaterDeps): UpdaterHandle {
       void confirmation
         .then(({ response }) => {
           if (response === 1 && state.status === 'ready' && state.version === version) {
-            quitAndInstall()
+            quitAndInstall(version)
           }
         })
         .catch((error) => {

apps/sim/app/api/desktop/update/download/route.test.ts

@@ -36,13 +36,32 @@ function release(tag: string, repository: string) {
   }
 }
 
+function manifest(version: string) {
+  return [`version: ${version}`, 'files:', `  - url: Sim-${version}-universal.zip`].join('\n')
+}
+
 async function getDownload(): Promise<Response> {
   return GET(new NextRequest('https://www.sim.ai/api/desktop/update/download'), undefined)
 }
 
 describe('desktop update download route', () => {
   const fetchMock = vi.fn()
 
+  function mockReleases(releases: ReturnType<typeof release>[]) {
+    fetchMock.mockImplementation(async (input: string | URL | Request) => {
+      const url = String(input)
+      if (url === STABLE_RELEASES_URL || url === PRERELEASE_RELEASES_URL) {
+        return Response.json(releases)
+      }
+      const candidate = releases.find((release) =>
+        release.assets.some((asset) => asset.browser_download_url === url)
+      )
+      return candidate
+        ? new Response(manifest(candidate.tag_name.replace(/^v/, '')))
+        : new Response(null, { status: 404 })
+    })
+  }
+
   beforeEach(() => {
     fetchMock.mockReset()
     vi.stubGlobal('fetch', fetchMock)
@@ -54,13 +73,11 @@ describe('desktop update download route', () => {
   })
 
   it('redirects to the newest stable installer', async () => {
-    fetchMock.mockResolvedValueOnce(
-      Response.json([
-        release('v1.1.0', DESKTOP_STABLE_RELEASE_REPOSITORY),
-        release('v1.3.0', DESKTOP_STABLE_RELEASE_REPOSITORY),
-        release('v1.2.0', DESKTOP_STABLE_RELEASE_REPOSITORY),
-      ])
-    )
+    mockReleases([
+      release('v1.1.0', DESKTOP_STABLE_RELEASE_REPOSITORY),
+      release('v1.3.0', DESKTOP_STABLE_RELEASE_REPOSITORY),
+      release('v1.2.0', DESKTOP_STABLE_RELEASE_REPOSITORY),
+    ])
 
     const response = await getDownload()
 
@@ -73,12 +90,10 @@ describe('desktop update download route', () => {
 
   it('serves its own deployment channel rather than the stable stream', async () => {
     setEnv({ APPCONFIG_ENVIRONMENT: 'dev' })
-    fetchMock.mockResolvedValueOnce(
-      Response.json([
-        release('v1.3.0-dev.4', DESKTOP_PRERELEASE_REPOSITORY),
-        release('v1.4.0-staging.1', DESKTOP_PRERELEASE_REPOSITORY),
-      ])
-    )
+    mockReleases([
+      release('v1.3.0-dev.4', DESKTOP_PRERELEASE_REPOSITORY),
+      release('v1.4.0-staging.1', DESKTOP_PRERELEASE_REPOSITORY),
+    ])
 
     const response = await getDownload()
 
@@ -87,6 +102,17 @@ describe('desktop update download route', () => {
     expect(fetchMock).toHaveBeenCalledWith(PRERELEASE_RELEASES_URL, expect.any(Object))
   })
 
+  it('falls back when the newest release has no installer artifact', async () => {
+    const incomplete = release('v1.4.0', DESKTOP_STABLE_RELEASE_REPOSITORY)
+    incomplete.assets = incomplete.assets.filter((asset) => asset.name === MANIFEST_ASSET_NAME)
+    mockReleases([incomplete, release('v1.3.0', DESKTOP_STABLE_RELEASE_REPOSITORY)])
+
+    const response = await getDownload()
+
+    expect(response.status).toBe(302)
+    expect(response.headers.get('location')).toContain('Sim-1.3.0-universal.dmg')
+  })
+
   it('reports no release when the channel has none', async () => {
     fetchMock.mockResolvedValueOnce(
       Response.json([release('v1.3.0-dev.4', DESKTOP_PRERELEASE_REPOSITORY)])

apps/sim/app/api/desktop/update/download/route.ts

@@ -9,7 +9,7 @@ import {
   releaseRepositoryForChannel,
   releasesApiUrl,
   resolveLatestRelease,
-  selectInstallerAsset,
+  resolveReleaseAssets,
 } from '@/lib/desktop/update-feed'
 
 const logger = createLogger('DesktopUpdateDownloadAPI')
@@ -36,52 +36,64 @@ export const GET = withRouteHandler(async (_request: NextRequest): Promise<Respo
   const releaseRepository = releaseRepositoryForChannel(channel)
 
   const githubToken = env.GITHUB_TOKEN
-  const resolved = await resolveLatestRelease(channel, async (page) => {
-    try {
-      const response = await fetch(releasesApiUrl(releaseRepository, page), {
-        headers: {
-          accept: 'application/vnd.github+json',
-          ...(githubToken ? { authorization: `Bearer ${githubToken}` } : {}),
-        },
-        next: { revalidate: REVALIDATE_SECONDS },
-      })
-      if (!response.ok) {
-        logger.error('GitHub releases lookup failed', {
-          status: response.status,
+  const resolved = await resolveLatestRelease(
+    channel,
+    async (page) => {
+      try {
+        const response = await fetch(releasesApiUrl(releaseRepository, page), {
+          headers: {
+            accept: 'application/vnd.github+json',
+            ...(githubToken ? { authorization: `Bearer ${githubToken}` } : {}),
+          },
+          next: { revalidate: REVALIDATE_SECONDS },
+        })
+        if (!response.ok) {
+          logger.error('GitHub releases lookup failed', {
+            status: response.status,
+            page,
+            channel,
+            releaseRepository,
+          })
+          return null
+        }
+        return (await response.json()) as DesktopReleaseCandidate[]
+      } catch (error) {
+        logger.error('GitHub releases response could not be read', {
+          message: getErrorMessage(error),
           page,
           channel,
           releaseRepository,
         })
         return null
       }
-      return (await response.json()) as DesktopReleaseCandidate[]
-    } catch (error) {
-      logger.error('GitHub releases response could not be read', {
-        message: getErrorMessage(error),
-        page,
-        channel,
-        releaseRepository,
-      })
-      return null
+    },
+    async (release) => {
+      const assets = await resolveReleaseAssets(release, releaseRepository, (url) =>
+        fetch(url, {
+          next: { revalidate: REVALIDATE_SECONDS },
+        })
+      )
+      if (!assets) {
+        logger.warn('Skipping incomplete or invalid desktop release', {
+          tag: release.tag_name,
+          channel,
+        })
+      }
+      return assets?.installer ?? null
     }
-  })
+  )
   if ('error' in resolved) {
     return NextResponse.json({ error: 'Release feed unavailable' }, { status: 502 })
   }
 
-  const release = resolved.release
-  const asset = release ? selectInstallerAsset(release, releaseRepository) : null
-  if (!release || !asset) {
-    if (release) {
-      logger.error('Release has no installer artifact', { tag: release.tag_name, channel })
-    }
+  if (!resolved.release) {
     return NextResponse.json(
       { error: `No desktop release for channel ${channel}` },
       { status: 404 }
     )
   }
 
-  return NextResponse.redirect(asset.browser_download_url, {
+  return NextResponse.redirect(resolved.value.browser_download_url, {
     status: 302,
     headers: { 'cache-control': `public, max-age=${REVALIDATE_SECONDS}` },
   })

apps/sim/app/api/desktop/update/latest-mac.yml/route.test.ts

@@ -18,6 +18,7 @@ const PRERELEASE_RELEASES_URL = releasesApiUrl(DESKTOP_PRERELEASE_REPOSITORY, 1)
 const FEED_STATUS_HEADER = 'x-sim-desktop-update-feed'
 
 function release(tag: string) {
+  const version = tag.replace(/^v/, '')
   return {
     tag_name: tag,
     draft: false,
@@ -27,6 +28,14 @@ function release(tag: string) {
         name: MANIFEST_ASSET_NAME,
         browser_download_url: `https://downloads.example/${tag}/${MANIFEST_ASSET_NAME}`,
       },
+      {
+        name: `Sim-${version}-universal.zip`,
+        browser_download_url: `https://downloads.example/${tag}/Sim-${version}-universal.zip`,
+      },
+      {
+        name: `Sim-${version}-universal.dmg`,
+        browser_download_url: `https://downloads.example/${tag}/Sim-${version}-universal.dmg`,
+      },
     ],
   }
 }
@@ -226,6 +235,28 @@ describe('desktop update manifest route', () => {
     expect(fetchMock).toHaveBeenNthCalledWith(1, PRERELEASE_RELEASES_URL, expect.any(Object))
   })
 
+  it('falls back when the newest release has an invalid manifest', async () => {
+    setEnv({ APPCONFIG_ENVIRONMENT: 'dev' })
+    fetchMock.mockImplementation(async (input: string | URL | Request) => {
+      const url = String(input)
+      if (url === PRERELEASE_RELEASES_URL) {
+        return Response.json([release('v1.2.0-dev.5'), release('v1.2.0-dev.4')])
+      }
+      if (url === `https://downloads.example/v1.2.0-dev.5/${MANIFEST_ASSET_NAME}`) {
+        return new Response(manifest('1.2.0-staging.5'))
+      }
+      if (url === `https://downloads.example/v1.2.0-dev.4/${MANIFEST_ASSET_NAME}`) {
+        return new Response(manifest('1.2.0-dev.4'))
+      }
+      return new Response(null, { status: 404 })
+    })
+
+    const response = await getFeed('www.dev.sim.ai')
+
+    expect(response.status).toBe(200)
+    expect(await response.text()).toContain('version: 1.2.0-dev.4')
+  })
+
   it('rejects an oversized updater manifest', async () => {
     fetchMock
       .mockResolvedValueOnce(Response.json([release('v1.1.0')]))