neonctl 1.28.0 → 1.29.1

package/src/commands/roles.test.ts

@@ -0,0 +1,46 @@
+import { describe } from '@jest/globals';
+
+import { testCliCommand } from '../test_utils/test_cli_command.js';
+
+describe('roles', () => {
+  testCliCommand({
+    name: 'list',
+    args: ['roles', 'list', '--project-id', 'test', '--branch', 'test_branch'],
+    expected: {
+      snapshot: true,
+    },
+  });
+
+  testCliCommand({
+    name: 'create',
+    args: [
+      'roles',
+      'create',
+      '--project-id',
+      'test',
+      '--branch',
+      'test_branch',
+      '--name',
+      'test_role',
+    ],
+    expected: {
+      snapshot: true,
+    },
+  });
+
+  testCliCommand({
+    name: 'delete',
+    args: [
+      'roles',
+      'delete',
+      'test_role',
+      '--project-id',
+      'test',
+      '--branch',
+      'test_branch',
+    ],
+    expected: {
+      snapshot: true,
+    },
+  });
+});

package/src/commands/roles.ts

@@ -0,0 +1,100 @@
+import yargs from 'yargs';
+import { retryOnLock } from '../api.js';
+import { branchIdFromProps, fillSingleProject } from '../utils/enrichers.js';
+
+import { BranchScopeProps } from '../types.js';
+import { writer } from '../writer.js';
+
+const ROLES_FIELDS = ['name', 'created_at'] as const;
+
+export const command = 'roles';
+export const describe = 'Manage roles';
+export const aliases = ['role'];
+export const builder = (argv: yargs.Argv) =>
+  argv
+    .usage('$0 roles <sub-command> [options]')
+    .options({
+      'project-id': {
+        describe: 'Project ID',
+        type: 'string',
+      },
+      branch: {
+        describe: 'Branch ID or name',
+        type: 'string',
+      },
+    })
+    .middleware(fillSingleProject as any)
+    .command(
+      'list',
+      'List roles',
+      (yargs) => yargs,
+      async (args) => await list(args as any),
+    )
+    .command(
+      'create',
+      'Create a role',
+      (yargs) =>
+        yargs.options({
+          name: {
+            describe: 'Role name',
+            type: 'string',
+            demandOption: true,
+          },
+        }),
+      async (args) => await create(args as any),
+    )
+    .command(
+      'delete <role>',
+      'Delete a role',
+      (yargs) => yargs,
+      async (args) => await deleteRole(args as any),
+    );
+
+export const handler = (args: yargs.Argv) => {
+  return args;
+};
+
+export const list = async (props: BranchScopeProps) => {
+  const branchId = await branchIdFromProps(props);
+  const { data } = await props.apiClient.listProjectBranchRoles(
+    props.projectId,
+    branchId,
+  );
+  writer(props).end(data.roles, {
+    fields: ROLES_FIELDS,
+  });
+};
+
+export const create = async (
+  props: BranchScopeProps & {
+    name: string;
+  },
+) => {
+  const branchId = await branchIdFromProps(props);
+  const { data } = await retryOnLock(() =>
+    props.apiClient.createProjectBranchRole(props.projectId, branchId, {
+      role: {
+        name: props.name,
+      },
+    }),
+  );
+  writer(props).end(data.role, {
+    fields: ROLES_FIELDS,
+  });
+};
+
+export const deleteRole = async (
+  props: BranchScopeProps & { role: string },
+) => {
+  const branchId = await branchIdFromProps(props);
+  const { data } = await retryOnLock(() =>
+    props.apiClient.deleteProjectBranchRole(
+      props.projectId,
+      branchId,
+      props.role,
+    ),
+  );
+  writer(props).end(data.role, {
+    fields: ROLES_FIELDS,
+  });
+};

package/src/commands/set_context.test.ts

