refactor(pgpm): split dials sources into @pgpmjs/import and @pgpmjs/diff; move shared pipeline glue into @pgpmjs/transform

Author: pyramation

pgpm/cli/__tests__/diff-e2e.test.ts

@@ -9,8 +9,8 @@
  *
  * PREREQUISITES: a running PostgreSQL instance via standard PG* env vars.
  */
-import { diffCatalogSnapshots, loadDiffSideFromDisk, snapshotCatalog, withoutColumnOrder } from '@pgpmjs/export';
-import { diffChangeSets, loadModule } from '@pgpmjs/transform';
+import { loadDiffSideFromDisk } from '@pgpmjs/diff';
+import { diffCatalogSnapshots, diffChangeSets, loadModule, snapshotCatalog, withoutColumnOrder } from '@pgpmjs/transform';
 import * as fs from 'fs';
 import * as path from 'path';
 import { teardownPgPools } from 'pg-cache';

pgpm/cli/__tests__/import-e2e.test.ts

@@ -14,7 +14,8 @@
  *
  * PREREQUISITES: a running PostgreSQL instance via standard PG* env vars.
  */
-import { copyBlockToInsert, diffCatalogSnapshots, preprocessDumpText, snapshotCatalog } from '@pgpmjs/export';
+import { copyBlockToInsert, preprocessDumpText } from '@pgpmjs/import';
+import { diffCatalogSnapshots, snapshotCatalog } from '@pgpmjs/transform';
 import * as fs from 'fs';
 import * as path from 'path';
 import { teardownPgPools } from 'pg-cache';

pgpm/cli/__tests__/transform-e2e.test.ts

@@ -9,7 +9,7 @@
  *
  * PREREQUISITES: a running PostgreSQL instance via standard PG* env vars.
  */
-import { diffCatalogSnapshots, snapshotCatalog } from '@pgpmjs/export';
+import { diffCatalogSnapshots, snapshotCatalog } from '@pgpmjs/transform';
 import * as fs from 'fs';
 import * as path from 'path';
 import { teardownPgPools } from 'pg-cache';

pgpm/cli/package.json

@@ -47,8 +47,10 @@
   "dependencies": {
     "@inquirerer/utils": "^3.3.9",
     "@pgpmjs/core": "workspace:^",
+    "@pgpmjs/diff": "workspace:^",
     "@pgpmjs/env": "workspace:^",
     "@pgpmjs/export": "workspace:^",
+    "@pgpmjs/import": "workspace:^",
     "@pgpmjs/logger": "workspace:^",
     "@pgpmjs/slice": "workspace:^",
     "@pgpmjs/transform": "workspace:^",

pgpm/cli/src/commands/diff.ts

@@ -2,21 +2,25 @@ import { PgpmMigrate, PgpmRow, SqlWriteOptions, writePgpmFiles, writePgpmPlan }
 import {
   deltaChangesToRows,
   DiffSide,
+  loadDiffSideFromDisk,
+  sqlToDiffChanges
+} from '@pgpmjs/diff';
+import { Logger } from '@pgpmjs/logger';
+import {
   diffCatalogSnapshots,
+  diffChangeSets,
   EXPORT_GRANULARITIES,
   ExportGranularity,
   isExportGranularity,
-  loadDiffSideFromDisk,
-  resolveDiffSideKind,
+  loadModule,
+  SemanticDiffResult,
+  SemanticObjectDiff,
   snapshotCatalog,
-  sqlToDiffChanges,
   withoutColumnOrder
-} from '@pgpmjs/export';
-import { Logger } from '@pgpmjs/logger';
-import { diffChangeSets, loadModule, SemanticDiffResult, SemanticObjectDiff } from '@pgpmjs/transform';
+} from '@pgpmjs/transform';
 import { spawn } from 'child_process';
 import * as fs from 'fs';
-import { CLIOptions, cliExitWithError, extractFirst, Inquirerer, ParsedArgs } from 'inquirerer';
+import { cliExitWithError, CLIOptions, extractFirst, Inquirerer, ParsedArgs } from 'inquirerer';
 import * as os from 'os';
 import * as path from 'path';
 import { getPgPool } from 'pg-cache';

