Skip to content

refactor(install): remove the starter-template install pipeline - #2136

Merged
benceruleanlu merged 1 commit into
mainfrom
bl/remove-starter-template-pipeline
Nov 16, 2026
Merged

benceruleanlu merged 1 commit into
mainfrom
bl/remove-starter-template-pipeline

Conversation

@benceruleanlu

Copy link
Copy Markdown
Member

Stacked on #2133. Once #2133 merges, GitHub retargets this to main, and I'll merge main in.

Why

No install path picks a starter workflow any more. #2133 removed the first-run step, Install on Set up has skipped it since #2072, and the New Build modal never asked. But the main process still had the whole per-install pipeline: a standalone bundledTemplate field, four template fields on installation records, a model download started during install, a deep link on first open, and a Downloads tray that opened by itself. This PR removes all of it.

What goes

  • Standalone source: no bundledTemplate field, no options for it, and buildInstallation writes no template fields, even when a selection still names a template.
  • Installation records: bundledTemplateId, bundledTemplateSizeBytes, pendingTemplateOpen, downloadTemplateModels and clearPendingTemplateOpen are gone. attach loads the plain ComfyUI URL.
  • Install handler: no longer starts or aborts a starter-model download. First open no longer schedules the Downloads tray (openDownloadsTrayForInstall had no other caller).
  • templateDownloadTask: only the task the performance test page runs is left (startTemplateDownloadTask, subscribeTemplateDownload, forgetTemplateDownload, hasActiveTemplateDownloads). It now requires the workflow JSON, so the per-install lookup (resolveTemplateModels, resolveTemplateInputAssets) is gone.
  • Catalog: the remote starter-templates.json reader, CURATED_TEMPLATES, loadTemplateCatalog with its cache and live-index substitution, and buildTemplateDeeplink are gone. hydrateTemplates stays.
  • Settings: skipTemplatePickerStep is retired through the existing removed-keys list, so it gets cleaned out of existing settings.json files.
  • Renderer: setupPlan and InstallWizardModal no longer special-case the field. The three standalone.starterTemplate* strings are gone.
  • launchStarterModels.integration.test.ts is deleted.

What stays

  • The performance test page: TemplatePickerStep, useTemplateTabs, hydrateTemplates, toTemplateFieldOption, the example-workflow downloads, and the quit warning while they run.
  • The starter-templates.json publish workflow (.github/workflows/starter-templates.yml, scripts/starter-templates.mjs, assets/starter-templates.json). This build no longer reads the file, but released builds that still show the step fetch it from R2. Removing the workflow would freeze that list for them, so it's a separate call.
  • The template_selected: false prop on comfy.desktop.install.dispatched. It's always false now; dropping it would change the event schema dashboards read.

Existing data

installations.json records that still carry the old template fields load, list and update as before. Nothing reads those fields now. New test: installations.load (a build made when first run offered a starter workflow).

Tests

  • Rewrote the download-task tests around startTemplateDownloadTask with a workflow JSON. They check that model jobs belong to the installation while the task is keyed separately, and that a task settles through a completed job.
  • Ported the catalog hydration tests to hydrateTemplates, and the model URL guards to resolveTemplateModelsFromJson. The input-asset parsing tests now go through resolveTemplateInputAssetSnapshot.
  • The wizard and first-use tests now use real source fields, and check that the setup plan holds only release, version and variant.
  • Ran the changed test files locally. The pre-push hook ran the full typecheck, lint and format check. CI runs the rest.

@benceruleanlu
benceruleanlu requested review from a team as code owners November 16, 2026 04:02
@coderabbitai

coderabbitai Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

Explain Change →

Caution

Review failed

The pull request is closed.

Walkthrough

The standalone setup no longer presents starter-template options or starts template downloads during installation. The retained template-download task now uses supplied workflow JSON to resolve models and input assets.

Changes: Standalone template selection