@@ -0,0 +1,64 @@
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import { rmSync, writeFileSync } from 'node:fs';
+import { afterAll, describe } from '@jest/globals';
+import { testCliCommand } from '../test_utils/test_cli_command';
+
+const CONTEXT_FILE = join(tmpdir(), `neon_${Date.now()}`);
+
+describe('set_context', () => {
+  afterAll(() => {
+    rmSync(CONTEXT_FILE);
+  });
+
+  describe('should set the context', () => {
+    testCliCommand({
+      name: 'set-context',
+      args: [
+        'set-context',
+        '--project-id',
+        'test',
+        '--context-file',
+        CONTEXT_FILE,
+      ],
+    });
+
+    testCliCommand({
+      name: 'list branches selecting project from the context',
+      args: ['branches', 'list', '--context-file', CONTEXT_FILE],
+      expected: {
+        snapshot: true,
+      },
+    });
+
+    const overrideContextFile = join(
+      tmpdir(),
+      `neon_override_ctx_${Date.now()}`,
+    );
+    testCliCommand({
+      name: 'get branch id overrides context set branch',
+      before: async () => {
+        writeFileSync(
+          overrideContextFile,
+          JSON.stringify({
+            projectId: 'test',
+            branchId: 'br-cloudy-branch-12345678',
+          }),
+        );
+      },
+      after: async () => {
+        rmSync(overrideContextFile);
+      },
+      args: [
+        'branches',
+        'get',
+        'br-sunny-branch-123456',
+        '--context-file',
+        overrideContextFile,
+      ],
+      expected: {
+        snapshot: true,
+      },
+    });
+  });
+});

package/src/commands/set_context.ts

@@ -0,0 +1,27 @@
+import yargs from 'yargs';
+import { Context, updateContextFile } from '../context.js';
+import { branchIdFromProps } from '../utils/enrichers.js';
+import { BranchScopeProps } from '../types.js';
+
+export const command = 'set-context';
+export const describe = 'Set the current context';
+export const builder = (argv: yargs.Argv) =>
+  argv.usage('$0 set-context [options]').options({
+    'project-id': {
+      describe: 'Project ID',
+      type: 'string',
+    },
+    branch: {
+      describe: 'Branch ID or name',
+      type: 'string',
+    },
+  });
+
+export const handler = async (props: BranchScopeProps) => {
+  const branchId = await branchIdFromProps(props);
+  const context: Context = {
+    projectId: props.projectId,
+    branchId,
+  };
+  updateContextFile(props.contextFile, context);
+};

package/src/commands/user.ts

@@ -0,0 +1,21 @@
+import yargs from 'yargs';
+
+import { CommonProps } from '../types.js';
+import { writer } from '../writer.js';
+
+export const command = 'me';
+export const describe = 'Show current user';
+export const builder = (yargs: yargs.Argv) =>
+  yargs.option('context-file', {
+    hidden: true,
+  });
+export const handler = async (args: CommonProps) => {
+  await me(args);
+};
+
+const me = async (props: CommonProps) => {
+  const { data } = await props.apiClient.getCurrentUserInfo();
+  writer(props).end(data, {
+    fields: ['login', 'email', 'name', 'projects_limit'],
+  });
+};

package/src/config.ts

@@ -0,0 +1,22 @@
+import { join } from 'node:path';
+import { homedir } from 'node:os';
+import { existsSync, mkdirSync } from 'node:fs';
+import yargs from 'yargs';
+
+import { isCi } from './env.js';
+
+export const CREDENTIALS_FILE = 'credentials.json';
+
+export const defaultDir = join(
+  process.env.XDG_CONFIG_HOME || join(homedir(), '.config'),
+  'neonctl',
+);
+
+export const ensureConfigDir = async ({
+  'config-dir': configDir,
+  'force-auth': forceAuth,
+}: yargs.Arguments<{ 'config-dir': string }>) => {
+  if (!existsSync(configDir) && (!isCi() || forceAuth)) {
+    mkdirSync(configDir, { recursive: true });
+  }
+};

package/src/context.ts

