allow specifying which validations should be executed for all validation and deploy commands.

Author: stevensJourney

cli/package.json

@@ -10,6 +10,7 @@
   "dependencies": {
     "@fastify/cors": "^10.0.0",
     "@inquirer/prompts": "^7.2.0",
+    "@journeyapps-labs/common-utils": "^1.0.1",
     "@oclif/core": "^4",
     "@oclif/plugin-autocomplete": "^3.2.40",
     "@oclif/plugin-commands": "^4.1.40",

cli/src/api/BaseDeployCommand.ts

@@ -5,16 +5,8 @@ import { routes } from '@powersync/management-types';
 import { ObjectId } from 'bson';
 import ora from 'ora';
 
-import { formatTestConnectionFailure, testCloudConnections } from './cloud/test-connection.js';
 import { DEFAULT_DEPLOY_TIMEOUT_MS, waitForOperationStatusChange } from './cloud/wait-for-operation.js';
 
-export const SKIP_SYNC_CONFIG_VALIDATION_FLAG = {
-  'skip-sync-config-validation': Flags.boolean({
-    default: false,
-    description: 'Skip sync config validation and continue with the deploy.'
-  })
-};
-
 export default abstract class BaseDeployCommand extends CloudInstanceCommand {
   static flags = {
     'deploy-timeout': Flags.integer({
@@ -157,42 +149,6 @@ export default abstract class BaseDeployCommand extends CloudInstanceCommand {
     }
   }
 
-  protected async testConnections(): Promise<void> {
-    const { client, project } = this;
-    const { linked } = project;
-    const { serviceConfig } = this;
-    if (!serviceConfig) {
-      this.styledError({
-        message: `Service config not loaded. Ensure ${SERVICE_FILENAME} is present and valid.`
-      });
-    }
-
-    this.log('\tTesting connections...');
-    if ((serviceConfig.replication?.connections?.length ?? 0) <= 0) {
-      this.styledError({
-        message: 'No connection found in config.',
-        suggestions: ['Add a connection to the config in replication->connections before deploying.']
-      });
-    }
-
-    const connectionResults = await testCloudConnections(
-      client,
-      linked,
-      serviceConfig.replication?.connections ?? []
-    ).catch((error) => {
-      this.styledError({
-        error,
-        message: 'Failed to test connections',
-        suggestions: ['Check your network connection and try again.', 'If the problem persists, contact support.']
-      });
-    });
-    for (const { connectionName, response } of connectionResults) {
-      if (response.success !== true) {
-        this.styledError({ message: formatTestConnectionFailure(response, connectionName) });
-      }
-    }
-  }
-
   protected async validateServiceConfig(params: { cloudConfigState: routes.InstanceConfigResponse }): Promise<void> {
     const { cloudConfigState } = params;
     const { linked } = this.project;
@@ -232,49 +188,6 @@ export default abstract class BaseDeployCommand extends CloudInstanceCommand {
     }
   }
 
-  protected async validateSyncConfig() {
-    const { client, project } = this;
-    // It might take a while for the instance to be fully provisioned after the deploy, so we retry the validation until it succeeds or we hit the timeout
-    for (let retry = 0; retry < 100; retry++) {
-      const validation = await client
-        .validateSyncRules({
-          app_id: project.linked.project_id,
-          id: project.linked.instance_id,
-          org_id: project.linked.org_id,
-          sync_rules: project.syncRulesContent ?? ''
-        })
-        .catch((error) => {
-          if (retry === 99) {
-            this.styledError({
-              error,
-              message: `Failed to validate sync config for instance ${project.linked.instance_id} in project ${project.linked.project_id} in org ${project.linked.org_id}. Ensure the sync config is valid before deploying.`,
-              suggestions: ['Check your sync config and try again.']
-            });
-          } else {
-            // signal a retry
-            return null;
-          }
-        });
-
-      if (!validation) {
-        await new Promise((resolve) => {
-          setTimeout(resolve, 1000);
-        });
-        continue;
-      }
-
-      if (validation.errors.some((error) => error.level === 'fatal')) {
-        this.styledError({
-          message: `Sync config validation failed for instance. Validation errors:\n${validation.errors.map((error) => error.message).join('\n')}`,
-          suggestions: ['Check your sync config and try again.']
-        });
-      }
-
-      // Validation succeeded with no errors
-      return;
-    }
-  }
-
   protected async waitForDeployCompletion(params: {
     deployResult: routes.DeployInstanceResponse;
     indentation?: string;

cli/src/api/validations/ValidationTestDefinition.ts

@@ -1,258 +1,26 @@
-import { ux } from '@oclif/core';
-import {
-  CloudProject,
-  parseYamlFile,
-  SelfHostedProject,
-  SERVICE_FILENAME,
-  SYNC_FILENAME,
-  SyncDiagnostic,
-  SyncValidationTestRunResult,
-  validateCloudSyncRules,
-  validateSelfHostedSyncRules,
-  ValidationResult,
-  ValidationTestResult,
-  ValidationTestRunResult
-} from '@powersync/cli-core';
-import { ServiceCloudConfig, ServiceSelfHostedConfig } from '@powersync/cli-schemas';
-import { existsSync, readFileSync } from 'node:fs';
-import { join } from 'node:path';
-import { Document } from 'yaml';
-
-/** Indentation used for nested human-readable output rows. */
-export const INDENT = '  ';
-
-/** Bullet character used for list rows in human-readable output. */
-export const BULLET = '•';
+import { ValidationTestRunResult } from '@powersync/cli-core';
 
 /**
  * Definition of a test: display name and async runner function.
  */
 export type ValidationTestDefinition = {
-  name: string;
+  name: ValidationTest;
   run: () => Promise<ValidationTestRunResult>;
 };
 
 /**
  * Runtime test entry, storing the in-flight promise and optional settled result.
  */
-export type ValidationTestEntry = {
+export type ValidationTestResultEntry = {
   name: string;
-  promise: Promise<ValidationTestRunResult>;
   result?: ValidationTestRunResult;
 };
 
 /**
  * Named test buckets used by the validate command.
  */
 export enum ValidationTest {
-  'CONFIGURATION-SCHEMA' = 'Validate Configuration Schema',
-  'CONNECTIONS' = 'Test Connections',
-  'SYNC-CONFIG' = 'Validate Sync Config'
-}
-
-/**
- * Formats spinner text showing per-test progress while tests are running.
- * These logs are indeted with bullets for readability, and update in-place as each test settles to show pass/fail status.
- */
-export function formatOraMessage(entries: ValidationTestEntry[]): string {
-  return entries
-    .map((e) => (e.result === undefined ? `\t... ${e.name}` : e.result.passed ? `\t✓ ${e.name}` : `\t✗ ${e.name}`))
-    .join('\n');
-}
-
-/**
- * Formats one test result into human-readable plain text.
- */
-function formatTestResultHuman(test: ValidationTestResult): string {
-  const status = test.passed ? '✓' : '✗';
-  const name = `${status} ${test.name}`;
-  const warningLines = (test.warnings ?? []).map((warning) => `${INDENT}${BULLET} [warning] ${warning}`);
-  if (test.passed && warningLines.length === 0) return name;
-  const errorLines = (test.errors ?? []).map((e) => `${INDENT}${BULLET} ${e}`);
-  return [name, ...warningLines, ...errorLines].join('\n');
-}
-
-/**
- * Formats suite output for `--output=human`.
- */
-export function formatValidationHuman(result: ValidationResult): string {
-  const header = result.passed ? 'All validation tests passed.' : 'Some validation tests failed.';
-  const lines = [header, '', ...result.tests.map((test) => formatTestResultHuman(test))];
-  return lines.join('\n');
-}
-
-/**
- * Formats suite output for `--output=json`.
- */
-export function formatValidationJson(result: ValidationResult): string {
-  return JSON.stringify(result, null, 2);
-}
-
-/**
- * Formats suite output for `--output=yaml`.
- */
-export function formatValidationYaml(result: ValidationResult): string {
-  return new Document(result).toString();
-}
-
-/**
- * Builds a two-line diagnostic message containing a source fragment and location-prefixed message.
- */
-function formatSyncDiagnosticMessage(diagnostic: SyncDiagnostic, syncRulesContent: string): string {
-  const lineText = getLineAt(syncRulesContent, diagnostic.startLine);
-  const fragment = getLineFragment(lineText, diagnostic.startColumn);
-
-  return `${fragment}\n${diagnostic.startLine}:${diagnostic.startColumn} ${diagnostic.message}`;
-}
-
-/**
- * Retrieves a specific 1-based line from text content.
- */
-function getLineAt(content: string, lineNumber: number): string {
-  if (!content) {
-    return '';
-  }
-
-  const lines = content.split(/\r?\n/);
-  return lines[Math.max(0, lineNumber - 1)] ?? '';
-}
-
-/**
- * Extracts a nearby fragment around `startColumn`, clipping to a fixed width for readability.
- */
-function getLineFragment(lineText: string, startColumn: number): string {
-  if (!lineText) {
-    return '(line unavailable)';
-  }
-
-  const maxWidth = 120;
-  if (lineText.length <= maxWidth) {
-    return lineText;
-  }
-
-  const centerIndex = Math.max(0, startColumn - 1);
-  let start = Math.max(0, centerIndex - Math.floor(maxWidth / 2));
-  const end = Math.min(lineText.length, start + maxWidth);
-
-  if (end - start < maxWidth) {
-    start = Math.max(0, end - maxWidth);
-  }
-
-  const prefix = start > 0 ? '…' : '';
-  const suffix = end < lineText.length ? '…' : '';
-
-  return `${prefix}${lineText.slice(start, end)}${suffix}`;
-}
-
-/**
- * Renders a warning into two lines for human output:
- * 1) gray source fragment
- * 2) yellow `[warning] line:column` prefix followed by plain message text
- */
-export function renderWarningForHumanOutput(warning: string): string[] {
-  const [fragmentRaw, locationAndMessageRaw] = warning.split('\n', 2);
-  const fragment = fragmentRaw ?? '';
-  const locationAndMessage = locationAndMessageRaw ?? '';
-
-  const parsed = locationAndMessage.match(/^(\d+:\d+)\s+([\s\S]+)$/);
-  const location = parsed?.[1] ?? '';
-  const message = parsed?.[2] ?? locationAndMessage;
-
-  const lines = [ux.colorize('gray', `${INDENT}${BULLET} ${fragment}`)];
-
-  if (location) {
-    lines.push(`${INDENT}${ux.colorize('yellow', '[warning]')} ${ux.colorize('yellow', location)} ${message}`);
-  } else {
-    lines.push(`${INDENT}${ux.colorize('yellow', '[warning]')} ${message}`);
-  }
-
-  return lines;
-}
-
-/**
- * Validates `service.yaml` against the cloud or self-hosted schema, depending on project type.
- */
-export async function runConfigTest(projectDir: string, isCloud: boolean): Promise<ValidationTestRunResult> {
-  const servicePath = join(projectDir, SERVICE_FILENAME);
-  try {
-    const doc = parseYamlFile(servicePath);
-    const raw = doc.contents?.toJSON();
-    if (isCloud) {
-      ServiceCloudConfig.decode(raw);
-    } else {
-      ServiceSelfHostedConfig.decode(raw);
-    }
-
-    return { passed: true };
-  } catch (error) {
-    const message = error instanceof Error ? error.message : String(error);
-    return { errors: [message], passed: false };
-  }
-}
-
-/**
- * Runs cloud sync-rules validation and maps diagnostics into warning/error message arrays.
- */
-export async function runSyncConfigTestCloud(project: CloudProject): Promise<SyncValidationTestRunResult> {
-  const syncRulesPath = join(project.projectDirectory, SYNC_FILENAME);
-  const syncRulesContent =
-    project.syncRulesContent ?? (existsSync(syncRulesPath) ? readFileSync(syncRulesPath, 'utf8') : undefined);
-  const syncText = syncRulesContent ?? '';
-
-  try {
-    const result = await validateCloudSyncRules({
-      linked: project.linked,
-      syncRulesContent: syncText
-    });
-
-    const errors = result.diagnostics
-      .filter((diagnostic) => diagnostic.level === 'fatal')
-      .map((diagnostic) => formatSyncDiagnosticMessage(diagnostic, syncText));
-    const warnings = result.diagnostics
-      .filter((diagnostic) => diagnostic.level === 'warning')
-      .map((diagnostic) => formatSyncDiagnosticMessage(diagnostic, syncText));
-
-    return {
-      // Add detailed diagnostics for errors and warnings.
-      diagnostics: result.diagnostics,
-      errors: errors.length > 0 ? errors : undefined,
-      passed: errors.length === 0,
-      warnings: warnings.length > 0 ? warnings : undefined
-    };
-  } catch (error) {
-    const message = error instanceof Error ? error.message : String(error);
-    return { diagnostics: [], errors: [message], passed: false };
-  }
-}
-
-/**
- * Runs self-hosted sync-rules validation and maps diagnostics into warning/error message arrays.
- */
-export async function runSyncConfigTestSelfHosted(project: SelfHostedProject): Promise<SyncValidationTestRunResult> {
-  const syncRulesPath = join(project.projectDirectory, SYNC_FILENAME);
-  const syncRulesContent = existsSync(syncRulesPath) ? readFileSync(syncRulesPath, 'utf8') : undefined;
-  const syncText = syncRulesContent ?? '';
-  try {
-    const result = await validateSelfHostedSyncRules({
-      linked: project.linked,
-      syncRulesContent: syncText
-    });
-
-    const errors = result.diagnostics
-      .filter((diagnostic) => diagnostic.level === 'fatal')
-      .map((diagnostic) => formatSyncDiagnosticMessage(diagnostic, syncText));
-    const warnings = result.diagnostics
-      .filter((diagnostic) => diagnostic.level === 'warning')
-      .map((diagnostic) => formatSyncDiagnosticMessage(diagnostic, syncText));
-
-    return {
-      diagnostics: result.diagnostics,
-      errors: errors.length > 0 ? errors : undefined,
-      passed: errors.length === 0,
-      warnings: warnings.length > 0 ? warnings : undefined
-    };
-  } catch (error) {
-    const message = error instanceof Error ? error.message : String(error);
-    return { diagnostics: [], errors: [message], passed: false };
-  }
+  'CONFIGURATION' = 'configuration',
+  'CONNECTIONS' = 'connections',
+  'SYNC-CONFIG' = 'sync-config'
 }