pantheon-ai/design-principles

Strategic architecture, tactical design, and testable code principles (SOLID, Clean Architecture, Design Patterns, Testable Design)

Quality

97%

Does it follow best practices?

Impact

Pending

No eval scenarios have been run

Securityby

Passed

No known issues

Resolve a Circular Dependency

Name: pantheon-ai/design-principles
Rating: 0.975 (1 reviews)
Author: pantheon-ai

Problem Description

A TypeScript monorepo has two modules with a circular import error:

src/modules/payments/payment-service.ts

import { NotificationService } from '../notifications/notification-service';

export class PaymentService {
  private notifier = new NotificationService();

  async processPayment(userId: string, amount: number): Promise<void> {
    // ... process payment
    await this.notifier.sendPaymentConfirmation(userId, amount);
  }
}

src/modules/notifications/notification-service.ts

import { PaymentService } from '../payments/payment-service';

export class NotificationService {
  private paymentService = new PaymentService();

  async sendPaymentConfirmation(userId: string, amount: number): Promise<void> {
    const history = await this.paymentService.getHistory(userId);
    // format and send notification with history
  }
}

The circular import is: PaymentService → NotificationService → PaymentService.

Produce:

A corrected module structure that eliminates the circular dependency (you can create new files as needed)
A REFACTOR.md explaining the root cause and the approach taken to break the cycle