@@ -0,0 +1,61 @@
+import { accessSync, readFileSync, writeFileSync } from 'node:fs';
+import { homedir } from 'node:os';
+import { normalize, resolve } from 'node:path';
+import yargs from 'yargs';
+
+export type Context = {
+  projectId?: string;
+  branchId?: string;
+};
+
+const CONTEXT_FILE = '.neon';
+const CHECK_FILES = [CONTEXT_FILE, 'package.json', '.git'];
+
+const wrapWithContextFile = (dir: string) => resolve(dir, CONTEXT_FILE);
+
+export const currentContextFile = () => {
+  const cwd = process.cwd();
+  let currentDir = cwd;
+  const root = normalize('/');
+  const home = homedir();
+  while (currentDir !== root && currentDir !== home) {
+    for (const file of CHECK_FILES) {
+      try {
+        accessSync(resolve(currentDir, file));
+        return wrapWithContextFile(currentDir);
+      } catch (e) {
+        // ignore
+      }
+    }
+    currentDir = resolve(currentDir, '..');
+  }
+
+  return wrapWithContextFile(cwd);
+};
+
+export const readContextFile = (file: string): Context => {
+  try {
+    return JSON.parse(readFileSync(file, 'utf-8'));
+  } catch (e) {
+    return {};
+  }
+};
+
+export const enrichFromContext = (
+  args: yargs.Arguments<{ contextFile: string }>,
+) => {
+  if (args._[0] === 'set-context') {
+    return;
+  }
+  const context = readContextFile(args.contextFile);
+  if (!args.branch && !args.id && !args.name) {
+    args.branch = context.branchId;
+  }
+  if (!args.projectId) {
+    args.projectId = context.projectId;
+  }
+};
+
+export const updateContextFile = (file: string, context: Context) => {
+  writeFileSync(file, JSON.stringify(context, null, 2));
+};

package/src/env.ts

@@ -0,0 +1,7 @@
+export const isCi = () => {
+  return process.env.CI !== 'false' && Boolean(process.env.CI);
+};
+
+export const isDebug = () => {
+  return Boolean(process.env.DEBUG);
+};

package/src/errors.ts

@@ -0,0 +1,24 @@
+export type ErrorCode =
+  | 'REQUEST_TIMEOUT'
+  | 'AUTH_FAILED'
+  | 'API_ERROR'
+  | 'UNKNOWN_COMMAND'
+  | 'MISSING_ARGUMENT'
+  | 'UNKNOWN_ERROR';
+
+const ERROR_MATCHERS = [
+  [/^Unknown command: (.*)$/, 'UNKNOWN_COMMAND'],
+  [/^Missing required argument: (.*)$/, 'MISSING_ARGUMENT'],
+] as const;
+export const matchErrorCode = (message?: string): ErrorCode => {
+  if (!message) {
+    return 'UNKNOWN_ERROR';
+  }
+  for (const [matcher, code] of ERROR_MATCHERS) {
+    const match = message.match(matcher);
+    if (match) {
+      return code;
+    }
+  }
+  return 'UNKNOWN_ERROR';
+};

package/src/help.ts

