@prisma-next/cli 0.3.0-dev.15 → 0.3.0-dev.162

package/src/commands/db-schema.ts

@@ -0,0 +1,77 @@
+import type { IntrospectSchemaResult } from '@prisma-next/framework-components/control';
+import { Command } from 'commander';
+import {
+  addGlobalOptions,
+  setCommandDescriptions,
+  setCommandExamples,
+} from '../utils/command-helpers';
+import { formatIntrospectJson, formatIntrospectOutput } from '../utils/formatters/verify';
+import { parseGlobalFlags } from '../utils/global-flags';
+import { handleResult } from '../utils/result-handler';
+import { TerminalUI } from '../utils/terminal-ui';
+import {
+  type InspectLiveSchemaOptions,
+  type InspectLiveSchemaResult,
+  inspectLiveSchema,
+} from './inspect-live-schema';
+
+function toIntrospectSchemaResult(
+  result: InspectLiveSchemaResult,
+): IntrospectSchemaResult<unknown> {
+  return {
+    ok: true,
+    summary: 'Schema read successfully',
+    target: result.target,
+    schema: result.schema,
+    meta: result.meta,
+    timings: result.timings,
+  };
+}
+
+export function createDbSchemaCommand(): Command {
+  const command = new Command('schema');
+  setCommandDescriptions(
+    command,
+    'Inspect the live database schema',
+    'Reads the live database schema and prints it as a tree by default or as JSON with\n' +
+      '--json. This command is always read-only and never writes files. To save machine-\n' +
+      'readable output, use shell redirection, for example `prisma-next db schema --json > schema.json`.',
+  );
+  setCommandExamples(command, [
+    'prisma-next db schema --db $DATABASE_URL',
+    'prisma-next db schema --db $DATABASE_URL --json',
+    'prisma-next db schema --db $DATABASE_URL --json > schema.json',
+  ]);
+  addGlobalOptions(command)
+    .option('--db <url>', 'Database connection string')
+    .option('--config <path>', 'Path to prisma-next.config.ts')
+    .action(async (options: InspectLiveSchemaOptions) => {
+      const flags = parseGlobalFlags(options);
+      const ui = new TerminalUI({ color: flags.color, interactive: flags.interactive });
+      const startTime = Date.now();
+
+      const result = await inspectLiveSchema(options, flags, ui, startTime, {
+        commandName: 'db schema',
+        description: 'Inspect the live database schema',
+        url: 'https://pris.ly/db-schema',
+      });
+
+      const exitCode = handleResult(result, flags, ui, (value) => {
+        const introspectResult = toIntrospectSchemaResult(value);
+
+        if (flags.json) {
+          ui.output(formatIntrospectJson(introspectResult));
+          return;
+        }
+
+        const output = formatIntrospectOutput(introspectResult, value.schemaView, flags);
+        if (output) {
+          ui.log(output);
+        }
+      });
+
+      process.exit(exitCode);
+    });
+
+  return command;
+}

package/src/commands/db-sign.ts

@@ -1,50 +1,196 @@
 import { readFile } from 'node:fs/promises';
-import { relative, resolve } from 'node:path';
-import {
-  errorDatabaseConnectionRequired,
-  errorDriverRequired,
-  errorFileNotFound,
-  errorRuntime,
-  errorUnexpected,
-} from '@prisma-next/core-control-plane/errors';
 import type {
   SignDatabaseResult,
   VerifyDatabaseSchemaResult,
-} from '@prisma-next/core-control-plane/types';
-import { createControlPlaneStack } from '@prisma-next/core-control-plane/types';
+} from '@prisma-next/framework-components/control';
+import { notOk, ok, type Result } from '@prisma-next/utils/result';
 import { Command } from 'commander';
+import { relative, resolve } from 'pathe';
 import { loadConfig } from '../config-loader';