pgpm/cli/src/commands/export.ts

@@ -1,6 +1,7 @@
 import { PgpmPackage } from '@pgpmjs/core';
 import { getEnvOptions } from '@pgpmjs/env';
-import { EXPORT_GRANULARITIES, exportGraphQL, exportMigrations, GraphQLClient, graphqlRowToPostgresRow, isExportGranularity, parsePartitionConfig, PartitionConfig } from '@pgpmjs/export';
+import { exportGraphQL, exportMigrations, GraphQLClient, graphqlRowToPostgresRow } from '@pgpmjs/export';
+import { EXPORT_GRANULARITIES, isExportGranularity, parsePartitionConfig, PartitionConfig } from '@pgpmjs/transform';
 import { getGitConfigInfo } from '@pgpmjs/types';
 import { CLIOptions, Inquirerer } from 'inquirerer';
 import { resolve } from 'path';

pgpm/cli/src/commands/import.ts

@@ -1,17 +1,19 @@
 import {
   dumpCompatibilityWarnings,
+  importDumpRows,
+  linkTextualDeps,
+  loadDumpSource
+} from '@pgpmjs/import';
+import { Logger } from '@pgpmjs/logger';
+import {
   EXPORT_GRANULARITIES,
   ExportGranularity,
-  importDumpRows,
   isExportGranularity,
-  linkTextualDeps,
-  loadDumpSource,
   parsePartitionConfig,
   PartitionConfig,
+  PartitionCycleError,
   partitionExportRows
-} from '@pgpmjs/export';
-import { Logger } from '@pgpmjs/logger';
-import { PartitionCycleError } from '@pgpmjs/transform';
+} from '@pgpmjs/transform';
 import { cliExitWithError, CLIOptions, Inquirerer, ParsedArgs } from 'inquirerer';
 import * as path from 'path';
 

pgpm/cli/src/commands/transform.ts

@@ -1,4 +1,5 @@
 import { PgpmMigrate, PgpmPackage, PgpmRow } from '@pgpmjs/core';
+import { Logger } from '@pgpmjs/logger';
 import {
   diffCatalogSnapshots,
   EXPORT_GRANULARITIES,
@@ -7,13 +8,12 @@ import {
   loadModuleSource,
   parsePartitionConfig,
   PartitionConfig,
+  PartitionCycleError,
   PartitionedPackageRows,
   partitionExportRows,
   restructureExportRows,
   snapshotCatalog
-} from '@pgpmjs/export';
-import { Logger } from '@pgpmjs/logger';
-import { PartitionCycleError } from '@pgpmjs/transform';
+} from '@pgpmjs/transform';
 import * as fs from 'fs';
 import { cliExitWithError, CLIOptions, Inquirerer, ParsedArgs } from 'inquirerer';
 import * as path from 'path';

pgpm/diff/README.md

@@ -0,0 +1,7 @@
+# @pgpmjs/diff
+
+`pgpm diff` engine: identity-keyed semantic schema diff between any two SQL sources — pgpm modules, SQL dumps, or live databases (dumped via `pg_dump` by the CLI).
+
+Every side normalizes to the same `DiffInputChange[]` seam consumed by the semantic diff driver in `@pgpmjs/transform`, so the comparison is source- and dial-invariant. `deltaChangesToRows` lifts the resulting deltas back onto deployable `PgpmRow`s.
+
+Used by the `pgpm diff` CLI command (`pgpm/cli`). Sibling front doors: `@pgpmjs/export` (live database), `@pgpmjs/import` (dumps).

pgpm/export/__tests__/diff-source.test.ts pgpm/diff/__tests__/diff-source.test.tspgpm/export/__tests__/diff-source.test.ts renamed to pgpm/diff/__tests__/diff-source.test.ts

@@ -55,8 +55,8 @@ describe('stripDumpPreamble', () => {
       '-- PostgreSQL database dump',
       '--',
       '\\restrict abcdef',
-      "SET statement_timeout = 0;",
-      "SET lock_timeout = 0;",
+      'SET statement_timeout = 0;',
+      'SET lock_timeout = 0;',
       "SELECT pg_catalog.set_config('search_path', '', false);",
       "SET default_tablespace = '';",
       '\\connect mydb',