Skip to content

ever-co/ever-works / .agents/skills/nestjs-best-practices

nestjs-best-practices

Verified

NestJS best practices and architecture patterns for building production-ready applications. This skill should be used when writing, reviewing, or refactoring NestJS code to ensure proper patterns for modules, dependency injection, security, and performance.

FileKindSize
AGENTS.mdmarkdown154.2 KB
README.mdmarkdown4.7 KB
SKILL.mdskill md4.8 KB
rules/_sections.mdmarkdown2.1 KB
rules/_template.mdmarkdown633 B
rules/api-use-dto-serialization.mdmarkdown4.2 KB
rules/api-use-interceptors.mdmarkdown5.4 KB
rules/api-use-pipes.mdmarkdown5.3 KB
rules/api-versioning.mdmarkdown4.7 KB
rules/arch-avoid-circular-deps.mdmarkdown1.9 KB
rules/arch-feature-modules.mdmarkdown2.3 KB
rules/arch-module-sharing.mdmarkdown3.7 KB
rules/arch-single-responsibility.mdmarkdown2.8 KB
rules/arch-use-events.mdmarkdown2.9 KB
rules/arch-use-repository-pattern.mdmarkdown2.7 KB
rules/db-avoid-n-plus-one.mdmarkdown3.8 KB
rules/db-use-migrations.mdmarkdown3.7 KB
rules/db-use-transactions.mdmarkdown3.6 KB
rules/devops-graceful-shutdown.mdmarkdown5.5 KB
rules/devops-use-config-module.mdmarkdown4.2 KB
rules/devops-use-logging.mdmarkdown5.1 KB
rules/di-avoid-service-locator.mdmarkdown2.8 KB
rules/di-interface-segregation.mdmarkdown5.0 KB
rules/di-liskov-substitution.mdmarkdown6.8 KB
rules/di-prefer-constructor-injection.mdmarkdown2.2 KB
rules/di-scope-awareness.mdmarkdown2.5 KB
rules/di-use-interfaces-tokens.mdmarkdown2.5 KB
rules/error-handle-async-errors.mdmarkdown3.4 KB
rules/error-throw-http-exceptions.mdmarkdown3.0 KB
rules/error-use-exception-filters.mdmarkdown3.4 KB
rules/micro-use-health-checks.mdmarkdown6.1 KB
rules/micro-use-patterns.mdmarkdown5.0 KB
rules/micro-use-queues.mdmarkdown5.7 KB
rules/perf-async-hooks.mdmarkdown2.8 KB
rules/perf-lazy-loading.mdmarkdown3.6 KB
rules/perf-optimize-database.mdmarkdown3.0 KB
rules/perf-use-caching.mdmarkdown3.3 KB
rules/security-auth-jwt.mdmarkdown3.8 KB
rules/security-rate-limiting.mdmarkdown3.1 KB
rules/security-sanitize-output.mdmarkdown3.7 KB
rules/security-use-guards.mdmarkdown3.4 KB
rules/security-validate-all-input.mdmarkdown3.2 KB
rules/test-e2e-supertest.mdmarkdown4.4 KB
rules/test-mock-external-services.mdmarkdown4.2 KB
rules/test-use-testing-module.mdmarkdown4.1 KB
scripts/build-agents.tsscript8.1 KB
scripts/build.shscript369 B
scripts/package-lock.jsonmanifest7.7 KB
scripts/package.jsonmanifest410 B

rules/perf-use-caching.md

View on GitHub
---
title: Use Caching Strategically
impact: HIGH
impactDescription: Dramatically reduces database load and response times
tags: performance, caching, redis, optimization
---

## Use Caching Strategically

Implement caching for expensive operations, frequently accessed data, and external API calls. Use NestJS CacheModule with appropriate TTLs and cache invalidation strategies. Don't cache everything - focus on high-impact areas.

**Incorrect (no caching or caching everything):**

```typescript
// No caching for expensive, repeated queries
@Injectable()
export class ProductsService {
	async getPopular(): Promise<Product[]> {
		// Runs complex aggregation query EVERY request
		return this.productsRepo
			.createQueryBuilder('p')
			.leftJoin('p.orders', 'o')
			.select('p.*, COUNT(o.id) as orderCount')
			.groupBy('p.id')
			.orderBy('orderCount', 'DESC')
			.limit(20)
			.getMany();
	}
}

// Cache everything without thought
@Injectable()
export class UsersService {
	@CacheKey('users')
	@CacheTTL(3600)
	@UseInterceptors(CacheInterceptor)
	async findAll(): Promise<User[]> {
		// Caching user list for 1 hour is wrong if data changes frequently
		return this.usersRepo.find();
	}
}
```

**Correct (strategic caching with proper invalidation):**

```typescript
// Setup caching module
@Module({
	imports: [
		CacheModule.registerAsync({
			imports: [ConfigModule],
			inject: [ConfigService],
			useFactory: (config: ConfigService) => ({
				stores: [new KeyvRedis(config.get('REDIS_URL'))],
				ttl: 60 * 1000 // Default 60s
			})
		})
	]
})
export class AppModule {}

// Manual caching for granular control
@Injectable()
export class ProductsService {
	constructor(
		@Inject(CACHE_MANAGER) private cache: Cache,
		private productsRepo: ProductRepository
	) {}

	async getPopular(): Promise<Product[]> {
		const cacheKey = 'products:popular';

		// Try cache first
		const cached = await this.cache.get<Product[]>(cacheKey);
		if (cached) return cached;

		// Cache miss - fetch and cache
		const products = await this.fetchPopularProducts();
		await this.cache.set(cacheKey, products, 5 * 60 * 1000); // 5 min TTL
		return products;
	}

	// Invalidate cache on changes
	async updateProduct(id: string, dto: UpdateProductDto): Promise<Product> {
		const product = await this.productsRepo.save({ id, ...dto });
		await this.cache.del('products:popular'); // Invalidate
		return product;
	}
}

// Decorator-based caching with auto-interceptor
@Controller('categories')
@UseInterceptors(CacheInterceptor)
export class CategoriesController {
	@Get()
	@CacheTTL(30 * 60 * 1000) // 30 minutes - categories rarely change
	findAll(): Promise<Category[]> {
		return this.categoriesService.findAll();
	}

	@Get(':id')
	@CacheTTL(60 * 1000) // 1 minute
	@CacheKey('category')
	findOne(@Param('id') id: string): Promise<Category> {
		return this.categoriesService.findOne(id);
	}
}

// Event-based cache invalidation
@Injectable()
export class CacheInvalidationService {
	constructor(@Inject(CACHE_MANAGER) private cache: Cache) {}

	@OnEvent('product.created')
	@OnEvent('product.updated')
	@OnEvent('product.deleted')
	async invalidateProductCaches(event: ProductEvent) {
		await Promise.all([this.cache.del('products:popular'), this.cache.del(`product:${event.productId}`)]);
	}
}
```

Reference: [NestJS Caching](https://docs.nestjs.com/techniques/caching)
rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first.Stars: 194kUpdated Claude CodeCodexVerifiedInstall