d4ea931bf8
* feat(agents): add modular engineering rules from 2026 standards Add a rules directory with individual rule files derived from the Cal.com Engineering in 2026 and Beyond blog post. Rules are organized by section (architecture, quality, data, api, performance, testing, patterns, culture) following the Vercel agent-skills structure. Includes: - _sections.md defining rule categories and impact levels - _template.md for creating new rules - 14 individual rule files covering key engineering standards - README documenting the rules structure and usage Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> * feat(agents): consolidate DI and Repository+DTO docs into rules - Move di-pattern.md content to rules/patterns-di-pattern.md - Extract Repository + DTO section from knowledge-base.md into: - rules/data-repository-methods.md (method naming conventions) - rules/data-dto-boundaries.md (DTO location and naming) - Update knowledge-base.md to reference the new rule files - Delete old di-pattern.md file Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> * chore(agents): remove stub reference sections from knowledge-base.md The rules directory is self-contained with its own README, so these redirect sections are unnecessary clutter. Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> * refactor(agents): combine DI pattern rules into single file Merged patterns-di-pattern.md into patterns-dependency-injection.md to eliminate overlap and create one comprehensive DI guide. Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
2.9 KiB
2.9 KiB
title, impact, impactDescription, tags
| title | impact | impactDescription | tags |
|---|---|---|---|
| Use Factory Pattern to Push Conditionals to Entry Points | HIGH | Keeps services focused and prevents complexity accumulation | patterns, factory, conditionals, single-responsibility |
Use Factory Pattern to Push Conditionals to Entry Points
Impact: HIGH
If statements belong at the entry point, not scattered throughout your services. This is one of the most important architectural principles for maintaining clean, focused code that doesn't spiral into unmaintainable complexity.
The problem with scattered conditionals: A service is written for a clear, specific purpose. Then a new product requirement arrives, and someone adds an if statement. A few years later, that service is littered with conditional checks. The service becomes:
- Complicated and hard to read
- Difficult to understand and reason about
- More susceptible to bugs
- Violating single responsibility
- Nearly impossible to test thoroughly
Incorrect (conditionals scattered in service):
class BillingService {
async processPayment(entityId: number, entityType: string) {
if (entityType === "organization") {
// Organization-specific logic
const org = await this.getOrganization(entityId);
if (org.billingPlan === "enterprise") {
// More nested conditionals...
}
} else if (entityType === "team") {
// Team-specific logic
} else if (entityType === "user") {
// User-specific logic
}
}
}
Correct (Factory pattern with specialized services):
// Factory makes the decision at entry point
class BillingServiceFactory {
static async createService(entityId: number): Promise<BillingService> {
const entity = await determineEntityType(entityId);
switch (entity.type) {
case "organization":
return new OrganizationBillingService(entity);
case "team":
return new TeamBillingService(entity);
default:
return new UserBillingService(entity);
}
}
}
// Each service handles ONLY its specific logic - no conditionals
class OrganizationBillingService extends BillingService {
async processPayment() {
// Only organization logic here - clean and focused
}
}
class TeamBillingService extends BillingService {
async processPayment() {
// Only team logic here - clean and focused
}
}
Benefits:
- Services stay focused with one responsibility
- Changes are isolated to specific service implementations
- Testing is straightforward - test each service independently
- New requirements don't pollute existing code
Guidelines:
- Push conditionals up to controllers, factories, or routing logic
- Keep services pure and focused on a single responsibility
- Prefer polymorphism over conditionals
- Watch for if statement accumulation during code review
Reference: Cal.com Engineering Blog