@@ -0,0 +1,185 @@
+import yargs from 'yargs';
+import cliui from 'cliui';
+import chalk from 'chalk';
+
+import {
+  consumeBlockIfMatches,
+  consumeNextMatching,
+  drawPointer,
+  splitColumns,
+} from './utils/ui.js';
+
+// target width for the leftmost column
+const SPACE_WIDTH = 20;
+
+const formatHelp = (help: string) => {
+  const lines = help.split('\n');
+  const result = [] as string[];
+  // full command, like `neonctl projects list`
+  const topLevelCommand = consumeNextMatching(lines, /^.*/);
+
+  if (topLevelCommand) {
+    result.push(
+      chalk.bold(
+        topLevelCommand.replace('[options]', chalk.reset.green('[options]')),
+      ),
+    );
+    result.push('');
+  }
+
+  // commands description block
+  // example command to see: neonctl projects
+  const commandsBlock = consumeBlockIfMatches(lines, /^Commands:/);
+  if (commandsBlock.length > 0) {
+    const header = commandsBlock.shift() as string;
+    result.push(header);
+    const ui = cliui({
+      width: 0,
+    });
+    commandsBlock.forEach((line) => {
+      if (line.match(/^\s{3,}/)) {
+        ui.div(
+          {
+            text: '',
+            width: SPACE_WIDTH,
+            padding: [0, 0, 0, 0],
+          },
+          { text: line.trim(), padding: [0, 0, 0, 0] },
+        );
+        return;
+      }
+
+      const [command, description] = splitColumns(line);
+
+      // patch the previous command if it was multiline
+      if (!description && ui.rows.length > 1) {
+        ui.rows[ui.rows.length - 2][0].text += command;
+        return;
+      }
+
+      ui.div(chalk.cyan(command));
+      ui.div(
+        {
+          text: chalk.gray(drawPointer(SPACE_WIDTH)),
+          width: SPACE_WIDTH,
+          padding: [0, 0, 0, 0],
+        },
+        { text: description, padding: [0, 0, 0, 2] },
+      );
+    });
+    result.push(ui.toString());
+    result.push('');
+  }
+
+  // positional args block
+  // example command to see: neonctl branches rename
+  const positionalsBlock = consumeBlockIfMatches(lines, /Positionals:/);
+  if (positionalsBlock.length > 0) {
+    const header = positionalsBlock.shift() as string;
+    result.push(header);
+    const ui = cliui({
+      width: 0,
+    });
+    positionalsBlock.forEach((line) => {
+      const [positional, description] = splitColumns(line);
+      ui.div(
+        {
+          text: positional,
+          width: SPACE_WIDTH,
+          padding: [0, 2, 0, 0],
+        },
+        {
+          text: description,
+          padding: [0, 0, 0, 0],
+        },
+      );
+    });
+    result.push(ui.toString());
+    result.push('');
+  }
+
+  // command description
+  // example command to see: neonctl projects list
+  const descritpionBlock = consumeBlockIfMatches(lines, /^(?!.*options:)/i);
+  if (descritpionBlock.length > 0) {
+    result.push(...descritpionBlock);
+    result.push('');
+  }
+
+  while (true) {
+    // there are two options blocks: global and specific
+    // example to see both: neonctl projects create
+    const optionsBlock = consumeBlockIfMatches(lines, /.*options:/i);
+    if (optionsBlock.length === 0) {
+      break;
+    }
+    result.push(optionsBlock.shift() as string);
+    optionsBlock.forEach((line) => {
+      const [option, description] = splitColumns(line);
+      const ui = cliui({
+        width: 0,
+      });
+      if (option.startsWith('-')) {
+        ui.div({
+          text: chalk.green(option),
+          padding: [0, 0, 0, 0],
+        });
+        ui.div(
+          {
+            text: chalk.gray(drawPointer(SPACE_WIDTH)),
+            width: SPACE_WIDTH,
+            padding: [0, 2, 0, 0],
+          },
+          {
+            text: chalk.rgb(210, 210, 210)(description ?? ''),
+            padding: [0, 0, 0, 0],
+          },
+        );
+      } else {
+        ui.div(
+          {
+            padding: [0, 0, 0, 0],
+            text: '',
+            width: SPACE_WIDTH,
+          },
+          {
+            text: chalk.rgb(210, 210, 210)(option),
+            padding: [0, 0, 0, 0],
+          },
+        );
+      }
+
+      result.push(ui.toString());
+    });
+    result.push('');
+  }
+
+  const exampleBlock = consumeBlockIfMatches(lines, /Examples:/);
+  if (exampleBlock.length > 0) {
+    result.push(exampleBlock.shift() as string);
+    const ui = cliui({
+      width: 0,
+    });
+    for (const line of exampleBlock) {
+      const [command, description] = splitColumns(line);
+      ui.div({
+        text: chalk.bold(command),
+        padding: [0, 0, 0, 0],
+      });
+      ui.div({
+        text: chalk.reset(description),
+        padding: [0, 0, 0, 2],
+      });
+    }
+    result.push(ui.toString());
+  }
+
+  return [...result, ...lines];
+};
+
+export const showHelp = async (argv: yargs.Argv) => {
+  // add wrap to ensure that there are no line breaks
+  const help = await argv.getHelp();
+  process.stderr.write(formatHelp(help).join('\n') + '\n');
+  process.exit(0);
+};