neonctl 1.29.1 → 1.29.4

package/commands/projects.js

@@ -0,0 +1,186 @@
+import { log } from '../log.js';
+import { projectCreateRequest, projectUpdateRequest, } from '../parameters.gen.js';
+import { writer } from '../writer.js';
+import { psql } from '../utils/psql.js';
+import { updateContextFile } from '../context.js';
+const PROJECT_FIELDS = ['id', 'name', 'region_id', 'created_at'];
+const REGIONS = [
+    'aws-us-west-2',
+    'aws-ap-southeast-1',
+    'aws-eu-central-1',
+    'aws-us-east-2',
+    'aws-us-east-1',
+];
+const PROJECTS_LIST_LIMIT = 100;
+export const command = 'projects';
+export const describe = 'Manage projects';
+export const aliases = ['project'];
+export const builder = (argv) => {
+    return argv
+        .usage('$0 projects <sub-command> [options]')
+        .command('list', 'List projects', (yargs) => yargs, async (args) => {
+        await list(args);
+    })
+        .command('create', 'Create a project', (yargs) => yargs.options({
+        name: {
+            describe: projectCreateRequest['project.name'].description,
+            type: 'string',
+        },
+        'region-id': {
+            describe: `The region ID. Possible values: ${REGIONS.join(', ')}`,
+            type: 'string',
+        },
+        psql: {
+            type: 'boolean',
+            describe: 'Connect to a new project via psql',
+            default: false,
+        },
+        database: {
+            describe: projectCreateRequest['project.branch.database_name'].description,
+            type: 'string',
+        },
+        role: {
+            describe: projectCreateRequest['project.branch.role_name'].description,
+            type: 'string',
+        },
+        'set-context': {
+            type: 'boolean',
+            describe: 'Set the current context to the new project',
+            default: false,
+        },
+    }), async (args) => {
+        await create(args);
+    })
+        .command('update <id>', 'Update a project', (yargs) => yargs.options({
+        name: {
+            describe: projectCreateRequest['project.name'].description,
+            type: 'string',
+        },
+        'ip-allow': {
+            describe: projectUpdateRequest['project.settings.allowed_ips.ips']
+                .description,
+            type: 'string',
+            array: true,
+            deprecated: "Deprecated. Use 'ip-allow' command",
+        },
+        'ip-primary-only': {
+            describe: projectUpdateRequest['project.settings.allowed_ips.primary_branch_only'].description,
+            type: 'boolean',
+            deprecated: "Deprecated. Use 'ip-allow' command",
+        },
+    }), async (args) => {
+        await update(args);
+    })
+        .command('delete <id>', 'Delete a project', (yargs) => yargs, async (args) => {
+        await deleteProject(args);
+    })
+        .command('get <id>', 'Get a project', (yargs) => yargs, async (args) => {
+        await get(args);
+    });
+};
+export const handler = (args) => {
+    return args;
+};
+const list = async (props) => {
+    const getList = async (fn) => {
+        const result = [];
+        let cursor;
+        let end = false;
+        while (!end) {
+            const { data } = await fn({
+                limit: PROJECTS_LIST_LIMIT,
+                cursor,
+            });
+            result.push(...data.projects);
+            cursor = data.pagination?.cursor;
+            log.debug('Got %d projects, with cursor: %s', data.projects.length, cursor);
+            if (data.projects.length < PROJECTS_LIST_LIMIT) {
+                end = true;
+            }
+        }
+        return result;
+    };
+    const [ownedProjects, sharedProjects] = await Promise.all([
+        getList(props.apiClient.listProjects),
+        getList(props.apiClient.listSharedProjects),
+    ]);
+    const out = writer(props);
+    out.write(ownedProjects, {
+        fields: PROJECT_FIELDS,
+        title: 'Projects',
+    });
+    out.write(sharedProjects, {
+        fields: PROJECT_FIELDS,
+        title: 'Shared with me',
+    });
+    out.end();
+};
+const create = async (props) => {
+    const project = {};
+    if (props.name) {
+        project.name = props.name;
+    }
+    if (props.regionId) {
+        project.region_id = props.regionId;
+    }
+    project.branch = {};
+    if (props.database) {
+        project.branch.database_name = props.database;
+    }
+    if (props.role) {
+        project.branch.role_name = props.role;
+    }
+    const { data } = await props.apiClient.createProject({
+        project,
+    });
+    if (props.setContext) {
+        updateContextFile(props.contextFile, {
+            projectId: data.project.id,
+            branchId: data.branch.id,
+        });
+    }
+    const out = writer(props);
+    out.write(data.project, { fields: PROJECT_FIELDS, title: 'Project' });
+    out.write(data.connection_uris, {
+        fields: ['connection_uri'],
+        title: 'Connection URIs',
+    });
+    out.end();
+    if (props.psql) {
+        const connection_uri = data.connection_uris[0].connection_uri;
+        const psqlArgs = props['--'];
+        await psql(connection_uri, psqlArgs);
+    }
+};
+const deleteProject = async (props) => {
+    const { data } = await props.apiClient.deleteProject(props.id);
+    writer(props).end(data.project, {
+        fields: PROJECT_FIELDS,
+    });
+};
+const update = async (props) => {
+    const project = {};
+    if (props.name) {
+        project.name = props.name;
+    }
+    if (props.ipAllow || props.ipPrimaryOnly != undefined) {
+        const { data } = await props.apiClient.getProject(props.id);
+        const existingAllowedIps = data.project.settings?.allowed_ips;
+        project.settings = {
+            allowed_ips: {
+                ips: props.ipAllow ?? existingAllowedIps?.ips ?? [],
+                primary_branch_only: props.ipPrimaryOnly ??
+                    existingAllowedIps?.primary_branch_only ??
+                    false,
+            },
+        };
+    }
+    const { data } = await props.apiClient.updateProject(props.id, {
+        project,
+    });
+    writer(props).end(data.project, { fields: PROJECT_FIELDS });
+};
+const get = async (props) => {
+    const { data } = await props.apiClient.getProject(props.id);
+    writer(props).end(data.project, { fields: PROJECT_FIELDS });
+};