Layer / File(s) Summary
Remove the starter-template catalog and selection
locales/*.json, src/main/sources/standalone/*, src/renderer/src/lib/setupPlan.ts, src/renderer/src/views/*, src/renderer/src/panel/BuildProgressDialog.test.ts
The standalone source no longer exposes the starter-template selector or its catalog. Setup-plan selection no longer gives the bundledTemplate field special handling. Tests and locale data are updated for the removed selection.
Remove install-time template downloads and launch tray opening
src/main/host/attach.ts, src/main/index.ts, src/main/installations.ts, src/main/installations.test.ts, src/main/lib/ipc/registerInstallationHandlers.ts, src/main/lib/ipc/sessionActions/launchStarterModels.integration.test.ts, src/main/popups/titlePopup.ts, src/main/settings.ts, src/main/settings.test.ts
Installation no longer starts or aborts starter-template downloads, and launch no longer opens the Downloads tray for those downloads. Installation records no longer declare bundled-template fields. Loading settings removes the retired skipTemplatePickerStep key.
Use supplied workflows for template download tasks
src/main/sources/standalone/templateDownloadTask.ts, src/main/sources/standalone/templateDownloadTask.test.ts, src/main/sources/standalone/templateInputAssets.ts, src/main/sources/standalone/templateInputAssets.test.ts, src/main/sources/standalone/templateInputAssets.integration.test.ts, src/main/sources/standalone/templateModels.ts, src/main/sources/standalone/templateModels.test.ts
Template download tasks require workflow JSON to resolve models and input assets. Updated tests cover the workflow-based task API, asset resolution, and model URL and path validation.

Possibly related issues

  • Comfy-Org/Comfy-Desktop issue 2089 reports a crash during the bundled-template model download queue. This PR removes the install-time starter-model download path cited by the issue.

Possibly related PRs

  • Comfy-Org/Comfy-Desktop#2114: Both PRs change the starter-model download and launch flow. This PR also removes the install-time download and automatic tray-opening behavior retained in #2114.
  • Comfy-Org/Comfy-Desktop#1642: This PR removes the bundled-template installation fields and first-launch template flow that #1642 adds.
  • Comfy-Org/Comfy-Desktop#1607: The performance test page uses the retained template-download task flow, whose API now requires supplied workflow JSON.

Suggested reviewers: deepme987, maanilverma, kosinkadink

Merge Risk: Minimal · up to a6532

This change removes the unused starter-workflow install pipeline: install-time model downloads, first-open template deep links and the automatic Downloads tray. Older installation records and settings are still read safely. No concrete regression was identified, so merge-readiness risk is minimal.

- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Base automatically changed from bl/inconsistent-onboarding-starter-workflow-bd4021 to main November 16, 2026 06:13
No install path selects a starter workflow any more: first-run
onboarding dropped the step, Install on Set up skipped it since #2072,
and the New Build modal never asked. The main process still carried the
whole per-install pipeline behind the standalone `bundledTemplate`
field, so this removes it end to end:

- standalone source: no `bundledTemplate` field, options or record fields
- installation records: drop `bundledTemplateId`, `bundledTemplateSizeBytes`,
  `pendingTemplateOpen`, `downloadTemplateModels` and
  `clearPendingTemplateOpen`; attach no longer deep-links a template
- install handler no longer starts or aborts a starter-model download;
  first open no longer auto-opens the Downloads tray for it
- templateDownloadTask keeps only the task the performance test page
  runs, and now requires the workflow JSON it is given
- drop the remote starter-templates reader, the built-in curated list,
  the starter catalog loader with its live-index substitution, and the
  install-based model and input-asset resolvers
- retire the `skipTemplatePickerStep` setting through the removed-keys list
- renderer setup plan and install wizard stop special-casing the field

The performance test page keeps TemplatePickerStep, useTemplateTabs,
hydrateTemplates and its example downloads. installations.json records
that still carry the old template fields load, list and update as before.
@benceruleanlu
benceruleanlu force-pushed the bl/remove-starter-template-pipeline branch from a653223 to dd3c618 Compare November 16, 2026 06:13
@benceruleanlu
benceruleanlu merged commit 8be93b4 into main Nov 16, 2026
3 checks passed
@benceruleanlu
benceruleanlu deleted the bl/remove-starter-template-pipeline branch November 16, 2026 06:14
benceruleanlu added a commit that referenced this pull request Nov 16, 2026
…idge-types

One conflict, in the popup import list of src/main/index.ts. Main (#2136)
dropped openDownloadsTrayForInstall along with the starter-template tray
auto-open. This branch dropped the InstancePickerInstall type import,
because the type now comes from src/types/titlePopup. Both removals are
kept, so the list is registerTitlePopupIpc and
triggerPickerSnapshotBroadcast.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant