| Dimension | Shared | Only in A | Only in B | Overlap |
|---|---|---|---|---|
| Sections | 0 | 5 | 12 | 0% |
| Commands | 0 | 0 | 19 | 0% |
| Section tags | 2 | 1 | 12 | 13% |
What each file covers
Sections
0 shared · 5 only in A · 12 only in B- − Backend Server (apps/server)
- − Bootstrap & Lifecycle
- − HTTP & WebSocket Design
- − Configuration & Environment
- − Error Handling & Observability
- + Project Coded Agent Guide
- + Tech Stack (by surface)
- + Structure & Responsibilities
- + Key Path Index (what lives where)
- + Commands (pnpm with filters)
- + Dependency Management Rule
- + Styling & Conventions
- + Testing Practices
- + TypeScript / Tooling
- + Refactoring & Comments
- + PR / Workflow Tips
- + Docker + SQL Conventions
Commands
0 shared · 0 only in A · 19 only in B- + eslint.config.ts
- + pnpm-workspace.yaml
- + docker/
- + pnpm -F @tg-search/server dev
- + pnpm run web:dev
- + pnpm run server:dev
- + pnpm run start
- + pnpm run build
- + pnpm run server:build
- + pnpm run test:run
- + pnpm run test:coverage
- + pnpm run lint
- + pnpm run lint:fix
- + pnpm run typecheck
- + pnpm run db:generate
- + pnpm install
- + pnpm install -F <target> <dependency>
- + vitest
- + docker-compose.yml
Section tags
2 shared · 1 only in A · 12 only in B- − security
- + build
- + test
- + lint-format
- + code-style
- + architecture
- + types
- + testing-strategy
- + git-pr
- + database
- + ui
- + agent-behaviour
- + docs
- setup
- monorepo
Line diff
groupultra/telegram-search · .cursor/rules/backend-server.mdc
@@ −1 @@
1---
2globs: apps/server/src/**/*
3---
4
5## Backend Server (apps/server)
6
7- **Role**: Thin WebSocket + HTTP edge that:
8 - Hosts a **`CoreContext` per WebSocket connection**.
9 - Exposes health/metrics endpoints.
10 - Delegates all business logic to `packages/core`.
11- Do **not** add business rules, Telegram API calls, or heavy data processing into `apps/server`; push those into `packages/core`.
12
13### Bootstrap & Lifecycle
14
15- Preserve the bootstrap sequence from `src/app.ts`:
16 1. Parse env flags (`parseEnvFlags`).
17 2. Initialize logging (`initLogger` + `useLogger().useGlobalConfig()`).
18 3. Build runtime config from environment (`parseEnvToConfig(process.env)`).
19 4. Initialize database via `initDrizzle` using that config.
20 5. Configure the HTTP/WebSocket server.
21 6. Start listening via `listhen` and register graceful shutdown handlers.
22- Any changes must keep this order clear and failure modes explicit.
23
24### HTTP & WebSocket Design
25
26- HTTP:
27 - Keep endpoints minimal: health checks, metrics, and potentially a small set of diagnostics.
28 - Reuse `h3` helpers (`createApp`, `createRouter`, `defineEventHandler`) and centralize error handling in `onError`.
29 - Never leak internal error details in HTTP responses; log full details, return generic messages.
30- WebSocket:
31 - Route all WS traffic through a dedicated module (e.g. `ws/routes`) that knows how to instantiate and manage `CoreContext`.
32 - Enforce **one `CoreContext` per connection**; no cross-connection sharing.
33 - When adding new events, ensure types are synchronized with `@tg-search/server/types` and `@tg-search/core`.
34
35### Configuration & Environment
36
37- Source configuration from `config.yaml` + environment variables only; avoid hard-coding URLs, ports, or credentials.
38- Keep the config schema compatible between server and browser modes where applicable (database, embedding, Telegram API).
39- When adding new configuration options:
40 - Document them in `.env.example`.
41 - Provide safe defaults that will not break existing deployments.
42
43### Error Handling & Observability
44
45- Use central error handlers:
46 - `setupErrorHandlers` for process-level errors (uncaughtException, unhandledRejection).
47 - `h3`'s `onError` hook for HTTP path errors.
48- Metrics:
49 - Use `prom-client` and expose metrics from `/metrics` using the shared registry.
50 - Only add new metrics when they support explicit SLOs (latency, error rate, throughput).
51
52
groupultra/telegram-search · AGENTS.md
@@ +1 @@
1# Project Coded Agent Guide
2
3Concise but detailed reference for contributors working in the `groupultra/telegram-search` monorepo. Improve code when you touch it; avoid one-off patterns.
4
5## Tech Stack (by surface)
6
7- **Server (`apps/server`)**: Node.js, TypeScript, Drizzle ORM, Postgres/pgvector, WebSocket + REST, dotenvx.
8- **Web (`apps/web`)**: Vue 3 + Vite, Pinia.
9- **Core/shared (`packages/*`)**: common types, client SDK, schema, core services, bot.
10- **Tooling**: pnpm workspaces, Vitest, ESLint, TypeScript 5.9, tsdown, Drizzle Kit.
11
12## Structure & Responsibilities
13
14- **Apps**
15 - `apps/server`: backend service (runtime entry in `apps/server/src/`).
16 - `apps/web`: web UI (source in `apps/web/src/`).
17- **Packages**
18 - `packages/`: shared libraries and domain logic used by apps.
19- **Root tooling**
20 - Linting: `eslint.config.ts`.
21 - DB tooling: `drizzle/`, `drizzle.config.ts`.
22 - Workspace: `pnpm-workspace.yaml`.
23
24## Key Path Index (what lives where)
25
26- `apps/server/src`: API, WebSocket, and session services.
27- `apps/web/src`: Vue UI and client-side logic.
28- `packages/core`: core domain/services.
29- `packages/schema`: shared types + DB schema.
30- `packages/client`: client SDKs for integration.
31- `docker/`: compose files + init scripts for local/dev.
32- `.env.example`: baseline env config.
33
34## Commands (pnpm with filters)
35
36> Use pnpm workspace filters to scope tasks, e.g. `pnpm -F @tg-search/server dev`.
37
38- **Dev (web only)**: `pnpm run web:dev`
39- **Dev (server only)**: `pnpm run server:dev`
40- **Dev (web + server)**: `pnpm run start`
41- **Build web**: `pnpm run build`
42- **Build server**: `pnpm run server:build`
43- **Run tests**: `pnpm run test:run`
44- **Coverage**: `pnpm run test:coverage`
45- **Lint**: `pnpm run lint` / `pnpm run lint:fix`
46- **Typecheck**: `pnpm run typecheck`
47- **DB generate**: `pnpm run db:generate`
48
49## Dependency Management Rule
50
51- Do not edit `package.json` directly to add/remove deps. Use `pnpm install` so lockfile and manifest stay in sync.
52- For workspace deps: `pnpm install -F <target> <dependency>` (add `-D` for dev deps).
53- Tooling like `typescript`, `vite`, `vitest`, `tsdown`, `@types/node` belongs at the workspace root (`-w`).
54
55## Styling & Conventions
56
57- Favor clear module boundaries; shared logic goes in `packages/`.
58- Keep runtime entrypoints lean; move heavy logic into services/modules.
59- Prefer functional patterns for testability; use DI where helpful. Avoid classes unless required by APIs.
60- Use Valibot for schema validation; keep schemas close to their consumers.
61- Use Eventa (`@moeru/eventa`) for structured IPC/RPC contracts where needed.
62- File names: `kebab-case`.
63- Do not add backward-compatibility guards. If extended support is required, write refactor docs and complete the change in a separate, well-scoped effort.
64- If the refactor scope is small, do a progressive refactor step by step.
65- When modifying code, look for small, safe refactors to reduce duplication or improve clarity.
66- If you need a workaround, add a `// NOTICE:` comment explaining why, the root cause, and any relevant context.
67
68## Testing Practices
69
70- Use Vitest for unit/integration tests.
71- Mock external services and Postgres where practical; keep tests deterministic.
72- When fixing a bug, add a Vitest test that documents the previous failure mode and include a short `//` comment about the cause.
73- For DB interactions, prefer migration-driven integration tests with env guards.
74
75## TypeScript / Tooling
76
77- Stay strict with types; avoid `any` unless absolutely necessary.
78- Prefer small, composable modules; keep exports minimal and intentional.
79
80## Refactoring & Comments
81
82- Prefer progressive, incremental refactors that keep behavior stable.
83- Keep existing comments with the code when moving/refactoring. If a comment becomes obsolete, replace it with a brief note about why it was removed.
84- Use markers consistently: `// TODO:`, `// REVIEW:`, `// NOTICE:`.
85- Add concise comments for complex logic, algorithms, OS-interaction, and shared utilities. Avoid obvious comments.
86
87## PR / Workflow Tips
88
89- Keep changes scoped; use workspace filters for commands.
90- Summarize changes, how tested (commands), and follow-ups.
91- Improve legacy when you touch it; avoid one-off patterns.
92- Maintain structured `README.md` documentation for each `packages/` and `apps/` entry.
93- Always run `pnpm run typecheck` and `pnpm run lint:fix` after finishing a task.
94- Use Conventional Commits (e.g., `feat(server): add session refresh`).
95
96## Docker + SQL Conventions
97
98- Use `docker-compose.yml` as the compose filename.
99- Do not write SQL migration files manually. Always use `drizzle-kit generate` to create migrations, which will be placed in `**/sql/` with descriptive, kebab-case names.
100- Avoid Postgres enums to keep migrations and imports flexible.
101
@@ −1 +1 @@
1−---
2−globs: apps/server/src/**/*
3−---
1+# Project Coded Agent Guide
42
5−## Backend Server (apps/server)
3+Concise but detailed reference for contributors working in the `groupultra/telegram-search` monorepo. Improve code when you touch it; avoid one-off patterns.
64
7−- **Role**: Thin WebSocket + HTTP edge that:
8− - Hosts a **`CoreContext` per WebSocket connection**.
9− - Exposes health/metrics endpoints.
10− - Delegates all business logic to `packages/core`.
11−- Do **not** add business rules, Telegram API calls, or heavy data processing into `apps/server`; push those into `packages/core`.
5+## Tech Stack (by surface)
126
13−### Bootstrap & Lifecycle
7+- **Server (`apps/server`)**: Node.js, TypeScript, Drizzle ORM, Postgres/pgvector, WebSocket + REST, dotenvx.
8+- **Web (`apps/web`)**: Vue 3 + Vite, Pinia.
9+- **Core/shared (`packages/*`)**: common types, client SDK, schema, core services, bot.
10+- **Tooling**: pnpm workspaces, Vitest, ESLint, TypeScript 5.9, tsdown, Drizzle Kit.
1411
15−- Preserve the bootstrap sequence from `src/app.ts`:
16− 1. Parse env flags (`parseEnvFlags`).
17− 2. Initialize logging (`initLogger` + `useLogger().useGlobalConfig()`).
18− 3. Build runtime config from environment (`parseEnvToConfig(process.env)`).
19− 4. Initialize database via `initDrizzle` using that config.
20− 5. Configure the HTTP/WebSocket server.
21− 6. Start listening via `listhen` and register graceful shutdown handlers.
22−- Any changes must keep this order clear and failure modes explicit.
12+## Structure & Responsibilities
2313
24−### HTTP & WebSocket Design
14+- **Apps**
15+ - `apps/server`: backend service (runtime entry in `apps/server/src/`).
16+ - `apps/web`: web UI (source in `apps/web/src/`).
17+- **Packages**
18+ - `packages/`: shared libraries and domain logic used by apps.
19+- **Root tooling**
20+ - Linting: `eslint.config.ts`.
21+ - DB tooling: `drizzle/`, `drizzle.config.ts`.
22+ - Workspace: `pnpm-workspace.yaml`.
2523
26−- HTTP:
27− - Keep endpoints minimal: health checks, metrics, and potentially a small set of diagnostics.
28− - Reuse `h3` helpers (`createApp`, `createRouter`, `defineEventHandler`) and centralize error handling in `onError`.
29− - Never leak internal error details in HTTP responses; log full details, return generic messages.
30−- WebSocket:
31− - Route all WS traffic through a dedicated module (e.g. `ws/routes`) that knows how to instantiate and manage `CoreContext`.
32− - Enforce **one `CoreContext` per connection**; no cross-connection sharing.
33− - When adding new events, ensure types are synchronized with `@tg-search/server/types` and `@tg-search/core`.
24+## Key Path Index (what lives where)
3425
35−### Configuration & Environment
26+- `apps/server/src`: API, WebSocket, and session services.
27+- `apps/web/src`: Vue UI and client-side logic.
28+- `packages/core`: core domain/services.
29+- `packages/schema`: shared types + DB schema.
30+- `packages/client`: client SDKs for integration.
31+- `docker/`: compose files + init scripts for local/dev.
32+- `.env.example`: baseline env config.
3633
37−- Source configuration from `config.yaml` + environment variables only; avoid hard-coding URLs, ports, or credentials.
38−- Keep the config schema compatible between server and browser modes where applicable (database, embedding, Telegram API).
39−- When adding new configuration options:
40− - Document them in `.env.example`.
41− - Provide safe defaults that will not break existing deployments.
34+## Commands (pnpm with filters)
4235
43−### Error Handling & Observability
36+> Use pnpm workspace filters to scope tasks, e.g. `pnpm -F @tg-search/server dev`.
4437
45−- Use central error handlers:
46− - `setupErrorHandlers` for process-level errors (uncaughtException, unhandledRejection).
47− - `h3`'s `onError` hook for HTTP path errors.
48−- Metrics:
49− - Use `prom-client` and expose metrics from `/metrics` using the shared registry.
50− - Only add new metrics when they support explicit SLOs (latency, error rate, throughput).
38+- **Dev (web only)**: `pnpm run web:dev`
39+- **Dev (server only)**: `pnpm run server:dev`
40+- **Dev (web + server)**: `pnpm run start`
41+- **Build web**: `pnpm run build`
42+- **Build server**: `pnpm run server:build`
43+- **Run tests**: `pnpm run test:run`
44+- **Coverage**: `pnpm run test:coverage`
45+- **Lint**: `pnpm run lint` / `pnpm run lint:fix`
46+- **Typecheck**: `pnpm run typecheck`
47+- **DB generate**: `pnpm run db:generate`
5148
49+## Dependency Management Rule
50+
51+- Do not edit `package.json` directly to add/remove deps. Use `pnpm install` so lockfile and manifest stay in sync.
52+- For workspace deps: `pnpm install -F <target> <dependency>` (add `-D` for dev deps).
53+- Tooling like `typescript`, `vite`, `vitest`, `tsdown`, `@types/node` belongs at the workspace root (`-w`).
54+
55+## Styling & Conventions
56+
57+- Favor clear module boundaries; shared logic goes in `packages/`.
58+- Keep runtime entrypoints lean; move heavy logic into services/modules.
59+- Prefer functional patterns for testability; use DI where helpful. Avoid classes unless required by APIs.
60+- Use Valibot for schema validation; keep schemas close to their consumers.
61+- Use Eventa (`@moeru/eventa`) for structured IPC/RPC contracts where needed.
62+- File names: `kebab-case`.
63+- Do not add backward-compatibility guards. If extended support is required, write refactor docs and complete the change in a separate, well-scoped effort.
64+- If the refactor scope is small, do a progressive refactor step by step.
65+- When modifying code, look for small, safe refactors to reduce duplication or improve clarity.
66+- If you need a workaround, add a `// NOTICE:` comment explaining why, the root cause, and any relevant context.
67+
68+## Testing Practices
69+
70+- Use Vitest for unit/integration tests.
71+- Mock external services and Postgres where practical; keep tests deterministic.
72+- When fixing a bug, add a Vitest test that documents the previous failure mode and include a short `//` comment about the cause.
73+- For DB interactions, prefer migration-driven integration tests with env guards.
74+
75+## TypeScript / Tooling
76+
77+- Stay strict with types; avoid `any` unless absolutely necessary.
78+- Prefer small, composable modules; keep exports minimal and intentional.
79+
80+## Refactoring & Comments
81+
82+- Prefer progressive, incremental refactors that keep behavior stable.
83+- Keep existing comments with the code when moving/refactoring. If a comment becomes obsolete, replace it with a brief note about why it was removed.
84+- Use markers consistently: `// TODO:`, `// REVIEW:`, `// NOTICE:`.
85+- Add concise comments for complex logic, algorithms, OS-interaction, and shared utilities. Avoid obvious comments.
86+
87+## PR / Workflow Tips
88+
89+- Keep changes scoped; use workspace filters for commands.
90+- Summarize changes, how tested (commands), and follow-ups.
91+- Improve legacy when you touch it; avoid one-off patterns.
92+- Maintain structured `README.md` documentation for each `packages/` and `apps/` entry.
93+- Always run `pnpm run typecheck` and `pnpm run lint:fix` after finishing a task.
94+- Use Conventional Commits (e.g., `feat(server): add session refresh`).
95+
96+## Docker + SQL Conventions
97+
98+- Use `docker-compose.yml` as the compose filename.
99+- Do not write SQL migration files manually. Always use `drizzle-kit generate` to create migrations, which will be placed in `**/sql/` with descriptive, kebab-case names.
100+- Avoid Postgres enums to keep migrations and imports flexible.
52101
