program.ts

import { Command, createCommand, Option } from 'commander';
import { resolve } from 'path';
import { readJSONSync } from 'fs-extra';
import {
  DefaultConfig,
  DefaultConfigPaths,
  disposeContext,
  initContext,
  runDiff,
  runPull,
  runPush,
  runRemovePermissionDuplicates,
  runUntrack,
  runWaitServerReady,
} from './index';
import { runSeedPush, runSeedDiff } from './commands/seed';

/**
 * Remove some default values from the program options that overrides the config file
 */
function cleanProgramOptions(programOptions: Record<string, unknown>) {
  return programOptions;
}

/**
 * Remove some default values from the command options that overrides the config file
 */
function cleanCommandOptions(commandOptions: Record<string, unknown>) {
  if (commandOptions.collections === true) {
    delete commandOptions.collections;
  }
  if (commandOptions.snapshot === true) {
    delete commandOptions.snapshot;
  }
  if (commandOptions.split === true) {
    delete commandOptions.split;
  }
  if (commandOptions.specs === true) {
    delete commandOptions.specs;
  }
  if (commandOptions.syncPolicyRoles === true) {
    delete commandOptions.syncPolicyRoles;
  }
  return commandOptions;
}

function wrapAction(program: Command, action: () => Promise<void>) {
  return (commandOpts: Record<string, unknown>) => {
    return initContext(
      cleanProgramOptions(program.opts()),
      cleanCommandOptions(commandOpts),
    )
      .then(action)
      .then(disposeContext);
  };
}

function getVersion(): string {
  try {
    const { version } = readJSONSync(
      resolve(__dirname, '..', '..', 'package.json'),
    ) as { version?: string };
    return version ?? 'undefined';
  } catch (e) {
    return (e as Error).message ?? 'error';
  }
}

/**
 * Split a comma separated list
 */
function commaSeparatedList(value: string) {
  return value.split(',').map((v) => v.trim());
}

/**
 * Split a comma separated list unless the value is "all" or "*"
 */
function commaSeparatedListOrAll(value: string) {
  const v = value.trim();
  if (v === '*' || v === 'all') {
    return v;
  }
  return commaSeparatedList(value);
}