package/commands/projects.test.js

@@ -0,0 +1,132 @@
+import { afterAll, describe, expect, test } from '@jest/globals';
+import { readFileSync, rmSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import { testCliCommand } from '../test_utils/test_cli_command.js';
+const CONTEXT_FILE = join(tmpdir(), `neon_project_create_ctx_${Date.now()}`);
+describe('projects', () => {
+    testCliCommand({
+        name: 'list',
+        args: ['projects', 'list'],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'create',
+        args: ['projects', 'create', '--name', 'test_project'],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'create with database and role',
+        args: [
+            'projects',
+            'create',
+            '--name',
+            'test_project',
+            '--database',
+            'test_db',
+            '--role',
+            'test_role',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'create and connect with psql',
+        args: ['projects', 'create', '--name', 'test_project', '--psql'],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'create and connect with psql and psql args',
+        args: [
+            'projects',
+            'create',
+            '--name',
+            'test_project',
+            '--psql',
+            '--',
+            '-c',
+            'SELECT 1',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'create project with setting the context',
+        args: [
+            'projects',
+            'create',
+            '--name',
+            'test_project',
+            '--context-file',
+            CONTEXT_FILE,
+            '--set-context',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    afterAll(() => {
+        rmSync(CONTEXT_FILE);
+    });
+    test('context file should exist and contain the project id', () => {
+        expect(readFileSync(CONTEXT_FILE, 'utf-8')).toContain('new-project-123456');
+    });
+    testCliCommand({
+        name: 'delete',
+        args: ['projects', 'delete', 'test'],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'update name',
+        args: ['projects', 'update', 'test', '--name', 'test_project_new_name'],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'update ip allow',
+        args: [
+            'projects',
+            'update',
+            'test',
+            '--ip-allow',
+            '127.0.0.1',
+            '192.168.1.2/22',
+            '--ip-primary-only',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'update ip allow primary only flag',
+        args: ['projects', 'update', 'test', '--ip-primary-only', 'false'],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'update ip allow remove',
+        args: ['projects', 'update', 'test', '--ip-allow'],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'get',
+        args: ['projects', 'get', 'test'],
+        expected: {
+            snapshot: true,
+        },
+    });
+});

package/commands/roles.js

@@ -0,0 +1,57 @@
+import { retryOnLock } from '../api.js';
+import { branchIdFromProps, fillSingleProject } from '../utils/enrichers.js';
+import { writer } from '../writer.js';
+const ROLES_FIELDS = ['name', 'created_at'];
+export const command = 'roles';
+export const describe = 'Manage roles';
+export const aliases = ['role'];
+export const builder = (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)
+    .command('list', 'List roles', (yargs) => yargs, async (args) => await list(args))
+    .command('create', 'Create a role', (yargs) => yargs.options({
+    name: {
+        describe: 'Role name',
+        type: 'string',
+        demandOption: true,
+    },
+}), async (args) => await create(args))
+    .command('delete <role>', 'Delete a role', (yargs) => yargs, async (args) => await deleteRole(args));
+export const handler = (args) => {
+    return args;
+};
+export const list = async (props) => {
+    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) => {
+    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) => {
+    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/commands/roles.test.js

@@ -0,0 +1,42 @@
+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/commands/set_context.js

@@ -0,0 +1,22 @@
+import { updateContextFile } from '../context.js';
+import { branchIdFromProps } from '../utils/enrichers.js';
+export const command = 'set-context';
+export const describe = 'Set the current context';
+export const builder = (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) => {
+    const branchId = await branchIdFromProps(props);
+    const context = {
+        projectId: props.projectId,
+        branchId,
+    };
+    updateContextFile(props.contextFile, context);
+};

package/commands/set_context.test.js

@@ -0,0 +1,53 @@
+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/commands/user.js

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

package/config.js

@@ -0,0 +1,11 @@
+import { join } from 'node:path';
+import { homedir } from 'node:os';
+import { existsSync, mkdirSync } from 'node:fs';
+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, }) => {
+    if (!existsSync(configDir) && (!isCi() || forceAuth)) {
+        mkdirSync(configDir, { recursive: true });
+    }
+};

package/context.js

@@ -0,0 +1,48 @@
+import { accessSync, readFileSync, writeFileSync } from 'node:fs';
+import { homedir } from 'node:os';
+import { normalize, resolve } from 'node:path';
+const CONTEXT_FILE = '.neon';
+const CHECK_FILES = [CONTEXT_FILE, 'package.json', '.git'];
+const wrapWithContextFile = (dir) => 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) => {
+    try {
+        return JSON.parse(readFileSync(file, 'utf-8'));
+    }
+    catch (e) {
+        return {};
+    }
+};
+export const enrichFromContext = (args) => {
+    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, context) => {
+    writeFileSync(file, JSON.stringify(context, null, 2));
+};

package/env.js

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

package/errors.js

@@ -0,0 +1,16 @@
+const ERROR_MATCHERS = [
+    [/^Unknown command: (.*)$/, 'UNKNOWN_COMMAND'],
+    [/^Missing required argument: (.*)$/, 'MISSING_ARGUMENT'],
+];
+export const matchErrorCode = (message) => {
+    if (!message) {
+        return 'UNKNOWN_ERROR';
+    }
+    for (const [matcher, code] of ERROR_MATCHERS) {
+        const match = message.match(matcher);
+        if (match) {
+            return code;
+        }
+    }
+    return 'UNKNOWN_ERROR';
+};