-import { performAction } from '../utils/action';
-import { setCommandDescriptions } from '../utils/command-helpers';
+import { createControlClient } from '../control-api/client';
+import { ContractValidationError } from '../control-api/errors';
+import {
+  CliStructuredError,
+  errorContractValidationFailed,
+  errorDatabaseConnectionRequired,
+  errorDriverRequired,
+  errorFileNotFound,
+  errorUnexpected,
+} from '../utils/cli-errors';
 import {
-  assertContractRequirementsSatisfied,
-  assertFrameworkComponentsCompatible,
-} from '../utils/framework-components';
-import { parseGlobalFlags } from '../utils/global-flags';
+  addGlobalOptions,
+  maskConnectionUrl,
+  resolveContractPath,
+  setCommandDescriptions,
+  setCommandExamples,
+} from '../utils/command-helpers';
+import { formatStyledHeader } from '../utils/formatters/styled';
 import {
-  formatCommandHelp,
   formatSchemaVerifyJson,
   formatSchemaVerifyOutput,
   formatSignJson,
   formatSignOutput,
-  formatStyledHeader,
-} from '../utils/output';
+} from '../utils/formatters/verify';
+import type { CommonCommandOptions } from '../utils/global-flags';
+import { type GlobalFlags, parseGlobalFlags } from '../utils/global-flags';
+import { createProgressAdapter } from '../utils/progress-adapter';
 import { handleResult } from '../utils/result-handler';
-import { withSpinner } from '../utils/spinner';
+import { TerminalUI } from '../utils/terminal-ui';
 
