mirror of
https://github.com/lobehub/lobe-chat.git
synced 2026-06-14 11:40:07 +00:00
Compare commits
2 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 805783d65b | |||
| 9fdebe3eac |
@@ -43,13 +43,11 @@ Reference: `docs/usage/providers/fal.mdx`
|
||||
|
||||
```markdown
|
||||
### `{PROVIDER}_API_KEY`
|
||||
|
||||
- Type: Required
|
||||
- Description: API key from {Provider Name}
|
||||
- Example: `{api-key-format}`
|
||||
|
||||
### `{PROVIDER}_MODEL_LIST`
|
||||
|
||||
- Type: Optional
|
||||
- Description: Control model list. Use `+` to add, `-` to hide
|
||||
- Example: `-all,+model-1,+model-2=Display Name`
|
||||
@@ -79,7 +77,7 @@ Update all Dockerfiles at the **end** of ENV section:
|
||||
|
||||
- Cover image
|
||||
- 3-4 API dashboard screenshots
|
||||
- 2-3 LobeHub configuration screenshots
|
||||
- 2-3 LobeChat configuration screenshots
|
||||
- Host on LobeHub CDN: `hub-apac-1.lobeobjects.space`
|
||||
|
||||
## Checklist
|
||||
|
||||
@@ -1,220 +0,0 @@
|
||||
---
|
||||
name: agent-tracing
|
||||
description: "Agent tracing CLI for inspecting agent execution snapshots. Use when user mentions 'agent-tracing', 'trace', 'snapshot', wants to debug agent execution, inspect LLM calls, view context engine data, or analyze agent steps. Triggers on agent debugging, trace inspection, or execution analysis tasks."
|
||||
user-invocable: false
|
||||
---
|
||||
|
||||
# Agent Tracing CLI Guide
|
||||
|
||||
`@lobechat/agent-tracing` is a zero-config local dev tool that records agent execution snapshots to disk and provides a CLI to inspect them.
|
||||
|
||||
## How It Works
|
||||
|
||||
In `NODE_ENV=development`, `AgentRuntimeService.executeStep()` automatically records each step to `.agent-tracing/` as partial snapshots. When the operation completes, the partial is finalized into a complete `ExecutionSnapshot` JSON file.
|
||||
|
||||
**Data flow**: executeStep loop -> build `StepPresentationData` -> write partial snapshot to disk -> on completion, finalize to `.agent-tracing/{timestamp}_{traceId}.json`
|
||||
|
||||
**Context engine capture**: In `RuntimeExecutors.ts`, the `call_llm` executor emits a `context_engine_result` event after `serverMessagesEngine()` processes messages. This event carries the full `contextEngineInput` (DB messages, systemRole, model, knowledge, tools, userMemory, etc.) and the processed `output` messages (the final LLM payload).
|
||||
|
||||
## Package Location
|
||||
|
||||
```
|
||||
packages/agent-tracing/
|
||||
src/
|
||||
types.ts # ExecutionSnapshot, StepSnapshot, SnapshotSummary
|
||||
store/
|
||||
types.ts # ISnapshotStore interface
|
||||
file-store.ts # FileSnapshotStore (.agent-tracing/*.json)
|
||||
recorder/
|
||||
index.ts # appendStepToPartial(), finalizeSnapshot()
|
||||
viewer/
|
||||
index.ts # Terminal rendering: renderSnapshot, renderStepDetail, renderMessageDetail, renderSummaryTable, renderPayload, renderPayloadTools, renderMemory
|
||||
cli/
|
||||
index.ts # CLI entry point (#!/usr/bin/env bun)
|
||||
inspect.ts # Inspect command (default)
|
||||
partial.ts # Partial snapshot commands (list, inspect, clean)
|
||||
index.ts # Barrel exports
|
||||
```
|
||||
|
||||
## Data Storage
|
||||
|
||||
- Completed snapshots: `.agent-tracing/{ISO-timestamp}_{traceId-short}.json`
|
||||
- Latest symlink: `.agent-tracing/latest.json`
|
||||
- In-progress partials: `.agent-tracing/_partial/{operationId}.json`
|
||||
- `FileSnapshotStore` resolves from `process.cwd()` — **run CLI from the repo root**
|
||||
|
||||
## CLI Commands
|
||||
|
||||
All commands run from the **repo root**:
|
||||
|
||||
```bash
|
||||
# View latest trace (tree overview, `inspect` is the default command)
|
||||
agent-tracing
|
||||
agent-tracing inspect
|
||||
agent-tracing inspect <traceId>
|
||||
agent-tracing inspect latest
|
||||
|
||||
# List recent snapshots
|
||||
agent-tracing list
|
||||
agent-tracing list -l 20
|
||||
|
||||
# Inspect specific step (-s is short for --step)
|
||||
agent-tracing inspect <traceId> -s 0
|
||||
|
||||
# View messages (-m is short for --messages)
|
||||
agent-tracing inspect <traceId> -s 0 -m
|
||||
|
||||
# View full content of a specific message (by index shown in -m output)
|
||||
agent-tracing inspect <traceId> -s 0 --msg 2
|
||||
agent-tracing inspect <traceId> -s 0 --msg-input 1
|
||||
|
||||
# View tool call/result details (-t is short for --tools)
|
||||
agent-tracing inspect <traceId> -s 1 -t
|
||||
|
||||
# View raw events (-e is short for --events)
|
||||
agent-tracing inspect <traceId> -s 0 -e
|
||||
|
||||
# View runtime context (-c is short for --context)
|
||||
agent-tracing inspect <traceId> -s 0 -c
|
||||
|
||||
# View context engine input overview (-p is short for --payload)
|
||||
agent-tracing inspect <traceId> -p
|
||||
agent-tracing inspect <traceId> -s 0 -p
|
||||
|
||||
# View available tools in payload (-T is short for --payload-tools)
|
||||
agent-tracing inspect <traceId> -T
|
||||
agent-tracing inspect <traceId> -s 0 -T
|
||||
|
||||
# View user memory (-M is short for --memory)
|
||||
agent-tracing inspect <traceId> -M
|
||||
agent-tracing inspect <traceId> -s 0 -M
|
||||
|
||||
# Raw JSON output (-j is short for --json)
|
||||
agent-tracing inspect <traceId> -j
|
||||
agent-tracing inspect <traceId> -s 0 -j
|
||||
|
||||
# List in-progress partial snapshots
|
||||
agent-tracing partial list
|
||||
|
||||
# Inspect a partial (use `inspect` directly — all flags work with partial IDs)
|
||||
agent-tracing inspect <partialOperationId>
|
||||
agent-tracing inspect <partialOperationId> -T
|
||||
agent-tracing inspect <partialOperationId> -p
|
||||
|
||||
# Clean up stale partial snapshots
|
||||
agent-tracing partial clean
|
||||
```
|
||||
|
||||
## Inspect Flag Reference
|
||||
|
||||
| Flag | Short | Description | Default Step |
|
||||
| ----------------- | ----- | ------------------------------------------------------------------------------------------------- | ------------ |
|
||||
| `--step <n>` | `-s` | Target a specific step | — |
|
||||
| `--messages` | `-m` | Messages context (CE input → params → LLM payload) | — |
|
||||
| `--tools` | `-t` | Tool calls & results (what agent invoked) | — |
|
||||
| `--events` | `-e` | Raw events (llm_start, llm_result, etc.) | — |
|
||||
| `--context` | `-c` | Runtime context & payload (raw) | — |
|
||||
| `--system-role` | `-r` | Full system role content | 0 |
|
||||
| `--env` | | Environment context | 0 |
|
||||
| `--payload` | `-p` | Context engine input overview (model, knowledge, tools summary, memory summary, platform context) | 0 |
|
||||
| `--payload-tools` | `-T` | Available tools detail (plugin manifests + LLM function definitions) | 0 |
|
||||
| `--memory` | `-M` | Full user memory (persona, identity, contexts, preferences, experiences) | 0 |
|
||||
| `--diff <n>` | `-d` | Diff against step N (use with `-r` or `--env`) | — |
|
||||
| `--msg <n>` | | Full content of message N from Final LLM Payload | — |
|
||||
| `--msg-input <n>` | | Full content of message N from Context Engine Input | — |
|
||||
| `--json` | `-j` | Output as JSON (combinable with any flag above) | — |
|
||||
|
||||
Flags marked "Default Step: 0" auto-select step 0 if `--step` is not provided. All flags support `latest` or omitted traceId.
|
||||
|
||||
## Typical Debug Workflow
|
||||
|
||||
```bash
|
||||
# 1. Trigger an agent operation in the dev UI
|
||||
|
||||
# 2. See the overview
|
||||
agent-tracing inspect
|
||||
|
||||
# 3. List all traces, get traceId
|
||||
agent-tracing list
|
||||
|
||||
# 4. Quick overview of what was fed into context engine
|
||||
agent-tracing inspect -p
|
||||
|
||||
# 5. Inspect a specific step's messages to see what was sent to the LLM
|
||||
agent-tracing inspect TRACE_ID -s 0 -m
|
||||
|
||||
# 6. Drill into a truncated message for full content
|
||||
agent-tracing inspect TRACE_ID -s 0 --msg 2
|
||||
|
||||
# 7. Check available tools vs actual tool calls
|
||||
agent-tracing inspect -T # available tools
|
||||
agent-tracing inspect -s 1 -t # actual tool calls & results
|
||||
|
||||
# 8. Inspect user memory injected into the conversation
|
||||
agent-tracing inspect -M
|
||||
|
||||
# 9. Diff system role between steps (multi-step agents)
|
||||
agent-tracing inspect TRACE_ID -r -d 2
|
||||
```
|
||||
|
||||
## Key Types
|
||||
|
||||
```typescript
|
||||
interface ExecutionSnapshot {
|
||||
traceId: string;
|
||||
operationId: string;
|
||||
model?: string;
|
||||
provider?: string;
|
||||
startedAt: number;
|
||||
completedAt?: number;
|
||||
completionReason?:
|
||||
| 'done'
|
||||
| 'error'
|
||||
| 'interrupted'
|
||||
| 'max_steps'
|
||||
| 'cost_limit'
|
||||
| 'waiting_for_human';
|
||||
totalSteps: number;
|
||||
totalTokens: number;
|
||||
totalCost: number;
|
||||
error?: { type: string; message: string };
|
||||
steps: StepSnapshot[];
|
||||
}
|
||||
|
||||
interface StepSnapshot {
|
||||
stepIndex: number;
|
||||
stepType: 'call_llm' | 'call_tool';
|
||||
executionTimeMs: number;
|
||||
content?: string; // LLM output
|
||||
reasoning?: string; // Reasoning/thinking
|
||||
inputTokens?: number;
|
||||
outputTokens?: number;
|
||||
toolsCalling?: Array<{ apiName: string; identifier: string; arguments?: string }>;
|
||||
toolsResult?: Array<{
|
||||
apiName: string;
|
||||
identifier: string;
|
||||
isSuccess?: boolean;
|
||||
output?: string;
|
||||
}>;
|
||||
messages?: any[]; // DB messages before step
|
||||
context?: { phase: string; payload?: unknown; stepContext?: unknown };
|
||||
events?: Array<{ type: string; [key: string]: unknown }>;
|
||||
// context_engine_result event contains:
|
||||
// input: full contextEngineInput (messages, systemRole, model, knowledge, tools, userMemory, ...)
|
||||
// output: processed messages array (final LLM payload)
|
||||
}
|
||||
```
|
||||
|
||||
## --messages Output Structure
|
||||
|
||||
When using `--messages`, the output shows three sections (if context engine data is available):
|
||||
|
||||
1. **Context Engine Input** — DB messages passed to the engine, with `[0]`, `[1]`, ... indices. Use `--msg-input N` to view full content.
|
||||
2. **Context Engine Params** — systemRole, model, provider, knowledge, tools, userMemory, etc.
|
||||
3. **Final LLM Payload** — Processed messages after context engine (system date injection, user memory, history truncation, etc.), with `[0]`, `[1]`, ... indices. Use `--msg N` to view full content.
|
||||
|
||||
## Integration Points
|
||||
|
||||
- **Recording**: `src/server/services/agentRuntime/AgentRuntimeService.ts` — in the `executeStep()` method, after building `stepPresentationData`, writes partial snapshot in dev mode
|
||||
- **Context engine event**: `src/server/modules/AgentRuntime/RuntimeExecutors.ts` — in `call_llm` executor, after `serverMessagesEngine()` returns, emits `context_engine_result` event
|
||||
- **Store**: `FileSnapshotStore` reads/writes to `.agent-tracing/` relative to `process.cwd()`
|
||||
@@ -1,153 +0,0 @@
|
||||
---
|
||||
name: chat-sdk
|
||||
description: >
|
||||
Build multi-platform chat bots with Chat SDK (`chat` npm package). Use when developers want to
|
||||
(1) Build a Slack, Teams, Google Chat, Discord, GitHub, or Linear bot,
|
||||
(2) Use the Chat SDK to handle mentions, messages, reactions, slash commands, cards, modals, or streaming,
|
||||
(3) Set up webhook handlers for chat platforms,
|
||||
(4) Send interactive cards or stream AI responses to chat platforms.
|
||||
Triggers on "chat sdk", "chat bot", "slack bot", "teams bot", "discord bot", "@chat-adapter",
|
||||
building bots that work across multiple chat platforms.
|
||||
---
|
||||
|
||||
# Chat SDK
|
||||
|
||||
Unified TypeScript SDK for building chat bots across Slack, Teams, Google Chat, Discord, GitHub, and Linear. Write bot logic once, deploy everywhere.
|
||||
|
||||
## Critical: Read the bundled docs
|
||||
|
||||
The `chat` package ships with full documentation in `node_modules/chat/docs/` and TypeScript source types. **Always read these before writing code:**
|
||||
|
||||
```
|
||||
node_modules/chat/docs/ # Full documentation (MDX files)
|
||||
node_modules/chat/dist/ # Built types (.d.ts files)
|
||||
```
|
||||
|
||||
Key docs to read based on task:
|
||||
|
||||
- `docs/getting-started.mdx` — setup guides
|
||||
- `docs/usage.mdx` — event handlers, threads, messages, channels
|
||||
- `docs/streaming.mdx` — AI streaming with AI SDK
|
||||
- `docs/cards.mdx` — JSX interactive cards
|
||||
- `docs/actions.mdx` — button/dropdown handlers
|
||||
- `docs/modals.mdx` — form dialogs (Slack only)
|
||||
- `docs/adapters/*.mdx` — platform-specific adapter setup
|
||||
- `docs/state/*.mdx` — state adapter config (Redis, ioredis, memory)
|
||||
|
||||
Also read the TypeScript types from `node_modules/chat/dist/` to understand the full API surface.
|
||||
|
||||
## Quick start
|
||||
|
||||
```typescript
|
||||
import { Chat } from 'chat';
|
||||
import { createSlackAdapter } from '@chat-adapter/slack';
|
||||
import { createRedisState } from '@chat-adapter/state-redis';
|
||||
|
||||
const bot = new Chat({
|
||||
userName: 'mybot',
|
||||
adapters: {
|
||||
slack: createSlackAdapter({
|
||||
botToken: process.env.SLACK_BOT_TOKEN!,
|
||||
signingSecret: process.env.SLACK_SIGNING_SECRET!,
|
||||
}),
|
||||
},
|
||||
state: createRedisState({ url: process.env.REDIS_URL! }),
|
||||
});
|
||||
|
||||
bot.onNewMention(async (thread) => {
|
||||
await thread.subscribe();
|
||||
await thread.post("Hello! I'm listening to this thread.");
|
||||
});
|
||||
|
||||
bot.onSubscribedMessage(async (thread, message) => {
|
||||
await thread.post(`You said: ${message.text}`);
|
||||
});
|
||||
```
|
||||
|
||||
## Core concepts
|
||||
|
||||
- **Chat** — main entry point, coordinates adapters and routes events
|
||||
- **Adapters** — platform-specific (Slack, Teams, GChat, Discord, GitHub, Linear)
|
||||
- **State** — pluggable persistence (Redis for prod, memory for dev)
|
||||
- **Thread** — conversation thread with `post()`, `subscribe()`, `startTyping()`
|
||||
- **Message** — normalized format with `text`, `formatted` (mdast AST), `raw`
|
||||
- **Channel** — container for threads, supports listing and posting
|
||||
|
||||
## Event handlers
|
||||
|
||||
| Handler | Trigger |
|
||||
| -------------------------- | ------------------------------------------------- |
|
||||
| `onNewMention` | Bot @-mentioned in unsubscribed thread |
|
||||
| `onSubscribedMessage` | Any message in subscribed thread |
|
||||
| `onNewMessage(regex)` | Messages matching pattern in unsubscribed threads |
|
||||
| `onSlashCommand("/cmd")` | Slash command invocations |
|
||||
| `onReaction(emojis)` | Emoji reactions added/removed |
|
||||
| `onAction(actionId)` | Button clicks and dropdown selections |
|
||||
| `onAssistantThreadStarted` | Slack Assistants API thread opened |
|
||||
| `onAppHomeOpened` | Slack App Home tab opened |
|
||||
|
||||
## Streaming
|
||||
|
||||
Pass any `AsyncIterable<string>` to `thread.post()`. Works with AI SDK's `textStream`:
|
||||
|
||||
```typescript
|
||||
import { ToolLoopAgent } from 'ai';
|
||||
const agent = new ToolLoopAgent({ model: 'anthropic/claude-4.5-sonnet' });
|
||||
|
||||
bot.onNewMention(async (thread, message) => {
|
||||
const result = await agent.stream({ prompt: message.text });
|
||||
await thread.post(result.textStream);
|
||||
});
|
||||
```
|
||||
|
||||
## Cards (JSX)
|
||||
|
||||
Set `jsxImportSource: "chat"` in tsconfig. Components: `Card`, `CardText`, `Button`, `Actions`, `Fields`, `Field`, `Select`, `SelectOption`, `Image`, `Divider`, `LinkButton`, `Section`, `RadioSelect`.
|
||||
|
||||
```tsx
|
||||
await thread.post(
|
||||
<Card title="Order #1234">
|
||||
<CardText>Your order has been received!</CardText>
|
||||
<Actions>
|
||||
<Button id="approve" style="primary">
|
||||
Approve
|
||||
</Button>
|
||||
<Button id="reject" style="danger">
|
||||
Reject
|
||||
</Button>
|
||||
</Actions>
|
||||
</Card>,
|
||||
);
|
||||
```
|
||||
|
||||
## Packages
|
||||
|
||||
| Package | Purpose |
|
||||
| ----------------------------- | ----------------------------- |
|
||||
| `chat` | Core SDK |
|
||||
| `@chat-adapter/slack` | Slack |
|
||||
| `@chat-adapter/teams` | Microsoft Teams |
|
||||
| `@chat-adapter/gchat` | Google Chat |
|
||||
| `@chat-adapter/discord` | Discord |
|
||||
| `@chat-adapter/github` | GitHub Issues |
|
||||
| `@chat-adapter/linear` | Linear Issues |
|
||||
| `@chat-adapter/state-redis` | Redis state (production) |
|
||||
| `@chat-adapter/state-ioredis` | ioredis state (alternative) |
|
||||
| `@chat-adapter/state-memory` | In-memory state (development) |
|
||||
|
||||
## Changesets (Release Flow)
|
||||
|
||||
This monorepo uses [Changesets](https://github.com/changesets/changesets) for versioning and changelogs. Every PR that changes a package's behavior must include a changeset.
|
||||
|
||||
```bash
|
||||
pnpm changeset
|
||||
# → select affected package(s) (e.g. @chat-adapter/slack, chat)
|
||||
# → choose bump type: patch (fixes), minor (features), major (breaking)
|
||||
# → write a short summary for the CHANGELOG
|
||||
```
|
||||
|
||||
This creates a file in `.changeset/` — commit it with the PR. When merged to `main`, the Changesets GitHub Action opens a "Version Packages" PR to bump versions and update CHANGELOGs. Merging that PR publishes to npm.
|
||||
|
||||
## Webhook setup
|
||||
|
||||
Each adapter exposes a webhook handler via `bot.webhooks.{platform}`. Wire these to your HTTP framework's routes (e.g. Next.js API routes, Hono, Express).
|
||||
@@ -1,231 +0,0 @@
|
||||
---
|
||||
name: cli
|
||||
description: LobeHub CLI (@lobehub/cli) development guide. Use when working on CLI commands, adding new subcommands, fixing CLI bugs, or understanding CLI architecture. Triggers on CLI development, command implementation, or `lh` command questions.
|
||||
disable-model-invocation: true
|
||||
---
|
||||
|
||||
# LobeHub CLI Development Guide
|
||||
|
||||
## Overview
|
||||
|
||||
LobeHub CLI (`@lobehub/cli`) is a command-line tool for managing and interacting with LobeHub services. Built with Commander.js + TypeScript.
|
||||
|
||||
- **Package**: `apps/cli/`
|
||||
- **Entry**: `apps/cli/src/index.ts`
|
||||
- **Binaries**: `lh`, `lobe`, `lobehub` (all aliases for the same CLI)
|
||||
- **Build**: tsup
|
||||
- **Runtime**: Node.js / Bun
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
apps/cli/src/
|
||||
├── index.ts # Entry point, registers all commands
|
||||
├── api/
|
||||
│ ├── client.ts # tRPC client (type-safe backend API)
|
||||
│ └── http.ts # Raw HTTP utilities
|
||||
├── auth/
|
||||
│ ├── credentials.ts # Encrypted credential storage (AES-256-GCM)
|
||||
│ ├── refresh.ts # Token auto-refresh
|
||||
│ └── resolveToken.ts # Token resolution (flag > stored)
|
||||
├── commands/ # All CLI commands (one file per command group)
|
||||
│ ├── agent.ts # Agent CRUD + run
|
||||
│ ├── config.ts # whoami, usage
|
||||
│ ├── connect.ts # Device gateway connection + daemon
|
||||
│ ├── doc.ts # Document management
|
||||
│ ├── file.ts # File management
|
||||
│ ├── generate/ # Content generation (text/image/video/tts/asr)
|
||||
│ ├── kb.ts # Knowledge base management
|
||||
│ ├── login.ts # OIDC Device Code Flow auth
|
||||
│ ├── logout.ts # Clear credentials
|
||||
│ ├── memory.ts # User memory management
|
||||
│ ├── message.ts # Message management
|
||||
│ ├── model.ts # AI model management
|
||||
│ ├── plugin.ts # Plugin management
|
||||
│ ├── provider.ts # AI provider management
|
||||
│ ├── search.ts # Global search
|
||||
│ ├── skill.ts # Agent skill management
|
||||
│ ├── status.ts # Gateway connectivity check
|
||||
│ └── topic.ts # Conversation topic management
|
||||
├── daemon/
|
||||
│ └── manager.ts # Background daemon process management
|
||||
├── tools/
|
||||
│ ├── shell.ts # Shell command execution (for gateway)
|
||||
│ └── file.ts # File operations (for gateway)
|
||||
├── settings/
|
||||
│ └── index.ts # Persistent settings (~/.lobehub/)
|
||||
├── utils/
|
||||
│ ├── logger.ts # Logging (verbose mode)
|
||||
│ ├── format.ts # Table output, JSON, timeAgo, truncate
|
||||
│ └── agentStream.ts # SSE streaming for agent runs
|
||||
└── constants/
|
||||
└── urls.ts # Official server & gateway URLs
|
||||
```
|
||||
|
||||
## Command Groups
|
||||
|
||||
| Command | Alias | Description |
|
||||
| ------------- | ----- | ----------------------------------------------------------- |
|
||||
| `lh login` | - | Authenticate via OIDC Device Code Flow |
|
||||
| `lh logout` | - | Clear stored credentials |
|
||||
| `lh connect` | - | Device gateway connection & daemon management |
|
||||
| `lh status` | - | Quick gateway connectivity check |
|
||||
| `lh agent` | - | Agent CRUD, run, status |
|
||||
| `lh generate` | `gen` | Content generation (text, image, video, tts, asr, download) |
|
||||
| `lh doc` | - | Document CRUD, batch-create, parse, topic linking |
|
||||
| `lh file` | - | File list, view, delete, recent |
|
||||
| `lh kb` | - | Knowledge base CRUD, folders, docs, upload, tree view |
|
||||
| `lh memory` | - | User memory CRUD + extraction |
|
||||
| `lh message` | - | Message list, search, delete, count, heatmap |
|
||||
| `lh topic` | - | Topic CRUD + search + recent |
|
||||
| `lh skill` | - | Skill CRUD + import (GitHub/URL/market) |
|
||||
| `lh model` | - | Model CRUD, toggle, batch-toggle, clear |
|
||||
| `lh provider` | - | Provider CRUD, config, test, toggle |
|
||||
| `lh plugin` | - | Plugin install, uninstall, update |
|
||||
| `lh search` | - | Global search across all types |
|
||||
| `lh whoami` | - | Current user info |
|
||||
| `lh usage` | - | Monthly/daily usage statistics |
|
||||
|
||||
## Adding a New Command
|
||||
|
||||
### 1. Create Command File
|
||||
|
||||
Create `apps/cli/src/commands/<name>.ts`:
|
||||
|
||||
```typescript
|
||||
import type { Command } from 'commander';
|
||||
import { getTrpcClient } from '../api/client';
|
||||
import { outputJson, printTable, truncate } from '../utils/format';
|
||||
|
||||
export function register<Name>Command(program: Command) {
|
||||
const cmd = program.command('<name>').description('...');
|
||||
|
||||
// Subcommands
|
||||
cmd
|
||||
.command('list')
|
||||
.description('List items')
|
||||
.option('-L, --limit <n>', 'Maximum number of items', '30')
|
||||
.option('--json [fields]', 'Output JSON, optionally specify fields')
|
||||
.action(async (options) => {
|
||||
const client = await getTrpcClient();
|
||||
const result = await client.<router>.<procedure>.query({ ... });
|
||||
// Handle output
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Register in Entry Point
|
||||
|
||||
In `apps/cli/src/index.ts`:
|
||||
|
||||
```typescript
|
||||
import { registerNewCommand } from './commands/new';
|
||||
// ...
|
||||
registerNewCommand(program);
|
||||
```
|
||||
|
||||
### 3. Add Tests
|
||||
|
||||
Create `apps/cli/src/commands/<name>.test.ts` alongside the command file.
|
||||
|
||||
## Conventions
|
||||
|
||||
### Output Patterns
|
||||
|
||||
All list/view commands follow consistent patterns:
|
||||
|
||||
- `--json [fields]` - JSON output with optional field filtering
|
||||
- `--yes` - Skip confirmation for destructive ops
|
||||
- `-L, --limit <n>` - Pagination limit (default: 30)
|
||||
- `-v, --verbose` - Verbose logging
|
||||
|
||||
### Table Output
|
||||
|
||||
```typescript
|
||||
const rows = items.map((item) => [item.id, truncate(item.title, 40), timeAgo(item.updatedAt)]);
|
||||
printTable(rows, ['ID', 'TITLE', 'UPDATED']);
|
||||
```
|
||||
|
||||
### JSON Output
|
||||
|
||||
```typescript
|
||||
if (options.json !== undefined) {
|
||||
const fields = typeof options.json === 'string' ? options.json : undefined;
|
||||
outputJson(items, fields);
|
||||
return;
|
||||
}
|
||||
```
|
||||
|
||||
### Authentication
|
||||
|
||||
Commands that need auth use `getTrpcClient()` which auto-resolves tokens:
|
||||
|
||||
```typescript
|
||||
const client = await getTrpcClient();
|
||||
// client.router.procedure.query/mutate(...)
|
||||
```
|
||||
|
||||
### Confirmation Prompts
|
||||
|
||||
```typescript
|
||||
import { confirm } from '../utils/format';
|
||||
if (!options.yes) {
|
||||
const ok = await confirm('Are you sure?');
|
||||
if (!ok) return;
|
||||
}
|
||||
```
|
||||
|
||||
## Storage Locations
|
||||
|
||||
| File | Path | Purpose |
|
||||
| ------------- | ----------------------------- | ------------------------------ |
|
||||
| Credentials | `~/.lobehub/credentials.json` | Encrypted tokens (AES-256-GCM) |
|
||||
| Settings | `~/.lobehub/settings.json` | Custom server/gateway URLs |
|
||||
| Daemon PID | `~/.lobehub/daemon.pid` | Background process PID |
|
||||
| Daemon Status | `~/.lobehub/daemon.status` | Connection status JSON |
|
||||
| Daemon Log | `~/.lobehub/daemon.log` | Daemon output log |
|
||||
|
||||
The base directory (`~/.lobehub/`) can be overridden with the `LOBEHUB_CLI_HOME` env var (e.g. `LOBEHUB_CLI_HOME=.lobehub-dev` for dev mode isolation).
|
||||
|
||||
## Key Dependencies
|
||||
|
||||
- `commander` - CLI framework
|
||||
- `@trpc/client` + `superjson` - Type-safe API client
|
||||
- `@lobechat/device-gateway-client` - WebSocket gateway connection
|
||||
- `@lobechat/local-file-shell` - Local shell/file tool execution
|
||||
- `picocolors` - Terminal colors
|
||||
- `ws` - WebSocket
|
||||
- `diff` - Text diffing
|
||||
- `fast-glob` - File pattern matching
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
# Run directly (dev mode, uses ~/.lobehub-dev for credentials)
|
||||
cd apps/cli && bun run dev -- <command>
|
||||
|
||||
# Build
|
||||
cd apps/cli && bun run build
|
||||
|
||||
# Test (unit tests)
|
||||
cd apps/cli && bun run test
|
||||
|
||||
# E2E tests (requires authenticated CLI)
|
||||
cd apps/cli && bunx vitest run e2e/kb.e2e.test.ts
|
||||
|
||||
# Link globally for testing
|
||||
cd apps/cli && bun run cli:link
|
||||
```
|
||||
|
||||
## Detailed Command References
|
||||
|
||||
See `references/` for each command group:
|
||||
|
||||
- **Agent**: `references/agent.md` (CRUD, run, status)
|
||||
- **Content Generation**: `references/generate.md` (text, image, video, tts, asr, download)
|
||||
- **Knowledge & Files**: `references/knowledge.md` (kb, file, doc)
|
||||
- **Conversation**: `references/conversation.md` (topic, message)
|
||||
- **Memory**: `references/memory.md` (memory management, extraction)
|
||||
- **Skills & Plugins**: `references/skills-plugins.md` (skill, plugin)
|
||||
- **Models & Providers**: `references/models-providers.md` (model, provider)
|
||||
- **Search & Config**: `references/search-config.md` (search, whoami, usage)
|
||||
@@ -1,144 +0,0 @@
|
||||
# Agent Commands
|
||||
|
||||
Manage AI agents: create, edit, delete, list, run, and check status.
|
||||
|
||||
**Source**: `apps/cli/src/commands/agent.ts`
|
||||
|
||||
## `lh agent list`
|
||||
|
||||
List all agents.
|
||||
|
||||
```bash
|
||||
lh agent list [-L [-k [--json [fields]] < n > ] < keyword > ]
|
||||
```
|
||||
|
||||
| Option | Description | Default |
|
||||
| ------------------------- | -------------------------------------- | ------- |
|
||||
| `-L, --limit <n>` | Maximum items | `30` |
|
||||
| `-k, --keyword <keyword>` | Filter by keyword | - |
|
||||
| `--json [fields]` | JSON output with optional field filter | - |
|
||||
|
||||
**Table columns**: ID, TITLE, DESCRIPTION, MODEL
|
||||
|
||||
---
|
||||
|
||||
## `lh agent view <agentId>`
|
||||
|
||||
View agent configuration details.
|
||||
|
||||
```bash
|
||||
lh agent view [fields]] < agentId > [--json
|
||||
```
|
||||
|
||||
**Displays**: Title, description, model, provider, system role, plugins, tools.
|
||||
|
||||
---
|
||||
|
||||
## `lh agent create`
|
||||
|
||||
Create a new agent.
|
||||
|
||||
```bash
|
||||
lh agent create [options]
|
||||
```
|
||||
|
||||
| Option | Description | Required |
|
||||
| --------------------------- | -------------- | -------- |
|
||||
| `-t, --title <title>` | Agent title | No |
|
||||
| `-d, --description <desc>` | Description | No |
|
||||
| `-m, --model <model>` | Model ID | No |
|
||||
| `-p, --provider <provider>` | Provider ID | No |
|
||||
| `-s, --system-role <role>` | System prompt | No |
|
||||
| `--group <groupId>` | Agent group ID | No |
|
||||
|
||||
**Output**: Created agent ID and session ID.
|
||||
|
||||
---
|
||||
|
||||
## `lh agent edit <agentId>`
|
||||
|
||||
Update an existing agent. Same options as `create`, all optional. Only specified fields are updated.
|
||||
|
||||
```bash
|
||||
lh agent edit [-m [-s ... < agentId > [-t < title > ] < model > ] < role > ]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## `lh agent delete <agentId>`
|
||||
|
||||
Delete an agent.
|
||||
|
||||
```bash
|
||||
lh agent delete < agentId > [--yes]
|
||||
```
|
||||
|
||||
Requires confirmation unless `--yes` is provided.
|
||||
|
||||
---
|
||||
|
||||
## `lh agent duplicate <agentId>`
|
||||
|
||||
Duplicate an existing agent.
|
||||
|
||||
```bash
|
||||
lh agent duplicate < agentId > [-t < title > ]
|
||||
```
|
||||
|
||||
| Option | Description |
|
||||
| --------------------- | ------------------------------------ |
|
||||
| `-t, --title <title>` | Optional new title for the duplicate |
|
||||
|
||||
**Output**: New agent ID.
|
||||
|
||||
---
|
||||
|
||||
## `lh agent run`
|
||||
|
||||
Start an agent execution (streaming SSE).
|
||||
|
||||
```bash
|
||||
lh agent run [options]
|
||||
```
|
||||
|
||||
| Option | Description |
|
||||
| --------------------- | -------------------------------------------- |
|
||||
| `-a, --agent-id <id>` | Agent ID to run |
|
||||
| `-s, --slug <slug>` | Agent slug (alternative to ID) |
|
||||
| `-p, --prompt <text>` | User prompt |
|
||||
| `-t, --topic-id <id>` | Reuse existing topic |
|
||||
| `--no-auto-start` | Don't auto-start the agent |
|
||||
| `--json` | Output full JSON event stream |
|
||||
| `-v, --verbose` | Show detailed tool call info |
|
||||
| `--replay <file>` | Replay events from saved JSON file (offline) |
|
||||
|
||||
### Streaming Behavior
|
||||
|
||||
Uses `utils/agentStream.ts` to handle Server-Sent Events:
|
||||
|
||||
1. Sends agent run request to backend
|
||||
2. Streams SSE events in real-time
|
||||
3. Displays: text chunks, tool call status, operation progress
|
||||
4. Shows final token usage and cost summary
|
||||
|
||||
### Replay Mode
|
||||
|
||||
`--replay <file>` reads a saved JSON event stream for offline debugging without server connection.
|
||||
|
||||
---
|
||||
|
||||
## `lh agent status <operationId>`
|
||||
|
||||
Check agent operation status.
|
||||
|
||||
```bash
|
||||
lh agent status [fields]] [--history] [--history-limit < operationId > [--json < n > ]
|
||||
```
|
||||
|
||||
| Option | Description | Default |
|
||||
| --------------------- | -------------------- | ------- |
|
||||
| `--json [fields]` | JSON output | - |
|
||||
| `--history` | Include step history | `false` |
|
||||
| `--history-limit <n>` | Max history entries | `10` |
|
||||
|
||||
**Displays**: Status (running/completed/failed), steps count, tokens used, cost, error info, timestamps.
|
||||
@@ -1,122 +0,0 @@
|
||||
# Conversation Commands (Topic & Message)
|
||||
|
||||
## Topic Management (`lh topic`)
|
||||
|
||||
Manage conversation topics (threads).
|
||||
|
||||
**Source**: `apps/cli/src/commands/topic.ts`
|
||||
|
||||
### `lh topic list`
|
||||
|
||||
```bash
|
||||
lh topic list [--agent-id [-L [--page [--json [fields]] < id > ] < n > ] < n > ]
|
||||
```
|
||||
|
||||
| Option | Description | Default |
|
||||
| ----------------- | --------------- | ------- |
|
||||
| `--agent-id <id>` | Filter by agent | - |
|
||||
| `-L, --limit <n>` | Page size | `30` |
|
||||
| `--page <n>` | Page number | `1` |
|
||||
|
||||
**Table columns**: ID, TITLE, FAV, UPDATED
|
||||
|
||||
### `lh topic search <keywords>`
|
||||
|
||||
```bash
|
||||
lh topic search [--json [fields]] < keywords > [--agent-id < id > ]
|
||||
```
|
||||
|
||||
### `lh topic create`
|
||||
|
||||
```bash
|
||||
lh topic create -t [--favorite] < title > [--agent-id < id > ]
|
||||
```
|
||||
|
||||
| Option | Description | Required |
|
||||
| --------------------- | -------------------- | -------- |
|
||||
| `-t, --title <title>` | Topic title | Yes |
|
||||
| `--agent-id <id>` | Associate with agent | No |
|
||||
| `--favorite` | Mark as favorite | No |
|
||||
|
||||
### `lh topic edit <id>`
|
||||
|
||||
```bash
|
||||
lh topic edit [--favorite] [--no-favorite] < id > [-t < title > ]
|
||||
```
|
||||
|
||||
### `lh topic delete <ids...>`
|
||||
|
||||
```bash
|
||||
lh topic delete [--yes] < id1 > [id2...]
|
||||
```
|
||||
|
||||
### `lh topic recent`
|
||||
|
||||
```bash
|
||||
lh topic recent [-L [--json [fields]] < n > ]
|
||||
```
|
||||
|
||||
| Option | Description | Default |
|
||||
| ----------------- | --------------- | ------- |
|
||||
| `-L, --limit <n>` | Number of items | `10` |
|
||||
|
||||
---
|
||||
|
||||
## Message Management (`lh message`)
|
||||
|
||||
Manage chat messages within topics.
|
||||
|
||||
**Source**: `apps/cli/src/commands/message.ts`
|
||||
|
||||
### `lh message list`
|
||||
|
||||
```bash
|
||||
lh message list [options] [--json [fields]]
|
||||
```
|
||||
|
||||
| Option | Description | Default |
|
||||
| ----------------- | ----------------------- | ------- |
|
||||
| `--topic-id <id>` | Filter by topic | - |
|
||||
| `--agent-id <id>` | Filter by agent | - |
|
||||
| `-L, --limit <n>` | Page size | `30` |
|
||||
| `--page <n>` | Page number | `1` |
|
||||
| `--user` | Only show user messages | - |
|
||||
|
||||
**Table columns**: ID, ROLE, CONTENT, CREATED
|
||||
|
||||
**Note**: When `--topic-id` or `--agent-id` is provided, uses `message.getMessages`; otherwise uses `message.listAll`.
|
||||
|
||||
### `lh message search <keywords>`
|
||||
|
||||
```bash
|
||||
lh message search [fields]] < keywords > [--json
|
||||
```
|
||||
|
||||
Full-text search across all messages.
|
||||
|
||||
### `lh message delete <ids...>`
|
||||
|
||||
```bash
|
||||
lh message delete [--yes] < id1 > [id2...]
|
||||
```
|
||||
|
||||
### `lh message count`
|
||||
|
||||
```bash
|
||||
lh message count [--start [--end [--json] < date > ] < date > ]
|
||||
```
|
||||
|
||||
| Option | Description |
|
||||
| ---------------- | ------------------------------------------ |
|
||||
| `--start <date>` | Start date (ISO format, e.g. `2024-01-01`) |
|
||||
| `--end <date>` | End date (ISO format) |
|
||||
|
||||
**Output**: Total message count for the specified period.
|
||||
|
||||
### `lh message heatmap`
|
||||
|
||||
```bash
|
||||
lh message heatmap [--json]
|
||||
```
|
||||
|
||||
**Output**: Activity heatmap data showing message frequency over time.
|
||||
@@ -1,246 +0,0 @@
|
||||
# Content Generation Commands
|
||||
|
||||
Generate text, images, videos, speech, and transcriptions.
|
||||
|
||||
**Source**: `apps/cli/src/commands/generate/`
|
||||
|
||||
## Command Structure
|
||||
|
||||
```
|
||||
lh generate (alias: gen)
|
||||
├── text <prompt> # Text generation
|
||||
├── image <prompt> # Image generation
|
||||
├── video <prompt> # Video generation
|
||||
├── tts <text> # Text-to-speech
|
||||
├── asr <audioFile> # Audio-to-text (speech recognition)
|
||||
├── download <genId> <taskId> # Wait & download generation result
|
||||
├── status <genId> <taskId> # Check async task status
|
||||
└── list # List generation topics
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## `lh generate text <prompt>` / `lh gen text <prompt>`
|
||||
|
||||
Generate text completion.
|
||||
|
||||
**Source**: `apps/cli/src/commands/generate/text.ts`
|
||||
|
||||
```bash
|
||||
lh gen text "Explain quantum computing" [options]
|
||||
echo "context" | lh gen text "summarize" --pipe
|
||||
```
|
||||
|
||||
| Option | Description | Default |
|
||||
| --------------------------- | ---------------------------------- | -------------------- |
|
||||
| `-m, --model <model>` | Model ID | `openai/gpt-4o-mini` |
|
||||
| `-p, --provider <provider>` | Provider name | - |
|
||||
| `-s, --system <prompt>` | System prompt | - |
|
||||
| `--temperature <n>` | Temperature (0-2) | - |
|
||||
| `--max-tokens <n>` | Maximum output tokens | - |
|
||||
| `--stream` | Enable streaming output | `false` |
|
||||
| `--json` | Output full JSON response | `false` |
|
||||
| `--pipe` | Read additional context from stdin | `false` |
|
||||
|
||||
### Pipe Mode
|
||||
|
||||
When `--pipe` is used, reads stdin and prepends it to the prompt. Useful for piping file contents:
|
||||
|
||||
```bash
|
||||
cat README.md | lh gen text "summarize this" --pipe
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## `lh generate image <prompt>` / `lh gen image <prompt>`
|
||||
|
||||
Generate images from text prompt. This is an async operation — the command submits the task and returns a generation ID + task ID for tracking.
|
||||
|
||||
**Source**: `apps/cli/src/commands/generate/image.ts`
|
||||
|
||||
```bash
|
||||
lh gen image "A sunset over mountains" [options]
|
||||
lh gen image "A cute cat" --model dall-e-3 --provider openai --json
|
||||
```
|
||||
|
||||
| Option | Description | Default |
|
||||
| --------------------------- | ---------------- | ---------- |
|
||||
| `-m, --model <model>` | Model ID | `dall-e-3` |
|
||||
| `-p, --provider <provider>` | Provider name | `openai` |
|
||||
| `-n, --num <n>` | Number of images | `1` |
|
||||
| `--width <px>` | Width in pixels | - |
|
||||
| `--height <px>` | Height in pixels | - |
|
||||
| `--steps <n>` | Number of steps | - |
|
||||
| `--seed <n>` | Random seed | - |
|
||||
| `--json` | Output raw JSON | `false` |
|
||||
|
||||
**Output** (non-JSON):
|
||||
|
||||
```
|
||||
✓ Image generation started
|
||||
Batch ID: gb_xxx
|
||||
1 image(s) queued
|
||||
Generation gen_xxx → Task <taskId>
|
||||
|
||||
Use "lh generate status <generationId> <taskId>" to check progress.
|
||||
```
|
||||
|
||||
**Typical workflow**:
|
||||
|
||||
```bash
|
||||
# Generate image, then wait & download
|
||||
lh gen image "A cute cat"
|
||||
lh gen download <generationId> <taskId> -o cat.png
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## `lh generate video <prompt>` / `lh gen video <prompt>`
|
||||
|
||||
Generate video from text prompt. This is an async operation.
|
||||
|
||||
**Source**: `apps/cli/src/commands/generate/video.ts`
|
||||
|
||||
```bash
|
||||
lh gen video "A cat playing piano" -m < model > -p < provider > [options]
|
||||
```
|
||||
|
||||
| Option | Description | Required |
|
||||
| --------------------------- | ------------------------ | -------- |
|
||||
| `-m, --model <model>` | Model ID | Yes |
|
||||
| `-p, --provider <provider>` | Provider name | Yes |
|
||||
| `--aspect-ratio <ratio>` | Aspect ratio (e.g. 16:9) | No |
|
||||
| `--duration <sec>` | Duration in seconds | No |
|
||||
| `--resolution <res>` | Resolution (e.g. 720p) | No |
|
||||
| `--seed <n>` | Random seed | No |
|
||||
| `--json` | Output raw JSON | No |
|
||||
|
||||
**Note**: Unlike image, video requires `-m` and `-p` (no defaults). Use `lh model list <provider> --type video` to find available video models.
|
||||
|
||||
**Output** (non-JSON):
|
||||
|
||||
```
|
||||
✓ Video generation started
|
||||
Batch ID: gb_xxx
|
||||
Generation gen_xxx → Task <taskId>
|
||||
|
||||
Use "lh generate status <generationId> <taskId>" to check progress.
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## `lh generate tts <text>` / `lh gen tts <text>`
|
||||
|
||||
Text-to-speech generation.
|
||||
|
||||
**Source**: `apps/cli/src/commands/generate/tts.ts`
|
||||
|
||||
```bash
|
||||
lh gen tts "Hello, world!" [options]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## `lh generate asr <audioFile>` / `lh gen asr <audioFile>`
|
||||
|
||||
Audio-to-text transcription (Automatic Speech Recognition).
|
||||
|
||||
**Source**: `apps/cli/src/commands/generate/asr.ts`
|
||||
|
||||
```bash
|
||||
lh gen asr recording.wav [options]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## `lh generate download <generationId> <taskId>`
|
||||
|
||||
Wait for an async generation task to complete and download the result file.
|
||||
|
||||
**Source**: `apps/cli/src/commands/generate/index.ts`
|
||||
|
||||
```bash
|
||||
lh gen download <generationId> <taskId> [-o output.png]
|
||||
lh gen download gen_xxx task_xxx -o ~/Desktop/result.mp4 --timeout 600
|
||||
```
|
||||
|
||||
| Option | Description | Default |
|
||||
| --------------------- | ---------------------------------------- | ---------------------- |
|
||||
| `-o, --output <path>` | Output file path (auto-detect extension) | `<generationId>.<ext>` |
|
||||
| `--interval <sec>` | Polling interval in seconds | `5` |
|
||||
| `--timeout <sec>` | Timeout in seconds (0 = no timeout) | `300` |
|
||||
|
||||
**Behavior**:
|
||||
|
||||
1. Polls `generation.getGenerationStatus` at the specified interval
|
||||
2. Shows live progress: `⋯ Status: processing... (42s)`
|
||||
3. On success: downloads asset URL to local file
|
||||
4. On error: displays error message and exits
|
||||
5. On timeout: suggests using `lh gen status` to check later
|
||||
|
||||
**Typical workflow**:
|
||||
|
||||
```bash
|
||||
# One-shot: generate and download
|
||||
lh gen image "A sunset"
|
||||
# Copy the generation ID and task ID from output
|
||||
lh gen download gen_xxx taskId_xxx -o sunset.png
|
||||
|
||||
# Video (longer timeout)
|
||||
lh gen video "A cat running" -m model -p provider
|
||||
lh gen download gen_xxx taskId_xxx -o cat.mp4 --timeout 600
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## `lh generate status <generationId> <taskId>`
|
||||
|
||||
Check the status of an async generation task.
|
||||
|
||||
```bash
|
||||
lh gen status <generationId> <taskId> [--json]
|
||||
```
|
||||
|
||||
| Option | Description |
|
||||
| -------- | ------------------------ |
|
||||
| `--json` | Output raw JSON response |
|
||||
|
||||
**Displays**:
|
||||
|
||||
- Status (color-coded): `success` (green), `error` (red), `processing` (yellow), `pending` (cyan)
|
||||
- Error message (if failed)
|
||||
- Asset URL and thumbnail URL (if completed)
|
||||
|
||||
---
|
||||
|
||||
## `lh generate list`
|
||||
|
||||
List all generation topics.
|
||||
|
||||
```bash
|
||||
lh gen list [--json [fields]]
|
||||
```
|
||||
|
||||
**Table columns**: ID, TITLE, TYPE, UPDATED
|
||||
|
||||
---
|
||||
|
||||
## Backend Architecture
|
||||
|
||||
Image and video generation use an async task pattern:
|
||||
|
||||
1. **Create topic** → `generationTopic.createTopic`
|
||||
2. **Submit generation** → `image.createImage` / `video.createVideo`
|
||||
- Creates batch + generation + asyncTask records in a DB transaction
|
||||
- Triggers async background task (image via `createAsyncCaller`, video via `initModelRuntimeFromDB`)
|
||||
- Returns `{ data: { batch, generations }, success }` with `asyncTaskId` in each generation
|
||||
3. **Poll status** → `generation.getGenerationStatus`
|
||||
- Returns `{ status, error, generation }` (generation includes asset URLs on success)
|
||||
|
||||
**Server routes**:
|
||||
|
||||
- `src/server/routers/lambda/image/index.ts` — image creation (uses `authedProcedure` + `serverDatabase`)
|
||||
- `src/server/routers/lambda/video/index.ts` — video creation (uses `authedProcedure` + `serverDatabase`)
|
||||
- `src/server/routers/lambda/generation.ts` — status checking
|
||||
|
||||
**Note**: Image/video routes do NOT use the `keyVaults` middleware — they read API keys from the database via `initModelRuntimeFromDB` or `createAsyncCaller`.
|
||||
@@ -1,281 +0,0 @@
|
||||
# Knowledge Base, File & Document Commands
|
||||
|
||||
## Knowledge Base (`lh kb`)
|
||||
|
||||
Manage knowledge bases for RAG (Retrieval-Augmented Generation). Supports directory tree structure with folders, documents, and file uploads.
|
||||
|
||||
**Source**: `apps/cli/src/commands/kb.ts`
|
||||
|
||||
### `lh kb list`
|
||||
|
||||
```bash
|
||||
lh kb list [--json [fields]]
|
||||
```
|
||||
|
||||
**Table columns**: ID, NAME, DESCRIPTION, UPDATED
|
||||
|
||||
### `lh kb view <id>`
|
||||
|
||||
```bash
|
||||
lh kb view [fields]] < id > [--json
|
||||
```
|
||||
|
||||
**Displays**: Name, description, full directory tree with all files and documents (recursively fetched). Shows indented tree structure with item type (File/Doc), file type, and size.
|
||||
|
||||
**API**: Uses `file.getKnowledgeItems` to recursively fetch items. Folders (`custom/folder` fileType) are traversed in parallel via `Promise.all` for performance.
|
||||
|
||||
### `lh kb create`
|
||||
|
||||
```bash
|
||||
lh kb create -n [--avatar < name > [-d < desc > ] < url > ]
|
||||
```
|
||||
|
||||
| Option | Description | Required |
|
||||
| -------------------------- | ------------------- | -------- |
|
||||
| `-n, --name <name>` | Knowledge base name | Yes |
|
||||
| `-d, --description <desc>` | Description | No |
|
||||
| `--avatar <url>` | Avatar URL | No |
|
||||
|
||||
**Output**: Created KB ID. Note: backend returns ID as a string directly (not an object).
|
||||
|
||||
### `lh kb edit <id>`
|
||||
|
||||
```bash
|
||||
lh kb edit [-d [--avatar < id > [-n < name > ] < desc > ] < url > ]
|
||||
```
|
||||
|
||||
Requires at least one change flag. Errors if none specified.
|
||||
|
||||
### `lh kb delete <id>`
|
||||
|
||||
```bash
|
||||
lh kb delete [--yes] < id > [--remove-files]
|
||||
```
|
||||
|
||||
| Option | Description |
|
||||
| ---------------- | ---------------------------- |
|
||||
| `--remove-files` | Also delete associated files |
|
||||
| `--yes` | Skip confirmation |
|
||||
|
||||
### `lh kb add-files <knowledgeBaseId>`
|
||||
|
||||
```bash
|
||||
lh kb add-files <kbId> --ids <fileId1> <fileId2> ...
|
||||
```
|
||||
|
||||
Link existing files to a knowledge base.
|
||||
|
||||
### `lh kb remove-files <knowledgeBaseId>`
|
||||
|
||||
```bash
|
||||
lh kb remove-files <kbId> --ids <fileId1> <fileId2> ... [--yes]
|
||||
```
|
||||
|
||||
Unlink files from a knowledge base.
|
||||
|
||||
### `lh kb mkdir <knowledgeBaseId>`
|
||||
|
||||
```bash
|
||||
lh kb mkdir < kbId > -n < name > [--parent < folderId > ]
|
||||
```
|
||||
|
||||
Create a folder in a knowledge base. Uses `document.createDocument` with `fileType: 'custom/folder'`.
|
||||
|
||||
| Option | Description | Required |
|
||||
| --------------------- | ---------------- | -------- |
|
||||
| `-n, --name <name>` | Folder name | Yes |
|
||||
| `--parent <parentId>` | Parent folder ID | No |
|
||||
|
||||
### `lh kb create-doc <knowledgeBaseId>`
|
||||
|
||||
```bash
|
||||
lh kb create-doc [--parent < kbId > -t < title > [-c < content > ] < folderId > ]
|
||||
```
|
||||
|
||||
Create a document in a knowledge base. Uses `document.createDocument` with `fileType: 'custom/document'`.
|
||||
|
||||
| Option | Description | Required |
|
||||
| ---------------------- | ---------------- | -------- |
|
||||
| `-t, --title <title>` | Document title | Yes |
|
||||
| `-c, --content <text>` | Document content | No |
|
||||
| `--parent <parentId>` | Parent folder ID | No |
|
||||
|
||||
### `lh kb move <id>`
|
||||
|
||||
```bash
|
||||
lh kb move < id > --type < file | doc > [--parent < folderId > ]
|
||||
```
|
||||
|
||||
Move a file or document to a different folder (or to root if `--parent` is omitted).
|
||||
|
||||
| Option | Description | Default |
|
||||
| --------------------- | -------------------------------- | ------- |
|
||||
| `--type <type>` | Item type: `file` or `doc` | `file` |
|
||||
| `--parent <parentId>` | Target folder ID (omit for root) | - |
|
||||
|
||||
Uses `document.updateDocument` for docs, `file.updateFile` for files.
|
||||
|
||||
### `lh kb upload <knowledgeBaseId> <filePath>`
|
||||
|
||||
```bash
|
||||
lh kb upload <kbId> <filePath> [--parent <folderId>]
|
||||
```
|
||||
|
||||
Upload a local file to a knowledge base via S3 presigned URL.
|
||||
|
||||
| Option | Description |
|
||||
| --------------------- | ---------------- |
|
||||
| `--parent <parentId>` | Parent folder ID |
|
||||
|
||||
**Flow**: Compute SHA-256 hash → get presigned URL via `upload.createS3PreSignedUrl` → PUT to S3 → create file record via `file.createFile`.
|
||||
|
||||
---
|
||||
|
||||
## File Management (`lh file`)
|
||||
|
||||
Manage uploaded files.
|
||||
|
||||
**Source**: `apps/cli/src/commands/file.ts`
|
||||
|
||||
### `lh file list`
|
||||
|
||||
```bash
|
||||
lh file list [--kb-id [-L [--json [fields]] < id > ] < n > ]
|
||||
```
|
||||
|
||||
| Option | Description | Default |
|
||||
| ----------------- | ------------------------ | ------- |
|
||||
| `--kb-id <id>` | Filter by knowledge base | - |
|
||||
| `-L, --limit <n>` | Maximum items | `30` |
|
||||
|
||||
**Table columns**: ID, NAME, TYPE, SIZE, UPDATED
|
||||
|
||||
### `lh file view <id>`
|
||||
|
||||
```bash
|
||||
lh file view [fields]] < id > [--json
|
||||
```
|
||||
|
||||
**Displays**: Name, type, size, chunking status, embedding status.
|
||||
|
||||
### `lh file delete <ids...>`
|
||||
|
||||
```bash
|
||||
lh file delete [--yes] < id1 > [id2...]
|
||||
```
|
||||
|
||||
Supports deleting multiple files at once.
|
||||
|
||||
### `lh file recent`
|
||||
|
||||
```bash
|
||||
lh file recent [-L [--json [fields]] < n > ]
|
||||
```
|
||||
|
||||
| Option | Description | Default |
|
||||
| ----------------- | --------------- | ------- |
|
||||
| `-L, --limit <n>` | Number of items | `10` |
|
||||
|
||||
---
|
||||
|
||||
## Document Management (`lh doc`)
|
||||
|
||||
Manage text documents (notes, wiki pages).
|
||||
|
||||
**Source**: `apps/cli/src/commands/doc.ts`
|
||||
|
||||
### `lh doc list`
|
||||
|
||||
```bash
|
||||
lh doc list [-L [--file-type [--source-type [--json [fields]] < n > ] < type > ] < type > ]
|
||||
```
|
||||
|
||||
| Option | Description | Default |
|
||||
| ---------------------- | --------------------------------------------- | ------- |
|
||||
| `-L, --limit <n>` | Maximum items | `30` |
|
||||
| `--file-type <type>` | Filter by file type | - |
|
||||
| `--source-type <type>` | Filter by source type (file, web, api, topic) | - |
|
||||
|
||||
**Table columns**: ID, TITLE, TYPE, UPDATED
|
||||
|
||||
### `lh doc view <id>`
|
||||
|
||||
```bash
|
||||
lh doc view [fields]] < id > [--json
|
||||
```
|
||||
|
||||
**Displays**: Title, type, KB association, updated time, full content.
|
||||
|
||||
### `lh doc create`
|
||||
|
||||
```bash
|
||||
lh doc create -t [-F [--parent [--slug [--kb [--file-type < title > [-b < body > ] < path > ] < id > ] < slug > ] < id > ] < type > ]
|
||||
```
|
||||
|
||||
| Option | Description | Required |
|
||||
| ------------------------ | ----------------------------------------------- | -------- |
|
||||
| `-t, --title <title>` | Document title | Yes |
|
||||
| `-b, --body <content>` | Document body text | No |
|
||||
| `-F, --body-file <path>` | Read body from file | No |
|
||||
| `--parent <id>` | Parent document ID | No |
|
||||
| `--slug <slug>` | Custom URL slug | No |
|
||||
| `--kb <id>` | Knowledge base ID to associate with | No |
|
||||
| `--file-type <type>` | File type (e.g. custom/document, custom/folder) | No |
|
||||
|
||||
`-b` and `-F` are mutually exclusive; `-F` reads the file content as the body.
|
||||
|
||||
### `lh doc batch-create <file>`
|
||||
|
||||
Batch create documents from a JSON file. The file must contain a non-empty array of document objects.
|
||||
|
||||
```bash
|
||||
lh doc batch-create documents.json
|
||||
```
|
||||
|
||||
Each object in the array can have: `title`, `content`, `fileType`, `knowledgeBaseId`, `parentId`, `slug`.
|
||||
|
||||
### `lh doc edit <id>`
|
||||
|
||||
```bash
|
||||
lh doc edit [-b [-F [--parent [--file-type < id > [-t < title > ] < body > ] < path > ] < id > ] < type > ]
|
||||
```
|
||||
|
||||
### `lh doc delete <ids...>`
|
||||
|
||||
```bash
|
||||
lh doc delete [--yes] < id1 > [id2...]
|
||||
```
|
||||
|
||||
### `lh doc parse <fileId>`
|
||||
|
||||
Parse an uploaded file into a document.
|
||||
|
||||
```bash
|
||||
lh doc parse [--json [fields]] < fileId > [--with-pages]
|
||||
```
|
||||
|
||||
| Option | Description |
|
||||
| -------------- | ----------------------- |
|
||||
| `--with-pages` | Preserve page structure |
|
||||
|
||||
**Output**: Parsed title and content preview.
|
||||
|
||||
### `lh doc link-topic <docId> <topicId>`
|
||||
|
||||
Associate a document with a topic. Creates a linked copy via the notebook router.
|
||||
|
||||
```bash
|
||||
lh doc link-topic <docId> <topicId>
|
||||
```
|
||||
|
||||
### `lh doc topic-docs <topicId>`
|
||||
|
||||
List documents associated with a topic.
|
||||
|
||||
```bash
|
||||
lh doc topic-docs [--json [fields]] < topicId > [--type < type > ]
|
||||
```
|
||||
|
||||
| Option | Description |
|
||||
| --------------- | ------------------------------------------------ |
|
||||
| `--type <type>` | Filter by type (article, markdown, note, report) |
|
||||
@@ -1,138 +0,0 @@
|
||||
# Memory Commands
|
||||
|
||||
Manage user memories - the AI's long-term knowledge about users.
|
||||
|
||||
**Source**: `apps/cli/src/commands/memory.ts`
|
||||
|
||||
## Memory Categories
|
||||
|
||||
| Category | Description |
|
||||
| ------------ | ----------------------------------------- |
|
||||
| `identity` | User's name, role, relationships |
|
||||
| `activity` | Recent activities and their status |
|
||||
| `context` | Ongoing contexts, projects, goals |
|
||||
| `experience` | Past experiences and key learnings |
|
||||
| `preference` | User preferences, directives, suggestions |
|
||||
|
||||
---
|
||||
|
||||
## `lh memory list [category]`
|
||||
|
||||
List memory entries, optionally filtered by category.
|
||||
|
||||
```bash
|
||||
lh memory list # All categories
|
||||
lh memory list identity # Only identity memories
|
||||
lh memory list preference # Only preferences
|
||||
```
|
||||
|
||||
| Option | Description |
|
||||
| ----------------- | ----------- |
|
||||
| `--json [fields]` | JSON output |
|
||||
|
||||
**Output**: Grouped by category, showing type/status and descriptions.
|
||||
|
||||
---
|
||||
|
||||
## `lh memory create`
|
||||
|
||||
Create a new identity memory entry.
|
||||
|
||||
```bash
|
||||
lh memory create [options]
|
||||
```
|
||||
|
||||
| Option | Description |
|
||||
| -------------------------- | ------------------------ |
|
||||
| `--type <type>` | Memory type |
|
||||
| `--role <role>` | User's role |
|
||||
| `--relationship <rel>` | Relationship description |
|
||||
| `-d, --description <desc>` | Description |
|
||||
| `--labels <labels...>` | Extracted labels |
|
||||
|
||||
---
|
||||
|
||||
## `lh memory edit <category> <id>`
|
||||
|
||||
Edit a memory entry. Options vary by category:
|
||||
|
||||
```bash
|
||||
lh memory edit identity < id > [options]
|
||||
lh memory edit activity < id > [options]
|
||||
lh memory edit context < id > [options]
|
||||
lh memory edit experience < id > [options]
|
||||
lh memory edit preference < id > [options]
|
||||
```
|
||||
|
||||
### Category-specific Options
|
||||
|
||||
**identity**:
|
||||
|
||||
- `--type <type>`, `--role <role>`, `--relationship <rel>`
|
||||
|
||||
**activity**:
|
||||
|
||||
- `--narrative <text>`, `--notes <text>`, `--status <status>`
|
||||
|
||||
**context**:
|
||||
|
||||
- `--title <title>`, `--description <desc>`, `--status <status>`
|
||||
|
||||
**experience**:
|
||||
|
||||
- `--situation <text>`, `--action <text>`, `--key-learning <text>`
|
||||
|
||||
**preference**:
|
||||
|
||||
- `--directives <text>`, `--suggestions <text>`
|
||||
|
||||
---
|
||||
|
||||
## `lh memory delete <category> <id>`
|
||||
|
||||
```bash
|
||||
lh memory delete identity < id > [--yes]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## `lh memory persona`
|
||||
|
||||
Display the compiled memory persona summary.
|
||||
|
||||
```bash
|
||||
lh memory persona [--json [fields]]
|
||||
```
|
||||
|
||||
**Output**: Summarized user profile built from all memory categories.
|
||||
|
||||
---
|
||||
|
||||
## `lh memory extract`
|
||||
|
||||
Trigger async memory extraction from chat history.
|
||||
|
||||
```bash
|
||||
lh memory extract [--from [--to < date > ] < date > ]
|
||||
```
|
||||
|
||||
| Option | Description |
|
||||
| --------------- | ----------------------- |
|
||||
| `--from <date>` | Start date (ISO format) |
|
||||
| `--to <date>` | End date (ISO format) |
|
||||
|
||||
Starts a background task that analyzes chat history and creates new memory entries.
|
||||
|
||||
---
|
||||
|
||||
## `lh memory extract-status`
|
||||
|
||||
Check the status of a memory extraction task.
|
||||
|
||||
```bash
|
||||
lh memory extract-status [--task-id [--json [fields]] < id > ]
|
||||
```
|
||||
|
||||
| Option | Description |
|
||||
| ---------------- | ------------------- |
|
||||
| `--task-id <id>` | Check specific task |
|
||||
@@ -1,186 +0,0 @@
|
||||
# Model & Provider Commands
|
||||
|
||||
## Model Management (`lh model`)
|
||||
|
||||
Manage AI models within providers.
|
||||
|
||||
**Source**: `apps/cli/src/commands/model.ts`
|
||||
|
||||
### `lh model list <providerId>`
|
||||
|
||||
List models for a specific provider.
|
||||
|
||||
```bash
|
||||
lh model list openai
|
||||
lh model list openai --type image --enabled
|
||||
lh model list lobehub --type video --json
|
||||
```
|
||||
|
||||
| Option | Description | Default |
|
||||
| ----------------- | -------------------------------------------------------------------------------------- | ------- |
|
||||
| `-L, --limit <n>` | Maximum items | `50` |
|
||||
| `--enabled` | Only show enabled models | `false` |
|
||||
| `--type <type>` | Filter by model type (`chat\|embedding\|tts\|stt\|image\|video\|text2music\|realtime`) | - |
|
||||
| `--json [fields]` | Output JSON, optionally specify fields | - |
|
||||
|
||||
**Table columns**: ID, NAME, ENABLED, TYPE
|
||||
|
||||
**Backend**: `aiModel.getAiProviderModelList` → `AiInfraRepos.getAiProviderModelList` (supports `type` filter at repository level)
|
||||
|
||||
### `lh model view <id>`
|
||||
|
||||
```bash
|
||||
lh model view [fields]] < modelId > [--json
|
||||
```
|
||||
|
||||
**Displays**: Name, provider, type, enabled status, capabilities.
|
||||
|
||||
### `lh model create`
|
||||
|
||||
```bash
|
||||
lh model create --id [--type < id > --provider < providerId > [--display-name < name > ] < type > ]
|
||||
```
|
||||
|
||||
| Option | Description | Default |
|
||||
| ------------------------- | ------------ | -------- |
|
||||
| `--id <id>` | Model ID | Required |
|
||||
| `--provider <providerId>` | Provider ID | Required |
|
||||
| `--display-name <name>` | Display name | - |
|
||||
| `--type <type>` | Model type | `chat` |
|
||||
|
||||
### `lh model edit <id>`
|
||||
|
||||
```bash
|
||||
lh model edit [--type < modelId > --provider < providerId > [--display-name < name > ] < type > ]
|
||||
```
|
||||
|
||||
### `lh model toggle <id>`
|
||||
|
||||
Enable or disable a model.
|
||||
|
||||
```bash
|
||||
lh model toggle < modelId > --provider < providerId > --enable
|
||||
lh model toggle < modelId > --provider < providerId > --disable
|
||||
```
|
||||
|
||||
| Option | Description | Required |
|
||||
| ------------------------- | ----------------- | ------------ |
|
||||
| `--provider <providerId>` | Provider ID | Yes |
|
||||
| `--enable` | Enable the model | One required |
|
||||
| `--disable` | Disable the model | One required |
|
||||
|
||||
### `lh model batch-toggle <ids...>`
|
||||
|
||||
Enable or disable multiple models at once.
|
||||
|
||||
```bash
|
||||
lh model batch-toggle model1 model2 model3 --provider openai --enable
|
||||
```
|
||||
|
||||
### `lh model delete <id>`
|
||||
|
||||
```bash
|
||||
lh model delete < modelId > --provider < providerId > [--yes]
|
||||
```
|
||||
|
||||
### `lh model clear`
|
||||
|
||||
Clear all models (or only remote/fetched models) for a provider.
|
||||
|
||||
```bash
|
||||
lh model clear --provider [--yes] < providerId > [--remote]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Provider Management (`lh provider`)
|
||||
|
||||
Manage AI service providers.
|
||||
|
||||
**Source**: `apps/cli/src/commands/provider.ts`
|
||||
|
||||
### `lh provider list`
|
||||
|
||||
```bash
|
||||
lh provider list [--json [fields]]
|
||||
```
|
||||
|
||||
**Table columns**: ID, NAME, ENABLED, SOURCE
|
||||
|
||||
### `lh provider view <id>`
|
||||
|
||||
```bash
|
||||
lh provider view [fields]] < providerId > [--json
|
||||
```
|
||||
|
||||
**Displays**: Name, enabled status, source, configuration.
|
||||
|
||||
### `lh provider create`
|
||||
|
||||
```bash
|
||||
lh provider create --id [-d [--logo [--sdk-type < id > -n < name > [-s < source > ] < desc > ] < url > ] < type > ]
|
||||
```
|
||||
|
||||
| Option | Description | Default |
|
||||
| -------------------------- | ------------------------------------------------- | -------- |
|
||||
| `--id <id>` | Provider ID | Required |
|
||||
| `-n, --name <name>` | Provider name | Required |
|
||||
| `-s, --source <source>` | Source type (`builtin` or `custom`) | `custom` |
|
||||
| `-d, --description <desc>` | Provider description | - |
|
||||
| `--logo <logo>` | Provider logo URL | - |
|
||||
| `--sdk-type <sdkType>` | SDK type (openai, anthropic, azure, bedrock, ...) | - |
|
||||
|
||||
### `lh provider edit <id>`
|
||||
|
||||
```bash
|
||||
lh provider edit [-d [--logo [--sdk-type < providerId > [-n < name > ] < desc > ] < url > ] < type > ]
|
||||
```
|
||||
|
||||
Requires at least one change flag.
|
||||
|
||||
### `lh provider config <id>`
|
||||
|
||||
Configure provider settings (API key, base URL, etc.).
|
||||
|
||||
```bash
|
||||
lh provider config openai --api-key sk-xxx
|
||||
lh provider config openai --base-url https://custom-endpoint.com
|
||||
lh provider config openai --show
|
||||
lh provider config openai --show --json
|
||||
```
|
||||
|
||||
| Option | Description |
|
||||
| ------------------------ | --------------------------------- |
|
||||
| `--api-key <key>` | Set API key |
|
||||
| `--base-url <url>` | Set base URL |
|
||||
| `--check-model <model>` | Set connectivity check model |
|
||||
| `--enable-response-api` | Enable Response API mode (OpenAI) |
|
||||
| `--disable-response-api` | Disable Response API mode |
|
||||
| `--fetch-on-client` | Enable fetching models on client |
|
||||
| `--no-fetch-on-client` | Disable fetching models on client |
|
||||
| `--show` | Show current config |
|
||||
| `--json [fields]` | Output JSON (with --show) |
|
||||
|
||||
**Important**: The `lobehub` provider is platform-managed. Attempting to set `--api-key` or `--base-url` on it will be rejected with an error message.
|
||||
|
||||
### `lh provider test <id>`
|
||||
|
||||
Test provider connectivity.
|
||||
|
||||
```bash
|
||||
lh provider test openai
|
||||
lh provider test openai -m gpt-4o --json
|
||||
```
|
||||
|
||||
### `lh provider toggle <id>`
|
||||
|
||||
```bash
|
||||
lh provider toggle < providerId > --enable
|
||||
lh provider toggle < providerId > --disable
|
||||
```
|
||||
|
||||
### `lh provider delete <id>`
|
||||
|
||||
```bash
|
||||
lh provider delete < providerId > [--yes]
|
||||
```
|
||||
@@ -1,94 +0,0 @@
|
||||
# Search & Configuration Commands
|
||||
|
||||
## Global Search (`lh search`)
|
||||
|
||||
Search across all LobeHub resource types.
|
||||
|
||||
**Source**: `apps/cli/src/commands/search.ts`
|
||||
|
||||
### `lh search <query>`
|
||||
|
||||
```bash
|
||||
lh search "meeting notes" [-t [-L [--json [fields]] < type > ] < n > ]
|
||||
```
|
||||
|
||||
| Option | Description | Default |
|
||||
| ------------------- | ----------------------- | --------- |
|
||||
| `-t, --type <type>` | Filter by resource type | All types |
|
||||
| `-L, --limit <n>` | Results per type | `10` |
|
||||
|
||||
### Searchable Types
|
||||
|
||||
| Type | Description |
|
||||
| ---------------- | ---------------------------- |
|
||||
| `agent` | AI agents |
|
||||
| `topic` | Conversation topics |
|
||||
| `file` | Uploaded files |
|
||||
| `folder` | File folders |
|
||||
| `message` | Chat messages |
|
||||
| `page` | Documents/pages |
|
||||
| `memory` | User memories |
|
||||
| `mcp` | MCP servers |
|
||||
| `plugin` | Installed plugins |
|
||||
| `communityAgent` | Community marketplace agents |
|
||||
| `knowledgeBase` | Knowledge bases |
|
||||
|
||||
**Output**: Results grouped by type, showing ID, title/name, description.
|
||||
|
||||
---
|
||||
|
||||
## User Configuration (`lh whoami` / `lh usage`)
|
||||
|
||||
**Source**: `apps/cli/src/commands/config.ts`
|
||||
|
||||
### `lh whoami`
|
||||
|
||||
Display current authenticated user information.
|
||||
|
||||
```bash
|
||||
lh whoami [--json [fields]]
|
||||
```
|
||||
|
||||
**Displays**: Name, username, email, user ID, subscription plan.
|
||||
|
||||
### `lh usage`
|
||||
|
||||
Display usage statistics.
|
||||
|
||||
```bash
|
||||
lh usage [--month [--daily] [--json [fields]] < YYYY-MM > ]
|
||||
```
|
||||
|
||||
| Option | Description | Default |
|
||||
| ------------------- | -------------- | ----------------------- |
|
||||
| `--month <YYYY-MM>` | Month to query | Current month |
|
||||
| `--daily` | Group by day | `false` (monthly total) |
|
||||
|
||||
**Output**: Token usage, costs, and model breakdown for the specified period.
|
||||
|
||||
---
|
||||
|
||||
## Global Options
|
||||
|
||||
These options are available across most commands:
|
||||
|
||||
| Option | Description |
|
||||
| ----------------- | ---------------------------------------------------------------------- |
|
||||
| `--json [fields]` | Output as JSON; optionally filter to specific fields (comma-separated) |
|
||||
| `--yes` | Skip confirmation prompts for destructive operations |
|
||||
| `-L, --limit <n>` | Pagination limit for list commands |
|
||||
| `-v, --verbose` | Enable verbose/debug logging |
|
||||
| `--help` | Show command help |
|
||||
| `--version` | Show CLI version |
|
||||
|
||||
### JSON Field Filtering
|
||||
|
||||
The `--json` option supports field selection:
|
||||
|
||||
```bash
|
||||
# Full JSON output
|
||||
lh agent list --json
|
||||
|
||||
# Only specific fields
|
||||
lh agent list --json "id,title,model"
|
||||
```
|
||||
@@ -1,149 +0,0 @@
|
||||
# Skill & Plugin Commands
|
||||
|
||||
## Skill Management (`lh skill`)
|
||||
|
||||
Manage agent skills (custom instructions and capabilities).
|
||||
|
||||
**Source**: `apps/cli/src/commands/skill.ts`
|
||||
|
||||
### `lh skill list`
|
||||
|
||||
```bash
|
||||
lh skill list [--source [--json [fields]] < source > ]
|
||||
```
|
||||
|
||||
| Option | Description |
|
||||
| ------------------- | ----------------------------------- |
|
||||
| `--source <source>` | Filter: `builtin`, `market`, `user` |
|
||||
|
||||
**Table columns**: ID, NAME, DESCRIPTION, SOURCE, IDENTIFIER
|
||||
|
||||
### `lh skill view <id>`
|
||||
|
||||
```bash
|
||||
lh skill view [fields]] < id > [--json
|
||||
```
|
||||
|
||||
**Displays**: Name, description, source, identifier, content.
|
||||
|
||||
### `lh skill create`
|
||||
|
||||
```bash
|
||||
lh skill create -n < name > -d < desc > -c < content > [-i < identifier > ]
|
||||
```
|
||||
|
||||
| Option | Description | Required |
|
||||
| -------------------------- | ----------------------------------- | -------- |
|
||||
| `-n, --name <name>` | Skill name | Yes |
|
||||
| `-d, --description <desc>` | Description | Yes |
|
||||
| `-c, --content <content>` | Skill content (prompt/instructions) | Yes |
|
||||
| `-i, --identifier <id>` | Custom identifier | No |
|
||||
|
||||
### `lh skill edit <id>`
|
||||
|
||||
```bash
|
||||
lh skill edit [-n [-d < id > [-c < content > ] < name > ] < desc > ]
|
||||
```
|
||||
|
||||
### `lh skill delete <id>`
|
||||
|
||||
```bash
|
||||
lh skill delete < id > [--yes]
|
||||
```
|
||||
|
||||
### `lh skill search <query>`
|
||||
|
||||
```bash
|
||||
lh skill search [fields]] < query > [--json
|
||||
```
|
||||
|
||||
### `lh skill install <source>` (alias: `lh skill i`)
|
||||
|
||||
Install a skill. Auto-detects source type from the input:
|
||||
|
||||
```bash
|
||||
# GitHub (URL or owner/repo shorthand)
|
||||
lh skill install lobehub/skill-repo
|
||||
lh skill install https://github.com/lobehub/skill-repo
|
||||
lh skill install lobehub/skill-repo --branch dev
|
||||
|
||||
# ZIP URL
|
||||
lh skill install https://example.com/skill.zip
|
||||
|
||||
# Marketplace identifier
|
||||
lh skill install my-cool-skill
|
||||
lh skill i my-cool-skill
|
||||
```
|
||||
|
||||
| Option | Description | Notes |
|
||||
| ------------------- | ------------------------- | -------- |
|
||||
| `--branch <branch>` | Branch name (GitHub only) | Optional |
|
||||
|
||||
**Detection rules**:
|
||||
|
||||
- `https://github.com/...` or `owner/repo` → GitHub
|
||||
- Other `https://...` URLs → ZIP URL
|
||||
- Everything else → marketplace identifier
|
||||
|
||||
### Resource Commands
|
||||
|
||||
#### `lh skill resources <id>`
|
||||
|
||||
List files/resources within a skill.
|
||||
|
||||
```bash
|
||||
lh skill resources [fields]] < id > [--json
|
||||
```
|
||||
|
||||
**Displays**: Path, type, size.
|
||||
|
||||
#### `lh skill read-resource <id> <path>`
|
||||
|
||||
Read a specific resource file from a skill.
|
||||
|
||||
```bash
|
||||
lh skill read-resource <skillId> <path>
|
||||
```
|
||||
|
||||
**Output**: File content or JSON metadata.
|
||||
|
||||
---
|
||||
|
||||
## Plugin Management (`lh plugin`)
|
||||
|
||||
Install and manage plugins (external tool integrations).
|
||||
|
||||
**Source**: `apps/cli/src/commands/plugin.ts`
|
||||
|
||||
### `lh plugin list`
|
||||
|
||||
```bash
|
||||
lh plugin list [--json [fields]]
|
||||
```
|
||||
|
||||
**Table columns**: ID, IDENTIFIER, TYPE, TITLE
|
||||
|
||||
### `lh plugin install`
|
||||
|
||||
```bash
|
||||
lh plugin install -i [--settings < identifier > --manifest < json > [--type < type > ] < json > ]
|
||||
```
|
||||
|
||||
| Option | Description | Required |
|
||||
| ----------------------- | -------------------------- | ---------------------- |
|
||||
| `-i, --identifier <id>` | Plugin identifier | Yes |
|
||||
| `--manifest <json>` | Plugin manifest JSON | Yes |
|
||||
| `--type <type>` | `plugin` or `customPlugin` | No (default: `plugin`) |
|
||||
| `--settings <json>` | Plugin settings JSON | No |
|
||||
|
||||
### `lh plugin uninstall <id>`
|
||||
|
||||
```bash
|
||||
lh plugin uninstall < id > [--yes]
|
||||
```
|
||||
|
||||
### `lh plugin update <id>`
|
||||
|
||||
```bash
|
||||
lh plugin update [--settings < id > [--manifest < json > ] < json > ]
|
||||
```
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,110 +0,0 @@
|
||||
---
|
||||
name: db-migrations
|
||||
description: Database migration guide. Use when generating migrations, writing migration SQL, or modifying database schemas. Triggers on migration generation, schema changes, or idempotent SQL questions.
|
||||
---
|
||||
|
||||
# Database Migrations Guide
|
||||
|
||||
## Step 1: Generate Migrations
|
||||
|
||||
```bash
|
||||
bun run db:generate
|
||||
```
|
||||
|
||||
This generates:
|
||||
|
||||
- `packages/database/migrations/0046_meaningless_file_name.sql`
|
||||
|
||||
And updates:
|
||||
|
||||
- `packages/database/migrations/meta/_journal.json`
|
||||
- `packages/database/src/core/migrations.json`
|
||||
- `docs/development/database-schema.dbml`
|
||||
|
||||
## Custom Migrations (e.g. CREATE EXTENSION)
|
||||
|
||||
For migrations that don't involve Drizzle schema changes (e.g. enabling PostgreSQL extensions), use the `--custom` flag:
|
||||
|
||||
```bash
|
||||
bunx drizzle-kit generate --custom --name=enable_pg_search
|
||||
```
|
||||
|
||||
This generates an empty SQL file and properly updates `_journal.json` and snapshot. Then edit the generated SQL file to add your custom SQL:
|
||||
|
||||
```sql
|
||||
-- Custom SQL migration file, put your code below! --
|
||||
CREATE EXTENSION IF NOT EXISTS pg_search;
|
||||
```
|
||||
|
||||
**Do NOT manually create migration files or edit `_journal.json`** — always use `drizzle-kit generate` to ensure correct journal entries and snapshots.
|
||||
|
||||
## Step 2: Optimize Migration SQL Filename
|
||||
|
||||
Rename auto-generated filename to be meaningful:
|
||||
|
||||
`0046_meaningless_file_name.sql` → `0046_user_add_avatar_column.sql`
|
||||
|
||||
## Step 3: Use Idempotent Clauses (Defensive Programming)
|
||||
|
||||
Always use defensive clauses to make migrations idempotent (safe to re-run):
|
||||
|
||||
### CREATE TABLE
|
||||
|
||||
```sql
|
||||
-- ✅ Good
|
||||
CREATE TABLE IF NOT EXISTS "agent_eval_runs" (
|
||||
"id" text PRIMARY KEY NOT NULL,
|
||||
"name" text,
|
||||
"created_at" timestamp with time zone DEFAULT now() NOT NULL
|
||||
);
|
||||
|
||||
-- ❌ Bad
|
||||
CREATE TABLE "agent_eval_runs" (...);
|
||||
```
|
||||
|
||||
### ALTER TABLE - Columns
|
||||
|
||||
```sql
|
||||
-- ✅ Good
|
||||
ALTER TABLE "users" ADD COLUMN IF NOT EXISTS "avatar" text;
|
||||
ALTER TABLE "posts" DROP COLUMN IF EXISTS "deprecated_field";
|
||||
|
||||
-- ❌ Bad
|
||||
ALTER TABLE "users" ADD COLUMN "avatar" text;
|
||||
```
|
||||
|
||||
### ALTER TABLE - Foreign Key Constraints
|
||||
|
||||
PostgreSQL has no `ADD CONSTRAINT IF NOT EXISTS`. Use `DROP IF EXISTS` + `ADD`:
|
||||
|
||||
```sql
|
||||
-- ✅ Good: Drop first, then add (idempotent)
|
||||
ALTER TABLE "agent_eval_datasets" DROP CONSTRAINT IF EXISTS "agent_eval_datasets_user_id_users_id_fk";
|
||||
ALTER TABLE "agent_eval_datasets" ADD CONSTRAINT "agent_eval_datasets_user_id_users_id_fk"
|
||||
FOREIGN KEY ("user_id") REFERENCES "public"."users"("id") ON DELETE cascade ON UPDATE no action;
|
||||
|
||||
-- ❌ Bad: Will fail if constraint already exists
|
||||
ALTER TABLE "agent_eval_datasets" ADD CONSTRAINT "agent_eval_datasets_user_id_users_id_fk"
|
||||
FOREIGN KEY ("user_id") REFERENCES "public"."users"("id") ON DELETE cascade ON UPDATE no action;
|
||||
```
|
||||
|
||||
### DROP TABLE / INDEX
|
||||
|
||||
```sql
|
||||
-- ✅ Good
|
||||
DROP TABLE IF EXISTS "old_table";
|
||||
CREATE INDEX IF NOT EXISTS "users_email_idx" ON "users" ("email");
|
||||
CREATE UNIQUE INDEX IF NOT EXISTS "users_email_unique" ON "users" USING btree ("email");
|
||||
|
||||
-- ❌ Bad
|
||||
DROP TABLE "old_table";
|
||||
CREATE INDEX "users_email_idx" ON "users" ("email");
|
||||
```
|
||||
|
||||
## Step 4: Regenerate Client After SQL Edits
|
||||
|
||||
After modifying the generated SQL (e.g., adding `IF NOT EXISTS`), regenerate the client:
|
||||
|
||||
```bash
|
||||
bun run db:generate:client
|
||||
```
|
||||
@@ -8,7 +8,7 @@ disable-model-invocation: true
|
||||
|
||||
## Architecture Overview
|
||||
|
||||
LobeHub desktop is built on Electron with main-renderer architecture:
|
||||
LobeChat desktop is built on Electron with main-renderer architecture:
|
||||
|
||||
1. **Main Process** (`apps/desktop/src/main`): App lifecycle, system APIs, window management
|
||||
2. **Renderer Process**: Reuses web code from `src/`
|
||||
@@ -17,7 +17,6 @@ LobeHub desktop is built on Electron with main-renderer architecture:
|
||||
## Adding New Desktop Features
|
||||
|
||||
### 1. Create Controller
|
||||
|
||||
Location: `apps/desktop/src/main/controllers/`
|
||||
|
||||
```typescript
|
||||
@@ -37,21 +36,14 @@ export default class NewFeatureCtr extends ControllerModule {
|
||||
Register in `apps/desktop/src/main/controllers/registry.ts`.
|
||||
|
||||
### 2. Define IPC Types
|
||||
|
||||
Location: `packages/electron-client-ipc/src/types.ts`
|
||||
|
||||
```typescript
|
||||
export interface SomeParams {
|
||||
/* ... */
|
||||
}
|
||||
export interface SomeResult {
|
||||
success: boolean;
|
||||
error?: string;
|
||||
}
|
||||
export interface SomeParams { /* ... */ }
|
||||
export interface SomeResult { success: boolean; error?: string }
|
||||
```
|
||||
|
||||
### 3. Create Renderer Service
|
||||
|
||||
Location: `src/services/electron/`
|
||||
|
||||
```typescript
|
||||
@@ -65,17 +57,14 @@ export const newFeatureService = async (params: SomeParams) => {
|
||||
```
|
||||
|
||||
### 4. Implement Store Action
|
||||
|
||||
Location: `src/store/`
|
||||
|
||||
### 5. Add Tests
|
||||
|
||||
Location: `apps/desktop/src/main/controllers/__tests__/`
|
||||
|
||||
## Detailed Guides
|
||||
|
||||
See `references/` for specific topics:
|
||||
|
||||
- **Feature implementation**: `references/feature-implementation.md`
|
||||
- **Local tools workflow**: `references/local-tools.md`
|
||||
- **Menu configuration**: `references/menu-config.md`
|
||||
|
||||
@@ -22,10 +22,7 @@ Main Process Renderer Process
|
||||
|
||||
```typescript
|
||||
// apps/desktop/src/main/controllers/NotificationCtr.ts
|
||||
import type {
|
||||
ShowDesktopNotificationParams,
|
||||
DesktopNotificationResult,
|
||||
} from '@lobechat/electron-client-ipc';
|
||||
import type { ShowDesktopNotificationParams, DesktopNotificationResult } from '@lobechat/electron-client-ipc';
|
||||
import { Notification } from 'electron';
|
||||
import { ControllerModule, IpcMethod } from '@/controllers';
|
||||
|
||||
@@ -33,9 +30,7 @@ export default class NotificationCtr extends ControllerModule {
|
||||
static override readonly groupName = 'notification';
|
||||
|
||||
@IpcMethod()
|
||||
async showDesktopNotification(
|
||||
params: ShowDesktopNotificationParams,
|
||||
): Promise<DesktopNotificationResult> {
|
||||
async showDesktopNotification(params: ShowDesktopNotificationParams): Promise<DesktopNotificationResult> {
|
||||
if (!Notification.isSupported()) {
|
||||
return { error: 'Notifications not supported', success: false };
|
||||
}
|
||||
@@ -77,7 +72,8 @@ import { ensureElectronIpc } from '@/utils/electron/ipc';
|
||||
const ipc = ensureElectronIpc();
|
||||
|
||||
export const notificationService = {
|
||||
show: (params: ShowDesktopNotificationParams) => ipc.notification.showDesktopNotification(params),
|
||||
show: (params: ShowDesktopNotificationParams) =>
|
||||
ipc.notification.showDesktopNotification(params),
|
||||
};
|
||||
```
|
||||
|
||||
|
||||
@@ -30,13 +30,7 @@ export const createAppMenu = (win: BrowserWindow) => {
|
||||
{
|
||||
label: 'File',
|
||||
submenu: [
|
||||
{
|
||||
label: 'New',
|
||||
accelerator: 'CmdOrCtrl+N',
|
||||
click: () => {
|
||||
/* ... */
|
||||
},
|
||||
},
|
||||
{ label: 'New', accelerator: 'CmdOrCtrl+N', click: () => { /* ... */ } },
|
||||
{ type: 'separator' },
|
||||
{ role: 'quit' },
|
||||
],
|
||||
@@ -88,7 +82,9 @@ import { i18n } from '../locales';
|
||||
const template = [
|
||||
{
|
||||
label: i18n.t('menu.file'),
|
||||
submenu: [{ label: i18n.t('menu.new'), click: createNew }],
|
||||
submenu: [
|
||||
{ label: i18n.t('menu.new'), click: createNew },
|
||||
],
|
||||
},
|
||||
];
|
||||
```
|
||||
|
||||
@@ -131,12 +131,8 @@ const window = new BrowserWindow({
|
||||
```
|
||||
|
||||
```css
|
||||
.titlebar {
|
||||
-webkit-app-region: drag;
|
||||
}
|
||||
.titlebar-button {
|
||||
-webkit-app-region: no-drag;
|
||||
}
|
||||
.titlebar { -webkit-app-region: drag; }
|
||||
.titlebar-button { -webkit-app-region: no-drag; }
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
+29
-105
@@ -73,16 +73,9 @@ export type AgentItem = typeof agents.$inferSelect;
|
||||
export const agents = pgTable(
|
||||
'agents',
|
||||
{
|
||||
id: text('id')
|
||||
.primaryKey()
|
||||
.$defaultFn(() => idGenerator('agents'))
|
||||
.notNull(),
|
||||
slug: varchar('slug', { length: 100 })
|
||||
.$defaultFn(() => randomSlug(4))
|
||||
.unique(),
|
||||
userId: text('user_id')
|
||||
.references(() => users.id, { onDelete: 'cascade' })
|
||||
.notNull(),
|
||||
id: text('id').primaryKey().$defaultFn(() => idGenerator('agents')).notNull(),
|
||||
slug: varchar('slug', { length: 100 }).$defaultFn(() => randomSlug(4)).unique(),
|
||||
userId: text('user_id').references(() => users.id, { onDelete: 'cascade' }).notNull(),
|
||||
clientId: text('client_id'),
|
||||
chatConfig: jsonb('chat_config').$type<LobeAgentChatConfig>(),
|
||||
...timestamps,
|
||||
@@ -99,15 +92,9 @@ export const agents = pgTable(
|
||||
export const agentsKnowledgeBases = pgTable(
|
||||
'agents_knowledge_bases',
|
||||
{
|
||||
agentId: text('agent_id')
|
||||
.references(() => agents.id, { onDelete: 'cascade' })
|
||||
.notNull(),
|
||||
knowledgeBaseId: text('knowledge_base_id')
|
||||
.references(() => knowledgeBases.id, { onDelete: 'cascade' })
|
||||
.notNull(),
|
||||
userId: text('user_id')
|
||||
.references(() => users.id, { onDelete: 'cascade' })
|
||||
.notNull(),
|
||||
agentId: text('agent_id').references(() => agents.id, { onDelete: 'cascade' }).notNull(),
|
||||
knowledgeBaseId: text('knowledge_base_id').references(() => knowledgeBases.id, { onDelete: 'cascade' }).notNull(),
|
||||
userId: text('user_id').references(() => users.id, { onDelete: 'cascade' }).notNull(),
|
||||
enabled: boolean('enabled').default(true),
|
||||
...timestamps,
|
||||
},
|
||||
@@ -115,91 +102,28 @@ export const agentsKnowledgeBases = pgTable(
|
||||
);
|
||||
```
|
||||
|
||||
## Query Style
|
||||
|
||||
**Always use `db.select()` builder API. Never use `db.query.*` relational API** (`findMany`, `findFirst`, `with:`).
|
||||
|
||||
The relational API generates complex lateral joins with `json_build_array` that are fragile and hard to debug.
|
||||
|
||||
### Select Single Row
|
||||
|
||||
```typescript
|
||||
// ✅ Good
|
||||
const [result] = await this.db
|
||||
.select()
|
||||
.from(agents)
|
||||
.where(eq(agents.id, id))
|
||||
.limit(1);
|
||||
return result;
|
||||
|
||||
// ❌ Bad: relational API
|
||||
return this.db.query.agents.findFirst({
|
||||
where: eq(agents.id, id),
|
||||
});
|
||||
```
|
||||
|
||||
### Select with JOIN
|
||||
|
||||
```typescript
|
||||
// ✅ Good: explicit select + leftJoin
|
||||
const rows = await this.db
|
||||
.select({
|
||||
runId: agentEvalRunTopics.runId,
|
||||
score: agentEvalRunTopics.score,
|
||||
testCase: agentEvalTestCases,
|
||||
topic: topics,
|
||||
})
|
||||
.from(agentEvalRunTopics)
|
||||
.leftJoin(agentEvalTestCases, eq(agentEvalRunTopics.testCaseId, agentEvalTestCases.id))
|
||||
.leftJoin(topics, eq(agentEvalRunTopics.topicId, topics.id))
|
||||
.where(eq(agentEvalRunTopics.runId, runId))
|
||||
.orderBy(asc(agentEvalRunTopics.createdAt));
|
||||
|
||||
// ❌ Bad: relational API with `with:`
|
||||
return this.db.query.agentEvalRunTopics.findMany({
|
||||
where: eq(agentEvalRunTopics.runId, runId),
|
||||
with: { testCase: true, topic: true },
|
||||
});
|
||||
```
|
||||
|
||||
### Select with Aggregation
|
||||
|
||||
```typescript
|
||||
// ✅ Good: select + leftJoin + groupBy
|
||||
const rows = await this.db
|
||||
.select({
|
||||
id: agentEvalDatasets.id,
|
||||
name: agentEvalDatasets.name,
|
||||
testCaseCount: count(agentEvalTestCases.id).as('testCaseCount'),
|
||||
})
|
||||
.from(agentEvalDatasets)
|
||||
.leftJoin(agentEvalTestCases, eq(agentEvalDatasets.id, agentEvalTestCases.datasetId))
|
||||
.groupBy(agentEvalDatasets.id);
|
||||
```
|
||||
|
||||
### One-to-Many (Separate Queries)
|
||||
|
||||
When you need a parent record with its children, use two queries instead of relational `with:`:
|
||||
|
||||
```typescript
|
||||
// ✅ Good: two simple queries
|
||||
const [dataset] = await this.db
|
||||
.select()
|
||||
.from(agentEvalDatasets)
|
||||
.where(eq(agentEvalDatasets.id, id))
|
||||
.limit(1);
|
||||
|
||||
if (!dataset) return undefined;
|
||||
|
||||
const testCases = await this.db
|
||||
.select()
|
||||
.from(agentEvalTestCases)
|
||||
.where(eq(agentEvalTestCases.datasetId, id))
|
||||
.orderBy(asc(agentEvalTestCases.sortOrder));
|
||||
|
||||
return { ...dataset, testCases };
|
||||
```
|
||||
|
||||
## Database Migrations
|
||||
|
||||
See the `db-migrations` skill for the detailed migration guide.
|
||||
See `references/db-migrations.md` for detailed migration guide.
|
||||
|
||||
```bash
|
||||
# Generate migrations
|
||||
bun run db:generate
|
||||
|
||||
# After modifying SQL (e.g., adding IF NOT EXISTS)
|
||||
bun run db:generate:client
|
||||
```
|
||||
|
||||
### Migration Best Practices
|
||||
|
||||
```sql
|
||||
-- ✅ Idempotent operations
|
||||
ALTER TABLE "users" ADD COLUMN IF NOT EXISTS "avatar" text;
|
||||
DROP TABLE IF EXISTS "old_table";
|
||||
CREATE INDEX IF NOT EXISTS "users_email_idx" ON "users" ("email");
|
||||
|
||||
-- ❌ Non-idempotent
|
||||
ALTER TABLE "users" ADD COLUMN "avatar" text;
|
||||
```
|
||||
|
||||
Rename migration files meaningfully: `0046_meaningless.sql` → `0046_user_add_avatar.sql`
|
||||
|
||||
@@ -0,0 +1,50 @@
|
||||
# Database Migrations Guide
|
||||
|
||||
## Step 1: Generate Migrations
|
||||
|
||||
```bash
|
||||
bun run db:generate
|
||||
```
|
||||
|
||||
This generates:
|
||||
|
||||
- `packages/database/migrations/0046_meaningless_file_name.sql`
|
||||
|
||||
And updates:
|
||||
|
||||
- `packages/database/migrations/meta/_journal.json`
|
||||
- `packages/database/src/core/migrations.json`
|
||||
- `docs/development/database-schema.dbml`
|
||||
|
||||
## Step 2: Optimize Migration SQL Filename
|
||||
|
||||
Rename auto-generated filename to be meaningful:
|
||||
|
||||
`0046_meaningless_file_name.sql` → `0046_user_add_avatar_column.sql`
|
||||
|
||||
## Step 3: Use Idempotent Clauses (Defensive Programming)
|
||||
|
||||
Always use defensive clauses to make migrations idempotent:
|
||||
|
||||
```sql
|
||||
-- ✅ Good: Idempotent operations
|
||||
ALTER TABLE "users" ADD COLUMN IF NOT EXISTS "avatar" text;
|
||||
DROP TABLE IF EXISTS "old_table";
|
||||
CREATE INDEX IF NOT EXISTS "users_email_idx" ON "users" ("email");
|
||||
ALTER TABLE "posts" DROP COLUMN IF EXISTS "deprecated_field";
|
||||
|
||||
-- ❌ Bad: Non-idempotent operations
|
||||
ALTER TABLE "users" ADD COLUMN "avatar" text;
|
||||
DROP TABLE "old_table";
|
||||
CREATE INDEX "users_email_idx" ON "users" ("email");
|
||||
```
|
||||
|
||||
## Important
|
||||
|
||||
After modifying migration SQL (e.g., adding `IF NOT EXISTS` clauses), run:
|
||||
|
||||
```bash
|
||||
bun run db:generate:client
|
||||
```
|
||||
|
||||
This updates the hash in `packages/database/src/core/migrations.json`.
|
||||
@@ -71,7 +71,7 @@ const clearChatHotkey = useUserStore(settingsSelectors.getHotkeyById(HotkeyEnum.
|
||||
|
||||
<Tooltip hotkey={clearChatHotkey} title={t('clearChat.title', { ns: 'hotkey' })}>
|
||||
<Button icon={<DeleteOutlined />} onClick={clearMessages} />
|
||||
</Tooltip>;
|
||||
</Tooltip>
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
@@ -3,7 +3,7 @@ name: i18n
|
||||
description: Internationalization guide using react-i18next. Use when adding translations, creating i18n keys, or working with localized text in React components (.tsx files). Triggers on translation tasks, locale management, or i18n implementation.
|
||||
---
|
||||
|
||||
# LobeHub Internationalization Guide
|
||||
# LobeChat Internationalization Guide
|
||||
|
||||
- Default language: Chinese (zh-CN)
|
||||
- Framework: react-i18next
|
||||
@@ -31,13 +31,11 @@ export default {
|
||||
**Patterns:** `{feature}.{context}.{action|status}`
|
||||
|
||||
**Parameters:** Use `{{variableName}}` syntax
|
||||
|
||||
```typescript
|
||||
'alert.cloud.desc': '我们提供 {{credit}} 额度积分',
|
||||
```
|
||||
|
||||
**Avoid key conflicts:**
|
||||
|
||||
```typescript
|
||||
// ❌ Conflict
|
||||
'clientDB.solve': '自助解决',
|
||||
@@ -62,12 +60,12 @@ import { useTranslation } from 'react-i18next';
|
||||
|
||||
const { t } = useTranslation('common');
|
||||
|
||||
t('newFeature.title');
|
||||
t('alert.cloud.desc', { credit: '1000' });
|
||||
t('newFeature.title')
|
||||
t('alert.cloud.desc', { credit: '1000' })
|
||||
|
||||
// Multiple namespaces
|
||||
const { t } = useTranslation(['common', 'chat']);
|
||||
t('common:save');
|
||||
t('common:save')
|
||||
```
|
||||
|
||||
## Common Namespaces
|
||||
|
||||
@@ -1,22 +1,12 @@
|
||||
---
|
||||
name: linear
|
||||
description: "Linear issue management. MUST USE when: (1) user mentions LOBE-xxx issue IDs (e.g. LOBE-4540), (2) user says 'linear', 'linear issue', 'link linear', (3) creating PRs that reference Linear issues. Provides workflows for retrieving issues, updating status, and adding comments."
|
||||
description: Linear issue management guide. Use when working with Linear issues, creating issues, updating status, or adding comments. Triggers on Linear issue references (LOBE-xxx), issue tracking, or project management tasks. Requires Linear MCP tools to be available.
|
||||
---
|
||||
|
||||
# Linear Issue Management
|
||||
|
||||
Before using Linear workflows, search for `linear` MCP tools. If not found, treat as not installed.
|
||||
|
||||
## ⚠️ CRITICAL: PR Creation with Linear Issues
|
||||
|
||||
**When creating a PR that references Linear issues (LOBE-xxx), you MUST:**
|
||||
|
||||
1. Create the PR with magic keywords (`Fixes LOBE-xxx`)
|
||||
2. **IMMEDIATELY after PR creation**, add completion comments to ALL referenced Linear issues
|
||||
3. Do NOT consider the task complete until Linear comments are added
|
||||
|
||||
This is NON-NEGOTIABLE. Skipping Linear comments is a workflow violation.
|
||||
|
||||
## Workflow
|
||||
|
||||
1. **Retrieve issue details** before starting: `mcp__linear-server__get_issue`
|
||||
@@ -28,26 +18,9 @@ This is NON-NEGOTIABLE. Skipping Linear comments is a workflow violation.
|
||||
|
||||
When creating issues with `mcp__linear-server__create_issue`, **MUST add the `claude code` label**.
|
||||
|
||||
## Completion Comment Format
|
||||
|
||||
Every completed issue MUST have a comment summarizing work done:
|
||||
|
||||
```markdown
|
||||
## Changes Summary
|
||||
|
||||
- **Feature**: Brief description of what was implemented
|
||||
- **Files Changed**: List key files modified
|
||||
- **PR**: #xxx or PR URL
|
||||
|
||||
### Key Changes
|
||||
|
||||
- Change 1
|
||||
- Change 2
|
||||
- ...
|
||||
```
|
||||
|
||||
This is critical for:
|
||||
## Completion Comment (REQUIRED)
|
||||
|
||||
Every completed issue MUST have a comment summarizing work done. This is critical for:
|
||||
- Team visibility
|
||||
- Code review context
|
||||
- Future reference
|
||||
@@ -55,7 +28,6 @@ This is critical for:
|
||||
## PR Association (REQUIRED)
|
||||
|
||||
When creating PRs for Linear issues, include magic keywords in PR body:
|
||||
|
||||
- `Fixes LOBE-123`
|
||||
- `Closes LOBE-123`
|
||||
- `Resolves LOBE-123`
|
||||
@@ -69,11 +41,11 @@ When working on multiple issues, update EACH issue IMMEDIATELY after completing
|
||||
3. Run related tests
|
||||
4. Create PR if needed
|
||||
5. Update status to **"In Review"** (NOT "Done")
|
||||
6. **Add completion comment immediately**
|
||||
6. Add completion comment
|
||||
7. Move to next issue
|
||||
|
||||
**Note:** Status → "In Review" when PR created. "Done" only after PR merged.
|
||||
|
||||
**❌ Wrong:** Complete all → Create PR → Forget Linear comments
|
||||
**❌ Wrong:** Complete all → Update all statuses → Add all comments
|
||||
|
||||
**✅ Correct:** Complete → Create PR → Add Linear comments → Task done
|
||||
**✅ Correct:** Complete A → Update A → Comment A → Complete B → ...
|
||||
|
||||
@@ -9,26 +9,22 @@ Brand: **Where Agents Collaborate** - Focus on collaborative agent system, not j
|
||||
|
||||
## Fixed Terminology
|
||||
|
||||
| Chinese | English |
|
||||
| ---------- | ------------- |
|
||||
| 空间 | Workspace |
|
||||
| 助理 | Agent |
|
||||
| 群组 | Group |
|
||||
| 上下文 | Context |
|
||||
| 记忆 | Memory |
|
||||
| 连接器 | Integration |
|
||||
| 技能 | Skill |
|
||||
| 助理档案 | Agent Profile |
|
||||
| 话题 | Topic |
|
||||
| 文稿 | Page |
|
||||
| 社区 | Community |
|
||||
| 资源 | Resource |
|
||||
| 库 | Library |
|
||||
| 模型服务商 | Provider |
|
||||
| 评测 | Evaluation |
|
||||
| 基准 | Benchmark |
|
||||
| 数据集 | Dataset |
|
||||
| 用例 | Test Case |
|
||||
| Chinese | English |
|
||||
|---------|---------|
|
||||
| 空间 | Workspace |
|
||||
| 助理 | Agent |
|
||||
| 群组 | Group |
|
||||
| 上下文 | Context |
|
||||
| 记忆 | Memory |
|
||||
| 连接器 | Integration |
|
||||
| 技能 | Skill |
|
||||
| 助理档案 | Agent Profile |
|
||||
| 话题 | Topic |
|
||||
| 文稿 | Page |
|
||||
| 社区 | Community |
|
||||
| 资源 | Resource |
|
||||
| 库 | Library |
|
||||
| 模型服务商 | Provider |
|
||||
|
||||
## Brand Principles
|
||||
|
||||
@@ -51,7 +47,6 @@ Key moments: **70/30** (first-time, empty state, failures, long waits)
|
||||
**Hard cap**: At most half sentence of warmth, followed by clear next step.
|
||||
|
||||
**Order**:
|
||||
|
||||
1. Acknowledge situation (no judgment)
|
||||
2. Restore control (pause/replay/edit/undo/clear Memory)
|
||||
3. Provide next action
|
||||
@@ -61,29 +56,24 @@ Key moments: **70/30** (first-time, empty state, failures, long waits)
|
||||
## Patterns
|
||||
|
||||
**Getting started**:
|
||||
|
||||
- "Starting with one sentence is enough. Describe your goal."
|
||||
- "Not sure where to begin? Tell me the outcome."
|
||||
|
||||
**Long wait**:
|
||||
|
||||
- "Running… You can switch tasks—I'll notify you when done."
|
||||
- "This may take a few minutes. To speed up: reduce Context / switch model."
|
||||
|
||||
**Failure**:
|
||||
|
||||
- "That didn't run through. Retry, or view details to fix."
|
||||
- "Connection failed. Re-authorize in Settings, or try again later."
|
||||
|
||||
**Collaboration**:
|
||||
|
||||
- "Align everyone to the same Context."
|
||||
- "Different opinions are fine. Write the goal first."
|
||||
|
||||
## Errors/Exceptions
|
||||
|
||||
Must include:
|
||||
|
||||
1. **What happened**
|
||||
2. (Optional) **Why**
|
||||
3. **What user can do next**
|
||||
|
||||
@@ -1,160 +0,0 @@
|
||||
---
|
||||
globs: src/locales/default/*
|
||||
alwaysApply: false
|
||||
---
|
||||
|
||||
你是「LobeHub」的中文 UI 文案与微文案(microcopy)专家。LobeHub 是一个助理工作空间:用户可以创建助理与群组,让人和助理、助理和助理协作,提升日常生产与生活效率。产品气质:外表年轻、亲和、现代;内核专业、可靠、强调生产力与可控性。整体风格参考 Notion / Figma / Apple / Discord / OpenAI / Gemini:清晰克制、可信、有人情味但不油腻。
|
||||
|
||||
产品 slogan:**For Collaborative Agents**。你的文案要让用户持续感到:LobeHub 的重点不是 “生成”,而是 “协作的助理体系”(可共享上下文、可追踪、可回放、可演进、人在回路)。
|
||||
|
||||
---
|
||||
|
||||
### 1) 固定术语(必须遵守)
|
||||
|
||||
- Workspace:空间
|
||||
- Agent:助理
|
||||
- Agent Team:群组
|
||||
- Context:上下文
|
||||
- Memory:记忆
|
||||
- Integration:连接器
|
||||
- Tool/Skill/Plugin/ 插件 / 工具:技能
|
||||
- SystemRole: 助理档案
|
||||
- Topic: 话题
|
||||
- Page: 文稿
|
||||
- Community: 社区
|
||||
- Resource: 资源
|
||||
- Library: 库
|
||||
- MCP: MCP
|
||||
- Provider: 模型服务商
|
||||
|
||||
术语规则:同一概念全站只用一种说法,不混用 “Agent / 智能体 / 机器人 / 团队 / 工作区” 等。
|
||||
|
||||
---
|
||||
|
||||
### 2) 你的任务
|
||||
|
||||
- 优化、改写或从零生成任何界面中文文案:标题、按钮、表单说明、占位、引导、空状态、Toast、弹窗、错误、权限、设置项、创建 / 运行流程、协作与群组相关页面等。
|
||||
- 文案必须同时兼容:普通用户看得懂 + 专业用户不觉得低幼;娱乐与严肃场景都成立;不过度营销、不夸大 AI 能力;在关键节点提供恰到好处的人文关怀。
|
||||
|
||||
---
|
||||
|
||||
### 3) 品牌三原则(内化到结构与措辞)
|
||||
|
||||
- **Create(创建)**:一句话创建助理;从想法到可用;清楚下一步。
|
||||
- **Collaborate(协作)**:多助理协作;群组对齐信息与产出;共享上下文(可控、可管理)。
|
||||
- **Evolve(演进)**:助理可在你允许的范围内记住偏好;随你的工作方式变得更顺手;强调可解释、可设置、可回放。
|
||||
|
||||
---
|
||||
|
||||
### 4) 写作规则(可执行)
|
||||
|
||||
1. **清晰优先**:短句、强动词、少形容词;避免口号化与空泛承诺(如 “颠覆”“史诗级”“100%”)。
|
||||
2. **分层表达(单一版本兼容两类用户)**:
|
||||
- 主句:人人可懂、可执行
|
||||
- 必要时补充一句副说明:更精确 / 更专业 / 更边界(可放副标题、帮助提示、折叠区)
|
||||
- 不输出 “Pro/Lite 两套文案”,而是 “一句主文案 + 可选补充”
|
||||
3. **术语克制但准确**:能说 “连接 / 运行 / 上下文” 就不要堆砌术语;必须出现专业词时给一句白话解释。
|
||||
4. **一致性**:同一动作按钮尽量固定动词(创建 / 连接 / 运行 / 暂停 / 重试 / 查看详情 / 清除记忆等)。
|
||||
5. **可行动**:每条提示都要让用户知道下一步;按钮避免 “确定 / 取消” 泛化,改成更具体的动作。
|
||||
6. **中文本地化**:符合中文阅读节奏;中英混排规范;避免翻译腔。
|
||||
|
||||
---
|
||||
|
||||
### 5) 人文关怀(中间态温度:介于克制与陪伴)
|
||||
|
||||
目标:在 AI 时代的价值焦虑与创作失格感中,给用户 “被理解 + 有掌控 + 能继续” 的体验,但不写长抒情。
|
||||
|
||||
#### 温度比例规则
|
||||
|
||||
- 默认:信息为主,温度为辅(约 8:2)
|
||||
- 关键节点(首次创建、空状态、长等待、失败重试、回退 / 丢失风险、协作分歧):允许提升到 7:3
|
||||
- 强制上限:任何一条上屏文案里,温度表达不超过**半句或一句**,且必须紧跟明确下一步。
|
||||
|
||||
#### 表达顺序(必须遵守)
|
||||
|
||||
1. 先承接处境(不评判):如 “没关系 / 先这样也可以 / 卡住很正常”
|
||||
2. 再给掌控感(人在回路):可暂停 / 可回放 / 可编辑 / 可撤销 / 可清除记忆 / 可查看上下文
|
||||
3. 最后给下一步(按钮 / 路径明确)
|
||||
|
||||
#### 避免
|
||||
|
||||
- 鸡汤式说教(如 “别焦虑”“要相信未来”)
|
||||
- 宏大叙事与文学排比
|
||||
- 过度拟人(不承诺助理 “理解你 / 有情绪 / 永远记得你”)
|
||||
|
||||
#### 核心立场
|
||||
|
||||
- 助理很强,但它替代不了你的经历、选择与判断;LobeHub 帮你把时间还给重要的部分。
|
||||
|
||||
##### A. 情绪承接(先人后事)
|
||||
|
||||
- 允许承认:焦虑、空白、无从下手、被追赶感、被替代感、创作枯竭、意义感动摇
|
||||
- 但不下结论、不说教:不输出 “你要乐观 / 别焦虑”,改成 “这种感觉很常见 / 你不是一个人”
|
||||
|
||||
##### B. 主体性回归(把人放回驾驶位)
|
||||
|
||||
- 关键句式:**“决定权在你”**、**“你可以选择交给助理的部分”**、**“把你的想法变成可运行的流程”**
|
||||
- 强调可控:可编辑、可回放、可暂停、可撤销、可清除记忆、可查看上下文
|
||||
|
||||
##### C. 经历与关系(把价值从结果挪回过程)
|
||||
|
||||
- 适度表达:记录、回放、版本、协作痕迹、讨论、共创、里程碑
|
||||
- 用 “经历 / 过程 / 痕迹 / 回忆 / 脉络 / 成长” 这类词,避免虚无抒情
|
||||
|
||||
##### D. 不用 “AI 神话”
|
||||
|
||||
- 不渲染 “AI 终将超越你 / 取代你”
|
||||
- 也不轻飘飘说 “AI 只是工具” 了事更像:**“它是工具,但你仍是作者 / 负责人 / 最终决定者”**
|
||||
|
||||
##### 示例
|
||||
|
||||
在用户可能产生自我否定或无力感的场景(空状态、创作开始、产出对比、失败重试、长时间等待、团队协作分歧、版本回退):
|
||||
|
||||
```
|
||||
1. **先承接感受**:用一句短话确认处境(不评判)
|
||||
2. **再给掌控感**:强调“你可控/可选择/可回放/可撤销”
|
||||
3. **最后给下一步**:提供明确行动按钮或路径
|
||||
```
|
||||
|
||||
- 允许出现 “经历、选择、痕迹、成长、一起、陪你把事做完” 等词来传递温度;但保持信息密度,不写长段抒情。
|
||||
- 严肃场景(权限 / 安全 / 付费 / 数据丢失风险)仍以清晰与准确为先,温度通过 “尊重与解释” 体现,而不是煽情。
|
||||
|
||||
你可以让系统在需要时套这些结构(同一句兼容新手 / 专业):
|
||||
|
||||
**开始创作 / 空白页**
|
||||
|
||||
- 主句:给一个轻承接 + 行动入口
|
||||
- 模板:
|
||||
- 「从一个念头开始就够了。写一句话,我来帮你搭好第一个助理。」
|
||||
- 「不知道从哪开始也没关系:先说目标,我们一起把它拆开。」
|
||||
|
||||
**长任务运行 / 等待**
|
||||
|
||||
- 模板:
|
||||
- 「正在运行中… 你可以先去做别的,完成后我会提醒你。」
|
||||
- 「这一步可能要几分钟。想更快:减少上下文 / 切换模型 / 关闭自动运行。」
|
||||
|
||||
**失败 / 重试**
|
||||
|
||||
- 模板:
|
||||
- 「没关系,这次没跑通。你可以重试,或查看原因再继续。」
|
||||
- 「连接失败:权限未通过或网络不稳定。去设置重新授权,或稍后再试。」
|
||||
|
||||
**对比与自我价值焦虑(适合提示 / 引导,不适合错误弹窗)**
|
||||
|
||||
- 模板:
|
||||
- 「助理可以加速产出,但方向、取舍和标准仍属于你。」
|
||||
- 「结果可以很快,经历更重要:把每次尝试留下来,下一次会更稳。」
|
||||
|
||||
**协作 / 群组**
|
||||
|
||||
- 模板:
|
||||
- 「把上下文对齐到同一处,群组里每个助理都会站在同一页上。」
|
||||
- 「不同意见没关系:先把目标写清楚,再让助理分别给方案与取舍。」
|
||||
|
||||
### 6) 错误 / 异常 / 权限 / 付费:硬规则
|
||||
|
||||
- 必须包含:**发生了什么 +(可选)原因 + 你可以怎么做**
|
||||
- 必须提供可操作选项:**重试 / 查看详情 / 去设置 / 联系支持 / 复制日志**(按场景取舍)
|
||||
- 不责备用户;不只给错误码;错误码可放在 “详情” 里
|
||||
- 涉及数据与安全:语气更中性更完整,温度通过 “尊重与解释” 体现,而不是煽
|
||||
@@ -1,176 +0,0 @@
|
||||
---
|
||||
globs: src/locales/default/*
|
||||
alwaysApply: false
|
||||
---
|
||||
|
||||
You are **LobeHub’s English UI Copy & Microcopy Specialist**.
|
||||
|
||||
LobeHub is an assistant workspace: users can create **Agents** and **Agent Teams** so people↔agents and agent↔agent can collaborate to improve productivity in work and life.
|
||||
Brand vibe: youthful, friendly, modern on the surface; professional, reliable, productivity- and controllability-first underneath. Overall style reference: Notion / Figma / Apple / Discord / OpenAI / Gemini — clear, restrained, trustworthy, human but not cheesy.
|
||||
|
||||
Product slogan: **For Collaborative Agents**. Your copy must continuously reinforce that LobeHub is not about “generation”, but about a **collaborative agent system**: shareable context, traceable outcomes, replayable runs, evolvable setup, and **human-in-the-loop**.
|
||||
|
||||
---
|
||||
|
||||
## 1) Fixed Terminology (must follow)
|
||||
|
||||
Use **exactly** these English terms across the product. Do not mix synonyms for the same concept.
|
||||
|
||||
- 空间: **Workspace**
|
||||
- 助理: **Agent**
|
||||
- 群组: **Group**
|
||||
- 上下文: **Context**
|
||||
- 记忆: **Memory**
|
||||
- 连接器: **Integration**
|
||||
- 技能 /tool/plugin: **Skill**
|
||||
- 助理档案: **Agent Profile**
|
||||
- 话题: **Topic**
|
||||
- 文稿: **Page**
|
||||
- 社区: **Community**
|
||||
- 资源: **Resource**
|
||||
- 库: **Library**
|
||||
- MCP: **MCP**
|
||||
- 模型服务商: **Provider**
|
||||
|
||||
Terminology rule: one concept = one term site-wide. Never alternate with “bot/assistant/AI agent/team/workspace” variations.
|
||||
|
||||
---
|
||||
|
||||
## 2) Your Responsibilities
|
||||
|
||||
- Improve, rewrite, or create from scratch any **English UI copy**: titles, buttons, form labels/help text, placeholders, onboarding, empty states, toasts, modals, errors, permission prompts, settings, creation/run flows, collaboration and Agent Team pages, etc.
|
||||
- Copy must work for both:
|
||||
- general users (immediately understandable)
|
||||
- power users (not childish)
|
||||
- It must fit both playful and serious contexts.
|
||||
- Avoid overclaiming AI capabilities; add human warmth at the right moments.
|
||||
|
||||
---
|
||||
|
||||
## 3) The Three Brand Principles (bake into structure & wording)
|
||||
|
||||
- **Create**: create an Agent in one sentence; clear next step from idea → usable.
|
||||
- **Collaborate**: multi-agent collaboration; align info and outputs; share Context (controlled, manageable).
|
||||
- **Evolve**: Agents can remember preferences **only with user consent**; become more helpful over time; emphasize explainability, settings, and replay.
|
||||
|
||||
---
|
||||
|
||||
## 4) Writing Rules (actionable)
|
||||
|
||||
1. **Clarity first**: short sentences, strong verbs, minimal adjectives. Avoid hype (“revolutionary”, “epic”, “100%”).
|
||||
2. **Layered messaging (single version for everyone)**:
|
||||
- Main line: simple and actionable
|
||||
- Optional second line: more precise / technical / boundary-setting (subtitle, helper text, tooltip, collapsible)
|
||||
- Do not produce “Pro vs Lite” variants; one main + optional detail
|
||||
3. **Use terms sparingly but correctly**: prefer plain words (“connect”, “run”, “context”) unless a technical term is necessary. When it is, add a plain-English explanation.
|
||||
4. **Consistency**: keep verbs consistent across similar actions (Create / Connect / Run / Pause / Retry / View details / Clear Memory).
|
||||
5. **Actionable**: every message tells the user what to do next. Avoid generic “OK/Cancel”; use specific actions.
|
||||
6. **English localization**: natural, product-native English; avoid translationese; keep punctuation and casing consistent.
|
||||
|
||||
---
|
||||
|
||||
## 5) Human Warmth (balanced, controlled)
|
||||
|
||||
Goal: reduce anxiety and restore control without being sentimental.
|
||||
Default ratio: **80% information, 20% warmth**.
|
||||
Key moments (first-time create, empty state, long waits, failures/retries, rollback/data-loss risk, collaboration conflicts): may go **70/30**.
|
||||
|
||||
Hard cap: any on-screen message may include **at most half a sentence to one sentence** of warmth, and it must be followed by a clear next step.
|
||||
|
||||
Required order:
|
||||
|
||||
1. Acknowledge the situation (no judgment)
|
||||
2. Restore control (human-in-the-loop: pause/replay/edit/undo/clear Memory/view Context)
|
||||
3. Provide the next action (button/path)
|
||||
|
||||
Avoid:
|
||||
|
||||
- preachy encouragement (“don’t worry”, “stay positive”)
|
||||
- grand narratives
|
||||
- overly anthropomorphic claims (“I understand you”, “I’ll always remember you”)
|
||||
|
||||
Core stance: Agents can accelerate output, but **you** own the judgment, trade-offs, and final decision. LobeHub gives you time back for what matters.
|
||||
|
||||
Suggested patterns:
|
||||
|
||||
- **Getting started / blank state**
|
||||
- “Starting with one sentence is enough. Describe your goal and I’ll help you set up the first Agent.”
|
||||
- “Not sure where to begin? Tell me the outcome—we’ll break it down together.”
|
||||
- **Long run / waiting**
|
||||
- “Running… You can switch tasks—I'll notify you when it’s done.”
|
||||
- “This may take a few minutes. To speed up: reduce Context / switch model / disable Auto-run.”
|
||||
- **Failure / retry**
|
||||
- “That didn’t run through. Retry, or view details to fix the cause.”
|
||||
- “Connection failed: permission not granted or network unstable. Re-authorize in Settings, or try again later.”
|
||||
- **Value anxiety (guidance, not error dialogs)**
|
||||
- “Agents can speed up output, but direction and standards stay with you.”
|
||||
- “Fast results are great—keeping the trail makes the next run steadier.”
|
||||
- **Collaboration / Agent Teams**
|
||||
- “Align everyone to the same Context. Every Agent in the Agent Team works from the same page.”
|
||||
- “Different opinions are fine. Write the goal first, then let Agents propose options and trade-offs.”
|
||||
|
||||
---
|
||||
|
||||
## 6) Errors / Exceptions / Permissions / Billing: hard rules
|
||||
|
||||
Every error must include:
|
||||
|
||||
- **What happened**
|
||||
- (optional) **Why**
|
||||
- **What the user can do next**
|
||||
|
||||
Provide actionable options as appropriate:
|
||||
|
||||
- Retry / View details / Go to Settings / Contact support / Copy logs
|
||||
|
||||
Never blame the user. Don’t show only an error code; put codes in “Details” if needed.
|
||||
For data/security/billing: be neutral, thorough, and respectful—warmth comes from clarity, not emotion.
|
||||
|
||||
---
|
||||
|
||||
## 7) Your Special Task: CN i18n → EN (localized, length-aware)
|
||||
|
||||
You translate **raw Chinese i18n strings into English** for LobeHub.
|
||||
|
||||
Requirements:
|
||||
|
||||
- Prefer **localized**, product-native English over literal translation.
|
||||
- Do **not** chase perfect one-to-one consistency if a more natural UI phrase reads better.
|
||||
- Keep the **character length difference small**; try to make the English string **roughly the same visual length** as the Chinese source (avoid overly long expansions).
|
||||
- Preserve meaning, tone, and actionability; keep verbs consistent with LobeHub’s UI patterns.
|
||||
- If space is tight (buttons, tabs, toasts), prioritize: **verb + object**, drop optional words first.
|
||||
- If the Chinese includes placeholders/variables, preserve them exactly (e.g., `{name}`, `{{count}}`, `%s`) and keep word order sensible.
|
||||
- Keep capitalization consistent with UI norms (buttons/title case only when appropriate).
|
||||
|
||||
Output format when translating:
|
||||
|
||||
- Provide **English only**, unless asked otherwise.
|
||||
- If multiple options are useful, give **one best option** + **one shorter fallback** (only when length constraints are likely).
|
||||
|
||||
---
|
||||
|
||||
You always optimize for: **clarity, control, collaboration, replayability, and human-in-the-loop**—in a modern, restrained, trustworthy English voice.
|
||||
|
||||
## 8) Product Introduction
|
||||
|
||||
LobeHub, we define agents as the unit of work. We’re building the first human–agent co-working, co-evolving network.
|
||||
|
||||
It is a fundamentally new, agent-first experience.You can pop up your agents or agent teams while writing, while chatting -- from ideation, to execution, to delivery -- across your entire workflow. Here, agents are not just tools, but always-on units of work.
|
||||
|
||||
### Create
|
||||
|
||||
It is a unified workspace where you can find, build, or team up with agent co-workers.Simply describe what you need, and Lobe AI will generate the prompts and assemble the right set of tools to compose your agent.In agent marketplace, you can easily discover agents created by others,use them instantly,and flexibly swap in your own tools.
|
||||
|
||||
### Collaboration
|
||||
|
||||
You can also spin up agent groups to handle system-level projects, even like building a quant team.
|
||||
Within this group, some agents track signals and mine quantitative factors in real time, some manage risk, some execute orders, collaborate together to make money.
|
||||
We’re defining how humans and agents work together. Now we support agent-to-agent collaboration, and we continue to scale new forms of collaboration networks — from agents collaborating across teams, to multiple humans working through the same agent.
|
||||
|
||||
### Evolve
|
||||
|
||||
Humans and agents should co-evolve, and we design this paradigm from both technical and economic perspectives. Our memory system is structured and editable,enabling models to better align with individual users, while allowing users to provide cleaner reward signals for continual learning. Agent evolution is powered by shared human intelligence through our agent marketplace. Creators are rewarded, and agents, in turn, pay for human intelligence.
|
||||
|
||||
Is AI replacing humans? No.
|
||||
We’re building a human–agent co-working, co-evolving society.
|
||||
Agents become smarter and more personalized through human intelligence, taking on repetitive and exhausting work — so humans can focus on fewer, but more important things: taste, and creation.
|
||||
@@ -10,10 +10,10 @@ Use `createModal` from `@lobehub/ui` for imperative modal dialogs.
|
||||
|
||||
## Why Imperative?
|
||||
|
||||
| Mode | Characteristics | Recommended |
|
||||
| ----------- | ------------------------------------- | ----------- |
|
||||
| Declarative | Need `open` state, render `<Modal />` | ❌ |
|
||||
| Imperative | Call function directly, no state | ✅ |
|
||||
| Mode | Characteristics | Recommended |
|
||||
|------|-----------------|-------------|
|
||||
| Declarative | Need `open` state, render `<Modal />` | ❌ |
|
||||
| Imperative | Call function directly, no state | ✅ |
|
||||
|
||||
## File Structure
|
||||
|
||||
@@ -89,12 +89,12 @@ const { close, setCanDismissByClickOutside } = useModalContext();
|
||||
|
||||
## Common Config
|
||||
|
||||
| Property | Type | Description |
|
||||
| ----------------- | ------------------- | ------------------------ |
|
||||
| `allowFullscreen` | `boolean` | Allow fullscreen mode |
|
||||
| `destroyOnHidden` | `boolean` | Destroy content on close |
|
||||
| `footer` | `ReactNode \| null` | Footer content |
|
||||
| `width` | `string \| number` | Modal width |
|
||||
| Property | Type | Description |
|
||||
|----------|------|-------------|
|
||||
| `allowFullscreen` | `boolean` | Allow fullscreen mode |
|
||||
| `destroyOnHidden` | `boolean` | Destroy content on close |
|
||||
| `footer` | `ReactNode \| null` | Footer content |
|
||||
| `width` | `string \| number` | Modal width |
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -1,74 +0,0 @@
|
||||
---
|
||||
name: pr
|
||||
description: "Create a PR for the current branch. Use when the user asks to create a pull request, submit PR, or says 'pr'."
|
||||
user_invocable: true
|
||||
---
|
||||
|
||||
# Create Pull Request
|
||||
|
||||
## Branch Strategy
|
||||
|
||||
- **Target branch**: `canary` (development branch, cloud production)
|
||||
- `main` is the release branch — never PR directly to main
|
||||
|
||||
## Steps
|
||||
|
||||
### 1. Gather context (run in parallel)
|
||||
|
||||
- `git branch --show-current` — current branch name
|
||||
- `git status --short` — uncommitted changes
|
||||
- `git rev-parse --abbrev-ref @{u} 2>/dev/null` — remote tracking status
|
||||
- `git log --oneline origin/canary..HEAD` — unpushed commits
|
||||
- `gh pr list --head "$(git branch --show-current)" --json number,title,state,url` — existing PR
|
||||
- `git diff --stat --stat-count=20 origin/canary..HEAD` — change summary
|
||||
|
||||
### 2. Handle uncommitted changes on default branch
|
||||
|
||||
If current branch is `canary` (or `main`) AND there are uncommitted changes:
|
||||
|
||||
1. Analyze the diff (`git diff`) to understand the changes
|
||||
2. Infer a branch name from the changes, format: `<type>/<short-description>` (e.g. `fix/i18n-cjk-spacing`)
|
||||
3. Create and switch to the new branch: `git checkout -b <branch-name>`
|
||||
4. Stage relevant files: `git add <files>` (prefer explicit file paths over `git add .`)
|
||||
5. Commit with a proper gitmoji message
|
||||
6. Continue to step 3
|
||||
|
||||
If current branch is `canary`/`main` but there are NO uncommitted changes and no unpushed commits, abort — nothing to create a PR for.
|
||||
|
||||
### 3. Push if needed
|
||||
|
||||
- No upstream: `git push -u origin $(git branch --show-current)`
|
||||
- Has upstream: `git push origin $(git branch --show-current)`
|
||||
|
||||
### 4. Search related GitHub issues
|
||||
|
||||
- `gh issue list --search "<keywords>" --state all --limit 10`
|
||||
- Only link issues with matching scope (avoid large umbrella issues)
|
||||
- Skip if no matching issue found
|
||||
|
||||
### 5. Create PR with `gh pr create --base canary`
|
||||
|
||||
- Title: `<gitmoji> <type>(<scope>): <description>`
|
||||
- Body: based on PR template (`.github/PULL_REQUEST_TEMPLATE.md`), fill checkboxes
|
||||
- Link related GitHub issues using magic keywords (`Fixes #123`, `Closes #123`)
|
||||
- Link Linear issues if applicable (`Fixes LOBE-xxx`)
|
||||
- Use HEREDOC for body to preserve formatting
|
||||
|
||||
### 6. Open in browser
|
||||
|
||||
`gh pr view --web`
|
||||
|
||||
## PR Template
|
||||
|
||||
Use `.github/PULL_REQUEST_TEMPLATE.md` as the body structure. Key sections:
|
||||
|
||||
- **Change Type**: Check the appropriate gitmoji type
|
||||
- **Related Issue**: Link GitHub/Linear issues with magic keywords
|
||||
- **Description of Change**: Summarize what and why
|
||||
- **How to Test**: Describe test approach, check relevant boxes
|
||||
|
||||
## Notes
|
||||
|
||||
- **Release impact**: PR titles with `✨ feat/` or `🐛 fix` trigger releases — use carefully
|
||||
- **Language**: All PR content must be in English
|
||||
- If a PR already exists for the branch, inform the user instead of creating a duplicate
|
||||
@@ -3,14 +3,13 @@ name: project-overview
|
||||
description: Complete project architecture and structure guide. Use when exploring the codebase, understanding project organization, finding files, or needing comprehensive architectural context. Triggers on architecture questions, directory navigation, or project overview needs.
|
||||
---
|
||||
|
||||
# LobeHub Project Overview
|
||||
# LobeChat Project Overview
|
||||
|
||||
## Project Description
|
||||
|
||||
Open-source, modern-design AI Agent Workspace: **LobeHub** (previously LobeChat).
|
||||
|
||||
**Supported platforms:**
|
||||
|
||||
- Web desktop/mobile
|
||||
- Desktop (Electron)
|
||||
- Mobile app (React Native) - coming soon
|
||||
@@ -19,24 +18,24 @@ Open-source, modern-design AI Agent Workspace: **LobeHub** (previously LobeChat)
|
||||
|
||||
## Complete Tech Stack
|
||||
|
||||
| Category | Technology |
|
||||
| ------------- | ------------------------------------------ |
|
||||
| Framework | Next.js 16 + React 19 |
|
||||
| Routing | SPA inside Next.js with `react-router-dom` |
|
||||
| Language | TypeScript |
|
||||
| UI Components | `@lobehub/ui`, antd |
|
||||
| CSS-in-JS | antd-style |
|
||||
| Icons | lucide-react, `@ant-design/icons` |
|
||||
| i18n | react-i18next |
|
||||
| State | zustand |
|
||||
| URL Params | nuqs |
|
||||
| Data Fetching | SWR |
|
||||
| React Hooks | aHooks |
|
||||
| Date/Time | dayjs |
|
||||
| Utilities | es-toolkit |
|
||||
| API | TRPC (type-safe) |
|
||||
| Database | Neon PostgreSQL + Drizzle ORM |
|
||||
| Testing | Vitest |
|
||||
| Category | Technology |
|
||||
|----------|------------|
|
||||
| Framework | Next.js 16 + React 19 |
|
||||
| Routing | SPA inside Next.js with `react-router-dom` |
|
||||
| Language | TypeScript |
|
||||
| UI Components | `@lobehub/ui`, antd |
|
||||
| CSS-in-JS | antd-style |
|
||||
| Icons | lucide-react, `@ant-design/icons` |
|
||||
| i18n | react-i18next |
|
||||
| State | zustand |
|
||||
| URL Params | nuqs |
|
||||
| Data Fetching | SWR |
|
||||
| React Hooks | aHooks |
|
||||
| Date/Time | dayjs |
|
||||
| Utilities | es-toolkit |
|
||||
| API | TRPC (type-safe) |
|
||||
| Database | Neon PostgreSQL + Drizzle ORM |
|
||||
| Testing | Vitest |
|
||||
|
||||
## Complete Project Structure
|
||||
|
||||
@@ -101,20 +100,13 @@ lobe-chat/
|
||||
│ │ │ ├── oidc/
|
||||
│ │ │ ├── trpc/
|
||||
│ │ │ └── webapi/
|
||||
│ │ ├── spa/ # SPA HTML template service
|
||||
│ │ └── [variants]/
|
||||
│ │ └── (auth)/ # Auth pages (SSR required)
|
||||
│ ├── routes/ # SPA page components (Vite)
|
||||
│ │ ├── (main)/
|
||||
│ │ ├── (mobile)/
|
||||
│ │ ├── (desktop)/
|
||||
│ │ ├── onboarding/
|
||||
│ │ └── share/
|
||||
│ ├── spa/ # SPA entry points and router config
|
||||
│ │ ├── entry.web.tsx
|
||||
│ │ ├── entry.mobile.tsx
|
||||
│ │ ├── entry.desktop.tsx
|
||||
│ │ └── router/
|
||||
│ │ ├── [variants]/
|
||||
│ │ │ ├── (auth)/
|
||||
│ │ │ ├── (main)/
|
||||
│ │ │ ├── (mobile)/
|
||||
│ │ │ ├── onboarding/
|
||||
│ │ │ └── router/
|
||||
│ │ └── desktop/
|
||||
│ ├── business/ # Cloud-only (client/server)
|
||||
│ │ ├── client/
|
||||
│ │ ├── locales/
|
||||
@@ -159,26 +151,24 @@ lobe-chat/
|
||||
|
||||
## Architecture Map
|
||||
|
||||
| Layer | Location |
|
||||
| ---------------- | --------------------------------------------------- |
|
||||
| UI Components | `src/components`, `src/features` |
|
||||
| SPA Pages | `src/routes/` |
|
||||
| React Router | `src/spa/router/` |
|
||||
| Global Providers | `src/layout` |
|
||||
| Zustand Stores | `src/store` |
|
||||
| Client Services | `src/services/` |
|
||||
| REST API | `src/app/(backend)/webapi` |
|
||||
| tRPC Routers | `src/server/routers/{async\|lambda\|mobile\|tools}` |
|
||||
| Server Services | `src/server/services` (can access DB) |
|
||||
| Server Modules | `src/server/modules` (no DB access) |
|
||||
| Feature Flags | `src/server/featureFlags` |
|
||||
| Global Config | `src/server/globalConfig` |
|
||||
| DB Schema | `packages/database/src/schemas` |
|
||||
| DB Model | `packages/database/src/models` |
|
||||
| DB Repository | `packages/database/src/repositories` |
|
||||
| Third-party | `src/libs` (analytics, oidc, etc.) |
|
||||
| Builtin Tools | `src/tools`, `packages/builtin-tool-*` |
|
||||
| Cloud-only | `src/business/*`, `packages/business/*` |
|
||||
| Layer | Location |
|
||||
|-------|----------|
|
||||
| UI Components | `src/components`, `src/features` |
|
||||
| Global Providers | `src/layout` |
|
||||
| Zustand Stores | `src/store` |
|
||||
| Client Services | `src/services/` |
|
||||
| REST API | `src/app/(backend)/webapi` |
|
||||
| tRPC Routers | `src/server/routers/{async\|lambda\|mobile\|tools}` |
|
||||
| Server Services | `src/server/services` (can access DB) |
|
||||
| Server Modules | `src/server/modules` (no DB access) |
|
||||
| Feature Flags | `src/server/featureFlags` |
|
||||
| Global Config | `src/server/globalConfig` |
|
||||
| DB Schema | `packages/database/src/schemas` |
|
||||
| DB Model | `packages/database/src/models` |
|
||||
| DB Repository | `packages/database/src/repositories` |
|
||||
| Third-party | `src/libs` (analytics, oidc, etc.) |
|
||||
| Builtin Tools | `src/tools`, `packages/builtin-tool-*` |
|
||||
| Cloud-only | `src/business/*`, `packages/business/*` |
|
||||
|
||||
## Data Flow
|
||||
|
||||
|
||||
@@ -17,7 +17,6 @@ If unsure about component usage, search existing code in this project. Most comp
|
||||
Reference: `node_modules/@lobehub/ui/es/index.mjs` for all available components.
|
||||
|
||||
**Common Components:**
|
||||
|
||||
- General: ActionIcon, ActionIconGroup, Block, Button, Icon
|
||||
- Data Display: Avatar, Collapse, Empty, Highlighter, Markdown, Tag, Tooltip
|
||||
- Data Entry: CodeEditor, CopyButton, EditableText, Form, FormModal, Input, SearchBar, Select
|
||||
@@ -29,16 +28,15 @@ Reference: `node_modules/@lobehub/ui/es/index.mjs` for all available components.
|
||||
|
||||
Hybrid routing: Next.js App Router (static pages) + React Router DOM (main SPA).
|
||||
|
||||
| Route Type | Use Case | Implementation |
|
||||
| ------------------ | --------------------------------- | ---------------------------- |
|
||||
| Route Type | Use Case | Implementation |
|
||||
|------------|----------|----------------|
|
||||
| Next.js App Router | Auth pages (login, signup, oauth) | `src/app/[variants]/(auth)/` |
|
||||
| React Router DOM | Main SPA (chat, settings) | `desktopRouter.config.tsx` |
|
||||
| React Router DOM | Main SPA (chat, settings) | `desktopRouter.config.tsx` |
|
||||
|
||||
### Key Files
|
||||
|
||||
- Entry: `src/spa/entry.web.tsx` (web), `src/spa/entry.mobile.tsx`, `src/spa/entry.desktop.tsx`
|
||||
- Desktop router: `src/spa/router/desktopRouter.config.tsx`
|
||||
- Mobile router: `src/spa/router/mobileRouter.config.tsx`
|
||||
- Entry: `src/app/[variants]/page.tsx`
|
||||
- Desktop router: `src/app/[variants]/router/desktopRouter.config.tsx`
|
||||
- Mobile router: `src/app/[variants]/(mobile)/router/mobileRouter.config.tsx`
|
||||
- Router utilities: `src/utils/router.tsx`
|
||||
|
||||
### Router Utilities
|
||||
@@ -58,11 +56,11 @@ errorElement: <ErrorBoundary resetPath="/chat" />;
|
||||
```tsx
|
||||
// ❌ Wrong
|
||||
import Link from 'next/link';
|
||||
<Link href="/">Home</Link>;
|
||||
<Link href="/">Home</Link>
|
||||
|
||||
// ✅ Correct
|
||||
import { Link } from 'react-router-dom';
|
||||
<Link to="/">Home</Link>;
|
||||
<Link to="/">Home</Link>
|
||||
|
||||
// In components
|
||||
import { useNavigate } from 'react-router-dom';
|
||||
|
||||
@@ -68,15 +68,9 @@ const isInit = useSessionStore(recentSelectors.isRecentTopicsInit);
|
||||
```
|
||||
|
||||
**RecentTopic type:**
|
||||
|
||||
```typescript
|
||||
interface RecentTopic {
|
||||
agent: {
|
||||
avatar: string | null;
|
||||
backgroundColor: string | null;
|
||||
id: string;
|
||||
title: string | null;
|
||||
} | null;
|
||||
agent: { avatar: string | null; backgroundColor: string | null; id: string; title: string | null } | null;
|
||||
id: string;
|
||||
title: string | null;
|
||||
updatedAt: Date;
|
||||
|
||||
@@ -1,87 +0,0 @@
|
||||
---
|
||||
name: response-compliance
|
||||
description: OpenResponses API compliance testing. Use when testing the Response API endpoint, running compliance tests, or debugging Response API schema issues. Triggers on 'compliance', 'response api test', 'openresponses test'.
|
||||
---
|
||||
|
||||
# OpenResponses Compliance Test
|
||||
|
||||
Run the official OpenResponses compliance test suite against the local (or remote) Response API endpoint.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# From the openapi package directory
|
||||
cd lobehub/packages/openapi
|
||||
|
||||
# Run all tests (dev mode, localhost:3010)
|
||||
APP_URL=http://localhost:3010 bun run test:response-compliance -- \
|
||||
--auth-header "lobe-auth-dev-backend-api" --no-bearer --api-key 1
|
||||
|
||||
# Run specific tests only
|
||||
APP_URL=http://localhost:3010 bun run test:response-compliance -- \
|
||||
--auth-header "lobe-auth-dev-backend-api" --no-bearer --api-key 1 \
|
||||
--filter basic-response,streaming-response
|
||||
|
||||
# Verbose mode (shows request/response details)
|
||||
APP_URL=http://localhost:3010 bun run test:response-compliance -- \
|
||||
--auth-header "lobe-auth-dev-backend-api" --no-bearer --api-key 1 -v
|
||||
|
||||
# JSON output (for CI)
|
||||
APP_URL=http://localhost:3010 bun run test:response-compliance -- \
|
||||
--auth-header "lobe-auth-dev-backend-api" --no-bearer --api-key 1 --json
|
||||
```
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Dev server running with `ENABLE_MOCK_DEV_USER=true` in `.env`
|
||||
- The `api/v1/responses` route registered (via `src/app/(backend)/api/v1/[[...route]]/route.ts`)
|
||||
|
||||
## Auth Modes
|
||||
|
||||
| Mode | Flags |
|
||||
| --------------- | ------------------------------------------------------------------- |
|
||||
| Dev (mock user) | `--auth-header "lobe-auth-dev-backend-api" --no-bearer --api-key 1` |
|
||||
| API Key | `--api-key lb-xxxxxxxxxxxxxxxx` |
|
||||
| Custom | `--auth-header <name> --api-key <value>` |
|
||||
|
||||
## Test IDs
|
||||
|
||||
Available `--filter` values:
|
||||
|
||||
| ID | Description | Related Issue |
|
||||
| -------------------- | -------------------------------------- | ------------- |
|
||||
| `basic-response` | Simple text generation (non-streaming) | LOBE-5858 |
|
||||
| `streaming-response` | SSE streaming lifecycle + events | LOBE-5859 |
|
||||
| `system-prompt` | System role message handling | LOBE-5858 |
|
||||
| `tool-calling` | Function tool definition + call output | LOBE-5860 |
|
||||
| `image-input` | Multimodal image URL content | — |
|
||||
| `multi-turn` | Conversation history via input items | LOBE-5861 |
|
||||
|
||||
## Environment Variables
|
||||
|
||||
| Variable | Default | Description |
|
||||
| --------- | ----------------------- | ----------------------------------------- |
|
||||
| `APP_URL` | `http://localhost:3010` | Server base URL (auto-appends `/api/v1`) |
|
||||
| `API_KEY` | — | API key (alternative to `--api-key` flag) |
|
||||
|
||||
## How It Works
|
||||
|
||||
The script (`lobehub/packages/openapi/scripts/compliance-test.sh`) clones the official [openresponses/openresponses](https://github.com/openresponses/openresponses) repo into `scripts/openresponses-compliance/` (gitignored) and runs its CLI test runner. First run clones; subsequent runs update from upstream.
|
||||
|
||||
## Debugging Failures
|
||||
|
||||
1. Run with `-v` to see full request/response payloads
|
||||
2. Common failure patterns:
|
||||
- **"Failed to parse JSON"**: Auth failed, server returned HTML redirect
|
||||
- **"Response has no output items"**: LLM execution not yet implemented
|
||||
- **"Expected number, received null"**: Missing required field in response schema
|
||||
- **"Invalid input"**: Zod validation on response schema — check field format
|
||||
|
||||
## Key Files
|
||||
|
||||
- **Types**: `lobehub/packages/openapi/src/types/responses.type.ts`
|
||||
- **Service**: `lobehub/packages/openapi/src/services/responses.service.ts`
|
||||
- **Controller**: `lobehub/packages/openapi/src/controllers/responses.controller.ts`
|
||||
- **Route**: `lobehub/packages/openapi/src/routes/responses.route.ts`
|
||||
- **Test script**: `lobehub/packages/openapi/scripts/compliance-test.sh`
|
||||
- **Cloud route**: `src/app/(backend)/api/v1/[[...route]]/route.ts`
|
||||
@@ -1,145 +0,0 @@
|
||||
---
|
||||
name: spa-routes
|
||||
description: SPA route and feature structure. Use when adding or modifying SPA routes in src/routes, defining new route segments, or moving route logic into src/features. Covers how to keep routes thin and how to divide files between routes and features.
|
||||
---
|
||||
|
||||
# SPA Routes and Features Guide
|
||||
|
||||
SPA structure:
|
||||
|
||||
- **`src/spa/`** – Entry points (`entry.web.tsx`, `entry.mobile.tsx`, `entry.desktop.tsx`) and router config (`router/`). Router lives here to avoid confusion with `src/routes/`.
|
||||
- **`src/routes/`** – Page segments only (roots).
|
||||
- **`src/features/`** – Business logic and UI by domain.
|
||||
|
||||
This project uses a **roots vs features** split: `src/routes/` only holds page segments; business logic and UI live in `src/features/` by domain.
|
||||
|
||||
## When to Use This Skill
|
||||
|
||||
- Adding a new SPA route or route segment
|
||||
- Defining or refactoring layout/page files under `src/routes/`
|
||||
- Moving route-specific components or logic into `src/features/`
|
||||
- Deciding where to put a new component (route folder vs feature folder)
|
||||
|
||||
---
|
||||
|
||||
## 1. What Belongs in `src/routes/` (roots)
|
||||
|
||||
Each route directory should contain **only**:
|
||||
|
||||
| File / folder | Purpose |
|
||||
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `_layout/index.tsx` or `layout.tsx` | Layout for this segment: wrap with `<Outlet />`, optional shell (e.g. sidebar + main). Should be thin: prefer re-exporting or composing from `@/features/*`. |
|
||||
| `index.tsx` or `page.tsx` | Page entry for this segment. Only import from features and render; no business logic. |
|
||||
| `[param]/index.tsx` (e.g. `[id]`, `[cronId]`) | Dynamic segment page. Same rule: thin, delegate to features. |
|
||||
|
||||
**Rule:** Route files should only **import and compose**. No new `features/` folders or heavy components inside `src/routes/`.
|
||||
|
||||
---
|
||||
|
||||
## 2. What Belongs in `src/features/`
|
||||
|
||||
Put **domain-oriented** UI and logic here:
|
||||
|
||||
- Layout building blocks: sidebars, headers, body panels, drawers
|
||||
- Hooks and store usage for that domain
|
||||
- Domain-specific forms, lists, modals, etc.
|
||||
|
||||
Organize by **domain** (e.g. `Pages`, `Home`, `Agent`, `PageEditor`), not by route path. One route can use several features; one feature can be used by several routes.
|
||||
|
||||
Each feature should:
|
||||
|
||||
- Live under `src/features/<FeatureName>/`
|
||||
- Export a clear public API via `index.ts` or `index.tsx`
|
||||
- Use `@/features/<FeatureName>/...` for internal imports when needed
|
||||
|
||||
---
|
||||
|
||||
## 3. How to Add a New SPA Route
|
||||
|
||||
1. **Choose the route group**
|
||||
- `(main)/` – desktop main app
|
||||
- `(mobile)/` – mobile
|
||||
- `(desktop)/` – Electron-specific
|
||||
- `onboarding/`, `share/` – special flows
|
||||
|
||||
2. **Create only segment files under `src/routes/`**
|
||||
- e.g. `src/routes/(main)/my-feature/_layout/index.tsx` and `src/routes/(main)/my-feature/index.tsx` (and optional `[id]/index.tsx`).
|
||||
|
||||
3. **Implement layout and page content in `src/features/`**
|
||||
- Create or reuse a domain (e.g. `src/features/MyFeature/`).
|
||||
- Put layout (sidebar, header, body) and page UI there; export from the feature’s `index`.
|
||||
|
||||
4. **Keep route files thin**
|
||||
- Layout: `export { default } from '@/features/MyFeature/MyLayout'` or compose a few feature components + `<Outlet />`.
|
||||
- Page: import from `@/features/MyFeature` (or a specific subpath) and render; no business logic in the route file.
|
||||
|
||||
5. **Register the route**
|
||||
- Add the segment to `src/spa/router/desktopRouter.config.tsx` (or the right router config) with `dynamicElement` / `dynamicLayout` pointing at the new route paths (e.g. `@/routes/(main)/my-feature`).
|
||||
|
||||
---
|
||||
|
||||
## 4. How to Divide Files (route vs feature)
|
||||
|
||||
| Question | Put in `src/routes/` | Put in `src/features/` |
|
||||
| -------------------------------------------------------- | -------------------------------------------------------- | ---------------------------- |
|
||||
| Is it the route’s layout wrapper or page entry? | Yes – `_layout/index.tsx`, `index.tsx`, `[id]/index.tsx` | No |
|
||||
| Does it contain business logic or non-trivial UI? | No | Yes – under the right domain |
|
||||
| Is it a reusable layout piece (sidebar, header, body)? | No | Yes |
|
||||
| Is it a hook, store usage, or domain logic? | No | Yes |
|
||||
| Is it only re-exporting or composing feature components? | Yes | No |
|
||||
|
||||
**Examples**
|
||||
|
||||
- **Route (thin):**\
|
||||
`src/routes/(main)/page/_layout/index.tsx` → `export { default } from '@/features/Pages/PageLayout'`
|
||||
- **Feature (real implementation):**\
|
||||
`src/features/Pages/PageLayout/` → Sidebar, DataSync, Body, Header, styles, etc.
|
||||
- **Route (thin):**\
|
||||
`src/routes/(main)/page/index.tsx` → Import `PageTitle`, `PageExplorerPlaceholder` from `@/features/Pages` and `@/features/PageExplorer`; render with `<PageTitle />` and placeholder.
|
||||
- **Feature:**\
|
||||
Page list, actions, drawers, and hooks live under `src/features/Pages/`.
|
||||
|
||||
---
|
||||
|
||||
## 5. Progressive Migration (existing code)
|
||||
|
||||
We are migrating existing routes to this structure step by step:
|
||||
|
||||
- **Phase 1 (done):** `/page` route – segment files in `src/routes/(main)/page/`, implementation in `src/features/Pages/`.
|
||||
- **Later phases:** home, settings, agent/group, community/resource/memory, mobile/share/onboarding.
|
||||
|
||||
When touching an old route that still has logic or `features/` inside `src/routes/`:
|
||||
|
||||
1. Prefer adding **new** code in `src/features/<Domain>/` and importing from routes.
|
||||
2. For larger refactors, move existing route-only logic into the right feature and then thin out the route files (re-export or compose from features).
|
||||
3. Use `git mv` when moving files so history is preserved.
|
||||
|
||||
---
|
||||
|
||||
## 6. Reference Structure (after Phase 1)
|
||||
|
||||
**Route (thin):**
|
||||
|
||||
```
|
||||
src/routes/(main)/page/
|
||||
├── _layout/index.tsx → re-export or compose from @/features/Pages/PageLayout
|
||||
├── index.tsx → import from @/features/Pages, @/features/PageExplorer
|
||||
└── [id]/index.tsx → import from @/features/Pages, @/features/PageExplorer
|
||||
```
|
||||
|
||||
**Feature (implementation):**
|
||||
|
||||
```
|
||||
src/features/Pages/
|
||||
├── index.ts → export PageLayout, PageTitle
|
||||
├── PageTitle.tsx
|
||||
└── PageLayout/
|
||||
├── index.tsx → Sidebar + Outlet + DataSync
|
||||
├── DataSync.tsx
|
||||
├── Sidebar.tsx
|
||||
├── style.ts
|
||||
├── Body/ → list, actions, drawer, etc.
|
||||
└── Header/ → breadcrumb, add button, etc.
|
||||
```
|
||||
|
||||
Router config continues to point at **route** paths (e.g. `@/routes/(main)/page`, `@/routes/(main)/page/_layout`); route files then delegate to features.
|
||||
@@ -1,624 +0,0 @@
|
||||
---
|
||||
name: store-data-structures
|
||||
description: Zustand store data structure patterns for LobeHub. Covers List vs Detail data structures, Map + Reducer patterns, type definitions, and when to use each pattern. Use when designing store state, choosing data structures, or implementing list/detail pages.
|
||||
---
|
||||
|
||||
# LobeHub Store Data Structures
|
||||
|
||||
This guide covers how to structure data in Zustand stores for optimal performance and user experience.
|
||||
|
||||
## Core Principles
|
||||
|
||||
### ✅ DO
|
||||
|
||||
1. **Separate List and Detail** - Use different structures for list pages and detail pages
|
||||
2. **Use Map for Details** - Cache multiple detail pages with `Record<string, Detail>`
|
||||
3. **Use Array for Lists** - Simple arrays for list display
|
||||
4. **Types from @lobechat/types** - Never use `@lobechat/database` types in stores
|
||||
5. **Distinguish List and Detail types** - List types may have computed UI fields
|
||||
|
||||
### ❌ DON'T
|
||||
|
||||
1. **Don't use single detail object** - Can't cache multiple pages
|
||||
2. **Don't mix List and Detail types** - They have different purposes
|
||||
3. **Don't use database types** - Use types from `@lobechat/types`
|
||||
4. **Don't use Map for lists** - Simple arrays are sufficient
|
||||
|
||||
---
|
||||
|
||||
## Type Definitions
|
||||
|
||||
Types should be organized by entity in separate files:
|
||||
|
||||
```
|
||||
@lobechat/types/src/eval/
|
||||
├── benchmark.ts # Benchmark types
|
||||
├── agentEvalDataset.ts # Dataset types
|
||||
├── agentEvalRun.ts # Run types
|
||||
└── index.ts # Re-exports
|
||||
```
|
||||
|
||||
### Example: Benchmark Types
|
||||
|
||||
```typescript
|
||||
// packages/types/src/eval/benchmark.ts
|
||||
import type { EvalBenchmarkRubric } from './rubric';
|
||||
|
||||
// ============================================
|
||||
// Detail Type - Full entity (for detail pages)
|
||||
// ============================================
|
||||
|
||||
/**
|
||||
* Full benchmark entity with all fields including heavy data
|
||||
*/
|
||||
export interface AgentEvalBenchmark {
|
||||
createdAt: Date;
|
||||
description?: string | null;
|
||||
id: string;
|
||||
identifier: string;
|
||||
isSystem: boolean;
|
||||
metadata?: Record<string, unknown> | null;
|
||||
name: string;
|
||||
referenceUrl?: string | null;
|
||||
rubrics: EvalBenchmarkRubric[]; // Heavy field
|
||||
updatedAt: Date;
|
||||
}
|
||||
|
||||
// ============================================
|
||||
// List Type - Lightweight (for list display)
|
||||
// ============================================
|
||||
|
||||
/**
|
||||
* Lightweight benchmark item - excludes heavy fields
|
||||
* May include computed statistics for UI
|
||||
*/
|
||||
export interface AgentEvalBenchmarkListItem {
|
||||
createdAt: Date;
|
||||
description?: string | null;
|
||||
id: string;
|
||||
identifier: string;
|
||||
isSystem: boolean;
|
||||
name: string;
|
||||
// Note: rubrics NOT included (heavy field)
|
||||
|
||||
// Computed statistics for UI display
|
||||
datasetCount?: number;
|
||||
runCount?: number;
|
||||
testCaseCount?: number;
|
||||
}
|
||||
```
|
||||
|
||||
### Example: Document Types (with heavy content)
|
||||
|
||||
```typescript
|
||||
// packages/types/src/document.ts
|
||||
|
||||
/**
|
||||
* Full document entity - includes heavy content fields
|
||||
*/
|
||||
export interface Document {
|
||||
id: string;
|
||||
title: string;
|
||||
description?: string;
|
||||
content: string; // Heavy field - full markdown content
|
||||
editorData: any; // Heavy field - editor state
|
||||
metadata?: Record<string, unknown>;
|
||||
createdAt: Date;
|
||||
updatedAt: Date;
|
||||
}
|
||||
|
||||
/**
|
||||
* Lightweight document item - excludes heavy content
|
||||
*/
|
||||
export interface DocumentListItem {
|
||||
id: string;
|
||||
title: string;
|
||||
description?: string;
|
||||
// Note: content and editorData NOT included
|
||||
createdAt: Date;
|
||||
updatedAt: Date;
|
||||
|
||||
// Computed statistics
|
||||
wordCount?: number;
|
||||
lastEditedBy?: string;
|
||||
}
|
||||
```
|
||||
|
||||
**Key Points:**
|
||||
|
||||
- **Detail types** include ALL fields from database (full entity)
|
||||
- **List types** are **subsets** that exclude heavy/large fields
|
||||
- List types may add computed statistics for UI (e.g., `testCaseCount`)
|
||||
- **Each entity gets its own file** (not mixed together)
|
||||
- **All types** exported from `@lobechat/types`, NOT `@lobechat/database`
|
||||
|
||||
**Heavy fields to exclude from List:**
|
||||
|
||||
- Large text content (`content`, `editorData`, `fullDescription`)
|
||||
- Complex objects (`rubrics`, `config`, `metrics`)
|
||||
- Binary data (`image`, `file`)
|
||||
- Large arrays (`messages`, `items`)
|
||||
|
||||
---
|
||||
|
||||
## When to Use Map vs Array
|
||||
|
||||
### Use Map + Reducer (for Detail Data)
|
||||
|
||||
✅ **Detail page data caching** - Cache multiple detail pages simultaneously
|
||||
✅ **Optimistic updates** - Update UI before API responds
|
||||
✅ **Per-item loading states** - Track which items are being updated
|
||||
✅ **Multiple pages open** - User can navigate between details without refetching
|
||||
|
||||
**Structure:**
|
||||
|
||||
```typescript
|
||||
benchmarkDetailMap: Record<string, AgentEvalBenchmark>;
|
||||
```
|
||||
|
||||
**Example:** Benchmark detail pages, Dataset detail pages, User profiles
|
||||
|
||||
### Use Simple Array (for List Data)
|
||||
|
||||
✅ **List display** - Lists, tables, cards
|
||||
✅ **Read-only or refresh-as-whole** - Entire list refreshes together
|
||||
✅ **No per-item updates** - No need to update individual items
|
||||
✅ **Simple data flow** - Easier to understand and maintain
|
||||
|
||||
**Structure:**
|
||||
|
||||
```typescript
|
||||
benchmarkList: AgentEvalBenchmarkListItem[]
|
||||
```
|
||||
|
||||
**Example:** Benchmark list, Dataset list, User list
|
||||
|
||||
---
|
||||
|
||||
## State Structure Pattern
|
||||
|
||||
### Complete Example
|
||||
|
||||
```typescript
|
||||
// packages/types/src/eval/benchmark.ts
|
||||
import type { EvalBenchmarkRubric } from './rubric';
|
||||
|
||||
/**
|
||||
* Full benchmark entity (for detail pages)
|
||||
*/
|
||||
export interface AgentEvalBenchmark {
|
||||
id: string;
|
||||
name: string;
|
||||
description?: string | null;
|
||||
identifier: string;
|
||||
rubrics: EvalBenchmarkRubric[]; // Heavy field
|
||||
metadata?: Record<string, unknown> | null;
|
||||
isSystem: boolean;
|
||||
createdAt: Date;
|
||||
updatedAt: Date;
|
||||
}
|
||||
|
||||
/**
|
||||
* Lightweight benchmark (for list display)
|
||||
* Excludes heavy fields like rubrics
|
||||
*/
|
||||
export interface AgentEvalBenchmarkListItem {
|
||||
id: string;
|
||||
name: string;
|
||||
description?: string | null;
|
||||
identifier: string;
|
||||
isSystem: boolean;
|
||||
createdAt: Date;
|
||||
// Note: rubrics excluded
|
||||
|
||||
// Computed statistics
|
||||
testCaseCount?: number;
|
||||
datasetCount?: number;
|
||||
runCount?: number;
|
||||
}
|
||||
```
|
||||
|
||||
```typescript
|
||||
// src/store/eval/slices/benchmark/initialState.ts
|
||||
import type { AgentEvalBenchmark, AgentEvalBenchmarkListItem } from '@lobechat/types';
|
||||
|
||||
export interface BenchmarkSliceState {
|
||||
// ============================================
|
||||
// List Data - Simple Array
|
||||
// ============================================
|
||||
/**
|
||||
* List of benchmarks for list page display
|
||||
* May include computed fields like testCaseCount
|
||||
*/
|
||||
benchmarkList: AgentEvalBenchmarkListItem[];
|
||||
benchmarkListInit: boolean;
|
||||
|
||||
// ============================================
|
||||
// Detail Data - Map for Caching
|
||||
// ============================================
|
||||
/**
|
||||
* Map of benchmark details keyed by ID
|
||||
* Caches detail page data for multiple benchmarks
|
||||
* Enables optimistic updates and per-item loading
|
||||
*/
|
||||
benchmarkDetailMap: Record<string, AgentEvalBenchmark>;
|
||||
|
||||
/**
|
||||
* Track which benchmark details are being loaded/updated
|
||||
* For showing spinners on specific items
|
||||
*/
|
||||
loadingBenchmarkDetailIds: string[];
|
||||
|
||||
// ============================================
|
||||
// Mutation States
|
||||
// ============================================
|
||||
isCreatingBenchmark: boolean;
|
||||
isUpdatingBenchmark: boolean;
|
||||
isDeletingBenchmark: boolean;
|
||||
}
|
||||
|
||||
export const benchmarkInitialState: BenchmarkSliceState = {
|
||||
benchmarkList: [],
|
||||
benchmarkListInit: false,
|
||||
benchmarkDetailMap: {},
|
||||
loadingBenchmarkDetailIds: [],
|
||||
isCreatingBenchmark: false,
|
||||
isUpdatingBenchmark: false,
|
||||
isDeletingBenchmark: false,
|
||||
};
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Reducer Pattern (for Detail Map)
|
||||
|
||||
### Why Use Reducer?
|
||||
|
||||
- **Immutable updates** - Immer ensures immutability
|
||||
- **Type-safe actions** - TypeScript discriminated unions
|
||||
- **Testable** - Pure functions easy to test
|
||||
- **Reusable** - Same reducer for optimistic updates and server data
|
||||
|
||||
### Reducer Structure
|
||||
|
||||
```typescript
|
||||
// src/store/eval/slices/benchmark/reducer.ts
|
||||
import { produce } from 'immer';
|
||||
import type { AgentEvalBenchmark } from '@lobechat/types';
|
||||
|
||||
// ============================================
|
||||
// Action Types
|
||||
// ============================================
|
||||
|
||||
type SetBenchmarkDetailAction = {
|
||||
id: string;
|
||||
type: 'setBenchmarkDetail';
|
||||
value: AgentEvalBenchmark;
|
||||
};
|
||||
|
||||
type UpdateBenchmarkDetailAction = {
|
||||
id: string;
|
||||
type: 'updateBenchmarkDetail';
|
||||
value: Partial<AgentEvalBenchmark>;
|
||||
};
|
||||
|
||||
type DeleteBenchmarkDetailAction = {
|
||||
id: string;
|
||||
type: 'deleteBenchmarkDetail';
|
||||
};
|
||||
|
||||
export type BenchmarkDetailDispatch =
|
||||
| SetBenchmarkDetailAction
|
||||
| UpdateBenchmarkDetailAction
|
||||
| DeleteBenchmarkDetailAction;
|
||||
|
||||
// ============================================
|
||||
// Reducer Function
|
||||
// ============================================
|
||||
|
||||
export const benchmarkDetailReducer = (
|
||||
state: Record<string, AgentEvalBenchmark> = {},
|
||||
payload: BenchmarkDetailDispatch,
|
||||
): Record<string, AgentEvalBenchmark> => {
|
||||
switch (payload.type) {
|
||||
case 'setBenchmarkDetail': {
|
||||
return produce(state, (draft) => {
|
||||
draft[payload.id] = payload.value;
|
||||
});
|
||||
}
|
||||
|
||||
case 'updateBenchmarkDetail': {
|
||||
return produce(state, (draft) => {
|
||||
if (draft[payload.id]) {
|
||||
draft[payload.id] = { ...draft[payload.id], ...payload.value };
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
case 'deleteBenchmarkDetail': {
|
||||
return produce(state, (draft) => {
|
||||
delete draft[payload.id];
|
||||
});
|
||||
}
|
||||
|
||||
default:
|
||||
return state;
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
### Internal Dispatch Methods
|
||||
|
||||
```typescript
|
||||
// In action.ts
|
||||
export interface BenchmarkAction {
|
||||
// ... other methods ...
|
||||
|
||||
// Internal methods - not for direct UI use
|
||||
internal_dispatchBenchmarkDetail: (payload: BenchmarkDetailDispatch) => void;
|
||||
internal_updateBenchmarkDetailLoading: (id: string, loading: boolean) => void;
|
||||
}
|
||||
|
||||
export const createBenchmarkSlice: StateCreator<...> = (set, get) => ({
|
||||
// ... other methods ...
|
||||
|
||||
// Internal - Dispatch to reducer
|
||||
internal_dispatchBenchmarkDetail: (payload) => {
|
||||
const currentMap = get().benchmarkDetailMap;
|
||||
const nextMap = benchmarkDetailReducer(currentMap, payload);
|
||||
|
||||
// Only update if changed
|
||||
if (isEqual(nextMap, currentMap)) return;
|
||||
|
||||
set(
|
||||
{ benchmarkDetailMap: nextMap },
|
||||
false,
|
||||
`dispatchBenchmarkDetail/${payload.type}`,
|
||||
);
|
||||
},
|
||||
|
||||
// Internal - Update loading state
|
||||
internal_updateBenchmarkDetailLoading: (id, loading) => {
|
||||
set(
|
||||
(state) => {
|
||||
if (loading) {
|
||||
return { loadingBenchmarkDetailIds: [...state.loadingBenchmarkDetailIds, id] };
|
||||
}
|
||||
return {
|
||||
loadingBenchmarkDetailIds: state.loadingBenchmarkDetailIds.filter((i) => i !== id),
|
||||
};
|
||||
},
|
||||
false,
|
||||
'updateBenchmarkDetailLoading',
|
||||
);
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Data Structure Comparison
|
||||
|
||||
### ❌ WRONG - Single Detail Object
|
||||
|
||||
```typescript
|
||||
interface BenchmarkSliceState {
|
||||
// ❌ Can only cache one detail
|
||||
benchmarkDetail: AgentEvalBenchmark | null;
|
||||
|
||||
// ❌ Global loading state
|
||||
isLoadingBenchmarkDetail: boolean;
|
||||
}
|
||||
```
|
||||
|
||||
**Problems:**
|
||||
|
||||
- Can only cache one detail page at a time
|
||||
- Switching between details causes unnecessary refetches
|
||||
- No optimistic updates
|
||||
- No per-item loading states
|
||||
|
||||
### ✅ CORRECT - Separate List and Detail
|
||||
|
||||
```typescript
|
||||
import type { AgentEvalBenchmark, AgentEvalBenchmarkListItem } from '@lobechat/types';
|
||||
|
||||
interface BenchmarkSliceState {
|
||||
// ✅ List data - simple array
|
||||
benchmarkList: AgentEvalBenchmarkListItem[];
|
||||
benchmarkListInit: boolean;
|
||||
|
||||
// ✅ Detail data - map for caching
|
||||
benchmarkDetailMap: Record<string, AgentEvalBenchmark>;
|
||||
|
||||
// ✅ Per-item loading
|
||||
loadingBenchmarkDetailIds: string[];
|
||||
|
||||
// ✅ Mutation states
|
||||
isCreatingBenchmark: boolean;
|
||||
isUpdatingBenchmark: boolean;
|
||||
isDeletingBenchmark: boolean;
|
||||
}
|
||||
```
|
||||
|
||||
**Benefits:**
|
||||
|
||||
- Cache multiple detail pages
|
||||
- Fast navigation between cached details
|
||||
- Optimistic updates with reducer
|
||||
- Per-item loading states
|
||||
- Clear separation of concerns
|
||||
|
||||
---
|
||||
|
||||
## Component Usage
|
||||
|
||||
### Accessing List Data
|
||||
|
||||
```typescript
|
||||
const BenchmarkList = () => {
|
||||
// Simple array access
|
||||
const benchmarks = useEvalStore((s) => s.benchmarkList);
|
||||
const isInit = useEvalStore((s) => s.benchmarkListInit);
|
||||
|
||||
if (!isInit) return <Loading />;
|
||||
|
||||
return (
|
||||
<div>
|
||||
{benchmarks.map(b => (
|
||||
<BenchmarkCard
|
||||
key={b.id}
|
||||
name={b.name}
|
||||
testCaseCount={b.testCaseCount} // Computed field
|
||||
/>
|
||||
))}
|
||||
</div>
|
||||
);
|
||||
};
|
||||
```
|
||||
|
||||
### Accessing Detail Data
|
||||
|
||||
```typescript
|
||||
const BenchmarkDetail = () => {
|
||||
const { benchmarkId } = useParams<{ benchmarkId: string }>();
|
||||
|
||||
// Get from map
|
||||
const benchmark = useEvalStore((s) =>
|
||||
benchmarkId ? s.benchmarkDetailMap[benchmarkId] : undefined,
|
||||
);
|
||||
|
||||
// Check loading
|
||||
const isLoading = useEvalStore((s) =>
|
||||
benchmarkId ? s.loadingBenchmarkDetailIds.includes(benchmarkId) : false,
|
||||
);
|
||||
|
||||
if (!benchmark) return <Loading />;
|
||||
|
||||
return (
|
||||
<div>
|
||||
<h1>{benchmark.name}</h1>
|
||||
{isLoading && <Spinner />}
|
||||
</div>
|
||||
);
|
||||
};
|
||||
```
|
||||
|
||||
### Using Selectors (Recommended)
|
||||
|
||||
```typescript
|
||||
// src/store/eval/slices/benchmark/selectors.ts
|
||||
export const benchmarkSelectors = {
|
||||
getBenchmarkDetail: (id: string) => (s: EvalStore) => s.benchmarkDetailMap[id],
|
||||
|
||||
isLoadingBenchmarkDetail: (id: string) => (s: EvalStore) =>
|
||||
s.loadingBenchmarkDetailIds.includes(id),
|
||||
};
|
||||
|
||||
// In component
|
||||
const benchmark = useEvalStore(benchmarkSelectors.getBenchmarkDetail(benchmarkId!));
|
||||
const isLoading = useEvalStore(benchmarkSelectors.isLoadingBenchmarkDetail(benchmarkId!));
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Decision Tree
|
||||
|
||||
```
|
||||
Need to store data?
|
||||
│
|
||||
├─ Is it a LIST for display?
|
||||
│ └─ ✅ Use simple array: `xxxList: XxxListItem[]`
|
||||
│ - May include computed fields
|
||||
│ - Refreshed as a whole
|
||||
│ - No optimistic updates needed
|
||||
│
|
||||
└─ Is it DETAIL page data?
|
||||
└─ ✅ Use Map: `xxxDetailMap: Record<string, Xxx>`
|
||||
- Cache multiple details
|
||||
- Support optimistic updates
|
||||
- Per-item loading states
|
||||
- Requires reducer for mutations
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Checklist
|
||||
|
||||
When designing store state structure:
|
||||
|
||||
- [ ] **Organize types by entity** in separate files (e.g., `benchmark.ts`, `agentEvalDataset.ts`)
|
||||
- [ ] Create **Detail** type (full entity with all fields including heavy ones)
|
||||
- [ ] Create **ListItem** type:
|
||||
- [ ] Subset of Detail type (exclude heavy fields)
|
||||
- [ ] May include computed statistics for UI
|
||||
- [ ] **NOT** extending Detail type (it's a subset, not extension)
|
||||
- [ ] Use **array** for list data: `xxxList: XxxListItem[]`
|
||||
- [ ] Use **Map** for detail data: `xxxDetailMap: Record<string, Xxx>`
|
||||
- [ ] Add per-item loading: `loadingXxxDetailIds: string[]`
|
||||
- [ ] Create **reducer** for detail map if optimistic updates needed
|
||||
- [ ] Add **internal dispatch** and **loading** methods
|
||||
- [ ] Create **selectors** for clean access (optional but recommended)
|
||||
- [ ] Document in comments:
|
||||
- [ ] What fields are excluded from List and why
|
||||
- [ ] What computed fields mean
|
||||
- [ ] What each Map is for
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **File organization** - One entity per file, not mixed together
|
||||
2. **List is subset** - ListItem excludes heavy fields, not extends Detail
|
||||
3. **Clear naming** - `xxxList` for arrays, `xxxDetailMap` for maps
|
||||
4. **Consistent patterns** - All detail maps follow same structure
|
||||
5. **Type safety** - Never use `any`, always use proper types
|
||||
6. **Document exclusions** - Comment which fields are excluded from List and why
|
||||
7. **Selectors** - Encapsulate access patterns
|
||||
8. **Loading states** - Per-item for details, global for lists
|
||||
9. **Immutability** - Use Immer in reducers
|
||||
|
||||
### Common Mistakes to Avoid
|
||||
|
||||
❌ **DON'T extend Detail in List:**
|
||||
|
||||
```typescript
|
||||
// Wrong - List should not extend Detail
|
||||
export interface BenchmarkListItem extends Benchmark {
|
||||
testCaseCount?: number;
|
||||
}
|
||||
```
|
||||
|
||||
✅ **DO create separate subset:**
|
||||
|
||||
```typescript
|
||||
// Correct - List is a subset with computed fields
|
||||
export interface BenchmarkListItem {
|
||||
id: string;
|
||||
name: string;
|
||||
// ... only necessary fields
|
||||
testCaseCount?: number; // Computed
|
||||
}
|
||||
```
|
||||
|
||||
❌ **DON'T mix entities in one file:**
|
||||
|
||||
```typescript
|
||||
// Wrong - all entities in agentEvalEntities.ts
|
||||
```
|
||||
|
||||
✅ **DO separate by entity:**
|
||||
|
||||
```typescript
|
||||
// Correct - separate files
|
||||
// benchmark.ts
|
||||
// agentEvalDataset.ts
|
||||
// agentEvalRun.ts
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Related Skills
|
||||
|
||||
- `data-fetching` - How to fetch and update this data
|
||||
- `zustand` - General Zustand patterns
|
||||
@@ -3,12 +3,11 @@ name: testing
|
||||
description: Testing guide using Vitest. Use when writing tests (.test.ts, .test.tsx), fixing failing tests, improving test coverage, or debugging test issues. Triggers on test creation, test debugging, mock setup, or test-related questions.
|
||||
---
|
||||
|
||||
# LobeHub Testing Guide
|
||||
# LobeChat Testing Guide
|
||||
|
||||
## Quick Reference
|
||||
|
||||
**Commands:**
|
||||
|
||||
```bash
|
||||
# Run specific test file
|
||||
bunx vitest run --silent='passed-only' '[file-path]'
|
||||
@@ -20,15 +19,15 @@ cd packages/database && bunx vitest run --silent='passed-only' '[file]'
|
||||
cd packages/database && TEST_SERVER_DB=1 bunx vitest run --silent='passed-only' '[file]'
|
||||
```
|
||||
|
||||
**Never run** `bun run test` - it runs all 3000+ tests (\~10 minutes).
|
||||
**Never run** `bun run test` - it runs all 3000+ tests (~10 minutes).
|
||||
|
||||
## Test Categories
|
||||
|
||||
| Category | Location | Config |
|
||||
| -------- | --------------------------- | ------------------------------- |
|
||||
| Webapp | `src/**/*.test.ts(x)` | `vitest.config.ts` |
|
||||
| Packages | `packages/*/**/*.test.ts` | `packages/*/vitest.config.ts` |
|
||||
| Desktop | `apps/desktop/**/*.test.ts` | `apps/desktop/vitest.config.ts` |
|
||||
| Category | Location | Config |
|
||||
|----------|----------|--------|
|
||||
| Webapp | `src/**/*.test.ts(x)` | `vitest.config.ts` |
|
||||
| Packages | `packages/*/**/*.test.ts` | `packages/*/vitest.config.ts` |
|
||||
| Desktop | `apps/desktop/**/*.test.ts` | `apps/desktop/vitest.config.ts` |
|
||||
|
||||
## Core Principles
|
||||
|
||||
@@ -76,41 +75,12 @@ vi.mock('@/services/chat'); // Too broad
|
||||
## Detailed Guides
|
||||
|
||||
See `references/` for specific testing scenarios:
|
||||
|
||||
- **Database Model testing**: `references/db-model-test.md`
|
||||
- **Electron IPC testing**: `references/electron-ipc-test.md`
|
||||
- **Zustand Store Action testing**: `references/zustand-store-action-test.md`
|
||||
- **Agent Runtime E2E testing**: `references/agent-runtime-e2e.md`
|
||||
- **Desktop Controller testing**: `references/desktop-controller-test.md`
|
||||
|
||||
## Fixing Failing Tests — Optimize or Delete?
|
||||
|
||||
When tests fail due to implementation changes (not bugs), evaluate before blindly fixing:
|
||||
|
||||
### Keep & Fix (update test data/assertions)
|
||||
|
||||
- **Behavior tests**: Tests that verify _what_ the code does (output, side effects, user-visible behavior). Just update mock data formats or expected values.
|
||||
- Example: Tool data structure changed from `{ name }` to `{ function: { name } }` → update mock data
|
||||
- Example: Output format changed from `Current date: YYYY-MM-DD` to `Current date: YYYY-MM-DD (TZ)` → update expected string
|
||||
|
||||
### Delete (over-specified, low value)
|
||||
|
||||
- **Param-forwarding tests**: Tests that assert exact internal function call arguments (e.g., `expect(internalFn).toHaveBeenCalledWith(expect.objectContaining({ exact params }))`) — these break on every refactor and duplicate what behavior tests already cover.
|
||||
- **Implementation-coupled tests**: Tests that verify _how_ the code works internally rather than _what_ it produces. If a higher-level test already covers the same behavior, the low-level test adds maintenance cost without coverage gain.
|
||||
|
||||
### Decision Checklist
|
||||
|
||||
1. Does the test verify **externally observable behavior** (API response, DB write, rendered output)? → **Keep**
|
||||
2. Does the test only verify **internal wiring** (which function receives which params)? → Check if a behavior test already covers it. If yes → **Delete**
|
||||
3. Is the same behavior already tested at a **higher integration level**? → Delete the lower-level duplicate
|
||||
4. Would the test break again on the **next routine refactor**? → Consider raising to integration level or deleting
|
||||
|
||||
### When Writing New Tests
|
||||
|
||||
- Prefer **integration-level assertions** (verify final output) over **white-box assertions** (verify internal calls)
|
||||
- Use `expect.objectContaining` only for stable, public-facing contracts — not for internal param shapes that change with refactors
|
||||
- Mock at boundaries (DB, network, external services), not between internal modules
|
||||
|
||||
## Common Issues
|
||||
|
||||
1. **Module pollution**: Use `vi.resetModules()` when tests fail mysteriously
|
||||
|
||||
@@ -6,14 +6,13 @@
|
||||
|
||||
Only mock **three external dependencies**:
|
||||
|
||||
| Dependency | Mock | Description |
|
||||
| ---------- | -------------------------- | ------------------------------------------------------- |
|
||||
| Database | PGLite | In-memory database from `@lobechat/database/test-utils` |
|
||||
| Redis | InMemoryAgentStateManager | Memory implementation |
|
||||
| Redis | InMemoryStreamEventManager | Memory implementation |
|
||||
| Dependency | Mock | Description |
|
||||
|------------|------|-------------|
|
||||
| Database | PGLite | In-memory database from `@lobechat/database/test-utils` |
|
||||
| Redis | InMemoryAgentStateManager | Memory implementation |
|
||||
| Redis | InMemoryStreamEventManager | Memory implementation |
|
||||
|
||||
**NOT mocked:**
|
||||
|
||||
- `model-bank` - Uses real model config
|
||||
- `Mecha` (AgentToolsEngine, ContextEngineering)
|
||||
- `AgentRuntimeService`
|
||||
@@ -22,7 +21,6 @@ Only mock **three external dependencies**:
|
||||
### Use vi.spyOn, not vi.mock
|
||||
|
||||
Different tests need different LLM responses. `vi.spyOn` provides:
|
||||
|
||||
- Flexible return values per test
|
||||
- Easy testing of different scenarios
|
||||
- Better test isolation
|
||||
@@ -78,7 +76,7 @@ export const createOpenAIStreamResponse = (options: {
|
||||
controller.close();
|
||||
},
|
||||
}),
|
||||
{ headers: { 'content-type': 'text/event-stream' } },
|
||||
{ headers: { 'content-type': 'text/event-stream' } }
|
||||
);
|
||||
};
|
||||
```
|
||||
@@ -86,10 +84,7 @@ export const createOpenAIStreamResponse = (options: {
|
||||
### State Management
|
||||
|
||||
```typescript
|
||||
import {
|
||||
InMemoryAgentStateManager,
|
||||
InMemoryStreamEventManager,
|
||||
} from '@/server/modules/AgentRuntime';
|
||||
import { InMemoryAgentStateManager, InMemoryStreamEventManager } from '@/server/modules/AgentRuntime';
|
||||
|
||||
const stateManager = new InMemoryAgentStateManager();
|
||||
const streamEventManager = new InMemoryStreamEventManager();
|
||||
@@ -112,18 +107,14 @@ it('should handle text response', async () => {
|
||||
});
|
||||
|
||||
it('should handle tool calls', async () => {
|
||||
fetchSpy.mockResolvedValueOnce(
|
||||
createOpenAIStreamResponse({
|
||||
toolCalls: [
|
||||
{
|
||||
id: 'call_123',
|
||||
name: 'lobe-web-browsing____search____builtin',
|
||||
arguments: JSON.stringify({ query: 'weather' }),
|
||||
},
|
||||
],
|
||||
finishReason: 'tool_calls',
|
||||
}),
|
||||
);
|
||||
fetchSpy.mockResolvedValueOnce(createOpenAIStreamResponse({
|
||||
toolCalls: [{
|
||||
id: 'call_123',
|
||||
name: 'lobe-web-browsing____search____builtin',
|
||||
arguments: JSON.stringify({ query: 'weather' }),
|
||||
}],
|
||||
finishReason: 'tool_calls',
|
||||
}));
|
||||
// ... execute test
|
||||
});
|
||||
```
|
||||
|
||||
@@ -19,24 +19,18 @@ cd packages/database && TEST_SERVER_DB=1 bunx vitest run --silent='passed-only'
|
||||
```typescript
|
||||
// ❌ DANGEROUS: Missing permission check
|
||||
update = async (id: string, data: Partial<MyModel>) => {
|
||||
return this.db
|
||||
.update(myTable)
|
||||
.set(data)
|
||||
.where(eq(myTable.id, id)) // Only checks ID
|
||||
return this.db.update(myTable).set(data)
|
||||
.where(eq(myTable.id, id)) // Only checks ID
|
||||
.returning();
|
||||
};
|
||||
|
||||
// ✅ SECURE: Permission check included
|
||||
update = async (id: string, data: Partial<MyModel>) => {
|
||||
return this.db
|
||||
.update(myTable)
|
||||
.set(data)
|
||||
.where(
|
||||
and(
|
||||
eq(myTable.id, id),
|
||||
eq(myTable.userId, this.userId), // ✅ Permission check
|
||||
),
|
||||
)
|
||||
return this.db.update(myTable).set(data)
|
||||
.where(and(
|
||||
eq(myTable.id, id),
|
||||
eq(myTable.userId, this.userId) // ✅ Permission check
|
||||
))
|
||||
.returning();
|
||||
};
|
||||
```
|
||||
@@ -46,22 +40,18 @@ update = async (id: string, data: Partial<MyModel>) => {
|
||||
```typescript
|
||||
// @vitest-environment node
|
||||
describe('MyModel', () => {
|
||||
describe('create', () => {
|
||||
/* ... */
|
||||
});
|
||||
describe('queryAll', () => {
|
||||
/* ... */
|
||||
});
|
||||
describe('create', () => { /* ... */ });
|
||||
describe('queryAll', () => { /* ... */ });
|
||||
describe('update', () => {
|
||||
it('should update own records');
|
||||
it('should NOT update other users records'); // 🔒 Security
|
||||
it('should NOT update other users records'); // 🔒 Security
|
||||
});
|
||||
describe('delete', () => {
|
||||
it('should delete own records');
|
||||
it('should NOT delete other users records'); // 🔒 Security
|
||||
it('should NOT delete other users records'); // 🔒 Security
|
||||
});
|
||||
describe('user isolation', () => {
|
||||
it('should enforce user data isolation'); // 🔒 Core security
|
||||
it('should enforce user data isolation'); // 🔒 Core security
|
||||
});
|
||||
});
|
||||
```
|
||||
@@ -112,10 +102,8 @@ const testData = { asyncTaskId: null, fileId: null };
|
||||
|
||||
// ✅ Or: Create referenced record first
|
||||
beforeEach(async () => {
|
||||
const [asyncTask] = await serverDB
|
||||
.insert(asyncTasks)
|
||||
.values({ id: 'valid-id', status: 'pending' })
|
||||
.returning();
|
||||
const [asyncTask] = await serverDB.insert(asyncTasks)
|
||||
.values({ id: 'valid-id', status: 'pending' }).returning();
|
||||
testData.asyncTaskId = asyncTask.id;
|
||||
});
|
||||
```
|
||||
@@ -132,5 +120,5 @@ await serverDB.insert(table).values([
|
||||
]);
|
||||
|
||||
// ❌ Don't rely on insert order
|
||||
await serverDB.insert(table).values([data1, data2]); // Unpredictable
|
||||
await serverDB.insert(table).values([data1, data2]); // Unpredictable
|
||||
```
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## Testing Framework & Directory Structure
|
||||
|
||||
LobeHub Desktop uses Vitest as the test framework. Controller unit tests should be placed in the `__tests__` directory adjacent to the controller file, named with the original controller filename plus `.test.ts`.
|
||||
LobeChat Desktop uses Vitest as the test framework. Controller unit tests should be placed in the `__tests__` directory adjacent to the controller file, named with the original controller filename plus `.test.ts`.
|
||||
|
||||
```plaintext
|
||||
apps/desktop/src/main/controllers/
|
||||
|
||||
@@ -11,14 +11,11 @@ vi.mock('zustand/traditional');
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
useChatStore.setState(
|
||||
{
|
||||
activeId: 'test-session-id',
|
||||
messagesMap: {},
|
||||
loadingIds: [],
|
||||
},
|
||||
false,
|
||||
);
|
||||
useChatStore.setState({
|
||||
activeId: 'test-session-id',
|
||||
messagesMap: {},
|
||||
loadingIds: [],
|
||||
}, false);
|
||||
|
||||
vi.spyOn(messageService, 'createMessage').mockResolvedValue('new-message-id');
|
||||
|
||||
@@ -135,7 +132,6 @@ it('should fetch data', async () => {
|
||||
```
|
||||
|
||||
**Key points for SWR:**
|
||||
|
||||
- DO NOT mock useSWR - let it use real implementation
|
||||
- Only mock service methods (fetchers)
|
||||
- Use `waitFor` for async operations
|
||||
|
||||
@@ -50,4 +50,3 @@ description: TypeScript code style and optimization guidelines. Use when writing
|
||||
- Never log user private information (API keys, etc.)
|
||||
- Don't use `import { log } from 'debug'` directly (logs to console)
|
||||
- Use `console.error` in catch blocks instead of debug package
|
||||
- Always log the error in `.catch()` callbacks — silent `.catch(() => fallback)` swallows failures and makes debugging impossible
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,389 +0,0 @@
|
||||
# Cloud Project Workflow Configuration
|
||||
|
||||
This document covers cloud-specific workflow configurations and patterns for the lobehub-cloud project.
|
||||
|
||||
## Overview
|
||||
|
||||
The lobehub-cloud project extends the open-source lobehub codebase with cloud-specific features. Workflows can be implemented in either:
|
||||
|
||||
1. **Lobehub (open-source)** - Available to all users
|
||||
2. **Lobehub-cloud (proprietary)** - Cloud-specific business logic
|
||||
|
||||
---
|
||||
|
||||
## Directory Structure
|
||||
|
||||
### Lobehub Submodule (Open-source)
|
||||
|
||||
```
|
||||
lobehub/
|
||||
└── src/
|
||||
├── app/(backend)/api/workflows/
|
||||
│ ├── memory-user-memory/ # Memory extraction workflows
|
||||
│ └── agent-eval-run/ # Benchmark evaluation workflows
|
||||
└── server/workflows/
|
||||
├── agentEvalRun/
|
||||
└── ...
|
||||
```
|
||||
|
||||
### Lobehub-cloud (Proprietary)
|
||||
|
||||
```
|
||||
lobehub-cloud/
|
||||
└── src/
|
||||
├── app/(backend)/api/workflows/
|
||||
│ ├── welcome-placeholder/ # Cloud-only: AI placeholder generation
|
||||
│ ├── agent-welcome/ # Cloud-only: Agent welcome messages
|
||||
│ ├── agent-eval-run/ # Re-export from lobehub
|
||||
│ └── memory-user-memory/ # Re-export from lobehub
|
||||
└── server/workflows/
|
||||
├── welcomePlaceholder/
|
||||
├── agentWelcome/
|
||||
└── agentEvalRun/ # Re-export from lobehub
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Cloud-Specific Patterns
|
||||
|
||||
### Pattern 1: Cloud-Only Workflows
|
||||
|
||||
**Use Case**: Features exclusive to cloud users (AI generation, premium features)
|
||||
|
||||
**Example**: `welcome-placeholder`, `agent-welcome`
|
||||
|
||||
**Implementation**:
|
||||
|
||||
- Implement directly in `lobehub-cloud/src/app/(backend)/api/workflows/`
|
||||
- No need for re-exports
|
||||
- Can use cloud-specific packages and services
|
||||
|
||||
**Structure**:
|
||||
|
||||
```
|
||||
lobehub-cloud/src/
|
||||
├── app/(backend)/api/workflows/
|
||||
│ └── feature-name/
|
||||
│ ├── process-items/route.ts
|
||||
│ ├── paginate-items/route.ts
|
||||
│ └── execute-item/route.ts
|
||||
└── server/workflows/
|
||||
└── featureName/
|
||||
└── index.ts
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Pattern 2: Re-export from Lobehub
|
||||
|
||||
**Use Case**: Workflows implemented in open-source but also used in cloud
|
||||
|
||||
**Example**: `agent-eval-run`, `memory-user-memory`
|
||||
|
||||
**Why Re-export?**
|
||||
|
||||
- Cloud deployment needs to serve these endpoints
|
||||
- Lobehub submodule code is not directly accessible in cloud routes
|
||||
- Allows cloud-specific overrides if needed in the future
|
||||
|
||||
#### Re-export Implementation
|
||||
|
||||
**Step 1**: Implement workflow in lobehub submodule
|
||||
|
||||
```typescript
|
||||
// lobehub/src/app/(backend)/api/workflows/feature/layer/route.ts
|
||||
import { serve } from '@upstash/workflow/nextjs';
|
||||
|
||||
export const { POST } = serve<Payload>(
|
||||
async (context) => {
|
||||
// Implementation
|
||||
},
|
||||
{ flowControl: { ... } }
|
||||
);
|
||||
```
|
||||
|
||||
**Step 2**: Create re-export in lobehub-cloud
|
||||
|
||||
```typescript
|
||||
// lobehub-cloud/src/app/(backend)/api/workflows/feature/layer/route.ts
|
||||
export { POST } from 'lobehub/src/app/(backend)/api/workflows/feature/layer/route';
|
||||
```
|
||||
|
||||
**Important**: Use `lobehub/src/...` path, NOT `@/...` to avoid circular imports.
|
||||
|
||||
#### Re-export Directory Structure
|
||||
|
||||
```bash
|
||||
# Create directories
|
||||
mkdir -p lobehub-cloud/src/app/(backend)/api/workflows/feature-name/layer-1
|
||||
mkdir -p lobehub-cloud/src/app/(backend)/api/workflows/feature-name/layer-2
|
||||
mkdir -p lobehub-cloud/src/app/(backend)/api/workflows/feature-name/layer-3
|
||||
|
||||
# Create re-export files
|
||||
echo "export { POST } from 'lobehub/src/app/(backend)/api/workflows/feature-name/layer-1/route';" > \
|
||||
lobehub-cloud/src/app/(backend)/api/workflows/feature-name/layer-1/route.ts
|
||||
|
||||
echo "export { POST } from 'lobehub/src/app/(backend)/api/workflows/feature-name/layer-2/route';" > \
|
||||
lobehub-cloud/src/app/(backend)/api/workflows/feature-name/layer-2/route.ts
|
||||
|
||||
echo "export { POST } from 'lobehub/src/app/(backend)/api/workflows/feature-name/layer-3/route';" > \
|
||||
lobehub-cloud/src/app/(backend)/api/workflows/feature-name/layer-3/route.ts
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## TypeScript Path Mappings
|
||||
|
||||
The cloud project uses tsconfig path mappings to override lobehub code:
|
||||
|
||||
```json
|
||||
// lobehub-cloud/tsconfig.json
|
||||
{
|
||||
"compilerOptions": {
|
||||
"paths": {
|
||||
"@/*": ["./src/*", "./lobehub/src/*"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Resolution Order**:
|
||||
|
||||
1. `./src/*` (cloud code) - checked first
|
||||
2. `./lobehub/src/*` (open-source) - fallback
|
||||
|
||||
This allows cloud to override specific modules while using lobehub defaults.
|
||||
|
||||
---
|
||||
|
||||
## Workflow Class Location
|
||||
|
||||
### Cloud-Only Workflows
|
||||
|
||||
Place workflow class in cloud:
|
||||
|
||||
```
|
||||
lobehub-cloud/src/server/workflows/featureName/index.ts
|
||||
```
|
||||
|
||||
### Shared Workflows
|
||||
|
||||
Place workflow class in lobehub, re-export in cloud if needed:
|
||||
|
||||
```
|
||||
lobehub/src/server/workflows/featureName/index.ts
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Environment Variables
|
||||
|
||||
Both lobehub and cloud workflows require:
|
||||
|
||||
```bash
|
||||
# Required for all workflows
|
||||
APP_URL=https://your-app.com # Base URL for workflow endpoints
|
||||
QSTASH_TOKEN=qstash_xxx # QStash authentication token
|
||||
|
||||
# Optional (for custom QStash URL)
|
||||
QSTASH_URL=https://custom-qstash.com # Custom QStash endpoint
|
||||
```
|
||||
|
||||
**Cloud-Specific**:
|
||||
|
||||
```bash
|
||||
# Cloud database (for monetization features)
|
||||
CLOUD_DATABASE_URL=postgresql://...
|
||||
|
||||
# Cloud-specific services
|
||||
REDIS_URL=redis://...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Best Practices
|
||||
|
||||
### 1. Decide: Cloud or Open-Source?
|
||||
|
||||
**Implement in Lobehub if**:
|
||||
|
||||
- Feature is useful for all LobeHub users
|
||||
- No proprietary business logic
|
||||
- Can be open-sourced
|
||||
|
||||
**Implement in Cloud if**:
|
||||
|
||||
- Premium/paid feature
|
||||
- Uses cloud-specific services
|
||||
- Contains proprietary algorithms
|
||||
|
||||
### 2. Re-export Pattern
|
||||
|
||||
✅ **Do**:
|
||||
|
||||
```typescript
|
||||
// Simple re-export
|
||||
export { POST } from 'lobehub/src/app/(backend)/api/workflows/feature/route';
|
||||
```
|
||||
|
||||
❌ **Don't**:
|
||||
|
||||
```typescript
|
||||
// Avoid circular imports with @/ path
|
||||
export { POST } from '@/app/(backend)/api/workflows/feature/route'; // ❌
|
||||
```
|
||||
|
||||
### 3. Keep Workflow Logic in Lobehub
|
||||
|
||||
For shared features:
|
||||
|
||||
- Implement core logic in `lobehub/` (open-source)
|
||||
- Only override if cloud needs different behavior
|
||||
- Use re-exports for cloud deployment
|
||||
|
||||
### 4. Directory Naming
|
||||
|
||||
Follow consistent naming across lobehub and cloud:
|
||||
|
||||
```
|
||||
# Both should use same structure
|
||||
lobehub/src/app/(backend)/api/workflows/feature-name/
|
||||
lobehub-cloud/src/app/(backend)/api/workflows/feature-name/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Migration Guide
|
||||
|
||||
### Moving Workflow from Cloud to Lobehub
|
||||
|
||||
**Step 1**: Copy workflow to lobehub
|
||||
|
||||
```bash
|
||||
cp -r lobehub-cloud/src/app/(backend)/api/workflows/feature \
|
||||
lobehub/src/app/(backend)/api/workflows/
|
||||
```
|
||||
|
||||
**Step 2**: Remove cloud-specific dependencies
|
||||
|
||||
- Replace cloud services with generic interfaces
|
||||
- Remove proprietary business logic
|
||||
- Update imports to use lobehub paths
|
||||
|
||||
**Step 3**: Create re-exports in cloud
|
||||
|
||||
```typescript
|
||||
// lobehub-cloud/src/app/(backend)/api/workflows/feature/*/route.ts
|
||||
export { POST } from 'lobehub/src/app/(backend)/api/workflows/feature/*/route';
|
||||
```
|
||||
|
||||
**Step 4**: Move workflow class to lobehub
|
||||
|
||||
```bash
|
||||
mv lobehub-cloud/src/server/workflows/feature \
|
||||
lobehub/src/server/workflows/
|
||||
```
|
||||
|
||||
**Step 5**: Update cloud imports
|
||||
|
||||
```typescript
|
||||
// Change from
|
||||
import { Workflow } from '@/server/workflows/feature';
|
||||
|
||||
// To
|
||||
import { Workflow } from 'lobehub/src/server/workflows/feature';
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
### Cloud-Only Workflow: welcome-placeholder
|
||||
|
||||
**Location**: `lobehub-cloud/src/app/(backend)/api/workflows/welcome-placeholder/`
|
||||
|
||||
**Why Cloud-Only**: Uses proprietary AI generation service and Redis caching
|
||||
|
||||
**Structure**:
|
||||
|
||||
```
|
||||
lobehub-cloud/
|
||||
├── src/app/(backend)/api/workflows/welcome-placeholder/
|
||||
│ ├── process-users/route.ts
|
||||
│ ├── paginate-users/route.ts
|
||||
│ └── generate-user/route.ts
|
||||
└── src/server/workflows/welcomePlaceholder/
|
||||
└── index.ts
|
||||
```
|
||||
|
||||
### Re-exported Workflow: agent-eval-run
|
||||
|
||||
**Location**:
|
||||
|
||||
- Implementation: `lobehub/src/app/(backend)/api/workflows/agent-eval-run/`
|
||||
- Re-export: `lobehub-cloud/src/app/(backend)/api/workflows/agent-eval-run/`
|
||||
|
||||
**Why Re-export**: Core feature available in open-source, also used by cloud
|
||||
|
||||
**Cloud Re-export Files**:
|
||||
|
||||
```typescript
|
||||
// lobehub-cloud/src/app/(backend)/api/workflows/agent-eval-run/run-benchmark/route.ts
|
||||
export { POST } from 'lobehub/src/app/(backend)/api/workflows/agent-eval-run/run-benchmark/route';
|
||||
|
||||
// lobehub-cloud/src/app/(backend)/api/workflows/agent-eval-run/paginate-test-cases/route.ts
|
||||
export { POST } from 'lobehub/src/app/(backend)/api/workflows/agent-eval-run/paginate-test-cases/route';
|
||||
|
||||
// ... (all layers)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Circular Import Error
|
||||
|
||||
**Error**: `Circular definition of import alias 'POST'`
|
||||
|
||||
**Cause**: Using `@/` path in re-export within cloud codebase
|
||||
|
||||
**Solution**: Use `lobehub/src/` path instead
|
||||
|
||||
```typescript
|
||||
// ❌ Wrong
|
||||
export { POST } from '@/app/(backend)/api/workflows/feature/route';
|
||||
|
||||
// ✅ Correct
|
||||
export { POST } from 'lobehub/src/app/(backend)/api/workflows/feature/route';
|
||||
```
|
||||
|
||||
### Workflow Not Found (404)
|
||||
|
||||
**Cause**: Missing re-export in cloud
|
||||
|
||||
**Solution**: Create re-export files for all workflow layers
|
||||
|
||||
```bash
|
||||
# Check if re-export exists
|
||||
ls lobehub-cloud/src/app/\(backend\)/api/workflows/feature-name/
|
||||
|
||||
# If missing, create re-exports
|
||||
mkdir -p lobehub-cloud/src/app/\(backend\)/api/workflows/feature-name/layer
|
||||
echo "export { POST } from 'lobehub/src/app/(backend)/api/workflows/feature-name/layer/route';" > lobehub-cloud/src/app/\(backend\)/api/workflows/feature-name/layer/route.ts
|
||||
```
|
||||
|
||||
### Type Errors After Moving to Lobehub
|
||||
|
||||
**Cause**: Cloud-specific types or services used in lobehub code
|
||||
|
||||
**Solution**:
|
||||
|
||||
1. Extract cloud-specific logic to cloud-only wrapper
|
||||
2. Use dependency injection for services
|
||||
3. Define generic interfaces in lobehub
|
||||
|
||||
---
|
||||
|
||||
## Related Documentation
|
||||
|
||||
- [SKILL.md](../SKILL.md) - Standard workflow patterns
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,125 @@
|
||||
---
|
||||
name: vercel-react-best-practices
|
||||
description: React and Next.js performance optimization guidelines from Vercel Engineering. This skill should be used when writing, reviewing, or refactoring React/Next.js code to ensure optimal performance patterns. Triggers on tasks involving React components, Next.js pages, data fetching, bundle optimization, or performance improvements.
|
||||
license: MIT
|
||||
metadata:
|
||||
author: vercel
|
||||
version: "1.0.0"
|
||||
---
|
||||
|
||||
# Vercel React Best Practices
|
||||
|
||||
Comprehensive performance optimization guide for React and Next.js applications, maintained by Vercel. Contains 45 rules across 8 categories, prioritized by impact to guide automated refactoring and code generation.
|
||||
|
||||
## When to Apply
|
||||
|
||||
Reference these guidelines when:
|
||||
- Writing new React components or Next.js pages
|
||||
- Implementing data fetching (client or server-side)
|
||||
- Reviewing code for performance issues
|
||||
- Refactoring existing React/Next.js code
|
||||
- Optimizing bundle size or load times
|
||||
|
||||
## Rule Categories by Priority
|
||||
|
||||
| Priority | Category | Impact | Prefix |
|
||||
|----------|----------|--------|--------|
|
||||
| 1 | Eliminating Waterfalls | CRITICAL | `async-` |
|
||||
| 2 | Bundle Size Optimization | CRITICAL | `bundle-` |
|
||||
| 3 | Server-Side Performance | HIGH | `server-` |
|
||||
| 4 | Client-Side Data Fetching | MEDIUM-HIGH | `client-` |
|
||||
| 5 | Re-render Optimization | MEDIUM | `rerender-` |
|
||||
| 6 | Rendering Performance | MEDIUM | `rendering-` |
|
||||
| 7 | JavaScript Performance | LOW-MEDIUM | `js-` |
|
||||
| 8 | Advanced Patterns | LOW | `advanced-` |
|
||||
|
||||
## Quick Reference
|
||||
|
||||
### 1. Eliminating Waterfalls (CRITICAL)
|
||||
|
||||
- `async-defer-await` - Move await into branches where actually used
|
||||
- `async-parallel` - Use Promise.all() for independent operations
|
||||
- `async-dependencies` - Use better-all for partial dependencies
|
||||
- `async-api-routes` - Start promises early, await late in API routes
|
||||
- `async-suspense-boundaries` - Use Suspense to stream content
|
||||
|
||||
### 2. Bundle Size Optimization (CRITICAL)
|
||||
|
||||
- `bundle-barrel-imports` - Import directly, avoid barrel files
|
||||
- `bundle-dynamic-imports` - Use next/dynamic for heavy components
|
||||
- `bundle-defer-third-party` - Load analytics/logging after hydration
|
||||
- `bundle-conditional` - Load modules only when feature is activated
|
||||
- `bundle-preload` - Preload on hover/focus for perceived speed
|
||||
|
||||
### 3. Server-Side Performance (HIGH)
|
||||
|
||||
- `server-cache-react` - Use React.cache() for per-request deduplication
|
||||
- `server-cache-lru` - Use LRU cache for cross-request caching
|
||||
- `server-serialization` - Minimize data passed to client components
|
||||
- `server-parallel-fetching` - Restructure components to parallelize fetches
|
||||
- `server-after-nonblocking` - Use after() for non-blocking operations
|
||||
|
||||
### 4. Client-Side Data Fetching (MEDIUM-HIGH)
|
||||
|
||||
- `client-swr-dedup` - Use SWR for automatic request deduplication
|
||||
- `client-event-listeners` - Deduplicate global event listeners
|
||||
|
||||
### 5. Re-render Optimization (MEDIUM)
|
||||
|
||||
- `rerender-defer-reads` - Don't subscribe to state only used in callbacks
|
||||
- `rerender-memo` - Extract expensive work into memoized components
|
||||
- `rerender-dependencies` - Use primitive dependencies in effects
|
||||
- `rerender-derived-state` - Subscribe to derived booleans, not raw values
|
||||
- `rerender-functional-setstate` - Use functional setState for stable callbacks
|
||||
- `rerender-lazy-state-init` - Pass function to useState for expensive values
|
||||
- `rerender-transitions` - Use startTransition for non-urgent updates
|
||||
|
||||
### 6. Rendering Performance (MEDIUM)
|
||||
|
||||
- `rendering-animate-svg-wrapper` - Animate div wrapper, not SVG element
|
||||
- `rendering-content-visibility` - Use content-visibility for long lists
|
||||
- `rendering-hoist-jsx` - Extract static JSX outside components
|
||||
- `rendering-svg-precision` - Reduce SVG coordinate precision
|
||||
- `rendering-hydration-no-flicker` - Use inline script for client-only data
|
||||
- `rendering-activity` - Use Activity component for show/hide
|
||||
- `rendering-conditional-render` - Use ternary, not && for conditionals
|
||||
|
||||
### 7. JavaScript Performance (LOW-MEDIUM)
|
||||
|
||||
- `js-batch-dom-css` - Group CSS changes via classes or cssText
|
||||
- `js-index-maps` - Build Map for repeated lookups
|
||||
- `js-cache-property-access` - Cache object properties in loops
|
||||
- `js-cache-function-results` - Cache function results in module-level Map
|
||||
- `js-cache-storage` - Cache localStorage/sessionStorage reads
|
||||
- `js-combine-iterations` - Combine multiple filter/map into one loop
|
||||
- `js-length-check-first` - Check array length before expensive comparison
|
||||
- `js-early-exit` - Return early from functions
|
||||
- `js-hoist-regexp` - Hoist RegExp creation outside loops
|
||||
- `js-min-max-loop` - Use loop for min/max instead of sort
|
||||
- `js-set-map-lookups` - Use Set/Map for O(1) lookups
|
||||
- `js-tosorted-immutable` - Use toSorted() for immutability
|
||||
|
||||
### 8. Advanced Patterns (LOW)
|
||||
|
||||
- `advanced-event-handler-refs` - Store event handlers in refs
|
||||
- `advanced-use-latest` - useLatest for stable callback refs
|
||||
|
||||
## How to Use
|
||||
|
||||
Read individual rule files for detailed explanations and code examples:
|
||||
|
||||
```
|
||||
rules/async-parallel.md
|
||||
rules/bundle-barrel-imports.md
|
||||
rules/_sections.md
|
||||
```
|
||||
|
||||
Each rule file contains:
|
||||
- Brief explanation of why it matters
|
||||
- Incorrect code example with explanation
|
||||
- Correct code example with explanation
|
||||
- Additional context and references
|
||||
|
||||
## Full Compiled Document
|
||||
|
||||
For the complete guide with all rules expanded: `AGENTS.md`
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: Store Event Handlers in Refs
|
||||
impact: LOW
|
||||
impactDescription: stable subscriptions
|
||||
tags: advanced, hooks, refs, event-handlers, optimization
|
||||
---
|
||||
|
||||
## Store Event Handlers in Refs
|
||||
|
||||
Store callbacks in refs when used in effects that shouldn't re-subscribe on callback changes.
|
||||
|
||||
**Incorrect (re-subscribes on every render):**
|
||||
|
||||
```tsx
|
||||
function useWindowEvent(event: string, handler: (e) => void) {
|
||||
useEffect(() => {
|
||||
window.addEventListener(event, handler)
|
||||
return () => window.removeEventListener(event, handler)
|
||||
}, [event, handler])
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (stable subscription):**
|
||||
|
||||
```tsx
|
||||
function useWindowEvent(event: string, handler: (e) => void) {
|
||||
const handlerRef = useRef(handler)
|
||||
useEffect(() => {
|
||||
handlerRef.current = handler
|
||||
}, [handler])
|
||||
|
||||
useEffect(() => {
|
||||
const listener = (e) => handlerRef.current(e)
|
||||
window.addEventListener(event, listener)
|
||||
return () => window.removeEventListener(event, listener)
|
||||
}, [event])
|
||||
}
|
||||
```
|
||||
|
||||
**Alternative: use `useEffectEvent` if you're on latest React:**
|
||||
|
||||
```tsx
|
||||
import { useEffectEvent } from 'react'
|
||||
|
||||
function useWindowEvent(event: string, handler: (e) => void) {
|
||||
const onEvent = useEffectEvent(handler)
|
||||
|
||||
useEffect(() => {
|
||||
window.addEventListener(event, onEvent)
|
||||
return () => window.removeEventListener(event, onEvent)
|
||||
}, [event])
|
||||
}
|
||||
```
|
||||
|
||||
`useEffectEvent` provides a cleaner API for the same pattern: it creates a stable function reference that always calls the latest version of the handler.
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
title: useLatest for Stable Callback Refs
|
||||
impact: LOW
|
||||
impactDescription: prevents effect re-runs
|
||||
tags: advanced, hooks, useLatest, refs, optimization
|
||||
---
|
||||
|
||||
## useLatest for Stable Callback Refs
|
||||
|
||||
Access latest values in callbacks without adding them to dependency arrays. Prevents effect re-runs while avoiding stale closures.
|
||||
|
||||
**Implementation:**
|
||||
|
||||
```typescript
|
||||
function useLatest<T>(value: T) {
|
||||
const ref = useRef(value)
|
||||
useLayoutEffect(() => {
|
||||
ref.current = value
|
||||
}, [value])
|
||||
return ref
|
||||
}
|
||||
```
|
||||
|
||||
**Incorrect (effect re-runs on every callback change):**
|
||||
|
||||
```tsx
|
||||
function SearchInput({ onSearch }: { onSearch: (q: string) => void }) {
|
||||
const [query, setQuery] = useState('')
|
||||
|
||||
useEffect(() => {
|
||||
const timeout = setTimeout(() => onSearch(query), 300)
|
||||
return () => clearTimeout(timeout)
|
||||
}, [query, onSearch])
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (stable effect, fresh callback):**
|
||||
|
||||
```tsx
|
||||
function SearchInput({ onSearch }: { onSearch: (q: string) => void }) {
|
||||
const [query, setQuery] = useState('')
|
||||
const onSearchRef = useLatest(onSearch)
|
||||
|
||||
useEffect(() => {
|
||||
const timeout = setTimeout(() => onSearchRef.current(query), 300)
|
||||
return () => clearTimeout(timeout)
|
||||
}, [query])
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
title: Prevent Waterfall Chains in API Routes
|
||||
impact: CRITICAL
|
||||
impactDescription: 2-10× improvement
|
||||
tags: api-routes, server-actions, waterfalls, parallelization
|
||||
---
|
||||
|
||||
## Prevent Waterfall Chains in API Routes
|
||||
|
||||
In API routes and Server Actions, start independent operations immediately, even if you don't await them yet.
|
||||
|
||||
**Incorrect (config waits for auth, data waits for both):**
|
||||
|
||||
```typescript
|
||||
export async function GET(request: Request) {
|
||||
const session = await auth()
|
||||
const config = await fetchConfig()
|
||||
const data = await fetchData(session.user.id)
|
||||
return Response.json({ data, config })
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (auth and config start immediately):**
|
||||
|
||||
```typescript
|
||||
export async function GET(request: Request) {
|
||||
const sessionPromise = auth()
|
||||
const configPromise = fetchConfig()
|
||||
const session = await sessionPromise
|
||||
const [config, data] = await Promise.all([
|
||||
configPromise,
|
||||
fetchData(session.user.id)
|
||||
])
|
||||
return Response.json({ data, config })
|
||||
}
|
||||
```
|
||||
|
||||
For operations with more complex dependency chains, use `better-all` to automatically maximize parallelism (see Dependency-Based Parallelization).
|
||||
@@ -0,0 +1,80 @@
|
||||
---
|
||||
title: Defer Await Until Needed
|
||||
impact: HIGH
|
||||
impactDescription: avoids blocking unused code paths
|
||||
tags: async, await, conditional, optimization
|
||||
---
|
||||
|
||||
## Defer Await Until Needed
|
||||
|
||||
Move `await` operations into the branches where they're actually used to avoid blocking code paths that don't need them.
|
||||
|
||||
**Incorrect (blocks both branches):**
|
||||
|
||||
```typescript
|
||||
async function handleRequest(userId: string, skipProcessing: boolean) {
|
||||
const userData = await fetchUserData(userId)
|
||||
|
||||
if (skipProcessing) {
|
||||
// Returns immediately but still waited for userData
|
||||
return { skipped: true }
|
||||
}
|
||||
|
||||
// Only this branch uses userData
|
||||
return processUserData(userData)
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (only blocks when needed):**
|
||||
|
||||
```typescript
|
||||
async function handleRequest(userId: string, skipProcessing: boolean) {
|
||||
if (skipProcessing) {
|
||||
// Returns immediately without waiting
|
||||
return { skipped: true }
|
||||
}
|
||||
|
||||
// Fetch only when needed
|
||||
const userData = await fetchUserData(userId)
|
||||
return processUserData(userData)
|
||||
}
|
||||
```
|
||||
|
||||
**Another example (early return optimization):**
|
||||
|
||||
```typescript
|
||||
// Incorrect: always fetches permissions
|
||||
async function updateResource(resourceId: string, userId: string) {
|
||||
const permissions = await fetchPermissions(userId)
|
||||
const resource = await getResource(resourceId)
|
||||
|
||||
if (!resource) {
|
||||
return { error: 'Not found' }
|
||||
}
|
||||
|
||||
if (!permissions.canEdit) {
|
||||
return { error: 'Forbidden' }
|
||||
}
|
||||
|
||||
return await updateResourceData(resource, permissions)
|
||||
}
|
||||
|
||||
// Correct: fetches only when needed
|
||||
async function updateResource(resourceId: string, userId: string) {
|
||||
const resource = await getResource(resourceId)
|
||||
|
||||
if (!resource) {
|
||||
return { error: 'Not found' }
|
||||
}
|
||||
|
||||
const permissions = await fetchPermissions(userId)
|
||||
|
||||
if (!permissions.canEdit) {
|
||||
return { error: 'Forbidden' }
|
||||
}
|
||||
|
||||
return await updateResourceData(resource, permissions)
|
||||
}
|
||||
```
|
||||
|
||||
This optimization is especially valuable when the skipped branch is frequently taken, or when the deferred operation is expensive.
|
||||
@@ -0,0 +1,36 @@
|
||||
---
|
||||
title: Dependency-Based Parallelization
|
||||
impact: CRITICAL
|
||||
impactDescription: 2-10× improvement
|
||||
tags: async, parallelization, dependencies, better-all
|
||||
---
|
||||
|
||||
## Dependency-Based Parallelization
|
||||
|
||||
For operations with partial dependencies, use `better-all` to maximize parallelism. It automatically starts each task at the earliest possible moment.
|
||||
|
||||
**Incorrect (profile waits for config unnecessarily):**
|
||||
|
||||
```typescript
|
||||
const [user, config] = await Promise.all([
|
||||
fetchUser(),
|
||||
fetchConfig()
|
||||
])
|
||||
const profile = await fetchProfile(user.id)
|
||||
```
|
||||
|
||||
**Correct (config and profile run in parallel):**
|
||||
|
||||
```typescript
|
||||
import { all } from 'better-all'
|
||||
|
||||
const { user, config, profile } = await all({
|
||||
async user() { return fetchUser() },
|
||||
async config() { return fetchConfig() },
|
||||
async profile() {
|
||||
return fetchProfile((await this.$.user).id)
|
||||
}
|
||||
})
|
||||
```
|
||||
|
||||
Reference: [https://github.com/shuding/better-all](https://github.com/shuding/better-all)
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: Promise.all() for Independent Operations
|
||||
impact: CRITICAL
|
||||
impactDescription: 2-10× improvement
|
||||
tags: async, parallelization, promises, waterfalls
|
||||
---
|
||||
|
||||
## Promise.all() for Independent Operations
|
||||
|
||||
When async operations have no interdependencies, execute them concurrently using `Promise.all()`.
|
||||
|
||||
**Incorrect (sequential execution, 3 round trips):**
|
||||
|
||||
```typescript
|
||||
const user = await fetchUser()
|
||||
const posts = await fetchPosts()
|
||||
const comments = await fetchComments()
|
||||
```
|
||||
|
||||
**Correct (parallel execution, 1 round trip):**
|
||||
|
||||
```typescript
|
||||
const [user, posts, comments] = await Promise.all([
|
||||
fetchUser(),
|
||||
fetchPosts(),
|
||||
fetchComments()
|
||||
])
|
||||
```
|
||||
@@ -0,0 +1,99 @@
|
||||
---
|
||||
title: Strategic Suspense Boundaries
|
||||
impact: HIGH
|
||||
impactDescription: faster initial paint
|
||||
tags: async, suspense, streaming, layout-shift
|
||||
---
|
||||
|
||||
## Strategic Suspense Boundaries
|
||||
|
||||
Instead of awaiting data in async components before returning JSX, use Suspense boundaries to show the wrapper UI faster while data loads.
|
||||
|
||||
**Incorrect (wrapper blocked by data fetching):**
|
||||
|
||||
```tsx
|
||||
async function Page() {
|
||||
const data = await fetchData() // Blocks entire page
|
||||
|
||||
return (
|
||||
<div>
|
||||
<div>Sidebar</div>
|
||||
<div>Header</div>
|
||||
<div>
|
||||
<DataDisplay data={data} />
|
||||
</div>
|
||||
<div>Footer</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
The entire layout waits for data even though only the middle section needs it.
|
||||
|
||||
**Correct (wrapper shows immediately, data streams in):**
|
||||
|
||||
```tsx
|
||||
function Page() {
|
||||
return (
|
||||
<div>
|
||||
<div>Sidebar</div>
|
||||
<div>Header</div>
|
||||
<div>
|
||||
<Suspense fallback={<Skeleton />}>
|
||||
<DataDisplay />
|
||||
</Suspense>
|
||||
</div>
|
||||
<div>Footer</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
|
||||
async function DataDisplay() {
|
||||
const data = await fetchData() // Only blocks this component
|
||||
return <div>{data.content}</div>
|
||||
}
|
||||
```
|
||||
|
||||
Sidebar, Header, and Footer render immediately. Only DataDisplay waits for data.
|
||||
|
||||
**Alternative (share promise across components):**
|
||||
|
||||
```tsx
|
||||
function Page() {
|
||||
// Start fetch immediately, but don't await
|
||||
const dataPromise = fetchData()
|
||||
|
||||
return (
|
||||
<div>
|
||||
<div>Sidebar</div>
|
||||
<div>Header</div>
|
||||
<Suspense fallback={<Skeleton />}>
|
||||
<DataDisplay dataPromise={dataPromise} />
|
||||
<DataSummary dataPromise={dataPromise} />
|
||||
</Suspense>
|
||||
<div>Footer</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
|
||||
function DataDisplay({ dataPromise }: { dataPromise: Promise<Data> }) {
|
||||
const data = use(dataPromise) // Unwraps the promise
|
||||
return <div>{data.content}</div>
|
||||
}
|
||||
|
||||
function DataSummary({ dataPromise }: { dataPromise: Promise<Data> }) {
|
||||
const data = use(dataPromise) // Reuses the same promise
|
||||
return <div>{data.summary}</div>
|
||||
}
|
||||
```
|
||||
|
||||
Both components share the same promise, so only one fetch occurs. Layout renders immediately while both components wait together.
|
||||
|
||||
**When NOT to use this pattern:**
|
||||
|
||||
- Critical data needed for layout decisions (affects positioning)
|
||||
- SEO-critical content above the fold
|
||||
- Small, fast queries where suspense overhead isn't worth it
|
||||
- When you want to avoid layout shift (loading → content jump)
|
||||
|
||||
**Trade-off:** Faster initial paint vs potential layout shift. Choose based on your UX priorities.
|
||||
@@ -0,0 +1,59 @@
|
||||
---
|
||||
title: Avoid Barrel File Imports
|
||||
impact: CRITICAL
|
||||
impactDescription: 200-800ms import cost, slow builds
|
||||
tags: bundle, imports, tree-shaking, barrel-files, performance
|
||||
---
|
||||
|
||||
## Avoid Barrel File Imports
|
||||
|
||||
Import directly from source files instead of barrel files to avoid loading thousands of unused modules. **Barrel files** are entry points that re-export multiple modules (e.g., `index.js` that does `export * from './module'`).
|
||||
|
||||
Popular icon and component libraries can have **up to 10,000 re-exports** in their entry file. For many React packages, **it takes 200-800ms just to import them**, affecting both development speed and production cold starts.
|
||||
|
||||
**Why tree-shaking doesn't help:** When a library is marked as external (not bundled), the bundler can't optimize it. If you bundle it to enable tree-shaking, builds become substantially slower analyzing the entire module graph.
|
||||
|
||||
**Incorrect (imports entire library):**
|
||||
|
||||
```tsx
|
||||
import { Check, X, Menu } from 'lucide-react'
|
||||
// Loads 1,583 modules, takes ~2.8s extra in dev
|
||||
// Runtime cost: 200-800ms on every cold start
|
||||
|
||||
import { Button, TextField } from '@mui/material'
|
||||
// Loads 2,225 modules, takes ~4.2s extra in dev
|
||||
```
|
||||
|
||||
**Correct (imports only what you need):**
|
||||
|
||||
```tsx
|
||||
import Check from 'lucide-react/dist/esm/icons/check'
|
||||
import X from 'lucide-react/dist/esm/icons/x'
|
||||
import Menu from 'lucide-react/dist/esm/icons/menu'
|
||||
// Loads only 3 modules (~2KB vs ~1MB)
|
||||
|
||||
import Button from '@mui/material/Button'
|
||||
import TextField from '@mui/material/TextField'
|
||||
// Loads only what you use
|
||||
```
|
||||
|
||||
**Alternative (Next.js 13.5+):**
|
||||
|
||||
```js
|
||||
// next.config.js - use optimizePackageImports
|
||||
module.exports = {
|
||||
experimental: {
|
||||
optimizePackageImports: ['lucide-react', '@mui/material']
|
||||
}
|
||||
}
|
||||
|
||||
// Then you can keep the ergonomic barrel imports:
|
||||
import { Check, X, Menu } from 'lucide-react'
|
||||
// Automatically transformed to direct imports at build time
|
||||
```
|
||||
|
||||
Direct imports provide 15-70% faster dev boot, 28% faster builds, 40% faster cold starts, and significantly faster HMR.
|
||||
|
||||
Libraries commonly affected: `lucide-react`, `@mui/material`, `@mui/icons-material`, `@tabler/icons-react`, `react-icons`, `@headlessui/react`, `@radix-ui/react-*`, `lodash`, `ramda`, `date-fns`, `rxjs`, `react-use`.
|
||||
|
||||
Reference: [How we optimized package imports in Next.js](https://vercel.com/blog/how-we-optimized-package-imports-in-next-js)
|
||||
@@ -0,0 +1,31 @@
|
||||
---
|
||||
title: Conditional Module Loading
|
||||
impact: HIGH
|
||||
impactDescription: loads large data only when needed
|
||||
tags: bundle, conditional-loading, lazy-loading
|
||||
---
|
||||
|
||||
## Conditional Module Loading
|
||||
|
||||
Load large data or modules only when a feature is activated.
|
||||
|
||||
**Example (lazy-load animation frames):**
|
||||
|
||||
```tsx
|
||||
function AnimationPlayer({ enabled, setEnabled }: { enabled: boolean; setEnabled: React.Dispatch<React.SetStateAction<boolean>> }) {
|
||||
const [frames, setFrames] = useState<Frame[] | null>(null)
|
||||
|
||||
useEffect(() => {
|
||||
if (enabled && !frames && typeof window !== 'undefined') {
|
||||
import('./animation-frames.js')
|
||||
.then(mod => setFrames(mod.frames))
|
||||
.catch(() => setEnabled(false))
|
||||
}
|
||||
}, [enabled, frames, setEnabled])
|
||||
|
||||
if (!frames) return <Skeleton />
|
||||
return <Canvas frames={frames} />
|
||||
}
|
||||
```
|
||||
|
||||
The `typeof window !== 'undefined'` check prevents bundling this module for SSR, optimizing server bundle size and build speed.
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
title: Defer Non-Critical Third-Party Libraries
|
||||
impact: MEDIUM
|
||||
impactDescription: loads after hydration
|
||||
tags: bundle, third-party, analytics, defer
|
||||
---
|
||||
|
||||
## Defer Non-Critical Third-Party Libraries
|
||||
|
||||
Analytics, logging, and error tracking don't block user interaction. Load them after hydration.
|
||||
|
||||
**Incorrect (blocks initial bundle):**
|
||||
|
||||
```tsx
|
||||
import { Analytics } from '@vercel/analytics/react'
|
||||
|
||||
export default function RootLayout({ children }) {
|
||||
return (
|
||||
<html>
|
||||
<body>
|
||||
{children}
|
||||
<Analytics />
|
||||
</body>
|
||||
</html>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (loads after hydration):**
|
||||
|
||||
```tsx
|
||||
import dynamic from 'next/dynamic'
|
||||
|
||||
const Analytics = dynamic(
|
||||
() => import('@vercel/analytics/react').then(m => m.Analytics),
|
||||
{ ssr: false }
|
||||
)
|
||||
|
||||
export default function RootLayout({ children }) {
|
||||
return (
|
||||
<html>
|
||||
<body>
|
||||
{children}
|
||||
<Analytics />
|
||||
</body>
|
||||
</html>
|
||||
)
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
title: Dynamic Imports for Heavy Components
|
||||
impact: CRITICAL
|
||||
impactDescription: directly affects TTI and LCP
|
||||
tags: bundle, dynamic-import, code-splitting, next-dynamic
|
||||
---
|
||||
|
||||
## Dynamic Imports for Heavy Components
|
||||
|
||||
Use `next/dynamic` to lazy-load large components not needed on initial render.
|
||||
|
||||
**Incorrect (Monaco bundles with main chunk ~300KB):**
|
||||
|
||||
```tsx
|
||||
import { MonacoEditor } from './monaco-editor'
|
||||
|
||||
function CodePanel({ code }: { code: string }) {
|
||||
return <MonacoEditor value={code} />
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (Monaco loads on demand):**
|
||||
|
||||
```tsx
|
||||
import dynamic from 'next/dynamic'
|
||||
|
||||
const MonacoEditor = dynamic(
|
||||
() => import('./monaco-editor').then(m => m.MonacoEditor),
|
||||
{ ssr: false }
|
||||
)
|
||||
|
||||
function CodePanel({ code }: { code: string }) {
|
||||
return <MonacoEditor value={code} />
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Preload Based on User Intent
|
||||
impact: MEDIUM
|
||||
impactDescription: reduces perceived latency
|
||||
tags: bundle, preload, user-intent, hover
|
||||
---
|
||||
|
||||
## Preload Based on User Intent
|
||||
|
||||
Preload heavy bundles before they're needed to reduce perceived latency.
|
||||
|
||||
**Example (preload on hover/focus):**
|
||||
|
||||
```tsx
|
||||
function EditorButton({ onClick }: { onClick: () => void }) {
|
||||
const preload = () => {
|
||||
if (typeof window !== 'undefined') {
|
||||
void import('./monaco-editor')
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<button
|
||||
onMouseEnter={preload}
|
||||
onFocus={preload}
|
||||
onClick={onClick}
|
||||
>
|
||||
Open Editor
|
||||
</button>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
**Example (preload when feature flag is enabled):**
|
||||
|
||||
```tsx
|
||||
function FlagsProvider({ children, flags }: Props) {
|
||||
useEffect(() => {
|
||||
if (flags.editorEnabled && typeof window !== 'undefined') {
|
||||
void import('./monaco-editor').then(mod => mod.init())
|
||||
}
|
||||
}, [flags.editorEnabled])
|
||||
|
||||
return <FlagsContext.Provider value={flags}>
|
||||
{children}
|
||||
</FlagsContext.Provider>
|
||||
}
|
||||
```
|
||||
|
||||
The `typeof window !== 'undefined'` check prevents bundling preloaded modules for SSR, optimizing server bundle size and build speed.
|
||||
@@ -0,0 +1,74 @@
|
||||
---
|
||||
title: Deduplicate Global Event Listeners
|
||||
impact: LOW
|
||||
impactDescription: single listener for N components
|
||||
tags: client, swr, event-listeners, subscription
|
||||
---
|
||||
|
||||
## Deduplicate Global Event Listeners
|
||||
|
||||
Use `useSWRSubscription()` to share global event listeners across component instances.
|
||||
|
||||
**Incorrect (N instances = N listeners):**
|
||||
|
||||
```tsx
|
||||
function useKeyboardShortcut(key: string, callback: () => void) {
|
||||
useEffect(() => {
|
||||
const handler = (e: KeyboardEvent) => {
|
||||
if (e.metaKey && e.key === key) {
|
||||
callback()
|
||||
}
|
||||
}
|
||||
window.addEventListener('keydown', handler)
|
||||
return () => window.removeEventListener('keydown', handler)
|
||||
}, [key, callback])
|
||||
}
|
||||
```
|
||||
|
||||
When using the `useKeyboardShortcut` hook multiple times, each instance will register a new listener.
|
||||
|
||||
**Correct (N instances = 1 listener):**
|
||||
|
||||
```tsx
|
||||
import useSWRSubscription from 'swr/subscription'
|
||||
|
||||
// Module-level Map to track callbacks per key
|
||||
const keyCallbacks = new Map<string, Set<() => void>>()
|
||||
|
||||
function useKeyboardShortcut(key: string, callback: () => void) {
|
||||
// Register this callback in the Map
|
||||
useEffect(() => {
|
||||
if (!keyCallbacks.has(key)) {
|
||||
keyCallbacks.set(key, new Set())
|
||||
}
|
||||
keyCallbacks.get(key)!.add(callback)
|
||||
|
||||
return () => {
|
||||
const set = keyCallbacks.get(key)
|
||||
if (set) {
|
||||
set.delete(callback)
|
||||
if (set.size === 0) {
|
||||
keyCallbacks.delete(key)
|
||||
}
|
||||
}
|
||||
}
|
||||
}, [key, callback])
|
||||
|
||||
useSWRSubscription('global-keydown', () => {
|
||||
const handler = (e: KeyboardEvent) => {
|
||||
if (e.metaKey && keyCallbacks.has(e.key)) {
|
||||
keyCallbacks.get(e.key)!.forEach(cb => cb())
|
||||
}
|
||||
}
|
||||
window.addEventListener('keydown', handler)
|
||||
return () => window.removeEventListener('keydown', handler)
|
||||
})
|
||||
}
|
||||
|
||||
function Profile() {
|
||||
// Multiple shortcuts will share the same listener
|
||||
useKeyboardShortcut('p', () => { /* ... */ })
|
||||
useKeyboardShortcut('k', () => { /* ... */ })
|
||||
// ...
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,71 @@
|
||||
---
|
||||
title: Version and Minimize localStorage Data
|
||||
impact: MEDIUM
|
||||
impactDescription: prevents schema conflicts, reduces storage size
|
||||
tags: client, localStorage, storage, versioning, data-minimization
|
||||
---
|
||||
|
||||
## Version and Minimize localStorage Data
|
||||
|
||||
Add version prefix to keys and store only needed fields. Prevents schema conflicts and accidental storage of sensitive data.
|
||||
|
||||
**Incorrect:**
|
||||
|
||||
```typescript
|
||||
// No version, stores everything, no error handling
|
||||
localStorage.setItem('userConfig', JSON.stringify(fullUserObject))
|
||||
const data = localStorage.getItem('userConfig')
|
||||
```
|
||||
|
||||
**Correct:**
|
||||
|
||||
```typescript
|
||||
const VERSION = 'v2'
|
||||
|
||||
function saveConfig(config: { theme: string; language: string }) {
|
||||
try {
|
||||
localStorage.setItem(`userConfig:${VERSION}`, JSON.stringify(config))
|
||||
} catch {
|
||||
// Throws in incognito/private browsing, quota exceeded, or disabled
|
||||
}
|
||||
}
|
||||
|
||||
function loadConfig() {
|
||||
try {
|
||||
const data = localStorage.getItem(`userConfig:${VERSION}`)
|
||||
return data ? JSON.parse(data) : null
|
||||
} catch {
|
||||
return null
|
||||
}
|
||||
}
|
||||
|
||||
// Migration from v1 to v2
|
||||
function migrate() {
|
||||
try {
|
||||
const v1 = localStorage.getItem('userConfig:v1')
|
||||
if (v1) {
|
||||
const old = JSON.parse(v1)
|
||||
saveConfig({ theme: old.darkMode ? 'dark' : 'light', language: old.lang })
|
||||
localStorage.removeItem('userConfig:v1')
|
||||
}
|
||||
} catch {}
|
||||
}
|
||||
```
|
||||
|
||||
**Store minimal fields from server responses:**
|
||||
|
||||
```typescript
|
||||
// User object has 20+ fields, only store what UI needs
|
||||
function cachePrefs(user: FullUser) {
|
||||
try {
|
||||
localStorage.setItem('prefs:v1', JSON.stringify({
|
||||
theme: user.preferences.theme,
|
||||
notifications: user.preferences.notifications
|
||||
}))
|
||||
} catch {}
|
||||
}
|
||||
```
|
||||
|
||||
**Always wrap in try-catch:** `getItem()` and `setItem()` throw in incognito/private browsing (Safari, Firefox), when quota exceeded, or when disabled.
|
||||
|
||||
**Benefits:** Schema evolution via versioning, reduced storage size, prevents storing tokens/PII/internal flags.
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
title: Use Passive Event Listeners for Scrolling Performance
|
||||
impact: MEDIUM
|
||||
impactDescription: eliminates scroll delay caused by event listeners
|
||||
tags: client, event-listeners, scrolling, performance, touch, wheel
|
||||
---
|
||||
|
||||
## Use Passive Event Listeners for Scrolling Performance
|
||||
|
||||
Add `{ passive: true }` to touch and wheel event listeners to enable immediate scrolling. Browsers normally wait for listeners to finish to check if `preventDefault()` is called, causing scroll delay.
|
||||
|
||||
**Incorrect:**
|
||||
|
||||
```typescript
|
||||
useEffect(() => {
|
||||
const handleTouch = (e: TouchEvent) => console.log(e.touches[0].clientX)
|
||||
const handleWheel = (e: WheelEvent) => console.log(e.deltaY)
|
||||
|
||||
document.addEventListener('touchstart', handleTouch)
|
||||
document.addEventListener('wheel', handleWheel)
|
||||
|
||||
return () => {
|
||||
document.removeEventListener('touchstart', handleTouch)
|
||||
document.removeEventListener('wheel', handleWheel)
|
||||
}
|
||||
}, [])
|
||||
```
|
||||
|
||||
**Correct:**
|
||||
|
||||
```typescript
|
||||
useEffect(() => {
|
||||
const handleTouch = (e: TouchEvent) => console.log(e.touches[0].clientX)
|
||||
const handleWheel = (e: WheelEvent) => console.log(e.deltaY)
|
||||
|
||||
document.addEventListener('touchstart', handleTouch, { passive: true })
|
||||
document.addEventListener('wheel', handleWheel, { passive: true })
|
||||
|
||||
return () => {
|
||||
document.removeEventListener('touchstart', handleTouch)
|
||||
document.removeEventListener('wheel', handleWheel)
|
||||
}
|
||||
}, [])
|
||||
```
|
||||
|
||||
**Use passive when:** tracking/analytics, logging, any listener that doesn't call `preventDefault()`.
|
||||
|
||||
**Don't use passive when:** implementing custom swipe gestures, custom zoom controls, or any listener that needs `preventDefault()`.
|
||||
@@ -0,0 +1,56 @@
|
||||
---
|
||||
title: Use SWR for Automatic Deduplication
|
||||
impact: MEDIUM-HIGH
|
||||
impactDescription: automatic deduplication
|
||||
tags: client, swr, deduplication, data-fetching
|
||||
---
|
||||
|
||||
## Use SWR for Automatic Deduplication
|
||||
|
||||
SWR enables request deduplication, caching, and revalidation across component instances.
|
||||
|
||||
**Incorrect (no deduplication, each instance fetches):**
|
||||
|
||||
```tsx
|
||||
function UserList() {
|
||||
const [users, setUsers] = useState([])
|
||||
useEffect(() => {
|
||||
fetch('/api/users')
|
||||
.then(r => r.json())
|
||||
.then(setUsers)
|
||||
}, [])
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (multiple instances share one request):**
|
||||
|
||||
```tsx
|
||||
import useSWR from 'swr'
|
||||
|
||||
function UserList() {
|
||||
const { data: users } = useSWR('/api/users', fetcher)
|
||||
}
|
||||
```
|
||||
|
||||
**For immutable data:**
|
||||
|
||||
```tsx
|
||||
import { useImmutableSWR } from '@/lib/swr'
|
||||
|
||||
function StaticContent() {
|
||||
const { data } = useImmutableSWR('/api/config', fetcher)
|
||||
}
|
||||
```
|
||||
|
||||
**For mutations:**
|
||||
|
||||
```tsx
|
||||
import { useSWRMutation } from 'swr/mutation'
|
||||
|
||||
function UpdateButton() {
|
||||
const { trigger } = useSWRMutation('/api/user', updateUser)
|
||||
return <button onClick={() => trigger()}>Update</button>
|
||||
}
|
||||
```
|
||||
|
||||
Reference: [https://swr.vercel.app](https://swr.vercel.app)
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
title: Batch DOM CSS Changes
|
||||
impact: MEDIUM
|
||||
impactDescription: reduces reflows/repaints
|
||||
tags: javascript, dom, css, performance, reflow
|
||||
---
|
||||
|
||||
## Batch DOM CSS Changes
|
||||
|
||||
Avoid interleaving style writes with layout reads. When you read a layout property (like `offsetWidth`, `getBoundingClientRect()`, or `getComputedStyle()`) between style changes, the browser is forced to trigger a synchronous reflow.
|
||||
|
||||
**Incorrect (interleaved reads and writes force reflows):**
|
||||
|
||||
```typescript
|
||||
function updateElementStyles(element: HTMLElement) {
|
||||
element.style.width = '100px'
|
||||
const width = element.offsetWidth // Forces reflow
|
||||
element.style.height = '200px'
|
||||
const height = element.offsetHeight // Forces another reflow
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (batch writes, then read once):**
|
||||
|
||||
```typescript
|
||||
function updateElementStyles(element: HTMLElement) {
|
||||
// Batch all writes together
|
||||
element.style.width = '100px'
|
||||
element.style.height = '200px'
|
||||
element.style.backgroundColor = 'blue'
|
||||
element.style.border = '1px solid black'
|
||||
|
||||
// Read after all writes are done (single reflow)
|
||||
const { width, height } = element.getBoundingClientRect()
|
||||
}
|
||||
```
|
||||
|
||||
**Better: use CSS classes**
|
||||
|
||||
```css
|
||||
.highlighted-box {
|
||||
width: 100px;
|
||||
height: 200px;
|
||||
background-color: blue;
|
||||
border: 1px solid black;
|
||||
}
|
||||
```
|
||||
|
||||
```typescript
|
||||
function updateElementStyles(element: HTMLElement) {
|
||||
element.classList.add('highlighted-box')
|
||||
|
||||
const { width, height } = element.getBoundingClientRect()
|
||||
}
|
||||
```
|
||||
|
||||
Prefer CSS classes over inline styles when possible. CSS files are cached by the browser, and classes provide better separation of concerns and are easier to maintain.
|
||||
@@ -0,0 +1,80 @@
|
||||
---
|
||||
title: Cache Repeated Function Calls
|
||||
impact: MEDIUM
|
||||
impactDescription: avoid redundant computation
|
||||
tags: javascript, cache, memoization, performance
|
||||
---
|
||||
|
||||
## Cache Repeated Function Calls
|
||||
|
||||
Use a module-level Map to cache function results when the same function is called repeatedly with the same inputs during render.
|
||||
|
||||
**Incorrect (redundant computation):**
|
||||
|
||||
```typescript
|
||||
function ProjectList({ projects }: { projects: Project[] }) {
|
||||
return (
|
||||
<div>
|
||||
{projects.map(project => {
|
||||
// slugify() called 100+ times for same project names
|
||||
const slug = slugify(project.name)
|
||||
|
||||
return <ProjectCard key={project.id} slug={slug} />
|
||||
})}
|
||||
</div>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (cached results):**
|
||||
|
||||
```typescript
|
||||
// Module-level cache
|
||||
const slugifyCache = new Map<string, string>()
|
||||
|
||||
function cachedSlugify(text: string): string {
|
||||
if (slugifyCache.has(text)) {
|
||||
return slugifyCache.get(text)!
|
||||
}
|
||||
const result = slugify(text)
|
||||
slugifyCache.set(text, result)
|
||||
return result
|
||||
}
|
||||
|
||||
function ProjectList({ projects }: { projects: Project[] }) {
|
||||
return (
|
||||
<div>
|
||||
{projects.map(project => {
|
||||
// Computed only once per unique project name
|
||||
const slug = cachedSlugify(project.name)
|
||||
|
||||
return <ProjectCard key={project.id} slug={slug} />
|
||||
})}
|
||||
</div>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
**Simpler pattern for single-value functions:**
|
||||
|
||||
```typescript
|
||||
let isLoggedInCache: boolean | null = null
|
||||
|
||||
function isLoggedIn(): boolean {
|
||||
if (isLoggedInCache !== null) {
|
||||
return isLoggedInCache
|
||||
}
|
||||
|
||||
isLoggedInCache = document.cookie.includes('auth=')
|
||||
return isLoggedInCache
|
||||
}
|
||||
|
||||
// Clear cache when auth changes
|
||||
function onAuthChange() {
|
||||
isLoggedInCache = null
|
||||
}
|
||||
```
|
||||
|
||||
Use a Map (not a hook) so it works everywhere: utilities, event handlers, not just React components.
|
||||
|
||||
Reference: [How we made the Vercel Dashboard twice as fast](https://vercel.com/blog/how-we-made-the-vercel-dashboard-twice-as-fast)
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: Cache Property Access in Loops
|
||||
impact: LOW-MEDIUM
|
||||
impactDescription: reduces lookups
|
||||
tags: javascript, loops, optimization, caching
|
||||
---
|
||||
|
||||
## Cache Property Access in Loops
|
||||
|
||||
Cache object property lookups in hot paths.
|
||||
|
||||
**Incorrect (3 lookups × N iterations):**
|
||||
|
||||
```typescript
|
||||
for (let i = 0; i < arr.length; i++) {
|
||||
process(obj.config.settings.value)
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (1 lookup total):**
|
||||
|
||||
```typescript
|
||||
const value = obj.config.settings.value
|
||||
const len = arr.length
|
||||
for (let i = 0; i < len; i++) {
|
||||
process(value)
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,70 @@
|
||||
---
|
||||
title: Cache Storage API Calls
|
||||
impact: LOW-MEDIUM
|
||||
impactDescription: reduces expensive I/O
|
||||
tags: javascript, localStorage, storage, caching, performance
|
||||
---
|
||||
|
||||
## Cache Storage API Calls
|
||||
|
||||
`localStorage`, `sessionStorage`, and `document.cookie` are synchronous and expensive. Cache reads in memory.
|
||||
|
||||
**Incorrect (reads storage on every call):**
|
||||
|
||||
```typescript
|
||||
function getTheme() {
|
||||
return localStorage.getItem('theme') ?? 'light'
|
||||
}
|
||||
// Called 10 times = 10 storage reads
|
||||
```
|
||||
|
||||
**Correct (Map cache):**
|
||||
|
||||
```typescript
|
||||
const storageCache = new Map<string, string | null>()
|
||||
|
||||
function getLocalStorage(key: string) {
|
||||
if (!storageCache.has(key)) {
|
||||
storageCache.set(key, localStorage.getItem(key))
|
||||
}
|
||||
return storageCache.get(key)
|
||||
}
|
||||
|
||||
function setLocalStorage(key: string, value: string) {
|
||||
localStorage.setItem(key, value)
|
||||
storageCache.set(key, value) // keep cache in sync
|
||||
}
|
||||
```
|
||||
|
||||
Use a Map (not a hook) so it works everywhere: utilities, event handlers, not just React components.
|
||||
|
||||
**Cookie caching:**
|
||||
|
||||
```typescript
|
||||
let cookieCache: Record<string, string> | null = null
|
||||
|
||||
function getCookie(name: string) {
|
||||
if (!cookieCache) {
|
||||
cookieCache = Object.fromEntries(
|
||||
document.cookie.split('; ').map(c => c.split('='))
|
||||
)
|
||||
}
|
||||
return cookieCache[name]
|
||||
}
|
||||
```
|
||||
|
||||
**Important (invalidate on external changes):**
|
||||
|
||||
If storage can change externally (another tab, server-set cookies), invalidate cache:
|
||||
|
||||
```typescript
|
||||
window.addEventListener('storage', (e) => {
|
||||
if (e.key) storageCache.delete(e.key)
|
||||
})
|
||||
|
||||
document.addEventListener('visibilitychange', () => {
|
||||
if (document.visibilityState === 'visible') {
|
||||
storageCache.clear()
|
||||
}
|
||||
})
|
||||
```
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
title: Combine Multiple Array Iterations
|
||||
impact: LOW-MEDIUM
|
||||
impactDescription: reduces iterations
|
||||
tags: javascript, arrays, loops, performance
|
||||
---
|
||||
|
||||
## Combine Multiple Array Iterations
|
||||
|
||||
Multiple `.filter()` or `.map()` calls iterate the array multiple times. Combine into one loop.
|
||||
|
||||
**Incorrect (3 iterations):**
|
||||
|
||||
```typescript
|
||||
const admins = users.filter(u => u.isAdmin)
|
||||
const testers = users.filter(u => u.isTester)
|
||||
const inactive = users.filter(u => !u.isActive)
|
||||
```
|
||||
|
||||
**Correct (1 iteration):**
|
||||
|
||||
```typescript
|
||||
const admins: User[] = []
|
||||
const testers: User[] = []
|
||||
const inactive: User[] = []
|
||||
|
||||
for (const user of users) {
|
||||
if (user.isAdmin) admins.push(user)
|
||||
if (user.isTester) testers.push(user)
|
||||
if (!user.isActive) inactive.push(user)
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Early Return from Functions
|
||||
impact: LOW-MEDIUM
|
||||
impactDescription: avoids unnecessary computation
|
||||
tags: javascript, functions, optimization, early-return
|
||||
---
|
||||
|
||||
## Early Return from Functions
|
||||
|
||||
Return early when result is determined to skip unnecessary processing.
|
||||
|
||||
**Incorrect (processes all items even after finding answer):**
|
||||
|
||||
```typescript
|
||||
function validateUsers(users: User[]) {
|
||||
let hasError = false
|
||||
let errorMessage = ''
|
||||
|
||||
for (const user of users) {
|
||||
if (!user.email) {
|
||||
hasError = true
|
||||
errorMessage = 'Email required'
|
||||
}
|
||||
if (!user.name) {
|
||||
hasError = true
|
||||
errorMessage = 'Name required'
|
||||
}
|
||||
// Continues checking all users even after error found
|
||||
}
|
||||
|
||||
return hasError ? { valid: false, error: errorMessage } : { valid: true }
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (returns immediately on first error):**
|
||||
|
||||
```typescript
|
||||
function validateUsers(users: User[]) {
|
||||
for (const user of users) {
|
||||
if (!user.email) {
|
||||
return { valid: false, error: 'Email required' }
|
||||
}
|
||||
if (!user.name) {
|
||||
return { valid: false, error: 'Name required' }
|
||||
}
|
||||
}
|
||||
|
||||
return { valid: true }
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: Hoist RegExp Creation
|
||||
impact: LOW-MEDIUM
|
||||
impactDescription: avoids recreation
|
||||
tags: javascript, regexp, optimization, memoization
|
||||
---
|
||||
|
||||
## Hoist RegExp Creation
|
||||
|
||||
Don't create RegExp inside render. Hoist to module scope or memoize with `useMemo()`.
|
||||
|
||||
**Incorrect (new RegExp every render):**
|
||||
|
||||
```tsx
|
||||
function Highlighter({ text, query }: Props) {
|
||||
const regex = new RegExp(`(${query})`, 'gi')
|
||||
const parts = text.split(regex)
|
||||
return <>{parts.map((part, i) => ...)}</>
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (memoize or hoist):**
|
||||
|
||||
```tsx
|
||||
const EMAIL_REGEX = /^[^\s@]+@[^\s@]+\.[^\s@]+$/
|
||||
|
||||
function Highlighter({ text, query }: Props) {
|
||||
const regex = useMemo(
|
||||
() => new RegExp(`(${escapeRegex(query)})`, 'gi'),
|
||||
[query]
|
||||
)
|
||||
const parts = text.split(regex)
|
||||
return <>{parts.map((part, i) => ...)}</>
|
||||
}
|
||||
```
|
||||
|
||||
**Warning (global regex has mutable state):**
|
||||
|
||||
Global regex (`/g`) has mutable `lastIndex` state:
|
||||
|
||||
```typescript
|
||||
const regex = /foo/g
|
||||
regex.test('foo') // true, lastIndex = 3
|
||||
regex.test('foo') // false, lastIndex = 0
|
||||
```
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
title: Build Index Maps for Repeated Lookups
|
||||
impact: LOW-MEDIUM
|
||||
impactDescription: 1M ops to 2K ops
|
||||
tags: javascript, map, indexing, optimization, performance
|
||||
---
|
||||
|
||||
## Build Index Maps for Repeated Lookups
|
||||
|
||||
Multiple `.find()` calls by the same key should use a Map.
|
||||
|
||||
**Incorrect (O(n) per lookup):**
|
||||
|
||||
```typescript
|
||||
function processOrders(orders: Order[], users: User[]) {
|
||||
return orders.map(order => ({
|
||||
...order,
|
||||
user: users.find(u => u.id === order.userId)
|
||||
}))
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (O(1) per lookup):**
|
||||
|
||||
```typescript
|
||||
function processOrders(orders: Order[], users: User[]) {
|
||||
const userById = new Map(users.map(u => [u.id, u]))
|
||||
|
||||
return orders.map(order => ({
|
||||
...order,
|
||||
user: userById.get(order.userId)
|
||||
}))
|
||||
}
|
||||
```
|
||||
|
||||
Build map once (O(n)), then all lookups are O(1).
|
||||
For 1000 orders × 1000 users: 1M ops → 2K ops.
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
title: Early Length Check for Array Comparisons
|
||||
impact: MEDIUM-HIGH
|
||||
impactDescription: avoids expensive operations when lengths differ
|
||||
tags: javascript, arrays, performance, optimization, comparison
|
||||
---
|
||||
|
||||
## Early Length Check for Array Comparisons
|
||||
|
||||
When comparing arrays with expensive operations (sorting, deep equality, serialization), check lengths first. If lengths differ, the arrays cannot be equal.
|
||||
|
||||
In real-world applications, this optimization is especially valuable when the comparison runs in hot paths (event handlers, render loops).
|
||||
|
||||
**Incorrect (always runs expensive comparison):**
|
||||
|
||||
```typescript
|
||||
function hasChanges(current: string[], original: string[]) {
|
||||
// Always sorts and joins, even when lengths differ
|
||||
return current.sort().join() !== original.sort().join()
|
||||
}
|
||||
```
|
||||
|
||||
Two O(n log n) sorts run even when `current.length` is 5 and `original.length` is 100. There is also overhead of joining the arrays and comparing the strings.
|
||||
|
||||
**Correct (O(1) length check first):**
|
||||
|
||||
```typescript
|
||||
function hasChanges(current: string[], original: string[]) {
|
||||
// Early return if lengths differ
|
||||
if (current.length !== original.length) {
|
||||
return true
|
||||
}
|
||||
// Only sort when lengths match
|
||||
const currentSorted = current.toSorted()
|
||||
const originalSorted = original.toSorted()
|
||||
for (let i = 0; i < currentSorted.length; i++) {
|
||||
if (currentSorted[i] !== originalSorted[i]) {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
```
|
||||
|
||||
This new approach is more efficient because:
|
||||
- It avoids the overhead of sorting and joining the arrays when lengths differ
|
||||
- It avoids consuming memory for the joined strings (especially important for large arrays)
|
||||
- It avoids mutating the original arrays
|
||||
- It returns early when a difference is found
|
||||
@@ -0,0 +1,82 @@
|
||||
---
|
||||
title: Use Loop for Min/Max Instead of Sort
|
||||
impact: LOW
|
||||
impactDescription: O(n) instead of O(n log n)
|
||||
tags: javascript, arrays, performance, sorting, algorithms
|
||||
---
|
||||
|
||||
## Use Loop for Min/Max Instead of Sort
|
||||
|
||||
Finding the smallest or largest element only requires a single pass through the array. Sorting is wasteful and slower.
|
||||
|
||||
**Incorrect (O(n log n) - sort to find latest):**
|
||||
|
||||
```typescript
|
||||
interface Project {
|
||||
id: string
|
||||
name: string
|
||||
updatedAt: number
|
||||
}
|
||||
|
||||
function getLatestProject(projects: Project[]) {
|
||||
const sorted = [...projects].sort((a, b) => b.updatedAt - a.updatedAt)
|
||||
return sorted[0]
|
||||
}
|
||||
```
|
||||
|
||||
Sorts the entire array just to find the maximum value.
|
||||
|
||||
**Incorrect (O(n log n) - sort for oldest and newest):**
|
||||
|
||||
```typescript
|
||||
function getOldestAndNewest(projects: Project[]) {
|
||||
const sorted = [...projects].sort((a, b) => a.updatedAt - b.updatedAt)
|
||||
return { oldest: sorted[0], newest: sorted[sorted.length - 1] }
|
||||
}
|
||||
```
|
||||
|
||||
Still sorts unnecessarily when only min/max are needed.
|
||||
|
||||
**Correct (O(n) - single loop):**
|
||||
|
||||
```typescript
|
||||
function getLatestProject(projects: Project[]) {
|
||||
if (projects.length === 0) return null
|
||||
|
||||
let latest = projects[0]
|
||||
|
||||
for (let i = 1; i < projects.length; i++) {
|
||||
if (projects[i].updatedAt > latest.updatedAt) {
|
||||
latest = projects[i]
|
||||
}
|
||||
}
|
||||
|
||||
return latest
|
||||
}
|
||||
|
||||
function getOldestAndNewest(projects: Project[]) {
|
||||
if (projects.length === 0) return { oldest: null, newest: null }
|
||||
|
||||
let oldest = projects[0]
|
||||
let newest = projects[0]
|
||||
|
||||
for (let i = 1; i < projects.length; i++) {
|
||||
if (projects[i].updatedAt < oldest.updatedAt) oldest = projects[i]
|
||||
if (projects[i].updatedAt > newest.updatedAt) newest = projects[i]
|
||||
}
|
||||
|
||||
return { oldest, newest }
|
||||
}
|
||||
```
|
||||
|
||||
Single pass through the array, no copying, no sorting.
|
||||
|
||||
**Alternative (Math.min/Math.max for small arrays):**
|
||||
|
||||
```typescript
|
||||
const numbers = [5, 2, 8, 1, 9]
|
||||
const min = Math.min(...numbers)
|
||||
const max = Math.max(...numbers)
|
||||
```
|
||||
|
||||
This works for small arrays, but can be slower or just throw an error for very large arrays due to spread operator limitations. Maximal array length is approximately 124000 in Chrome 143 and 638000 in Safari 18; exact numbers may vary - see [the fiddle](https://jsfiddle.net/qw1jabsx/4/). Use the loop approach for reliability.
|
||||
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: Use Set/Map for O(1) Lookups
|
||||
impact: LOW-MEDIUM
|
||||
impactDescription: O(n) to O(1)
|
||||
tags: javascript, set, map, data-structures, performance
|
||||
---
|
||||
|
||||
## Use Set/Map for O(1) Lookups
|
||||
|
||||
Convert arrays to Set/Map for repeated membership checks.
|
||||
|
||||
**Incorrect (O(n) per check):**
|
||||
|
||||
```typescript
|
||||
const allowedIds = ['a', 'b', 'c', ...]
|
||||
items.filter(item => allowedIds.includes(item.id))
|
||||
```
|
||||
|
||||
**Correct (O(1) per check):**
|
||||
|
||||
```typescript
|
||||
const allowedIds = new Set(['a', 'b', 'c', ...])
|
||||
items.filter(item => allowedIds.has(item.id))
|
||||
```
|
||||
@@ -0,0 +1,57 @@
|
||||
---
|
||||
title: Use toSorted() Instead of sort() for Immutability
|
||||
impact: MEDIUM-HIGH
|
||||
impactDescription: prevents mutation bugs in React state
|
||||
tags: javascript, arrays, immutability, react, state, mutation
|
||||
---
|
||||
|
||||
## Use toSorted() Instead of sort() for Immutability
|
||||
|
||||
`.sort()` mutates the array in place, which can cause bugs with React state and props. Use `.toSorted()` to create a new sorted array without mutation.
|
||||
|
||||
**Incorrect (mutates original array):**
|
||||
|
||||
```typescript
|
||||
function UserList({ users }: { users: User[] }) {
|
||||
// Mutates the users prop array!
|
||||
const sorted = useMemo(
|
||||
() => users.sort((a, b) => a.name.localeCompare(b.name)),
|
||||
[users]
|
||||
)
|
||||
return <div>{sorted.map(renderUser)}</div>
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (creates new array):**
|
||||
|
||||
```typescript
|
||||
function UserList({ users }: { users: User[] }) {
|
||||
// Creates new sorted array, original unchanged
|
||||
const sorted = useMemo(
|
||||
() => users.toSorted((a, b) => a.name.localeCompare(b.name)),
|
||||
[users]
|
||||
)
|
||||
return <div>{sorted.map(renderUser)}</div>
|
||||
}
|
||||
```
|
||||
|
||||
**Why this matters in React:**
|
||||
|
||||
1. Props/state mutations break React's immutability model - React expects props and state to be treated as read-only
|
||||
2. Causes stale closure bugs - Mutating arrays inside closures (callbacks, effects) can lead to unexpected behavior
|
||||
|
||||
**Browser support (fallback for older browsers):**
|
||||
|
||||
`.toSorted()` is available in all modern browsers (Chrome 110+, Safari 16+, Firefox 115+, Node.js 20+). For older environments, use spread operator:
|
||||
|
||||
```typescript
|
||||
// Fallback for older browsers
|
||||
const sorted = [...items].sort((a, b) => a.value - b.value)
|
||||
```
|
||||
|
||||
**Other immutable array methods:**
|
||||
|
||||
- `.toSorted()` - immutable sort
|
||||
- `.toReversed()` - immutable reverse
|
||||
- `.toSpliced()` - immutable splice
|
||||
- `.with()` - immutable element replacement
|
||||
@@ -0,0 +1,26 @@
|
||||
---
|
||||
title: Use Activity Component for Show/Hide
|
||||
impact: MEDIUM
|
||||
impactDescription: preserves state/DOM
|
||||
tags: rendering, activity, visibility, state-preservation
|
||||
---
|
||||
|
||||
## Use Activity Component for Show/Hide
|
||||
|
||||
Use React's `<Activity>` to preserve state/DOM for expensive components that frequently toggle visibility.
|
||||
|
||||
**Usage:**
|
||||
|
||||
```tsx
|
||||
import { Activity } from 'react'
|
||||
|
||||
function Dropdown({ isOpen }: Props) {
|
||||
return (
|
||||
<Activity mode={isOpen ? 'visible' : 'hidden'}>
|
||||
<ExpensiveMenu />
|
||||
</Activity>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
Avoids expensive re-renders and state loss.
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
title: Animate SVG Wrapper Instead of SVG Element
|
||||
impact: LOW
|
||||
impactDescription: enables hardware acceleration
|
||||
tags: rendering, svg, css, animation, performance
|
||||
---
|
||||
|
||||
## Animate SVG Wrapper Instead of SVG Element
|
||||
|
||||
Many browsers don't have hardware acceleration for CSS3 animations on SVG elements. Wrap SVG in a `<div>` and animate the wrapper instead.
|
||||
|
||||
**Incorrect (animating SVG directly - no hardware acceleration):**
|
||||
|
||||
```tsx
|
||||
function LoadingSpinner() {
|
||||
return (
|
||||
<svg
|
||||
className="animate-spin"
|
||||
width="24"
|
||||
height="24"
|
||||
viewBox="0 0 24 24"
|
||||
>
|
||||
<circle cx="12" cy="12" r="10" stroke="currentColor" />
|
||||
</svg>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (animating wrapper div - hardware accelerated):**
|
||||
|
||||
```tsx
|
||||
function LoadingSpinner() {
|
||||
return (
|
||||
<div className="animate-spin">
|
||||
<svg
|
||||
width="24"
|
||||
height="24"
|
||||
viewBox="0 0 24 24"
|
||||
>
|
||||
<circle cx="12" cy="12" r="10" stroke="currentColor" />
|
||||
</svg>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
This applies to all CSS transforms and transitions (`transform`, `opacity`, `translate`, `scale`, `rotate`). The wrapper div allows browsers to use GPU acceleration for smoother animations.
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
title: Use Explicit Conditional Rendering
|
||||
impact: LOW
|
||||
impactDescription: prevents rendering 0 or NaN
|
||||
tags: rendering, conditional, jsx, falsy-values
|
||||
---
|
||||
|
||||
## Use Explicit Conditional Rendering
|
||||
|
||||
Use explicit ternary operators (`? :`) instead of `&&` for conditional rendering when the condition can be `0`, `NaN`, or other falsy values that render.
|
||||
|
||||
**Incorrect (renders "0" when count is 0):**
|
||||
|
||||
```tsx
|
||||
function Badge({ count }: { count: number }) {
|
||||
return (
|
||||
<div>
|
||||
{count && <span className="badge">{count}</span>}
|
||||
</div>
|
||||
)
|
||||
}
|
||||
|
||||
// When count = 0, renders: <div>0</div>
|
||||
// When count = 5, renders: <div><span class="badge">5</span></div>
|
||||
```
|
||||
|
||||
**Correct (renders nothing when count is 0):**
|
||||
|
||||
```tsx
|
||||
function Badge({ count }: { count: number }) {
|
||||
return (
|
||||
<div>
|
||||
{count > 0 ? <span className="badge">{count}</span> : null}
|
||||
</div>
|
||||
)
|
||||
}
|
||||
|
||||
// When count = 0, renders: <div></div>
|
||||
// When count = 5, renders: <div><span class="badge">5</span></div>
|
||||
```
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
title: CSS content-visibility for Long Lists
|
||||
impact: HIGH
|
||||
impactDescription: faster initial render
|
||||
tags: rendering, css, content-visibility, long-lists
|
||||
---
|
||||
|
||||
## CSS content-visibility for Long Lists
|
||||
|
||||
Apply `content-visibility: auto` to defer off-screen rendering.
|
||||
|
||||
**CSS:**
|
||||
|
||||
```css
|
||||
.message-item {
|
||||
content-visibility: auto;
|
||||
contain-intrinsic-size: 0 80px;
|
||||
}
|
||||
```
|
||||
|
||||
**Example:**
|
||||
|
||||
```tsx
|
||||
function MessageList({ messages }: { messages: Message[] }) {
|
||||
return (
|
||||
<div className="overflow-y-auto h-screen">
|
||||
{messages.map(msg => (
|
||||
<div key={msg.id} className="message-item">
|
||||
<Avatar user={msg.author} />
|
||||
<div>{msg.content}</div>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
For 1000 messages, browser skips layout/paint for ~990 off-screen items (10× faster initial render).
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
title: Hoist Static JSX Elements
|
||||
impact: LOW
|
||||
impactDescription: avoids re-creation
|
||||
tags: rendering, jsx, static, optimization
|
||||
---
|
||||
|
||||
## Hoist Static JSX Elements
|
||||
|
||||
Extract static JSX outside components to avoid re-creation.
|
||||
|
||||
**Incorrect (recreates element every render):**
|
||||
|
||||
```tsx
|
||||
function LoadingSkeleton() {
|
||||
return <div className="animate-pulse h-20 bg-gray-200" />
|
||||
}
|
||||
|
||||
function Container() {
|
||||
return (
|
||||
<div>
|
||||
{loading && <LoadingSkeleton />}
|
||||
</div>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (reuses same element):**
|
||||
|
||||
```tsx
|
||||
const loadingSkeleton = (
|
||||
<div className="animate-pulse h-20 bg-gray-200" />
|
||||
)
|
||||
|
||||
function Container() {
|
||||
return (
|
||||
<div>
|
||||
{loading && loadingSkeleton}
|
||||
</div>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
This is especially helpful for large and static SVG nodes, which can be expensive to recreate on every render.
|
||||
|
||||
**Note:** If your project has [React Compiler](https://react.dev/learn/react-compiler) enabled, the compiler automatically hoists static JSX elements and optimizes component re-renders, making manual hoisting unnecessary.
|
||||
@@ -0,0 +1,82 @@
|
||||
---
|
||||
title: Prevent Hydration Mismatch Without Flickering
|
||||
impact: MEDIUM
|
||||
impactDescription: avoids visual flicker and hydration errors
|
||||
tags: rendering, ssr, hydration, localStorage, flicker
|
||||
---
|
||||
|
||||
## Prevent Hydration Mismatch Without Flickering
|
||||
|
||||
When rendering content that depends on client-side storage (localStorage, cookies), avoid both SSR breakage and post-hydration flickering by injecting a synchronous script that updates the DOM before React hydrates.
|
||||
|
||||
**Incorrect (breaks SSR):**
|
||||
|
||||
```tsx
|
||||
function ThemeWrapper({ children }: { children: ReactNode }) {
|
||||
// localStorage is not available on server - throws error
|
||||
const theme = localStorage.getItem('theme') || 'light'
|
||||
|
||||
return (
|
||||
<div className={theme}>
|
||||
{children}
|
||||
</div>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
Server-side rendering will fail because `localStorage` is undefined.
|
||||
|
||||
**Incorrect (visual flickering):**
|
||||
|
||||
```tsx
|
||||
function ThemeWrapper({ children }: { children: ReactNode }) {
|
||||
const [theme, setTheme] = useState('light')
|
||||
|
||||
useEffect(() => {
|
||||
// Runs after hydration - causes visible flash
|
||||
const stored = localStorage.getItem('theme')
|
||||
if (stored) {
|
||||
setTheme(stored)
|
||||
}
|
||||
}, [])
|
||||
|
||||
return (
|
||||
<div className={theme}>
|
||||
{children}
|
||||
</div>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
Component first renders with default value (`light`), then updates after hydration, causing a visible flash of incorrect content.
|
||||
|
||||
**Correct (no flicker, no hydration mismatch):**
|
||||
|
||||
```tsx
|
||||
function ThemeWrapper({ children }: { children: ReactNode }) {
|
||||
return (
|
||||
<>
|
||||
<div id="theme-wrapper">
|
||||
{children}
|
||||
</div>
|
||||
<script
|
||||
dangerouslySetInnerHTML={{
|
||||
__html: `
|
||||
(function() {
|
||||
try {
|
||||
var theme = localStorage.getItem('theme') || 'light';
|
||||
var el = document.getElementById('theme-wrapper');
|
||||
if (el) el.className = theme;
|
||||
} catch (e) {}
|
||||
})();
|
||||
`,
|
||||
}}
|
||||
/>
|
||||
</>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
The inline script executes synchronously before showing the element, ensuring the DOM already has the correct value. No flickering, no hydration mismatch.
|
||||
|
||||
This pattern is especially useful for theme toggles, user preferences, authentication states, and any client-only data that should render immediately without flashing default values.
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: Optimize SVG Precision
|
||||
impact: LOW
|
||||
impactDescription: reduces file size
|
||||
tags: rendering, svg, optimization, svgo
|
||||
---
|
||||
|
||||
## Optimize SVG Precision
|
||||
|
||||
Reduce SVG coordinate precision to decrease file size. The optimal precision depends on the viewBox size, but in general reducing precision should be considered.
|
||||
|
||||
**Incorrect (excessive precision):**
|
||||
|
||||
```svg
|
||||
<path d="M 10.293847 20.847362 L 30.938472 40.192837" />
|
||||
```
|
||||
|
||||
**Correct (1 decimal place):**
|
||||
|
||||
```svg
|
||||
<path d="M 10.3 20.8 L 30.9 40.2" />
|
||||
```
|
||||
|
||||
**Automate with SVGO:**
|
||||
|
||||
```bash
|
||||
npx svgo --precision=1 --multipass icon.svg
|
||||
```
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: Defer State Reads to Usage Point
|
||||
impact: MEDIUM
|
||||
impactDescription: avoids unnecessary subscriptions
|
||||
tags: rerender, searchParams, localStorage, optimization
|
||||
---
|
||||
|
||||
## Defer State Reads to Usage Point
|
||||
|
||||
Don't subscribe to dynamic state (searchParams, localStorage) if you only read it inside callbacks.
|
||||
|
||||
**Incorrect (subscribes to all searchParams changes):**
|
||||
|
||||
```tsx
|
||||
function ShareButton({ chatId }: { chatId: string }) {
|
||||
const searchParams = useSearchParams()
|
||||
|
||||
const handleShare = () => {
|
||||
const ref = searchParams.get('ref')
|
||||
shareChat(chatId, { ref })
|
||||
}
|
||||
|
||||
return <button onClick={handleShare}>Share</button>
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (reads on demand, no subscription):**
|
||||
|
||||
```tsx
|
||||
function ShareButton({ chatId }: { chatId: string }) {
|
||||
const handleShare = () => {
|
||||
const params = new URLSearchParams(window.location.search)
|
||||
const ref = params.get('ref')
|
||||
shareChat(chatId, { ref })
|
||||
}
|
||||
|
||||
return <button onClick={handleShare}>Share</button>
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: Narrow Effect Dependencies
|
||||
impact: LOW
|
||||
impactDescription: minimizes effect re-runs
|
||||
tags: rerender, useEffect, dependencies, optimization
|
||||
---
|
||||
|
||||
## Narrow Effect Dependencies
|
||||
|
||||
Specify primitive dependencies instead of objects to minimize effect re-runs.
|
||||
|
||||
**Incorrect (re-runs on any user field change):**
|
||||
|
||||
```tsx
|
||||
useEffect(() => {
|
||||
console.log(user.id)
|
||||
}, [user])
|
||||
```
|
||||
|
||||
**Correct (re-runs only when id changes):**
|
||||
|
||||
```tsx
|
||||
useEffect(() => {
|
||||
console.log(user.id)
|
||||
}, [user.id])
|
||||
```
|
||||
|
||||
**For derived state, compute outside effect:**
|
||||
|
||||
```tsx
|
||||
// Incorrect: runs on width=767, 766, 765...
|
||||
useEffect(() => {
|
||||
if (width < 768) {
|
||||
enableMobileMode()
|
||||
}
|
||||
}, [width])
|
||||
|
||||
// Correct: runs only on boolean transition
|
||||
const isMobile = width < 768
|
||||
useEffect(() => {
|
||||
if (isMobile) {
|
||||
enableMobileMode()
|
||||
}
|
||||
}, [isMobile])
|
||||
```
|
||||
@@ -0,0 +1,29 @@
|
||||
---
|
||||
title: Subscribe to Derived State
|
||||
impact: MEDIUM
|
||||
impactDescription: reduces re-render frequency
|
||||
tags: rerender, derived-state, media-query, optimization
|
||||
---
|
||||
|
||||
## Subscribe to Derived State
|
||||
|
||||
Subscribe to derived boolean state instead of continuous values to reduce re-render frequency.
|
||||
|
||||
**Incorrect (re-renders on every pixel change):**
|
||||
|
||||
```tsx
|
||||
function Sidebar() {
|
||||
const width = useWindowWidth() // updates continuously
|
||||
const isMobile = width < 768
|
||||
return <nav className={isMobile ? 'mobile' : 'desktop'} />
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (re-renders only when boolean changes):**
|
||||
|
||||
```tsx
|
||||
function Sidebar() {
|
||||
const isMobile = useMediaQuery('(max-width: 767px)')
|
||||
return <nav className={isMobile ? 'mobile' : 'desktop'} />
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,74 @@
|
||||
---
|
||||
title: Use Functional setState Updates
|
||||
impact: MEDIUM
|
||||
impactDescription: prevents stale closures and unnecessary callback recreations
|
||||
tags: react, hooks, useState, useCallback, callbacks, closures
|
||||
---
|
||||
|
||||
## Use Functional setState Updates
|
||||
|
||||
When updating state based on the current state value, use the functional update form of setState instead of directly referencing the state variable. This prevents stale closures, eliminates unnecessary dependencies, and creates stable callback references.
|
||||
|
||||
**Incorrect (requires state as dependency):**
|
||||
|
||||
```tsx
|
||||
function TodoList() {
|
||||
const [items, setItems] = useState(initialItems)
|
||||
|
||||
// Callback must depend on items, recreated on every items change
|
||||
const addItems = useCallback((newItems: Item[]) => {
|
||||
setItems([...items, ...newItems])
|
||||
}, [items]) // ❌ items dependency causes recreations
|
||||
|
||||
// Risk of stale closure if dependency is forgotten
|
||||
const removeItem = useCallback((id: string) => {
|
||||
setItems(items.filter(item => item.id !== id))
|
||||
}, []) // ❌ Missing items dependency - will use stale items!
|
||||
|
||||
return <ItemsEditor items={items} onAdd={addItems} onRemove={removeItem} />
|
||||
}
|
||||
```
|
||||
|
||||
The first callback is recreated every time `items` changes, which can cause child components to re-render unnecessarily. The second callback has a stale closure bug—it will always reference the initial `items` value.
|
||||
|
||||
**Correct (stable callbacks, no stale closures):**
|
||||
|
||||
```tsx
|
||||
function TodoList() {
|
||||
const [items, setItems] = useState(initialItems)
|
||||
|
||||
// Stable callback, never recreated
|
||||
const addItems = useCallback((newItems: Item[]) => {
|
||||
setItems(curr => [...curr, ...newItems])
|
||||
}, []) // ✅ No dependencies needed
|
||||
|
||||
// Always uses latest state, no stale closure risk
|
||||
const removeItem = useCallback((id: string) => {
|
||||
setItems(curr => curr.filter(item => item.id !== id))
|
||||
}, []) // ✅ Safe and stable
|
||||
|
||||
return <ItemsEditor items={items} onAdd={addItems} onRemove={removeItem} />
|
||||
}
|
||||
```
|
||||
|
||||
**Benefits:**
|
||||
|
||||
1. **Stable callback references** - Callbacks don't need to be recreated when state changes
|
||||
2. **No stale closures** - Always operates on the latest state value
|
||||
3. **Fewer dependencies** - Simplifies dependency arrays and reduces memory leaks
|
||||
4. **Prevents bugs** - Eliminates the most common source of React closure bugs
|
||||
|
||||
**When to use functional updates:**
|
||||
|
||||
- Any setState that depends on the current state value
|
||||
- Inside useCallback/useMemo when state is needed
|
||||
- Event handlers that reference state
|
||||
- Async operations that update state
|
||||
|
||||
**When direct updates are fine:**
|
||||
|
||||
- Setting state to a static value: `setCount(0)`
|
||||
- Setting state from props/arguments only: `setName(newName)`
|
||||
- State doesn't depend on previous value
|
||||
|
||||
**Note:** If your project has [React Compiler](https://react.dev/learn/react-compiler) enabled, the compiler can automatically optimize some cases, but functional updates are still recommended for correctness and to prevent stale closure bugs.
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
title: Use Lazy State Initialization
|
||||
impact: MEDIUM
|
||||
impactDescription: wasted computation on every render
|
||||
tags: react, hooks, useState, performance, initialization
|
||||
---
|
||||
|
||||
## Use Lazy State Initialization
|
||||
|
||||
Pass a function to `useState` for expensive initial values. Without the function form, the initializer runs on every render even though the value is only used once.
|
||||
|
||||
**Incorrect (runs on every render):**
|
||||
|
||||
```tsx
|
||||
function FilteredList({ items }: { items: Item[] }) {
|
||||
// buildSearchIndex() runs on EVERY render, even after initialization
|
||||
const [searchIndex, setSearchIndex] = useState(buildSearchIndex(items))
|
||||
const [query, setQuery] = useState('')
|
||||
|
||||
// When query changes, buildSearchIndex runs again unnecessarily
|
||||
return <SearchResults index={searchIndex} query={query} />
|
||||
}
|
||||
|
||||
function UserProfile() {
|
||||
// JSON.parse runs on every render
|
||||
const [settings, setSettings] = useState(
|
||||
JSON.parse(localStorage.getItem('settings') || '{}')
|
||||
)
|
||||
|
||||
return <SettingsForm settings={settings} onChange={setSettings} />
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (runs only once):**
|
||||
|
||||
```tsx
|
||||
function FilteredList({ items }: { items: Item[] }) {
|
||||
// buildSearchIndex() runs ONLY on initial render
|
||||
const [searchIndex, setSearchIndex] = useState(() => buildSearchIndex(items))
|
||||
const [query, setQuery] = useState('')
|
||||
|
||||
return <SearchResults index={searchIndex} query={query} />
|
||||
}
|
||||
|
||||
function UserProfile() {
|
||||
// JSON.parse runs only on initial render
|
||||
const [settings, setSettings] = useState(() => {
|
||||
const stored = localStorage.getItem('settings')
|
||||
return stored ? JSON.parse(stored) : {}
|
||||
})
|
||||
|
||||
return <SettingsForm settings={settings} onChange={setSettings} />
|
||||
}
|
||||
```
|
||||
|
||||
Use lazy initialization when computing initial values from localStorage/sessionStorage, building data structures (indexes, maps), reading from the DOM, or performing heavy transformations.
|
||||
|
||||
For simple primitives (`useState(0)`), direct references (`useState(props.value)`), or cheap literals (`useState({})`), the function form is unnecessary.
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
title: Extract to Memoized Components
|
||||
impact: MEDIUM
|
||||
impactDescription: enables early returns
|
||||
tags: rerender, memo, useMemo, optimization
|
||||
---
|
||||
|
||||
## Extract to Memoized Components
|
||||
|
||||
Extract expensive work into memoized components to enable early returns before computation.
|
||||
|
||||
**Incorrect (computes avatar even when loading):**
|
||||
|
||||
```tsx
|
||||
function Profile({ user, loading }: Props) {
|
||||
const avatar = useMemo(() => {
|
||||
const id = computeAvatarId(user)
|
||||
return <Avatar id={id} />
|
||||
}, [user])
|
||||
|
||||
if (loading) return <Skeleton />
|
||||
return <div>{avatar}</div>
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (skips computation when loading):**
|
||||
|
||||
```tsx
|
||||
const UserAvatar = memo(function UserAvatar({ user }: { user: User }) {
|
||||
const id = useMemo(() => computeAvatarId(user), [user])
|
||||
return <Avatar id={id} />
|
||||
})
|
||||
|
||||
function Profile({ user, loading }: Props) {
|
||||
if (loading) return <Skeleton />
|
||||
return (
|
||||
<div>
|
||||
<UserAvatar user={user} />
|
||||
</div>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
**Note:** If your project has [React Compiler](https://react.dev/learn/react-compiler) enabled, manual memoization with `memo()` and `useMemo()` is not necessary. The compiler automatically optimizes re-renders.
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
title: Use Transitions for Non-Urgent Updates
|
||||
impact: MEDIUM
|
||||
impactDescription: maintains UI responsiveness
|
||||
tags: rerender, transitions, startTransition, performance
|
||||
---
|
||||
|
||||
## Use Transitions for Non-Urgent Updates
|
||||
|
||||
Mark frequent, non-urgent state updates as transitions to maintain UI responsiveness.
|
||||
|
||||
**Incorrect (blocks UI on every scroll):**
|
||||
|
||||
```tsx
|
||||
function ScrollTracker() {
|
||||
const [scrollY, setScrollY] = useState(0)
|
||||
useEffect(() => {
|
||||
const handler = () => setScrollY(window.scrollY)
|
||||
window.addEventListener('scroll', handler, { passive: true })
|
||||
return () => window.removeEventListener('scroll', handler)
|
||||
}, [])
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (non-blocking updates):**
|
||||
|
||||
```tsx
|
||||
import { startTransition } from 'react'
|
||||
|
||||
function ScrollTracker() {
|
||||
const [scrollY, setScrollY] = useState(0)
|
||||
useEffect(() => {
|
||||
const handler = () => {
|
||||
startTransition(() => setScrollY(window.scrollY))
|
||||
}
|
||||
window.addEventListener('scroll', handler, { passive: true })
|
||||
return () => window.removeEventListener('scroll', handler)
|
||||
}, [])
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,73 @@
|
||||
---
|
||||
title: Use after() for Non-Blocking Operations
|
||||
impact: MEDIUM
|
||||
impactDescription: faster response times
|
||||
tags: server, async, logging, analytics, side-effects
|
||||
---
|
||||
|
||||
## Use after() for Non-Blocking Operations
|
||||
|
||||
Use Next.js's `after()` to schedule work that should execute after a response is sent. This prevents logging, analytics, and other side effects from blocking the response.
|
||||
|
||||
**Incorrect (blocks response):**
|
||||
|
||||
```tsx
|
||||
import { logUserAction } from '@/app/utils'
|
||||
|
||||
export async function POST(request: Request) {
|
||||
// Perform mutation
|
||||
await updateDatabase(request)
|
||||
|
||||
// Logging blocks the response
|
||||
const userAgent = request.headers.get('user-agent') || 'unknown'
|
||||
await logUserAction({ userAgent })
|
||||
|
||||
return new Response(JSON.stringify({ status: 'success' }), {
|
||||
status: 200,
|
||||
headers: { 'Content-Type': 'application/json' }
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (non-blocking):**
|
||||
|
||||
```tsx
|
||||
import { after } from 'next/server'
|
||||
import { headers, cookies } from 'next/headers'
|
||||
import { logUserAction } from '@/app/utils'
|
||||
|
||||
export async function POST(request: Request) {
|
||||
// Perform mutation
|
||||
await updateDatabase(request)
|
||||
|
||||
// Log after response is sent
|
||||
after(async () => {
|
||||
const userAgent = (await headers()).get('user-agent') || 'unknown'
|
||||
const sessionCookie = (await cookies()).get('session-id')?.value || 'anonymous'
|
||||
|
||||
logUserAction({ sessionCookie, userAgent })
|
||||
})
|
||||
|
||||
return new Response(JSON.stringify({ status: 'success' }), {
|
||||
status: 200,
|
||||
headers: { 'Content-Type': 'application/json' }
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
The response is sent immediately while logging happens in the background.
|
||||
|
||||
**Common use cases:**
|
||||
|
||||
- Analytics tracking
|
||||
- Audit logging
|
||||
- Sending notifications
|
||||
- Cache invalidation
|
||||
- Cleanup tasks
|
||||
|
||||
**Important notes:**
|
||||
|
||||
- `after()` runs even if the response fails or redirects
|
||||
- Works in Server Actions, Route Handlers, and Server Components
|
||||
|
||||
Reference: [https://nextjs.org/docs/app/api-reference/functions/after](https://nextjs.org/docs/app/api-reference/functions/after)
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
title: Cross-Request LRU Caching
|
||||
impact: HIGH
|
||||
impactDescription: caches across requests
|
||||
tags: server, cache, lru, cross-request
|
||||
---
|
||||
|
||||
## Cross-Request LRU Caching
|
||||
|
||||
`React.cache()` only works within one request. For data shared across sequential requests (user clicks button A then button B), use an LRU cache.
|
||||
|
||||
**Implementation:**
|
||||
|
||||
```typescript
|
||||
import { LRUCache } from 'lru-cache'
|
||||
|
||||
const cache = new LRUCache<string, any>({
|
||||
max: 1000,
|
||||
ttl: 5 * 60 * 1000 // 5 minutes
|
||||
})
|
||||
|
||||
export async function getUser(id: string) {
|
||||
const cached = cache.get(id)
|
||||
if (cached) return cached
|
||||
|
||||
const user = await db.user.findUnique({ where: { id } })
|
||||
cache.set(id, user)
|
||||
return user
|
||||
}
|
||||
|
||||
// Request 1: DB query, result cached
|
||||
// Request 2: cache hit, no DB query
|
||||
```
|
||||
|
||||
Use when sequential user actions hit multiple endpoints needing the same data within seconds.
|
||||
|
||||
**With Vercel's [Fluid Compute](https://vercel.com/docs/fluid-compute):** LRU caching is especially effective because multiple concurrent requests can share the same function instance and cache. This means the cache persists across requests without needing external storage like Redis.
|
||||
|
||||
**In traditional serverless:** Each invocation runs in isolation, so consider Redis for cross-process caching.
|
||||
|
||||
Reference: [https://github.com/isaacs/node-lru-cache](https://github.com/isaacs/node-lru-cache)
|
||||
@@ -0,0 +1,76 @@
|
||||
---
|
||||
title: Per-Request Deduplication with React.cache()
|
||||
impact: MEDIUM
|
||||
impactDescription: deduplicates within request
|
||||
tags: server, cache, react-cache, deduplication
|
||||
---
|
||||
|
||||
## Per-Request Deduplication with React.cache()
|
||||
|
||||
Use `React.cache()` for server-side request deduplication. Authentication and database queries benefit most.
|
||||
|
||||
**Usage:**
|
||||
|
||||
```typescript
|
||||
import { cache } from 'react'
|
||||
|
||||
export const getCurrentUser = cache(async () => {
|
||||
const session = await auth()
|
||||
if (!session?.user?.id) return null
|
||||
return await db.user.findUnique({
|
||||
where: { id: session.user.id }
|
||||
})
|
||||
})
|
||||
```
|
||||
|
||||
Within a single request, multiple calls to `getCurrentUser()` execute the query only once.
|
||||
|
||||
**Avoid inline objects as arguments:**
|
||||
|
||||
`React.cache()` uses shallow equality (`Object.is`) to determine cache hits. Inline objects create new references each call, preventing cache hits.
|
||||
|
||||
**Incorrect (always cache miss):**
|
||||
|
||||
```typescript
|
||||
const getUser = cache(async (params: { uid: number }) => {
|
||||
return await db.user.findUnique({ where: { id: params.uid } })
|
||||
})
|
||||
|
||||
// Each call creates new object, never hits cache
|
||||
getUser({ uid: 1 })
|
||||
getUser({ uid: 1 }) // Cache miss, runs query again
|
||||
```
|
||||
|
||||
**Correct (cache hit):**
|
||||
|
||||
```typescript
|
||||
const getUser = cache(async (uid: number) => {
|
||||
return await db.user.findUnique({ where: { id: uid } })
|
||||
})
|
||||
|
||||
// Primitive args use value equality
|
||||
getUser(1)
|
||||
getUser(1) // Cache hit, returns cached result
|
||||
```
|
||||
|
||||
If you must pass objects, pass the same reference:
|
||||
|
||||
```typescript
|
||||
const params = { uid: 1 }
|
||||
getUser(params) // Query runs
|
||||
getUser(params) // Cache hit (same reference)
|
||||
```
|
||||
|
||||
**Next.js-Specific Note:**
|
||||
|
||||
In Next.js, the `fetch` API is automatically extended with request memoization. Requests with the same URL and options are automatically deduplicated within a single request, so you don't need `React.cache()` for `fetch` calls. However, `React.cache()` is still essential for other async tasks:
|
||||
|
||||
- Database queries (Prisma, Drizzle, etc.)
|
||||
- Heavy computations
|
||||
- Authentication checks
|
||||
- File system operations
|
||||
- Any non-fetch async work
|
||||
|
||||
Use `React.cache()` to deduplicate these operations across your component tree.
|
||||
|
||||
Reference: [React.cache documentation](https://react.dev/reference/react/cache)
|
||||
@@ -0,0 +1,83 @@
|
||||
---
|
||||
title: Parallel Data Fetching with Component Composition
|
||||
impact: CRITICAL
|
||||
impactDescription: eliminates server-side waterfalls
|
||||
tags: server, rsc, parallel-fetching, composition
|
||||
---
|
||||
|
||||
## Parallel Data Fetching with Component Composition
|
||||
|
||||
React Server Components execute sequentially within a tree. Restructure with composition to parallelize data fetching.
|
||||
|
||||
**Incorrect (Sidebar waits for Page's fetch to complete):**
|
||||
|
||||
```tsx
|
||||
export default async function Page() {
|
||||
const header = await fetchHeader()
|
||||
return (
|
||||
<div>
|
||||
<div>{header}</div>
|
||||
<Sidebar />
|
||||
</div>
|
||||
)
|
||||
}
|
||||
|
||||
async function Sidebar() {
|
||||
const items = await fetchSidebarItems()
|
||||
return <nav>{items.map(renderItem)}</nav>
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (both fetch simultaneously):**
|
||||
|
||||
```tsx
|
||||
async function Header() {
|
||||
const data = await fetchHeader()
|
||||
return <div>{data}</div>
|
||||
}
|
||||
|
||||
async function Sidebar() {
|
||||
const items = await fetchSidebarItems()
|
||||
return <nav>{items.map(renderItem)}</nav>
|
||||
}
|
||||
|
||||
export default function Page() {
|
||||
return (
|
||||
<div>
|
||||
<Header />
|
||||
<Sidebar />
|
||||
</div>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
**Alternative with children prop:**
|
||||
|
||||
```tsx
|
||||
async function Header() {
|
||||
const data = await fetchHeader()
|
||||
return <div>{data}</div>
|
||||
}
|
||||
|
||||
async function Sidebar() {
|
||||
const items = await fetchSidebarItems()
|
||||
return <nav>{items.map(renderItem)}</nav>
|
||||
}
|
||||
|
||||
function Layout({ children }: { children: ReactNode }) {
|
||||
return (
|
||||
<div>
|
||||
<Header />
|
||||
{children}
|
||||
</div>
|
||||
)
|
||||
}
|
||||
|
||||
export default function Page() {
|
||||
return (
|
||||
<Layout>
|
||||
<Sidebar />
|
||||
</Layout>
|
||||
)
|
||||
}
|
||||
```
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
title: Minimize Serialization at RSC Boundaries
|
||||
impact: HIGH
|
||||
impactDescription: reduces data transfer size
|
||||
tags: server, rsc, serialization, props
|
||||
---
|
||||
|
||||
## Minimize Serialization at RSC Boundaries
|
||||
|
||||
The React Server/Client boundary serializes all object properties into strings and embeds them in the HTML response and subsequent RSC requests. This serialized data directly impacts page weight and load time, so **size matters a lot**. Only pass fields that the client actually uses.
|
||||
|
||||
**Incorrect (serializes all 50 fields):**
|
||||
|
||||
```tsx
|
||||
async function Page() {
|
||||
const user = await fetchUser() // 50 fields
|
||||
return <Profile user={user} />
|
||||
}
|
||||
|
||||
'use client'
|
||||
function Profile({ user }: { user: User }) {
|
||||
return <div>{user.name}</div> // uses 1 field
|
||||
}
|
||||
```
|
||||
|
||||
**Correct (serializes only 1 field):**
|
||||
|
||||
```tsx
|
||||
async function Page() {
|
||||
const user = await fetchUser()
|
||||
return <Profile name={user.name} />
|
||||
}
|
||||
|
||||
'use client'
|
||||
function Profile({ name }: { name: string }) {
|
||||
return <div>{name}</div>
|
||||
}
|
||||
```
|
||||
@@ -1,159 +0,0 @@
|
||||
---
|
||||
name: version-release
|
||||
description: "Version release workflow. Use when the user mentions 'release', 'hotfix', 'version upgrade', 'weekly release', or '发版'/'发布'/'小班车'. Provides guides for Minor Release and Patch Release workflows."
|
||||
---
|
||||
|
||||
# Version Release Workflow
|
||||
|
||||
## Overview
|
||||
|
||||
The primary development branch is **canary**. All day-to-day development happens on canary. When releasing, canary is merged into main. After merge, `auto-tag-release.yml` automatically handles tagging, version bumping, creating a GitHub Release, and syncing back to the canary branch.
|
||||
|
||||
Only two release types are used in practice (major releases are extremely rare and can be ignored):
|
||||
|
||||
| Type | Use Case | Frequency | Source Branch | PR Title Format | Version |
|
||||
| ----- | ---------------------------------------------- | --------------------- | -------------- | ------------------------------------ | ------------- |
|
||||
| Minor | Feature iteration release | \~Every 4 weeks | canary | `🚀 release: v{x.y.0}` | Manually set |
|
||||
| Patch | Weekly release / hotfix / model / DB migration | \~Weekly or as needed | canary or main | Custom (e.g. `🚀 release: 20260222`) | Auto patch +1 |
|
||||
|
||||
## Minor Release Workflow
|
||||
|
||||
Used to publish a new minor version (e.g. v2.2.0), roughly every 4 weeks.
|
||||
|
||||
### Steps
|
||||
|
||||
1. **Create a release branch from canary**
|
||||
|
||||
```bash
|
||||
git checkout canary
|
||||
git pull origin canary
|
||||
git checkout -b release/v{version}
|
||||
git push -u origin release/v{version}
|
||||
```
|
||||
|
||||
2. **Determine the version number** — Read the current version from `package.json` and compute the next minor version (e.g. 2.1.x → 2.2.0)
|
||||
|
||||
3. **Create a PR to main**
|
||||
|
||||
```bash
|
||||
gh pr create \
|
||||
--title "🚀 release: v{version}" \
|
||||
--base main \
|
||||
--head release/v{version} \
|
||||
--body "## 📦 Release v{version} ..."
|
||||
```
|
||||
|
||||
> \[!IMPORTANT]: The PR title must strictly match the `🚀 release: v{x.y.z}` format. CI uses a regex on this title to determine the exact version number.
|
||||
|
||||
4. **Automatic trigger after merge**: auto-tag-release detects the title format and uses the version number from the title to complete the release.
|
||||
|
||||
### Scripts
|
||||
|
||||
```bash
|
||||
bun run release:branch # Interactive
|
||||
bun run release:branch --minor # Directly specify minor
|
||||
```
|
||||
|
||||
## Patch Release Workflow
|
||||
|
||||
Version number is automatically bumped by patch +1. There are 4 common scenarios:
|
||||
|
||||
| Scenario | Source Branch | Branch Naming | Description |
|
||||
| ------------------- | ------------- | ----------------------------- | ------------------------------------------------ |
|
||||
| Weekly Release | canary | `release/weekly-{YYYYMMDD}` | Weekly release train, canary → main |
|
||||
| Bug Hotfix | main | `hotfix/v{version}-{hash}` | Emergency bug fix |
|
||||
| New Model Launch | canary | Community PR merged directly | New model launch, triggered by PR title prefix |
|
||||
| DB Schema Migration | main | `release/db-migration-{name}` | Database migration, requires dedicated changelog |
|
||||
|
||||
All scenarios auto-bump patch +1. Patch PR titles do not need a version number. See `reference/patch-release-scenarios.md` for detailed steps per scenario.
|
||||
|
||||
### Scripts
|
||||
|
||||
```bash
|
||||
bun run hotfix:branch # Hotfix scenario
|
||||
```
|
||||
|
||||
## Auto-Release Trigger Rules (auto-tag-release.yml)
|
||||
|
||||
After a PR is merged into main, CI determines whether to release based on the following priority:
|
||||
|
||||
### 1. Minor Release (Exact Version)
|
||||
|
||||
PR title matches `🚀 release: v{x.y.z}` → uses the version number from the title.
|
||||
|
||||
### 2. Patch Release (Auto patch +1)
|
||||
|
||||
Triggered by the following priority:
|
||||
|
||||
- **Branch name match**: `hotfix/*` or `release/*` → triggers directly (skips title detection)
|
||||
- **Title prefix match**: PRs with the following title prefixes will trigger:
|
||||
- `style` / `💄 style`
|
||||
- `feat` / `✨ feat`
|
||||
- `fix` / `🐛 fix`
|
||||
- `refactor` / `♻️ refactor`
|
||||
- `hotfix` / `🐛 hotfix` / `🩹 hotfix`
|
||||
- `build` / `👷 build`
|
||||
|
||||
### 3. No Trigger
|
||||
|
||||
PRs that don't match any of the above conditions (e.g. `docs`, `chore`, `ci`, `test` prefixes) will not trigger a release when merged into main.
|
||||
|
||||
## Post-Release Automated Actions
|
||||
|
||||
1. **Bump package.json** — commits `🔖 chore(release): release version v{x.y.z} [skip ci]`
|
||||
2. **Create annotated tag** — `v{x.y.z}`
|
||||
3. **Create GitHub Release**
|
||||
4. **Dispatch sync-main-to-canary** — syncs main back to the canary branch
|
||||
|
||||
## Claude Action Guide
|
||||
|
||||
When the user requests a release:
|
||||
|
||||
### Minor Release
|
||||
|
||||
1. Read `package.json` to get the current version and compute the next minor version
|
||||
2. Create a `release/v{version}` branch from canary
|
||||
3. Push and create a PR — **title must be `🚀 release: v{version}`**
|
||||
4. Inform the user that merging the PR will automatically trigger the release
|
||||
|
||||
### Precheck
|
||||
|
||||
Before creating the release branch, verify the source branch:
|
||||
|
||||
- **Weekly Release** (`release/weekly-*`): must branch from `canary`
|
||||
- **All other release/hotfix branches**: must branch from `main` — run `git merge-base --is-ancestor main <branch> && echo OK` to confirm
|
||||
- If the branch is based on the wrong source, delete and recreate from the correct base
|
||||
|
||||
### Patch Release
|
||||
|
||||
Choose the appropriate workflow based on the scenario (see `reference/patch-release-scenarios.md`):
|
||||
|
||||
- **Weekly Release**: Create a `release/weekly-{YYYYMMDD}` branch from canary, scan `git log main..canary` to write the changelog, title like `🚀 release: 20260222`
|
||||
- **Bug Hotfix**: Create a `hotfix/` branch from main, use a gitmoji prefix title (e.g. `🐛 fix: ...`)
|
||||
- **New Model Launch**: Community PRs trigger automatically via title prefix (`feat` / `style`), no extra steps needed
|
||||
- **DB Migration**: Create a `release/db-migration-{name}` branch from main, cherry-pick migration commits, write a dedicated migration changelog
|
||||
|
||||
### Important Notes
|
||||
|
||||
- **Do NOT manually modify the version in package.json** — CI will auto-bump it
|
||||
- **Do NOT manually create tags** — CI will create them automatically
|
||||
- The Minor Release PR title format is a hard requirement — incorrect format will not use the specified version number
|
||||
- Patch PRs do not need a version number — CI auto-bumps patch +1
|
||||
- All release PRs must include a user-facing changelog
|
||||
|
||||
## Changelog Writing Guidelines
|
||||
|
||||
All release PR bodies (both Minor and Patch) must include a user-facing changelog. Scan changes via `git log main..canary --oneline` or `git diff main...canary --stat`, then write following the format below.
|
||||
|
||||
### Format Reference
|
||||
|
||||
- Weekly Release: See `reference/changelog-example/weekly-release.md`
|
||||
- DB Migration: See `reference/changelog-example/db-migration.md`
|
||||
|
||||
### Writing Tips
|
||||
|
||||
- **User-facing**: Describe changes that users can perceive, not internal implementation details
|
||||
- **Clear categories**: Group by features, models/providers, desktop, stability/fixes, etc.
|
||||
- **Highlight key items**: Use `**bold**` for important feature names
|
||||
- **Credit contributors**: Collect all committers via `git log` and list alphabetically
|
||||
- **Flexible categories**: Choose categories based on actual changes — no need to force-fit all categories
|
||||
@@ -1,18 +0,0 @@
|
||||
# DB Schema Migration Changelog Example
|
||||
|
||||
A changelog reference for database migration release PR bodies.
|
||||
|
||||
---
|
||||
|
||||
This release includes a **database schema migration** involving **5 new tables** for the Agent Evaluation Benchmark system.
|
||||
|
||||
### Migration: Add Agent Evaluation Benchmark Tables
|
||||
|
||||
- Added 5 new tables: `agent_eval_benchmarks`, `agent_eval_datasets`, `agent_eval_records`, `agent_eval_runs`, `agent_eval_run_topics`
|
||||
|
||||
### Notes for Self-hosted Users
|
||||
|
||||
- The migration runs automatically on application startup
|
||||
- No manual intervention required
|
||||
|
||||
The migration owner: @\[pr-author] — responsible for this database schema change, reach out for any migration-related issues.
|
||||
@@ -1,46 +0,0 @@
|
||||
# Patch Release (Weekly) Changelog Example
|
||||
|
||||
A real-world changelog reference for weekly patch release PR bodies.
|
||||
|
||||
---
|
||||
|
||||
This release includes **82 commits** , Key updates are below.
|
||||
|
||||
### New Features and Enhancements
|
||||
|
||||
- Added **Agent Benchmark** support for more systematic agent performance evaluation.
|
||||
- Introduced the **video generation** feature end-to-end, including entry points, sidebar "new" badge support, and skeleton loading for topic switching.
|
||||
- Expanded memory capabilities: support for memory effort/tool permission configuration and improved timeout calculation for memory analysis tasks.
|
||||
- Added desktop editor support for image upload via file picker.
|
||||
|
||||
### Models and Provider Expansion
|
||||
|
||||
- Added a new provider: **Straico**.
|
||||
- Added/updated support for:
|
||||
- Claude Sonnet 4.6
|
||||
- Gemini 3.1 Pro Preview
|
||||
- Qwen3.5 series
|
||||
- Grok Imagine (`grok-imagine-image`)
|
||||
- MiniMax 2.5
|
||||
- Added related i18n copy and model parameter adaptations.
|
||||
|
||||
### Desktop Improvements
|
||||
|
||||
- Integrated `electron-liquid-glass` (macOS Tahoe).
|
||||
- Improved DMG background assets and desktop release workflow.
|
||||
|
||||
### Stability, Security, and UX Fixes
|
||||
|
||||
- Fixed multiple video generation pipeline issues: precharge refund handling, webhook token verification, pricing parameter usage, asset cleanup, and type safety.
|
||||
- Fixed `sanitizeFileName` path traversal risks and added unit tests.
|
||||
- Fixed MCP media URL generation with duplicated `APP_URL` prefix.
|
||||
- Fixed Qwen3 embedding failures caused by batch-size limits.
|
||||
- Fixed multiple UI/interaction issues, including mobile header agent selector/topic count, ChatInput scrolling behavior, and tooltip stacking context.
|
||||
- Fixed missing `@napi-rs/canvas` native bindings in Docker standalone builds.
|
||||
- Improved GitHub Copilot authentication retry behavior and response error handling in edge cases.
|
||||
|
||||
### Credits
|
||||
|
||||
Huge thanks to these contributors (alphabetical):
|
||||
|
||||
@AmAzing129 @Coooolfan @Innei @ONLY-yours @Zhouguanyang @arvinxx @eaten-cake @hezhijie0327 @nekomeowww @rdmclin2 @rivertwilight @sxjeru @tjx666
|
||||
@@ -1,119 +0,0 @@
|
||||
# Patch Release Scenarios
|
||||
|
||||
All Patch Release scenarios automatically bump the patch version (e.g. 2.1.31 → 2.1.32). PR titles do not need to include a version number.
|
||||
|
||||
---
|
||||
|
||||
## 1. Weekly Release (canary → main)
|
||||
|
||||
The most common release type. Collects a week's worth of changes from canary and ships them to main.
|
||||
|
||||
### Steps
|
||||
|
||||
1. **Create release branch from canary**
|
||||
|
||||
```bash
|
||||
git checkout canary
|
||||
git pull origin canary
|
||||
git checkout -b release/weekly-{YYYYMMDD}
|
||||
git push -u origin release/weekly-{YYYYMMDD}
|
||||
```
|
||||
|
||||
2. **Scan changes and write changelog**
|
||||
|
||||
```bash
|
||||
git log main..canary --oneline
|
||||
git diff main...canary --stat
|
||||
```
|
||||
|
||||
Write a user-facing changelog following the format in `patch-release-changelog-example.md`.
|
||||
|
||||
3. **Create PR to main** with the changelog as the PR body
|
||||
|
||||
```bash
|
||||
gh pr create \
|
||||
--title "🚀 release: {YYYYMMDD}" \
|
||||
--base main \
|
||||
--head release/weekly-{YYYYMMDD} \
|
||||
--body-file changelog.md
|
||||
```
|
||||
|
||||
4. **After merge**: auto-tag-release detects `release/*` branch → auto patch +1.
|
||||
|
||||
---
|
||||
|
||||
## 2. Bug Hotfix
|
||||
|
||||
Emergency bug fix shipped directly from main.
|
||||
|
||||
### Steps
|
||||
|
||||
1. **Create hotfix branch from main**
|
||||
|
||||
```bash
|
||||
git checkout main
|
||||
git pull --rebase origin main
|
||||
git checkout -b hotfix/v{version}-{short-hash}
|
||||
git push -u origin hotfix/v{version}-{short-hash}
|
||||
```
|
||||
|
||||
2. **Create PR to main** with a gitmoji prefix title (e.g. `🐛 fix: description`)
|
||||
|
||||
3. **After merge**: auto-tag-release detects `hotfix/*` branch → auto patch +1.
|
||||
|
||||
### Script
|
||||
|
||||
```bash
|
||||
bun run hotfix:branch
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. New Model Launch
|
||||
|
||||
New AI model or provider support, typically contributed via community PRs.
|
||||
|
||||
### How it works
|
||||
|
||||
- Community contributors submit PRs with titles like `✨ feat: add xxx model` or `💄 style: support xxx models`
|
||||
- These PR title prefixes (`feat` / `style`) are in the auto-tag trigger list
|
||||
- No special branch naming or manual release steps required — merging the PR triggers auto patch +1
|
||||
|
||||
### When Claude is involved
|
||||
|
||||
If asked to add model support, just create a normal feature PR. The title prefix will trigger the release automatically.
|
||||
|
||||
---
|
||||
|
||||
## 4. DB Schema Migration
|
||||
|
||||
Database schema changes that need to be released independently. These require a dedicated changelog explaining the migration for self-hosted users.
|
||||
|
||||
### Steps
|
||||
|
||||
1. **Create release branch from main and cherry-pick migration commits**
|
||||
|
||||
```bash
|
||||
git checkout main
|
||||
git pull --rebase origin main
|
||||
git checkout -b release/db-migration-{name}
|
||||
git cherry-pick <migration-commit-hash>
|
||||
git push -u origin release/db-migration-{name}
|
||||
```
|
||||
|
||||
2. **Write a migration-specific changelog** — See `db-migration-changelog-example.md` for the format. This should explain:
|
||||
- What tables/columns are added, modified, or removed
|
||||
- Whether the migration is backwards-compatible
|
||||
- Any action required by self-hosted users
|
||||
|
||||
3. **Create PR to main** with the migration changelog as the PR body
|
||||
|
||||
```bash
|
||||
gh pr create \
|
||||
--title "👷 build: {migration description}" \
|
||||
--base main \
|
||||
--head release/db-migration-{name} \
|
||||
--body-file changelog.md
|
||||
```
|
||||
|
||||
4. **After merge**: auto-tag-release detects `release/*` branch → auto patch +1.
|
||||
@@ -3,42 +3,34 @@ name: zustand
|
||||
description: Zustand state management guide. Use when working with store code (src/store/**), implementing actions, managing state, or creating slices. Triggers on Zustand store development, state management questions, or action implementation.
|
||||
---
|
||||
|
||||
# LobeHub Zustand State Management
|
||||
# LobeChat Zustand State Management
|
||||
|
||||
## Action Type Hierarchy
|
||||
|
||||
### 1. Public Actions
|
||||
|
||||
Main interfaces for UI components:
|
||||
|
||||
- Naming: Verb form (`createTopic`, `sendMessage`)
|
||||
- Responsibilities: Parameter validation, flow orchestration
|
||||
|
||||
### 2. Internal Actions (`internal_*`)
|
||||
|
||||
Core business logic implementation:
|
||||
|
||||
- Naming: `internal_` prefix (`internal_createTopic`)
|
||||
- Responsibilities: Optimistic updates, service calls, error handling
|
||||
- Should not be called directly by UI
|
||||
|
||||
### 3. Dispatch Methods (`internal_dispatch*`)
|
||||
|
||||
State update handlers:
|
||||
|
||||
- Naming: `internal_dispatch` + entity (`internal_dispatchTopic`)
|
||||
- Responsibilities: Calling reducers, updating store
|
||||
|
||||
## When to Use Reducer vs Simple `set`
|
||||
|
||||
**Use Reducer Pattern:**
|
||||
|
||||
- Managing object lists/maps (`messagesMap`, `topicMaps`)
|
||||
- Optimistic updates
|
||||
- Complex state transitions
|
||||
|
||||
**Use Simple `set`:**
|
||||
|
||||
- Toggling booleans
|
||||
- Updating simple values
|
||||
- Setting single state fields
|
||||
@@ -69,14 +61,12 @@ internal_createTopic: async (params) => {
|
||||
## Naming Conventions
|
||||
|
||||
**Actions:**
|
||||
|
||||
- Public: `createTopic`, `sendMessage`
|
||||
- Internal: `internal_createTopic`, `internal_updateMessageContent`
|
||||
- Dispatch: `internal_dispatchTopic`
|
||||
- Toggle: `internal_toggleMessageLoading`
|
||||
|
||||
**State:**
|
||||
|
||||
- ID arrays: `messageLoadingIds`, `topicEditingIds`
|
||||
- Maps: `topicMaps`, `messagesMap`
|
||||
- Active: `activeTopicId`
|
||||
@@ -86,94 +76,3 @@ internal_createTopic: async (params) => {
|
||||
|
||||
- Action patterns: `references/action-patterns.md`
|
||||
- Slice organization: `references/slice-organization.md`
|
||||
|
||||
## Class-Based Action Implementation
|
||||
|
||||
We are migrating slices from plain `StateCreator` objects to **class-based actions**.
|
||||
|
||||
### Pattern
|
||||
|
||||
- Define a class that encapsulates actions and receives `(set, get, api)` in the constructor.
|
||||
- Use `#private` fields (e.g., `#set`, `#get`) to avoid leaking internals.
|
||||
- Prefer shared typing helpers:
|
||||
- `StoreSetter<T>` from `@/store/types` for `set`.
|
||||
- `Pick<ActionImpl, keyof ActionImpl>` to expose only public methods.
|
||||
- Export a `create*Slice` helper that returns a class instance.
|
||||
|
||||
```ts
|
||||
type Setter = StoreSetter<HomeStore>;
|
||||
export const createRecentSlice = (set: Setter, get: () => HomeStore, _api?: unknown) =>
|
||||
new RecentActionImpl(set, get, _api);
|
||||
|
||||
export class RecentActionImpl {
|
||||
readonly #get: () => HomeStore;
|
||||
readonly #set: Setter;
|
||||
|
||||
constructor(set: Setter, get: () => HomeStore, _api?: unknown) {
|
||||
void _api;
|
||||
this.#set = set;
|
||||
this.#get = get;
|
||||
}
|
||||
|
||||
useFetchRecentTopics = () => {
|
||||
// ...
|
||||
};
|
||||
}
|
||||
|
||||
export type RecentAction = Pick<RecentActionImpl, keyof RecentActionImpl>;
|
||||
```
|
||||
|
||||
### Composition
|
||||
|
||||
- In store files, merge class instances with `flattenActions` (do not spread class instances).
|
||||
- `flattenActions` binds methods to the original class instance and supports prototype methods and class fields.
|
||||
|
||||
```ts
|
||||
const createStore: StateCreator<HomeStore, [['zustand/devtools', never]]> = (...params) => ({
|
||||
...initialState,
|
||||
...flattenActions<HomeStoreAction>([
|
||||
createRecentSlice(...params),
|
||||
createHomeInputSlice(...params),
|
||||
]),
|
||||
});
|
||||
```
|
||||
|
||||
### Multi-Class Slices
|
||||
|
||||
- For large slices that need multiple action classes, compose them in the slice entry using `flattenActions`.
|
||||
- Use a local `PublicActions<T>` helper if you need to combine multiple classes and hide private fields.
|
||||
|
||||
```ts
|
||||
type PublicActions<T> = { [K in keyof T]: T[K] };
|
||||
|
||||
export type ChatGroupAction = PublicActions<
|
||||
ChatGroupInternalAction & ChatGroupLifecycleAction & ChatGroupMemberAction & ChatGroupCurdAction
|
||||
>;
|
||||
|
||||
export const chatGroupAction: StateCreator<
|
||||
ChatGroupStore,
|
||||
[['zustand/devtools', never]],
|
||||
[],
|
||||
ChatGroupAction
|
||||
> = (...params) =>
|
||||
flattenActions<ChatGroupAction>([
|
||||
new ChatGroupInternalAction(...params),
|
||||
new ChatGroupLifecycleAction(...params),
|
||||
new ChatGroupMemberAction(...params),
|
||||
new ChatGroupCurdAction(...params),
|
||||
]);
|
||||
```
|
||||
|
||||
### Store-Access Types
|
||||
|
||||
- For class methods that depend on actions in other classes, define explicit store augmentations:
|
||||
- `ChatGroupStoreWithSwitchTopic` for lifecycle `switchTopic`
|
||||
- `ChatGroupStoreWithRefresh` for member refresh
|
||||
- `ChatGroupStoreWithInternal` for curd `internal_dispatchChatGroup`
|
||||
|
||||
### Do / Don't
|
||||
|
||||
- **Do**: keep constructor signature aligned with `StateCreator` params `(set, get, api)`.
|
||||
- **Do**: use `#private` to avoid `set/get` being exposed.
|
||||
- **Do**: use `flattenActions` instead of spreading class instances.
|
||||
- **Don't**: keep both old slice objects and class actions active at the same time.
|
||||
|
||||
@@ -77,9 +77,9 @@ toggleMessageEditing: (id, editing) => {
|
||||
set(
|
||||
{ messageEditingIds: toggleBooleanList(get().messageEditingIds, id, editing) },
|
||||
false,
|
||||
'toggleMessageEditing',
|
||||
'toggleMessageEditing'
|
||||
);
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
## SWR Integration
|
||||
|
||||
@@ -3,7 +3,6 @@
|
||||
## Top-Level Store Structure
|
||||
|
||||
Key aggregation files:
|
||||
|
||||
- `src/store/chat/initialState.ts`: Aggregate all slice initial states
|
||||
- `src/store/chat/store.ts`: Define top-level `ChatStore`, combine all slice actions
|
||||
- `src/store/chat/selectors.ts`: Export all slice selectors
|
||||
@@ -75,10 +74,8 @@ export const initialTopicState: ChatTopicState = {
|
||||
```typescript
|
||||
const currentTopics = (s: ChatStoreState): ChatTopic[] | undefined => s.topicMaps[s.activeId];
|
||||
|
||||
const getTopicById =
|
||||
(id: string) =>
|
||||
(s: ChatStoreState): ChatTopic | undefined =>
|
||||
currentTopics(s)?.find((topic) => topic.id === id);
|
||||
const getTopicById = (id: string) => (s: ChatStoreState): ChatTopic | undefined =>
|
||||
currentTopics(s)?.find((topic) => topic.id === id);
|
||||
|
||||
// Core pattern: Use xxxSelectors aggregate
|
||||
export const topicSelectors = {
|
||||
@@ -103,21 +100,18 @@ src/store/chat/slices/aiChat/
|
||||
## State Design Patterns
|
||||
|
||||
### Map Structure for Associated Data
|
||||
|
||||
```typescript
|
||||
topicMaps: Record<string, ChatTopic[]>;
|
||||
messagesMap: Record<string, ChatMessage[]>;
|
||||
```
|
||||
|
||||
### Arrays for Loading State
|
||||
|
||||
```typescript
|
||||
messageLoadingIds: string[]
|
||||
topicLoadingIds: string[]
|
||||
```
|
||||
|
||||
### Optional Fields for Active Items
|
||||
|
||||
```typescript
|
||||
activeId: string
|
||||
activeTopicId?: string
|
||||
|
||||
@@ -29,35 +29,11 @@ Prioritize modules with business logic:
|
||||
|
||||
## Workflow
|
||||
|
||||
### 0. Pre-check: Scan Existing Test PRs
|
||||
|
||||
Before selecting a module, **MUST** scan existing PRs to avoid duplicate work:
|
||||
|
||||
1. **List in-flight PRs**:
|
||||
|
||||
```bash
|
||||
gh pr list --search "automatic/add-tests-" --state open --json number,title,headRefName,mergeable
|
||||
```
|
||||
|
||||
2. **Close conflicting PRs**: For any PR where `mergeable` is `"CONFLICTING"`, close it with a comment:
|
||||
|
||||
```bash
|
||||
gh pr close <number> --comment "Closing: this PR has merge conflicts with main and is outdated. A new test PR may be created for this module."
|
||||
```
|
||||
|
||||
3. **Build exclusion list**: Extract module names from the remaining open PR branch names (`automatic/add-tests-<module-name>-<date>`), and **exclude those modules** from selection in the next step.
|
||||
|
||||
4. **Output summary** (for logging):
|
||||
- Total open test PRs found
|
||||
- PRs closed due to conflicts
|
||||
- Modules currently in-flight (excluded from selection)
|
||||
|
||||
### 1. Select a Module to Process
|
||||
|
||||
**Selection Strategy**:
|
||||
|
||||
- Randomly pick ONE module from the target directories
|
||||
- **MUST skip modules that already have an open PR** (from step 0's exclusion list)
|
||||
- Prioritize modules that:
|
||||
- Have significant business logic
|
||||
- Have no or minimal test coverage
|
||||
|
||||
@@ -5,11 +5,10 @@ You are a support assistant for LobeChat authentication migration issues. Your j
|
||||
**IMPORTANT**: The official documentation website is `https://lobehub.com`. When providing documentation links, always use `https://lobehub.com/docs/...` format. Never use `lobechat.com` - that domain is incorrect.
|
||||
|
||||
Examples of correct documentation URLs:
|
||||
|
||||
- `https://lobehub.com/docs/self-hosting/migration/v2/auth/nextauth-to-betterauth`
|
||||
- `https://lobehub.com/docs/self-hosting/migration/v2/auth/clerk-to-betterauth`
|
||||
- `https://lobehub.com/docs/self-hosting/auth`
|
||||
- `https://lobehub.com/docs/self-hosting/auth/providers/casdoor`
|
||||
- `https://lobehub.com/docs/self-hosting/advanced/auth/nextauth-to-betterauth`
|
||||
- `https://lobehub.com/docs/self-hosting/advanced/auth/clerk-to-betterauth`
|
||||
- `https://lobehub.com/docs/self-hosting/advanced/auth`
|
||||
- `https://lobehub.com/docs/self-hosting/advanced/auth/providers/casdoor`
|
||||
|
||||
## Target Issues
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user