| Dimension | Shared | Only in A | Only in B | Overlap |
|---|---|---|---|---|
| Sections | 0 | 1 | 2 | 0% |
| Commands | 0 | 0 | 1 | 0% |
| Section tags | 1 | 0 | 0 | 100% |
What each file covers
Sections
0 shared · 1 only in A · 2 only in B- − ClickHouse Conventions
- + WebSocket Service
- + WebSocket Conventions
Commands
0 shared · 0 only in A · 1 only in B- + pnpm start:ws
Section tags
1 shared · 0 only in A · 0 only in B- code-style
Line diff
novuhq/novu · .cursor/rules/clickhouse.mdc
@@ −1 @@
1---
2description: Rules for working with ClickHouse analytics and trace logging
3globs:
4 - "**/analytic-logs/**"
5 - "**/clickhouse-migrations/**"
6alwaysApply: false
7---
8
9### ClickHouse Conventions
10
11**Service layer**
12- Use `ClickHouseService` for single queries/inserts and `ClickHouseBatchService` for high-throughput writes.
13- Both are registered as custom providers (`clickHouseService`, `clickHouseBatchService`) in each app's `shared.module.ts`.
14- Never instantiate ClickHouse clients directly — always inject the providers.
15
16**Repositories**
17- All ClickHouse repositories extend `LogRepository` in `libs/application-generic/src/services/analytic-logs/`.
18- Each repository has a corresponding schema file defining the table columns and types.
19- Always include `_environmentId` and `_organizationId` in queries for tenant isolation (same pattern as MongoDB DAL).
20
21**Migrations**
22- ClickHouse migrations are numbered `.sql` files in `apps/api/migrations/clickhouse-migrations/`.
23- Run locally with `cd apps/api && pnpm run clickhouse:migrate:local`.
24- New migrations must be additive — never alter or drop columns that existing queries depend on. Use temp tables and exchange patterns for schema refactors (see migration 4/5 for the established pattern).
25
26**Feature flags**
27- Gate new ClickHouse-dependent behavior behind a feature flag (see `packages/shared/src/types/feature-flags.ts` for existing flags like `IS_CLICKHOUSE_BATCHING_ENABLED`).
28
novuhq/novu · .cursor/rules/ws.mdc
@@ +1 @@
1---
2description: Rules for working in the WebSocket service (real-time delivery)
3globs: apps/ws/**/*
4alwaysApply: false
5---
6
7## WebSocket Service
8
9**Stack:** NestJS · Socket.io with Redis adapter (horizontal scaling)
10
11**Run:** `pnpm start:ws` — only needed for real-time features (live inbox, read/unread sync). Skip for most tasks.
12
13**Key directories:**
14```
15apps/ws/src/ # Socket gateways, guards, and event handlers
16```
17
18### WebSocket Conventions
19
20**Authentication:** Clients authenticate via JWT on the Socket.io handshake.
21
22**Scaling:** The Redis adapter is required in production — multiple ws instances share socket state through it.
23
24**Client packages:** Events emitted here are consumed by `@novu/js` and `@novu/react`. New Socket.io event types require matching updates in both packages.
25
@@ −1 +1 @@
11 ---
2−description: Rules for working with ClickHouse analytics and trace logging
3−globs:
4− - "**/analytic-logs/**"
5− - "**/clickhouse-migrations/**"
2+description: Rules for working in the WebSocket service (real-time delivery)
3+globs: apps/ws/**/*
64 alwaysApply: false
75 ---
86
9−### ClickHouse Conventions
7+## WebSocket Service
108
11−**Service layer**
12−- Use `ClickHouseService` for single queries/inserts and `ClickHouseBatchService` for high-throughput writes.
13−- Both are registered as custom providers (`clickHouseService`, `clickHouseBatchService`) in each app's `shared.module.ts`.
14−- Never instantiate ClickHouse clients directly — always inject the providers.
9+**Stack:** NestJS · Socket.io with Redis adapter (horizontal scaling)
1510
16−**Repositories**
17−- All ClickHouse repositories extend `LogRepository` in `libs/application-generic/src/services/analytic-logs/`.
18−- Each repository has a corresponding schema file defining the table columns and types.
19−- Always include `_environmentId` and `_organizationId` in queries for tenant isolation (same pattern as MongoDB DAL).
11+**Run:** `pnpm start:ws` — only needed for real-time features (live inbox, read/unread sync). Skip for most tasks.
2012
21−**Migrations**
22−- ClickHouse migrations are numbered `.sql` files in `apps/api/migrations/clickhouse-migrations/`.
23−- Run locally with `cd apps/api && pnpm run clickhouse:migrate:local`.
24−- New migrations must be additive — never alter or drop columns that existing queries depend on. Use temp tables and exchange patterns for schema refactors (see migration 4/5 for the established pattern).
13+**Key directories:**
14+```
15+apps/ws/src/ # Socket gateways, guards, and event handlers
16+```
2517
26−**Feature flags**
27−- Gate new ClickHouse-dependent behavior behind a feature flag (see `packages/shared/src/types/feature-flags.ts` for existing flags like `IS_CLICKHOUSE_BATCHING_ENABLED`).
18+### WebSocket Conventions
19+
20+**Authentication:** Clients authenticate via JWT on the Socket.io handshake.
21+
22+**Scaling:** The Redis adapter is required in production — multiple ws instances share socket state through it.
23+
24+**Client packages:** Events emitted here are consumed by `@novu/js` and `@novu/react`. New Socket.io event types require matching updates in both packages.
2825
