Decouple legacy migration service

2026-07-26 12:11:05 +02:00
parent c1be85e408
commit 859fa4a42a
9 changed files with 335 additions and 71 deletions
@@ -1,38 +1,17 @@
 import crypto from "node:crypto";
 import { eq, inArray, isNull } from "drizzle-orm";
+import type {
+  LegacyMigrationCircuitInput,
+  LegacyMigrationReportInput,
+} from "../../domain/ports/legacy-consumer-migration.store.js";
 import type { AppDatabase } from "../database-context.js";
 import { circuitDeviceRows } from "../schema/circuit-device-rows.js";
 import { circuits } from "../schema/circuits.js";
 import { consumers } from "../schema/consumers.js";
 import { legacyConsumerCircuitMigrations } from "../schema/legacy-consumer-circuit-migrations.js";
 import { legacyConsumerMigrationReports } from "../schema/legacy-consumer-migration-report.js";
-import {
-  toCircuitDeviceRowCreateValues,
-  type CircuitDeviceRowCreateInput,
-} from "./circuit-device-row.persistence.js";
-import {
-  toCircuitCreateValues,
-  type CircuitCreatePersistenceInput,
-} from "./circuit.persistence.js";
-
-export interface LegacyMigrationCircuitPersistenceInput {
-  circuit: CircuitCreatePersistenceInput;
-  deviceRows: Array<
-    Omit<CircuitDeviceRowCreateInput, "circuitId"> & { legacyConsumerId: string }
-  >;
-}
-
-export interface LegacyMigrationReportPersistenceInput {
-  legacyConsumerCount: number;
-  createdCircuitCount: number;
-  createdDeviceRowCount: number;
-  duplicateGroupedCount: number;
-  generatedIdentifierCount: number;
-  unassignedRowCount: number;
-  warningsJson: string;
-  generatedIdentifiersJson: string;
-  duplicateGroupsJson: string;
-}
+import { toCircuitDeviceRowCreateValues } from "./circuit-device-row.persistence.js";
+import { toCircuitCreateValues } from "./circuit.persistence.js";

 export class LegacyConsumerMigrationRepository {
  constructor(private readonly database: AppDatabase) {}
@@ -69,8 +48,8 @@ export class LegacyConsumerMigrationRepository {

  persistCircuitListMigration(input: {
    circuitListId: string;
-    circuits: LegacyMigrationCircuitPersistenceInput[];
-    report: LegacyMigrationReportPersistenceInput;
+    circuits: LegacyMigrationCircuitInput[];
+    report: LegacyMigrationReportInput;
  }) {
    if (input.circuits.some((entry) => entry.circuit.circuitListId !== input.circuitListId)) {
      throw new Error("All migrated circuits must belong to the target circuit list.");
@@ -0,0 +1,143 @@
+export interface LegacyConsumerMigrationCircuitListReader {
+  findById(
+    projectId: string,
+    circuitListId: string
+  ): Promise<{ id: string } | null>;
+}
+
+export interface LegacyConsumerMigrationSection {
+  id: string;
+  key: string;
+  prefix: string;
+}
+
+export interface LegacyConsumerMigrationSectionStore {
+  createDefaults(circuitListId: string): Promise<void>;
+  listByCircuitList(
+    circuitListId: string
+  ): Promise<LegacyConsumerMigrationSection[]>;
+}
+
+export interface LegacyConsumerMigrationCircuitReader {
+  listByCircuitList(circuitListId: string): Promise<
+    Array<{
+      sectionId: string;
+      equipmentIdentifier: string;
+      sortOrder: number;
+    }>
+  >;
+}
+
+export interface LegacyConsumerMigrationRoomReader {
+  listByProject(projectId: string): Promise<
+    Array<{
+      id: string;
+      roomNumber: string;
+      roomName: string;
+    }>
+  >;
+}
+
+export interface LegacyConsumerSource {
+  id: string;
+  projectDeviceId: string | null;
+  roomId: string | null;
+  circuitNumber: string | null;
+  description: string | null;
+  name: string;
+  category: string | null;
+  deviceType: string | null;
+  phaseType: string | null;
+  tradeOrCostGroup: string | null;
+  protectionType: string | null;
+  protectionRatedCurrent: number | null;
+  protectionCharacteristic: string | null;
+  cableType: string | null;
+  cableCrossSection: string | null;
+  comment: string | null;
+  quantity: number;
+  installedPowerPerUnitKw: number;
+  demandFactor: number;
+  voltageV: number | null;
+  phaseCount: number | null;
+  powerFactor: number | null;
+  note: string | null;
+}
+
+export interface LegacyMigrationDeviceRowInput {
+  linkedProjectDeviceId?: string;
+  legacyConsumerId: string;
+  sortOrder: number;
+  name: string;
+  displayName: string;
+  phaseType?: string;
+  connectionKind?: string;
+  costGroup?: string;
+  category?: string;
+  level?: string;
+  roomId?: string;
+  roomNumberSnapshot?: string;
+  roomNameSnapshot?: string;
+  quantity: number;
+  powerPerUnit: number;
+  simultaneityFactor: number;
+  cosPhi?: number;
+  remark?: string;
+  overriddenFields?: string;
+}
+
+export interface LegacyMigrationCircuitInput {
+  circuit: {
+    circuitListId: string;
+    sectionId: string;
+    equipmentIdentifier: string;
+    displayName?: string;
+    sortOrder: number;
+    protectionType?: string;
+    protectionRatedCurrent?: number;
+    protectionCharacteristic?: string;
+    cableType?: string;
+    cableCrossSection?: string;
+    cableLength?: number;
+    voltage?: number;
+    controlRequirement?: string;
+    remark?: string;
+    rcdAssignment?: string;
+    terminalDesignation?: string;
+    status?: string;
+    isReserve?: boolean;
+  };
+  deviceRows: LegacyMigrationDeviceRowInput[];
+}
+
+export interface LegacyMigrationReportInput {
+  legacyConsumerCount: number;
+  createdCircuitCount: number;
+  createdDeviceRowCount: number;
+  duplicateGroupedCount: number;
+  generatedIdentifierCount: number;
+  unassignedRowCount: number;
+  warningsJson: string;
+  generatedIdentifiersJson: string;
+  duplicateGroupsJson: string;
+}
+
+export interface LegacyConsumerMigrationStore {
+  listSourceConsumersByCircuitList(
+    circuitListId: string
+  ): Promise<LegacyConsumerSource[]>;
+  listMigratedConsumerIds(circuitListId: string): Promise<string[]>;
+  persistCircuitListMigration(input: {
+    circuitListId: string;
+    circuits: LegacyMigrationCircuitInput[];
+    report: LegacyMigrationReportInput;
+  }): void;
+}
+
+export interface LegacyConsumerMigrationDependencies {
+  circuitListReader: LegacyConsumerMigrationCircuitListReader;
+  sectionStore: LegacyConsumerMigrationSectionStore;
+  circuitReader: LegacyConsumerMigrationCircuitReader;
+  roomReader: LegacyConsumerMigrationRoomReader;
+  migrationStore: LegacyConsumerMigrationStore;
+}
@@ -1,25 +1,19 @@
-import { CircuitRepository } from "../../db/repositories/circuit.repository.js";
-import { CircuitListRepository } from "../../db/repositories/circuit-list.repository.js";
-import { CircuitSectionRepository } from "../../db/repositories/circuit-section.repository.js";
-import {
-  LegacyConsumerMigrationRepository,
-  type LegacyMigrationCircuitPersistenceInput,
-} from "../../db/repositories/legacy-consumer-migration.repository.js";
-import { RoomRepository } from "../../db/repositories/room.repository.js";
 import type { LegacyMigrationReport } from "../models/circuit-tree.model.js";
+import type {
+  LegacyConsumerMigrationDependencies,
+  LegacyConsumerSource,
+  LegacyMigrationCircuitInput,
+} from "../ports/legacy-consumer-migration.store.js";
 import {
  inferSectionKeyFromEquipmentIdentifier,
  inferSectionKeyFromLegacyInput,
  normalizeCircuitNumber,
 } from "./legacy-consumer-migration-planner.js";

-type LegacyConsumerRow = Awaited<
-  ReturnType<
-    LegacyConsumerMigrationRepository["listSourceConsumersByCircuitList"]
-  >
->[number];
-
-function parseEquipmentSequence(equipmentIdentifier: string, prefix: string): number | null {
+function parseEquipmentSequence(
+  equipmentIdentifier: string,
+  prefix: string
+): number | null {
  if (!equipmentIdentifier.startsWith(prefix)) {
    return null;
  }
@@ -30,43 +24,45 @@ function parseEquipmentSequence(equipmentIdentifier: string, prefix: string): nu
  return Number(suffix);
 }

-
 export class LegacyConsumerMigrationService {
-  private readonly circuitListRepository = new CircuitListRepository();
-  private readonly sectionRepository = new CircuitSectionRepository();
-  private readonly circuitRepository = new CircuitRepository();
-  private readonly roomRepository = new RoomRepository();
-
  constructor(
-    private readonly migrationRepository: LegacyConsumerMigrationRepository
+    private readonly dependencies: LegacyConsumerMigrationDependencies
  ) {}

-  async migrateCircuitList(projectId: string, circuitListId: string): Promise<LegacyMigrationReport> {
+  async migrateCircuitList(
+    projectId: string,
+    circuitListId: string
+  ): Promise<LegacyMigrationReport> {
    // Migration is additive: legacy consumers are preserved, and circuit-first entities are created
    // with mapping records so transition remains auditable and reversible.
-    const list = await this.circuitListRepository.findById(projectId, circuitListId);
+    const list = await this.dependencies.circuitListReader.findById(
+      projectId,
+      circuitListId
+    );
    if (!list) {
      throw new Error("Circuit list not found in project.");
    }

-    await this.sectionRepository.createDefaults(circuitListId);
-    const sections = await this.sectionRepository.listByCircuitList(circuitListId);
+    await this.dependencies.sectionStore.createDefaults(circuitListId);
+    const sections =
+      await this.dependencies.sectionStore.listByCircuitList(circuitListId);
    const sectionByKey = new Map(sections.map((section) => [section.key, section]));
    const unassignedSection = sectionByKey.get("unassigned");
    if (!unassignedSection) {
      throw new Error("Unassigned section is required.");
    }

-    const existingCircuits = await this.circuitRepository.listByCircuitList(circuitListId);
+    const existingCircuits =
+      await this.dependencies.circuitReader.listByCircuitList(circuitListId);
    const usedEquipmentIdentifiers = new Set(
      existingCircuits.map((circuit) => circuit.equipmentIdentifier.toUpperCase())
    );

    const legacyConsumers =
-      await this.migrationRepository.listSourceConsumersByCircuitList(
+      await this.dependencies.migrationStore.listSourceConsumersByCircuitList(
        circuitListId
      );
-    const rooms = await this.roomRepository.listByProject(projectId);
+    const rooms = await this.dependencies.roomReader.listByProject(projectId);
    const roomById = new Map(rooms.map((room) => [room.id, room]));

    const report: LegacyMigrationReport = {
@@ -82,14 +78,16 @@ export class LegacyConsumerMigrationService {

    // Idempotency guard: skip consumers already mapped in previous migration run.
    const migratedConsumerIds = new Set(
-      await this.migrationRepository.listMigratedConsumerIds(circuitListId)
+      await this.dependencies.migrationStore.listMigratedConsumerIds(
+        circuitListId
+      )
    );
    const consumersToMigrate = legacyConsumers.filter((consumer) => !migratedConsumerIds.has(consumer.id));

    // Legacy rows are grouped by normalized circuit number so duplicates become
    // multiple device rows within one circuit instead of duplicate circuits.
-    const byNormalizedCircuitNumber = new Map<string, LegacyConsumerRow[]>();
-    const withoutNormalizedCircuitNumber: LegacyConsumerRow[] = [];
+    const byNormalizedCircuitNumber = new Map<string, LegacyConsumerSource[]>();
+    const withoutNormalizedCircuitNumber: LegacyConsumerSource[] = [];
    for (const consumer of consumersToMigrate) {
      const normalized = normalizeCircuitNumber(consumer.circuitNumber ?? null);
      if (!normalized) {
@@ -110,7 +108,7 @@ export class LegacyConsumerMigrationService {

    const groups: Array<{
      equipmentIdentifier: string | null;
-      consumers: LegacyConsumerRow[];
+      consumers: LegacyConsumerSource[];
      inferredSectionKey: string | null;
      isGeneratedIdentifier: boolean;
    }> = [];
@@ -152,7 +150,7 @@ export class LegacyConsumerMigrationService {
      maxBySectionPrefix.set(section.prefix.toUpperCase(), Math.max(current, sequence));
    }

-    const migrationCircuits: LegacyMigrationCircuitPersistenceInput[] = [];
+    const migrationCircuits: LegacyMigrationCircuitInput[] = [];
    for (const group of groups) {
      const representative = group.consumers[0];
      let section = group.inferredSectionKey ? sectionByKey.get(group.inferredSectionKey) : null;
@@ -181,7 +179,7 @@ export class LegacyConsumerMigrationService {

      usedEquipmentIdentifiers.add(equipmentIdentifier.toUpperCase());

-      const deviceRows: LegacyMigrationCircuitPersistenceInput["deviceRows"] = [];
+      const deviceRows: LegacyMigrationCircuitInput["deviceRows"] = [];
      const circuitSortOrder = nextSortOrder;
      nextSortOrder += 10;

@@ -250,7 +248,7 @@ export class LegacyConsumerMigrationService {
      report.warnings.push(`Consumer ${row.consumerId} was migrated into unassigned section.`);
    }

-    this.migrationRepository.persistCircuitListMigration({
+    this.dependencies.migrationStore.persistCircuitListMigration({
      circuitListId,
      circuits: migrationCircuits,
      report: {