opencode-skills-collection 3.0.35 → 3.0.37
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bundled-skills/.antigravity-install-manifest.json +15 -1
- package/bundled-skills/accesslint-audit/SKILL.md +115 -0
- package/bundled-skills/accesslint-diff/SKILL.md +81 -0
- package/bundled-skills/accesslint-scan/SKILL.md +47 -0
- package/bundled-skills/composition-patterns/SKILL.md +87 -0
- package/bundled-skills/composition-patterns/rules/_sections.md +29 -0
- package/bundled-skills/composition-patterns/rules/_template.md +24 -0
- package/bundled-skills/composition-patterns/rules/architecture-avoid-boolean-props.md +100 -0
- package/bundled-skills/composition-patterns/rules/architecture-compound-components.md +112 -0
- package/bundled-skills/composition-patterns/rules/patterns-children-over-render-props.md +87 -0
- package/bundled-skills/composition-patterns/rules/patterns-explicit-variants.md +100 -0
- package/bundled-skills/composition-patterns/rules/react19-no-forwardref.md +42 -0
- package/bundled-skills/composition-patterns/rules/state-context-interface.md +191 -0
- package/bundled-skills/composition-patterns/rules/state-decouple-implementation.md +113 -0
- package/bundled-skills/composition-patterns/rules/state-lift-state.md +125 -0
- package/bundled-skills/debugging-toolkit/SKILL.md +35 -0
- package/bundled-skills/deploy-to-vercel/SKILL.md +304 -0
- package/bundled-skills/deploy-to-vercel/resources/deploy-codex.sh +301 -0
- package/bundled-skills/deploy-to-vercel/resources/deploy.sh +301 -0
- package/bundled-skills/docs/integrations/jetski-cortex.md +3 -3
- package/bundled-skills/docs/integrations/jetski-gemini-loader/README.md +1 -1
- package/bundled-skills/docs/maintainers/backups/README-2026-06-02.md +687 -0
- package/bundled-skills/docs/maintainers/repo-growth-seo.md +4 -4
- package/bundled-skills/docs/maintainers/skills-update-guide.md +1 -1
- package/bundled-skills/docs/users/bundles.md +245 -1
- package/bundled-skills/docs/users/claude-code-skills.md +1 -1
- package/bundled-skills/docs/users/gemini-cli-skills.md +1 -1
- package/bundled-skills/docs/users/getting-started.md +1 -1
- package/bundled-skills/docs/users/kiro-integration.md +1 -1
- package/bundled-skills/docs/users/plugins.md +21 -13
- package/bundled-skills/docs/users/specialized-plugin-roadmap.md +95 -0
- package/bundled-skills/docs/users/usage.md +4 -4
- package/bundled-skills/docs/users/visual-guide.md +4 -4
- package/bundled-skills/polis-protocol/SKILL.md +93 -0
- package/bundled-skills/python-development/SKILL.md +35 -0
- package/bundled-skills/radix-ui-design-system/SKILL.md +2 -2
- package/bundled-skills/react-native-skills/SKILL.md +120 -0
- package/bundled-skills/react-native-skills/rules/_sections.md +86 -0
- package/bundled-skills/react-native-skills/rules/_template.md +28 -0
- package/bundled-skills/react-native-skills/rules/animation-derived-value.md +53 -0
- package/bundled-skills/react-native-skills/rules/animation-gesture-detector-press.md +95 -0
- package/bundled-skills/react-native-skills/rules/animation-gpu-properties.md +65 -0
- package/bundled-skills/react-native-skills/rules/design-system-compound-components.md +66 -0
- package/bundled-skills/react-native-skills/rules/fonts-config-plugin.md +71 -0
- package/bundled-skills/react-native-skills/rules/imports-design-system-folder.md +68 -0
- package/bundled-skills/react-native-skills/rules/js-hoist-intl.md +61 -0
- package/bundled-skills/react-native-skills/rules/list-performance-callbacks.md +44 -0
- package/bundled-skills/react-native-skills/rules/list-performance-function-references.md +132 -0
- package/bundled-skills/react-native-skills/rules/list-performance-images.md +53 -0
- package/bundled-skills/react-native-skills/rules/list-performance-inline-objects.md +97 -0
- package/bundled-skills/react-native-skills/rules/list-performance-item-expensive.md +94 -0
- package/bundled-skills/react-native-skills/rules/list-performance-item-memo.md +82 -0
- package/bundled-skills/react-native-skills/rules/list-performance-item-types.md +104 -0
- package/bundled-skills/react-native-skills/rules/list-performance-virtualize.md +67 -0
- package/bundled-skills/react-native-skills/rules/monorepo-native-deps-in-app.md +46 -0
- package/bundled-skills/react-native-skills/rules/monorepo-single-dependency-versions.md +63 -0
- package/bundled-skills/react-native-skills/rules/navigation-native-navigators.md +188 -0
- package/bundled-skills/react-native-skills/rules/react-compiler-destructure-functions.md +50 -0
- package/bundled-skills/react-native-skills/rules/react-compiler-reanimated-shared-values.md +48 -0
- package/bundled-skills/react-native-skills/rules/react-state-dispatcher.md +91 -0
- package/bundled-skills/react-native-skills/rules/react-state-fallback.md +56 -0
- package/bundled-skills/react-native-skills/rules/react-state-minimize.md +65 -0
- package/bundled-skills/react-native-skills/rules/rendering-no-falsy-and.md +74 -0
- package/bundled-skills/react-native-skills/rules/rendering-text-in-text-component.md +36 -0
- package/bundled-skills/react-native-skills/rules/scroll-position-no-state.md +82 -0
- package/bundled-skills/react-native-skills/rules/state-ground-truth.md +80 -0
- package/bundled-skills/react-native-skills/rules/ui-expo-image.md +66 -0
- package/bundled-skills/react-native-skills/rules/ui-image-gallery.md +104 -0
- package/bundled-skills/react-native-skills/rules/ui-measure-views.md +78 -0
- package/bundled-skills/react-native-skills/rules/ui-menus.md +174 -0
- package/bundled-skills/react-native-skills/rules/ui-native-modals.md +77 -0
- package/bundled-skills/react-native-skills/rules/ui-pressable.md +61 -0
- package/bundled-skills/react-native-skills/rules/ui-safe-area-scroll.md +65 -0
- package/bundled-skills/react-native-skills/rules/ui-scrollview-content-inset.md +45 -0
- package/bundled-skills/react-native-skills/rules/ui-styling.md +87 -0
- package/bundled-skills/skill-issue/SKILL.md +73 -0
- package/bundled-skills/tdd-workflows/SKILL.md +35 -0
- package/bundled-skills/vercel-cli-with-tokens/SKILL.md +361 -0
- package/bundled-skills/vercel-optimize/CONTRIBUTING.md +41 -0
- package/bundled-skills/vercel-optimize/SKILL.md +331 -0
- package/bundled-skills/vercel-optimize/lib/auth-route.mjs +23 -0
- package/bundled-skills/vercel-optimize/lib/budget-summary.mjs +182 -0
- package/bundled-skills/vercel-optimize/lib/citations.mjs +139 -0
- package/bundled-skills/vercel-optimize/lib/cost-coverage.mjs +143 -0
- package/bundled-skills/vercel-optimize/lib/dedup-recs.mjs +325 -0
- package/bundled-skills/vercel-optimize/lib/deep-dive.mjs +350 -0
- package/bundled-skills/vercel-optimize/lib/display-labels.mjs +185 -0
- package/bundled-skills/vercel-optimize/lib/extract-claims.mjs +550 -0
- package/bundled-skills/vercel-optimize/lib/framework-support.mjs +67 -0
- package/bundled-skills/vercel-optimize/lib/gates/build-minutes-fanout.mjs +69 -0
- package/bundled-skills/vercel-optimize/lib/gates/cold-start.mjs +66 -0
- package/bundled-skills/vercel-optimize/lib/gates/contract.mjs +79 -0
- package/bundled-skills/vercel-optimize/lib/gates/cwv-poor.mjs +87 -0
- package/bundled-skills/vercel-optimize/lib/gates/external-api-slow.mjs +55 -0
- package/bundled-skills/vercel-optimize/lib/gates/hard-gates.mjs +73 -0
- package/bundled-skills/vercel-optimize/lib/gates/index.mjs +45 -0
- package/bundled-skills/vercel-optimize/lib/gates/isr-overrevalidation.mjs +62 -0
- package/bundled-skills/vercel-optimize/lib/gates/middleware-heavy.mjs +51 -0
- package/bundled-skills/vercel-optimize/lib/gates/observability-events-attribution.mjs +56 -0
- package/bundled-skills/vercel-optimize/lib/gates/platform-bot-protection.mjs +115 -0
- package/bundled-skills/vercel-optimize/lib/gates/platform-fluid-compute.mjs +83 -0
- package/bundled-skills/vercel-optimize/lib/gates/region-misconfig.mjs +64 -0
- package/bundled-skills/vercel-optimize/lib/gates/route-errors.mjs +80 -0
- package/bundled-skills/vercel-optimize/lib/gates/scanner-driven.mjs +122 -0
- package/bundled-skills/vercel-optimize/lib/gates/select-candidates.mjs +134 -0
- package/bundled-skills/vercel-optimize/lib/gates/slow-route.mjs +88 -0
- package/bundled-skills/vercel-optimize/lib/gates/types.d.ts +38 -0
- package/bundled-skills/vercel-optimize/lib/gates/uncached-route.mjs +93 -0
- package/bundled-skills/vercel-optimize/lib/gates/usage-spike-triage.mjs +121 -0
- package/bundled-skills/vercel-optimize/lib/grade-recommendation.mjs +155 -0
- package/bundled-skills/vercel-optimize/lib/impact-label.mjs +126 -0
- package/bundled-skills/vercel-optimize/lib/impact-magnitude.mjs +60 -0
- package/bundled-skills/vercel-optimize/lib/investigation-brief.mjs +610 -0
- package/bundled-skills/vercel-optimize/lib/observation-safety.mjs +174 -0
- package/bundled-skills/vercel-optimize/lib/project-facts.mjs +99 -0
- package/bundled-skills/vercel-optimize/lib/queries.mjs +315 -0
- package/bundled-skills/vercel-optimize/lib/reconcile-candidates.mjs +372 -0
- package/bundled-skills/vercel-optimize/lib/render-report.mjs +955 -0
- package/bundled-skills/vercel-optimize/lib/repo-root.mjs +86 -0
- package/bundled-skills/vercel-optimize/lib/route-normalize.mjs +220 -0
- package/bundled-skills/vercel-optimize/lib/sanitizers/bot-protection-certainty.mjs +38 -0
- package/bundled-skills/vercel-optimize/lib/sanitizers/cache-tag-invalidation-certainty.mjs +30 -0
- package/bundled-skills/vercel-optimize/lib/sanitizers/count-correct.mjs +52 -0
- package/bundled-skills/vercel-optimize/lib/sanitizers/function-duration-invocations.mjs +38 -0
- package/bundled-skills/vercel-optimize/lib/sanitizers/index.mjs +79 -0
- package/bundled-skills/vercel-optimize/lib/sanitizers/middleware-conflict.mjs +36 -0
- package/bundled-skills/vercel-optimize/lib/sanitizers/missing-citation.mjs +16 -0
- package/bundled-skills/vercel-optimize/lib/sanitizers/pre-release.mjs +74 -0
- package/bundled-skills/vercel-optimize/lib/sanitizers/rate-limit.mjs +67 -0
- package/bundled-skills/vercel-optimize/lib/sanitizers/rendering-mode-mislabel.mjs +38 -0
- package/bundled-skills/vercel-optimize/lib/sanitizers/undeclared-dep.mjs +78 -0
- package/bundled-skills/vercel-optimize/lib/sanitizers/vercel-directive-strip.mjs +37 -0
- package/bundled-skills/vercel-optimize/lib/sanitizers/window-units.mjs +32 -0
- package/bundled-skills/vercel-optimize/lib/scanners/cache-components-suspense-dedupe.mjs +109 -0
- package/bundled-skills/vercel-optimize/lib/scanners/edge-heavy-import.mjs +94 -0
- package/bundled-skills/vercel-optimize/lib/scanners/force-dynamic.mjs +42 -0
- package/bundled-skills/vercel-optimize/lib/scanners/headers-in-page.mjs +44 -0
- package/bundled-skills/vercel-optimize/lib/scanners/index.mjs +35 -0
- package/bundled-skills/vercel-optimize/lib/scanners/large-static-asset.mjs +92 -0
- package/bundled-skills/vercel-optimize/lib/scanners/max-age-without-s-maxage.mjs +42 -0
- package/bundled-skills/vercel-optimize/lib/scanners/middleware-broad-matcher.mjs +55 -0
- package/bundled-skills/vercel-optimize/lib/scanners/missing-cache-headers.mjs +90 -0
- package/bundled-skills/vercel-optimize/lib/scanners/prisma-include-tree.mjs +42 -0
- package/bundled-skills/vercel-optimize/lib/scanners/region-pin-in-config.mjs +88 -0
- package/bundled-skills/vercel-optimize/lib/scanners/source-maps-production.mjs +36 -0
- package/bundled-skills/vercel-optimize/lib/scanners/sveltekit-prerender-missing.mjs +43 -0
- package/bundled-skills/vercel-optimize/lib/scanners/turbo-force-bypass.mjs +129 -0
- package/bundled-skills/vercel-optimize/lib/scanners/unoptimized-image.mjs +113 -0
- package/bundled-skills/vercel-optimize/lib/scanners/use-cache-date-stamp.mjs +106 -0
- package/bundled-skills/vercel-optimize/lib/support-topics.mjs +355 -0
- package/bundled-skills/vercel-optimize/lib/throttle.mjs +273 -0
- package/bundled-skills/vercel-optimize/lib/util.mjs +17 -0
- package/bundled-skills/vercel-optimize/lib/vercel.mjs +784 -0
- package/bundled-skills/vercel-optimize/lib/verify-claim.mjs +1296 -0
- package/bundled-skills/vercel-optimize/lib/workspace-resolver.mjs +521 -0
- package/bundled-skills/vercel-optimize/references/candidates.md +176 -0
- package/bundled-skills/vercel-optimize/references/data-collection.md +218 -0
- package/bundled-skills/vercel-optimize/references/docs-library.json +683 -0
- package/bundled-skills/vercel-optimize/references/doctrine.md +105 -0
- package/bundled-skills/vercel-optimize/references/observability-plus.md +108 -0
- package/bundled-skills/vercel-optimize/references/playbooks/README.md +53 -0
- package/bundled-skills/vercel-optimize/references/playbooks/ai-application.md +32 -0
- package/bundled-skills/vercel-optimize/references/playbooks/api-service.md +30 -0
- package/bundled-skills/vercel-optimize/references/playbooks/content-site.md +30 -0
- package/bundled-skills/vercel-optimize/references/playbooks/ecommerce.md +30 -0
- package/bundled-skills/vercel-optimize/references/playbooks/marketing.md +30 -0
- package/bundled-skills/vercel-optimize/references/playbooks/saas.md +31 -0
- package/bundled-skills/vercel-optimize/references/playbooks/sveltekit.md +75 -0
- package/bundled-skills/vercel-optimize/references/recommendations.md +203 -0
- package/bundled-skills/vercel-optimize/references/scanner-patterns.md +251 -0
- package/bundled-skills/vercel-optimize/references/scoring.md +205 -0
- package/bundled-skills/vercel-optimize/references/support-topics/README.md +46 -0
- package/bundled-skills/vercel-optimize/references/support-topics/astro-edge-middleware-scope.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/astro-output-mode-and-isr.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/auth-preserving-parallelization.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/bot-protection-product-guardrails.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/build-minutes-monorepo-fanout.md +23 -0
- package/bundled-skills/vercel-optimize/references/support-topics/cache-components-static-shell-boundaries.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/cache-components-suspense-dedupe-pitfall.md +23 -0
- package/bundled-skills/vercel-optimize/references/support-topics/cdn-cache-auth-safety.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/cold-start-initialization-bundle.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/core-web-vitals-client-bottlenecks.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/database-egress-pooling-region.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/dynamic-rendering-traps.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/external-api-critical-path-platform.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/external-api-critical-path.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/fast-data-transfer-payloads.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/fluid-compute-caveats.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/function-duration-io-and-after.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/function-invocation-reduction.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/function-region-misconfiguration-ttfb.md +23 -0
- package/bundled-skills/vercel-optimize/references/support-topics/image-optimization-cost-control.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/isr-revalidation-static-generation.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/middleware-proxy-edge-cost.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/next-fetch-revalidate-floor.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/next-font-cls-self-hosting.md +23 -0
- package/bundled-skills/vercel-optimize/references/support-topics/next-heavy-ui-lazy-load-boundaries.md +23 -0
- package/bundled-skills/vercel-optimize/references/support-topics/next-image-lcp-preload-sizes.md +23 -0
- package/bundled-skills/vercel-optimize/references/support-topics/next-route-handler-get-cache-defaults.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/next-script-third-party-strategy.md +23 -0
- package/bundled-skills/vercel-optimize/references/support-topics/nextjs-version-cache-semantics.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/not-found-catchall-request-waste.md +23 -0
- package/bundled-skills/vercel-optimize/references/support-topics/nuxt-route-rules-cache-isr.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/observability-events-cost-attribution.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/post-response-work-waituntil.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/route-error-durable-offload.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/route-error-runtime-limits.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/runtime-cache-reusable-data.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/sveltekit-isr-prerender-safety.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/sveltekit-split-cold-start-tradeoff.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/usage-spike-triage.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/use-cache-date-stamp-isr-write-amplifier.md +23 -0
- package/bundled-skills/vercel-optimize/references/support-topics/use-cache-remote-shared-origin-data.md +22 -0
- package/bundled-skills/vercel-optimize/references/support-topics/workflow-resumable-stream-routes.md +23 -0
- package/bundled-skills/vercel-optimize/references/verification.md +102 -0
- package/bundled-skills/vercel-optimize/references/voice.md +76 -0
- package/bundled-skills/vercel-optimize/scripts/budget-summary.mjs +56 -0
- package/bundled-skills/vercel-optimize/scripts/build-docs.mjs +74 -0
- package/bundled-skills/vercel-optimize/scripts/check-citations.mjs +81 -0
- package/bundled-skills/vercel-optimize/scripts/check-docs-fresh.mjs +93 -0
- package/bundled-skills/vercel-optimize/scripts/collect-signals.mjs +576 -0
- package/bundled-skills/vercel-optimize/scripts/collect-sub-agent-outputs.mjs +296 -0
- package/bundled-skills/vercel-optimize/scripts/deep-dive.mjs +319 -0
- package/bundled-skills/vercel-optimize/scripts/gate-investigations.mjs +166 -0
- package/bundled-skills/vercel-optimize/scripts/merge-signals.mjs +192 -0
- package/bundled-skills/vercel-optimize/scripts/prepare-investigation-brief.mjs +231 -0
- package/bundled-skills/vercel-optimize/scripts/reconcile-candidates.mjs +62 -0
- package/bundled-skills/vercel-optimize/scripts/render-report.mjs +437 -0
- package/bundled-skills/vercel-optimize/scripts/scan-codebase.mjs +313 -0
- package/bundled-skills/vercel-optimize/scripts/verify-and-regen.mjs +346 -0
- package/bundled-skills/vercel-optimize/scripts/verify-finding.mjs +19 -0
- package/bundled-skills/vercel-react-view-transitions/SKILL.md +327 -0
- package/bundled-skills/vercel-react-view-transitions/references/css-recipes.md +242 -0
- package/bundled-skills/vercel-react-view-transitions/references/implementation.md +182 -0
- package/bundled-skills/vercel-react-view-transitions/references/nextjs.md +176 -0
- package/bundled-skills/vercel-react-view-transitions/references/patterns.md +262 -0
- package/package.json +2 -2
- package/skills_index.json +312 -0
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
# Doctrine
|
|
2
|
+
|
|
3
|
+
The four non-negotiable rules that shape every action this skill takes. If a future change conflicts with one of these, the change is wrong.
|
|
4
|
+
|
|
5
|
+
## Rule 1: Observability before investigation
|
|
6
|
+
|
|
7
|
+
The skill never reads a source file without an observability signal pointing at it. Step 1 (`node scripts/collect-signals.mjs`) is always first. Nothing reads source code until `signals.json` exists.
|
|
8
|
+
|
|
9
|
+
**Why this fails when skipped:** without metrics, the skill defaults to "grep the repo for known anti-patterns and complain." That produces noisy, low-impact recs that aren't tied to traffic, cost, or user pain. Metrics-first investigation keeps the skill focused on observed traffic, cost, and reliability signals.
|
|
10
|
+
|
|
11
|
+
### Four-check first-pass (Enterprise)
|
|
12
|
+
|
|
13
|
+
When `plan === 'enterprise'`, the gate run must surface these four checks before code-level recommendations. Field engineers confirm these are the highest-leverage account-level levers across every renewal audit:
|
|
14
|
+
|
|
15
|
+
1. **Observability Plus enabled?** From `signals.observabilityPlus`. If false, the whole audit degrades; surface as a top-of-report item.
|
|
16
|
+
2. **Reverse proxy in front?** Heuristic from response headers / CNAME chain (when collected). A non-Vercel CDN over Vercel ISR is usually a "dumb pipe" — wasted spend.
|
|
17
|
+
3. **WAF rules enabled?** From `signals.project.security`. BotID + managed rules absent on a project with bot evidence is the most common cost spike.
|
|
18
|
+
4. **ISR read:write ratio.** From `metrics.isrReadsByRoute` + `metrics.isrWritesByRoute`. Include CDN-tier reads (see [data-collection.md](data-collection.md)) before flagging "writes > reads."
|
|
19
|
+
|
|
20
|
+
These checks anchor the Enterprise-tier report's opening narrative; code-level recs follow.
|
|
21
|
+
|
|
22
|
+
## Rule 2: Deterministic gate before every sub-agent investigation
|
|
23
|
+
|
|
24
|
+
`node scripts/gate-investigations.mjs` is a pure-JS, LLM-free function. It reads `signals.json` and outputs `{toLaunch, platform, gated}`. Same input always produces byte-identical output (modulo `appliedAt`).
|
|
25
|
+
|
|
26
|
+
Every kind of candidate (uncached route, slow route, errors, cold starts, scanner findings, platform-level recs) has its threshold expression encoded as a `gate(signals) → Candidate[]` function in `lib/gates/<kind>.mjs`.
|
|
27
|
+
|
|
28
|
+
**Failed gates surface in the final report**, under "Not investigated in this run," with the exact reason they were held back. This is the user-facing trust mechanism: you see what we considered and chose to skip, and the reason.
|
|
29
|
+
|
|
30
|
+
**Why this matters:** the agent never decides "should I look at this route?" via LLM judgment. The threshold is mechanical. This eliminates the entire failure mode where the agent investigates routes it shouldn't (cold-path) and recommends fixes for routes that don't need them.
|
|
31
|
+
|
|
32
|
+
## Rule 3: Candidate-bound investigation scope
|
|
33
|
+
|
|
34
|
+
When the gate emits a candidate with `files: ['src/app/api/products/route.ts']`, the agent reads ONLY that file (and its imports as the chain unfolds). It does NOT `grep -r` across the repo.
|
|
35
|
+
|
|
36
|
+
If you find yourself wanting to grep the whole codebase, stop and re-read the current candidate's `question` field. If the question doesn't constrain the search, the candidate is malformed — log it as `gated` and skip. Do NOT compensate with a wider search.
|
|
37
|
+
|
|
38
|
+
**Why this matters:** the agent's job is to verify and explain the metric anomaly the gate found, not to do a general code review. Wandering investigations produce drift, hallucination, and recommendations untied to the cost and performance data.
|
|
39
|
+
|
|
40
|
+
### Scanner findings (the supplementary signal)
|
|
41
|
+
|
|
42
|
+
Static AST-grep scanners run in parallel with the metric-driven investigations. Their output is annotated with the per-file observability signal (`function invocations: 1.2M; 95th percentile duration: 850ms; cache hit rate: 0%` if the file maps to a hot route, `COLD-PATH` if it maps to a route with no traffic, `NO-ROUTE-MAPPING` if the file doesn't map to any route).
|
|
43
|
+
|
|
44
|
+
**Default rule:** scanner findings on `COLD-PATH` or `NO-ROUTE-MAPPING` files are dropped. They become recs only if the pattern is *traffic-independent*: build configuration, middleware matcher, source maps in production, raw script tags, React Compiler config. These don't care about traffic — they affect every request equally or affect the build itself.
|
|
45
|
+
|
|
46
|
+
The traffic-independent allow-list lives in each scanner's `metadata.trafficIndependent: boolean` field. Set it to `true` only when you can defend the claim.
|
|
47
|
+
|
|
48
|
+
## Rule 4: Doc-grounded, version-aware recommendations — no hallucinations
|
|
49
|
+
|
|
50
|
+
Every recommendation must carry at least one citation from `references/docs-library.json`. Anything else is dropped at sanitizer time.
|
|
51
|
+
|
|
52
|
+
The library has two parts:
|
|
53
|
+
- **URLs** — Vercel docs, Next.js docs, SvelteKit docs, etc. Each declares `applicableFrameworks` (e.g., `["next@>=15.0.0"]`).
|
|
54
|
+
- **Cross-skill rule references** — by name only (`vercel-react-best-practices:async-parallel`). The agent's host resolves these.
|
|
55
|
+
|
|
56
|
+
Three sanitizers enforce this:
|
|
57
|
+
- `missing-citation` — drops recs with empty `citations[]`.
|
|
58
|
+
- `unknown-citation` — strips URLs not in the library, marks `needsReview=true`.
|
|
59
|
+
- `version-mismatch` — strips URLs whose `applicableFrameworks` doesn't match the project's framework@version (parsed from `package.json`).
|
|
60
|
+
|
|
61
|
+
Two verifier claim types check it: `citation_in_library` (URL ∈ allow-list) and `citation_applies_to_version` (semver match).
|
|
62
|
+
|
|
63
|
+
**Why this matters:** LLMs cite plausible-looking URLs that 404, or recommend Next 15 features to Next 13 users. Both are trust-killers. The allow-list closes the first failure mode; the `applicableFrameworks` field closes the second.
|
|
64
|
+
|
|
65
|
+
### Performance citations cite observed data
|
|
66
|
+
|
|
67
|
+
Every performance claim cites the actual observability datum from `signals.json` — e.g., `functionRoutes[/api/products].p95Ms=850`. Estimated improvements are framed as ranges grounded in the observed baseline: `"Reduce /api/products 95th percentile duration from 850ms toward ~250-400ms based on similar cached routes."` Never an unanchored claim.
|
|
68
|
+
|
|
69
|
+
### Cost framing is magnitude, never precise
|
|
70
|
+
|
|
71
|
+
Cost claims like `$340/mo` are forbidden. The dollar noise floor on projections is too high to justify precision. The `impactMagnitude({currentCost, impactTier})` helper maps to phrases like `"hundreds of dollars per month at current traffic"` (computed against the user's actual `vercel usage` data).
|
|
72
|
+
|
|
73
|
+
The `$-strip` sanitizer enforces this at output time — any `$N` literal in customer-facing fields is stripped.
|
|
74
|
+
|
|
75
|
+
Performance numbers stay precise because they're observed, not extrapolated. We trust observed metrics; we don't trust dollar projections.
|
|
76
|
+
|
|
77
|
+
## What good looks like
|
|
78
|
+
|
|
79
|
+
A good run produces:
|
|
80
|
+
- A small number (5-15) of recommendations.
|
|
81
|
+
- Every rec ties to a specific route or file plus a specific metric signal.
|
|
82
|
+
- Every rec carries before/after code and ≥1 citation matching the user's framework version.
|
|
83
|
+
- Cost framing uses magnitude phrases. Performance framing uses precise observed numbers.
|
|
84
|
+
- The "Not investigated in this run" section explains every other signal we saw and why we chose not to dig (cache hit rate was below threshold, 95th percentile duration was already healthy, etc.).
|
|
85
|
+
- No `$N/mo` strings, no fabricated URLs, no Next.js 15 features recommended to a Next.js 13 user.
|
|
86
|
+
|
|
87
|
+
## What bad looks like (anti-patterns we will not ship)
|
|
88
|
+
|
|
89
|
+
- Recommendations from grepping the repo for known anti-patterns, without checking traffic.
|
|
90
|
+
- "Enable Fluid Compute" without a cold-start signal.
|
|
91
|
+
- "Add caching to /api/users" when the route has cookies() and is auth-gated.
|
|
92
|
+
- "Reduce the duration of `/.well-known/workflow/v1/step`" because a Workflow step is long-running. Workflow runtime endpoints are generated orchestration routes; high wall-clock duration there is expected unless a separate reliability/error signal points elsewhere.
|
|
93
|
+
- "Fix `/api/chat/[id]/stream` because it has high duration" without proving the stream does avoidable pre-first-byte work, high active CPU, duplicate invocations, or movable post-response work.
|
|
94
|
+
- "Save $340/mo by doing X" — invented precision.
|
|
95
|
+
- Citations to URLs that don't exist or that describe Next.js features the user's version doesn't have.
|
|
96
|
+
- Long lists of recs the user can't act on; every rec needs an evidence chain.
|
|
97
|
+
|
|
98
|
+
## Out of scope
|
|
99
|
+
|
|
100
|
+
The skill is bounded to runtime cost and performance optimization on Vercel-hosted projects. The following are explicit non-goals; if signals or scanner findings surface in these areas, route them out:
|
|
101
|
+
|
|
102
|
+
- **Deployment artifact size** in isolation. Bundle size matters only when it shows up as runtime cost (cold start, FDT) or performance (LCP, INP). If the only effect is "the .next directory is large," it's not in scope.
|
|
103
|
+
- **Build-time issues without runtime impact.** Slow builds, build-cache misses, monorepo build fan-out — these only enter scope when they show up as Build Minutes billing pressure (then they go through the `build-minutes-fanout` gate). A 6-minute build that completes successfully and ships a small artifact is not a target.
|
|
104
|
+
- **Security advisories and credential rotation.** RCE in `next-mdx-remote`, leaked env vars, OIDC vs explicit-key auth hygiene — refer to a security skill, not this one. Exception: when a security setting is also a documented cost lever (BotID = bot traffic = edge cost), it enters via the `platform_bot_protection` gate.
|
|
105
|
+
- **Commercial / billing-process trivia.** Discount sliders, seat reconciliation, contract renewal mechanics. The skill can quantify which SKU is expensive; it does not negotiate.
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
# Observability Plus Stop-And-Ask
|
|
2
|
+
|
|
3
|
+
Use this file only when `signals.observabilityPlusBlocker` is set. Do not silently continue into scanner-only mode unless the user chooses that path.
|
|
4
|
+
|
|
5
|
+
## Why This Check Exists
|
|
6
|
+
|
|
7
|
+
This is a data dependency, not an upgrade pitch. The skill ranks work by observed route behavior so it can separate hot, expensive paths from code that only looks suspicious. These gates need per-route metrics:
|
|
8
|
+
|
|
9
|
+
| Gate | Required signal |
|
|
10
|
+
|---|---|
|
|
11
|
+
| `slow_route` | Function duration and invocation count by route |
|
|
12
|
+
| `uncached_route` | Cache result and request count by route |
|
|
13
|
+
| `cold_start` | Function start type by route |
|
|
14
|
+
| `route_errors` | Function status by route |
|
|
15
|
+
| `isr_overrevalidation` | ISR reads and writes by route |
|
|
16
|
+
| `middleware_heavy` | Middleware invocations and duration |
|
|
17
|
+
| `cwv_poor` | Core Web Vitals by route |
|
|
18
|
+
| `platform_bot_protection` | Fast Data Transfer by bot category |
|
|
19
|
+
|
|
20
|
+
Scanner-only mode can still catch traffic-independent code issues, but it cannot rank the hottest routes or prove cost impact. Make that tradeoff explicit before continuing.
|
|
21
|
+
|
|
22
|
+
## User Template
|
|
23
|
+
|
|
24
|
+
Render this template first, then wait for the user's choice. Replace only `<detail>`. Do not add a preface; the heading is the opening line.
|
|
25
|
+
|
|
26
|
+
```md
|
|
27
|
+
**Per-route metrics are unavailable.**
|
|
28
|
+
|
|
29
|
+
<detail>
|
|
30
|
+
|
|
31
|
+
This audit needs route-level metrics to rank fixes by observed latency, cache hit rate, error rate, cold-start rate, and Incremental Static Regeneration reads and writes. Without them, I can run a scanner-only audit for traffic-independent code issues, but I cannot tell which routes matter most or prove cost impact.
|
|
32
|
+
|
|
33
|
+
Docs: https://vercel.com/docs/observability/observability-plus
|
|
34
|
+
|
|
35
|
+
Choose one:
|
|
36
|
+
1. Enable Observability Plus, then re-run the metric-backed audit.
|
|
37
|
+
2. Continue in scanner-only mode for a limited audit.
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
If the host supports a structured question tool, use this exact customer-facing copy. Do not rewrite it.
|
|
41
|
+
|
|
42
|
+
```json
|
|
43
|
+
{
|
|
44
|
+
"question": "Enable Observability Plus and re-run, or continue with a limited scanner-only audit?",
|
|
45
|
+
"header": "Observability Plus",
|
|
46
|
+
"options": [
|
|
47
|
+
{
|
|
48
|
+
"label": "Enable and re-run",
|
|
49
|
+
"description": "Use route-level metrics to rank the routes that matter most for cost and performance."
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
"label": "Run scanner-only",
|
|
53
|
+
"description": "Check traffic-independent code patterns without route ranking or proven cost impact."
|
|
54
|
+
}
|
|
55
|
+
]
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Use the full product name in this question. Do not abbreviate product names or metrics in customer-facing blocker copy.
|
|
60
|
+
|
|
61
|
+
## After The User Chooses
|
|
62
|
+
|
|
63
|
+
If the user chooses **Enable and re-run**, stop after this short response:
|
|
64
|
+
|
|
65
|
+
```md
|
|
66
|
+
Enable Observability Plus from the Vercel dashboard's Observability tab, then tell me to rerun. I'll restart the metric-backed audit once route-level metrics are available.
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Do not include raw team IDs, org IDs, project IDs, pricing language, dashboard screenshots, or extra persuasion. The docs link in the blocker message already covers availability and billing details.
|
|
70
|
+
|
|
71
|
+
If the user chooses **Run scanner-only**, continue with the scanner-only steps below.
|
|
72
|
+
|
|
73
|
+
## Blocker Copy
|
|
74
|
+
|
|
75
|
+
| Blocker | Detail |
|
|
76
|
+
|---|---|
|
|
77
|
+
| `payment_required` | `Detected: route-level metrics were recognized for this team, but these metric queries are not usable.` |
|
|
78
|
+
| `no_oplus_probe` | `Detected: this team does not expose the route-level metrics this audit needs.` |
|
|
79
|
+
| `not_linked` | `Detected: this app directory is not linked to a Vercel project.` |
|
|
80
|
+
| `forbidden` | `Detected: the Vercel CLI is authenticated to a team that cannot read this project.` |
|
|
81
|
+
| `project_not_found` | `Detected: the project ID is not visible to the authenticated team.` |
|
|
82
|
+
| `project_disabled` | `Detected: route-level metrics are enabled for the team but disabled for this project.` |
|
|
83
|
+
| `all_failed_other` | `Detected: every per-route metric query failed. Error code: <code>.` |
|
|
84
|
+
|
|
85
|
+
For `not_linked`, do not use the Observability Plus template. Link the app directory first:
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
vercel link --yes --project <project-name-or-id> --cwd <app-dir>
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Add `--team <team-id-or-slug>` when the team is known. If the user supplied both app path and project name, run the link command instead of asking them what to do.
|
|
92
|
+
|
|
93
|
+
For `forbidden` and `project_not_found`, ask the user to confirm the exact Vercel project and team/personal scope before presenting the Observability Plus choice.
|
|
94
|
+
|
|
95
|
+
For `project_disabled`, do not present it as a team subscription problem. Ask the user to enable Observability Plus for this project, then re-run.
|
|
96
|
+
|
|
97
|
+
For `no_traffic`, do not use this template. Tell the user the project has no meaningful traffic in the 14-day window, then ask whether to run scanner-only mode now or come back after traffic accumulates.
|
|
98
|
+
|
|
99
|
+
## Scanner-Only Mode
|
|
100
|
+
|
|
101
|
+
If the user picks scanner-only mode:
|
|
102
|
+
|
|
103
|
+
1. Re-run `node scripts/collect-signals.mjs [projectId] --continue-without-observability > "$RUN_DIR/vercel-signals.json" 2> "$RUN_DIR/collect.stderr"` if the current `signals.json` stopped at the fast blocker (`usageError=NOT_COLLECTED_OBSERVABILITY_BLOCKED` or `project=null`).
|
|
104
|
+
2. Run code scanners.
|
|
105
|
+
3. Launch only traffic-independent findings.
|
|
106
|
+
4. Render a clear data gap: per-route metric gates were skipped because Observability Plus data was unavailable.
|
|
107
|
+
|
|
108
|
+
Do not imply the scanner-only report is a complete optimization audit.
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# Playbooks
|
|
2
|
+
|
|
3
|
+
Application-profile-specific advice that shapes how recommendations are phrased and ordered. Playbooks never invent claims — every rec still traces to a verified candidate or finding. They tell the recommender what to emphasize when a project matches a profile.
|
|
4
|
+
|
|
5
|
+
## How a playbook gets applied
|
|
6
|
+
|
|
7
|
+
1. Step 1 detects the project's stack + dependencies.
|
|
8
|
+
2. The recommender heuristics infer an application profile (best guess from frameworks + dep signals).
|
|
9
|
+
3. The matching playbook(s) are included in the recommender's context.
|
|
10
|
+
4. Recommendations are shaped: ordering tilts toward the profile's priority list; phrasing nods to profile-specific concerns.
|
|
11
|
+
|
|
12
|
+
## Profile detection (best-effort heuristics)
|
|
13
|
+
|
|
14
|
+
| Signals → | Profile |
|
|
15
|
+
|---|---|
|
|
16
|
+
| `@vercel/sandbox`, `@ai-sdk/*`, `ai`, `openai`, `@anthropic-ai/sdk` deps OR AI Gateway / Sandbox SKU active in `usage.services` | `ai-application` |
|
|
17
|
+
| `stripe`, `@shopify/*`, `react-stripe-js`, "cart"/"checkout" routes | `ecommerce` |
|
|
18
|
+
| `next-auth`, `clerk`, dashboard routes, multi-tenant headers | `saas` |
|
|
19
|
+
| Only `pages/api/**` or `app/api/**`, no UI routes | `api-service` |
|
|
20
|
+
| Heavy MDX / markdown, mostly static routes | `content-site` |
|
|
21
|
+
| Lots of `/(marketing)/` route groups, A/B test deps | `marketing` |
|
|
22
|
+
|
|
23
|
+
`ai-application` is checked first — AI-shaped customers often share routes with SaaS/ecommerce surfaces, but the billing shape (AI Gateway dominant) and remediation set (provider failover, sandbox reuse, OIDC keyless) belong to this profile.
|
|
24
|
+
|
|
25
|
+
When detection is uncertain, no playbook is applied. The recommender works fine without one — the playbook is a tilt, not a requirement.
|
|
26
|
+
|
|
27
|
+
## Playbook schema
|
|
28
|
+
|
|
29
|
+
Each playbook is a Markdown file with a fixed shape so the recommender can parse it reliably. Required sections:
|
|
30
|
+
|
|
31
|
+
```markdown
|
|
32
|
+
# {Profile name}
|
|
33
|
+
|
|
34
|
+
## Typical billing shape
|
|
35
|
+
(Which dimensions dominate — e.g., "Edge Requests > Function Duration > Image Optimization")
|
|
36
|
+
|
|
37
|
+
## Priority patterns
|
|
38
|
+
(Ordered list of patterns this profile particularly benefits from)
|
|
39
|
+
|
|
40
|
+
## Frequent gotchas
|
|
41
|
+
(Anti-patterns specific to this profile)
|
|
42
|
+
|
|
43
|
+
## Cross-references
|
|
44
|
+
(Rec IDs from recommendations.md or rule names from vercel-react-best-practices)
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Contributing a new playbook
|
|
48
|
+
|
|
49
|
+
1. Identify a clear application profile and one or two representative project profiles that exemplify it.
|
|
50
|
+
2. Create `references/playbooks/<profile>.md` matching the schema.
|
|
51
|
+
3. Add detection signals to the table above (the heuristics live in the recommender code; document them here).
|
|
52
|
+
4. Update the playbook selection matrix in `references/scoring.md`.
|
|
53
|
+
5. Run `node --test packages/vercel-optimize-tests/test/support-topics.test.mjs packages/vercel-optimize-tests/test/investigation-brief.test.mjs`. No tests directly cover playbooks (they're content), but the schema validator runs in CI.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# AI application
|
|
2
|
+
|
|
3
|
+
LLM-backed apps, agents, code-sandbox tools, RAG pipelines. Cost shape is dominated by per-token AI Gateway spend and Sandbox active-compute time, not edge requests or function duration. Many AI customers also have a SaaS surface (auth, dashboards), but the cost lever lives upstream of the dashboard.
|
|
4
|
+
|
|
5
|
+
## Typical billing shape
|
|
6
|
+
|
|
7
|
+
AI Gateway > Sandbox Active Compute > Function Duration > Function Invocations. Edge Requests usually quiet; ISR rarely applies. Observability Events can climb fast if every tool-call span is captured at full fidelity.
|
|
8
|
+
|
|
9
|
+
## Priority patterns
|
|
10
|
+
|
|
11
|
+
1. **Provider failover.** Configure AI Gateway with an active-active fallback chain across providers (OpenAI + Anthropic, or model-family pairs). Critical-path agents must not be single-provider — a 429 from one provider becomes a user-visible outage otherwise. Field example: MELI runs homegrown active-active routing because retry-on-error against a single provider degraded their NLP-on-support flow.
|
|
12
|
+
2. **OIDC keyless auth, not explicit API keys.** In production, use the AI Gateway OIDC binding so requests are signed by deployment identity. In local dev, `vercel env run -- <cmd>` rotates OIDC each run. An explicit `AI_GATEWAY_API_KEY` in repo env vars is a regression — it bypasses keyless and creates a long-lived secret.
|
|
13
|
+
3. **Sandbox reuse over per-request `Sandbox.create`.** Each fresh sandbox costs at least 1 minute of billed compute (boot + teardown rounded up). When isolation isn't required (single-tenant agents, shared workspaces), pool sandboxes by name (`sandbox.get(name)`) — auto-snapshot on death + auto-resume on next get is the persistence model.
|
|
14
|
+
4. **`after()` / `waitUntil()` for tool logging.** Tool-call telemetry, audit writes, and analytics should never block the user response. Use `after()` (Next 15+) or `waitUntil()` from `@vercel/functions` for any write that doesn't affect the streamed response.
|
|
15
|
+
5. **Fluid Compute for JIT/process warmth.** Streaming LLM responses benefit from warm processes; the GraphQL/Apollo JIT cache + persisted-document plans only pay back when processes survive across requests. Fluid is the default; disabling it on AI workloads is almost always wrong.
|
|
16
|
+
|
|
17
|
+
## Frequent gotchas
|
|
18
|
+
|
|
19
|
+
- **Single-provider lock-in.** "We're using AI Gateway" doesn't imply failover — the provider list still has to be configured. A single-provider gateway is a thinner wrapper, not multi-provider resilience.
|
|
20
|
+
- **Sandbox-per-request.** `new Sandbox(...)` inside a per-request handler with no `id` argument creates a fresh microVM each time. Cheaper to pool when isolation allows.
|
|
21
|
+
- **BYOK fallback cost invisible.** AI Gateway with BYOK silently falls back to system credits on 429 / provider outage; cost migrates from "free BYOK" to "billed credits" without a separate signal unless tracked.
|
|
22
|
+
- **Observability Events runaway.** Captured every tool call + every streamed delta at 100% sampling — events SKU climbs above 30% of bill. Cap span cardinality before scaling traffic.
|
|
23
|
+
|
|
24
|
+
## Cross-references
|
|
25
|
+
|
|
26
|
+
- [external-api-critical-path](../support-topics/external-api-critical-path.md) — sequential vs parallel calls; AI Gateway is one external API among others
|
|
27
|
+
- [fluid-compute-caveats](../support-topics/fluid-compute-caveats.md) — module-state hazards and shared-instance caveats
|
|
28
|
+
- [function-duration-io-and-after](../support-topics/function-duration-io-and-after.md) — `after()` for post-response tool logging
|
|
29
|
+
- [observability-events-cost-attribution](../support-topics/observability-events-cost-attribution.md) — when Observability Events climb above 20% of bill
|
|
30
|
+
- [use-cache-remote-shared-origin-data](../support-topics/use-cache-remote-shared-origin-data.md) — caching shared LLM context or embedding lookups
|
|
31
|
+
- `https://vercel.com/docs/ai-gateway` — provider configuration, failover chain
|
|
32
|
+
- `https://vercel.com/docs/vercel-sandbox` — `sandbox.get(name)` and active-compute billing
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# API service
|
|
2
|
+
|
|
3
|
+
Headless API backend. No UI routes. Often consumed by mobile apps, partner integrations, or other Vercel projects via rewrites.
|
|
4
|
+
|
|
5
|
+
## Typical billing shape
|
|
6
|
+
|
|
7
|
+
Function Duration dominates (every request is a function invocation). Edge Requests scale with API traffic. External API costs matter when the service is a thin shim over third-party APIs (Stripe, Twilio, etc.).
|
|
8
|
+
|
|
9
|
+
## Priority patterns
|
|
10
|
+
|
|
11
|
+
1. **Cache GET responses at the edge.** Idempotent GET endpoints (catalog reads, status checks, public data) should ship with `Cache-Control: public, s-maxage=<seconds>, stale-while-revalidate=<longer>`. The CDN serves repeat callers without invoking the function.
|
|
12
|
+
2. **Rate-limit at the edge, not the function.** Middleware with proper matcher scoping handles abusive clients before they hit your function-duration bill.
|
|
13
|
+
3. **Parallel external API calls.** A "checkout-like" endpoint that calls Stripe + inventory + email-service sequentially is the most common slow_route in this profile. `Promise.all` is the obvious fix.
|
|
14
|
+
4. **Background work post-response.** `after()` (Next 15+) for analytics, webhooks-to-self, and any write that doesn't affect the response.
|
|
15
|
+
5. **Connection pooling.** Direct PG connections from serverless function instances exhaust the database. Use PgBouncer / Prisma Accelerate / Neon's pooler.
|
|
16
|
+
|
|
17
|
+
## Frequent gotchas
|
|
18
|
+
|
|
19
|
+
- **No `Cache-Control` on the public GETs.** This is the most common finding in this profile, and the easiest fix.
|
|
20
|
+
- **Auth check serialized with data load.** `await checkAuth()` then `await loadData()` — these are often independent and can run in parallel if your auth path doesn't depend on the data.
|
|
21
|
+
- **External API fan-out for one user.** A "build me a profile" endpoint that calls 5 third parties sequentially. Even small latency improvements multiplied by every user are huge.
|
|
22
|
+
- **Long-running async operations on the request path.** Image generation, PDF rendering, big report computation. Move these to background queues or `after()`.
|
|
23
|
+
|
|
24
|
+
## Cross-references
|
|
25
|
+
|
|
26
|
+
- `https://vercel.com/docs/caching/cdn-cache` — the GET-handler Cache-Control fix
|
|
27
|
+
- `vercel-react-best-practices:async-parallel` — parallelize external API calls
|
|
28
|
+
- `vercel-react-best-practices:server-after-nonblocking` — `after()` for post-response work
|
|
29
|
+
- `https://vercel.com/docs/fluid-compute` — when cold starts on infrequently-called endpoints hurt
|
|
30
|
+
- `https://nextjs.org/docs/app/building-your-application/routing/middleware` — for rate-limit middleware
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Content site
|
|
2
|
+
|
|
3
|
+
Documentation, blogs, knowledge bases, marketing-adjacent content with mostly static pages. Authoring may be headless-CMS-driven or markdown-in-repo.
|
|
4
|
+
|
|
5
|
+
## Typical billing shape
|
|
6
|
+
|
|
7
|
+
Edge Requests dominate (every page view is an edge request; static assets even more). Image Optimization is often the #2 line item. Function Duration tends to be low — most pages should be static or ISR.
|
|
8
|
+
|
|
9
|
+
## Priority patterns
|
|
10
|
+
|
|
11
|
+
1. **Pre-render everything that can be pre-rendered.** Blog index, individual posts, docs pages, category pages. Use `generateStaticParams` for App Router or `getStaticPaths` for Pages Router. Anything CMS-driven should run on a webhook revalidation, not on every request.
|
|
12
|
+
2. **ISR with a sensible cadence.** Pages that need fresh-ish content but don't need real-time accuracy go ISR. `revalidate: 3600` (hourly) is a good starting point for docs; `60s` for blog index pages.
|
|
13
|
+
3. **`next/image` for every image asset.** Hero images, author photos, post inline images, OG images. Even thumbnail-only sites benefit from format negotiation (WebP/AVIF).
|
|
14
|
+
4. **`next/font` for self-hosted fonts.** Eliminates FOIT/FOUT, eliminates the third-party request, prevents CLS.
|
|
15
|
+
5. **Prefetch on hover.** `next/link` does this by default. For other frameworks, consider intersection-observer-based prefetch on the visible link set.
|
|
16
|
+
|
|
17
|
+
## Frequent gotchas
|
|
18
|
+
|
|
19
|
+
- **`force-dynamic` on the blog index.** Almost never necessary. The index can ISR or be fully static.
|
|
20
|
+
- **Markdown rendering on every request.** If you're parsing MDX at request time, you're paying function-duration cost on what should be a static asset. Build-time MDX → static HTML.
|
|
21
|
+
- **Search rebuilt on every request.** Site search backed by a function that queries a CMS on every keystroke. Move to a search index (Algolia, Pagefind, build-time generated) and serve from the CDN.
|
|
22
|
+
- **CMS preview routes leaking into production traffic.** A `/preview/[slug]` route that's effectively another rendering path; sometimes called from production by mistake. Audit referrers.
|
|
23
|
+
|
|
24
|
+
## Cross-references
|
|
25
|
+
|
|
26
|
+
- `https://nextjs.org/docs/app/api-reference/functions/generate-static-params` — for pre-rendering
|
|
27
|
+
- `https://vercel.com/docs/incremental-static-regeneration` — for the ISR fix
|
|
28
|
+
- `https://nextjs.org/docs/app/api-reference/components/image` — image optimization
|
|
29
|
+
- `https://nextjs.org/docs/app/api-reference/components/font` — self-hosted fonts
|
|
30
|
+
- `vercel-react-best-practices:bundle-defer-third-party` — defer analytics/cookie banners
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# E-commerce
|
|
2
|
+
|
|
3
|
+
Storefronts with cart, checkout, product catalogs. Often Stripe-integrated. Traffic skews toward catalog browsing (cacheable) and checkout (uncacheable).
|
|
4
|
+
|
|
5
|
+
## Typical billing shape
|
|
6
|
+
|
|
7
|
+
Edge Requests dominate (catalog browsing, image asset traffic) → Image Optimization (product images) → Function Duration (cart/checkout APIs). ISR Reads matter when product pages use ISR.
|
|
8
|
+
|
|
9
|
+
## Priority patterns
|
|
10
|
+
|
|
11
|
+
1. **Catalog pages: aggressive ISR + image optimization.** Product list and product detail pages should be ISR with a sensible `revalidate` (60s-3600s). Every image should go through `next/image` (or the framework equivalent). For Vercel-hosted storefronts, image cost can dominate everything else.
|
|
12
|
+
2. **Checkout: keep dynamic, but parallelize external calls.** Cart/checkout/payment routes are correctly dynamic. The win is in reducing their function duration — `Promise.all` for independent calls to Stripe + inventory + tax services. Cite `vercel-react-best-practices:async-parallel`.
|
|
13
|
+
3. **Cart drawer hydration: lift `'use client'` to the leaf.** Cart components are interactive, but the page wrapping them shouldn't be. Hoist server-rendered parts upward; only the buttons/forms are client.
|
|
14
|
+
4. **Webhooks: separate, not on the user path.** Stripe/Shopify webhook handlers should live as their own routes with short duration limits. They don't share traffic patterns with the storefront.
|
|
15
|
+
5. **Edge middleware for A/B + region routing only.** Catalog locale routing is a fine fit. Auth/cart state belongs in the dynamic page, not middleware.
|
|
16
|
+
|
|
17
|
+
## Frequent gotchas
|
|
18
|
+
|
|
19
|
+
- **Product images served raw.** `<img src={product.imageUrl}>` for hundreds of variants costs more than the rest of the bill combined. Always next/image.
|
|
20
|
+
- **`force-dynamic` on the storefront homepage.** Often added during development to test cart-state behavior, never removed. Audit ruthlessly.
|
|
21
|
+
- **Sequential Stripe calls.** "Create customer" → "create subscription" → "create invoice" is often three sequential awaits where two could run in parallel.
|
|
22
|
+
- **Bot traffic on product search.** Marketing-driven traffic + bot traffic on search routes inflates edge request cost. Bot Protection often pays for itself within a month.
|
|
23
|
+
|
|
24
|
+
## Cross-references
|
|
25
|
+
|
|
26
|
+
- `vercel-react-best-practices:async-parallel` — parallelize Stripe/inventory/tax calls in checkout
|
|
27
|
+
- `vercel-react-best-practices:async-suspense-boundaries` — stream the checkout shell, fill cart drawer later
|
|
28
|
+
- `vercel-react-best-practices:bundle-defer-third-party` — defer analytics (GA, Mixpanel) post-hydration
|
|
29
|
+
- `https://nextjs.org/docs/app/api-reference/components/image` — for the catalog image fix
|
|
30
|
+
- `https://vercel.com/docs/bot-management` — for bot traffic on search/product routes
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Marketing site
|
|
2
|
+
|
|
3
|
+
Landing pages, lead-capture forms, A/B-tested variants, region-routed homepages. Traffic is bursty (campaigns drive spikes). Bot traffic can be substantial.
|
|
4
|
+
|
|
5
|
+
## Typical billing shape
|
|
6
|
+
|
|
7
|
+
Edge Requests dominate. Image Optimization is high (hero images, illustrations, product screenshots). Bandwidth matters for video content. Function Duration is usually low — most pages are static or ISR.
|
|
8
|
+
|
|
9
|
+
## Priority patterns
|
|
10
|
+
|
|
11
|
+
1. **Aggressive caching at the edge.** Marketing pages rarely change between campaign updates. `Cache-Control: public, s-maxage=86400, stale-while-revalidate=604800` keeps the CDN warm for 24h and stale-serves for a week.
|
|
12
|
+
2. **Bot Protection.** Marketing campaigns attract competitor scrapers and bot traffic that inflates edge requests without delivering value. If edge cost is > $100/month and Bot Protection is disabled, this is almost always the top platform rec.
|
|
13
|
+
3. **ISR for content-driven sections.** Customer logos, testimonials, "latest blog post" widgets, pricing tables — anything coming from a CMS. Revalidate hourly or on webhook.
|
|
14
|
+
4. **A/B test logic at the edge, not in the page.** Edge Middleware for the variant assignment; cached static page per variant. Don't render the variant choice on every request.
|
|
15
|
+
5. **Defer all third-party JS post-hydration.** Analytics, chat widgets, marketing pixels, cookie banners. None of them block the LCP. Cite `vercel-react-best-practices:bundle-defer-third-party`.
|
|
16
|
+
|
|
17
|
+
## Frequent gotchas
|
|
18
|
+
|
|
19
|
+
- **Hero images served at native resolution.** A 4MP hero image on every viewport, including mobile. `next/image` with `sizes` is mandatory.
|
|
20
|
+
- **Cookie banner blocks first paint.** GDPR-compliant cookie banners often render synchronously in the head. Defer; render after hydration; persist consent state via a tiny inline script.
|
|
21
|
+
- **Tracking pixel waterfalls.** Three different analytics services loaded in a chain. Load them after hydration in parallel; better yet, replace some with server-side tracking via webhook.
|
|
22
|
+
- **`/api/contact` is the only function but runs hot.** Marketing sites are mostly static but the contact form gets bot-spammed. Rate limit at middleware; consider a queue for outgoing emails.
|
|
23
|
+
|
|
24
|
+
## Cross-references
|
|
25
|
+
|
|
26
|
+
- `https://vercel.com/docs/bot-management` — almost always the right platform rec
|
|
27
|
+
- `https://vercel.com/docs/incremental-static-regeneration` — for CMS-driven sections
|
|
28
|
+
- `https://nextjs.org/docs/app/api-reference/components/image` — hero/illustration optimization
|
|
29
|
+
- `vercel-react-best-practices:bundle-defer-third-party` — defer analytics/pixels
|
|
30
|
+
- `https://nextjs.org/docs/app/building-your-application/routing/middleware` — A/B variant routing at the edge
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# SaaS
|
|
2
|
+
|
|
3
|
+
Multi-tenant applications with authenticated dashboards, settings, billing. Auth-gated by default. Traffic skews toward function duration (per-user data fetches) over edge requests.
|
|
4
|
+
|
|
5
|
+
## Typical billing shape
|
|
6
|
+
|
|
7
|
+
Function Duration dominates (every dashboard request runs the function fully — no edge caching for auth-gated content). Edge Requests grow with API surface. ISR rarely applies. Image Optimization rarely material.
|
|
8
|
+
|
|
9
|
+
## Priority patterns
|
|
10
|
+
|
|
11
|
+
1. **Per-request memoization with React.cache().** Server Components called from multiple places in the same request tree often re-query the database. `React.cache()` dedupes within the request. Cite `vercel-react-best-practices:server-cache-react`.
|
|
12
|
+
2. **Parallel data loads in Server Components.** Dashboards typically load user + org + billing + recent-activity. Run all four in parallel via `Promise.all`. Cite `vercel-react-best-practices:async-parallel` and `:server-parallel-fetching`.
|
|
13
|
+
3. **Fluid Compute.** Auth-gated routes have higher cold-start sensitivity (every cold start is a user waiting). If cold-start signal shows up in observability, Fluid Compute is usually the right account-level rec.
|
|
14
|
+
4. **Async work after response.** Activity logs, audit trails, analytics events — anything that doesn't block the user — should run via `after()` (Next 15+) or `waitUntil()` from `@vercel/functions`. Cite `vercel-react-best-practices:server-after-nonblocking`.
|
|
15
|
+
5. **Suspense boundaries around expensive widgets.** The dashboard shell renders fast; widgets stream in. This shifts perceived latency without changing the underlying queries.
|
|
16
|
+
|
|
17
|
+
## Frequent gotchas
|
|
18
|
+
|
|
19
|
+
- **N+1 ORM queries.** A list page that loops over results and fetches related records per-item. Especially common with Prisma's `.findUnique` inside a `.map`. Use `include` or batch via DataLoader.
|
|
20
|
+
- **Sequential session+permission checks.** `await getSession()` then `await checkPermissions()` then `await loadData()` — these can often be parallelized when the permissions check doesn't depend on the data load.
|
|
21
|
+
- **No connection pooling on serverless.** Prisma without a pooler exhausts the database under load. Connection pooling is mandatory.
|
|
22
|
+
- **Polling for state from the client.** Every poll is a function invocation. Replace with SWR + on-demand revalidation, or with `revalidateTag` triggered by the mutation that actually changes state.
|
|
23
|
+
|
|
24
|
+
## Cross-references
|
|
25
|
+
|
|
26
|
+
- `vercel-react-best-practices:server-cache-react` — per-request dedup
|
|
27
|
+
- `vercel-react-best-practices:server-parallel-fetching` — restructure for Promise.all
|
|
28
|
+
- `vercel-react-best-practices:async-suspense-boundaries` — stream the dashboard shell
|
|
29
|
+
- `vercel-react-best-practices:server-after-nonblocking` — defer audit/analytics writes (Next 15+)
|
|
30
|
+
- `vercel-react-best-practices:client-swr-dedup` — replace polling with SWR
|
|
31
|
+
- `https://vercel.com/docs/fluid-compute` — when cold starts hurt
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# SvelteKit
|
|
2
|
+
|
|
3
|
+
Framework-specific playbook for SvelteKit projects on Vercel. Applies in
|
|
4
|
+
addition to whichever application-profile playbook fits (saas, ecommerce,
|
|
5
|
+
content-site, etc.). SvelteKit-on-Vercel ships through
|
|
6
|
+
`@sveltejs/adapter-vercel`, so most platform-level recs map to adapter
|
|
7
|
+
config rather than per-route framework APIs.
|
|
8
|
+
|
|
9
|
+
## Typical billing shape
|
|
10
|
+
|
|
11
|
+
Function Duration dominates server-rendered routes (every `+page.server.ts`
|
|
12
|
+
`load` + `+server.ts` POST handler runs as a function). Edge Requests grow
|
|
13
|
+
with API surface (`+server.ts` and form actions). ISR is supported via the
|
|
14
|
+
adapter; when enabled, it converts to a cache_result HIT after first render.
|
|
15
|
+
Image Optimization is rarely a SvelteKit-specific lever (it's the same
|
|
16
|
+
Vercel image service Next.js uses).
|
|
17
|
+
|
|
18
|
+
## Priority patterns
|
|
19
|
+
|
|
20
|
+
1. **Adapter ISR for cacheable content.** Routes that don't depend on
|
|
21
|
+
per-request data are still served as functions by default. The
|
|
22
|
+
adapter accepts an `isr: { expiration: 60 }` option per route (set
|
|
23
|
+
in `+page.server.ts` via `export const config`). This converts
|
|
24
|
+
function invocations to cache hits. Cite
|
|
25
|
+
`https://kit.svelte.dev/docs/adapter-vercel` +
|
|
26
|
+
`https://vercel.com/docs/incremental-static-regeneration`.
|
|
27
|
+
2. **Prerender what's static.** `export const prerender = true` in
|
|
28
|
+
`+page.server.ts` or `+page.ts` moves a route from function to CDN.
|
|
29
|
+
Cite `https://kit.svelte.dev/docs/page-options`.
|
|
30
|
+
3. **Parallel `load` fetches.** A `load` function with multiple
|
|
31
|
+
sequential `await fetch(...)` calls leaves wall-clock time on the
|
|
32
|
+
table — wrap them in `Promise.all` (or return promises directly
|
|
33
|
+
from `load`, which SvelteKit streams). Cite
|
|
34
|
+
`https://kit.svelte.dev/docs/load`.
|
|
35
|
+
4. **Move per-request work to `+server.ts` action handlers and run
|
|
36
|
+
them via `fetch` from the client.** Reduces SSR cost when only a
|
|
37
|
+
slice of the page actually needs server data on every request.
|
|
38
|
+
5. **`hooks.server.ts` matcher hygiene.** Like Next.js middleware, the
|
|
39
|
+
`handle` hook intercepts every request unless filtered. Heavy
|
|
40
|
+
`handle` code multiplies cost by request volume. Move work into the
|
|
41
|
+
specific route's `load` when only that route needs it.
|
|
42
|
+
6. **Adapter runtime + region config.** Single-region default; if the
|
|
43
|
+
project's users skew to a different region, set `regions: [...]` on
|
|
44
|
+
the adapter to reduce TTFB by 100-300ms.
|
|
45
|
+
|
|
46
|
+
## Frequent gotchas
|
|
47
|
+
|
|
48
|
+
- **Per-route SSR when prerender would do.** Marketing pages, docs,
|
|
49
|
+
blog posts often end up as functions because nobody added
|
|
50
|
+
`prerender = true`. The scanner flags these.
|
|
51
|
+
- **`+layout.server.ts` data fetches blocking every child route.**
|
|
52
|
+
Auth-check + user-load in a layout makes EVERY function invocation
|
|
53
|
+
wait on those queries — even routes that don't read user. Push
|
|
54
|
+
user-load into the routes that need it.
|
|
55
|
+
- **Adapter version drift.** `adapter-vercel@5` adds new options (ISR,
|
|
56
|
+
split). `adapter-vercel@3` doesn't. The recommender must check the
|
|
57
|
+
installed version before suggesting `isr: ...`.
|
|
58
|
+
- **`fetch` calls in `load` to your own SvelteKit routes.** SvelteKit
|
|
59
|
+
optimizes these into direct module calls during SSR, but only if
|
|
60
|
+
the URL is relative. A hardcoded `https://your-domain.tld/api/...`
|
|
61
|
+
defeats this optimization.
|
|
62
|
+
- **No connection pooling on serverless.** Same as Next.js — Postgres
|
|
63
|
+
without a pooler exhausts the database under load.
|
|
64
|
+
|
|
65
|
+
## Cross-references
|
|
66
|
+
|
|
67
|
+
- `https://kit.svelte.dev/docs/adapter-vercel` — adapter config (ISR, regions, runtime)
|
|
68
|
+
- `https://kit.svelte.dev/docs/page-options` — prerender, ssr, csr
|
|
69
|
+
- `https://kit.svelte.dev/docs/load` — parallel fetches in load
|
|
70
|
+
- `https://kit.svelte.dev/docs/routing` — file conventions
|
|
71
|
+
- `https://kit.svelte.dev/docs/hooks` — handle / handleFetch
|
|
72
|
+
- `https://kit.svelte.dev/docs/form-actions` — server-side form handling
|
|
73
|
+
- `https://kit.svelte.dev/docs/state-management` — request-scoped state
|
|
74
|
+
- `https://vercel.com/docs/incremental-static-regeneration` — ISR on Vercel
|
|
75
|
+
- `https://vercel.com/docs/fluid-compute` — Fluid Compute (framework-agnostic)
|