문제: 라우터는 `AppShell` 아래 플랫폼 라우트를 모든 context보다 먼저 붙인다.
그래서 기능 라우트를 플랫폼 라우트도 받으면 오류 없이 플랫폼 화면이 나온다.
React Router `matchRoutes`로 라우터와 같은 구조를 만들어 확인했다.
- 같은 경로: context `examples/*`의 `/examples/ui`는 `EXAMPLES_UI`가 받는다.
레이아웃 아래에서도 순위가 같으면 앞에 있는 `AppShell`이 이긴다.
- `APP_HOME`이 아닌 id로 선언한 `/`는 플랫폼 홈이 받는다(ca16187 한계).
- 레이아웃 없는 `*` 루트 context는 모든 URL을 NOT_FOUND splat에 뺏긴다.
splat끼리 순위가 같고 플랫폼 쪽이 먼저다. 7139c7c의 루트 검사는 context
루트끼리만 비교해 이 셋을 통과시킨다.
고른 방법: 라우트 조립 런타임, 곧 `defineDeployableAppModule`의 09-06 검사
(`assertFeatureRoutesReachOwningContext`)에 한 단계를 더한다. 기능 라우트
경로마다 `[대체되지 않은 플랫폼 라우트..., context가 붙는 자리]`로
`matchRoutes`를 돌려, 그 context가 받지 않으면 route id, 경로, 기능, context,
가로챈 플랫폼 라우트를 담아 TypeError로 실패한다. context가 붙는 자리는
라우터와 같다. 레이아웃이 없으면 루트이고, 있으면 그 라우트의 경로다. 기능이
대신한 `APP_HOME`은 플랫폼 쪽에서 빼고, `APP_HOME` 라우트 자체는 지금처럼
건너뛴다.
- 앱 모듈을 평가할 때 실패하므로 부트와 앱 모듈을 불러오는 모든 테스트가
막힌다(fail-closed). 기존 09-06 검사와 같은 자리이고, 라우트 정의는 이미
초기 그래프에 있다.
버린 대안:
- 라우터(`createRegisteredRoutes`)에서 검사: 라우터 표 자체로 보니 순위가
정확하다. 하지만 `AppRouter`가 마운트될 때에야 실패하고, 앱 모듈을 fixture로
바꿔 끼우는 테스트를 따로 만들어야 한다.
- 아키텍처 테스트: 템플릿에 설치된 기능만 보고, 다운스트림이 기능을 더한
빌드는 실행 때 지켜지지 않는다.
- 레지스트리 검사(`check:registries`) 또는 생성기: 생성기는 정규식으로
리터럴만 읽어 라우트 경로를 모른다.
- 경로 문자열 비교: `*` 루트와 파라미터 모양이 같은 경로를 놓친다.
위험·한계:
- 라우터 순서를 이 함수가 따라 한다. `app-router.tsx`가 플랫폼 라우트를
context 뒤로 옮기면 이 검사도 같이 바꿔야 한다. 주석에 적었다.
- 일부만 겹치는 경우(`/examples/:slug`의 `ui` 값)는 막지 않는다. 그 기능
라우트는 다른 값으로는 닿는다.
- 기능끼리 같은 경로는 이 커밋 범위가 아니다.
검증:
- RED: tests/architecture/context-route-roots.test.ts 새 5건 중 거절 4건이
"expected [Function] to throw an error"로 실패(21건 중 4 실패).
- GREEN: 21건 통과. 메시지 예: "Route EXAMPLES_UI_COPY (/examples/ui) of
feature examples-feature in context examples is answered by platform route
EXAMPLES_UI (/examples/ui). A feature replaces a platform route only by
declaring its id (APP_HOME)."
- 회귀: tests/{architecture,unit,features,platform,component,contract,
runtime-schema,integration,scripts,scale}(pnpm을 띄우는 3개 제외) 306
files 중 3,569 통과, 1 실패. 실패는 telemetry-storm.test.ts 10초
timeout(부하 44)이고 단독 재실행에서 4건 통과했다.
- tsc app·test·node 통과. 바꾼 파일 eslint 통과. check-registries 통과.
verify-documentation-readiness PASS_SCOPED.
262 lines
16 KiB
Markdown
262 lines
16 KiB
Markdown
# Starter experience contract
|
|
|
|
The repository provides a runnable, domain-neutral application rather than
|
|
only infrastructure contracts. The starter experience is intentionally
|
|
replaceable at the page level while the shell, providers, boundaries,
|
|
primitives, and state surfaces remain reusable.
|
|
|
|
## Runtime composition
|
|
|
|
```text
|
|
validated config + coherent release manifest
|
|
-> concrete adapters
|
|
-> QueryClientProvider
|
|
-> ApplicationProvider
|
|
-> RouterProvider
|
|
-> ThemeProvider
|
|
-> SessionProvider
|
|
-> AppShell
|
|
-> lazy route boundary
|
|
```
|
|
|
|
Boot stops before product mount when configuration or release coherence fails.
|
|
Each lazy page renders inside Suspense and a telemetry-aware route boundary.
|
|
Route changes move focus to the new page heading; the skip link and landmarks
|
|
remain stable in the shell.
|
|
|
|
## Registered routes
|
|
|
|
The route list is `ROUTE_REGISTRY` (`src/features/installed-feature-contracts.ts`):
|
|
the platform routes of `src/contracts/routes.ts` plus the routes of every
|
|
installed feature. The platform overview page (`/examples/platform`) shows the
|
|
composed list at runtime, so this document does not keep a copy of it.
|
|
|
|
Navigation labels and order come from `ROUTE_REGISTRY`; the sidebar does not
|
|
maintain a second route list. The client access decision never claims to be
|
|
authorization.
|
|
|
|
## Authentication seam
|
|
|
|
The session port exposes state subscription, sign-in start, sign-out,
|
|
credential attachment, recovery, and unauthenticated notification. Credentials
|
|
remain opaque to the application and presentation layers.
|
|
|
|
- `demo`: local/development-only state transition with no credentials
|
|
- `external`: delegates to `globalThis.__CA_FRONTEND_AUTH_OWNER__`
|
|
- missing/invalid external owner: fails closed as `integration-failed`
|
|
|
|
An external owner implements `readState`, `readSubject`, `subscribe`,
|
|
`beginSignIn`, `signOut`, `attachCredential`, `recoverSession`, and
|
|
`notifyUnauthenticated`. It owns token acquisition and storage. An owner that
|
|
lacks any of these methods is rejected, and the session fails closed as
|
|
`integration-failed`.
|
|
|
|
`readSubject()` is required. The server-state cache is cleared only when the
|
|
session state or the subject changes, so a token refresh for the same user
|
|
keeps cached data. `readSubject()` must return:
|
|
|
|
- an opaque, non-empty string that stays the same for one user across token
|
|
refreshes and differs between users: the OIDC `sub` claim, Supabase
|
|
`session.user.id`, or Firebase `user.uid`
|
|
- `null` when nobody is signed in
|
|
- never an access token, refresh token, or any other credential
|
|
|
|
If `readSubject()` returns `null` or `""` while the owner reports
|
|
`authenticated`, the runtime cannot tell a refresh from an account switch. It
|
|
fails closed: every such notification clears server state, and each one records
|
|
the `cache.operation.failed` diagnostic with `operation: SCOPE_FENCE` and
|
|
`reason: SUBJECT_MISSING`. Seeing that diagnostic means the owner is not
|
|
reporting its subject. The `demo` adapter reports one fixed demo user as its
|
|
subject.
|
|
|
|
Migration: `readSubject()` used to be optional. An owner written for an earlier
|
|
release must add it; without it the owner is rejected at startup (the session
|
|
becomes `integration-failed`) and a TypeScript owner no longer compiles
|
|
against `ExternalSessionOwner`. A code path that implements `AuthSessionPort`
|
|
or `SessionGateway` directly must add `getSubject()` the same way.
|
|
|
|
## Extending the starter
|
|
|
|
New platform work should follow
|
|
[routing, page templates, and reusable patterns](./routing-pages-and-patterns.md)
|
|
and the
|
|
[TypeScript, state, and data-flow target](./typescript-state-and-data-flow.md)
|
|
rather than adding another independent route or data-loading convention.
|
|
|
|
### Replacing the starter screens
|
|
|
|
`/` (`src/presentation/pages/home-page.tsx`) and `/examples/*`
|
|
(`src/presentation/examples/`) are template content. Their own tests are the
|
|
`tests/component/starter-*.test.tsx` files; delete them together with the
|
|
screens. The platform's component tests (router, boundaries, shell, runtime
|
|
tree) run on the pages of the test-only feature in
|
|
`tests/helpers/fixture-feature.tsx` and keep passing when the starter screens
|
|
change. Browser-level checks of the starter screens stay in `tests/e2e` and
|
|
`tests/visual`.
|
|
|
|
### Ownership declarations
|
|
|
|
Features, contexts and apps are discovered by
|
|
`scripts/generate-product-feature-index.ts`. Each boundary declares only its
|
|
parent, as exported string or integer literals the generator reads:
|
|
|
|
| File | Exports |
|
|
| --- | --- |
|
|
| `src/apps/<app>/app-module.ts` | `APP_MODULE_ID`, `APP_MAX_CONTEXTS` |
|
|
| `src/contexts/<context>/context-module.ts` | `CONTEXT_MODULE_ID`, `CONTEXT_APP_ID`, `CONTEXT_ROUTE_PATH`, `CONTEXT_MAX_FEATURES` |
|
|
| `src/features/<feature>/feature-module.ts` | `FEATURE_MODULE_ID`, `FEATURE_CONTEXT_ID`, `FEATURE_MODULE` |
|
|
| `src/features/<feature>/feature-runtime.ts` | `FEATURE_RUNTIME` (imported only by `feature-module.ts`, dynamically) |
|
|
| `src/features/<feature>/context-routes.ts` | `FEATURE_CONTEXT_ROUTES` |
|
|
| `src/contexts/<context>/context-layout.tsx` (optional) | `CONTEXT_LAYOUT`, the context's own layout ("Product home and layouts") |
|
|
|
|
The generator writes `src/.generated/` (git-ignored): the feature index the
|
|
installed catalogs import, the context index the router loads lazily, and the
|
|
selected app. Every build and check script runs it first; run it yourself with
|
|
`corepack pnpm generate:feature-index`. It fails, naming the file, when:
|
|
|
|
- a directory under `src/features/` has no `feature-module.ts` and no
|
|
`NOT_INSTALLED` marker file (`src/features/local-draft-feature/NOT_INSTALLED`
|
|
is the one intentional example);
|
|
- a feature names an undeclared context, or a context an undeclared app;
|
|
- a context or app exceeds its declared budget;
|
|
- `VITE_PRODUCT_FEATURES` names a feature the app does not declare. The
|
|
variable narrows the installed set here, before anything is compiled.
|
|
|
|
### Adding a feature
|
|
|
|
1. Create `src/features/<feature>/feature-module.ts`. Build `FEATURE_MODULE`
|
|
with `defineFeatureModule` (`src/features/feature-module.ts`). This is the
|
|
feature's declaration, and it is in the initial chunk, so it holds data
|
|
only: the declaration contract (routes, route runtime contracts,
|
|
invalidation, topic versions and the external `contractPackages` the
|
|
release manifest is checked against at boot), its message catalogs, and
|
|
`loadRuntime`, which imports `feature-runtime.ts` dynamically.
|
|
`src/features/reference-feature/feature-module.ts` is the complete example.
|
|
2. Create `src/features/<feature>/feature-runtime.ts` with
|
|
`defineFeatureRuntime`: the API contract (operations, schema metadata,
|
|
runtime schemas, mappers), the adapter contributions
|
|
(`defineFeatureAdapterContribution`, with `needs` naming the platform
|
|
capabilities it receives) and the contract contributions. The router loads
|
|
it (`application.features.load`) when one of the feature's routes is
|
|
entered. Do not import it statically from anywhere: each feature would add
|
|
its whole executable code to the initial chunk again, about 3.9 KB gzip
|
|
(`tests/unit/feature-shape-growth.test.ts` bounds one feature at 1 KiB).
|
|
An HTTP API is written twice: its API contract operation (V2) is what
|
|
`check:registries` governs, and its contract contribution descriptor (V3)
|
|
is what executes. `tests/unit/http-operation-v2-v3-parity.test.ts` fails
|
|
when one exists without the other or when they disagree.
|
|
A product feature's contract contribution uses an `EXTERNAL_PACKAGE`
|
|
source. `TEMPLATE_FIXTURE` belongs to `reference-feature` only and never
|
|
joins the release contract set; the composer rejects it anywhere else.
|
|
3. Create `src/features/<feature>/context-routes.ts` exporting
|
|
`FEATURE_CONTEXT_ROUTES`. Page components are imported lazily here, and each
|
|
route handle carries the route's params/search `codecs`; the owning context
|
|
loads this file only when its route root is visited
|
|
(`src/features/reference-feature/context-routes.ts`). Each handle's
|
|
`routeId` must be a route of a feature contract in the same context; the
|
|
context refuses the routes when they load, naming the route, context and
|
|
features (`src/contexts/bounded-context-module.ts`).
|
|
4. Name the owning context in `FEATURE_CONTEXT_ID`. Use an existing context or
|
|
add `src/contexts/<context>/context-module.ts` owned by the app.
|
|
Every route path in the feature contract must sit at or under that
|
|
context's `CONTEXT_ROUTE_PATH` and must not fall under another context's
|
|
identical or more specific root: the router renders feature routes only
|
|
inside the owning context. No platform route may answer it either: the
|
|
router tries `AppShell`'s platform routes first, so the same path as a
|
|
platform route, `/` under an id other than `APP_HOME`, or a `*` root
|
|
without a layout (the not-found route takes every URL) never renders the
|
|
feature. The app module refuses anything else when it loads, naming the
|
|
route, feature and context (`src/apps/deployable-app-module.ts`). A route
|
|
that takes over the platform home is the exception ("Product home and
|
|
layouts").
|
|
5. If the feature has application input, augment `ApplicationFeatureInputs`
|
|
from the feature (`src/features/local-draft-feature/application/local-draft-api.ts`).
|
|
6. Run `corepack pnpm check:architecture`, `corepack pnpm check:types`,
|
|
`corepack pnpm check:registries` and the tests. `tests/unit/two-feature-install-typecheck.test.ts`
|
|
keeps the installed catalogs compiling with more than one feature.
|
|
7. Run `corepack pnpm test:sample-removal -- --feature=<feature id>` to prove
|
|
the product still builds and passes its gates without the feature.
|
|
|
|
Files outside the feature directory. Everything else a feature needs is in
|
|
`src/features/<feature>/` and `tests/features/<feature>/`.
|
|
|
|
| File | When | What fails without it |
|
|
| --- | --- | --- |
|
|
| `src/.generated/*` | never by hand: every build and check script regenerates it | — |
|
|
| `src/contexts/<context>/context-module.ts` | the feature needs a new context | `generate:feature-index`: `Feature <id> belongs to undeclared context <context>` |
|
|
| `src/contexts/<context>/context-layout.tsx` | the context needs its own frame instead of `AppShell` (see "Product home and layouts" below) | nothing: without it the context renders in `AppShell` |
|
|
| `artifacts/tests/a11y-manual/<ROUTE_ID>.md` | every route the feature adds. Copy a record and reset it to `Status: pending-manual-review` | `test:unit` (`tests/unit/manual-a11y-evidence.test.ts`), `verify:documentation` (names the route IDs) and FE-GATE-009 (`review:a11y-manual -- --format-only`). FE-GATE-028 requires the signed review at release |
|
|
| `tests/e2e/accessibility.spec.ts` | a route path has a parameter other than `:resourceId`, or a protected page cannot render while every API answers `[]` | `test:a11y` (FE-GATE-009): the spec fills in only `:resourceId` and answers every API with `[]` |
|
|
| `src/bootstrap/product-composition.ts` (product-owned) | `needs` names a capability the template does not build: augment `FeaturePlatformCapabilities` and return the capability here. `indexedDb` is built as in `recipes/frontend-capabilities/indexeddb-feature-capability.ts`. Credentials for a product auth profile are returned here too. A product that owns the session (a BFF's httpOnly cookie) returns its session owner from `composeProductSessionOwner` instead of installing it on the host global before boot | `check:types`; at runtime `feature <id> needs <capability>, which the host did not provide`. Without the session owner, `AUTH_MODE: "external"` boots with the session `integration-failed` |
|
|
| `src/contracts/product-contracts.ts` (product-owned) | a product auth profile, or a product runtime-config key and its FE-REG-ENV row (`PRODUCT_ENV_REGISTRY`) | auth profile: every gate that loads the operation, with `REST security profiles are incoherent for <operationId>: unknown authProfileId …`. Config key: `check:types` where it is read. FE-REG-ENV row: `check:registries` checks its fields; nothing requires the row |
|
|
| `config/runtime/<profile>.json` | optional: a `FEATURE_OVERRIDES` entry switches the feature off | nothing |
|
|
| `package.json`, the lockfile, `config/security/dependency-change-evidence.json` | the contract contribution imports a generated `@org-contracts/*` package as a production dependency | `generate:supply-chain` (in `check:bundle`): `high-risk dependency missing review: add:<package>` |
|
|
|
|
The central catalogs (`src/features/installed-*.ts`) and the registry
|
|
governance file do not change: consumer directories there are globs over every
|
|
feature (`src/features/*/adapters`, `config/contracts/registry-governance.json`).
|
|
A route's params/search schema ids are checked against the schemas the feature
|
|
registers, and its `loadingSurface` only has to be a kebab-case name, so a
|
|
route with its own schema and loading surface needs no governance edit either.
|
|
The registry baseline does not change either. New routes, API operations,
|
|
schemas and invalidation topics, namespaces and edges are additive registry
|
|
changes; `update:registry-baseline` or breaking evidence is needed only to
|
|
remove or change a row or graph item.
|
|
`tests/unit/second-api-feature-registries.test.ts` adds such a feature (an API
|
|
operation, a route with its own search schema and loading surface, and an
|
|
invalidation topic) to a copy of the repository and runs `check:registries` on
|
|
it.
|
|
|
|
Schema, operation, mapper, route and chunk ids and invalidation topics are
|
|
global. Prefix them with the feature; `NoRequest` already belongs to the
|
|
sample. MSW scenarios for the feature's own operations come from
|
|
`createHttpScenarioHandler` (`tests/mocks/handlers/http-scenarios.ts`) with
|
|
the feature's installed contract; the shared scenario catalog does not change.
|
|
|
|
### Product home and layouts
|
|
|
|
A product whose home is a feature screen, or whose screens use a frame other
|
|
than `AppShell`, declares it. The router and the catalogs do not change.
|
|
|
|
- **Home.** A feature takes over the platform home by declaring a route with
|
|
the id `APP_HOME` in its contract. The platform names the routes a feature
|
|
may take over (`FEATURE_REPLACEABLE_PLATFORM_ROUTE_IDS` in
|
|
`src/contracts/routes.ts`); any other platform route id is still a
|
|
duplicate. Two features declaring `APP_HOME` fail when the catalogs load,
|
|
naming both. The router mounts the route at its own path with the owning
|
|
context, whatever that context's route root. Leaving the feature out of the
|
|
build (`VITE_PRODUCT_FEATURES`) brings the platform home back; switching it
|
|
off at runtime shows the disabled-feature page at its path.
|
|
- **Layout.** A context with `src/contexts/<context>/context-layout.tsx`
|
|
exporting `CONTEXT_LAYOUT` (a component) renders under that layout instead
|
|
of `AppShell`. The generated index loads the file lazily, when one of the
|
|
context's routes is entered. The router mounts the context at each
|
|
registered path of its features under the layout, so an unknown URL still
|
|
gets the not-found page in `AppShell`. Contexts whose layout files export the
|
|
same component keep one layout instance when the user moves between them,
|
|
so several route roots can share a layout.
|
|
- **Accessibility.** The layout renders a skip link to `#main-content` and
|
|
exactly one `<main id="main-content" tabIndex={-1}>` around `<Outlet />`.
|
|
The router moves focus there on every route change. Layout routes are
|
|
siblings of `AppShell`, never inside it.
|
|
`tests/component/layout-landmarks.test.tsx` renders `AppShell` and the
|
|
layout of every installed context and fails one without them.
|
|
- **Failures.** A layout chunk a deploy removed gets the reload-once recovery
|
|
of a route chunk. Route and feature boundaries work as they do in
|
|
`AppShell`.
|
|
- The route root rule of step 4 spans every layout: a root takes the URLs
|
|
under it whichever layout either context has.
|
|
|
|
`tests/component/context-layouts.test.tsx` installs a product declared this
|
|
way (`tests/helpers/fixture-layout-product.tsx`).
|
|
|
|
### Before shipping
|
|
|
|
- Use the semantic tokens, UI primitives, and state surfaces before adding a
|
|
project-specific variant.
|
|
- Add component behavior, all-engine E2E, automated axe, and signed manual
|
|
route evidence.
|
|
|
|
Theme preference is the public `COLOR_SCHEME` storage contract. Authentication
|
|
tokens and other secrets remain forbidden storage keys.
|