d3209b5aab
Maintainer resolved E1 as variant B: the public vitals sink + client collection must be OFF by default (else client_metrics grows unbounded on a self-host deploy with no external pruner, via an unauthenticated public endpoint). - F1: new operator flag CLIENT_TELEMETRY_ENABLED (default OFF), SEPARATE from METRICS_PORT (Grafana reads the table directly, independent of the scrape port). ClientTelemetryModule.register() provides VitalsController ONLY when the flag is true (route absent otherwise); the flag reaches the client via window.CONFIG (config.ts isClientTelemetryEnabled), and initVitals() early-returns when off. - F2/F3 [throttler]: this repo's ThrottlerGuard applies EVERY named throttler to every guarded route unless skipped. The new VITALS bucket therefore (a) newly bound collab-token → 429 behind shared/NAT IPs, and (b) the vitals route didn't skip the stricter public-share-ai (5/min) bucket → effective 5/min not 120. Fix (additive, global config unchanged): vitals.controller @SkipThrottle the other buckets + @Throttle VITALS 120/min; collab-token adds VITALS_THROTTLER to its existing @SkipThrottle (restoring its prior effectively-unthrottled state). - F4: metrics node:http server is closed on shutdown (MetricsServerLifecycle OnModuleDestroy → closeMetricsServer(), fired by enableShutdownHooks). - F5: docSize outside [0, int4-max] drops to null (keeping the event) instead of overflowing int4 and failing the WHOLE batch insert (+ 2 tests). - F6: .env.example documents METRICS_PORT (no default — unset = subsystem OFF) + CLIENT_TELEMETRY_ENABLED; fixed the inaccurate "default 9464" wording. - F7: disabled/non-sampled sessions install ZERO observers — isVitalsActive() (enabled && sampled) gates reportClientMetric AND the page-editor measurePageOpen + dispatchTransaction wrapping. - F8: kept db.d.ts hand-added (wontfix) — this repo HAND-CURATES db.d.ts (verified across recent fork migrations a32fba63/8c5b57eb/fdeede00); codegen would be the deviation. The ClientMetrics interface maps the migration 1:1. Gate: server tsc 0, client tsc 0, server metrics/vitals/telemetry/throttle 21 tests, client route-template 5. No new deps. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
114 lines
4.1 KiB
TypeScript
114 lines
4.1 KiB
TypeScript
import { Module } from '@nestjs/common';
|
|
import { APP_INTERCEPTOR } from '@nestjs/core';
|
|
import { AppController } from './app.controller';
|
|
import { AppService } from './app.service';
|
|
import { EnvironmentService } from './integrations/environment/environment.service';
|
|
import { AuditActorInterceptor } from './common/interceptors/audit-actor.interceptor';
|
|
import { CoreModule } from './core/core.module';
|
|
import { EnvironmentModule } from './integrations/environment/environment.module';
|
|
import { CollaborationModule } from './collaboration/collaboration.module';
|
|
import { WsModule } from './ws/ws.module';
|
|
import { DatabaseModule } from '@docmost/db/database.module';
|
|
import { StorageModule } from './integrations/storage/storage.module';
|
|
import { MailModule } from './integrations/mail/mail.module';
|
|
import { QueueModule } from './integrations/queue/queue.module';
|
|
import { StaticModule } from './integrations/static/static.module';
|
|
import { EventEmitterModule } from '@nestjs/event-emitter';
|
|
import { HealthModule } from './integrations/health/health.module';
|
|
import { ExportModule } from './integrations/export/export.module';
|
|
import { ImportModule } from './integrations/import/import.module';
|
|
import { SecurityModule } from './integrations/security/security.module';
|
|
import { TelemetryModule } from './integrations/telemetry/telemetry.module';
|
|
import { RedisModule } from '@nestjs-labs/nestjs-ioredis';
|
|
import { RedisConfigService } from './integrations/redis/redis-config.service';
|
|
import { CacheModule } from '@nestjs/cache-manager';
|
|
import KeyvRedis from '@keyv/redis';
|
|
import { LoggerModule } from './common/logger/logger.module';
|
|
import { ClsModule } from 'nestjs-cls';
|
|
import { NoopAuditModule } from './integrations/audit/audit.module';
|
|
import { ThrottleModule } from './integrations/throttle/throttle.module';
|
|
import { McpModule } from './integrations/mcp/mcp.module';
|
|
import { SandboxModule } from './integrations/sandbox/sandbox.module';
|
|
import { AiModule } from './integrations/ai/ai.module';
|
|
import { AiChatModule } from './core/ai-chat/ai-chat.module';
|
|
import { MetricsModule } from './integrations/metrics/metrics.module';
|
|
import { ClientTelemetryModule } from './core/telemetry/client-telemetry.module';
|
|
|
|
const enterpriseModules = [];
|
|
try {
|
|
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
|
if (require('./ee/ee.module')?.EeModule) {
|
|
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
|
enterpriseModules.push(require('./ee/ee.module')?.EeModule);
|
|
}
|
|
} catch (err) {
|
|
if (process.env.CLOUD === 'true') {
|
|
console.warn('Failed to load enterprise modules. Exiting program.\n', err);
|
|
process.exit(1);
|
|
}
|
|
}
|
|
|
|
@Module({
|
|
imports: [
|
|
ClsModule.forRoot({
|
|
global: true,
|
|
middleware: { mount: true },
|
|
}),
|
|
LoggerModule,
|
|
NoopAuditModule,
|
|
CoreModule,
|
|
DatabaseModule,
|
|
EnvironmentModule,
|
|
RedisModule.forRootAsync({
|
|
useClass: RedisConfigService,
|
|
}),
|
|
CacheModule.registerAsync({
|
|
isGlobal: true,
|
|
useFactory: async (environmentService: EnvironmentService) => {
|
|
const redisUrl = environmentService.getRedisUrl();
|
|
|
|
return {
|
|
ttl: 5 * 1000,
|
|
stores: [new KeyvRedis(redisUrl)],
|
|
};
|
|
},
|
|
inject: [EnvironmentService],
|
|
}),
|
|
CollaborationModule,
|
|
WsModule,
|
|
QueueModule,
|
|
StaticModule,
|
|
HealthModule,
|
|
ImportModule,
|
|
ExportModule,
|
|
StorageModule.forRootAsync({
|
|
imports: [EnvironmentModule],
|
|
}),
|
|
MailModule.forRootAsync({
|
|
imports: [EnvironmentModule],
|
|
}),
|
|
EventEmitterModule.forRoot(),
|
|
SecurityModule,
|
|
TelemetryModule,
|
|
ThrottleModule,
|
|
McpModule,
|
|
SandboxModule,
|
|
AiModule,
|
|
AiChatModule,
|
|
MetricsModule,
|
|
// Gated OFF by default: only registers the public vitals sink controller
|
|
// when CLIENT_TELEMETRY_ENABLED=true (maintainer decision E1=B).
|
|
ClientTelemetryModule.register(),
|
|
...enterpriseModules,
|
|
],
|
|
controllers: [AppController],
|
|
providers: [
|
|
AppService,
|
|
{
|
|
provide: APP_INTERCEPTOR,
|
|
useClass: AuditActorInterceptor,
|
|
},
|
|
],
|
|
})
|
|
export class AppModule {}
|