@prisma-next/cli 0.12.0 → 0.13.0-dev.2

package/src/utils/formatters/migration-graph-tree-render.ts

@@ -1,459 +0,0 @@
-import { EMPTY_CONTRACT_HASH } from '@prisma-next/migration-tools/constants';
-import { bold } from 'colorette';
-import stringWidth from 'string-width';
-import type { GlyphMode } from '../glyph-mode';
-import type {
-  MigrationGraphGridModel,
-  MigrationGraphGridRow,
-  StructuralCell,
-} from './migration-graph-layout';
-import type { ClassifiedEdge } from './migration-graph-rows';
-import {
-  MIGRATION_LIST_HASH_WIDTH,
-  migrationListEmptySource,
-  migrationListForwardArrow,
-} from './migration-list-data-column';
-import type { MigrationEdgeKind } from './migration-list-graph-topology';
-import type { MigrationListStyler } from './migration-list-render';
-import { CONTRACT_MARKER_NAME, createAnsiMigrationListStyler } from './migration-list-styler';
-
-const LABEL_GAP = 2;
-
-/**
- * The live-database overlay marker. Just another ref as far as styling goes —
- * the only emphasized markers are the active ref and the `contract`
- * desired-state marker (see {@link CONTRACT_MARKER_NAME}).
- */
-const DB_MARKER_NAME = 'db';
-
-export interface RenderMigrationGraphTreeOptions {
-  readonly refsByHash?: ReadonlyMap<string, readonly string[]>;
-  readonly dbHash?: string;
-  readonly contractHash?: string;
-  readonly activeRefName?: string;
-  readonly hashLength?: number;
-  readonly colorize: boolean;
-  readonly glyphMode?: GlyphMode;
-}
-
-interface MigrationGraphTreeGlyphPalette {
-  readonly node: string;
-  readonly arcLand: string;
-  readonly arcTee: string;
-  readonly verticalPass: string;
-  readonly branchTee: string;
-  readonly mergeTee: string;
-  readonly branchCorner: string;
-  readonly mergeCorner: string;
-  readonly arcBranchCorner: string;
-  readonly arcBranchTee: string;
-  readonly arcLandCorner: string;
-  readonly arcCrossing: string;
-  readonly arcLandBridge: string;
-  readonly horizontalPass: string;
-  readonly connectorBranchTee: string;
-  readonly connectorBranchTeeCo: string;
-  readonly connectorMergeTeeCo: string;
-  readonly edgeArrow: Readonly<Record<MigrationEdgeKind, string>>;
-  readonly forwardArrow: string;
-  readonly emptySource: string;
-}
-
-const UNICODE_PALETTE: MigrationGraphTreeGlyphPalette = {
-  node: '○ ',
-  arcLand: '○◂',
-  arcTee: '○─',
-  verticalPass: '│ ',
-  branchTee: '├─',
-  mergeTee: '├─',
-  branchCorner: '╮ ',
-  mergeCorner: '╯ ',
-  arcBranchCorner: '╮ ',
-  arcBranchTee: '┬─',
-  arcLandCorner: '╯ ',
-  arcCrossing: '┼─',
-  arcLandBridge: '──',
-  horizontalPass: '──',
-  connectorBranchTee: '├─',
-  connectorBranchTeeCo: '┬─',
-  connectorMergeTeeCo: '┴─',
-  edgeArrow: { forward: '↑', rollback: '↓', self: '⟲' },
-  forwardArrow: migrationListForwardArrow('unicode'),
-  emptySource: migrationListEmptySource('unicode'),
-};
-
-const ASCII_PALETTE: MigrationGraphTreeGlyphPalette = {
-  node: '* ',
-  arcLand: '*<',
-  arcTee: '*-',
-  verticalPass: '| ',
-  branchTee: '+-',
-  mergeTee: '+-',
-  branchCorner: '\\ ',
-  mergeCorner: '/ ',
-  arcBranchCorner: '\\ ',
-  arcBranchTee: '+-',
-  arcLandCorner: '/ ',
-  arcCrossing: '+-',
-  arcLandBridge: '--',
-  horizontalPass: '--',
-  connectorBranchTee: '+-',
-  connectorBranchTeeCo: '+-',
-  connectorMergeTeeCo: '+-',
-  edgeArrow: { forward: '^', rollback: 'v', self: '@' },
-  forwardArrow: migrationListForwardArrow('ascii'),
-  emptySource: migrationListEmptySource('ascii'),
-};
-
-function paletteFor(mode: GlyphMode): MigrationGraphTreeGlyphPalette {
-  return mode === 'ascii' ? ASCII_PALETTE : UNICODE_PALETTE;
-}
-
-function arrowForEdgeKind(
-  kind: MigrationEdgeKind,
-  palette: MigrationGraphTreeGlyphPalette,
-): string {
-  return palette.edgeArrow[kind];
-}
-
-/**
- * A node-marker glyph pair (`○◂`, `○─`, `*<`, `*-`) is the contract node
- * marker (`○` / `*`) followed by an arc connector (`◂` / `─` / `<` / `-`).
- * The marker is the signal and stays bright (`style.kind`); the connector is
- * gutter and stays dim (`style.lane`) — consistent with the plain node marker,
- * which is never dimmed.
- */
-function renderNodeMarkerPair(pair: string, style: MigrationListStyler): string {
-  return style.kind(pair.slice(0, 1)) + style.lane(pair.slice(1));
-}
-
-function renderCellPair(
-  cell: StructuralCell,
-  style: MigrationListStyler,
-  palette: MigrationGraphTreeGlyphPalette,
-): string {
-  switch (cell.kind) {
-    case 'node':
-      if (cell.arcLand === true) return renderNodeMarkerPair(palette.arcLand, style);
-      if (cell.arcTee === true) return renderNodeMarkerPair(palette.arcTee, style);
-      return style.kind(palette.node);
-    case 'vertical-pass':
-      return style.lane(palette.verticalPass);
-    case 'edge-lane':
-      // The lane stays dim; the direction arrow (↑ / ↓ / ⟲) is the signal and
-      // stays bright, like the contract-node marker.
-      return cell.ownsLabel
-        ? style.lane(palette.verticalPass.trimEnd()) +
-            style.kind(arrowForEdgeKind(cell.edgeKind, palette))
-        : style.lane(palette.verticalPass);
-    case 'branch-tee':
-      return style.lane(palette.branchTee);
-    case 'merge-tee':
-      return style.lane(palette.mergeTee);
-    case 'branch-corner':
-      return style.lane(palette.branchCorner);
-    case 'merge-corner':
-      return style.lane(palette.mergeCorner);
-    case 'arc-branch-corner':
-      return style.lane(palette.arcBranchCorner);
-    case 'arc-branch-tee':
-      return style.lane(palette.arcBranchTee);
-    case 'arc-land-corner':
-      return style.lane(palette.arcLandCorner);
-    case 'arc-crossing':
-      return style.lane(palette.arcCrossing);
-    case 'arc-land-bridge':
-      return style.lane(palette.arcLandBridge);
-    case 'horizontal-pass':
-      return style.lane(palette.horizontalPass);
-    case 'empty':
-      return '  ';
-  }
-}
-
-function renderConnectorRow(
-  row: MigrationGraphGridRow,
-  gridWidth: number,
-  style: MigrationListStyler,
-  palette: MigrationGraphTreeGlyphPalette,
-): string {
-  const isMerge = row.kind === 'merge-connector';
-  if (row.cells.length > 0) {
-    let seenTee = false;
-    let out = '';
-    for (const cell of row.cells) {
-      switch (cell.kind) {
-        case 'branch-tee':
-          out += style.lane(seenTee ? palette.connectorBranchTeeCo : palette.connectorBranchTee);
-          seenTee = true;
-          break;
-        case 'merge-tee':
-          out += style.lane(seenTee ? palette.connectorMergeTeeCo : palette.connectorBranchTee);
-          seenTee = true;
-          break;
-        case 'branch-corner':
-          out += style.lane(palette.branchCorner);
-          break;
-        case 'merge-corner':
-          out += style.lane(palette.mergeCorner);
-          break;
-        case 'vertical-pass':
-          out += style.lane(palette.verticalPass);
-          break;
-        case 'horizontal-pass':
-          out += style.lane(palette.horizontalPass);
-          break;
-        default:
-          out += '  ';
-      }
-    }
-    // The cells array is sized to the grid width at emit time; a back-arc lane
-    // allocated by a later row can push the grid wider afterwards, so pad any
-    // trailing columns rather than dropping the lanes that pass through here.
-    for (let column = row.cells.length; column < gridWidth; column++) {
-      out += '  ';
-    }
-    return out;
-  }
-
-  const start = row.startLane ?? 0;
-  const end = row.endLane ?? start;
-  let out = '';
-  for (let column = 0; column < gridWidth; column++) {
-    if (column < start || column > end) out += '  ';
-    else if (column === start) out += style.lane(palette.connectorBranchTee);
-    else if (column === end)
-      out += style.lane(isMerge ? palette.mergeCorner : palette.branchCorner);
-    else out += style.lane(isMerge ? palette.connectorMergeTeeCo : palette.connectorBranchTeeCo);
-  }
-  return out;
-}
-
-function abbreviateHash(hash: string, hashLength: number, emptySource: string): string {
-  if (hash === EMPTY_CONTRACT_HASH) {
-    return emptySource;
-  }
-  const stripped = hash.startsWith('sha256:') ? hash.slice(7) : hash;
-  return stripped.slice(0, hashLength);
-}
-
-const MIN_HASH_DATA_COLUMN = 25;
-
-function overlayNamesForContract(
-  contractHash: string,
-  opts: RenderMigrationGraphTreeOptions,
-): readonly string[] {
-  const names: string[] = [];
-  const userRefs = opts.refsByHash?.get(contractHash);
-  if (userRefs) {
-    names.push(...[...userRefs].sort((a, b) => a.localeCompare(b)));
-  }
-  if (opts.dbHash === contractHash) {
-    names.push(DB_MARKER_NAME);
-  }
-  if (opts.contractHash === contractHash && contractHash !== EMPTY_CONTRACT_HASH) {
-    names.push(CONTRACT_MARKER_NAME);
-  }
-  return names;
-}
-
-function createTreeStyler(opts: RenderMigrationGraphTreeOptions): MigrationListStyler {
-  const base = createAnsiMigrationListStyler({ useColor: opts.colorize });
-  const activeRefName = opts.activeRefName;
-  if (!opts.colorize || activeRefName === undefined) {
-    return base;
-  }
-  return {
-    ...base,
-    refs: (names) => {
-      const styledNames = names.map((name) => (name === activeRefName ? bold(name) : name));
-      return base.refs(styledNames);
-    },
-  };
-}
-
-function formatEdgeHashColumn(
-  edge: ClassifiedEdge,
-  style: MigrationListStyler,
-  hashLength: number,
-  palette: MigrationGraphTreeGlyphPalette,
-): string {
-  if (edge.kind === 'self') {
-    const hash = abbreviateHash(edge.from, hashLength, palette.emptySource);
-    return `${style.sourceHash(hash)} ${style.glyph(palette.forwardArrow)} ${style.destHash(hash)}`;
-  }
-  const source =
-    edge.from === EMPTY_CONTRACT_HASH
-      ? style.glyph(palette.emptySource) +
-        ' '.repeat(Math.max(0, hashLength - palette.emptySource.length))
-      : style.sourceHash(abbreviateHash(edge.from, hashLength, palette.emptySource));
-  const arrow = style.glyph(palette.forwardArrow);
-  const dest = style.destHash(abbreviateHash(edge.to, hashLength, palette.emptySource));
-  return `${source} ${arrow} ${dest}`;
-}
-
-function padVisible(text: string, targetWidth: number): string {
-  const padding = Math.max(0, targetWidth - stringWidth(text));
-  return text + ' '.repeat(padding);
-}
-
-function gridWidthForModel(rows: readonly MigrationGraphGridRow[]): number {
-  return rows.reduce(
-    (max, row) =>
-      row.kind === 'node' || row.kind === 'edge' ? Math.max(max, row.cells.length) : max,
-    1,
-  );
-}
-
-function maxDirNameLength(edges: readonly ClassifiedEdge[]): number {
-  if (edges.length === 0) return 0;
-  return Math.max(...edges.map((edge) => edge.dirName.length));
-}
-
-function rowDirNameWidth(labelColumn: number, maxDirNameLen: number, dirNameGap: number): number {
-  return Math.max(maxDirNameLen + dirNameGap, MIN_HASH_DATA_COLUMN - labelColumn);
-}
-
-function gridUsesSkipRollbackArcs(rows: readonly MigrationGraphGridRow[]): boolean {
-  return rows.some((row) =>
-    row.cells.some(
-      (cell) => cell.kind === 'edge-lane' && cell.adjacency === 'node-skipping-rollback',
-    ),
-  );
-}
-
-function edgeLabelColumn(row: MigrationGraphGridRow, wideLabelColumn: number | undefined): number {
-  if (wideLabelColumn !== undefined) {
-    return wideLabelColumn;
-  }
-  const laneIndex = row.laneIndex ?? 0;
-  if (row.edge?.from === EMPTY_CONTRACT_HASH && laneIndex === 0) {
-    return (laneIndex + 1) * 2 + LABEL_GAP;
-  }
-  const usesFullRowGutter = row.cells.some(
-    (cell, index) => index > laneIndex && cell.kind === 'vertical-pass',
-  );
-  return usesFullRowGutter ? row.cells.length * 2 + LABEL_GAP : (laneIndex + 1) * 2 + LABEL_GAP;
-}
-
-function nodeHasArcDecoration(row: MigrationGraphGridRow): boolean {
-  return row.cells.some(
-    (cell) => cell.kind === 'node' && (cell.arcTee === true || cell.arcLand === true),
-  );
-}
-
-export function renderMigrationGraphTree(
-  model: MigrationGraphGridModel,
-  opts: RenderMigrationGraphTreeOptions,
-): string {
-  const glyphMode = opts.glyphMode ?? 'unicode';
-  const palette = paletteFor(glyphMode);
-  const style = createTreeStyler(opts);
-  const hashLength = opts.hashLength ?? MIGRATION_LIST_HASH_WIDTH;
-  const gridWidth = gridWidthForModel(model.rows);
-  const wideLabelColumn = gridUsesSkipRollbackArcs(model.rows) ? gridWidth * 2 + 4 : undefined;
-  const dirNameGap = wideLabelColumn !== undefined ? 3 : LABEL_GAP;
-  const allEdges = model.rows
-    .filter(
-      (row): row is MigrationGraphGridRow & { edge: ClassifiedEdge } =>
-        row.kind === 'edge' && row.edge !== undefined,
-    )
-    .map((row) => row.edge);
-  const maxDirNameLen = maxDirNameLength(allEdges);
-
-  const lines: string[] = [];
-
-  for (let rowIndex = 0; rowIndex < model.rows.length; rowIndex++) {
-    const row = model.rows[rowIndex];
-    if (row === undefined) continue;
-
-    if (row.kind === 'component-separator') {
-      lines.push('');
-      continue;
-    }
-
-    if (row.kind === 'branch-connector' || row.kind === 'merge-connector') {
-      lines.push(renderConnectorRow(row, gridWidth, style, palette).replace(/\s+$/, ''));
-      continue;
-    }
-
-    let gutter = row.cells.map((cell) => renderCellPair(cell, style, palette)).join('');
-    const prevRow = model.rows[rowIndex - 1];
-    let laneSpan = row.cells.length;
-    if (row.kind === 'node') {
-      const contractHash = row.contractHash ?? EMPTY_CONTRACT_HASH;
-      if (prevRow?.kind === 'merge-connector' || contractHash === EMPTY_CONTRACT_HASH) {
-        laneSpan = 1;
-      } else {
-        laneSpan = row.cells.length;
-      }
-    }
-    const labelColumn =
-      row.kind === 'edge'
-        ? edgeLabelColumn(row, wideLabelColumn)
-        : wideLabelColumn !== undefined &&
-            (nodeHasArcDecoration(row) || row.contractHash !== undefined)
-          ? wideLabelColumn
-          : laneSpan * 2 + LABEL_GAP;
-    if (
-      row.kind === 'edge' &&
-      row.edge?.from === EMPTY_CONTRACT_HASH &&
-      (row.laneIndex ?? 0) === 0
-    ) {
-      gutter = row.cells
-        .slice(0, 1)
-        .map((cell) => renderCellPair(cell, style, palette))
-        .join('');
-    } else if (row.kind === 'node' && laneSpan < row.cells.length && !nodeHasArcDecoration(row)) {
-      gutter = row.cells
-        .slice(0, laneSpan)
-        .map((cell) => renderCellPair(cell, style, palette))
-        .join('');
-    } else if (gutter.length < laneSpan * 2) {
-      gutter = gutter.padEnd(laneSpan * 2, ' ');
-    }
-    const dirNameWidth = rowDirNameWidth(labelColumn, maxDirNameLen, dirNameGap);
-    const dataColumn = labelColumn + dirNameWidth;
-    const gutterPad = padVisible(gutter, labelColumn);
-
-    if (row.kind === 'node') {
-      const contractHash = row.contractHash ?? EMPTY_CONTRACT_HASH;
-      if (contractHash === EMPTY_CONTRACT_HASH) {
-        const trailingLanes = row.cells
-          .slice(1)
-          .map((cell) => renderCellPair(cell, style, palette))
-          .join('');
-        const emptyGutter = palette.emptySource.padEnd(2, ' ') + trailingLanes;
-        const overlayNames = overlayNamesForContract(contractHash, opts);
-        if (overlayNames.length === 0) {
-          lines.push(emptyGutter.replace(/\s+$/, ''));
-          continue;
-        }
-        const overlay = style.refs(overlayNames);
-        lines.push(`${padVisible(emptyGutter, dataColumn)}${overlay}`.replace(/\s+$/, ''));
-        continue;
-      }
-      const hashText = style.sourceHash(
-        abbreviateHash(contractHash, hashLength, palette.emptySource),
-      );
-      const overlayNames = overlayNamesForContract(contractHash, opts);
-      const overlayPad =
-        overlayNames.length > 0
-          ? ' '.repeat(Math.max(0, dataColumn - labelColumn - stringWidth(hashText)))
-          : '';
-      const overlay = overlayNames.length > 0 ? style.refs(overlayNames) : '';
-      lines.push(`${gutterPad}${hashText}${overlayPad}${overlay}`.replace(/\s+$/, ''));
-      continue;
-    }
-
-    const edge = row.edge;
-    if (edge === undefined) continue;
-
-    const dirNamePadding = ' '.repeat(Math.max(0, dirNameWidth - edge.dirName.length));
-    const dirName = `${style.dirName(edge.dirName)}${dirNamePadding}`;
-    const hashColumn = formatEdgeHashColumn(edge, style, hashLength, palette);
-    lines.push(`${gutterPad}${dirName}${hashColumn}`.replace(/\s+$/, ''));
-  }
-
-  return lines.join('\n');
-}