-interface DbSignOptions {
+interface DbSignOptions extends CommonCommandOptions {
   readonly db?: string;
   readonly config?: string;
-  readonly json?: string | boolean;
-  readonly quiet?: boolean;
-  readonly q?: boolean;
-  readonly verbose?: boolean;
-  readonly v?: boolean;
-  readonly vv?: boolean;
-  readonly trace?: boolean;
-  readonly timestamps?: boolean;
-  readonly color?: boolean;
-  readonly 'no-color'?: boolean;
+}
+
+/**
+ * Failure type for db sign command.
+ * Either an infrastructure error (CliStructuredError) or a logical failure (schema verification failed).
+ */
+type DbSignFailure = CliStructuredError | VerifyDatabaseSchemaResult;
+
+/**
+ * Executes the db sign command and returns a structured Result.
+ * Success: SignDatabaseResult (sign happened)
+ * Failure: CliStructuredError (infra error) or VerifyDatabaseSchemaResult (schema mismatch)
+ */
+async function executeDbSignCommand(
+  options: DbSignOptions,
+  flags: GlobalFlags,
+  ui: TerminalUI,
+): Promise<Result<SignDatabaseResult, DbSignFailure>> {
+  // Load config
+  const config = await loadConfig(options.config);
+  const configPath = options.config
+    ? relative(process.cwd(), resolve(options.config))
+    : 'prisma-next.config.ts';
+  const contractPathAbsolute = resolveContractPath(config);
+  const contractPath = relative(process.cwd(), contractPathAbsolute);
+
+  // Output header
+  if (!flags.json && !flags.quiet) {
+    const details: Array<{ label: string; value: string }> = [
+      { label: 'config', value: configPath },
+      { label: 'contract', value: contractPath },
+    ];
+    if (options.db) {
+      details.push({ label: 'database', value: maskConnectionUrl(options.db) });
+    }
+    const header = formatStyledHeader({
+      command: 'db sign',
+      description: 'Sign the database with your contract so you can safely run queries',
+      url: 'https://pris.ly/db-sign',
+      details,
+      flags,
+    });
+    ui.stderr(header);
+  }
+
+  // Load contract file
+  let contractJsonContent: string;
+  try {
+    contractJsonContent = await readFile(contractPathAbsolute, 'utf-8');
+  } catch (error) {
+    if (error instanceof Error && (error as { code?: string }).code === 'ENOENT') {
+      return notOk(
+        errorFileNotFound(contractPathAbsolute, {
+          why: `Contract file not found at ${contractPathAbsolute}`,
+          fix: `Run \`prisma-next contract emit\` to generate ${contractPath}, or update \`config.contract.output\` in ${configPath}`,
+        }),
+      );
+    }
+    return notOk(
+      errorUnexpected(error instanceof Error ? error.message : String(error), {
+        why: `Failed to read contract file: ${error instanceof Error ? error.message : String(error)}`,
+      }),
+    );
+  }
+
+  let contractJson: Record<string, unknown>;
+  try {
+    contractJson = JSON.parse(contractJsonContent) as Record<string, unknown>;
+  } catch (error) {
+    return notOk(
+      errorContractValidationFailed(
+        `Contract JSON is invalid: ${error instanceof Error ? error.message : String(error)}`,
+        { where: { path: contractPathAbsolute } },
+      ),
+    );
+  }
+
+  // Resolve database connection (--db flag or config.db.connection)
+  const dbConnection = options.db ?? config.db?.connection;
+  if (!dbConnection) {
+    return notOk(
+      errorDatabaseConnectionRequired({
+        why: `Database connection is required for db sign (set db.connection in ${configPath}, or pass --db <url>)`,
+        commandName: 'db sign',
+      }),
+    );
+  }
+
+  // Check for driver
+  if (!config.driver) {
+    return notOk(errorDriverRequired({ why: 'Config.driver is required for db sign' }));
+  }
+
+  // Create control client
+  const client = createControlClient({
+    family: config.family,
+    target: config.target,
+    adapter: config.adapter,
+    driver: config.driver,
+    extensionPacks: config.extensionPacks ?? [],
+  });
+
+  // Create progress adapter
+  const onProgress = createProgressAdapter({ ui, flags });
+
+  try {
+    // Step 1: Schema verification - connect here
+    const schemaVerifyResult = await client.schemaVerify({
+      contract: contractJson,
+      strict: false,
+      connection: dbConnection,
+      onProgress,
+    });
+
+    // If schema verification failed, return as failure
+    if (!schemaVerifyResult.ok) {
+      return notOk(schemaVerifyResult);
+    }
+
+    // Step 2: Sign (already connected from schemaVerify)
+    const signResult = await client.sign({
+      contract: contractJson,
+      contractPath,
+      configPath,
+      onProgress,
+    });
+
+    return ok(signResult);
+  } catch (error) {
+    // Driver already throws CliStructuredError for connection failures
+    if (error instanceof CliStructuredError) {
+      return notOk(error);
+    }
+
+    if (error instanceof ContractValidationError) {
+      return notOk(
+        errorContractValidationFailed(`Contract validation failed: ${error.message}`, {
+          where: { path: contractPathAbsolute },
+        }),
+      );
+    }
+
+    // Wrap unexpected errors
+    return notOk(
+      errorUnexpected(error instanceof Error ? error.message : String(error), {
+        why: `Unexpected error during db sign: ${error instanceof Error ? error.message : String(error)}`,
+      }),
+    );
+  } finally {
+    await client.close();
+  }
 }
 
 export function createDbSignCommand(): Command {
@@ -53,220 +199,53 @@ export function createDbSignCommand(): Command {
     command,
     'Sign the database with your contract so you can safely run queries',
     'Verifies that your database schema satisfies the emitted contract, and if so, writes or\n' +
-      'updates the contract marker in the database. This command is idempotent and safe to run\n' +
-      'in CI/deployment pipelines. The marker records that this database instance is aligned\n' +
+      'updates the database signature. This command is idempotent and safe to run\n' +
+      'in CI/deployment pipelines. The signature records that this database instance is aligned\n' +
       'with a specific contract version.',
   );
-  command
-    .configureHelp({
-      formatHelp: (cmd) => {
-        const flags = parseGlobalFlags({});
-        return formatCommandHelp({ command: cmd, flags });
-      },
-    })
+  setCommandExamples(command, ['prisma-next db sign --db $DATABASE_URL']);
+  addGlobalOptions(command)
     .option('--db <url>', 'Database connection string')
     .option('--config <path>', 'Path to prisma-next.config.ts')
-    .option('--json [format]', 'Output as JSON (object or ndjson)', false)
-    .option('-q, --quiet', 'Quiet mode: errors only')
-    .option('-v, --verbose', 'Verbose output: debug info, timings')
-    .option('-vv, --trace', 'Trace output: deep internals, stack traces')
-    .option('--timestamps', 'Add timestamps to output')
-    .option('--color', 'Force color output')
-    .option('--no-color', 'Disable color output')
     .action(async (options: DbSignOptions) => {
       const flags = parseGlobalFlags(options);
 
-      const result = await performAction(async () => {
-        // Load config (file I/O)
-        const config = await loadConfig(options.config);
-        // Normalize config path for display (match contract path format - no ./ prefix)
-        const configPath = options.config
-          ? relative(process.cwd(), resolve(options.config))
-          : 'prisma-next.config.ts';
-        const contractPathAbsolute = config.contract?.output
-          ? resolve(config.contract.output)
-          : resolve('src/prisma/contract.json');
-        // Convert to relative path for display
-        const contractPath = relative(process.cwd(), contractPathAbsolute);
-
-        // Output header (only for human-readable output)
-        if (flags.json !== 'object' && !flags.quiet) {
-          const details: Array<{ label: string; value: string }> = [
-            { label: 'config', value: configPath },
-            { label: 'contract', value: contractPath },
-          ];
-          if (options.db) {
-            details.push({ label: 'database', value: options.db });
-          }
-          const header = formatStyledHeader({
-            command: 'db sign',
-            description: 'Sign the database with your contract so you can safely run queries',
-            url: 'https://pris.ly/db-sign',
-            details,
-            flags,
-          });
-          console.log(header);
-        }
-
-        // Load contract file (file I/O)
-        let contractJsonContent: string;
-        try {
-          contractJsonContent = await readFile(contractPathAbsolute, 'utf-8');
-        } catch (error) {
-          if (error instanceof Error && (error as { code?: string }).code === 'ENOENT') {
-            throw errorFileNotFound(contractPathAbsolute, {
-              why: `Contract file not found at ${contractPathAbsolute}`,
-            });
-          }
-          throw errorUnexpected(error instanceof Error ? error.message : String(error), {
-            why: `Failed to read contract file: ${error instanceof Error ? error.message : String(error)}`,
-          });
-        }
-        const contractJson = JSON.parse(contractJsonContent) as Record<string, unknown>;
-
-        // Resolve database connection (--db flag or config.db.connection)
-        const dbConnection = options.db ?? config.db?.connection;
-        if (!dbConnection) {
-          throw errorDatabaseConnectionRequired();
-        }
-
-        // Check for driver
-        if (!config.driver) {
-          throw errorDriverRequired();
-        }
-
-        // Store driver descriptor after null check
-        const driverDescriptor = config.driver;
-
-        // Create family instance (needed for contract validation - no DB connection required)
-        const stack = createControlPlaneStack({
-          target: config.target,
-          adapter: config.adapter,
-          driver: driverDescriptor,
-          extensionPacks: config.extensionPacks,
-        });
-        const familyInstance = config.family.create(stack);
-
-        // Validate contract using instance validator (fail-fast before DB connection)
-        const contractIR = familyInstance.validateContractIR(contractJson);
-        assertContractRequirementsSatisfied({ contract: contractIR, stack });
-
-        const rawComponents = [config.target, config.adapter, ...(config.extensionPacks ?? [])];
-        const frameworkComponents = assertFrameworkComponentsCompatible(
-          config.family.familyId,
-          config.target.targetId,
-          rawComponents,
-        );
-
-        // Create driver (expensive operation - done after validation)
-        const driver = await driverDescriptor.create(dbConnection);
-
-        try {
-          // Schema verification precondition with spinner
-          let schemaVerifyResult: VerifyDatabaseSchemaResult;
-          try {
-            schemaVerifyResult = await withSpinner(
-              () =>
-                familyInstance.schemaVerify({
-                  driver,
-                  contractIR,
-                  strict: false,
-                  contractPath: contractPathAbsolute,
-                  configPath,
-                  frameworkComponents,
-                }),
-              {
-                message: 'Verifying database satisfies contract',
-                flags,
-              },
-            );
-          } catch (error) {
-            // Wrap errors from schemaVerify() in structured error
-            throw errorRuntime(error instanceof Error ? error.message : String(error), {
-              why: `Failed to verify database schema: ${error instanceof Error ? error.message : String(error)}`,
-            });
-          }
-
-          // If schema verification failed, return both results for handling outside performAction
-          if (!schemaVerifyResult.ok) {
-            return { schemaVerifyResult, signResult: undefined };
-          }
+      const ui = new TerminalUI({ color: flags.color, interactive: flags.interactive });
 
-          // Schema verification passed - proceed with signing
-          let signResult: SignDatabaseResult;
-          try {
-            signResult = await withSpinner(
-              () =>
-                familyInstance.sign({
-                  driver,
-                  contractIR,
-                  contractPath: contractPathAbsolute,
-                  configPath,
-                }),
-              {
-                message: 'Signing database...',
-                flags,
-              },
-            );
-          } catch (error) {
-            // Wrap errors from sign() in structured error
-            throw errorRuntime(error instanceof Error ? error.message : String(error), {
-              why: `Failed to sign database: ${error instanceof Error ? error.message : String(error)}`,
-            });
-          }
+      const result = await executeDbSignCommand(options, flags, ui);
 
-          // Add blank line after all async operations if spinners were shown
-          if (!flags.quiet && flags.json !== 'object' && process.stdout.isTTY) {
-            console.log('');
+      if (result.ok) {
+        // Success - format sign output
+        if (flags.json) {
+          ui.output(formatSignJson(result.value));
+        } else {
+          const output = formatSignOutput(result.value, flags);
+          if (output) {
+            ui.log(output);
           }
-
-          return { schemaVerifyResult: undefined, signResult };
-        } finally {
-          // Ensure driver connection is closed
-          await driver.close();
         }
-      });
-
-      // Handle result - formats output and returns exit code
-      const exitCode = handleResult(result, flags, (value) => {
-        const { schemaVerifyResult, signResult } = value;
+        process.exit(0);
+      }
 
-        // If schema verification failed, format and print schema verification output
-        if (schemaVerifyResult && !schemaVerifyResult.ok) {
-          if (flags.json === 'object') {
-            console.log(formatSchemaVerifyJson(schemaVerifyResult));
-          } else {
-            const output = formatSchemaVerifyOutput(schemaVerifyResult, flags);
-            if (output) {
-              console.log(output);
-            }
-          }
-          // Don't proceed to sign output formatting
-          return;
-        }
+      // Failure - determine type and handle appropriately
+      const failure = result.failure;
 
-        // Schema verification passed - format sign output
-        if (signResult) {
-          if (flags.json === 'object') {
-            console.log(formatSignJson(signResult));
-          } else {
-            const output = formatSignOutput(signResult, flags);
-            if (output) {
-              console.log(output);
-            }
-          }
-        }
-      });
+      if (failure instanceof CliStructuredError) {
+        // Infrastructure error - use standard handler
+        const exitCode = handleResult(result as Result<never, CliStructuredError>, flags, ui);
+        process.exit(exitCode);
+      }
 
-      // For logical schema mismatches, check if schema verification passed
-      // Infra errors already handled by handleResult (returns non-zero exit code)
-      if (result.ok && result.value.schemaVerifyResult && !result.value.schemaVerifyResult.ok) {
-        // Schema verification failed - exit with code 1
-        process.exit(1);
+      // Schema verification failed - format and print schema verification output
+      if (flags.json) {
+        ui.output(formatSchemaVerifyJson(failure));
       } else {
-        // Success or infra error - use exit code from handleResult
-        process.exit(exitCode);
+        const output = formatSchemaVerifyOutput(failure, flags);
+        if (output) {
+          ui.log(output);
+        }
       }
+      process.exit(1);
     });
 
   return command;