export function createProgram() {
  const program = createCommand();
  // Global options
  const debugOption = new Option(
    '-d, --debug',
    `display more logging (default "${DefaultConfig.debug}")`,
  );
  const directusUrlOption = new Option(
    '-u, --directus-url <directusUrl>',
    'Directus URL',
  ).env('DIRECTUS_URL');
  const directusTokenOption = new Option(
    '-t, --directus-token <directusToken>',
    'Directus access token',
  ).env('DIRECTUS_TOKEN');
  const directusEmailOption = new Option(
    '-e, --directus-email <directusEmail>',
    'Directus user email',
  ).env('DIRECTUS_ADMIN_EMAIL');
  const directusPasswordOption = new Option(
    '-p, --directus-password <directusPassword>',
    'Directus user password',
  ).env('DIRECTUS_ADMIN_PASSWORD');
  const configPathOption = new Option(
    '-c, --config-path <configPath>',
    `the path to the config file. Required for extended options (default paths: ${DefaultConfigPaths.join(
      ', ',
    )})`,
  );
  const sortJsonOption = new Option(
    '--sort-json',
    `sort JSON keys when saving files (default "${DefaultConfig.sortJson}")`,
  );

  // Shared options
  const dumpPathOption = new Option(
    '--dump-path <dumpPath>',
    `the base path for the dump (default "${DefaultConfig.dumpPath}")`,
  );

  const maxPushRetriesOption = new Option(
    '--max-push-retries <maxPushRetries>',
    `the number of retries for the push operation (default "${DefaultConfig.maxPushRetries}")`,
  );

  const collectionsPathOption = new Option(
    '--collections-path <collectionPath>',
    `the path for the collections dump, relative to the dump path (default "${DefaultConfig.collectionsPath}")`,
  );
  const excludeCollectionsOption = new Option(
    '-x, --exclude-collections <excludeCollections>',
    `comma separated list of collections to exclude from the process (default to none)`,
  ).argParser(commaSeparatedList);
  const onlyCollectionsOption = new Option(
    '-o, --only-collections <onlyCollections>',
    `comma separated list of collections to include in the process (default to all)`,
  ).argParser(commaSeparatedList);
  const noCollectionsOption = new Option(
    '--no-collections',
    `should pull and push the collections (default "${DefaultConfig.collections}")`,
  );
  const noSyncPolicyRolesOption = new Option(
    '--no-sync-policy-roles',
    `should sync the role ↔ policy attachments (directus_access entries linking roles and policies). Disable to leave existing role-policy assignments on the target untouched (default "${DefaultConfig.syncPolicyRoles}")`,
  );
  const preserveIdsOption = new Option(
    '--preserve-ids <preserveIds>',
    `comma separated list of collections that preserve their original ids (default to none). Use "*" or "all" to preserve all ids, if applicable.`,
  ).argParser(commaSeparatedListOrAll);

  const snapshotPathOption = new Option(
    '--snapshot-path <snapshotPath>',
    `the path for the schema snapshot dump, relative to the dump path (default "${DefaultConfig.snapshotPath}")`,
  );
  const noSnapshotOption = new Option(
    '--no-snapshot',
    `should pull and push the Directus schema (default "${DefaultConfig.snapshot}")`,
  );
  const noSplitOption = new Option(
    '--no-split',
    `should split the schema snapshot into multiple files (default "${DefaultConfig.split}")`,
  );

  const specificationsPathOption = new Option(
    '--specs-path <specsPath>',
    `the path for the specifications dump (GraphQL & OpenAPI), relative to the dump path (default "${DefaultConfig.specsPath}")`,
  );
  const noSpecificationsOption = new Option(
    '--no-specs',
    `should dump the GraphQL & OpenAPI specifications (default "${DefaultConfig.specs}")`,
  );

  const forceOption = new Option(
    '-f, --force',
    `force the diff of schema, even if the Directus version is different (default "${DefaultConfig.force}")`,
  );

  const prettyDiffOption = new Option(
    '--pretty-diff',
    `display a human readable schema diff instead of the raw JSON (default "${DefaultConfig.prettyDiff}")`,
  );

  program
    .version(getVersion())
    .addOption(debugOption)
    .addOption(sortJsonOption)
    .addOption(directusUrlOption)
    .addOption(directusTokenOption)
    .addOption(directusEmailOption)
    .addOption(directusPasswordOption)
    .addOption(configPathOption);

  program
    .command('pull')
    .description('get the schema and collections and store them locally')
    .addOption(dumpPathOption)
    .addOption(collectionsPathOption)
    .addOption(excludeCollectionsOption)
    .addOption(onlyCollectionsOption)
    .addOption(noCollectionsOption)
    .addOption(noSyncPolicyRolesOption)
    .addOption(preserveIdsOption)
    .addOption(snapshotPathOption)
    .addOption(noSnapshotOption)
    .addOption(noSplitOption)
    .addOption(specificationsPathOption)
    .addOption(noSpecificationsOption)
    .action(wrapAction(program, runPull));

  program
    .command('diff')
    .description(
      'describe the schema and collections diff. Does not modify the database.',
    )
    .addOption(dumpPathOption)
    .addOption(collectionsPathOption)
    .addOption(excludeCollectionsOption)
    .addOption(onlyCollectionsOption)
    .addOption(noCollectionsOption)
    .addOption(noSyncPolicyRolesOption)
    .addOption(snapshotPathOption)
    .addOption(noSnapshotOption)
    .addOption(noSplitOption)
    .addOption(forceOption)
    .addOption(prettyDiffOption)
    .action(wrapAction(program, runDiff));

  program
    .command('push')
    .description('push the schema and collections')
    .addOption(dumpPathOption)
    .addOption(collectionsPathOption)
    .addOption(excludeCollectionsOption)
    .addOption(onlyCollectionsOption)
    .addOption(noCollectionsOption)
    .addOption(noSyncPolicyRolesOption)
    .addOption(preserveIdsOption)
    .addOption(snapshotPathOption)
    .addOption(noSnapshotOption)
    .addOption(noSplitOption)
    .addOption(forceOption)
    .addOption(maxPushRetriesOption)
    .action(wrapAction(program, runPush));

  // ---------------------------------------------------------------------------------
  // Seed
  const defaultSeedPath = Array.isArray(DefaultConfig.seedPath)
    ? DefaultConfig.seedPath.join(', ')
    : DefaultConfig.seedPath;
  const seedPathOption = new Option(
    '--seed-path <seedPath...>',
    `the base path(s) for the seed (default "${defaultSeedPath}")`,
  );

  const seed = program
    .command('seed')
    .description('seed the custom collections with data');

  seed
    .command('push')
    .description('push the seed data')
    .addOption(seedPathOption)
    .addOption(maxPushRetriesOption)
    .action(wrapAction(program, runSeedPush));

  seed
    .command('diff')
    .description('describe the seed data diff')
    .addOption(seedPathOption)
    .action(wrapAction(program, runSeedDiff));

  // ---------------------------------------------------------------------------------
  // Helpers
  const helpers = program
    .command('helpers')
    .description('a set of helper utilities');

  helpers
    .command('untrack')
    .description('stop tracking of an element')
    .requiredOption(
      '--collection <collection>',
      'the collection of the element',
    )
    .requiredOption('--id <id>', 'the id of the element to untrack')
    .action(wrapAction(program, runUntrack));

  helpers
    .command('remove-permission-duplicates')
    .description(
      'remove conflicts in permissions when there are duplicated groups "policy + collection + action".',
    )
    .option(
      '--keep <keep>',
      `the permission to keep in case of conflict: "first" or "last" (default "${DefaultConfig.keep}")`,
    )
    .action(wrapAction(program, runRemovePermissionDuplicates));

  helpers
    .command('wait-server-ready')
    .description('wait until the Directus server is ready (health endpoint)')
    .option(
      '--interval <interval>',
      `seconds between checks (default "${DefaultConfig.interval}")`,
    )
    .option(
      '--timeout <timeout>',
      `timeout in seconds (default "${DefaultConfig.timeout}")`,
    )
    .option(
      '--successes <successes>',
      `number of consecutive successes required (default "${DefaultConfig.successes}")`,
    )
    .action(wrapAction(program, runWaitServerReady));

  return program;
}