Compare commits

..

8 Commits

Author SHA1 Message Date
Austin Mroz
7954e28bb7 Fix test 2026-07-09 16:39:14 -07:00
Austin Mroz
42186132b0 Add test 2026-07-09 15:44:37 -07:00
Austin Mroz
05caa42475 Support adding descriptions to app inputs 2026-07-09 15:44:37 -07:00
Matt Miller
2ef341dcd8 test: E2E for BYOK secret add / list / delete flow (#13510)
## ELI-5

The settings screen now has a "Secrets" panel where you can save API
keys for
model/AI providers. This adds an end-to-end test that plays out the
whole story
like a real user: open the panel, add a key, watch it show up in the
list, then
delete it. It also checks the security promise — the key you type is
sent to the
server but is **never** shown back to you afterward — and that an
account without
access to the gated providers never even sees them in the dropdown.

## What

Adds `browser_tests/tests/cloudSecrets.spec.ts`, a Playwright spec
covering the
secrets (API keys) surface in the cloud app:

- **Entitled account, full CRUD round-trip:** empty state -> add a
provider key
(pick provider, name, secret value, save) -> the key appears in the list
->
  delete it via the confirm dialog -> back to empty state.
- **Secret value is write-only:** asserts the create request carried the
plaintext
value, but the value is never echoed back into the DOM (the
list-response schema
  is metadata-only).
- **Entitlement gate:** an account whose provider allowlist is empty
never sees
  the gated providers anywhere in the add dialog.

Follows the existing cloud E2E conventions: drives a raw `page` and
reuses the
`mockCloudBoot` / `bootCloud` helpers so the app boots signed-in against
fully
mocked endpoints. A small stateful in-memory handler backs the secrets
endpoints
(list / create / delete + the provider allowlist) so the flow is
deterministic
and never touches a real backend.

## Why

Verification capstone for the secrets settings surface — proves the add
/ list /
delete flow works against the documented API behavior
(`GET`/`POST`/`DELETE` on
the secrets collection, `GET` on the provider allowlist) and locks in
the two
contracts that matter: the secret value is never returned after
creation, and the
provider allowlist is the only thing that surfaces gated providers to
the user.

## Tests

- `browser_tests/tests/cloudSecrets.spec.ts` — new, two cases (tagged
`@cloud`).
- Static checks pass locally: oxlint (0 warnings/errors) and oxfmt
formatting.
- The browser run itself needs a served app + the E2E harness (CI), so
it was not
executed in this environment; the spec is self-contained and mocks all
network.

---------

Co-authored-by: GitHub Action <action@github.com>
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-09 21:20:03 +00:00
Mobeen Abdullah
1815c7f7a4 feat(website): add JSON-LD structured data across the site (#13480)
## Summary

This PR adds schema.org **JSON-LD structured data across the whole
marketing site**, built from one shared, CMS-ready module and gated by a
small CI validator. It replaces the old global block (which had a stale
logo, wrong social links, disconnected nodes, and a head slot that
rendered three times) with a single connected `@graph` on every page.
Structured data only — there is no visual or runtime change for users.
Tracks Linear **FE-1170**.

The design goal was that structured data should be impossible to get
subtly wrong: one place builds it, honesty rules are enforced in code,
and a build-time validator fails the build if any page ships a broken
`@id` graph or a fabricated price/rating.

## Changes

- **One builder, one sink.** `utils/jsonLd.ts` holds pure, node-testable
builders; `components/common/JsonLdGraph.astro` is the single escaped
`<script type="application/ld+json">` sink (prevents `</script>`
breakout XSS).
- **The layout owns the page entity.** `BaseLayout` emits a baseline
`Organization` + `WebSite` + `WebPage` graph on every page from its own
`title`/`description`/canonical props. Enriched pages pass only what is
specific to them: `pageType`, `breadcrumbs`, `mainEntityId`, and
`extraJsonLd` nodes. This makes it impossible for a page's meta tags and
its structured data to drift apart.
- **Corrected site-wide entity.** Raster PNG logo (Google does not index
SVG logos), real `sameAs` handles sourced from the footer links,
`@id`-linked `Organization`/`WebSite`, and the triple-rendered head slot
fixed.
- **Honesty is enforced, not just intended.** No fabricated
`Review`/`AggregateRating`/`Offer`. Pricing offers are parsed only from
plain `$N` copy (a future "Contact us" drops the offer instead of
shipping a garbage price). Third-party node packs and listed models do
**not** claim Comfy Org as author/publisher. `noindex` pages (404,
payment) emit no structured data.
- **CI validator.** `pnpm --filter @comfyorg/website validate:jsonld`
runs over `dist/` in the website build workflow and fails on invalid
JSON, an unresolved `@id`, a fake rating, or an empty/non-numeric offer
price.
- **Breaking:** none.

## Coverage (also a manual QA checklist for the preview)

Every public page carries at least `Organization` + `WebSite` +
`WebPage`. The pages below add a page-specific primary entity, in
**English and zh-CN**:

| Page | Path (example) | Adds to the graph |
|---|---|---|
| Home | `/`, `/zh-CN` | `SoftwareApplication` (ComfyUI, free) +
`SoftwareSourceCode` |
| Download | `/download` | `SoftwareApplication` (ComfyUI desktop) |
| Pricing | `/cloud/pricing` | `Product` + 3 monthly `Offer`s
($20/$35/$100) + Breadcrumb |
| Models catalog | `/p/supported-models` | `CollectionPage` + `ItemList`
(313, lean) + Breadcrumb |
| Model detail | `/p/supported-models/4x-ultrasharp` |
`SoftwareApplication` + `FAQPage` + Breadcrumb |
| Nodes catalog | `/cloud/supported-nodes` | `CollectionPage` +
`ItemList` (58 packs) + Breadcrumb |
| Node-pack detail | `/cloud/supported-nodes/ComfyQR` |
`SoftwareApplication` (+ free `Offer`) + Breadcrumb |
| Demos | `/demos/community-workflows` | `LearningResource` + Breadcrumb
|
| About / Contact | `/about`, `/contact` | `AboutPage` / `ContactPage`
(Org as `mainEntity`) + Breadcrumb |
| Careers | `/careers` | `CollectionPage` + `ItemList` of open roles +
Breadcrumb |
| Affiliates | `/affiliates` | `FAQPage` + Breadcrumb |

Pages deliberately left at the baseline `WebPage` (generic landings,
legal, coming-soon) and pages with **no** structured data (`noindex`:
`/404`, `/payment/*`; redirect URLs) are intentional.

## Review Focus

- **Layout-owns-WebPage design.** `BaseLayout` builds the `WebPage`;
pages contribute only extra nodes. This is the main structural decision
and is what removes meta-vs-schema drift by construction.
- **Honesty guardrails.** Worth confirming: pricing offers, third-party
author omission on packs/models, and that `noindex` pages emit nothing.
- **`@id` and URL consistency.** All cross-page links and `@id`s resolve
to the canonical trailing-slash form; zh-CN breadcrumbs are rooted under
`/zh-CN`; the singleton `WebSite`/`#software` entities carry one
consistent definition across pages and locales.
- **The validator.** It is a bespoke ~100-line script scoped to the
website build job (not the prod deploy). Happy to make it non-blocking
or drop it if the team prefers.
- **Coordination with #13468.** Both branches add
`components/common/JsonLdGraph.astro`. Customer pages are intentionally
excluded here; #13468 can converge onto this shared builder.

## Verification

`astro check` 0 errors · 166 unit tests · `knip` 0 · `eslint` 0 · build
497 pages · validator passes across 500 pages · JSON-LD e2e specs 24/24.
(The 3 pre-existing demo e2e timeouts are an external Arcade-embed flake
on one slug, reproduced identically on `main`.)

## Screenshots

Not applicable — head-only structured data, no visual change. Validate
on the Vercel preview with the Rich Results Test and the schema.org
validator. Note: `@id`/URL values render as `comfy.org` (from
`astro.config` `site`) even on the preview host, which is correct.
2026-07-09 21:03:43 +00:00
imick-io
287b9eb980 feat(website): add HeroBackdrop01 block component (#13549)
## Summary

Adds the `HeroBackdrop01` hero block component to the website app. This
lands the component on its own so it can be merged to `main` ahead of
the EDU page work (on another branch) that consumes it.

The component renders a responsive hero with an optional image/video
backdrop (in-flow rounded card on mobile, full-bleed background on
desktop), an optional product badge, title, subtitle, and footnote. It
respects `prefers-reduced-motion` by not autoplaying the looping
backdrop video (WCAG 2.2.2).

## Notes

- No consumer imports the component yet — it is intentionally added
ahead of the page that will use it. The `knip` unused-file check flags
this, which is expected for this staging PR.
- Depends on existing `useReducedMotion` composable and
`ProductHeroBadge` component, both already present on `main`.

## Test plan

- [ ] `pnpm typecheck:website` passes (verified locally via pre-commit
hook)
- [ ] Component renders correctly once wired into a page

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-09 20:43:49 +00:00
Matt Miller
06b0471257 test: pin unknown-provider flow-through in server-driven provider options (#13546)
## ELI-5

The provider picker for BYOK secrets is now driven by the server's
`availableProviders` list, not a hardcoded frontend list. The point is
that a provider the server offers but the frontend has never heard of
should still show up — using its raw id as the label and no logo. This
adds the one test that actually pins that behavior, so nobody can later
re-add a "only show providers the frontend knows about" filter without a
test going red.

## Summary

Regression test for the server-driven provider options introduced in
#13509: asserts that an unknown provider id passes through
`providerOptions` rather than being filtered against the local
presentational registry.

## Changes

- **What**: Adds one `useSecretForm.test.ts` case asserting that a
create-mode `availableProviders` list containing an id absent from the
local `SECRET_PROVIDERS` registry (`'brand-new-provider'`) yields a
single `providerOptions` entry rendered with the raw id as its label and
`logo: undefined`.

## Review Focus

The existing suite already covers the registry fallback
(`providers.test.ts`) and server-listed *known* ids (`runway`/`gemini`),
but every one of those cases uses an id that exists in the local
registry — so a future change that re-filtered `availableProviders`
against `SECRET_PROVIDERS` could pass all current tests while silently
dropping unknown providers. This test closes that gap by using an id
that is deliberately absent from the registry, so it fails if
pass-through is ever broken. Follow-up to the optional review ask on
#13509. Test-only; no production code changes.
2026-07-09 19:20:56 +00:00
Maanil Verma
8120142f49 feat(cloud): redesign the cloud onboarding survey (#13518)
## Summary

New users get a cleaner, faster onboarding survey: one question per
screen on tappable cards that advance the moment you pick an answer,
with follow-up questions that appear only when they're relevant. The
questions themselves were reworked to learn what people actually want to
do with ComfyUI.

## Changes

**What**

- Replaced the radio/checkbox list with a card-based,
one-question-at-a-time wizard. Choosing a single-select answer advances
automatically — no separate Next click — while multi-select and
free-text steps still wait for you to confirm.
- Reworked the question set: what you want to make, how well you know
ComfyUI, and how you found us. Two questions are now conditional — a
"what are you building?" follow-up appears only for workflow/API
builders, and a "which platform?" follow-up appears only when you say
you found us on social media.
- Added an "other" free-text escape hatch to the intent and source
questions, required before you can move on so we don't capture an empty
"other".
- Polished the whole surface to the comfy-canvas theme with animated
step-height and cross-fade transitions between questions, and hid the
marketing hero on the survey and user-check routes so the form has room.
- Errors now surface only after you've interacted with a field, not on
first paint.
- Extended the telemetry survey-response and remote-config option shapes
to carry the new fields (including per-option icons), leaving the older
fields in place so historical responses still typecheck.

**Breaking** — None. The remote-config survey schema stays
backend-overridable, hidden branch answers are zeroed in the submitted
payload, and the telemetry field names line up 1:1 with the schema. The
backend dynamic config already ships the matching version-3 schema.


## Testing

Behavioral coverage over the wizard's real interactions rather than DOM
structure, since the risk is in navigation/branching/validation, not
markup. `vue-i18n` is mounted for real with the actual locale file so
tests assert on rendered copy.

-
[DynamicSurveyForm.test.ts](src/platform/cloud/onboarding/survey/DynamicSurveyForm.test.ts)
— auto-advance on single-select, no-advance on multi/other, Back
navigation, branch reveal/hide and its submitted payload,
required-"other" gating, post-interaction error surfacing, and
survey-prop reset.
-
[DynamicSurveyField.test.ts](src/platform/cloud/onboarding/survey/DynamicSurveyField.test.ts)
— card rendering/selection state, stable option ids, multi-select emit,
the conditional "other" input, and label resolution via key / locale map
/ id fallback.
-
[surveySchema.test.ts](src/platform/cloud/onboarding/survey/surveySchema.test.ts)
— default-schema branching (which steps show), hidden-field zeroing and
free-text-over-sentinel in the payload, and the shared
`hasNonEmptyValue` truth table.

Gates: `vue-tsc` typecheck clean; eslint/oxfmt clean on touched files;
survey suite green (68 tests across the three files). Manual: run the
cloud onboarding flow, pick a workflow/apps intent to confirm the
"building" follow-up, pick social to confirm the platform follow-up, and
verify an empty "other" blocks advancing.

## Screen Recording



https://github.com/user-attachments/assets/1908ca18-93d1-41a2-a55b-1f04a6df2268
2026-07-09 18:31:52 +00:00
90 changed files with 3399 additions and 1599 deletions

View File

@@ -40,3 +40,6 @@ jobs:
WEBSITE_ASHBY_API_KEY: ${{ secrets.WEBSITE_ASHBY_API_KEY }}
WEBSITE_ASHBY_JOB_BOARD_NAME: ${{ secrets.WEBSITE_ASHBY_JOB_BOARD_NAME }}
run: pnpm --filter @comfyorg/website build
- name: Validate JSON-LD structured data
run: pnpm --filter @comfyorg/website validate:jsonld

View File

@@ -76,10 +76,14 @@ test.describe('Affiliates landing — desktop interactions', () => {
return match?.textContent ?? null
})
expect(faqJsonLd, 'FAQ JSON-LD script').not.toBeNull()
const parsed = JSON.parse(faqJsonLd!)
expect(parsed['@type']).toBe('FAQPage')
expect(Array.isArray(parsed.mainEntity)).toBe(true)
expect(parsed.mainEntity.length).toBe(FAQ_COUNT)
const graph = JSON.parse(faqJsonLd!)['@graph'] as {
'@type': string
mainEntity?: unknown[]
}[]
const faqPage = graph.find((node) => node['@type'] === 'FAQPage')
expect(faqPage, 'FAQPage node in @graph').toBeDefined()
expect(Array.isArray(faqPage!.mainEntity)).toBe(true)
expect(faqPage!.mainEntity!.length).toBe(FAQ_COUNT)
})
test('Apply Now CTA opens the application form in a new tab', async ({

View File

@@ -17,7 +17,8 @@
"test:visual:update": "playwright test --project visual --update-snapshots",
"ashby:refresh-snapshot": "tsx ./scripts/refresh-ashby-snapshot.ts",
"cloud-nodes:refresh-snapshot": "tsx ./scripts/refresh-cloud-nodes-snapshot.ts",
"generate:models": "tsx ./scripts/generate-models.ts"
"generate:models": "tsx ./scripts/generate-models.ts",
"validate:jsonld": "tsx ./scripts/validate-jsonld.ts"
},
"dependencies": {
"@astrojs/sitemap": "catalog:",

View File

@@ -0,0 +1,129 @@
import { readFileSync, readdirSync } from 'node:fs'
import { join } from 'node:path'
import { collectGraphIds } from '../src/utils/jsonLd'
const DIST_DIR = join(process.cwd(), 'dist')
const JSON_LD_BLOCK =
/<script[^>]*type=["']application\/ld\+json["'][^>]*>([\s\S]*?)<\/script>/gi
interface Violation {
file: string
message: string
}
function htmlFiles(dir: string): string[] {
return readdirSync(dir, { recursive: true })
.map(String)
.filter((entry) => entry.endsWith('.html'))
.map((entry) => join(dir, entry))
}
function typesOf(node: Record<string, unknown>): string[] {
const type = node['@type']
if (typeof type === 'string') return [type]
if (Array.isArray(type)) {
return type.filter((t): t is string => typeof t === 'string')
}
return []
}
function hasValidPrice(node: Record<string, unknown>): boolean {
const price = node.price
const priceStr = price == null ? '' : String(price).trim()
return priceStr !== '' && !Number.isNaN(Number(priceStr))
}
function checkHonesty(
value: unknown,
file: string,
violations: Violation[]
): void {
const walk = (node: unknown): void => {
if (Array.isArray(node)) {
node.forEach(walk)
return
}
if (!node || typeof node !== 'object') return
const record = node as Record<string, unknown>
const types = typesOf(record)
if (types.includes('Review') || types.includes('AggregateRating')) {
violations.push({
file,
message: `dishonest node type ${types.join('/')}`
})
}
if ('aggregateRating' in record || 'review' in record) {
violations.push({
file,
message: 'node carries a review/aggregateRating'
})
}
if (
types.includes('Offer') &&
(!hasValidPrice(record) || !record.priceCurrency)
) {
violations.push({
file,
message: 'Offer missing priceCurrency or a concrete price'
})
}
Object.values(record).forEach(walk)
}
walk(value)
}
function validateFile(file: string): Violation[] {
const html = readFileSync(file, 'utf8')
const violations: Violation[] = []
const definedIds = new Set<string>()
const referencedIds: string[] = []
for (const match of html.matchAll(JSON_LD_BLOCK)) {
let parsed: unknown
try {
parsed = JSON.parse(match[1])
} catch (error) {
violations.push({ file, message: `invalid JSON-LD: ${String(error)}` })
continue
}
checkHonesty(parsed, file, violations)
const { defined, references } = collectGraphIds(parsed)
defined.forEach((id) => definedIds.add(id))
referencedIds.push(...references)
}
for (const id of referencedIds) {
if (!definedIds.has(id)) {
violations.push({ file, message: `unresolved @id reference: ${id}` })
}
}
return violations
}
function main(): void {
const files = htmlFiles(DIST_DIR)
if (files.length === 0) {
console.error(
`JSON-LD validation found no HTML in ${DIST_DIR} — build first.`
)
process.exit(1)
}
const violations = files.flatMap(validateFile)
if (violations.length > 0) {
console.error(`JSON-LD validation failed (${violations.length} issue(s)):`)
for (const { file, message } of violations) {
console.error(` ${file.replace(DIST_DIR, 'dist')}: ${message}`)
}
process.exit(1)
}
process.stdout.write(
`JSON-LD validation passed across ${files.length} page(s).\n`
)
}
main()

View File

@@ -0,0 +1,41 @@
import type { Meta, StoryObj } from '@storybook/vue3-vite'
import HeroBackdrop01 from './HeroBackdrop01.vue'
const sampleImage =
'https://images.unsplash.com/photo-1451187580459-43490279c0fa?auto=format&fit=crop&w=1600&q=80'
const meta: Meta<typeof HeroBackdrop01> = {
title: 'Website/Blocks/HeroBackdrop01',
component: HeroBackdrop01,
tags: ['autodocs'],
args: {
backdrop: { type: 'image', src: sampleImage, alt: 'Abstract gradient' },
title: 'Build anything\nwith ComfyUI',
subtitle:
'A powerful, modular visual interface for building and running AI workflows.'
}
}
export default meta
type Story = StoryObj<typeof meta>
export const Default: Story = {}
export const WithBadge: Story = {
args: {
badgeText: 'New'
}
}
export const WithFootnote: Story = {
args: {
footnote: 'Available on Windows, macOS, and Linux.'
}
}
export const NoBackdrop: Story = {
args: {
backdrop: undefined
}
}

View File

@@ -0,0 +1,193 @@
<script setup lang="ts">
import { cn } from '@comfyorg/tailwind-utils'
import { computed } from 'vue'
import type { HTMLAttributes } from 'vue'
import { prefersReducedMotion } from '../../composables/useReducedMotion'
import ProductHeroBadge from '../common/ProductHeroBadge.vue'
type Backdrop =
| { type: 'image'; src: string; alt?: string }
| { type: 'video'; src: string; poster?: string; alt?: string }
const {
backdrop,
mobileBackdrop,
badgeText,
badgeLogoSrc,
badgeLogoAlt,
title,
subtitle,
footnote,
class: className
} = defineProps<{
backdrop?: Backdrop
mobileBackdrop?: Backdrop
badgeText?: string
badgeLogoSrc?: string
badgeLogoAlt?: string
title: string
subtitle?: string
footnote?: string
class?: HTMLAttributes['class']
}>()
// Respect prefers-reduced-motion: don't autoplay the looping backdrop video
// (WCAG 2.2.2). The paused video falls back to its poster/first frame.
const reduceMotion = computed(() => prefersReducedMotion())
// Removing the reactive `autoplay` attribute only suppresses the *initial*
// play; it can't pause a video the browser has already started. That is
// exactly the SSR case: the server renders `autoplay` (it can't read the
// client's motion preference), the browser begins playback on parse, and the
// post-hydration attribute removal is too late. Pause on mount so
// reduced-motion users get the poster frame instead of a looping video.
const pauseIfReduced = (el: unknown) => {
if (el instanceof HTMLVideoElement && reduceMotion.value) el.pause()
}
// On mobile the backdrop is an in-flow rounded card above the content; on
// desktop it is the full-bleed background behind it. A single element serves
// both roles via responsive classes — mobileBackdrop only swaps the source.
const sharedBackdropClass =
'relative aspect-3/2 w-full rounded-3xl object-cover lg:absolute lg:inset-0 lg:aspect-auto lg:size-full lg:rounded-none'
// When both breakpoints use images, serve them from a single responsive <img>
// so the browser fetches only the source matching the viewport. Two
// `hidden`/`lg:hidden`-toggled <img> layers would each download (display:none
// does not stop the fetch), doubling the high-priority load on an
// LCP-critical hero. Videos or a mixed image/video pair can't collapse this
// way and fall back to breakpoint-toggled layers below.
const responsiveImage = computed(() => {
if (backdrop?.type !== 'image') return null
if (mobileBackdrop && mobileBackdrop.type !== 'image') return null
const base = mobileBackdrop ?? backdrop
return {
src: base.src,
alt: backdrop.alt ?? mobileBackdrop?.alt ?? '',
// Larger-viewport source; omitted when one image serves both breakpoints.
desktopSrc: mobileBackdrop ? backdrop.src : undefined
}
})
// Fallback for videos and mixed image/video pairs: toggle assets by breakpoint.
const backdropLayers = computed(() => {
if (!backdrop) return []
if (mobileBackdrop) {
return [
{
backdrop: mobileBackdrop,
class: 'relative aspect-3/2 w-full rounded-3xl object-cover lg:hidden'
},
{
backdrop,
class: 'absolute inset-0 hidden size-full object-cover lg:block'
}
]
}
return [{ backdrop, class: sharedBackdropClass }]
})
const scrimShape = 'farthest-side at 50% 50%'
const scrimStyle = {
background: `radial-gradient(${scrimShape}, color-mix(in srgb, var(--color-primary-warm-white) 80%, transparent) 0%, transparent 80%)`,
maskImage: `radial-gradient(${scrimShape}, #000 45%, transparent 90%)`,
WebkitMaskImage: `radial-gradient(${scrimShape}, #000 45%, transparent 90%)`
}
</script>
<template>
<section
:class="cn('max-w-9xl mx-auto px-4 pt-4 lg:px-6 lg:pt-6', className)"
>
<div class="relative overflow-hidden rounded-3xl">
<slot name="backdrop">
<picture v-if="responsiveImage" class="contents">
<source
v-if="responsiveImage.desktopSrc"
:srcset="responsiveImage.desktopSrc"
media="(min-width: 1024px)"
/>
<img
:src="responsiveImage.src"
:alt="responsiveImage.alt"
fetchpriority="high"
decoding="async"
:class="sharedBackdropClass"
/>
</picture>
<template v-else>
<template v-for="(layer, i) in backdropLayers" :key="i">
<video
v-if="layer.backdrop.type === 'video'"
:ref="pauseIfReduced"
:src="layer.backdrop.src"
:poster="layer.backdrop.poster"
:aria-label="layer.backdrop.alt"
:aria-hidden="layer.backdrop.alt ? undefined : true"
:autoplay="!reduceMotion"
loop
muted
playsinline
preload="metadata"
:class="layer.class"
/>
<img
v-else
:src="layer.backdrop.src"
:alt="layer.backdrop.alt ?? ''"
fetchpriority="high"
decoding="async"
:class="layer.class"
/>
</template>
</template>
</slot>
<div
class="relative flex flex-col justify-center px-0 pt-6 pb-8 lg:min-h-176 lg:px-16 lg:py-24"
>
<div class="relative w-full max-w-xl">
<div
aria-hidden="true"
class="pointer-events-none absolute -inset-12 hidden backdrop-blur-md lg:-inset-16 lg:block"
:style="scrimStyle"
/>
<div class="relative">
<ProductHeroBadge
v-if="badgeText"
:text="badgeText"
:logo-src="badgeLogoSrc"
:logo-alt="badgeLogoAlt"
/>
<h1
class="mt-10 text-4xl/tight font-light tracking-tight whitespace-pre-line text-primary-comfy-canvas lg:text-6xl/tight lg:text-primary-comfy-ink"
>
{{ title }}
</h1>
<p
v-if="subtitle"
class="mt-8 max-w-md text-base text-primary-comfy-canvas lg:text-lg lg:text-primary-comfy-ink"
>
{{ subtitle }}
</p>
<p
v-if="footnote"
class="mt-10 text-sm text-primary-comfy-canvas lg:text-primary-comfy-ink"
>
{{ footnote }}
</p>
<slot />
</div>
</div>
</div>
</div>
</section>
</template>

View File

@@ -0,0 +1,12 @@
---
import type { JsonLdGraph } from '../../utils/jsonLd'
import { escapeJsonLd } from '../../utils/escapeJsonLd'
interface Props {
graph: JsonLdGraph
}
const { graph } = Astro.props
---
<script is:inline type="application/ld+json" set:html={escapeJsonLd(graph)} />

View File

@@ -0,0 +1,53 @@
import { t } from '../i18n/translations'
import type { Locale, TranslationKey } from '../i18n/translations'
import { externalLinks } from './routes'
interface PricingTier {
slug: string
labelKey: TranslationKey
priceKey: TranslationKey
}
const tiers: PricingTier[] = [
{
slug: 'standard',
labelKey: 'pricing.plan.standard.label',
priceKey: 'pricing.plan.standard.price'
},
{
slug: 'creator',
labelKey: 'pricing.plan.creator.label',
priceKey: 'pricing.plan.creator.price'
},
{
slug: 'pro',
labelKey: 'pricing.plan.pro.label',
priceKey: 'pricing.plan.pro.price'
}
]
export interface PricingOffer {
name: string
price: string
url: string
}
export function pricingOffers(locale: Locale): PricingOffer[] {
return tiers.flatMap((tier) => {
const display = t(tier.priceKey, locale).trim()
const match = /^\$(\d+(?:\.\d+)?)$/.exec(display)
if (!match) {
console.warn(
`pricingOffers: skipping tier "${tier.slug}" (${locale}) — price "${display}" is not a plain USD amount`
)
return []
}
return [
{
name: t(tier.labelKey, locale),
price: match[1],
url: `${externalLinks.cloud}/cloud/subscribe?tier=${tier.slug}&cycle=monthly`
}
]
})
}

View File

@@ -82,14 +82,19 @@ export const externalLinks = {
docsApi: 'https://docs.comfy.org/development/cloud/overview#quick-start',
docsMcp: 'https://docs.comfy.org/agent-tools/cloud',
docsSubscription: 'https://docs.comfy.org/support/subscription/subscribing',
g2ComfyUi: 'https://www.g2.com/products/comfyui',
github: 'https://github.com/Comfy-Org/ComfyUI',
githubInstall: 'https://github.com/Comfy-Org/ComfyUI#installing',
instagram: 'https://www.instagram.com/comfyui/',
linkedin: 'https://www.linkedin.com/company/comfyui',
mcpSkills: 'https://github.com/Comfy-Org/comfy-skills',
platform: 'https://platform.comfy.org',
platformUsage: 'https://platform.comfy.org/profile/usage',
reddit: 'https://www.reddit.com/r/comfyui/',
support: 'https://support.comfy.org/hc/en-us',
wikidataComfyOrg: 'https://www.wikidata.org/wiki/Q130598554',
wikidataComfyUi: 'https://www.wikidata.org/wiki/Q127798647',
wikipediaComfyUi: 'https://en.wikipedia.org/wiki/ComfyUI',
workflows: 'https://comfy.org/workflows',
x: 'https://x.com/ComfyUI',
youtube: 'https://www.youtube.com/@ComfyOrg'

View File

@@ -2190,6 +2190,13 @@ const translations = {
'nav.ctaCloudPrefix': { en: 'LAUNCH', 'zh-CN': '启动' },
'nav.ctaCloudCore': { en: 'CLOUD', 'zh-CN': '云端' },
'nav.home': { en: 'Comfy home', 'zh-CN': 'Comfy 首页' },
'breadcrumb.home': { en: 'Home', 'zh-CN': '首页' },
'breadcrumb.about': { en: 'About Us', 'zh-CN': '关于我们' },
'breadcrumb.contact': { en: 'Contact', 'zh-CN': '联系我们' },
'breadcrumb.download': { en: 'Download', 'zh-CN': '下载' },
'breadcrumb.careers': { en: 'Careers', 'zh-CN': '招聘' },
'breadcrumb.pricing': { en: 'Pricing', 'zh-CN': '定价' },
'breadcrumb.supportedNodes': { en: 'Supported Nodes', 'zh-CN': '支持的节点' },
'nav.menu': { en: 'Menu', 'zh-CN': '菜单' },
'nav.toggleMenu': { en: 'Toggle menu', 'zh-CN': '切换菜单' },
'nav.close': { en: 'Close', 'zh-CN': '关闭' },
@@ -4061,7 +4068,6 @@ const translations = {
en: 'This page is being redesigned. Check back soon.',
'zh-CN': '此页面正在重新设计中,请稍后再来。'
},
'demos.breadcrumb.home': { en: 'Home', 'zh-CN': '首页' },
'demos.breadcrumb.demos': { en: 'Demos', 'zh-CN': '演示' },
'customers.story.whatsNext': {
@@ -4157,10 +4163,6 @@ const translations = {
en: "Run the world's leading AI models in ComfyUI",
'zh-CN': '在 ComfyUI 中运行世界领先的 AI 模型'
},
'models.breadcrumb.home': {
en: 'Home',
'zh-CN': '首页'
},
'models.breadcrumb.models': {
en: 'Supported Models',
'zh-CN': '支持的模型'

View File

@@ -14,8 +14,10 @@ import {
createBannerVersion,
evaluateBannerVisibility
} from '../utils/banner'
import { escapeJsonLd } from '../utils/escapeJsonLd'
import { fetchGitHubStars, formatStarCount } from '../utils/github'
import { buildPageGraph, pageContext } from '../utils/jsonLd'
import type { Crumb, JsonLdNode, WebPageType } from '../utils/jsonLd'
import JsonLdGraph from '../components/common/JsonLdGraph.astro'
interface Props {
title: string
@@ -23,6 +25,10 @@ interface Props {
keywords?: string[]
ogImage?: string
noindex?: boolean
pageType?: WebPageType
breadcrumbs?: Crumb[]
mainEntityId?: string
extraJsonLd?: (JsonLdNode | null | undefined)[]
}
const {
@@ -31,15 +37,21 @@ const {
keywords,
ogImage = 'https://media.comfy.org/website/comfy.webp',
noindex = false,
pageType,
breadcrumbs,
mainEntityId,
extraJsonLd,
} = Astro.props
const keywordsContent = keywords && keywords.length > 0 ? keywords.join(', ') : undefined
const siteBase = Astro.site ?? 'https://comfy.org'
const canonicalURL = new URL(Astro.url.pathname, siteBase)
const ogImageURL = new URL(ogImage, siteBase)
const rawLocale = Astro.currentLocale ?? 'en'
const locale: Locale = rawLocale === 'zh-CN' ? 'zh-CN' : 'en'
const { siteUrl, locale, url } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
const canonicalURL = new URL(url)
const ogImageURL = new URL(ogImage, Astro.site ?? 'https://comfy.org')
const rawStars = await fetchGitHubStars('Comfy-Org', 'ComfyUI')
const githubStars = rawStars ? formatStarCount(rawStars) : ''
@@ -58,28 +70,21 @@ const bannerVersion = createBannerVersion(bannerData, locale)
const gtmId = 'GTM-NP9JM6K7'
const gtmEnabled = import.meta.env.PROD
const organizationJsonLd = {
'@context': 'https://schema.org',
'@type': 'Organization',
name: 'Comfy Org',
url: 'https://comfy.org',
logo: 'https://comfy.org/icons/logomark.svg',
sameAs: [
'https://github.com/comfyanonymous/ComfyUI',
'https://discord.gg/comfyorg',
'https://x.com/comaboratory',
'https://reddit.com/r/comfyui',
'https://linkedin.com/company/comfyorg',
'https://instagram.com/comfyorg',
],
}
const websiteJsonLd = {
'@context': 'https://schema.org',
'@type': 'WebSite',
name: 'Comfy',
url: 'https://comfy.org',
}
const structuredData = noindex
? undefined
: buildPageGraph(
{ siteUrl, locale },
{
url,
name: title,
description,
imageUrl: ogImageURL.href,
type: pageType,
crumbs: breadcrumbs,
mainEntityId,
},
...(extraJsonLd ?? []),
)
---
<!doctype html>
@@ -121,10 +126,7 @@ const websiteJsonLd = {
<meta name="twitter:image" content={ogImageURL.href} />
<!-- Structured Data -->
<script is:inline type="application/ld+json" set:html={escapeJsonLd(organizationJsonLd)} />
<script is:inline type="application/ld+json" set:html={escapeJsonLd(websiteJsonLd)} />
<slot name="head" />
{structuredData && <JsonLdGraph graph={structuredData} />}
<slot name="head" />
<!-- Google Tag Manager -->
@@ -144,7 +146,6 @@ const websiteJsonLd = {
)}
<ClientRouter />
<slot name="head" />
<!-- Hide an already-dismissed announcement banner before first paint (no flash/shift). -->
{bannerVisible && (

View File

@@ -5,9 +5,25 @@ import StorySection from '../components/about/StorySection.vue'
import OurValuesSection from '../components/about/OurValuesSection.vue'
import ValuesSection from '../components/about/ValuesSection.vue'
import CareersSection from '../components/about/CareersSection.vue'
import { t } from '../i18n/translations'
import { absoluteUrl, organizationId, pageContext } from '../utils/jsonLd'
const { siteUrl, locale } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
---
<BaseLayout title="About Us — Comfy">
<BaseLayout
title="About Us — Comfy"
pageType="AboutPage"
mainEntityId={organizationId(siteUrl)}
breadcrumbs={[
{ name: t('breadcrumb.home', locale), url: absoluteUrl(Astro.site, '/') },
{ name: t('breadcrumb.about', locale) },
]}
>
<HeroSection client:load />
<StorySection />
<OurValuesSection />

View File

@@ -9,34 +9,36 @@ import HeroSection from '../../templates/affiliate/HeroSection.vue'
import HowItWorksSection from '../../templates/affiliate/HowItWorksSection.vue'
import { affiliateFaqs } from '../../data/affiliateFaq'
import { t } from '../../i18n/translations'
import type { JsonLdNode } from '../../utils/jsonLd'
import { absoluteUrl, jsonLdId, pageContext } from '../../utils/jsonLd'
const locale = 'en' as const
const faqJsonLd = {
'@context': 'https://schema.org',
const pageTitle = t('affiliate.page.title', 'en')
const pageDescription = t('affiliate.page.description', 'en')
const { locale, url } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
const faqPage: JsonLdNode = {
'@type': 'FAQPage',
'@id': jsonLdId(url, 'faq'),
mainEntity: affiliateFaqs.map((faq) => ({
'@type': 'Question',
name: faq.question[locale],
acceptedAnswer: {
'@type': 'Answer',
text: faq.answer[locale]
}
}))
acceptedAnswer: { '@type': 'Answer', text: faq.answer[locale] },
})),
}
---
<BaseLayout
title={t('affiliate.page.title', locale)}
description={t('affiliate.page.description', locale)}
title={pageTitle}
description={pageDescription}
breadcrumbs={[
{ name: t('breadcrumb.home', locale), url: absoluteUrl(Astro.site, '/') },
{ name: pageTitle },
]}
extraJsonLd={[faqPage]}
>
<Fragment slot="head">
<script
is:inline
type="application/ld+json"
set:html={JSON.stringify(faqJsonLd)}
/>
</Fragment>
<HeroSection />
<HowItWorksSection />

View File

@@ -7,6 +7,13 @@ import TeamPhotosSection from '../components/careers/TeamPhotosSection.vue'
import FAQSection from '../components/common/FAQSection.vue'
import { fetchRolesForBuild } from '../utils/ashby'
import { reportAshbyOutcome } from '../utils/ashby.ci'
import { t } from '../i18n/translations'
import {
absoluteUrl,
itemListNode,
jsonLdId,
pageContext,
} from '../utils/jsonLd'
const outcome = await fetchRolesForBuild()
reportAshbyOutcome(outcome)
@@ -19,11 +26,31 @@ if (outcome.status === 'failed') {
}
const departments = outcome.snapshot.departments
const { siteUrl, locale, url } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
const roles = itemListNode(
url,
t('breadcrumb.careers', locale),
departments.flatMap((department) =>
department.roles.map((role) => ({ name: role.title, url: role.jobUrl })),
),
)
---
<BaseLayout
title="Careers — Comfy"
description="Join the team building the operating system for generative AI. Open roles in engineering, design, marketing, and more."
pageType="CollectionPage"
mainEntityId={jsonLdId(url, 'itemlist')}
breadcrumbs={[
{ name: t('breadcrumb.home', locale), url: absoluteUrl(Astro.site, '/') },
{ name: t('breadcrumb.careers', locale) },
]}
extraJsonLd={[roles]}
>
<HeroSection />
<RolesSection departments={departments} client:visible />

View File

@@ -2,9 +2,41 @@
import BaseLayout from '../../layouts/BaseLayout.astro'
import PriceSection from '../../components/pricing/PriceSection.vue'
import WhatsIncludedSection from '../../components/pricing/WhatsIncludedSection.vue'
import { pricingOffers } from '../../config/pricing'
import { t } from '../../i18n/translations'
import {
absoluteUrl,
jsonLdId,
pageContext,
productNode,
} from '../../utils/jsonLd'
const { siteUrl, locale, url } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
const productId = jsonLdId(url, 'product')
---
<BaseLayout title="Pricing — Comfy Cloud">
<BaseLayout
title="Pricing — Comfy Cloud"
mainEntityId={productId}
breadcrumbs={[
{ name: t('breadcrumb.home', locale), url: absoluteUrl(Astro.site, '/') },
{ name: 'Comfy Cloud', url: absoluteUrl(Astro.site, '/cloud') },
{ name: t('breadcrumb.pricing', locale) },
]}
extraJsonLd={[
productNode({
siteUrl,
id: productId,
name: 'Comfy Cloud',
url,
offers: pricingOffers(locale),
}),
]}
>
<PriceSection client:load />
<WhatsIncludedSection />
</BaseLayout>

View File

@@ -4,39 +4,44 @@ import HeroSection from '../../components/cloud-nodes/HeroSection.vue'
import PackGridSection from '../../components/cloud-nodes/PackGridSection.vue'
import { t } from '../../i18n/translations'
import { loadPacksForBuild } from '../../utils/cloudNodes.build'
import { escapeJsonLd } from '../../utils/escapeJsonLd'
import {
absoluteUrl,
itemListNode,
jsonLdId,
pageContext,
} from '../../utils/jsonLd'
const packs = await loadPacksForBuild()
const siteBase = Astro.site ?? new URL('https://comfy.org')
const pageUrl = new URL('/cloud/supported-nodes', siteBase).href
const itemListJsonLd = {
'@context': 'https://schema.org',
'@type': 'ItemList',
name: 'Custom-node packs supported on Comfy Cloud',
url: pageUrl,
numberOfItems: packs.length,
itemListElement: packs.map((pack, index) => ({
'@type': 'ListItem',
position: index + 1,
url: new URL(`/cloud/supported-nodes/${pack.id}`, siteBase).href,
const title = t('cloudNodes.meta.title', 'en')
const description = t('cloudNodes.meta.description', 'en')
const { url, locale } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
const packList = itemListNode(
url,
title,
packs.map((pack) => ({
name: pack.displayName,
image: pack.bannerUrl || pack.iconUrl
}))
}
url: absoluteUrl(Astro.site, `/cloud/supported-nodes/${pack.id}`),
})),
)
---
<BaseLayout
title={t('cloudNodes.meta.title', 'en')}
description={t('cloudNodes.meta.description', 'en')}
title={title}
description={description}
pageType="CollectionPage"
mainEntityId={jsonLdId(url, 'itemlist')}
breadcrumbs={[
{ name: t('breadcrumb.home', locale), url: absoluteUrl(Astro.site, '/') },
{ name: 'Comfy Cloud', url: absoluteUrl(Astro.site, '/cloud') },
{ name: t('breadcrumb.supportedNodes', locale) },
]}
extraJsonLd={[packList]}
>
<script
is:inline
slot="head"
type="application/ld+json"
set:html={escapeJsonLd(itemListJsonLd)}
/>
<HeroSection client:visible />
<PackGridSection packs={packs} client:visible />
</BaseLayout>

View File

@@ -7,7 +7,12 @@ import PackDetail from '../../../components/cloud-nodes/PackDetail.vue'
import BaseLayout from '../../../layouts/BaseLayout.astro'
import { t } from '../../../i18n/translations'
import { loadPacksForBuild } from '../../../utils/cloudNodes.build'
import { escapeJsonLd } from '../../../utils/escapeJsonLd'
import {
absoluteUrl,
jsonLdId,
pageContext,
softwareApplicationNode,
} from '../../../utils/jsonLd'
export const getStaticPaths: GetStaticPaths = async () => {
const packs = await loadPacksForBuild()
@@ -29,35 +34,45 @@ const metaDescription = t('cloudNodes.detail.metaDescription', 'en')
.replace('{nodeCount}', String(pack.nodes.length))
.replace('{description}', description)
const siteBase = Astro.site ?? new URL('https://comfy.org')
const pageUrl = new URL(`/cloud/supported-nodes/${pack.id}`, siteBase).href
const softwareJsonLd = {
'@context': 'https://schema.org',
'@type': 'SoftwareApplication',
const { siteUrl, locale, url } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
const softwareId = jsonLdId(url, 'software')
const software = softwareApplicationNode({
siteUrl,
id: softwareId,
name: pack.displayName,
url,
applicationCategory: 'DeveloperApplication',
applicationSubCategory: 'ComfyUI custom-node pack',
operatingSystem: 'Comfy Cloud (managed)',
url: pageUrl,
description,
description: pack.description || undefined,
image: pack.bannerUrl || pack.iconUrl,
softwareVersion: pack.latestVersion,
license: pack.license,
codeRepository: pack.repoUrl,
author: pack.publisher?.name
? { '@type': 'Person', name: pack.publisher.name }
: undefined,
offers: { '@type': 'Offer', price: 0, priceCurrency: 'USD' }
}
authorName: pack.publisher?.name,
isFree: true,
})
---
<BaseLayout title={title} description={metaDescription} ogImage={pack.bannerUrl}>
<script
is:inline
slot="head"
type="application/ld+json"
set:html={escapeJsonLd(softwareJsonLd)}
/>
<BaseLayout
title={title}
description={metaDescription}
ogImage={pack.bannerUrl}
mainEntityId={softwareId}
breadcrumbs={[
{ name: t('breadcrumb.home', locale), url: absoluteUrl(Astro.site, '/') },
{ name: 'Comfy Cloud', url: absoluteUrl(Astro.site, '/cloud') },
{
name: t('breadcrumb.supportedNodes', locale),
url: absoluteUrl(Astro.site, '/cloud/supported-nodes'),
},
{ name: pack.displayName },
]}
extraJsonLd={[software]}
>
<PackDetail pack={pack} />
</BaseLayout>

View File

@@ -2,9 +2,25 @@
import BaseLayout from '../layouts/BaseLayout.astro'
import FormSection from '../components/contact/FormSection.vue'
import SocialProofBarSection from '../components/common/SocialProofBarSection.vue'
import { t } from '../i18n/translations'
import { absoluteUrl, organizationId, pageContext } from '../utils/jsonLd'
const { siteUrl, locale } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
---
<BaseLayout title="Contact — Comfy">
<BaseLayout
title="Contact — Comfy"
pageType="ContactPage"
mainEntityId={organizationId(siteUrl)}
breadcrumbs={[
{ name: t('breadcrumb.home', locale), url: absoluteUrl(Astro.site, '/') },
{ name: t('breadcrumb.contact', locale) },
]}
>
<FormSection client:load />
<SocialProofBarSection />
</BaseLayout>

View File

@@ -7,6 +7,13 @@ import DemoTranscript from '../../components/demos/DemoTranscript.vue'
import DemoNavSection from '../../components/demos/DemoNavSection.vue'
import { demos, getDemoBySlug, getNextDemo } from '../../config/demos'
import { t } from '../../i18n/translations'
import type { JsonLdNode } from '../../utils/jsonLd'
import {
absoluteUrl,
jsonLdId,
organizationId,
pageContext,
} from '../../utils/jsonLd'
export const getStaticPaths: GetStaticPaths = () => {
return demos.map((demo) => ({
@@ -19,68 +26,34 @@ const demo = getDemoBySlug(slug as string)!
const nextDemo = getNextDemo(slug as string)
const title = t(demo.title)
const description = t(demo.description)
const canonicalURL = new URL(`/demos/${demo.slug}`, Astro.site)
const howToJsonLd = {
'@context': 'https://schema.org',
'@type': 'HowTo',
name: title,
description,
image: new URL(demo.ogImage, Astro.site).href,
totalTime: demo.durationIso,
datePublished: demo.publishedDate,
dateModified: demo.modifiedDate,
author: {
'@type': 'Organization',
name: 'Comfy Org',
url: 'https://comfy.org'
}
}
const learningResourceJsonLd = {
'@context': 'https://schema.org',
'@type': 'LearningResource',
name: title,
description,
learningResourceType: 'interactive tutorial',
interactivityType: 'active',
educationalLevel: demo.difficulty === 'beginner'
const { siteUrl, locale, url } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
const educationalLevel =
demo.difficulty === 'beginner'
? 'Beginner'
: demo.difficulty === 'intermediate'
? 'Intermediate'
: 'Advanced',
url: canonicalURL.href,
: 'Advanced'
const learningId = jsonLdId(url, 'learning')
const learningResource: JsonLdNode = {
'@type': 'LearningResource',
'@id': learningId,
name: title,
description,
url,
image: new URL(demo.ogImage, Astro.site).href,
learningResourceType: 'interactive tutorial',
interactivityType: 'active',
educationalLevel,
timeRequired: demo.durationIso,
datePublished: demo.publishedDate,
dateModified: demo.modifiedDate,
author: {
'@type': 'Organization',
name: 'Comfy Org',
url: 'https://comfy.org'
}
}
const breadcrumbJsonLd = {
'@context': 'https://schema.org',
'@type': 'BreadcrumbList',
itemListElement: [
{
'@type': 'ListItem',
position: 1,
name: t('demos.breadcrumb.home'),
item: 'https://comfy.org'
},
{
'@type': 'ListItem',
position: 2,
name: t('demos.breadcrumb.demos'),
item: 'https://comfy.org/demos'
},
{
'@type': 'ListItem',
position: 3,
name: title
}
]
isPartOf: { '@id': jsonLdId(url, 'webpage') },
author: { '@id': organizationId(siteUrl) },
}
---
@@ -88,25 +61,20 @@ const breadcrumbJsonLd = {
title={`${title} — Comfy`}
description={description}
ogImage={demo.ogImage}
mainEntityId={learningId}
breadcrumbs={[
{ name: t('breadcrumb.home', locale), url: absoluteUrl(Astro.site, '/') },
{
name: t('demos.breadcrumb.demos', locale),
url: absoluteUrl(Astro.site, '/demos'),
},
{ name: title },
]}
extraJsonLd={[learningResource]}
>
<Fragment slot="head">
<meta property="article:published_time" content={demo.publishedDate} />
<meta property="article:modified_time" content={demo.modifiedDate} />
<script
is:inline
type="application/ld+json"
set:html={JSON.stringify(howToJsonLd)}
/>
<script
is:inline
type="application/ld+json"
set:html={JSON.stringify(learningResourceJsonLd)}
/>
<script
is:inline
type="application/ld+json"
set:html={JSON.stringify(breadcrumbJsonLd)}
/>
<link rel="preconnect" href="https://demo.arcade.software" />
</Fragment>

View File

@@ -8,11 +8,29 @@ import EcoSystemSection from '../components/product/local/EcoSystemSection.vue'
import ProductCardsSection from '../components/product/local/ProductCardsSection.vue'
import FAQSection from '../components/product/local/FAQSection.vue'
import { t } from '../i18n/translations'
import {
absoluteUrl,
comfyUiApplicationNode,
comfyUiSoftwareId,
pageContext,
} from '../utils/jsonLd'
const { siteUrl, locale } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
---
<BaseLayout
title="Download Comfy Desktop — Run AI on Your Hardware"
description={t('download.hero.subtitle', 'en')}
mainEntityId={comfyUiSoftwareId(siteUrl)}
breadcrumbs={[
{ name: t('breadcrumb.home', locale), url: absoluteUrl(Astro.site, '/') },
{ name: t('breadcrumb.download', locale) },
]}
extraJsonLd={[comfyUiApplicationNode(siteUrl)]}
keywords={['comfyui app', 'comfyui desktop app', 'comfyui desktop', 'comfy ui application', 'comfyui download', 'download comfyui', 'comfyui windows', 'comfyui mac', 'comfyui linux']}
>
<CloudBannerSection />

View File

@@ -9,11 +9,28 @@ import CaseStudySpotlightSection from "../components/home/CaseStudySpotlightSect
import GetStartedSection from "../components/home/GetStartedSection.vue";
import BuildWhatSection from "../components/home/BuildWhatSection.vue";
import { t } from "../i18n/translations";
import {
comfyUiApplicationNode,
comfyUiSoftwareId,
comfyUiSourceCodeNode,
pageContext,
} from "../utils/jsonLd";
const { siteUrl } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
);
---
<BaseLayout
title="Comfy — Professional Control of Visual AI"
description={t("hero.subtitle", "en")}
mainEntityId={comfyUiSoftwareId(siteUrl)}
extraJsonLd={[
comfyUiApplicationNode(siteUrl),
comfyUiSourceCodeNode(siteUrl),
]}
keywords={[
"comfyui app",
"comfyui web app",

View File

@@ -4,6 +4,13 @@ import BaseLayout from '../../../layouts/BaseLayout.astro'
import ModelHeroSection from '../../../components/models/ModelHeroSection.vue'
import { models, getModelBySlug } from '../../../config/models'
import { t } from '../../../i18n/translations'
import type { JsonLdNode } from '../../../utils/jsonLd'
import {
absoluteUrl,
jsonLdId,
pageContext,
softwareApplicationNode,
} from '../../../utils/jsonLd'
export const getStaticPaths: GetStaticPaths = () => {
return models.map((model) => ({
@@ -19,7 +26,6 @@ if (model.canonicalSlug) {
}
const { displayName } = model
const canonicalURL = new URL(`/p/supported-models/${model.slug}`, Astro.site)
const dirDescriptions: Record<string, string> = {
diffusion_models: 'a diffusion model that generates images or video from text and image prompts',
@@ -40,55 +46,31 @@ const dirDescriptions: Record<string, string> = {
const dirDesc = dirDescriptions[model.directory] ?? 'an AI model'
const whatIsDescription = `${displayName} is ${dirDesc}. You can run it locally in ComfyUI with full control over every parameter, or access it through Comfy Cloud. ComfyUI's node-based workflow editor lets you connect ${displayName} with ControlNets, LoRAs, upscalers, and custom nodes to build any pipeline you need. There are ${model.workflowCount} community workflow templates using ${displayName} on Comfy Hub, ready to load and customize.`
const softwareAppJsonLd = {
'@context': 'https://schema.org',
'@type': 'SoftwareApplication',
const pageTitle = `${displayName} in ComfyUI`
const pageDescription = `Run ${displayName} in ComfyUI with full parameter control. ${model.workflowCount} community workflow templates, step-by-step tutorials, and free local inference.`
const { siteUrl, locale, url } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
const softwareId = jsonLdId(url, 'software')
const software = softwareApplicationNode({
siteUrl,
id: softwareId,
name: displayName,
url,
applicationCategory: 'MultimediaApplication',
operatingSystem: 'Any',
url: canonicalURL.href,
author: {
'@type': 'Organization',
name: 'Comfy Org',
url: 'https://comfy.org'
}
}
const breadcrumbJsonLd = {
'@context': 'https://schema.org',
'@type': 'BreadcrumbList',
itemListElement: [
{
'@type': 'ListItem',
position: 1,
name: t('models.breadcrumb.home'),
item: 'https://comfy.org'
},
{
'@type': 'ListItem',
position: 2,
name: t('models.breadcrumb.models'),
item: 'https://comfy.org/p/supported-models'
},
{
'@type': 'ListItem',
position: 3,
name: displayName
}
]
}
const faqJsonLd = {
'@context': 'https://schema.org',
})
const faqPage: JsonLdNode = {
'@type': 'FAQPage',
'@id': jsonLdId(url, 'faq'),
mainEntity: [
{
'@type': 'Question',
name: `What is ${displayName}?`,
acceptedAnswer: {
'@type': 'Answer',
text: whatIsDescription
}
acceptedAnswer: { '@type': 'Answer', text: whatIsDescription },
},
{
'@type': 'Question',
@@ -97,54 +79,44 @@ const faqJsonLd = {
'@type': 'Answer',
text: model.docsUrl
? `Follow the step-by-step tutorial at ${model.docsUrl}. You can also load any of the ${model.workflowCount} community workflow templates that use ${displayName} directly in ComfyUI.`
: `Open ComfyUI and browse the ${model.workflowCount} community workflow templates that use ${displayName}. Load one as a starting point, then customize the nodes and parameters to fit your use case.`
}
: `Open ComfyUI and browse the ${model.workflowCount} community workflow templates that use ${displayName}. Load one as a starting point, then customize the nodes and parameters to fit your use case.`,
},
},
{
'@type': 'Question',
name: `How many ComfyUI workflows use ${displayName}?`,
acceptedAnswer: {
'@type': 'Answer',
text: `There are ${model.workflowCount} community workflow templates that use ${displayName} on Comfy Hub. Each template is ready to run in ComfyUI and can be customized to suit your project.`
}
text: `There are ${model.workflowCount} community workflow templates that use ${displayName} on Comfy Hub. Each template is ready to run in ComfyUI and can be customized to suit your project.`,
},
},
{
'@type': 'Question',
name: `Is ${displayName} free to use in ComfyUI?`,
acceptedAnswer: {
'@type': 'Answer',
text: `ComfyUI is free and open source. ${model.huggingFaceUrl ? `${displayName} weights are available to download from Hugging Face.` : `${displayName} is available as a cloud API through Comfy Cloud.`} You only pay for compute when running on Comfy Cloud; local inference on your own hardware is always free.`
}
}
]
text: `ComfyUI is free and open source. ${model.huggingFaceUrl ? `${displayName} weights are available to download from Hugging Face.` : `${displayName} is available as a cloud API through Comfy Cloud.`} You only pay for compute when running on Comfy Cloud; local inference on your own hardware is always free.`,
},
},
],
}
const pageTitle = `${displayName} in ComfyUI`
const pageDescription = `Run ${displayName} in ComfyUI with full parameter control. ${model.workflowCount} community workflow templates, step-by-step tutorials, and free local inference.`
---
<BaseLayout
title={`${pageTitle} — Comfy`}
description={pageDescription}
ogImage={model.thumbnailUrl}
mainEntityId={softwareId}
breadcrumbs={[
{ name: t('breadcrumb.home', locale), url: absoluteUrl(Astro.site, '/') },
{
name: t('models.breadcrumb.models', locale),
url: absoluteUrl(Astro.site, '/p/supported-models'),
},
{ name: displayName },
]}
extraJsonLd={[software, faqPage]}
>
<Fragment slot="head">
<script
is:inline
type="application/ld+json"
set:html={JSON.stringify(softwareAppJsonLd)}
/>
<script
is:inline
type="application/ld+json"
set:html={JSON.stringify(breadcrumbJsonLd)}
/>
<script
is:inline
type="application/ld+json"
set:html={JSON.stringify(faqJsonLd)}
/>
</Fragment>
<ModelHeroSection
displayName={displayName}

View File

@@ -2,10 +2,29 @@
import BaseLayout from '../../../layouts/BaseLayout.astro'
import { models } from '../../../config/models'
import { t } from '../../../i18n/translations'
import {
absoluteUrl,
itemListNode,
jsonLdId,
pageContext,
} from '../../../utils/jsonLd'
const title = t('models.index.title')
const subtitle = t('models.index.subtitle')
const { url, locale } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
const modelList = itemListNode(
url,
title,
models.map((model) => ({
url: absoluteUrl(Astro.site, `/p/supported-models/${model.slug}`),
})),
)
const dirLabel: Record<string, string> = {
diffusion_models: 'Diffusion',
checkpoints: 'Checkpoint',
@@ -26,6 +45,13 @@ const dirLabel: Record<string, string> = {
<BaseLayout
title={`${title} — Comfy`}
description={subtitle}
pageType="CollectionPage"
mainEntityId={jsonLdId(url, 'itemlist')}
breadcrumbs={[
{ name: t('breadcrumb.home', locale), url: absoluteUrl(Astro.site, '/') },
{ name: title },
]}
extraJsonLd={[modelList]}
>
<div class="mx-auto max-w-7xl px-6 py-16 lg:px-8 lg:py-24">
<header class="mb-12">

View File

@@ -5,9 +5,29 @@ import StorySection from '../../components/about/StorySection.vue'
import OurValuesSection from '../../components/about/OurValuesSection.vue'
import ValuesSection from '../../components/about/ValuesSection.vue'
import CareersSection from '../../components/about/CareersSection.vue'
import { t } from '../../i18n/translations'
import { absoluteUrl, organizationId, pageContext } from '../../utils/jsonLd'
const { siteUrl, locale } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
---
<BaseLayout title="关于我们 — Comfy" description="了解 ComfyUI 背后的团队和使命——开源的生成式 AI 平台。">
<BaseLayout
title="关于我们 — Comfy"
description="了解 ComfyUI 背后的团队和使命——开源的生成式 AI 平台。"
pageType="AboutPage"
mainEntityId={organizationId(siteUrl)}
breadcrumbs={[
{
name: t('breadcrumb.home', locale),
url: absoluteUrl(Astro.site, '/zh-CN'),
},
{ name: t('breadcrumb.about', locale) },
]}
>
<HeroSection locale="zh-CN" client:load />
<StorySection locale="zh-CN" />
<OurValuesSection locale="zh-CN" />

View File

@@ -7,6 +7,13 @@ import TeamPhotosSection from '../../components/careers/TeamPhotosSection.vue'
import FAQSection from '../../components/common/FAQSection.vue'
import { fetchRolesForBuild } from '../../utils/ashby'
import { reportAshbyOutcome } from '../../utils/ashby.ci'
import { t } from '../../i18n/translations'
import {
absoluteUrl,
itemListNode,
jsonLdId,
pageContext,
} from '../../utils/jsonLd'
const outcome = await fetchRolesForBuild()
reportAshbyOutcome(outcome)
@@ -19,11 +26,34 @@ if (outcome.status === 'failed') {
}
const departments = outcome.snapshot.departments
const { siteUrl, locale, url } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
const roles = itemListNode(
url,
t('breadcrumb.careers', locale),
departments.flatMap((department) =>
department.roles.map((role) => ({ name: role.title, url: role.jobUrl })),
),
)
---
<BaseLayout
title="招聘 — Comfy"
description="加入构建生成式 AI 操作系统的团队。工程、设计、市场营销等岗位开放招聘中。"
pageType="CollectionPage"
mainEntityId={jsonLdId(url, 'itemlist')}
breadcrumbs={[
{
name: t('breadcrumb.home', locale),
url: absoluteUrl(Astro.site, '/zh-CN'),
},
{ name: t('breadcrumb.careers', locale) },
]}
extraJsonLd={[roles]}
>
<HeroSection locale="zh-CN" />
<RolesSection locale="zh-CN" departments={departments} client:visible />

View File

@@ -2,9 +2,44 @@
import BaseLayout from '../../../layouts/BaseLayout.astro'
import PriceSection from '../../../components/pricing/PriceSection.vue'
import WhatsIncludedSection from '../../../components/pricing/WhatsIncludedSection.vue'
import { pricingOffers } from '../../../config/pricing'
import { t } from '../../../i18n/translations'
import {
absoluteUrl,
jsonLdId,
pageContext,
productNode,
} from '../../../utils/jsonLd'
const { siteUrl, locale, url } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
const productId = jsonLdId(url, 'product')
---
<BaseLayout title="定价 — Comfy Cloud">
<BaseLayout
title="定价 — Comfy Cloud"
mainEntityId={productId}
breadcrumbs={[
{
name: t('breadcrumb.home', locale),
url: absoluteUrl(Astro.site, '/zh-CN'),
},
{ name: 'Comfy Cloud', url: absoluteUrl(Astro.site, '/zh-CN/cloud') },
{ name: t('breadcrumb.pricing', locale) },
]}
extraJsonLd={[
productNode({
siteUrl,
id: productId,
name: 'Comfy Cloud',
url,
offers: pricingOffers(locale),
}),
]}
>
<PriceSection locale="zh-CN" client:load />
<WhatsIncludedSection locale="zh-CN" />
</BaseLayout>

View File

@@ -4,39 +4,47 @@ import HeroSection from '../../../components/cloud-nodes/HeroSection.vue'
import PackGridSection from '../../../components/cloud-nodes/PackGridSection.vue'
import { t } from '../../../i18n/translations'
import { loadPacksForBuild } from '../../../utils/cloudNodes.build'
import { escapeJsonLd } from '../../../utils/escapeJsonLd'
import {
absoluteUrl,
itemListNode,
jsonLdId,
pageContext,
} from '../../../utils/jsonLd'
const packs = await loadPacksForBuild()
const siteBase = Astro.site ?? new URL('https://comfy.org')
const pageUrl = new URL('/zh-CN/cloud/supported-nodes', siteBase).href
const itemListJsonLd = {
'@context': 'https://schema.org',
'@type': 'ItemList',
name: 'Comfy Cloud 支持的自定义节点包',
url: pageUrl,
numberOfItems: packs.length,
itemListElement: packs.map((pack, index) => ({
'@type': 'ListItem',
position: index + 1,
url: new URL(`/zh-CN/cloud/supported-nodes/${pack.id}`, siteBase).href,
const title = t('cloudNodes.meta.title', 'zh-CN')
const description = t('cloudNodes.meta.description', 'zh-CN')
const { url, locale } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
const packList = itemListNode(
url,
title,
packs.map((pack) => ({
name: pack.displayName,
image: pack.bannerUrl || pack.iconUrl
}))
}
url: absoluteUrl(Astro.site, `/zh-CN/cloud/supported-nodes/${pack.id}`),
})),
)
---
<BaseLayout
title={t('cloudNodes.meta.title', 'zh-CN')}
description={t('cloudNodes.meta.description', 'zh-CN')}
title={title}
description={description}
pageType="CollectionPage"
mainEntityId={jsonLdId(url, 'itemlist')}
breadcrumbs={[
{
name: t('breadcrumb.home', locale),
url: absoluteUrl(Astro.site, '/zh-CN'),
},
{ name: 'Comfy Cloud', url: absoluteUrl(Astro.site, '/zh-CN/cloud') },
{ name: t('breadcrumb.supportedNodes', locale) },
]}
extraJsonLd={[packList]}
>
<script
is:inline
slot="head"
type="application/ld+json"
set:html={escapeJsonLd(itemListJsonLd)}
/>
<HeroSection locale="zh-CN" client:visible />
<PackGridSection locale="zh-CN" packs={packs} client:visible />
</BaseLayout>

View File

@@ -7,7 +7,12 @@ import PackDetail from '../../../../components/cloud-nodes/PackDetail.vue'
import BaseLayout from '../../../../layouts/BaseLayout.astro'
import { t } from '../../../../i18n/translations'
import { loadPacksForBuild } from '../../../../utils/cloudNodes.build'
import { escapeJsonLd } from '../../../../utils/escapeJsonLd'
import {
absoluteUrl,
jsonLdId,
pageContext,
softwareApplicationNode,
} from '../../../../utils/jsonLd'
export const getStaticPaths: GetStaticPaths = async () => {
const packs = await loadPacksForBuild()
@@ -29,35 +34,48 @@ const metaDescription = t('cloudNodes.detail.metaDescription', 'zh-CN')
.replace('{nodeCount}', String(pack.nodes.length))
.replace('{description}', description)
const siteBase = Astro.site ?? new URL('https://comfy.org')
const pageUrl = new URL(`/zh-CN/cloud/supported-nodes/${pack.id}`, siteBase).href
const softwareJsonLd = {
'@context': 'https://schema.org',
'@type': 'SoftwareApplication',
const { siteUrl, locale, url } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
const softwareId = jsonLdId(url, 'software')
const software = softwareApplicationNode({
siteUrl,
id: softwareId,
name: pack.displayName,
url,
applicationCategory: 'DeveloperApplication',
applicationSubCategory: 'ComfyUI custom-node pack',
operatingSystem: 'Comfy Cloud (managed)',
url: pageUrl,
description,
description: pack.description || undefined,
image: pack.bannerUrl || pack.iconUrl,
softwareVersion: pack.latestVersion,
license: pack.license,
codeRepository: pack.repoUrl,
author: pack.publisher?.name
? { '@type': 'Person', name: pack.publisher.name }
: undefined,
offers: { '@type': 'Offer', price: 0, priceCurrency: 'USD' }
}
authorName: pack.publisher?.name,
isFree: true,
})
---
<BaseLayout title={title} description={metaDescription} ogImage={pack.bannerUrl}>
<script
is:inline
slot="head"
type="application/ld+json"
set:html={escapeJsonLd(softwareJsonLd)}
/>
<BaseLayout
title={title}
description={metaDescription}
ogImage={pack.bannerUrl}
mainEntityId={softwareId}
breadcrumbs={[
{
name: t('breadcrumb.home', locale),
url: absoluteUrl(Astro.site, '/zh-CN'),
},
{ name: 'Comfy Cloud', url: absoluteUrl(Astro.site, '/zh-CN/cloud') },
{
name: t('breadcrumb.supportedNodes', locale),
url: absoluteUrl(Astro.site, '/zh-CN/cloud/supported-nodes'),
},
{ name: pack.displayName },
]}
extraJsonLd={[software]}
>
<PackDetail pack={pack} locale="zh-CN" />
</BaseLayout>

View File

@@ -2,9 +2,28 @@
import BaseLayout from '../../layouts/BaseLayout.astro'
import FormSection from '../../components/contact/FormSection.vue'
import SocialProofBarSection from '../../components/common/SocialProofBarSection.vue'
import { t } from '../../i18n/translations'
import { absoluteUrl, organizationId, pageContext } from '../../utils/jsonLd'
const { siteUrl, locale } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
---
<BaseLayout title="联系我们 — Comfy">
<BaseLayout
title="联系我们 — Comfy"
pageType="ContactPage"
mainEntityId={organizationId(siteUrl)}
breadcrumbs={[
{
name: t('breadcrumb.home', locale),
url: absoluteUrl(Astro.site, '/zh-CN'),
},
{ name: t('breadcrumb.contact', locale) },
]}
>
<FormSection locale="zh-CN" client:load />
<SocialProofBarSection />
</BaseLayout>

View File

@@ -7,6 +7,13 @@ import DemoTranscript from '../../../components/demos/DemoTranscript.vue'
import DemoNavSection from '../../../components/demos/DemoNavSection.vue'
import { demos, getDemoBySlug, getNextDemo } from '../../../config/demos'
import { t } from '../../../i18n/translations'
import type { JsonLdNode } from '../../../utils/jsonLd'
import {
absoluteUrl,
jsonLdId,
organizationId,
pageContext,
} from '../../../utils/jsonLd'
export const getStaticPaths: GetStaticPaths = () => {
return demos.map((demo) => ({
@@ -19,68 +26,34 @@ const demo = getDemoBySlug(slug as string)!
const nextDemo = getNextDemo(slug as string)
const title = t(demo.title, 'zh-CN')
const description = t(demo.description, 'zh-CN')
const canonicalURL = new URL(`/zh-CN/demos/${demo.slug}`, Astro.site)
const howToJsonLd = {
'@context': 'https://schema.org',
'@type': 'HowTo',
name: title,
description,
image: new URL(demo.ogImage, Astro.site).href,
totalTime: demo.durationIso,
datePublished: demo.publishedDate,
dateModified: demo.modifiedDate,
author: {
'@type': 'Organization',
name: 'Comfy Org',
url: 'https://comfy.org'
}
}
const learningResourceJsonLd = {
'@context': 'https://schema.org',
'@type': 'LearningResource',
name: title,
description,
learningResourceType: 'interactive tutorial',
interactivityType: 'active',
educationalLevel: demo.difficulty === 'beginner'
const { siteUrl, locale, url } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
const educationalLevel =
demo.difficulty === 'beginner'
? 'Beginner'
: demo.difficulty === 'intermediate'
? 'Intermediate'
: 'Advanced',
url: canonicalURL.href,
: 'Advanced'
const learningId = jsonLdId(url, 'learning')
const learningResource: JsonLdNode = {
'@type': 'LearningResource',
'@id': learningId,
name: title,
description,
url,
image: new URL(demo.ogImage, Astro.site).href,
learningResourceType: 'interactive tutorial',
interactivityType: 'active',
educationalLevel,
timeRequired: demo.durationIso,
datePublished: demo.publishedDate,
dateModified: demo.modifiedDate,
author: {
'@type': 'Organization',
name: 'Comfy Org',
url: 'https://comfy.org'
}
}
const breadcrumbJsonLd = {
'@context': 'https://schema.org',
'@type': 'BreadcrumbList',
itemListElement: [
{
'@type': 'ListItem',
position: 1,
name: t('demos.breadcrumb.home', 'zh-CN'),
item: 'https://comfy.org/zh-CN'
},
{
'@type': 'ListItem',
position: 2,
name: t('demos.breadcrumb.demos', 'zh-CN'),
item: 'https://comfy.org/zh-CN/demos'
},
{
'@type': 'ListItem',
position: 3,
name: title
}
]
isPartOf: { '@id': jsonLdId(url, 'webpage') },
author: { '@id': organizationId(siteUrl) },
}
---
@@ -88,25 +61,23 @@ const breadcrumbJsonLd = {
title={`${title} — Comfy`}
description={description}
ogImage={demo.ogImage}
mainEntityId={learningId}
breadcrumbs={[
{
name: t('breadcrumb.home', locale),
url: absoluteUrl(Astro.site, '/zh-CN'),
},
{
name: t('demos.breadcrumb.demos', locale),
url: absoluteUrl(Astro.site, '/zh-CN/demos'),
},
{ name: title },
]}
extraJsonLd={[learningResource]}
>
<Fragment slot="head">
<meta property="article:published_time" content={demo.publishedDate} />
<meta property="article:modified_time" content={demo.modifiedDate} />
<script
is:inline
type="application/ld+json"
set:html={JSON.stringify(howToJsonLd)}
/>
<script
is:inline
type="application/ld+json"
set:html={JSON.stringify(learningResourceJsonLd)}
/>
<script
is:inline
type="application/ld+json"
set:html={JSON.stringify(breadcrumbJsonLd)}
/>
<link rel="preconnect" href="https://demo.arcade.software" />
</Fragment>

View File

@@ -8,11 +8,32 @@ import EcoSystemSection from '../../components/product/local/EcoSystemSection.vu
import ProductCardsSection from '../../components/product/local/ProductCardsSection.vue'
import FAQSection from '../../components/product/local/FAQSection.vue'
import { t } from '../../i18n/translations'
import {
absoluteUrl,
comfyUiApplicationNode,
comfyUiSoftwareId,
pageContext,
} from '../../utils/jsonLd'
const { siteUrl, locale } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
---
<BaseLayout
title="下载 Comfy 桌面版 — 在您的硬件上运行 AI"
description={t('download.hero.subtitle', 'zh-CN')}
mainEntityId={comfyUiSoftwareId(siteUrl)}
breadcrumbs={[
{
name: t('breadcrumb.home', locale),
url: absoluteUrl(Astro.site, '/zh-CN'),
},
{ name: t('breadcrumb.download', locale) },
]}
extraJsonLd={[comfyUiApplicationNode(siteUrl)]}
keywords={['comfyui app', 'comfyui desktop app', 'comfyui download', 'ComfyUI 下载', 'ComfyUI 桌面应用', 'ComfyUI 应用', 'ComfyUI Windows', 'ComfyUI macOS', 'ComfyUI Linux']}
>
<CloudBannerSection locale="zh-CN" />

View File

@@ -9,11 +9,25 @@ import CaseStudySpotlightSection from '../../components/home/CaseStudySpotlightS
import GetStartedSection from '../../components/home/GetStartedSection.vue'
import BuildWhatSection from '../../components/home/BuildWhatSection.vue'
import { t } from '../../i18n/translations'
import {
comfyUiApplicationNode,
comfyUiSoftwareId,
comfyUiSourceCodeNode,
pageContext,
} from '../../utils/jsonLd'
const { siteUrl } = pageContext(
Astro.site,
Astro.url.pathname,
Astro.currentLocale,
)
---
<BaseLayout
title="Comfy — 视觉 AI 的最强可控性"
description={t('hero.subtitle', 'zh-CN')}
mainEntityId={comfyUiSoftwareId(siteUrl)}
extraJsonLd={[comfyUiApplicationNode(siteUrl), comfyUiSourceCodeNode(siteUrl)]}
keywords={['comfyui app', 'comfyui web app', 'comfyui application', 'ComfyUI 应用', 'ComfyUI 网页版', 'ComfyUI 桌面应用', 'ComfyUI 下载', '可视化 AI', '节点式 AI', '生成式 AI 工作流']}
>
<HeroSection locale="zh-CN" client:load />

View File

@@ -0,0 +1,212 @@
import { describe, expect, it } from 'vitest'
import { externalLinks } from '../config/routes'
import { escapeJsonLd } from './escapeJsonLd'
import type { JsonLdGraph } from './jsonLd'
import {
absoluteUrl,
buildPageGraph,
collectGraphIds,
comfyUiApplicationNode,
comfyUiSoftwareId,
comfyUiSourceCodeNode,
itemListNode,
jsonLdId,
organizationId,
pageContext,
productNode,
softwareApplicationNode
} from './jsonLd'
const siteUrl = 'https://comfy.org'
const site = new URL('https://comfy.org/')
function typeNames(graph: JsonLdGraph): string[] {
return graph['@graph'].map((node) => node['@type'])
}
describe('absoluteUrl', () => {
it('resolves internal paths to their trailing-slash canonical form', () => {
expect(absoluteUrl(site, '/cloud')).toBe('https://comfy.org/cloud/')
expect(absoluteUrl(site, '/about/')).toBe('https://comfy.org/about/')
expect(absoluteUrl(site, '/')).toBe('https://comfy.org/')
})
})
describe('pageContext', () => {
it('derives siteUrl, locale and canonical url from the Astro globals', () => {
expect(pageContext(site, '/about/', undefined)).toEqual({
siteUrl,
locale: 'en',
url: 'https://comfy.org/about/'
})
expect(pageContext(site, '/zh-CN/', 'zh-CN').locale).toBe('zh-CN')
})
})
describe('itemListNode', () => {
it('counts items and omits per-item names when not supplied', () => {
const node = itemListNode('https://comfy.org/careers/', 'Careers', [
{ url: 'https://jobs.example/1' },
{ url: 'https://jobs.example/2', name: 'Designer' }
])
expect(node.numberOfItems).toBe(2)
const items = node.itemListElement as Record<string, unknown>[]
expect('name' in items[0]).toBe(false)
expect(items[1].name).toBe('Designer')
})
})
describe('softwareApplicationNode', () => {
it('claims Comfy Org as author and publisher only when first-party', () => {
const node = softwareApplicationNode({
siteUrl,
id: jsonLdId(siteUrl, 'software'),
name: 'ComfyUI',
url: siteUrl,
firstParty: true,
applicationCategory: 'MultimediaApplication',
isFree: true
})
const orgRef = { '@id': organizationId(siteUrl) }
expect(node.author).toEqual(orgRef)
expect(node.publisher).toEqual(orgRef)
expect(node.offers).toEqual({
'@type': 'Offer',
price: 0,
priceCurrency: 'USD',
seller: orgRef
})
})
it('does not name Comfy Org as seller on a third-party free offer', () => {
const node = softwareApplicationNode({
siteUrl,
id: 'https://comfy.org/cloud/supported-nodes/foo/#software',
name: 'Foo Pack',
url: 'https://comfy.org/cloud/supported-nodes/foo/',
applicationCategory: 'DeveloperApplication',
isFree: true
})
expect((node.offers as Record<string, unknown>).seller).toBeUndefined()
})
it('credits a known third-party author without claiming to publish it', () => {
const node = softwareApplicationNode({
siteUrl,
id: 'https://comfy.org/cloud/supported-nodes/foo/#software',
name: 'Foo Pack',
url: 'https://comfy.org/cloud/supported-nodes/foo/',
applicationCategory: 'DeveloperApplication',
authorName: 'Jane Dev'
})
expect(node.author).toEqual({ '@type': 'Person', name: 'Jane Dev' })
expect(node.publisher).toBeUndefined()
})
it('claims no author or publisher for third-party software with no author', () => {
const node = softwareApplicationNode({
siteUrl,
id: 'https://comfy.org/p/supported-models/foo/#software',
name: 'Foo Model',
url: 'https://comfy.org/p/supported-models/foo/',
applicationCategory: 'MultimediaApplication'
})
expect(node.author).toBeUndefined()
expect(node.publisher).toBeUndefined()
})
})
describe('sameAs encyclopedic references', () => {
it('links the organization to its Wikidata entity', () => {
const graph = buildPageGraph(
{ siteUrl, locale: 'en' },
{ url: `${siteUrl}/`, name: 'Home' }
)
const org = graph['@graph'].find((node) => node['@type'] === 'Organization')
expect(org?.sameAs).toContain(externalLinks.wikidataComfyOrg)
})
it('links the ComfyUI application to its Wikidata, Wikipedia and G2 entities', () => {
const node = comfyUiApplicationNode(siteUrl)
expect(node.sameAs).toEqual([
externalLinks.wikidataComfyUi,
externalLinks.wikipediaComfyUi,
externalLinks.g2ComfyUi
])
})
it('omits sameAs for third-party software', () => {
const node = softwareApplicationNode({
siteUrl,
id: 'https://comfy.org/p/supported-models/foo/#software',
name: 'Foo Model',
url: 'https://comfy.org/p/supported-models/foo/',
applicationCategory: 'MultimediaApplication'
})
expect(node.sameAs).toBeUndefined()
})
})
describe('productNode', () => {
it('gives every offer a currency and price', () => {
const node = productNode({
siteUrl,
id: 'https://comfy.org/cloud/pricing/#product',
name: 'Comfy Cloud',
url: 'https://comfy.org/cloud/pricing/',
offers: [{ name: 'Standard', price: '20' }]
})
const offers = node.offers as Record<string, unknown>[]
expect(offers[0].price).toBe('20')
expect(offers[0].priceCurrency).toBe('USD')
expect(offers[0].seller).toEqual({ '@id': organizationId(siteUrl) })
})
})
describe('comfyUiSourceCodeNode', () => {
it('links the source code to the ComfyUI application via targetProduct', () => {
const node = comfyUiSourceCodeNode(siteUrl)
expect(node.targetProduct).toEqual({ '@id': comfyUiSoftwareId(siteUrl) })
})
})
describe('buildPageGraph', () => {
const url = 'https://comfy.org/cloud/pricing/'
const graph = buildPageGraph(
{ siteUrl, locale: 'en' },
{
url,
name: 'Pricing',
type: 'CollectionPage',
mainEntityId: jsonLdId(url, 'itemlist'),
crumbs: [{ name: 'Home', url: `${siteUrl}/` }, { name: 'Pricing' }]
},
itemListNode(url, 'Plans', [{ url: `${siteUrl}/one/` }])
)
it('always includes the site-wide organization, website and page entity', () => {
expect(typeNames(graph)).toContain('Organization')
expect(typeNames(graph)).toContain('WebSite')
expect(typeNames(graph)).toContain('CollectionPage')
})
it('produces a graph where every @id reference resolves', () => {
const { defined, references } = collectGraphIds(graph)
for (const reference of references) {
expect(defined.has(reference)).toBe(true)
}
})
})
describe('escapeJsonLd on a built graph', () => {
it('neutralizes a </script> breakout in a page name', () => {
const graph = buildPageGraph(
{ siteUrl, locale: 'en' },
{ url: `${siteUrl}/x/`, name: '</script><script>alert(1)</script>' }
)
const serialized = escapeJsonLd(graph)
expect(serialized).not.toContain('</script>')
expect(serialized).toContain('\\u003c')
})
})

View File

@@ -0,0 +1,377 @@
import { externalLinks } from '../config/routes'
import type { Locale } from '../i18n/translations'
export type JsonLdNode = Record<string, unknown> & { '@type': string }
export interface JsonLdGraph {
'@context': 'https://schema.org'
'@graph': JsonLdNode[]
}
export interface PageContext {
siteUrl: string
locale: Locale
}
export type WebPageType =
| 'WebPage'
| 'AboutPage'
| 'ContactPage'
| 'CollectionPage'
export interface Crumb {
name: string
url?: string
}
const sameAs = [
externalLinks.github,
externalLinks.x,
externalLinks.youtube,
externalLinks.discord,
externalLinks.instagram,
externalLinks.reddit,
externalLinks.linkedin,
// Wikidata entity for the organization, so the Knowledge Graph can resolve it.
externalLinks.wikidataComfyOrg
]
// Authoritative encyclopedic and review-platform references for the ComfyUI software entity.
const comfyUiSameAs = [
externalLinks.wikidataComfyUi,
externalLinks.wikipediaComfyUi,
externalLinks.g2ComfyUi
]
function siteUrlFrom(site: URL | undefined): string {
return (site?.href ?? 'https://comfy.org/').replace(/\/$/, '')
}
export function absoluteUrl(site: URL | undefined, path: string): string {
const resolved = new URL(path, site ?? 'https://comfy.org').href
return resolved.endsWith('/') ? resolved : `${resolved}/`
}
export function pageContext(
site: URL | undefined,
pathname: string,
currentLocale: string | undefined
): PageContext & { url: string } {
return {
siteUrl: siteUrlFrom(site),
locale: currentLocale === 'zh-CN' ? 'zh-CN' : 'en',
url: absoluteUrl(site, pathname)
}
}
export function jsonLdId(pageUrl: string, fragment: string): string {
return `${pageUrl}#${fragment}`
}
export function organizationId(siteUrl: string): string {
return `${siteUrl}/#organization`
}
function websiteId(siteUrl: string): string {
return `${siteUrl}/#website`
}
function buildGraph(...nodes: (JsonLdNode | null | undefined)[]): JsonLdGraph {
return {
'@context': 'https://schema.org',
'@graph': nodes.filter((node): node is JsonLdNode => Boolean(node))
}
}
function organizationNode(siteUrl: string): JsonLdNode {
return {
'@type': 'Organization',
'@id': organizationId(siteUrl),
name: 'Comfy Org',
url: siteUrl,
logo: {
'@type': 'ImageObject',
url: `${siteUrl}/web-app-manifest-512x512.png`,
width: 512,
height: 512
},
sameAs
}
}
function websiteNode(siteUrl: string): JsonLdNode {
return {
'@type': 'WebSite',
'@id': websiteId(siteUrl),
name: 'Comfy',
url: siteUrl,
publisher: { '@id': organizationId(siteUrl) }
}
}
function breadcrumbNode(pageUrl: string, crumbs: Crumb[]): JsonLdNode {
return {
'@type': 'BreadcrumbList',
'@id': jsonLdId(pageUrl, 'breadcrumb'),
itemListElement: crumbs.map((crumb, index) => {
const isLast = index === crumbs.length - 1
return isLast || !crumb.url
? { '@type': 'ListItem', position: index + 1, name: crumb.name }
: {
'@type': 'ListItem',
position: index + 1,
name: crumb.name,
item: crumb.url
}
})
}
}
export function itemListNode(
pageUrl: string,
name: string,
items: { url: string; name?: string }[]
): JsonLdNode {
return {
'@type': 'ItemList',
'@id': jsonLdId(pageUrl, 'itemlist'),
name,
numberOfItems: items.length,
itemListElement: items.map((item, index) => ({
'@type': 'ListItem',
position: index + 1,
url: item.url,
...(item.name ? { name: item.name } : {})
}))
}
}
interface WebPageInput {
siteUrl: string
locale: Locale
url: string
name: string
description?: string
imageUrl?: string
crumbs?: Crumb[]
mainEntityId?: string
}
function webPageNode(input: WebPageInput, type: WebPageType): JsonLdNode {
const hasCrumbs = Boolean(input.crumbs && input.crumbs.length > 0)
return {
'@type': type,
'@id': jsonLdId(input.url, 'webpage'),
url: input.url,
name: input.name,
description: input.description,
isPartOf: { '@id': websiteId(input.siteUrl) },
primaryImageOfPage: input.imageUrl
? { '@type': 'ImageObject', url: input.imageUrl }
: undefined,
breadcrumb: hasCrumbs
? { '@id': jsonLdId(input.url, 'breadcrumb') }
: undefined,
mainEntity: input.mainEntityId ? { '@id': input.mainEntityId } : undefined,
inLanguage: input.locale
}
}
export interface SoftwareAppInput {
siteUrl: string
id: string
name: string
url: string
applicationCategory: string
firstParty?: boolean
applicationSubCategory?: string
description?: string
operatingSystem?: string
image?: string
softwareVersion?: string
license?: string
codeRepository?: string
authorName?: string
isFree?: boolean
sameAs?: string[]
}
export function softwareApplicationNode(input: SoftwareAppInput): JsonLdNode {
const orgRef = { '@id': organizationId(input.siteUrl) }
const author = input.firstParty
? orgRef
: input.authorName
? { '@type': 'Person', name: input.authorName }
: undefined
return {
'@type': 'SoftwareApplication',
'@id': input.id,
name: input.name,
url: input.url,
applicationCategory: input.applicationCategory,
applicationSubCategory: input.applicationSubCategory,
description: input.description,
operatingSystem: input.operatingSystem,
image: input.image,
softwareVersion: input.softwareVersion,
license: input.license,
codeRepository: input.codeRepository,
author,
publisher: input.firstParty ? orgRef : undefined,
sameAs: input.sameAs,
offers: input.isFree
? {
'@type': 'Offer',
price: 0,
priceCurrency: 'USD',
seller: input.firstParty ? orgRef : undefined
}
: undefined
}
}
interface SourceCodeInput {
siteUrl: string
id: string
name: string
codeRepository: string
programmingLanguage?: string
targetProductId?: string
}
function softwareSourceCodeNode(input: SourceCodeInput): JsonLdNode {
return {
'@type': 'SoftwareSourceCode',
'@id': input.id,
name: input.name,
codeRepository: input.codeRepository,
programmingLanguage: input.programmingLanguage,
targetProduct: input.targetProductId
? { '@id': input.targetProductId }
: undefined,
author: { '@id': organizationId(input.siteUrl) }
}
}
export function comfyUiSoftwareId(siteUrl: string): string {
return `${siteUrl}/#software`
}
export function comfyUiApplicationNode(siteUrl: string): JsonLdNode {
return softwareApplicationNode({
siteUrl,
id: comfyUiSoftwareId(siteUrl),
name: 'ComfyUI',
url: siteUrl,
firstParty: true,
applicationCategory: 'MultimediaApplication',
operatingSystem: 'Windows, macOS, Linux',
isFree: true,
sameAs: comfyUiSameAs
})
}
export function comfyUiSourceCodeNode(siteUrl: string): JsonLdNode {
return softwareSourceCodeNode({
siteUrl,
id: `${siteUrl}/#sourcecode`,
name: 'ComfyUI',
codeRepository: externalLinks.github,
programmingLanguage: 'Python',
targetProductId: comfyUiSoftwareId(siteUrl)
})
}
interface OfferInput {
name: string
price: string | number
url?: string
}
export interface ProductInput {
siteUrl: string
id: string
name: string
url: string
offers: OfferInput[]
}
export function productNode(input: ProductInput): JsonLdNode {
return {
'@type': 'Product',
'@id': input.id,
name: input.name,
url: input.url,
brand: { '@id': organizationId(input.siteUrl) },
offers: input.offers.map((offer) => ({
'@type': 'Offer',
name: offer.name,
price: offer.price,
priceCurrency: 'USD',
url: offer.url,
seller: { '@id': organizationId(input.siteUrl) },
priceSpecification: {
'@type': 'UnitPriceSpecification',
price: offer.price,
priceCurrency: 'USD',
unitText: 'MONTH'
}
}))
}
}
export interface PageGraphInput {
url: string
name: string
type?: WebPageType
description?: string
imageUrl?: string
crumbs?: Crumb[]
mainEntityId?: string
}
export function buildPageGraph(
ctx: PageContext,
page: PageGraphInput,
...extraNodes: (JsonLdNode | null | undefined)[]
): JsonLdGraph {
const { type = 'WebPage', ...rest } = page
const input: WebPageInput = {
...rest,
siteUrl: ctx.siteUrl,
locale: ctx.locale
}
const hasCrumbs = Boolean(page.crumbs && page.crumbs.length > 0)
return buildGraph(
organizationNode(ctx.siteUrl),
websiteNode(ctx.siteUrl),
webPageNode(input, type),
hasCrumbs ? breadcrumbNode(page.url, page.crumbs!) : undefined,
...extraNodes
)
}
export function collectGraphIds(value: unknown): {
defined: Set<string>
references: string[]
} {
const defined = new Set<string>()
const references: string[] = []
const walk = (node: unknown): void => {
if (Array.isArray(node)) {
node.forEach(walk)
return
}
if (node && typeof node === 'object') {
const record = node as Record<string, unknown>
const id = record['@id']
if (typeof id === 'string') {
if (Object.keys(record).length === 1) references.push(id)
else defined.add(id)
}
Object.values(record).forEach(walk)
}
}
walk(value)
return { defined, references }
}

View File

@@ -1,6 +1,7 @@
import type { Locator, Page } from '@playwright/test'
import type { ComfyPage } from '@e2e/fixtures/ComfyPage'
import { TestIds } from '@e2e/fixtures/selectors'
import { WidgetSelectDropdownFixture } from '@e2e/fixtures/components/WidgetSelectDropdown'
/**
@@ -26,6 +27,12 @@ export class AppModeWidgetHelper {
return this.container.locator(`[data-widget-key$=":${key}"]`)
}
getWidgetDescription(key: string) {
return this.page
.locator(`[data-widget-key$=":${key}"]`)
.getByTestId(TestIds.appMode.widgetDescription)
}
/** Get a FormDropdown widget by its key (e.g. "10:image"). */
getSelectDropdown(key: string): WidgetSelectDropdownFixture {
return new WidgetSelectDropdownFixture(this.getWidgetItem(key))

View File

@@ -218,6 +218,7 @@ export const TestIds = {
},
appMode: {
widgetItem: 'app-mode-widget-item',
widgetDescription: 'app-mode-widget-description',
welcome: 'linear-welcome',
emptyWorkflow: 'linear-welcome-empty-workflow',
buildApp: 'linear-welcome-build-app',

View File

@@ -46,6 +46,54 @@ test.describe('App mode builder selection', () => {
await expect(items).toHaveCount(1)
})
test(
'Can add description to widgets',
{ tag: '@vue-nodes' },
async ({ comfyPage }) => {
const descLocator =
comfyPage.appMode.widgets.getWidgetDescription('6:text')
await test.step('set up baseline app', async () => {
await comfyPage.appMode.enterAppModeWithInputs([['6', 'text']])
await expect(descLocator, 'Empty description hidden').toBeHidden()
})
const description = "Don't forget the massive fennec ears!"
await test.step('Enter builder and add description', async () => {
await comfyPage.appMode.enterBuilder()
await comfyPage.appMode.steps.goToPreview()
await expect(
descLocator,
'Display placeholder in builder'
).toBeVisible()
await descLocator.dblclick()
await descLocator.locator('input').fill(description)
await descLocator.locator('input').blur()
await expect(descLocator, 'Description updates').toHaveText(description)
})
await test.step('Exit builder and return to app mode', async () => {
await comfyPage.appMode.footer.exitBuilder()
await comfyPage.appMode.toggleAppMode()
await expect(descLocator, 'Description displays').toHaveText(
description
)
})
await test.step('Swap workflows to test persistance', async () => {
await comfyPage.appMode.toggleAppMode()
await comfyPage.menu.topbar.getTab(0).click()
await comfyPage.menu.topbar.getTab(1).click()
await comfyPage.appMode.toggleAppMode()
await expect(descLocator, 'Description persists').toHaveText(
description
)
})
}
)
test('Can not select nodes with errors or notes', async ({ comfyPage }) => {
//Manually set error state on checkpoint loader
//Shouldn't be needed on ci, but has spotty reliability

View File

@@ -0,0 +1,279 @@
import { expect } from '@playwright/test'
import type { Page, Route } from '@playwright/test'
import type { RemoteConfig } from '@/platform/remoteConfig/types'
import { comfyPageFixture as test } from '@e2e/fixtures/ComfyPage'
import { bootCloud, mockCloudBoot } from '@e2e/fixtures/utils/cloudBootMocks'
import { jsonRoute } from '@e2e/fixtures/utils/jsonRoute'
/**
* End-to-end coverage for the user-secrets (API keys) surface in the cloud app:
* add a provider key, see it listed, delete it — the full CRUD round-trip —
* plus the entitlement contract that a non-entitled account never sees the
* gated providers.
*
* Drives a raw `page` against fully-mocked endpoints (the `comfyPage` fixture
* would reach the OSS devtools backend during setup); `mockCloudBoot` +
* `bootCloud` boot the app signed-in, and this spec layers a stateful in-memory
* `/secrets` backend on top so the flow is deterministic and never touches a
* real server.
*/
const APP_URL = process.env.PLAYWRIGHT_TEST_URL || 'http://localhost:8188'
// `/api/features` is the remote-config source. Enabling user secrets is what
// surfaces the Secrets settings panel for a signed-in user.
const BOOT_FEATURES = {
user_secrets_enabled: true
} satisfies RemoteConfig
// TutorialCompleted suppresses the new-user template browser, whose modal
// overlay (z-1700) would otherwise intercept clicks on the settings dialog.
const BOOT_SETTINGS = { 'Comfy.TutorialCompleted': true }
// The plaintext key a user types in. It must be sent on create but NEVER echoed
// back by the API or rendered anywhere in the UI.
const RUNWAY_KEY_VALUE = 'sk-runway-do-not-echo-0xDEADBEEF'
interface SecretRecord {
id: string
name: string
provider?: string
created_at: string
updated_at: string
last_used_at?: string
}
interface CreateCapture {
name?: string
provider?: string
secret_value?: string
}
interface SecretsBackend {
/** Bodies received by POST /secrets, in order — for asserting what was sent. */
createRequests: CreateCapture[]
/** Current server-side store — for asserting delete actually removed a row. */
store: SecretRecord[]
}
/**
* Stateful mock of the ingest `/secrets` surface. A single route handler
* branches on path + method so registration order can never make a specific
* path (`/secrets/providers`, `/secrets/:id`) lose to the collection glob.
*
* `providerIds` models entitlement: an entitled account sees runway/gemini,
* a non-entitled account gets an empty list (the server omits them).
*/
async function mockSecretsBackend(
page: Page,
providerIds: string[]
): Promise<SecretsBackend> {
const backend: SecretsBackend = { createRequests: [], store: [] }
let idSeq = 0
const respondList = (route: Route) =>
route.fulfill(jsonRoute({ data: backend.store }))
await page.route('**/api/secrets**', async (route) => {
const request = route.request()
const { pathname } = new URL(request.url())
const method = request.method()
// The glob `**/api/secrets**` also matches the panel's own lazy-loaded
// source module (`/src/platform/secrets/api/secretsApi.ts`), whose path
// contains the `/api/secrets` substring. Fulfilling that dev-server module
// request with JSON breaks the dynamic import and the panel never mounts.
// Anchor to the start of the pathname so only genuine `/api/secrets…` API
// routes are handled; everything else falls through to the real Vite server.
if (!/^\/api\/secrets(\/|$)/.test(pathname)) {
return route.continue()
}
// GET /secrets/providers — the entitlement-gated provider allowlist.
if (pathname.endsWith('/secrets/providers')) {
return route.fulfill(
jsonRoute({ data: providerIds.map((id) => ({ id })) })
)
}
// /secrets/:id — item routes (only DELETE is exercised by this flow).
const itemMatch = pathname.match(/\/secrets\/([^/]+)$/)
if (itemMatch) {
const id = itemMatch[1]
if (method === 'DELETE') {
backend.store = backend.store.filter((s) => s.id !== id)
return route.fulfill({ status: 204, body: '' })
}
return respondList(route)
}
// /secrets — collection routes.
if (method === 'POST') {
const body = (request.postDataJSON() ?? {}) as CreateCapture
backend.createRequests.push(body)
idSeq += 1
const created: SecretRecord = {
id: `00000000-0000-4000-8000-${String(idSeq).padStart(12, '0')}`,
name: body.name ?? '',
provider: body.provider,
created_at: '2026-07-08T00:00:00Z',
updated_at: '2026-07-08T00:00:00Z'
}
backend.store.push(created)
// Response echoes metadata ONLY — the schema has no secret_value field.
return route.fulfill(jsonRoute(created))
}
// GET /secrets (list).
return respondList(route)
})
return backend
}
/**
* Open the settings dialog and land on the Secrets panel, waiting for both the
* provider allowlist and the secret list to resolve so subsequent assertions
* are not racing the panel's on-mount fetches.
*/
async function openSecretsPanel(page: Page) {
const settingsDialog = page.getByTestId('settings-dialog')
await page.evaluate(() => {
const app = window.app
if (!app) throw new Error('window.app is not available')
return app.extensionManager.command.execute('Comfy.ShowSettingsDialog')
})
await settingsDialog.waitFor({ state: 'visible' })
const providersResolved = page.waitForResponse((r) =>
r.url().includes('/api/secrets/providers')
)
const listResolved = page.waitForResponse(
(r) =>
/\/api\/secrets(\?|$)/.test(r.url()) && r.request().method() === 'GET'
)
await settingsDialog
.locator('nav')
.getByRole('button', { name: 'Secrets' })
.click()
await Promise.all([providersResolved, listResolved])
return settingsDialog
}
test.describe('Cloud user secrets (API keys)', { tag: '@cloud' }, () => {
test('an entitled account can add, list, and delete a provider key', async ({
page
}) => {
test.slow()
await mockCloudBoot(page, {
features: BOOT_FEATURES,
settings: BOOT_SETTINGS
})
await bootCloud(page)
const backend = await mockSecretsBackend(page, ['runway', 'gemini'])
await page.goto(APP_URL)
await page.waitForFunction(() => !!window.app?.extensionManager, null, {
timeout: 45_000
})
const settingsDialog = await openSecretsPanel(page)
// Empty state before anything is added.
await expect(settingsDialog.getByText(/No secrets stored/)).toBeVisible()
// --- ADD -------------------------------------------------------------
await settingsDialog.getByRole('button', { name: 'Add Secret' }).click()
const formDialog = page
.getByRole('dialog')
.filter({ hasText: 'Secret Value' })
await expect(formDialog).toBeVisible()
// Pick the entitled Runway provider from the server-driven dropdown.
await formDialog.locator('#secret-provider').click()
await page.getByRole('option', { name: 'Runway' }).click()
await formDialog.locator('#secret-name').fill('My Runway Key')
await formDialog.locator('input[type="password"]').fill(RUNWAY_KEY_VALUE)
await formDialog.getByRole('button', { name: 'Save', exact: true }).click()
await expect(formDialog).toBeHidden()
// --- LIST ------------------------------------------------------------
await expect(settingsDialog.getByText('My Runway Key')).toBeVisible()
await expect(settingsDialog.getByText(/No secrets stored/)).toBeHidden()
// The create request carried the plaintext value + provider...
expect(backend.createRequests).toHaveLength(1)
expect(backend.createRequests[0]).toMatchObject({
name: 'My Runway Key',
provider: 'runway',
secret_value: RUNWAY_KEY_VALUE
})
// ...but the value must never be echoed back into the list — the API
// response carries metadata only, so nothing should render it as text.
await expect(page.getByText(RUNWAY_KEY_VALUE)).toHaveCount(0)
// --- DELETE ----------------------------------------------------------
await settingsDialog
.getByRole('button', { name: 'Delete', exact: true })
.click()
const confirmDialog = page
.getByRole('dialog')
.filter({ hasText: 'Delete Secret' })
await confirmDialog
.getByRole('button', { name: 'Delete', exact: true })
.click()
await expect(settingsDialog.getByText('My Runway Key')).toBeHidden()
await expect(settingsDialog.getByText(/No secrets stored/)).toBeVisible()
expect(backend.store).toHaveLength(0)
})
test('a non-entitled account never sees the gated providers', async ({
page
}) => {
test.slow()
await mockCloudBoot(page, {
features: BOOT_FEATURES,
settings: BOOT_SETTINGS
})
await bootCloud(page)
// Non-entitled: the server omits runway/gemini from the allowlist.
await mockSecretsBackend(page, [])
await page.goto(APP_URL)
await page.waitForFunction(() => !!window.app?.extensionManager, null, {
timeout: 45_000
})
const settingsDialog = await openSecretsPanel(page)
await expect(settingsDialog.getByText(/No secrets stored/)).toBeVisible()
// The add form opens, but its provider dropdown is empty — the gated
// providers must not appear anywhere.
await settingsDialog.getByRole('button', { name: 'Add Secret' }).click()
const formDialog = page
.getByRole('dialog')
.filter({ hasText: 'Secret Value' })
await expect(formDialog).toBeVisible()
await formDialog.locator('#secret-provider').click()
// Anchor on the opened listbox so the absence assertions below can't pass
// vacuously against a dropdown that never opened.
const providerListbox = page.getByRole('listbox')
await expect(providerListbox).toBeVisible()
// An empty allowlist must yield an empty dropdown. Asserting zero options
// (not just runway/gemini absent) also rejects the fetch-failure fallback,
// where `availableProviders` is null and the default providers would show.
await expect(providerListbox.getByRole('option')).toHaveCount(0)
})
})

View File

@@ -1,10 +1,10 @@
<script setup lang="ts">
import { computed, provide } from 'vue'
import { useAppModeWidgetResizing } from '@/components/builder/useAppModeWidgetResizing'
import { useResolvedSelectedInputs } from '@/components/builder/useResolvedSelectedInputs'
import { useI18n } from 'vue-i18n'
import WidgetDescription from '@/components/builder/WidgetDescription.vue'
import { useAppModeWidgetResizing } from '@/components/builder/useAppModeWidgetResizing'
import { useResolvedSelectedInputs } from '@/components/builder/useResolvedSelectedInputs'
import Popover from '@/components/ui/Popover.vue'
import Button from '@/components/ui/button/Button.vue'
import { extractVueNodeData } from '@/composables/graph/useGraphNodeManager'
@@ -33,6 +33,7 @@ interface WidgetEntry {
widgets: NonNullable<ReturnType<typeof nodeToNodeData>['widgets']>
}
action: { widget: IBaseWidget; node: LGraphNode }
description?: string
}
const { mobile = false, builderMode = false } = defineProps<{
@@ -83,6 +84,7 @@ const mappedSelections = computed((): WidgetEntry[] => {
{
key: widgetId,
persistedHeight: config?.height,
description: config?.description,
nodeData: {
...fullNodeData,
widgets: [matchingWidget]
@@ -148,7 +150,13 @@ defineExpose({ handleDragDrop })
</script>
<template>
<div
v-for="{ key, persistedHeight, nodeData, action } in mappedSelections"
v-for="{
key,
persistedHeight,
nodeData,
action,
description
} in mappedSelections"
:key
:class="
cn(
@@ -211,6 +219,24 @@ defineExpose({ handleDragDrop })
</template>
</Popover>
</div>
<div
v-if="description || builderMode"
data-testid="app-mode-widget-description"
:class="
cn(
'h-5 px-5',
description ? 'text-muted-foreground' : 'text-muted-background'
)
"
>
<WidgetDescription
:description
label-class="drag-handle"
label-type="div"
:disabled="!builderMode"
:widget="action.widget"
/>
</div>
<div
:style="
persistedHeight

View File

@@ -0,0 +1,36 @@
<script setup lang="ts">
import { computed, ref } from 'vue'
import { useI18n } from 'vue-i18n'
import EditableText from '@/components/common/EditableText.vue'
import type { IBaseWidget } from '@/lib/litegraph/src/types/widgets'
import { useAppModeStore } from '@/stores/appModeStore'
const { t } = useI18n()
const { widget } = defineProps<{
widget: IBaseWidget
description?: string
disabled?: boolean
}>()
const placeholder = computed(() =>
t('linearMode.arrange.descriptionPlaceholder')
)
const isEditing = ref(false)
function onEditComplete(val: string) {
isEditing.value = false
const description = val && val !== placeholder.value ? val : undefined
useAppModeStore().updateInputConfig(widget, { description })
}
</script>
<template>
<EditableText
:model-value="description || placeholder"
:is-editing
label-class="truncate"
@dblclick="!disabled && (isEditing = true)"
@edit="onEditComplete"
@cancel="isEditing = false"
/>
</template>

View File

@@ -31,7 +31,6 @@ const {
modelValue,
isEditing = false,
inputAttrs = {},
labelClass = '',
labelType = 'span'
} = defineProps<{
modelValue: string

View File

@@ -449,6 +449,12 @@ describe('shouldPreventRekaDismiss', () => {
expect(event.defaultPrevented).toBe(false)
})
it('focus-outside never dismisses when dismissOnFocusOutside is false', () => {
const event = makeEvent(document.body)
onRekaFocusOutside(event, { dismissOnFocusOutside: false })
expect(event.defaultPrevented).toBe(true)
})
it('focus-outside on a sibling Reka portal does not dismiss the parent', () => {
const portal = document.createElement('div')
portal.setAttribute('role', 'dialog')

View File

@@ -32,7 +32,9 @@
dialogStore.activeKey === item.key
)
"
@focus-outside="onRekaFocusOutside"
@focus-outside="
(e) => onRekaFocusOutside(e, item.dialogComponentProps)
"
@mousedown="() => dialogStore.riseDialog({ key: item.key })"
>
<template v-if="item.dialogComponentProps.headless">

View File

@@ -53,7 +53,22 @@ export function onRekaPointerDownOutside(
// nested Reka or PrimeVue dialog teleported to body). Without this guard a
// non-modal Reka dialog would dismiss itself the moment a nested dialog
// receives focus.
export function onRekaFocusOutside(event: OutsideEvent) {
//
// A container dialog (e.g. Settings) that hosts nested confirm/edit dialogs can
// also lose focus to an ordinary app element — not just a portal — when a
// nested dialog closes and the element it focused was removed (deleting the
// selected row). That programmatic focus shift is not a dismiss intent, so such
// a dialog opts out of focus-outside dismissal entirely via
// `dismissOnFocusOutside: false`; it still dismisses on escape or an outside
// pointer.
export function onRekaFocusOutside(
event: OutsideEvent,
options: { dismissOnFocusOutside?: boolean } = {}
) {
if (options.dismissOnFocusOutside === false) {
event.preventDefault()
return
}
if (isInsideOverlay(event.detail.originalEvent.target)) {
event.preventDefault()
}

View File

@@ -203,7 +203,9 @@ describe('useLoad3d', () => {
getModelInfo: vi.fn().mockReturnValue(null),
captureThumbnail: vi.fn().mockResolvedValue('data:image/png;base64,test'),
setAnimationTime: vi.fn(),
domElement: mockCanvas
renderer: {
domElement: mockCanvas
} as Partial<Load3d['renderer']> as Load3d['renderer']
}
vi.mocked(Load3d).mockImplementation(function (this: Load3d) {
@@ -290,7 +292,7 @@ describe('useLoad3d', () => {
mockNode.flags.collapsed = true
mockNode.onDrawBackground?.({} as CanvasRenderingContext2D)
expect(mockLoad3d.domElement!.hidden).toBe(true)
expect(mockLoad3d.renderer!.domElement.hidden).toBe(true)
})
it('should initialize without loading model (model loading is handled by Load3DConfiguration)', async () => {

View File

@@ -239,7 +239,7 @@ export const useLoad3d = (nodeOrRef: MaybeRef<LGraphNode | null>) => {
node.onDrawBackground,
function (this: LGraphNode) {
if (load3d) {
load3d.domElement.hidden = this.flags.collapsed ?? false
load3d.renderer.domElement.hidden = this.flags.collapsed ?? false
}
}
)

View File

@@ -43,8 +43,13 @@ function makeMockEventManager() {
} satisfies EventManagerInterface
}
function makeElement() {
return document.createElement('div')
function makeRenderer(opts: { withParent?: boolean } = {}) {
const canvas = document.createElement('canvas')
if (opts.withParent) {
const parent = document.createElement('div')
parent.appendChild(canvas)
}
return { domElement: canvas } as unknown as THREE.WebGLRenderer
}
describe('ControlsManager', () => {
@@ -59,19 +64,33 @@ describe('ControlsManager', () => {
})
describe('construction', () => {
it('attaches OrbitControls to the interaction element', () => {
const element = makeElement()
it('attaches OrbitControls to the canvas parent when one exists', () => {
const renderer = makeRenderer({ withParent: true })
manager = new ControlsManager(element, camera, events)
manager = new ControlsManager(renderer, camera, events)
expect(mockOrbitControls).toHaveBeenCalledWith(camera, element)
expect(mockOrbitControls).toHaveBeenCalledWith(
camera,
renderer.domElement.parentElement
)
expect(manager.controls.enableDamping).toBe(true)
})
it('falls back to the canvas itself when there is no parent', () => {
const renderer = makeRenderer({ withParent: false })
manager = new ControlsManager(renderer, camera, events)
expect(mockOrbitControls).toHaveBeenCalledWith(
camera,
renderer.domElement
)
})
})
describe('init', () => {
it('emits cameraChanged with a perspective state when the controls fire end', () => {
manager = new ControlsManager(makeElement(), camera, events)
manager = new ControlsManager(makeRenderer(), camera, events)
camera.position.set(1, 2, 3)
camera.zoom = 1.25
manager.controls.target.set(4, 5, 6)
@@ -90,7 +109,7 @@ describe('ControlsManager', () => {
it('reports orthographic camera type when initialized with one', () => {
const ortho = new THREE.OrthographicCamera()
ortho.zoom = 0.5
manager = new ControlsManager(makeElement(), ortho, events)
manager = new ControlsManager(makeRenderer(), ortho, events)
manager.init()
;(manager.controls as unknown as { fire(e: string): void }).fire('end')
@@ -104,7 +123,7 @@ describe('ControlsManager', () => {
describe('updateCamera', () => {
it('rebinds controls to the new camera, copies position from the previous one, and preserves the target', () => {
manager = new ControlsManager(makeElement(), camera, events)
manager = new ControlsManager(makeRenderer(), camera, events)
camera.position.set(7, 8, 9)
manager.controls.target.set(1, 1, 1)
@@ -120,7 +139,7 @@ describe('ControlsManager', () => {
describe('update / reset', () => {
it('update delegates to controls.update', () => {
manager = new ControlsManager(makeElement(), camera, events)
manager = new ControlsManager(makeRenderer(), camera, events)
manager.update()
@@ -128,7 +147,7 @@ describe('ControlsManager', () => {
})
it('reset clears the target back to the origin and refreshes', () => {
manager = new ControlsManager(makeElement(), camera, events)
manager = new ControlsManager(makeRenderer(), camera, events)
manager.controls.target.set(5, 6, 7)
manager.reset()
@@ -140,7 +159,7 @@ describe('ControlsManager', () => {
describe('dispose', () => {
it('disposes the underlying OrbitControls', () => {
manager = new ControlsManager(makeElement(), camera, events)
manager = new ControlsManager(makeRenderer(), camera, events)
manager.dispose()
@@ -150,7 +169,7 @@ describe('ControlsManager', () => {
describe('detach / attach', () => {
it('detach disables OrbitControls interaction', () => {
manager = new ControlsManager(makeElement(), camera, events)
manager = new ControlsManager(makeRenderer(), camera, events)
expect(manager.controls.enabled).toBe(true)
manager.detach()
@@ -159,7 +178,7 @@ describe('ControlsManager', () => {
})
it('attach re-enables OrbitControls interaction', () => {
manager = new ControlsManager(makeElement(), camera, events)
manager = new ControlsManager(makeRenderer(), camera, events)
manager.detach()
manager.attach()

View File

@@ -12,14 +12,15 @@ export class ControlsManager implements ControlsManagerInterface {
private camera: THREE.Camera
constructor(
interactionElement: HTMLElement,
renderer: THREE.WebGLRenderer,
camera: THREE.Camera,
eventManager: EventManagerInterface
) {
this.eventManager = eventManager
this.camera = camera
this.controls = new OrbitControls(camera, interactionElement)
const container = renderer.domElement.parentElement || renderer.domElement
this.controls = new OrbitControls(camera, container)
this.controls.enableDamping = true
}

View File

@@ -55,7 +55,7 @@ function makeMockOrbitControls() {
describe('GizmoManager', () => {
let scene: THREE.Scene
let interactionElement: HTMLElement
let renderer: THREE.WebGLRenderer
let camera: THREE.PerspectiveCamera
let orbitControls: ReturnType<typeof makeMockOrbitControls>
let manager: GizmoManager
@@ -66,7 +66,9 @@ describe('GizmoManager', () => {
vi.clearAllMocks()
scene = new THREE.Scene()
interactionElement = document.createElement('div')
renderer = {
domElement: document.createElement('canvas')
} as unknown as THREE.WebGLRenderer
camera = new THREE.PerspectiveCamera()
orbitControls = makeMockOrbitControls()
onTransformChange = vi.fn()
@@ -78,7 +80,7 @@ describe('GizmoManager', () => {
manager = new GizmoManager(
scene,
interactionElement,
renderer,
orbitControls,
() => camera,
onTransformChange

View File

@@ -15,19 +15,19 @@ export class GizmoManager {
private activeCamera: THREE.Camera
private mode: GizmoMode = 'translate'
private scene: THREE.Scene
private interactionElement: HTMLElement
private renderer: THREE.WebGLRenderer
private orbitControls: OrbitControls
private onTransformChange?: () => void
constructor(
scene: THREE.Scene,
interactionElement: HTMLElement,
renderer: THREE.WebGLRenderer,
orbitControls: OrbitControls,
getActiveCamera: () => THREE.Camera,
onTransformChange?: () => void
) {
this.scene = scene
this.interactionElement = interactionElement
this.renderer = renderer
this.orbitControls = orbitControls
this.activeCamera = getActiveCamera()
this.onTransformChange = onTransformChange
@@ -36,7 +36,7 @@ export class GizmoManager {
init(): void {
this.transformControls = new TransformControls(
this.activeCamera,
this.interactionElement
this.renderer.domElement
)
this.transformControls.addEventListener('dragging-changed', (event) => {

View File

@@ -1,8 +1,6 @@
import * as THREE from 'three'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import { createRendererViewState } from '@/renderer/three/sharedWebGLRenderer'
import { HDRIManager } from './HDRIManager'
import Load3dUtils from './Load3dUtils'
@@ -78,12 +76,7 @@ describe('HDRIManager', () => {
dispose: vi.fn()
})
manager = new HDRIManager(
scene,
{} as THREE.WebGLRenderer,
createRendererViewState(),
eventManager
)
manager = new HDRIManager(scene, {} as THREE.WebGLRenderer, eventManager)
})
afterEach(() => {

View File

@@ -2,14 +2,12 @@ import * as THREE from 'three'
import { EXRLoader } from 'three/examples/jsm/loaders/EXRLoader'
import { RGBELoader } from 'three/examples/jsm/loaders/RGBELoader'
import type { RendererViewState } from '@/renderer/three/sharedWebGLRenderer'
import Load3dUtils from './Load3dUtils'
import type { EventManagerInterface } from './interfaces'
export class HDRIManager {
private scene: THREE.Scene
private viewState: RendererViewState
private renderer: THREE.WebGLRenderer
private pmremGenerator: THREE.PMREMGenerator
private eventManager: EventManagerInterface
@@ -35,11 +33,10 @@ export class HDRIManager {
constructor(
scene: THREE.Scene,
renderer: THREE.WebGLRenderer,
viewState: RendererViewState,
eventManager: EventManagerInterface
) {
this.scene = scene
this.viewState = viewState
this.renderer = renderer
this.pmremGenerator = new THREE.PMREMGenerator(renderer)
this.pmremGenerator.compileEquirectangularShader()
this.eventManager = eventManager
@@ -104,8 +101,8 @@ export class HDRIManager {
this.scene.environment = envMap
this.scene.environmentIntensity = this._intensity
this.scene.background = this._showAsBackground ? this.hdriTexture : null
this.viewState.toneMapping = THREE.ACESFilmicToneMapping
this.viewState.toneMappingExposure = 1.0
this.renderer.toneMapping = THREE.ACESFilmicToneMapping
this.renderer.toneMappingExposure = 1.0
this.eventManager.emitEvent('hdriChange', {
enabled: this._isEnabled,
showAsBackground: this._showAsBackground
@@ -117,8 +114,8 @@ export class HDRIManager {
if (this.scene.background === this.hdriTexture) {
this.scene.background = null
}
this.viewState.toneMapping = THREE.NoToneMapping
this.viewState.toneMappingExposure = 1.0
this.renderer.toneMapping = THREE.NoToneMapping
this.renderer.toneMappingExposure = 1.0
this.eventManager.emitEvent('hdriChange', {
enabled: false,
showAsBackground: this._showAsBackground

View File

@@ -334,7 +334,7 @@ describe('Load3d', () => {
const sceneResize = vi.fn()
Object.assign(ctx.load3d, {
view: { canvas, setSize },
renderer: { domElement: canvas, setSize, setPixelRatio: vi.fn() },
targetWidth: 400,
targetHeight: 200,
targetAspectRatio: 2,
@@ -361,21 +361,26 @@ describe('Load3d', () => {
const updateAspectRatio = vi.fn()
const renderBackground = vi.fn()
const canvas = document.createElement('canvas')
Object.defineProperty(canvas, 'clientWidth', {
value: 800,
configurable: true
})
Object.defineProperty(canvas, 'clientHeight', {
value: 600,
configurable: true
})
const scene = {} as THREE.Scene
Object.assign(ctx.load3d, {
view: {
width: 800,
height: 600,
state: { clearColor: new THREE.Color(0x000000), clearAlpha: 0 },
renderer: {
setViewport,
setScissor,
setScissorTest,
setClearColor,
clear,
render
}
renderer: {
domElement: canvas,
setViewport,
setScissor,
setScissorTest,
setClearColor,
clear,
render
},
targetWidth: 400,
targetHeight: 200,
@@ -410,7 +415,7 @@ describe('Load3d', () => {
})
Object.assign(ctx.load3d, {
view: { canvas },
renderer: { domElement: canvas },
targetWidth: 400,
targetHeight: 200,
targetAspectRatio: 2,
@@ -433,7 +438,7 @@ describe('Load3d', () => {
expect(args[3]).toBe(400)
})
it('handleResize scales the view size by getZoomScaleCallback', () => {
it('handleResize calls setPixelRatio with the value returned by getZoomScaleCallback', () => {
delete (ctx.load3d as { handleResize?: unknown }).handleResize
const parent = document.createElement('div')
@@ -448,10 +453,10 @@ describe('Load3d', () => {
const canvas = document.createElement('canvas')
parent.appendChild(canvas)
const setSize = vi.fn()
const setPixelRatio = vi.fn()
Object.assign(ctx.load3d, {
view: { canvas, setSize },
renderer: { domElement: canvas, setSize: vi.fn(), setPixelRatio },
getZoomScaleCallback: () => 2.5,
targetWidth: 0,
targetHeight: 0,
@@ -462,10 +467,10 @@ describe('Load3d', () => {
ctx.load3d.handleResize()
expect(setSize).toHaveBeenCalledWith(1000, 1000)
expect(setPixelRatio).toHaveBeenCalledWith(2.5)
})
it('handleResize caps the zoom scale at 3', () => {
it('handleResize defaults to pixelRatio 1 when no getZoomScaleCallback is provided', () => {
delete (ctx.load3d as { handleResize?: unknown }).handleResize
const parent = document.createElement('div')
@@ -480,42 +485,10 @@ describe('Load3d', () => {
const canvas = document.createElement('canvas')
parent.appendChild(canvas)
const setSize = vi.fn()
const setPixelRatio = vi.fn()
Object.assign(ctx.load3d, {
view: { canvas, setSize },
getZoomScaleCallback: () => 10,
targetWidth: 0,
targetHeight: 0,
isViewerMode: false,
cameraManager: { ...ctx.cameraManager, handleResize: vi.fn() },
sceneManager: { ...ctx.sceneManager, handleResize: vi.fn() }
})
ctx.load3d.handleResize()
expect(setSize).toHaveBeenCalledWith(1200, 1200)
})
it('handleResize defaults to scale 1 when no getZoomScaleCallback is provided', () => {
delete (ctx.load3d as { handleResize?: unknown }).handleResize
const parent = document.createElement('div')
Object.defineProperty(parent, 'clientWidth', {
value: 400,
configurable: true
})
Object.defineProperty(parent, 'clientHeight', {
value: 400,
configurable: true
})
const canvas = document.createElement('canvas')
parent.appendChild(canvas)
const setSize = vi.fn()
Object.assign(ctx.load3d, {
view: { canvas, setSize },
renderer: { domElement: canvas, setSize: vi.fn(), setPixelRatio },
getZoomScaleCallback: undefined,
targetWidth: 0,
targetHeight: 0,
@@ -526,7 +499,7 @@ describe('Load3d', () => {
ctx.load3d.handleResize()
expect(setSize).toHaveBeenCalledWith(400, 400)
expect(setPixelRatio).toHaveBeenCalledWith(1)
})
})
@@ -537,8 +510,7 @@ describe('Load3d', () => {
const viewHelperRender = vi.fn()
const controlsUpdate = vi.fn()
const renderMainScene = vi.fn()
const beginRender = vi.fn()
const blit = vi.fn()
const resetViewport = vi.fn()
Object.assign(ctx.load3d, {
STATUS_MOUSE_ON_NODE: true,
@@ -553,16 +525,13 @@ describe('Load3d', () => {
},
viewHelperManager: {
update: viewHelperUpdate,
render: viewHelperRender
viewHelper: { render: viewHelperRender }
},
controlsManager: { update: controlsUpdate },
recordingManager: { getIsRecording: vi.fn(() => false) },
renderMainScene,
view: {
beginRender,
blit,
renderer: { setScissorTest: vi.fn() }
}
resetViewport,
renderer: {}
})
;(ctx.load3d as unknown as { startAnimation(): void }).startAnimation()
@@ -577,10 +546,9 @@ describe('Load3d', () => {
expect(animationUpdate).toHaveBeenCalledOnce()
expect(viewHelperUpdate).toHaveBeenCalledOnce()
expect(controlsUpdate).toHaveBeenCalledOnce()
expect(beginRender).toHaveBeenCalledOnce()
expect(renderMainScene).toHaveBeenCalledOnce()
expect(resetViewport).toHaveBeenCalledOnce()
expect(viewHelperRender).toHaveBeenCalledOnce()
expect(blit).toHaveBeenCalledOnce()
// Cancel the queued rAF so the test doesn't leak frames.
loop.stop()
@@ -592,10 +560,12 @@ describe('Load3d', () => {
Object.assign(ctx.load3d, {
renderLoop: { stop },
resizeObserver: null,
contextMenuAbortController: null,
view: {
canvas,
dispose: vi.fn()
renderer: {
forceContextLoss: vi.fn(),
dispose: vi.fn(),
domElement: canvas
},
sceneManager: { ...ctx.sceneManager, dispose: vi.fn() },
cameraManager: { ...ctx.cameraManager, dispose: vi.fn() },

View File

@@ -67,7 +67,7 @@ class Load3d extends Viewport3d {
private hasLoadedModel: boolean = false
constructor(
container: HTMLElement,
container: Element | HTMLElement,
deps: Load3dDeps,
options: Load3DOptions = {}
) {
@@ -255,8 +255,8 @@ class Load3d extends Viewport3d {
this.sceneManager.backgroundTexture &&
this.sceneManager.backgroundMesh
) {
const containerWidth = this.domElement.clientWidth
const containerHeight = this.domElement.clientHeight
const containerWidth = this.renderer.domElement.clientWidth
const containerHeight = this.renderer.domElement.clientHeight
if (this.shouldMaintainAspectRatio()) {
const { width, height } = computeLetterboxedViewport(

View File

@@ -64,16 +64,16 @@ function makeStream(): MediaStream {
} as unknown as MediaStream
}
function makeSourceCanvas(): HTMLCanvasElement {
function makeRenderer(): THREE.WebGLRenderer {
const canvas = document.createElement('canvas')
canvas.width = 800
canvas.height = 600
return canvas
return { domElement: canvas } as unknown as THREE.WebGLRenderer
}
describe('RecordingManager', () => {
let scene: THREE.Scene
let sourceCanvas: HTMLCanvasElement
let renderer: THREE.WebGLRenderer
let events: ReturnType<typeof makeMockEventManager>
let manager: RecordingManager
let rafSpy: ReturnType<typeof vi.spyOn>
@@ -104,9 +104,9 @@ describe('RecordingManager', () => {
vi.spyOn(window, 'cancelAnimationFrame').mockImplementation(() => {})
scene = new THREE.Scene()
sourceCanvas = makeSourceCanvas()
renderer = makeRenderer()
events = makeMockEventManager()
manager = new RecordingManager(scene, sourceCanvas, events)
manager = new RecordingManager(scene, renderer, events)
})
afterEach(() => {

View File

@@ -11,7 +11,7 @@ export class RecordingManager {
private recordingStream: MediaStream | null = null
private recordingIndicator: THREE.Sprite | null = null
private scene: THREE.Scene
private sourceCanvas: HTMLCanvasElement
private renderer: THREE.WebGLRenderer
private eventManager: EventManagerInterface
private recordingStartTime: number = 0
private recordingDuration: number = 0
@@ -21,11 +21,11 @@ export class RecordingManager {
constructor(
scene: THREE.Scene,
sourceCanvas: HTMLCanvasElement,
renderer: THREE.WebGLRenderer,
eventManager: EventManagerInterface
) {
this.scene = scene
this.sourceCanvas = sourceCanvas
this.renderer = renderer
this.eventManager = eventManager
this.setupRecordingIndicator()
}
@@ -61,7 +61,7 @@ export class RecordingManager {
}
try {
const sourceCanvas = this.sourceCanvas
const sourceCanvas = this.renderer.domElement
const sourceWidth = sourceCanvas.width
const sourceHeight = sourceCanvas.height

View File

@@ -3,9 +3,6 @@ import * as THREE from 'three'
import type { OrbitControls } from 'three/examples/jsm/controls/OrbitControls'
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
import type { RendererView } from '@/renderer/three/RendererView'
import { createRendererViewState } from '@/renderer/three/sharedWebGLRenderer'
import type { EventManagerInterface } from './interfaces'
import Load3dUtils from './Load3dUtils'
import { SceneManager } from './SceneManager'
@@ -68,32 +65,6 @@ function makeMockEventManager() {
} satisfies EventManagerInterface
}
function makeView(
renderer: THREE.WebGLRenderer,
width = 400,
height = 300
): RendererView {
const canvas = document.createElement('canvas')
Object.defineProperty(canvas, 'clientWidth', {
configurable: true,
value: width
})
Object.defineProperty(canvas, 'clientHeight', {
configurable: true,
value: height
})
return {
renderer,
canvas,
state: createRendererViewState(),
width,
height,
beginRender: vi.fn(),
blit: vi.fn(),
setSize: vi.fn()
} as unknown as RendererView
}
function makeRenderer() {
const canvas = document.createElement('canvas')
Object.defineProperty(canvas, 'clientWidth', {
@@ -149,7 +120,7 @@ describe('SceneManager', () => {
camera = new THREE.PerspectiveCamera()
events = makeMockEventManager()
manager = new SceneManager(
makeView(renderer),
renderer,
() => camera,
() => ({}) as unknown as OrbitControls,
events
@@ -621,22 +592,20 @@ describe('SceneManager', () => {
function makeSceneManager(
pixelRatio = 1,
cameraOverride?: THREE.PerspectiveCamera | THREE.OrthographicCamera,
viewSize?: { width: number; height: number }
cameraOverride?: THREE.PerspectiveCamera | THREE.OrthographicCamera
) {
const renderer = makeMockRenderer(pixelRatio)
const view = makeView(renderer, viewSize?.width, viewSize?.height)
const camera = cameraOverride ?? new THREE.PerspectiveCamera()
const eventManager = makeMockEventManager()
const manager = new SceneManager(
view,
renderer,
() => camera,
vi.fn() as unknown as () => InstanceType<
typeof import('three/examples/jsm/controls/OrbitControls').OrbitControls
>,
eventManager
)
return { manager, renderer, view, camera, eventManager }
return { manager, renderer, camera, eventManager }
}
describe('SceneManager.captureScene', () => {
@@ -679,19 +648,6 @@ describe('SceneManager.captureScene', () => {
expect(calls.at(-1)).toEqual([400, 300])
})
it('restores the view state first and resizes the background to the view size, not the shared buffer size', async () => {
const { manager, view } = makeSceneManager(1, undefined, {
width: 640,
height: 480
})
const handleResize = vi.spyOn(manager, 'handleResize')
await manager.captureScene(1920, 1080)
expect(view.beginRender).toHaveBeenCalledOnce()
expect(handleResize).toHaveBeenCalledWith(640, 480)
})
it('restores perspective camera aspect after capture', async () => {
const camera = new THREE.PerspectiveCamera(75, 1, 0.1, 1000)
const { manager } = makeSceneManager(1, camera)

View File

@@ -2,8 +2,6 @@ import { SparkRenderer } from '@sparkjsdev/spark'
import * as THREE from 'three'
import { OrbitControls } from 'three/examples/jsm/controls/OrbitControls'
import type { RendererView } from '@/renderer/three/RendererView'
import Load3dUtils from './Load3dUtils'
import {
type BackgroundRenderModeType,
@@ -40,18 +38,16 @@ export class SceneManager implements SceneManagerInterface {
private eventManager: EventManagerInterface
private renderer: THREE.WebGLRenderer
private view: RendererView
private getActiveCamera: () => THREE.Camera
constructor(
view: RendererView,
renderer: THREE.WebGLRenderer,
getActiveCamera: () => THREE.Camera,
_getControls: () => OrbitControls,
eventManager: EventManagerInterface
) {
this.view = view
this.renderer = view.renderer
this.renderer = renderer
this.eventManager = eventManager
this.scene = new THREE.Scene()
@@ -69,7 +65,7 @@ export class SceneManager implements SceneManagerInterface {
// forceRender directly into onDirty caused a per-frame render-setDirty
// cascade that made splats visibly "balloon" during camera interaction.
this.sparkRenderer = new SparkRenderer({
renderer: view.renderer,
renderer,
onDirty: () => {
const resolve = this.nextSparkDirtyResolve
this.nextSparkDirtyResolve = null
@@ -108,8 +104,7 @@ export class SceneManager implements SceneManagerInterface {
this.backgroundMesh.position.set(0, 0, 0)
this.backgroundScene.add(this.backgroundMesh)
this.view.state.clearColor.set(0x000000)
this.view.state.clearAlpha = 0
this.renderer.setClearColor(0x000000, 0)
}
init(): void {}
@@ -255,8 +250,8 @@ export class SceneManager implements SceneManagerInterface {
this.updateBackgroundSize(
this.backgroundTexture,
this.backgroundMesh,
this.view.canvas.clientWidth,
this.view.canvas.clientHeight
this.renderer.domElement.clientWidth,
this.renderer.domElement.clientHeight
)
}
@@ -374,8 +369,6 @@ export class SceneManager implements SceneManagerInterface {
width: number,
height: number
): Promise<{ scene: string; mask: string; normal: string }> {
this.view.beginRender()
const originalSize = new THREE.Vector2()
this.renderer.getSize(originalSize)
const originalPixelRatio = this.renderer.getPixelRatio()
@@ -502,10 +495,7 @@ export class SceneManager implements SceneManagerInterface {
this.renderer.setPixelRatio(originalPixelRatio)
this.renderer.setSize(originalSize.x, originalSize.y)
this.renderer.outputColorSpace = originalOutputColorSpace
this.handleResize(
this.view.canvas.clientWidth,
this.view.canvas.clientHeight
)
this.handleResize(originalSize.x, originalSize.y)
}
}

View File

@@ -2,13 +2,18 @@ import { SparkRenderer } from '@sparkjsdev/spark'
import * as THREE from 'three'
import { describe, expect, it, vi } from 'vitest'
import { createRendererViewState } from '@/renderer/three/sharedWebGLRenderer'
import { DEFAULT_MODEL_CAPABILITIES } from './ModelAdapter'
import type { ModelAdapterCapabilities } from './ModelAdapter'
import { SceneModelManager } from './SceneModelManager'
import type { EventManagerInterface } from './interfaces'
function createMockRenderer(): THREE.WebGLRenderer {
return {
outputColorSpace: THREE.SRGBColorSpace,
dispose: vi.fn()
} as unknown as THREE.WebGLRenderer
}
function createMockEventManager(): EventManagerInterface {
return {
addEventListener: vi.fn(),
@@ -25,7 +30,7 @@ function createManager(
} = {}
) {
const scene = overrides.scene ?? new THREE.Scene()
const viewState = createRendererViewState()
const renderer = createMockRenderer()
const eventManager = overrides.eventManager ?? createMockEventManager()
const camera = new THREE.PerspectiveCamera()
const getActiveCamera = () => camera
@@ -38,7 +43,7 @@ function createManager(
const manager = new SceneModelManager(
scene,
viewState,
renderer,
eventManager,
getActiveCamera,
setupCamera,
@@ -49,7 +54,7 @@ function createManager(
return {
manager,
scene,
viewState,
renderer,
eventManager,
camera,
setupCamera,
@@ -62,6 +67,7 @@ function createManagerWithPose(opts: {
pose: { size: THREE.Vector3; center: THREE.Vector3 } | null
}) {
const scene = new THREE.Scene()
const renderer = createMockRenderer()
const eventManager = createMockEventManager()
const camera = new THREE.PerspectiveCamera()
const setupCamera = vi.fn()
@@ -73,7 +79,7 @@ function createManagerWithPose(opts: {
const manager = new SceneModelManager(
scene,
createRendererViewState(),
renderer,
eventManager,
() => camera,
setupCamera,
@@ -468,7 +474,7 @@ describe('SceneModelManager', () => {
})
it('switches to depth material', async () => {
const { manager, viewState } = createManager()
const { manager, renderer } = createManager()
const model = createMeshModel()
await manager.setupModel(model)
@@ -476,7 +482,7 @@ describe('SceneModelManager', () => {
const mesh = model.children[0] as THREE.Mesh
expect(mesh.material).toBeInstanceOf(THREE.MeshDepthMaterial)
expect(viewState.outputColorSpace).toBe(THREE.LinearSRGBColorSpace)
expect(renderer.outputColorSpace).toBe(THREE.LinearSRGBColorSpace)
})
it('restores original material when switching back', async () => {
@@ -507,16 +513,16 @@ describe('SceneModelManager', () => {
expect((mesh.material as THREE.MeshStandardMaterial).map).toBe(texture)
})
it('sets view color space to SRGB for non-depth modes', async () => {
const { manager, viewState } = createManager()
it('sets renderer color space to SRGB for non-depth modes', async () => {
const { manager, renderer } = createManager()
const model = createMeshModel()
await manager.setupModel(model)
manager.setMaterialMode('depth')
expect(viewState.outputColorSpace).toBe(THREE.LinearSRGBColorSpace)
expect(renderer.outputColorSpace).toBe(THREE.LinearSRGBColorSpace)
manager.setMaterialMode('normal')
expect(viewState.outputColorSpace).toBe(THREE.SRGBColorSpace)
expect(renderer.outputColorSpace).toBe(THREE.SRGBColorSpace)
})
it('delegates to handlePLYModeSwitch for BufferGeometry original model', async () => {

View File

@@ -2,8 +2,6 @@ import { SparkRenderer } from '@sparkjsdev/spark'
import * as THREE from 'three'
import type { GLTF } from 'three/examples/jsm/loaders/GLTFLoader'
import type { RendererViewState } from '@/renderer/three/sharedWebGLRenderer'
import { DEFAULT_MODEL_CAPABILITIES } from './ModelAdapter'
import type { ModelAdapterCapabilities } from './ModelAdapter'
import { buildPointCloudForMaterialMode } from './PointCloudModelAdapter'
@@ -39,7 +37,7 @@ export class SceneModelManager implements ModelManagerInterface {
showSkeleton: boolean = false
private scene: THREE.Scene
private viewState: RendererViewState
private renderer: THREE.WebGLRenderer
private eventManager: EventManagerInterface
private activeCamera: THREE.Camera
private setupCamera: (size: THREE.Vector3, center: THREE.Vector3) => void
@@ -54,7 +52,7 @@ export class SceneModelManager implements ModelManagerInterface {
constructor(
scene: THREE.Scene,
viewState: RendererViewState,
renderer: THREE.WebGLRenderer,
eventManager: EventManagerInterface,
getActiveCamera: () => THREE.Camera,
setupCamera: (size: THREE.Vector3, center: THREE.Vector3) => void,
@@ -70,7 +68,7 @@ export class SceneModelManager implements ModelManagerInterface {
} | null = () => null
) {
this.scene = scene
this.viewState = viewState
this.renderer = renderer
this.eventManager = eventManager
this.activeCamera = getActiveCamera()
this.setupCamera = setupCamera
@@ -198,9 +196,9 @@ export class SceneModelManager implements ModelManagerInterface {
}
if (mode === 'depth') {
this.viewState.outputColorSpace = THREE.LinearSRGBColorSpace
this.renderer.outputColorSpace = THREE.LinearSRGBColorSpace
} else {
this.viewState.outputColorSpace = THREE.SRGBColorSpace
this.renderer.outputColorSpace = THREE.SRGBColorSpace
}
if (this.currentModel) {

View File

@@ -15,16 +15,6 @@ export class ViewHelperManager implements ViewHelperManagerInterface {
private getControls: () => OrbitControls
private eventManager: EventManagerInterface
private readonly helperCamera = new THREE.OrthographicCamera(
-2,
2,
2,
-2,
0,
4
)
private readonly savedViewport = new THREE.Vector4()
constructor(
_renderer: THREE.WebGLRenderer,
getActiveCamera: () => THREE.Camera,
@@ -34,25 +24,10 @@ export class ViewHelperManager implements ViewHelperManagerInterface {
this.getActiveCamera = getActiveCamera
this.getControls = getControls
this.eventManager = eventManager
this.helperCamera.position.set(0, 0, 2)
}
init(): void {}
render(renderer: THREE.WebGLRenderer, size: number): void {
const helper = this.viewHelper
if (!helper.isViewHelper) return
helper.quaternion.copy(this.getActiveCamera().quaternion).invert()
helper.updateMatrixWorld()
renderer.clearDepth()
renderer.getViewport(this.savedViewport)
renderer.setViewport(0, 0, size, size)
renderer.render(helper, this.helperCamera)
renderer.setViewport(this.savedViewport)
}
dispose(): void {
if (this.viewHelper) {
this.viewHelper.dispose()

View File

@@ -394,10 +394,14 @@ describe('Viewport3d', () => {
initialRenderTimer: null,
startAnimation: vi.fn(),
renderLoop: { stop: vi.fn() },
resizeObserver: null,
disposeContextMenuGuard: null,
view: {
canvas: document.createElement('canvas'),
dispose: vi.fn()
renderer: {
forceContextLoss: vi.fn(),
dispose: vi.fn(),
domElement: Object.assign(document.createElement('canvas'), {
remove: vi.fn()
})
},
disposeManagers: vi.fn()
})

View File

@@ -1,6 +1,6 @@
import * as THREE from 'three'
import type { RendererView } from '@/renderer/three/RendererView'
import { WebGLViewport } from '@/renderer/three/WebGLViewport'
import type { CameraManager } from './CameraManager'
import type { ControlsManager } from './ControlsManager'
@@ -19,10 +19,8 @@ import type { RenderLoopHandle } from './load3dRenderLoop'
import { startRenderLoop } from './load3dRenderLoop'
import { computeLetterboxedViewport, isLoad3dActive } from './load3dViewport'
const VIEW_HELPER_SIZE = 128
export type Viewport3dDeps = {
view: RendererView
renderer: THREE.WebGLRenderer
eventManager: EventManager
sceneManager: SceneManager
cameraManager: CameraManager
@@ -31,8 +29,7 @@ export type Viewport3dDeps = {
viewHelperManager: ViewHelperManager
}
export class Viewport3d {
protected readonly view: RendererView
export class Viewport3d extends WebGLViewport {
protected clock: THREE.Clock
private renderLoop: RenderLoopHandle | null = null
private onContextMenuCallback?: (event: MouseEvent) => void
@@ -60,14 +57,13 @@ export class Viewport3d {
private externalActiveCamera: THREE.Camera | null = null
private overlay: SceneOverlay | null = null
private initialRenderTimer: ReturnType<typeof setTimeout> | null = null
private viewPixelScale = 1
constructor(
container: HTMLElement,
container: Element | HTMLElement,
deps: Viewport3dDeps,
options: Load3DOptions = {}
) {
this.view = deps.view
super(deps.renderer)
this.clock = new THREE.Clock()
this.isViewerMode = options.isViewerMode || false
this.onContextMenuCallback = options.onContextMenu
@@ -98,15 +94,7 @@ export class Viewport3d {
this.STATUS_MOUSE_ON_VIEWER = false
this.initContextMenu()
this.view.observeResize(container, () => this.handleResize())
}
get renderer(): THREE.WebGLRenderer {
return this.view.renderer
}
get domElement(): HTMLCanvasElement {
return this.view.canvas
this.observeResize(container, () => this.handleResize())
}
start(): void {
@@ -132,7 +120,7 @@ export class Viewport3d {
private initContextMenu(): void {
this.disposeContextMenuGuard = attachContextMenuGuard(
this.view.canvas,
this.renderer.domElement,
(event) => this.onContextMenuCallback?.(event),
{ isDisabled: () => this.isViewerMode }
)
@@ -171,21 +159,15 @@ export class Viewport3d {
forceRender(): void {
const delta = this.clock.getDelta()
this.tickPerFrame(delta)
this.renderView()
this.INITIAL_RENDER_DONE = true
}
private renderView(): void {
this.view.beginRender()
this.renderMainScene()
this.resetViewport()
this.renderer.setScissorTest(false)
this.viewHelperManager.render(
this.renderer,
VIEW_HELPER_SIZE * this.viewPixelScale
)
if (this.viewHelperManager.viewHelper.render) {
this.viewHelperManager.viewHelper.render(this.renderer)
}
this.view.blit()
this.INITIAL_RENDER_DONE = true
}
protected tickPerFrame(delta: number): void {
@@ -237,8 +219,8 @@ export class Viewport3d {
}
renderMainScene(): void {
const viewWidth = this.view.width
const viewHeight = this.view.height
const containerWidth = this.renderer.domElement.clientWidth
const containerHeight = this.renderer.domElement.clientHeight
if (this.getDimensionsCallback) {
const dims = this.getDimensionsCallback()
@@ -247,16 +229,15 @@ export class Viewport3d {
}
}
this.renderer.setViewport(0, 0, viewWidth, viewHeight)
this.renderer.setScissor(0, 0, viewWidth, viewHeight)
this.renderer.setScissorTest(true)
if (this.shouldMaintainAspectRatio()) {
const { offsetX, offsetY, width, height } = computeLetterboxedViewport(
{ width: viewWidth, height: viewHeight },
{ width: containerWidth, height: containerHeight },
this.targetAspectRatio
)
this.renderer.setViewport(0, 0, containerWidth, containerHeight)
this.renderer.setScissor(0, 0, containerWidth, containerHeight)
this.renderer.setScissorTest(true)
this.renderer.setClearColor(0x0a0a0a)
this.renderer.clear()
@@ -265,23 +246,34 @@ export class Viewport3d {
this.cameraManager.updateAspectRatio(width / height)
} else {
this.renderer.setClearColor(
this.view.state.clearColor,
this.view.state.clearAlpha
)
this.renderer.clear()
this.renderer.setViewport(0, 0, containerWidth, containerHeight)
this.renderer.setScissor(0, 0, containerWidth, containerHeight)
this.renderer.setScissorTest(true)
}
this.sceneManager.renderBackground()
this.renderer.render(this.sceneManager.scene, this.getRenderCamera())
}
resetViewport(): void {
const width = this.renderer.domElement.clientWidth
const height = this.renderer.domElement.clientHeight
this.renderer.setViewport(0, 0, width, height)
this.renderer.setScissor(0, 0, width, height)
this.renderer.setScissorTest(false)
}
protected startAnimation(): void {
this.renderLoop = startRenderLoop({
tick: () => {
const delta = this.clock.getDelta()
this.tickPerFrame(delta)
this.renderView()
this.renderMainScene()
this.resetViewport()
if (this.viewHelperManager.viewHelper.render) {
this.viewHelperManager.viewHelper.render(this.renderer)
}
},
isActive: () => this.isActive()
})
@@ -354,7 +346,7 @@ export class Viewport3d {
}
handleResize(): void {
const parentElement = this.view.canvas.parentElement
const parentElement = this.renderer?.domElement?.parentElement
if (!parentElement) {
console.warn('Parent element not found')
@@ -365,7 +357,7 @@ export class Viewport3d {
const containerHeight = parentElement.clientHeight
const zoomScale = this.getZoomScaleCallback?.() ?? 1
this.viewPixelScale = Math.min(zoomScale, 3)
this.renderer.setPixelRatio(Math.min(zoomScale, 3))
if (this.getDimensionsCallback) {
const dims = this.getDimensionsCallback()
@@ -374,20 +366,17 @@ export class Viewport3d {
}
}
this.view.setSize(
containerWidth * this.viewPixelScale,
containerHeight * this.viewPixelScale
)
if (this.shouldMaintainAspectRatio()) {
const { width, height } = computeLetterboxedViewport(
{ width: containerWidth, height: containerHeight },
this.targetAspectRatio
)
this.renderer.setSize(containerWidth, containerHeight)
this.cameraManager.handleResize(width, height)
this.sceneManager.handleResize(width, height)
} else {
this.renderer.setSize(containerWidth, containerHeight)
this.cameraManager.handleResize(containerWidth, containerHeight)
this.sceneManager.handleResize(containerWidth, containerHeight)
}
@@ -409,7 +398,7 @@ export class Viewport3d {
this.disposeManagers()
this.view.dispose()
this.disposeRenderer()
}
protected disposeManagers(): void {

View File

@@ -1,4 +1,4 @@
import { beforeEach, describe, expect, it, vi } from 'vitest'
import { describe, expect, it, vi } from 'vitest'
import { DEFAULT_MODEL_CAPABILITIES } from './ModelAdapter'
import type { ModelAdapter, ModelAdapterCapabilities } from './ModelAdapter'
@@ -20,14 +20,7 @@ vi.mock('three', async () => {
rendererCtor(opts)
}
setSize() {}
setPixelRatio() {}
setClearColor() {}
getSize(target: { set(x: number, y: number): unknown }) {
target.set(300, 300)
return target
}
forceContextLoss() {}
dispose() {}
}
}
})
@@ -170,12 +163,6 @@ function makeAdapter(overrides: Partial<ModelAdapter> = {}): ModelAdapter {
}
describe('createLoad3d', () => {
beforeEach(() => {
vi.spyOn(HTMLCanvasElement.prototype, 'getContext').mockReturnValue({
drawImage: vi.fn()
} as unknown as ReturnType<HTMLCanvasElement['getContext']>)
})
it('constructs the renderer with alpha + antialias and appends it to the container', () => {
rendererCtor.mockClear()
const container = createContainer()

View File

@@ -1,6 +1,4 @@
import type * as THREE from 'three'
import { RendererView } from '@/renderer/three/RendererView'
import * as THREE from 'three'
import { AnimationManager } from './AnimationManager'
import { CameraManager } from './CameraManager'
@@ -19,9 +17,25 @@ import { SceneModelManager } from './SceneModelManager'
import { ViewHelperManager } from './ViewHelperManager'
import type { Load3DOptions } from './interfaces'
function buildLoad3dDeps(container: HTMLElement): Load3dDeps {
const view = new RendererView(container)
const renderer = view.renderer
function createRenderer(container: Element | HTMLElement): THREE.WebGLRenderer {
const renderer = new THREE.WebGLRenderer({ alpha: true, antialias: true })
renderer.setSize(300, 300)
renderer.setClearColor(0x282828)
renderer.autoClear = false
renderer.outputColorSpace = THREE.SRGBColorSpace
renderer.domElement.classList.add(
'absolute',
'inset-0',
'h-full',
'w-full',
'outline-none'
)
container.appendChild(renderer.domElement)
return renderer
}
function buildLoad3dDeps(container: Element | HTMLElement): Load3dDeps {
const renderer = createRenderer(container)
const eventManager = new EventManager()
// Shared mutable handle: LoaderManager writes the active adapter on each
// load; SceneModelManager reads it for capability/bounds/dispose lookups
@@ -36,7 +50,7 @@ function buildLoad3dDeps(container: HTMLElement): Load3dDeps {
const getControls = () => controlsManager.controls
const sceneManager = new SceneManager(
view,
renderer,
getActiveCamera,
getControls,
eventManager
@@ -44,7 +58,7 @@ function buildLoad3dDeps(container: HTMLElement): Load3dDeps {
cameraManager = new CameraManager(renderer, eventManager)
controlsManager = new ControlsManager(
container,
renderer,
cameraManager.activeCamera,
eventManager
)
@@ -54,7 +68,6 @@ function buildLoad3dDeps(container: HTMLElement): Load3dDeps {
const hdriManager = new HDRIManager(
sceneManager.scene,
renderer,
view.state,
eventManager
)
const viewHelperManager = new ViewHelperManager(
@@ -66,7 +79,7 @@ function buildLoad3dDeps(container: HTMLElement): Load3dDeps {
const modelManager = new SceneModelManager(
sceneManager.scene,
view.state,
renderer,
eventManager,
getActiveCamera,
(size, center) => cameraManager.setupForModel(size, center),
@@ -85,14 +98,14 @@ function buildLoad3dDeps(container: HTMLElement): Load3dDeps {
)
const recordingManager = new RecordingManager(
sceneManager.scene,
view.canvas,
renderer,
eventManager
)
const animationManager = new AnimationManager(eventManager)
gizmoManager = new GizmoManager(
sceneManager.scene,
container,
renderer,
controlsManager.controls,
getActiveCamera,
() => {
@@ -106,7 +119,7 @@ function buildLoad3dDeps(container: HTMLElement): Load3dDeps {
)
return {
view,
renderer,
eventManager,
sceneManager,
cameraManager,
@@ -124,7 +137,7 @@ function buildLoad3dDeps(container: HTMLElement): Load3dDeps {
}
export function createLoad3d(
container: HTMLElement,
container: Element | HTMLElement,
options?: Load3DOptions
): Load3d {
return new Load3d(container, buildLoad3dDeps(container), options)

View File

@@ -3122,57 +3122,52 @@
"cloudOnboarding": {
"skipToCloudApp": "Skip to the cloud app",
"survey": {
"title": "Cloud Survey",
"title": "Let's get to know you",
"placeholder": "Survey questions placeholder",
"intro": "Help us tailor your ComfyUI experience.",
"intro": "A few quick questions so we can set up ComfyUI for you.",
"otherPlaceholder": "Tell us more",
"errors": {
"chooseAnOption": "Please choose an option.",
"selectAtLeastOne": "Please select at least one option.",
"describeAnswer": "Please describe your answer."
},
"steps": {
"usage": "How do you plan to use ComfyUI?",
"familiarity": "How familiar are you with ComfyUI?",
"intent": "What do you want to create with ComfyUI?",
"source": "Where did you hear about ComfyUI?"
"describeAnswer": "Please describe your answer.",
"answerTooLong": "Please keep your answer under {max} characters."
},
"options": {
"usage": {
"personal": "Personal use",
"work": "Work",
"education": "Education (student or educator)"
},
"familiarity": {
"new": "New — never used it",
"starting": "Beginner — following tutorials",
"basics": "Intermediate — comfortable with basics",
"advanced": "Advanced — build and edit workflows",
"expert": "Expert — I help others"
},
"intent": {
"workflows": "Custom workflows or pipelines",
"custom_nodes": "Custom nodes",
"videos": "Videos",
"images": "Images",
"3d_game": "3D assets / game assets",
"audio": "Audio / music",
"apps": "Simplified Apps from workflows",
"api": "API endpoints to run workflows",
"not_sure": "Not sure"
"video": "Video",
"workflows": "Workflows and pipelines",
"apps_api": "Apps and APIs",
"exploring": "Just exploring",
"other": "Something else",
"otherPlaceholder": "What do you want to make?"
},
"experience": {
"new": "New to ComfyUI",
"some": "I know my way around",
"pro": "I'm a power user"
},
"focus": {
"custom_nodes": "Custom nodes",
"pipelines": "Automated pipelines",
"products": "Products for others"
},
"source": {
"social": "Social media",
"friend": "A friend or colleague",
"search": "Web search",
"community": "A community or forum",
"other": "Somewhere else",
"otherPlaceholder": "Where did you find us?"
},
"source_social": {
"youtube": "YouTube",
"reddit": "Reddit",
"twitter": "Twitter / X",
"twitter": "X (Twitter)",
"instagram": "Instagram",
"tiktok": "TikTok",
"linkedin": "LinkedIn",
"friend": "Friend or colleague",
"search": "Google / search",
"newsletter": "Newsletter or blog",
"conference": "Conference or event",
"discord": "Discord / community",
"github": "GitHub",
"other": "Other"
"discord": "Discord"
}
}
},
@@ -3265,10 +3260,11 @@
"cloudForgotPassword_emailRequired": "Email is required",
"cloudForgotPassword_passwordResetSent": "Password reset sent",
"cloudForgotPassword_passwordResetError": "Failed to send password reset email",
"cloudSurvey_steps_usage": "How do you plan to use ComfyUI?",
"cloudSurvey_steps_familiarity": "How familiar are you with ComfyUI?",
"cloudSurvey_steps_intent": "What do you want to create with ComfyUI?",
"cloudSurvey_steps_source": "Where did you hear about ComfyUI?",
"cloudSurvey_steps_intent": "What do you want to make?",
"cloudSurvey_steps_experience": "How well do you know ComfyUI?",
"cloudSurvey_steps_focus": "What are you building?",
"cloudSurvey_steps_source": "How did you find us?",
"cloudSurvey_steps_source_social": "Which platform?",
"assetBrowser": {
"allCategory": "All {category}",
"allModels": "All Models",
@@ -3740,7 +3736,8 @@
"outputExamples": "Examples: 'Save Image' or 'Save Video'",
"switchToOutputsButton": "Switch to Outputs",
"outputs": "Outputs",
"resultsLabel": "Results generated from the selected output node(s) will be shown here after running this app"
"resultsLabel": "Results generated from the selected output node(s) will be shown here after running this app",
"descriptionPlaceholder": "Double click to add a description"
},
"builder": {
"title": "App builder mode",

View File

@@ -1,5 +1,12 @@
<template>
<div class="flex h-[700px] max-h-[85vh] w-[320px] max-w-[90vw] flex-col">
<div
class="dark-theme flex max-h-[85vh] w-full max-w-md flex-col overflow-y-auto px-4 sm:px-6"
>
<h1
class="-mb-1 font-inter text-xl/8 font-semibold tracking-wide text-primary-comfy-canvas sm:text-2xl/8"
>
{{ $t('cloudOnboarding.survey.title') }}
</h1>
<DynamicSurveyForm
:key="activeSurvey.version"
:survey="activeSurvey"

View File

@@ -0,0 +1,35 @@
import { render, screen } from '@testing-library/vue'
import { describe, expect, it } from 'vitest'
import { createMemoryHistory, createRouter } from 'vue-router'
import CloudTemplate from './CloudTemplate.vue'
const renderWithMeta = async (meta: Record<string, unknown>) => {
const router = createRouter({
history: createMemoryHistory(),
routes: [{ path: '/', name: 'test', component: CloudTemplate, meta }]
})
await router.push('/')
await router.isReady()
return render(CloudTemplate, {
global: {
plugins: [router],
stubs: {
CloudHeroCarousel: { template: '<div data-testid="hero" />' },
CloudTemplateFooter: true
}
}
})
}
describe('CloudTemplate', () => {
it('shows the hero carousel when the route does not hide it', async () => {
await renderWithMeta({})
expect(screen.getByTestId('hero')).toBeInTheDocument()
})
it('hides the hero carousel when route.meta.hideHero is set', async () => {
await renderWithMeta({ hideHero: true })
expect(screen.queryByTestId('hero')).not.toBeInTheDocument()
})
})

View File

@@ -13,15 +13,22 @@
</div>
<CloudTemplateFooter />
</div>
<div class="relative hidden flex-1 overflow-hidden py-2 pr-2 lg:block">
<div
v-if="!route.meta.hideHero"
class="relative hidden flex-1 overflow-hidden py-2 pr-2 lg:block"
>
<CloudHeroCarousel />
</div>
</div>
</template>
<script setup lang="ts">
import { useRoute } from 'vue-router'
import CloudHeroCarousel from '@/platform/cloud/onboarding/components/CloudHeroCarousel.vue'
import CloudTemplateFooter from '@/platform/cloud/onboarding/components/CloudTemplateFooter.vue'
const route = useRoute()
</script>
<style>
@import '../assets/css/fonts.css';

View File

@@ -5,20 +5,22 @@
<a
href="https://www.comfy.org/terms-of-service"
target="_blank"
class="cursor-pointer text-sm text-gray-600 no-underline"
rel="noopener noreferrer"
class="cursor-pointer text-sm text-primary-comfy-canvas/60 no-underline"
>
{{ t('auth.login.termsLink') }}
</a>
<a
href="https://www.comfy.org/privacy-policy"
target="_blank"
class="cursor-pointer text-sm text-gray-600 no-underline"
rel="noopener noreferrer"
class="cursor-pointer text-sm text-primary-comfy-canvas/60 no-underline"
>
{{ t('auth.login.privacyLink') }}
</a>
<a
href="https://support.comfy.org"
class="cursor-pointer text-sm text-gray-600 no-underline"
class="cursor-pointer text-sm text-primary-comfy-canvas/60 no-underline"
target="_blank"
rel="noopener noreferrer"
>

View File

@@ -94,7 +94,7 @@ export const cloudOnboardingRoutes: RouteRecordRaw[] = [
name: 'cloud-survey',
component: () =>
import('@/platform/cloud/onboarding/CloudSurveyView.vue'),
meta: { requiresAuth: true }
meta: { requiresAuth: true, hideHero: true }
},
{
path: 'oauth/consent',
@@ -106,7 +106,7 @@ export const cloudOnboardingRoutes: RouteRecordRaw[] = [
name: 'cloud-user-check',
component: () =>
import('@/platform/cloud/onboarding/UserCheckView.vue'),
meta: { requiresAuth: true }
meta: { requiresAuth: true, hideHero: true }
},
{
path: 'sorry-contact-support',

View File

@@ -0,0 +1,176 @@
import userEvent from '@testing-library/user-event'
import { render, screen } from '@testing-library/vue'
import { describe, expect, it } from 'vitest'
import { createI18n } from 'vue-i18n'
import enMessages from '@/locales/en/main.json'
import type { OnboardingSurveyField } from '@/platform/remoteConfig/types'
import DynamicSurveyField from './DynamicSurveyField.vue'
const renderField = (
field: OnboardingSurveyField,
props: {
modelValue?: string | string[]
otherValue?: string
errorMessage?: string
} = {},
locale = 'en'
) =>
render(DynamicSurveyField, {
global: {
plugins: [
createI18n({ legacy: false, locale, messages: { en: enMessages } })
]
},
props: { field, modelValue: undefined, ...props }
})
const optionButton = (label: string) =>
screen.getByRole('button', { name: label })
describe('DynamicSurveyField', () => {
const singleField: OnboardingSurveyField = {
id: 'intent',
type: 'single',
label: 'What do you want to make?',
required: true,
options: [
{ value: 'images', label: 'Images', icon: 'icon-[lucide--image]' },
{ value: 'video', label: 'Video' }
]
}
it('renders the label and one card per option', () => {
renderField(singleField)
expect(screen.getByText('What do you want to make?')).toBeVisible()
expect(screen.getByText('Images')).toBeInTheDocument()
expect(screen.getByText('Video')).toBeInTheDocument()
})
it('emits the chosen value for a single-select card', async () => {
const user = userEvent.setup()
const { emitted } = renderField(singleField)
await user.click(screen.getByText('Images'))
expect(emitted()['update:modelValue']?.[0]).toEqual(['images'])
})
it('marks the selected single card as on (aria-pressed/state)', () => {
renderField(singleField, { modelValue: 'images' })
expect(optionButton('Images')).toHaveAttribute('data-state', 'on')
expect(optionButton('Video')).toHaveAttribute('data-state', 'off')
})
it('gives each option card a stable "<fieldId>-<value>" id', () => {
renderField(singleField)
expect(optionButton('Images')).toHaveAttribute('id', 'intent-images')
expect(optionButton('Video')).toHaveAttribute('id', 'intent-video')
})
const multiField: OnboardingSurveyField = {
id: 'making',
type: 'multi',
label: 'Pick some',
required: true,
options: [
{ value: 'a', label: 'Making A' },
{ value: 'b', label: 'Making B' }
]
}
it('emits an array for a multi-select card and reflects current selection', async () => {
const user = userEvent.setup()
const { emitted } = renderField(multiField, { modelValue: ['a'] })
expect(optionButton('Making A')).toHaveAttribute('data-state', 'on')
await user.click(screen.getByText('Making B'))
const events = emitted()['update:modelValue'] as unknown[][] | undefined
const last = events?.at(-1)?.[0]
expect(last).toEqual(expect.arrayContaining(['a', 'b']))
})
it('shows the "other" free-text input only when "other" is selected and emits it', async () => {
const user = userEvent.setup()
const otherField: OnboardingSurveyField = {
id: 'source',
type: 'single',
label: 'How did you find us?',
required: true,
allowOther: true,
otherFieldId: 'sourceOther',
options: [
{ value: 'search', label: 'Web search' },
{ value: 'other', label: 'Somewhere else' }
]
}
const { rerender, emitted } = renderField(otherField, {
modelValue: 'search'
})
expect(
screen.queryByPlaceholderText('Where did you find us?')
).not.toBeInTheDocument()
await rerender({ field: otherField, modelValue: 'other', otherValue: '' })
const input = screen.getByPlaceholderText('Where did you find us?')
await user.type(input, 'A podcast')
expect(emitted()['update:otherValue']?.length).toBeGreaterThan(0)
})
it('renders a text field and emits typed input', async () => {
const user = userEvent.setup()
const textField: OnboardingSurveyField = {
id: 'note',
type: 'text',
label: 'Anything else?',
placeholder: 'Your note'
}
const { emitted } = renderField(textField)
await user.type(screen.getByPlaceholderText('Your note'), 'Hi')
expect(emitted()['update:modelValue']?.length).toBeGreaterThan(0)
})
it('resolves labels via labelKey, locale map, and falls back to the value', () => {
renderField(
{
id: 'q',
type: 'single',
labelKey: 'cloudSurvey_steps_intent',
options: [
{ value: 'x', label: { en: 'Ex', ko: '엑스' } },
{ value: 'raw' } // no label → falls back to the value
]
},
{}
)
expect(screen.getByText('What do you want to make?')).toBeVisible()
expect(screen.getByText('Ex')).toBeInTheDocument()
expect(screen.getByText('raw')).toBeInTheDocument()
})
it('resolves a field label from a locale map when no labelKey is set', () => {
renderField({
id: 'q',
type: 'single',
label: { en: 'Server question', ko: '서버 질문' },
options: [{ value: 'a', label: 'A' }]
})
expect(screen.getByText('Server question')).toBeVisible()
})
it('falls back to the field id when neither labelKey nor label resolves', () => {
renderField({
id: 'bare_field_id',
type: 'single',
options: [{ value: 'a', label: 'A' }]
})
expect(screen.getByText('bare_field_id')).toBeVisible()
})
it('renders the error message when provided', () => {
renderField(singleField, { errorMessage: 'Please choose an option.' })
expect(screen.getByText('Please choose an option.')).toBeVisible()
})
})

View File

@@ -2,62 +2,72 @@
<fieldset
v-if="field.type !== 'text'"
:aria-invalid="Boolean(errorMessage)"
class="flex flex-col gap-4 border-0 p-0"
class="m-0 flex flex-col gap-4 border-0 p-0"
>
<legend class="mb-2 block text-lg font-medium text-base-foreground">
<legend class="mb-2 block text-lg font-medium text-primary-comfy-canvas">
{{ resolvedLabel }}
</legend>
<template v-if="field.type === 'single'">
<div
<ToggleGroup
v-if="field.type === 'single'"
:model-value="(modelValue as string) ?? ''"
type="single"
class="flex w-full flex-col gap-2"
@update:model-value="onSingleChange"
>
<ToggleGroupItem
v-for="option in field.options"
:id="`${field.id}-${option.value}`"
:key="option.value"
class="flex items-center gap-3"
:value="option.value"
:class="optionCardClass"
>
<RadioButton
:model-value="(modelValue as string) ?? ''"
:input-id="`${field.id}-${option.value}`"
:name="field.id"
:value="option.value"
:dt="checkedTokens"
@update:model-value="onSingleChange"
<i
v-if="option.icon"
:class="
cn('size-4 shrink-0 text-primary-comfy-canvas/60', option.icon)
"
aria-hidden="true"
/>
<label
:for="`${field.id}-${option.value}`"
class="cursor-pointer text-sm"
>{{ resolveOptionLabel(option) }}</label
>
</div>
</template>
<template v-else>
<div
<span class="flex-1">{{ resolveOptionLabel(option) }}</span>
<i :class="checkMarkClass" aria-hidden="true" />
</ToggleGroupItem>
</ToggleGroup>
<ToggleGroup
v-else
:model-value="(modelValue as string[]) ?? []"
type="multiple"
class="flex w-full flex-col gap-2"
@update:model-value="onMultiChange"
>
<ToggleGroupItem
v-for="option in field.options"
:id="`${field.id}-${option.value}`"
:key="option.value"
class="flex items-center gap-3"
:value="option.value"
:class="optionCardClass"
>
<Checkbox
:model-value="(modelValue as string[]) ?? []"
:input-id="`${field.id}-${option.value}`"
:value="option.value"
:dt="checkedTokens"
@update:model-value="onMultiChange"
<i
v-if="option.icon"
:class="
cn('size-4 shrink-0 text-primary-comfy-canvas/60', option.icon)
"
aria-hidden="true"
/>
<label
:for="`${field.id}-${option.value}`"
class="cursor-pointer text-sm"
>{{ resolveOptionLabel(option) }}</label
>
</div>
</template>
<span class="flex-1">{{ resolveOptionLabel(option) }}</span>
<i :class="checkMarkClass" aria-hidden="true" />
</ToggleGroupItem>
</ToggleGroup>
<Input
v-if="field.allowOther && field.otherFieldId && modelValue === 'other'"
v-if="field.allowOther && field.otherFieldId && isOtherSelected"
:model-value="(otherValue as string) ?? ''"
:class="inputClass"
:maxlength="OTHER_TEXT_MAX_LENGTH"
:placeholder="
$t(
`cloudOnboarding.survey.options.${field.id}.otherPlaceholder`,
$t('cloudOnboarding.survey.otherPlaceholder')
)
"
class="ml-1"
@update:model-value="onOtherChange"
/>
<p v-if="errorMessage" class="text-danger text-xs">{{ errorMessage }}</p>
@@ -65,7 +75,7 @@
<div v-else class="flex flex-col gap-3">
<label
:for="controlId"
class="block text-lg font-medium text-base-foreground"
class="block text-lg font-medium text-primary-comfy-canvas"
>
{{ resolvedLabel }}
</label>
@@ -74,6 +84,7 @@
:model-value="(modelValue as string) ?? ''"
:placeholder="field.placeholder"
:aria-invalid="Boolean(errorMessage)"
:class="inputClass"
@update:model-value="onTextChange"
/>
<p v-if="errorMessage" class="text-danger text-xs">{{ errorMessage }}</p>
@@ -81,18 +92,20 @@
</template>
<script setup lang="ts">
import Checkbox from 'primevue/checkbox'
import RadioButton from 'primevue/radiobutton'
import { useId } from 'vue'
import { cn } from '@comfyorg/tailwind-utils'
import { computed, useId } from 'vue'
import { useI18n } from 'vue-i18n'
import Input from '@/components/ui/input/Input.vue'
import { ToggleGroup, ToggleGroupItem } from '@/components/ui/toggle-group'
import type {
LocalizedString,
OnboardingSurveyField,
OnboardingSurveyOption
} from '@/platform/remoteConfig/types'
import { OTHER_TEXT_MAX_LENGTH } from './surveySchema'
const {
field,
modelValue,
@@ -113,25 +126,31 @@ const emit = defineEmits<{
const { t, te, locale } = useI18n()
const controlId = useId()
const optionCardClass =
'group h-auto w-full items-center justify-start gap-3 rounded-md border border-solid border-smoke-800/10 bg-smoke-800/10 px-4 py-3 text-left text-sm text-primary-comfy-canvas shadow-inset-highlight transition-colors hover:bg-sand-300/20 data-[state=on]:bg-sand-300/15 data-[state=on]:ring-1 data-[state=on]:ring-inset data-[state=on]:ring-brand-yellow'
const checkMarkClass =
'icon-[lucide--check] size-4 shrink-0 text-brand-yellow opacity-0 group-data-[state=on]:opacity-100'
const inputClass =
'border-smoke-800/10 bg-smoke-800/10 text-primary-comfy-canvas placeholder:text-primary-comfy-canvas/50 focus-visible:ring-inset'
const isOtherSelected = computed(() =>
Array.isArray(modelValue)
? modelValue.includes('other')
: modelValue === 'other'
)
const resolveLocalized = (value: LocalizedString): string => {
if (typeof value === 'string') return value
return value[locale.value] ?? value.en ?? Object.values(value)[0] ?? ''
}
const checkedTokens = {
checked: {
background: 'var(--color-electric-400)',
borderColor: 'var(--color-electric-400)',
hoverBackground: 'var(--color-electric-400)',
hoverBorderColor: 'var(--color-electric-400)'
}
}
const resolvedLabel = (() => {
const resolvedLabel = computed(() => {
if (field.labelKey && te(field.labelKey)) return t(field.labelKey)
if (field.label != null) return resolveLocalized(field.label)
return field.id
})()
})
const resolveOptionLabel = (option: OnboardingSurveyOption): string => {
if (option.labelKey && te(option.labelKey)) return t(option.labelKey)
@@ -143,13 +162,10 @@ const onSingleChange = (value: unknown) => {
emit('update:modelValue', typeof value === 'string' ? value : '')
}
const onMultiChange = (value: unknown) => {
if (!Array.isArray(value)) {
emit('update:modelValue', [])
return
}
const selected = Array.isArray(value) ? value : []
emit(
'update:modelValue',
value.filter((v): v is string => typeof v === 'string')
selected.filter((v): v is string => typeof v === 'string')
)
}
const onTextChange = (value: string | number | undefined) => {

View File

@@ -1,320 +1,383 @@
import userEvent from '@testing-library/user-event'
import { render, screen } from '@testing-library/vue'
import PrimeVue from 'primevue/config'
import { render, screen, waitFor } from '@testing-library/vue'
import { describe, expect, it } from 'vitest'
import { createI18n } from 'vue-i18n'
import enMessages from '@/locales/en/main.json'
import type { OnboardingSurvey } from '@/platform/remoteConfig/types'
import DynamicSurveyForm from './DynamicSurveyForm.vue'
const flushPromises = () => new Promise((resolve) => setTimeout(resolve, 0))
const i18n = createI18n({
legacy: false,
locale: 'en',
messages: {
en: {
g: { back: 'Back', next: 'Next', submit: 'Submit' },
cloudOnboarding: {
survey: {
intro: 'Help us tailor your ComfyUI experience.',
errors: {
chooseAnOption: 'Please choose an option.',
selectAtLeastOne: 'Please select at least one option.',
describeAnswer: 'Please describe your answer.'
}
}
}
}
}
})
import { defaultOnboardingSurvey } from './defaultSurveySchema'
const renderForm = (survey: OnboardingSurvey) =>
render(DynamicSurveyForm, {
global: { plugins: [PrimeVue, i18n] },
global: {
plugins: [
createI18n({
legacy: false,
locale: 'en',
messages: { en: enMessages }
})
]
},
props: { survey }
})
const clickOption = (user: ReturnType<typeof userEvent.setup>, label: string) =>
user.click(screen.getByText(label))
const firstSubmitPayload = (
emitted: Record<string, unknown[]>
): Record<string, unknown> | undefined =>
(emitted.submit?.[0] as [Record<string, unknown>] | undefined)?.[0]
const twoStepSurvey: OnboardingSurvey = {
version: 1,
introKey: 'cloudOnboarding.survey.intro',
fields: [
{
id: 'usage',
type: 'single',
label: 'How do you plan to use ComfyUI?',
required: true,
options: [
{ value: 'personal', label: 'Personal use' },
{ value: 'work', label: 'Work' }
]
},
{
id: 'intent',
type: 'multi',
label: 'What do you want to create with ComfyUI?',
type: 'single',
label: 'What do you want to make?',
required: true,
options: [
{ value: 'images', label: 'Images' },
{ value: 'videos', label: 'Videos' }
{ value: 'video', label: 'Video' }
]
},
{
id: 'making',
type: 'multi',
label: 'Pick everything that applies',
required: true,
options: [
{ value: 'a', label: 'Making A' },
{ value: 'b', label: 'Making B' }
]
}
]
}
describe('DynamicSurveyForm', () => {
it('renders the intro text and the first field options', () => {
renderForm(twoStepSurvey)
const branchedSurvey: OnboardingSurvey = {
version: 1,
fields: [
{
id: 'intent',
type: 'single',
label: 'What do you want to make?',
required: true,
options: [
{ value: 'workflows', label: 'Workflows' },
{ value: 'images', label: 'Images' }
]
},
{
id: 'focus',
type: 'single',
label: 'What are you building?',
required: true,
showWhen: { field: 'intent', equals: 'workflows' },
options: [{ value: 'custom_nodes', label: 'Custom nodes' }]
}
]
}
expect(
screen.getByText('Help us tailor your ComfyUI experience.')
).toBeInTheDocument()
expect(screen.getByText('How do you plan to use ComfyUI?')).toBeVisible()
expect(screen.getByLabelText('Personal use')).toBeInTheDocument()
expect(screen.getByLabelText('Work')).toBeInTheDocument()
describe('DynamicSurveyForm', () => {
it('renders the real default schema (v3) with its first question and options', () => {
expect(defaultOnboardingSurvey.version).toBe(3)
const firstField = defaultOnboardingSurvey.fields[0]!
renderForm(defaultOnboardingSurvey)
expect(screen.getByText('What do you want to make?')).toBeVisible()
expect(screen.getByText('Images')).toBeInTheDocument()
expect(screen.getAllByRole('button')).toHaveLength(
firstField.options!.length
)
})
it('disables Next until the user selects an option, then advances', async () => {
it('auto-advances when a single-select option is chosen', async () => {
const user = userEvent.setup()
renderForm(twoStepSurvey)
const next = screen.getByRole('button', { name: 'Next' })
expect(next).toBeDisabled()
await user.click(screen.getByLabelText('Personal use'))
expect(next).toBeEnabled()
await user.click(next)
await flushPromises()
// No Next click — choosing the card advances the wizard.
await clickOption(user, 'Images')
expect(
screen.getByText('What do you want to create with ComfyUI?')
await screen.findByText('Pick everything that applies')
).toBeVisible()
expect(screen.getByLabelText('Images')).toBeInTheDocument()
expect(screen.getByRole('button', { name: 'Back' })).toBeInTheDocument()
})
it('does not auto-advance a multi-select step; Submit gates on a choice', async () => {
const user = userEvent.setup()
renderForm(twoStepSurvey)
await clickOption(user, 'Images')
const submit = await screen.findByRole('button', { name: 'Submit' })
expect(submit).toBeDisabled()
await clickOption(user, 'Making A')
// Still on the multi step (no auto-advance), now submittable.
expect(screen.getByText('Pick everything that applies')).toBeVisible()
await waitFor(() => expect(submit).toBeEnabled())
})
it('navigates back to the previous step', async () => {
const user = userEvent.setup()
renderForm(twoStepSurvey)
await user.click(screen.getByLabelText('Personal use'))
await user.click(screen.getByRole('button', { name: 'Next' }))
await flushPromises()
await clickOption(user, 'Images')
expect(
screen.getByText('What do you want to create with ComfyUI?')
await screen.findByText('Pick everything that applies')
).toBeVisible()
await user.click(screen.getByRole('button', { name: 'Back' }))
await flushPromises()
expect(screen.getByText('How do you plan to use ComfyUI?')).toBeVisible()
expect(await screen.findByText('What do you want to make?')).toBeVisible()
})
it('resolves option and field labels via labelKey when provided', () => {
const localizedI18n = createI18n({
legacy: false,
locale: 'en',
messages: {
en: {
g: { back: 'Back', next: 'Next', submit: 'Submit' },
cloudOnboarding: {
survey: {
intro: 'Help us tailor your ComfyUI experience.',
errors: {
chooseAnOption: '',
selectAtLeastOne: '',
describeAnswer: ''
}
}
},
survey_label: 'Localized question?',
survey_a: 'Localized A',
survey_b: 'Localized B'
}
}
})
it('offers Next on an already-answered single-select reached via Back', async () => {
const user = userEvent.setup()
renderForm(twoStepSurvey)
render(DynamicSurveyForm, {
global: { plugins: [PrimeVue, localizedI18n] },
props: {
survey: {
version: 1,
fields: [
{
id: 'q',
type: 'single',
labelKey: 'survey_label',
required: true,
options: [
{ value: 'a', labelKey: 'survey_a' },
{ value: 'b', labelKey: 'survey_b' }
]
}
]
}
}
})
await clickOption(user, 'Images')
await screen.findByText('Pick everything that applies')
await user.click(screen.getByRole('button', { name: 'Back' }))
expect(screen.getByText('Localized question?')).toBeVisible()
expect(screen.getByLabelText('Localized A')).toBeInTheDocument()
expect(screen.getByLabelText('Localized B')).toBeInTheDocument()
const next = await screen.findByRole('button', { name: 'Next' })
await user.click(next)
expect(
await screen.findByText('Pick everything that applies')
).toBeVisible()
})
it('renders server-supplied translations from a label locale map', () => {
const koreanI18n = createI18n({
legacy: false,
locale: 'ko',
fallbackLocale: 'en',
messages: {
en: {
g: { back: 'Back', next: 'Next', submit: 'Submit' },
cloudOnboarding: {
survey: {
intro: '',
errors: {
chooseAnOption: '',
selectAtLeastOne: '',
describeAnswer: ''
}
}
}
},
ko: { g: { back: '뒤로', next: '다음', submit: '제출' } }
}
})
it('reveals a branched follow-up step from the answer and submits it', async () => {
const user = userEvent.setup()
const { emitted } = renderForm(branchedSurvey)
render(DynamicSurveyForm, {
global: { plugins: [PrimeVue, koreanI18n] },
props: {
survey: {
version: 1,
fields: [
{
id: 'usage',
type: 'single',
label: {
en: 'How will you use it?',
ko: '어떻게 사용하시겠어요?'
},
required: true,
options: [
{
value: 'personal',
label: { en: 'Personal use', ko: '개인 용도' }
},
{ value: 'work', label: { en: 'Work', ko: '업무' } }
]
}
]
}
}
})
await clickOption(user, 'Workflows')
expect(await screen.findByText('What are you building?')).toBeVisible()
expect(screen.getByText('어떻게 사용하시겠어요?')).toBeVisible()
expect(screen.getByLabelText('개인 용도')).toBeInTheDocument()
expect(screen.getByLabelText('업무')).toBeInTheDocument()
await clickOption(user, 'Custom nodes')
await user.click(await screen.findByRole('button', { name: 'Submit' }))
await waitFor(() =>
expect(firstSubmitPayload(emitted())).toEqual({
intent: 'workflows',
focus: 'custom_nodes'
})
)
})
it('falls back to English when current locale missing from label map', () => {
const fallbackI18n = createI18n({
legacy: false,
locale: 'fr',
fallbackLocale: 'en',
messages: {
en: {
g: { back: 'Back', next: 'Next', submit: 'Submit' },
cloudOnboarding: {
survey: {
intro: '',
errors: {
chooseAnOption: '',
selectAtLeastOne: '',
describeAnswer: ''
}
}
}
},
fr: {}
}
})
it('hides the branched step when the answer does not match', async () => {
const user = userEvent.setup()
const { emitted } = renderForm(branchedSurvey)
render(DynamicSurveyForm, {
global: { plugins: [PrimeVue, fallbackI18n] },
props: {
survey: {
version: 1,
fields: [
{
id: 'q',
type: 'single',
label: { en: 'English question', ko: '한국어' },
required: true,
options: [
{ value: 'a', label: { en: 'English A', ko: '한국어 A' } }
]
}
// 'images' is the last visible step (focus hidden) → Submit, no branch.
await clickOption(user, 'Images')
const submit = await screen.findByRole('button', { name: 'Submit' })
expect(screen.queryByText('What are you building?')).not.toBeInTheDocument()
await user.click(submit)
await waitFor(() =>
expect(firstSubmitPayload(emitted())).toEqual({
intent: 'images',
focus: ''
})
)
})
it('requires the "other" free-text before submitting, then submits it', async () => {
const user = userEvent.setup()
const otherSurvey: OnboardingSurvey = {
version: 1,
fields: [
{
id: 'source',
type: 'single',
label: 'How did you find us?',
required: true,
allowOther: true,
otherFieldId: 'sourceOther',
options: [
{ value: 'search', label: 'Web search' },
{ value: 'other', label: 'Somewhere else' }
]
}
}
]
}
const { emitted } = renderForm(otherSurvey)
// Selecting 'other' must NOT auto-advance — the text box is required.
await clickOption(user, 'Somewhere else')
const submit = await screen.findByRole('button', { name: 'Submit' })
expect(submit).toBeDisabled()
await user.type(
await screen.findByPlaceholderText('Where did you find us?'),
'A newsletter'
)
await waitFor(() => expect(submit).toBeEnabled())
await user.click(submit)
await waitFor(() =>
expect(firstSubmitPayload(emitted())).toEqual({ source: 'A newsletter' })
)
})
it('surfaces the free-text error once "other" text is touched then cleared', async () => {
const user = userEvent.setup()
const otherSurvey: OnboardingSurvey = {
version: 1,
fields: [
{
id: 'source',
type: 'single',
label: 'How did you find us?',
required: true,
allowOther: true,
otherFieldId: 'sourceOther',
options: [
{ value: 'search', label: 'Web search' },
{ value: 'other', label: 'Somewhere else' }
]
}
]
}
renderForm(otherSurvey)
await clickOption(user, 'Somewhere else')
const input = await screen.findByPlaceholderText('Where did you find us?')
// Type then clear → the free-text field is touched but empty, so its
// required error surfaces.
await user.type(input, 'x')
await user.clear(input)
expect(
await screen.findByText('Please describe your answer.')
).toBeVisible()
})
it('shows a required-field error only after the user interacts, not before', async () => {
const user = userEvent.setup()
renderForm({
version: 1,
fields: [
{
id: 'making',
type: 'multi',
label: 'Pick everything that applies',
required: true,
options: [{ value: 'a', label: 'Making A' }]
}
]
})
// fr is not in the map → falls back to en
expect(screen.getByText('English question')).toBeVisible()
expect(screen.getByLabelText('English A')).toBeInTheDocument()
// No error on first render (field untouched).
expect(
screen.queryByText('Please select at least one option.')
).not.toBeInTheDocument()
// Select then clear → field is touched but empty → error surfaces.
await user.click(screen.getByText('Making A'))
await user.click(screen.getByText('Making A'))
expect(
await screen.findByText('Please select at least one option.')
).toBeVisible()
})
it('allows advancing past an optional field while still empty', async () => {
const user = userEvent.setup()
render(DynamicSurveyForm, {
global: { plugins: [PrimeVue, i18n] },
props: {
survey: {
version: 1,
fields: [
{
id: 'q1',
type: 'single',
label: 'Optional question?',
options: [
{ value: 'a', label: 'A' },
{ value: 'b', label: 'B' }
]
// no required: true — should be skippable
},
{
id: 'q2',
type: 'single',
label: 'Required question?',
required: true,
options: [{ value: 'c', label: 'C' }]
}
renderForm({
version: 1,
fields: [
{
id: 'q1',
type: 'single',
label: 'Optional question?',
options: [
{ value: 'a', label: 'A' },
{ value: 'b', label: 'B' }
]
// no required: true — should be skippable
},
{
id: 'q2',
type: 'single',
label: 'Required question?',
required: true,
options: [{ value: 'c', label: 'C' }]
}
}
]
})
const next = screen.getByRole('button', { name: 'Next' })
expect(next).toBeEnabled()
await user.click(next)
await flushPromises()
expect(screen.getByText('Required question?')).toBeVisible()
expect(await screen.findByText('Required question?')).toBeVisible()
})
it('enables Submit only after the multi-select field has at least one choice', async () => {
it('resets to the first step when the survey prop changes', async () => {
const user = userEvent.setup()
renderForm(twoStepSurvey)
const { rerender } = render(DynamicSurveyForm, {
global: {
plugins: [
createI18n({
legacy: false,
locale: 'en',
messages: { en: enMessages }
})
]
},
props: { survey: twoStepSurvey }
})
await user.click(screen.getByLabelText('Work'))
await user.click(screen.getByRole('button', { name: 'Next' }))
await flushPromises()
await clickOption(user, 'Images')
expect(
await screen.findByText('Pick everything that applies')
).toBeVisible()
const submitBtn = screen.getByRole('button', { name: 'Submit' })
expect(submitBtn).toBeDisabled()
await rerender({ survey: branchedSurvey })
// Back on step 0 of the new survey (no Back button on the first step).
expect(await screen.findByText('What do you want to make?')).toBeVisible()
expect(
screen.queryByRole('button', { name: 'Back' })
).not.toBeInTheDocument()
})
await user.click(screen.getByRole('checkbox', { name: /Images/i }))
await flushPromises()
expect(submitBtn).toBeEnabled()
it('renders server-supplied label translations and falls back to English', () => {
render(DynamicSurveyForm, {
global: {
plugins: [
createI18n({
legacy: false,
locale: 'ko',
fallbackLocale: 'en',
messages: { en: enMessages, ko: { g: { next: '다음' } } }
})
]
},
props: {
survey: {
version: 1,
fields: [
{
id: 'intent',
type: 'single',
label: { en: 'What will you make?', ko: '무엇을 만들 건가요?' },
required: true,
options: [
// ko provided → localized; ko missing → English fallback
{ value: 'images', label: { en: 'Images', ko: '이미지' } },
{ value: 'video', label: { en: 'Video' } }
]
}
]
}
}
})
expect(screen.getByText('무엇을 만들 건가요?')).toBeVisible()
expect(screen.getByText('이미지')).toBeInTheDocument()
expect(screen.getByText('Video')).toBeInTheDocument()
})
})

View File

@@ -1,109 +1,118 @@
<template>
<form class="flex size-full flex-col" @submit.prevent="onSubmit">
<p v-if="introText" class="mb-4 text-sm text-muted">
<form class="flex w-full flex-col" @submit.prevent="onSubmit">
<p v-if="introText" class="mb-4 text-sm text-muted-foreground">
{{ introText }}
</p>
<div
class="mb-8 h-2 w-full overflow-hidden rounded-full bg-secondary-background"
class="mb-8 h-1.5 w-full overflow-hidden rounded-full bg-primary-comfy-canvas/10"
>
<div
class="h-full bg-electric-400 transition-[width] duration-300 ease-out"
class="h-full bg-brand-yellow transition-[width] duration-300 ease-out"
:style="{ width: `${progressPercent}%` }"
/>
</div>
<div class="flex flex-1 flex-col overflow-hidden">
<div
v-if="currentField"
:key="currentField.id"
class="flex flex-1 flex-col gap-4 overflow-y-auto pr-1"
>
<DynamicSurveyField
:field="currentField"
:model-value="values[currentField.id]"
:other-value="
currentField.otherFieldId
? (values[currentField.otherFieldId] as string)
: undefined
"
:error-message="
errors[currentField.id] ??
(currentField.otherFieldId
? errors[currentField.otherFieldId]
: undefined)
"
@update:model-value="(value) => onFieldChange(currentField.id, value)"
@update:other-value="
(value) =>
currentField.otherFieldId &&
onFieldChange(currentField.otherFieldId, value)
"
/>
<div
class="overflow-hidden transition-[height] duration-300 ease-out"
:style="animatedHeightStyle"
>
<div ref="questionContent" class="relative">
<Transition
enter-active-class="transition-opacity duration-300 ease-out"
enter-from-class="opacity-0"
leave-active-class="absolute inset-x-0 top-0 transition-opacity duration-300 ease-out"
leave-to-class="opacity-0"
>
<div
v-if="currentField"
:key="currentField.id"
class="flex flex-col gap-4"
>
<DynamicSurveyField
:field="currentField"
:model-value="values[currentField.id]"
:other-value="
currentField.otherFieldId
? (values[currentField.otherFieldId] as string)
: undefined
"
:error-message="currentError"
@update:model-value="
(value) => void onFieldChange(currentField.id, value)
"
@update:other-value="
(value) =>
currentField.otherFieldId &&
void onFieldChange(currentField.otherFieldId, value)
"
/>
</div>
</Transition>
</div>
</div>
<div class="flex gap-6 pt-4">
<div
v-if="!isFirst || showNext || isLast"
class="mt-8 flex items-center justify-between gap-4"
>
<Button
v-if="!isFirst"
type="button"
variant="secondary"
class="h-10 flex-1 text-white"
variant="link"
size="lg"
class="px-0 text-primary-comfy-canvas/70 hover:text-primary-comfy-canvas"
@click="goPrevious"
>
<i class="icon-[lucide--chevron-left] size-4" aria-hidden="true" />
{{ $t('g.back') }}
</Button>
<span v-else class="flex-1" />
<span v-else />
<Button
v-if="!isLast"
v-if="showNext"
type="button"
size="lg"
:disabled="!isCurrentValid"
:class="
cn(
'h-10 flex-1 border-none',
isCurrentValid
? 'bg-electric-400 text-black hover:bg-electric-400/85'
: 'bg-zinc-800 text-zinc-500'
)
"
class="bg-brand-yellow text-primary-comfy-ink hover:bg-brand-yellow/85 disabled:bg-smoke-800/10 disabled:text-primary-comfy-canvas/40 disabled:opacity-100"
@click="goNext"
>
{{ $t('g.next') }}
<i class="icon-[lucide--chevron-right] size-4" aria-hidden="true" />
</Button>
<Button
v-else
v-else-if="isLast"
type="submit"
size="lg"
:disabled="!isCurrentValid || isSubmitting"
:loading="isSubmitting"
:class="
cn(
'h-10 flex-1 border-none',
isCurrentValid && !isSubmitting
? 'bg-electric-400 text-black hover:bg-electric-400/85'
: 'bg-zinc-800 text-zinc-500'
)
"
class="bg-brand-yellow text-primary-comfy-ink hover:bg-brand-yellow/85 disabled:bg-smoke-800/10 disabled:text-primary-comfy-canvas/40 disabled:opacity-100"
>
{{ $t('g.submit') }}
</Button>
<span v-else />
</div>
</form>
</template>
<script setup lang="ts">
import { cn } from '@comfyorg/tailwind-utils'
import { useElementSize } from '@vueuse/core'
import { toTypedSchema } from '@vee-validate/zod'
import { useForm } from 'vee-validate'
import { computed, ref, watch } from 'vue'
import { computed, nextTick, ref, useTemplateRef, watch } from 'vue'
import { useI18n } from 'vue-i18n'
import Button from '@/components/ui/button/Button.vue'
import type { OnboardingSurvey } from '@/platform/remoteConfig/types'
import type {
OnboardingSurvey,
OnboardingSurveyField
} from '@/platform/remoteConfig/types'
import DynamicSurveyField from './DynamicSurveyField.vue'
import {
buildInitialValues,
buildSubmissionPayload,
buildZodSchema,
hasNonEmptyValue,
isOtherValue,
prepareSurvey,
visibleFields
} from './surveySchema'
@@ -147,6 +156,8 @@ watch(
liveValues.value = { ...fresh }
resetForm({ values: fresh })
stepIndex.value = 0
touched.value = new Set()
isAdvancing.value = false
}
)
@@ -154,11 +165,43 @@ const visible = computed(() =>
visibleFields(preparedSurvey.value, values as SurveyValues)
)
const stepIndex = ref(0)
const touched = ref(new Set<string>())
const isAdvancing = ref(false)
const questionContent = useTemplateRef<HTMLElement>('questionContent')
const { height: contentHeight } = useElementSize(questionContent)
const animatedHeightStyle = computed(() =>
contentHeight.value ? { height: `${contentHeight.value}px` } : {}
)
const currentField = computed(() => visible.value[stepIndex.value])
const isFirst = computed(() => stepIndex.value === 0)
const isLast = computed(() => stepIndex.value === visible.value.length - 1)
const showNext = computed(() => {
if (isLast.value || isAdvancing.value) return false
const field = currentField.value
if (!field) return false
if (field.type !== 'single') return true
return !(field.required && !hasNonEmptyValue(values[field.id]))
})
const currentError = computed(() => {
const field = currentField.value
if (!field) return undefined
if (touched.value.has(field.id) && errors.value[field.id]) {
return errors.value[field.id]
}
if (
field.otherFieldId &&
touched.value.has(field.otherFieldId) &&
errors.value[field.otherFieldId]
) {
return errors.value[field.otherFieldId]
}
return undefined
})
const totalSteps = computed(() => Math.max(visible.value.length, 1))
const progressPercent = computed(() =>
Math.max(
@@ -172,26 +215,41 @@ const isCurrentValid = computed(() => {
if (!field) return false
const value = values[field.id]
const isEmpty =
field.type === 'multi'
? !Array.isArray(value) || value.length === 0
: typeof value !== 'string' || value.length === 0
if (!hasNonEmptyValue(value)) return !field.required
if (isEmpty) return !field.required
if (field.allowOther && field.otherFieldId && value === 'other') {
if (field.allowOther && field.otherFieldId && isOtherValue(value)) {
const other = values[field.otherFieldId]
return typeof other === 'string' && other.trim().length > 0
}
return true
})
const onFieldChange = (id: string, value: string | string[]) => {
const isAutoAdvanceValue = (field: OnboardingSurveyField, value: unknown) =>
field.type === 'single' &&
typeof value === 'string' &&
value !== '' &&
value !== 'other'
const markTouched = (id: string) => {
touched.value = new Set(touched.value).add(id)
}
const onFieldChange = async (id: string, value: string | string[]) => {
if (isAdvancing.value) return
markTouched(id)
setFieldValue(id, value)
liveValues.value = { ...liveValues.value, [id]: value }
if (stepIndex.value > visible.value.length - 1) {
stepIndex.value = Math.max(0, visible.value.length - 1)
}
const field = currentField.value
if (field?.id === id && isAutoAdvanceValue(field, value)) {
isAdvancing.value = true
await nextTick()
goNext()
isAdvancing.value = false
}
}
const goNext = () => {
@@ -202,6 +260,11 @@ const goPrevious = () => {
}
const onSubmit = async () => {
const field = currentField.value
if (field) {
markTouched(field.id)
if (field.otherFieldId) markTouched(field.otherFieldId)
}
const result = await validate()
if (!result.valid) return
emit(

View File

@@ -1,55 +1,61 @@
import type { OnboardingSurvey } from '@/platform/remoteConfig/types'
import type {
OnboardingSurvey,
OnboardingSurveyOption
} from '@/platform/remoteConfig/types'
const optionsFor = (
fieldId: string,
values: string[]
): { value: string; labelKey: string }[] =>
values: string[],
icons: Record<string, string> = {}
): OnboardingSurveyOption[] =>
values.map((value) => ({
value,
labelKey: `cloudOnboarding.survey.options.${fieldId}.${value}`
labelKey: `cloudOnboarding.survey.options.${fieldId}.${value}`,
...(icons[value] ? { icon: icons[value] } : {})
}))
export const defaultOnboardingSurvey: OnboardingSurvey = {
version: 2,
version: 3,
introKey: 'cloudOnboarding.survey.intro',
fields: [
{
id: 'usage',
type: 'single',
labelKey: 'cloudSurvey_steps_usage',
required: true,
options: optionsFor('usage', ['personal', 'work', 'education'])
},
{
id: 'familiarity',
type: 'single',
labelKey: 'cloudSurvey_steps_familiarity',
required: true,
options: optionsFor('familiarity', [
'new',
'starting',
'basics',
'advanced',
'expert'
])
},
{
id: 'intent',
type: 'multi',
type: 'single',
labelKey: 'cloudSurvey_steps_intent',
required: true,
randomize: true,
options: optionsFor('intent', [
'workflows',
'custom_nodes',
'videos',
'images',
'3d_game',
'audio',
'apps',
'api',
'not_sure'
])
allowOther: true,
otherFieldId: 'intentOther',
options: optionsFor(
'intent',
['images', 'video', 'workflows', 'apps_api', 'exploring', 'other'],
{
images: 'icon-[lucide--image]',
video: 'icon-[lucide--video]',
workflows: 'icon-[lucide--workflow]',
apps_api: 'icon-[lucide--blocks]',
exploring: 'icon-[lucide--compass]',
other: 'icon-[lucide--pencil]'
}
)
},
{
id: 'experience',
type: 'single',
labelKey: 'cloudSurvey_steps_experience',
required: true,
options: optionsFor('experience', ['new', 'some', 'pro'], {
new: 'icon-[lucide--sprout]',
some: 'icon-[lucide--map]',
pro: 'icon-[lucide--rocket]'
})
},
{
id: 'focus',
type: 'single',
labelKey: 'cloudSurvey_steps_focus',
required: true,
showWhen: { field: 'intent', equals: ['workflows', 'apps_api'] },
options: optionsFor('focus', ['custom_nodes', 'pipelines', 'products'])
},
{
id: 'source',
@@ -57,19 +63,31 @@ export const defaultOnboardingSurvey: OnboardingSurvey = {
labelKey: 'cloudSurvey_steps_source',
required: true,
randomize: true,
allowOther: true,
otherFieldId: 'sourceOther',
options: optionsFor('source', [
'social',
'friend',
'search',
'community',
'other'
])
},
{
id: 'source_social',
type: 'single',
labelKey: 'cloudSurvey_steps_source_social',
required: true,
randomize: true,
showWhen: { field: 'source', equals: 'social' },
options: optionsFor('source_social', [
'youtube',
'reddit',
'twitter',
'instagram',
'tiktok',
'linkedin',
'friend',
'search',
'newsletter',
'conference',
'discord',
'github',
'other'
'discord'
])
}
]

View File

@@ -2,10 +2,13 @@ import { describe, expect, it } from 'vitest'
import type { OnboardingSurvey } from '@/platform/remoteConfig/types'
import { defaultOnboardingSurvey } from './defaultSurveySchema'
import {
OTHER_TEXT_MAX_LENGTH,
buildInitialValues,
buildSubmissionPayload,
buildZodSchema,
hasNonEmptyValue,
prepareSurvey,
visibleFields
} from './surveySchema'
@@ -246,3 +249,179 @@ describe('prepareSurvey', () => {
expect(values.slice(0, -2).sort()).toEqual(['a', 'b'])
})
})
describe('defaultOnboardingSurvey branching', () => {
const idsFor = (values: Record<string, string | string[]>) =>
visibleFields(defaultOnboardingSurvey, values).map((f) => f.id)
it('asks only the core steps when no branch condition is met', () => {
expect(idsFor({ intent: 'images', source: 'friend' })).toEqual([
'intent',
'experience',
'source'
])
})
it('asks every step when both branches are active', () => {
expect(idsFor({ intent: 'workflows', source: 'social' })).toEqual([
'intent',
'experience',
'focus',
'source',
'source_social'
])
})
it('asks focus only for builder intents (workflows / apps_api)', () => {
expect(idsFor({ intent: 'workflows' })).toContain('focus')
expect(idsFor({ intent: 'apps_api' })).toContain('focus')
expect(idsFor({ intent: 'images' })).not.toContain('focus')
expect(idsFor({ intent: 'exploring' })).not.toContain('focus')
})
it('asks source_social only when source is social', () => {
expect(idsFor({ source: 'social' })).toContain('source_social')
expect(idsFor({ source: 'friend' })).not.toContain('source_social')
})
it('zeroes hidden branch fields in the submission payload', () => {
const payload = buildSubmissionPayload(defaultOnboardingSurvey, {
intent: 'images',
experience: 'new',
source: 'friend'
})
expect(payload).toMatchObject({
intent: 'images',
experience: 'new',
source: 'friend',
focus: '',
source_social: ''
})
})
it('prefers free-text over the "other" sentinel for intent and source', () => {
const payload = buildSubmissionPayload(defaultOnboardingSurvey, {
intent: 'other',
intentOther: ' Comics ',
experience: 'pro',
source: 'other',
sourceOther: 'A podcast'
})
expect(payload.intent).toBe('Comics')
expect(payload.source).toBe('A podcast')
})
})
describe('hasNonEmptyValue', () => {
const cases: [string | string[] | undefined, boolean][] = [
[undefined, false],
['', false],
[[], false],
['a', true],
[['a'], true],
[['a', 'b'], true]
]
it.for(cases)('treats %o as non-empty=%o', ([value, expected]) => {
expect(hasNonEmptyValue(value)).toBe(expected)
})
})
describe('multi-select allowOther', () => {
const multiOtherSurvey: OnboardingSurvey = {
version: 1,
fields: [
{
id: 'making',
type: 'multi',
required: true,
allowOther: true,
otherFieldId: 'makingOther',
options: [
{ value: 'a', labelKey: 'a' },
{ value: 'other', labelKey: 'other' }
]
}
]
}
it('requires the free-text when a multi field includes "other"', () => {
const schema = buildZodSchema(multiOtherSurvey, {
making: ['a', 'other'],
makingOther: ''
})
expect(
schema.safeParse({ making: ['a', 'other'], makingOther: '' }).success
).toBe(false)
expect(
schema.safeParse({ making: ['a', 'other'], makingOther: 'Comics' })
.success
).toBe(true)
})
it('does not require the free-text when "other" is not among the choices', () => {
const schema = buildZodSchema(multiOtherSurvey, {
making: ['a'],
makingOther: ''
})
expect(schema.safeParse({ making: ['a'], makingOther: '' }).success).toBe(
true
)
})
it('keeps the array and surfaces the trimmed free-text separately', () => {
const payload = buildSubmissionPayload(multiOtherSurvey, {
making: ['a', 'other'],
makingOther: ' Comics '
})
expect(payload.making).toEqual(['a', 'other'])
expect(payload.makingOther).toBe('Comics')
})
})
describe('other free-text validation', () => {
const otherSurvey: OnboardingSurvey = {
version: 1,
fields: [
{
id: 'source',
type: 'single',
required: true,
allowOther: true,
otherFieldId: 'sourceOther',
options: [
{ value: 'search', labelKey: 'search' },
{ value: 'other', labelKey: 'other' }
]
}
]
}
it('rejects a whitespace-only "other" answer', () => {
const schema = buildZodSchema(otherSurvey, {
source: 'other',
sourceOther: ' '
})
expect(
schema.safeParse({ source: 'other', sourceOther: ' ' }).success
).toBe(false)
})
it('rejects an "other" answer longer than the max length', () => {
const schema = buildZodSchema(otherSurvey, {
source: 'other',
sourceOther: 'x'.repeat(OTHER_TEXT_MAX_LENGTH + 1)
})
expect(
schema.safeParse({
source: 'other',
sourceOther: 'x'.repeat(OTHER_TEXT_MAX_LENGTH + 1)
}).success
).toBe(false)
expect(
schema.safeParse({
source: 'other',
sourceOther: 'x'.repeat(OTHER_TEXT_MAX_LENGTH)
}).success
).toBe(true)
})
})

View File

@@ -9,12 +9,19 @@ import type {
export type SurveyValues = Record<string, string | string[] | undefined>
const hasNonEmptyValue = (current: string | string[] | undefined): boolean => {
export const OTHER_TEXT_MAX_LENGTH = 200
export const hasNonEmptyValue = (
current: string | string[] | undefined
): boolean => {
if (current === undefined || current === '') return false
if (Array.isArray(current)) return current.length > 0
return true
}
export const isOtherValue = (current: string | string[] | undefined): boolean =>
Array.isArray(current) ? current.includes('other') : current === 'other'
const conditionMatches = (
condition: OnboardingSurveyFieldCondition | undefined,
values: SurveyValues
@@ -54,7 +61,7 @@ export const prepareSurvey = (survey: OnboardingSurvey): OnboardingSurvey => ({
fields: survey.fields.map(randomizeOptions)
})
type Translator = (key: string) => string
type Translator = (key: string, named?: Record<string, unknown>) => string
const identityTranslator: Translator = (key) => key
@@ -87,11 +94,19 @@ export const buildZodSchema = (
if (
field.allowOther &&
field.otherFieldId &&
values[field.id] === 'other'
isOtherValue(values[field.id])
) {
shape[field.otherFieldId] = z.string().min(1, {
message: t('cloudOnboarding.survey.errors.describeAnswer')
})
shape[field.otherFieldId] = z
.string()
.trim()
.min(1, {
message: t('cloudOnboarding.survey.errors.describeAnswer')
})
.max(OTHER_TEXT_MAX_LENGTH, {
message: t('cloudOnboarding.survey.errors.answerTooLong', {
max: OTHER_TEXT_MAX_LENGTH
})
})
} else if (field.otherFieldId) {
shape[field.otherFieldId] = z.string().optional()
}
@@ -120,17 +135,23 @@ export const buildSubmissionPayload = (
continue
}
const value = values[field.id]
const otherRaw = field.otherFieldId ? values[field.otherFieldId] : undefined
if (
const otherFieldId = field.otherFieldId
const otherRaw = otherFieldId ? values[otherFieldId] : undefined
const otherText =
field.allowOther &&
field.otherFieldId &&
value === 'other' &&
otherFieldId &&
isOtherValue(value) &&
typeof otherRaw === 'string'
) {
const other = otherRaw.trim()
payload[field.id] = other || 'other'
? otherRaw.trim()
: undefined
if (otherText !== undefined && field.type !== 'multi') {
payload[field.id] = otherText || 'other'
} else {
payload[field.id] = field.type === 'multi' ? (value ?? []) : (value ?? '')
if (otherText !== undefined && otherFieldId) {
payload[otherFieldId] = otherText
}
}
}
return payload

View File

@@ -44,6 +44,7 @@ export type OnboardingSurveyOption = {
value: string
label?: LocalizedString
labelKey?: string
icon?: string
}
export type OnboardingSurveyFieldCondition = {

View File

@@ -41,7 +41,7 @@
<img
v-if="option.logo"
:src="option.logo"
:alt="option.label"
alt=""
class="size-4"
/>
{{ option.label }}

View File

@@ -268,6 +268,27 @@ describe('useSecretForm', () => {
])
})
it('passes a server-listed provider absent from the local registry through with its raw id as label and no logo', () => {
const visible = ref(true)
const { providerOptions } = useSecretForm({
mode: 'create',
existingProviders: () => [],
availableProviders: () => ['brand-new-provider'],
visible,
onSaved: vi.fn()
})
expect(providerOptions.value).toEqual([
{
value: 'brand-new-provider',
label: 'brand-new-provider',
logo: undefined,
disabled: false
}
])
expect(providerOptions.value[0]?.logo).toBeUndefined()
})
it('omits BYOK providers the server does not list', () => {
const visible = ref(true)
const { providerOptions } = useSecretForm({

View File

@@ -101,8 +101,11 @@ export function useSecretForm(options: UseSecretFormOptions) {
// Once the server allowlist resolves, drop a selection the resolved list no
// longer offers so the user cannot submit an unlisted provider.
watch(providerOptions, (options) => {
if (form.provider && !options.some((o) => o.value === form.provider)) {
watch(providerOptions, (resolvedOptions) => {
if (
form.provider &&
!resolvedOptions.some((o) => o.value === form.provider)
) {
form.provider = null
}
})

View File

@@ -39,6 +39,11 @@ export function useSettingsDialog() {
// breaks those nested dialogs' autofocus and click handling. Non-modal
// keeps the visual overlay without those traps.
modal: false,
// A nested dialog closing (e.g. confirming a Secrets delete) can move
// focus onto an app element once the row it focused is removed. As a
// non-modal dialog Settings would treat that as an outside focus and
// dismiss itself, so opt out — escape and outside clicks still close it.
dismissOnFocusOutside: false,
size: 'full',
contentClass: SETTINGS_CONTENT_CLASS,
overlayClass: isWorkspaceMode ? 'p-8' : undefined

View File

@@ -52,20 +52,25 @@ export interface AuthMetadata {
utm_campaign?: string
}
/**
* Survey response data for user profiling
* Maps 1-to-1 with actual survey fields
*/
/** Survey field ids → answers. Fields are backend-overridable, so all optional. */
export interface SurveyResponses {
// Current default schema (see defaultSurveySchema.ts)
intent?: string | string[]
intentOther?: string
experience?: string
focus?: string
source?: string
sourceOther?: string
source_social?: string
// Legacy fields — only emitted by older backend-supplied schemas, never by
// the current default. Kept so historical responses still typecheck.
familiarity?: string
industry?: string
useCase?: string
making?: string[]
role?: string
teamSize?: string
source?: string
usage?: string
intent?: string[]
}
export interface SurveyResponsesNormalized extends SurveyResponses {

View File

@@ -14,6 +14,7 @@ import type { WidgetId } from '@/types/widgetId'
export interface InputWidgetConfig {
height?: number
description?: string
}
type LinearInputId = WidgetId | NodeLocatorId | SerializedNodeId

View File

@@ -1,126 +0,0 @@
import * as THREE from 'three'
import { beforeEach, describe, expect, it, vi } from 'vitest'
import { RendererView } from './RendererView'
vi.mock('three', async (importOriginal) => {
const actual = await importOriginal<typeof THREE>()
class WebGLRenderer {
domElement = document.createElement('canvas')
autoClear = true
outputColorSpace = ''
toneMapping = 0
toneMappingExposure = 1
setSize(width: number, height: number) {
this.domElement.width = width
this.domElement.height = height
}
getSize(target: { set(x: number, y: number): unknown }) {
target.set(this.domElement.width, this.domElement.height)
return target
}
setPixelRatio() {}
setClearColor = vi.fn()
forceContextLoss = vi.fn()
dispose = vi.fn()
}
return { ...actual, WebGLRenderer }
})
const drawImage = vi.fn()
beforeEach(() => {
drawImage.mockClear()
vi.spyOn(HTMLCanvasElement.prototype, 'getContext').mockReturnValue({
drawImage,
globalCompositeOperation: 'source-over'
} as unknown as ReturnType<HTMLCanvasElement['getContext']>)
})
describe('RendererView', () => {
it('appends its own canvas to the container', () => {
const container = document.createElement('div')
const view = new RendererView(container)
expect(view.canvas.parentElement).toBe(container)
view.dispose()
expect(view.canvas.parentElement).toBeNull()
})
it('setSize resizes the view canvas and grows the shared buffer to fit', () => {
const container = document.createElement('div')
const view = new RendererView(container)
view.setSize(640.4, 480.6)
expect(view.width).toBe(640)
expect(view.height).toBe(481)
expect(view.canvas.width).toBe(640)
expect(view.canvas.height).toBe(481)
expect(view.renderer.domElement.width).toBeGreaterThanOrEqual(640)
expect(view.renderer.domElement.height).toBeGreaterThanOrEqual(481)
view.dispose()
})
it('setSize clamps degenerate sizes to 1 pixel', () => {
const container = document.createElement('div')
const view = new RendererView(container)
view.setSize(0, -5)
expect(view.width).toBe(1)
expect(view.height).toBe(1)
view.dispose()
})
it('beginRender applies the view state and regrows a shrunken shared buffer', () => {
const container = document.createElement('div')
const view = new RendererView(container)
view.setSize(400, 300)
view.state.toneMapping = THREE.ACESFilmicToneMapping
view.state.toneMappingExposure = 0.5
view.state.outputColorSpace = THREE.LinearSRGBColorSpace
view.state.clearAlpha = 0.25
view.renderer.setSize(50, 40)
view.beginRender()
expect(view.renderer.domElement.width).toBeGreaterThanOrEqual(400)
expect(view.renderer.domElement.height).toBeGreaterThanOrEqual(300)
expect(view.renderer.toneMapping).toBe(THREE.ACESFilmicToneMapping)
expect(view.renderer.toneMappingExposure).toBe(0.5)
expect(view.renderer.outputColorSpace).toBe(THREE.LinearSRGBColorSpace)
expect(view.renderer.setClearColor).toHaveBeenCalledWith(
view.state.clearColor,
0.25
)
view.dispose()
})
it('blit copies the bottom-left region of the shared buffer into the view canvas', () => {
const container = document.createElement('div')
const view = new RendererView(container)
view.renderer.setSize(1000, 800)
view.setSize(400, 300)
view.blit()
expect(drawImage).toHaveBeenCalledWith(
view.renderer.domElement,
0,
500,
400,
300,
0,
0,
400,
300
)
view.dispose()
})
})

View File

@@ -1,88 +0,0 @@
import type * as THREE from 'three'
import type {
RendererViewState,
SharedRendererHandle
} from './sharedWebGLRenderer'
import {
acquireSharedRenderer,
applyRendererViewState,
createRendererViewState,
ensureRendererSize
} from './sharedWebGLRenderer'
export class RendererView {
readonly renderer: THREE.WebGLRenderer
readonly canvas: HTMLCanvasElement
readonly state: RendererViewState = createRendererViewState()
width = 1
height = 1
private readonly context: CanvasRenderingContext2D
private readonly handle: SharedRendererHandle
private resizeObserver: ResizeObserver | null = null
constructor(container: HTMLElement) {
this.canvas = document.createElement('canvas')
this.canvas.classList.add(
'absolute',
'inset-0',
'h-full',
'w-full',
'outline-none'
)
const context = this.canvas.getContext('2d')
if (!context) {
throw new Error('Failed to create 2D context for 3D view')
}
this.context = context
this.handle = acquireSharedRenderer()
this.renderer = this.handle.renderer
container.appendChild(this.canvas)
}
setSize(width: number, height: number): void {
this.width = Math.max(1, Math.round(width))
this.height = Math.max(1, Math.round(height))
if (this.canvas.width !== this.width) this.canvas.width = this.width
if (this.canvas.height !== this.height) this.canvas.height = this.height
ensureRendererSize(this.renderer, this.width, this.height)
}
beginRender(): void {
ensureRendererSize(this.renderer, this.width, this.height)
applyRendererViewState(this.renderer, this.state)
}
blit(): void {
const source = this.renderer.domElement
this.context.globalCompositeOperation = 'copy'
this.context.drawImage(
source,
0,
source.height - this.height,
this.width,
this.height,
0,
0,
this.width,
this.height
)
}
observeResize(target: Element, onResize: () => void): void {
if (typeof ResizeObserver === 'undefined') return
this.resizeObserver?.disconnect()
this.resizeObserver = new ResizeObserver(() => onResize())
this.resizeObserver.observe(target)
}
dispose(): void {
this.resizeObserver?.disconnect()
this.resizeObserver = null
this.canvas.remove()
this.handle.release()
}
}

View File

@@ -1,140 +0,0 @@
import * as THREE from 'three'
import { describe, expect, it, vi } from 'vitest'
import {
acquireSharedRenderer,
applyRendererViewState,
createRendererViewState,
ensureRendererSize
} from './sharedWebGLRenderer'
const { rendererCtor, forceContextLoss, dispose } = vi.hoisted(() => ({
rendererCtor: vi.fn(),
forceContextLoss: vi.fn(),
dispose: vi.fn()
}))
vi.mock('three', async (importOriginal) => {
const actual = await importOriginal<typeof THREE>()
class WebGLRenderer {
domElement = document.createElement('canvas')
autoClear = true
outputColorSpace = ''
toneMapping = 0
toneMappingExposure = 1
width = 0
height = 0
constructor(opts: unknown) {
rendererCtor(opts)
}
setSize(width: number, height: number) {
this.width = width
this.height = height
}
getSize(target: THREE.Vector2) {
target.set(this.width, this.height)
return target
}
setPixelRatio() {}
setClearColor = vi.fn()
forceContextLoss = forceContextLoss
dispose = dispose
}
return { ...actual, WebGLRenderer }
})
describe('acquireSharedRenderer', () => {
it('returns the same renderer for concurrent views and disposes after the last release', () => {
rendererCtor.mockClear()
forceContextLoss.mockClear()
dispose.mockClear()
const first = acquireSharedRenderer()
const second = acquireSharedRenderer()
expect(second.renderer).toBe(first.renderer)
expect(rendererCtor).toHaveBeenCalledTimes(1)
first.release()
expect(dispose).not.toHaveBeenCalled()
const disposedWhenContextLostFired: boolean[] = []
second.renderer.domElement.addEventListener('webglcontextlost', () => {
disposedWhenContextLostFired.push(dispose.mock.calls.length > 0)
})
second.release()
expect(forceContextLoss).toHaveBeenCalledTimes(1)
expect(dispose).toHaveBeenCalledTimes(1)
expect(disposedWhenContextLostFired).toEqual([false])
})
it('creates a fresh renderer after the previous one was torn down', () => {
rendererCtor.mockClear()
const first = acquireSharedRenderer()
first.release()
const second = acquireSharedRenderer()
expect(rendererCtor).toHaveBeenCalledTimes(2)
expect(second.renderer).not.toBe(first.renderer)
second.release()
})
it('ignores double release from the same handle', () => {
dispose.mockClear()
const first = acquireSharedRenderer()
const second = acquireSharedRenderer()
first.release()
first.release()
expect(dispose).not.toHaveBeenCalled()
second.release()
expect(dispose).toHaveBeenCalledTimes(1)
})
})
describe('ensureRendererSize', () => {
it('grows the drawing buffer per-axis but never shrinks it', () => {
const handle = acquireSharedRenderer()
const renderer = handle.renderer
renderer.setSize(300, 300)
ensureRendererSize(renderer, 500, 200)
expect(renderer.getSize(new THREE.Vector2())).toEqual(
new THREE.Vector2(500, 300)
)
ensureRendererSize(renderer, 400, 250)
expect(renderer.getSize(new THREE.Vector2())).toEqual(
new THREE.Vector2(500, 300)
)
handle.release()
})
})
describe('applyRendererViewState', () => {
it('writes the per-view state onto the renderer', () => {
const handle = acquireSharedRenderer()
const renderer = handle.renderer
const state = createRendererViewState()
state.toneMapping = THREE.ACESFilmicToneMapping
state.toneMappingExposure = 0.5
state.outputColorSpace = THREE.LinearSRGBColorSpace
state.clearColor.set(0x123456)
state.clearAlpha = 0.25
applyRendererViewState(renderer, state)
expect(renderer.toneMapping).toBe(THREE.ACESFilmicToneMapping)
expect(renderer.toneMappingExposure).toBe(0.5)
expect(renderer.outputColorSpace).toBe(THREE.LinearSRGBColorSpace)
expect(renderer.setClearColor).toHaveBeenCalledWith(state.clearColor, 0.25)
handle.release()
})
})

View File

@@ -1,78 +0,0 @@
import * as THREE from 'three'
export type RendererViewState = {
toneMapping: THREE.ToneMapping
toneMappingExposure: number
outputColorSpace: THREE.ColorSpace
clearColor: THREE.Color
clearAlpha: number
}
export function createRendererViewState(): RendererViewState {
return {
toneMapping: THREE.NoToneMapping,
toneMappingExposure: 1.0,
outputColorSpace: THREE.SRGBColorSpace,
clearColor: new THREE.Color(0x000000),
clearAlpha: 0
}
}
export function applyRendererViewState(
renderer: THREE.WebGLRenderer,
state: RendererViewState
): void {
renderer.toneMapping = state.toneMapping
renderer.toneMappingExposure = state.toneMappingExposure
renderer.outputColorSpace = state.outputColorSpace
renderer.setClearColor(state.clearColor, state.clearAlpha)
}
export type SharedRendererHandle = {
renderer: THREE.WebGLRenderer
release: () => void
}
let sharedRenderer: THREE.WebGLRenderer | null = null
let viewCount = 0
function createSharedRenderer(): THREE.WebGLRenderer {
const renderer = new THREE.WebGLRenderer({ alpha: true, antialias: true })
renderer.setPixelRatio(1)
renderer.setSize(300, 300)
renderer.autoClear = false
renderer.outputColorSpace = THREE.SRGBColorSpace
return renderer
}
export function acquireSharedRenderer(): SharedRendererHandle {
sharedRenderer ??= createSharedRenderer()
viewCount++
const renderer = sharedRenderer
let released = false
return {
renderer,
release() {
if (released) return
released = true
viewCount--
if (viewCount > 0 || sharedRenderer !== renderer) return
sharedRenderer = null
renderer.forceContextLoss()
renderer.domElement.dispatchEvent(
new Event('webglcontextlost', { bubbles: true, cancelable: true })
)
renderer.dispose()
}
}
}
export function ensureRendererSize(
renderer: THREE.WebGLRenderer,
width: number,
height: number
): void {
const size = renderer.getSize(new THREE.Vector2())
if (size.width >= width && size.height >= height) return
renderer.setSize(Math.max(size.width, width), Math.max(size.height, height))
}

View File

@@ -38,6 +38,14 @@ interface CustomDialogComponentProps {
pt?: DialogPassThroughOptions
closeOnEscape?: boolean
dismissableMask?: boolean
/**
* When `false`, the Reka dialog does not dismiss when focus leaves its
* content. Set on container dialogs (e.g. Settings) that host nested dialogs,
* where a nested dialog closing can move focus onto an ordinary app element
* — a programmatic shift that must not be read as a dismiss. Escape and
* outside-pointer dismissal are unaffected. Defaults to `true`.
*/
dismissOnFocusOutside?: boolean
unstyled?: boolean
headless?: boolean
renderer?: DialogRenderer