neonctl 1.28.0 → 1.29.1

package/commands/connection_string.js

@@ -1,137 +0,0 @@
-import { EndpointType } from '@neondatabase/api-client';
-import { branchIdFromProps, fillSingleProject } from '../utils/enrichers.js';
-import { writer } from '../writer.js';
-import { psql } from '../utils/psql.js';
-const SSL_MODES = ['require', 'verify-ca', 'verify-full', 'omit'];
-export const command = 'connection-string [branch]';
-export const aliases = ['cs'];
-export const describe = 'Get connection string';
-export const builder = (argv) => {
-    return argv
-        .usage('$0 connection-string [branch] [options]')
-        .positional('branch', {
-        describe: 'Branch name or id. If ommited will use the primary branch',
-        type: 'string',
-    })
-        .options({
-        'project-id': {
-            type: 'string',
-            describe: 'Project ID',
-        },
-        'role-name': {
-            type: 'string',
-            describe: 'Role name',
-        },
-        'database-name': {
-            type: 'string',
-            describe: 'Database name',
-        },
-        pooled: {
-            type: 'boolean',
-            describe: 'Use pooled connection',
-            default: false,
-        },
-        prisma: {
-            type: 'boolean',
-            describe: 'Use connection string for Prisma setup',
-            default: false,
-        },
-        'endpoint-type': {
-            type: 'string',
-            choices: Object.values(EndpointType),
-            describe: 'Endpoint type',
-        },
-        extended: {
-            type: 'boolean',
-            describe: 'Show extended information',
-        },
-        psql: {
-            type: 'boolean',
-            describe: 'Connect to a database via psql using connection string',
-            default: false,
-        },
-        ssl: {
-            type: 'string',
-            choices: SSL_MODES,
-            default: 'require',
-            describe: 'SSL mode',
-        },
-    })
-        .middleware(fillSingleProject);
-};
-export const handler = async (props) => {
-    const projectId = props.projectId;
-    const branchId = await branchIdFromProps(props);
-    const { data: { endpoints }, } = await props.apiClient.listProjectBranchEndpoints(projectId, branchId);
-    const matchEndpointType = props.endpointType ?? EndpointType.ReadWrite;
-    let endpoint = endpoints.find((e) => e.type === matchEndpointType);
-    if (!endpoint && props.endpointType == null) {
-        endpoint = endpoints[0];
-    }
-    if (!endpoint) {
-        throw new Error(`No ${props.endpointType ?? ''} endpoint found for the branch: ${branchId}`);
-    }
-    const role = props.roleName ||
-        (await props.apiClient
-            .listProjectBranchRoles(projectId, branchId)
-            .then(({ data }) => {
-            if (data.roles.length === 0) {
-                throw new Error(`No roles found for the branch: ${branchId}`);
-            }
-            if (data.roles.length === 1) {
-                return data.roles[0].name;
-            }
-            throw new Error(`Multiple roles found for the branch, please provide one with the --role-name option: ${data.roles
-                .map((r) => r.name)
-                .join(', ')}`);
-        }));
-    const database = props.databaseName ||
-        (await props.apiClient
-            .listProjectBranchDatabases(projectId, branchId)
-            .then(({ data }) => {
-            if (data.databases.length === 0) {
-                throw new Error(`No databases found for the branch: ${branchId}`);
-            }
-            if (data.databases.length === 1) {
-                return data.databases[0].name;
-            }
-            throw new Error(`Multiple databases found for the branch, please provide one with the --database-name option: ${data.databases
-                .map((d) => d.name)
-                .join(', ')}`);
-        }));
-    const { data: { password }, } = await props.apiClient.getProjectBranchRolePassword(props.projectId, endpoint.branch_id, role);
-    const host = props.pooled
-        ? endpoint.host.replace(endpoint.id, `${endpoint.id}-pooler`)
-        : endpoint.host;
-    const connectionString = new URL(`postgres://${host}`);
-    connectionString.pathname = database;
-    connectionString.username = role;
-    connectionString.password = password;
-    if (props.prisma) {
-        connectionString.searchParams.set('connect_timeout', '30');
-        if (props.pooled) {
-            connectionString.searchParams.set('pool_timeout', '30');
-            connectionString.searchParams.set('pgbouncer', 'true');
-        }
-    }
-    if (props.ssl !== 'omit') {
-        connectionString.searchParams.set('sslmode', props.ssl);
-    }
-    if (props.psql) {
-        const psqlArgs = props['--'];
-        await psql(connectionString.toString(), psqlArgs);
-    }
-    else if (props.extended) {
-        writer(props).end({
-            connection_string: connectionString.toString(),
-            host,
-            role,
-            password,
-            database,
-            options: connectionString.searchParams.toString(),
-        }, { fields: ['host', 'role', 'password', 'database'] });
-    }
-    else {
-        process.stdout.write(connectionString.toString() + '\n');
-    }
-};

package/commands/connection_string.test.js

@@ -1,204 +0,0 @@
-import { describe } from '@jest/globals';
-import { testCliCommand } from '../test_utils/test_cli_command';
-describe('connection_string', () => {
-    testCliCommand({
-        name: 'connection_string',
-        args: [
-            'connection-string',
-            'test_branch',
-            '--project-id',
-            'test',
-            '--database-name',
-            'test_db',
-            '--role-name',
-            'test_role',
-        ],
-        expected: {
-            snapshot: true,
-        },
-    });
-    testCliCommand({
-        name: 'connection_string branch id',
-        args: [
-            'connection-string',
-            'br-sunny-branch-123456',
-            '--project-id',
-            'test',
-            '--database-name',
-            'test_db',
-            '--role-name',
-            'test_role',
-        ],
-        expected: {
-            snapshot: true,
-        },
-    });
-    testCliCommand({
-        name: 'connection_string branch id 8 digits',
-        args: [
-            'connection-string',
-            'br-cloudy-branch-12345678',
-            '--project-id',
-            'test',
-            '--database-name',
-            'test_db',
-            '--role-name',
-            'test_role',
-        ],
-        expected: {
-            snapshot: true,
-        },
-    });
-    testCliCommand({
-        name: 'connection_string pooled',
-        args: [
-            'connection-string',
-            'test_branch',
-            '--project-id',
-            'test',
-            '--database-name',
-            'test_db',
-            '--role-name',
-            'test_role',
-            '--pooled',
-        ],
-        expected: {
-            snapshot: true,
-        },
-    });
-    testCliCommand({
-        name: 'connection_string prisma',
-        args: [
-            'connection-string',
-            'test_branch',
-            '--project-id',
-            'test',
-            '--database-name',
-            'test_db',
-            '--role-name',
-            'test_role',
-            '--prisma',
-        ],
-        expected: {
-            snapshot: true,
-        },
-    });
-    testCliCommand({
-        name: 'connection_string prisma pooled',
-        args: [
-            'connection-string',
-            'test_branch',
-            '--project-id',
-            'test',
-            '--database-name',
-            'test_db',
-            '--role-name',
-            'test_role',
-            '--prisma',
-            '--pooled',
-        ],
-        expected: {
-            snapshot: true,
-        },
-    });
-    testCliCommand({
-        name: 'connection_string prisma pooled extended',
-        args: [
-            'connection-string',
-            'test_branch',
-            '--project-id',
-            'test',
-            '--database-name',
-            'test_db',
-            '--role-name',
-            'test_role',
-            '--prisma',
-            '--pooled',
-            '--extended',
-        ],
-        expected: {
-            snapshot: true,
-        },
-    });
-    testCliCommand({
-        name: 'connection_string without any args should pass',
-        args: ['connection-string'],
-        mockDir: 'single_project',
-        expected: {
-            snapshot: true,
-        },
-    });
-    testCliCommand({
-        name: 'connection_string with psql',
-        args: [
-            'connection-string',
-            'test_branch',
-            '--project-id',
-            'test',
-            '--database-name',
-            'test_db',
-            '--role-name',
-            'test_role',
-            '--psql',
-        ],
-        expected: {
-            snapshot: true,
-        },
-    });
-    testCliCommand({
-        name: 'connection_string with psql and psql args',
-        args: [
-            'connection-string',
-            'test_branch',
-            '--project-id',
-            'test',
-            '--database-name',
-            'test_db',
-            '--role-name',
-            'test_role',
-            '--psql',
-            '--',
-            '-c',
-            'SELECT 1',
-        ],
-        expected: {
-            snapshot: true,
-        },
-    });
-    testCliCommand({
-        name: 'connection_string without ssl',
-        args: [
-            'connection-string',
-            'test_branch',
-            '--project-id',
-            'test',
-            '--database-name',
-            'test_db',
-            '--role-name',
-            'test_role',
-            '--ssl',
-            'omit',
-        ],
-        expected: {
-            snapshot: true,
-        },
-    });
-    testCliCommand({
-        name: 'connection_string with ssl verify full',
-        args: [
-            'connection-string',
-            'test_branch',
-            '--project-id',
-            'test',
-            '--database-name',
-            'test_db',
-            '--role-name',
-            'test_role',
-            '--ssl',
-            'verify-full',
-        ],
-        expected: {
-            snapshot: true,
-        },
-    });
-});

package/commands/databases.js

@@ -1,79 +0,0 @@
-import { retryOnLock } from '../api.js';
-import { branchIdFromProps, fillSingleProject } from '../utils/enrichers.js';
-import { writer } from '../writer.js';
-const DATABASE_FIELDS = ['name', 'owner_name', 'created_at'];
-export const command = 'databases';
-export const describe = 'Manage databases';
-export const aliases = ['database', 'db'];
-export const builder = (argv) => argv
-    .usage('$0 databases <sub-command> [options]')
-    .options({
-    'project-id': {
-        describe: 'Project ID',
-        type: 'string',
-    },
-    branch: {
-        describe: 'Branch ID or name',
-        type: 'string',
-    },
-})
-    .middleware(fillSingleProject)
-    .command('list', 'List databases', (yargs) => yargs, async (args) => await list(args))
-    .command('create', 'Create a database', (yargs) => yargs.options({
-    name: {
-        describe: 'Database name',
-        type: 'string',
-        demandOption: true,
-    },
-    'owner-name': {
-        describe: 'Owner name',
-        type: 'string',
-    },
-}), async (args) => await create(args))
-    .command('delete <database>', 'Delete a database', (yargs) => yargs, async (args) => await deleteDb(args));
-export const handler = (args) => {
-    return args;
-};
-export const list = async (props) => {
-    const branchId = await branchIdFromProps(props);
-    const { data } = await props.apiClient.listProjectBranchDatabases(props.projectId, branchId);
-    writer(props).end(data.databases, {
-        fields: DATABASE_FIELDS,
-    });
-};
-export const create = async (props) => {
-    const branchId = await branchIdFromProps(props);
-    const owner = props.ownerName ??
-        (await props.apiClient
-            .listProjectBranchRoles(props.projectId, branchId)
-            .then(({ data }) => {
-            if (data.roles.length === 0) {
-                throw new Error(`No roles found in branch ${branchId}`);
-            }
-            if (data.roles.length > 1) {
-                throw new Error(`More than one role found in branch ${branchId}. Please specify the owner name. Roles: ${data.roles
-                    .map((r) => r.name)
-                    .join(', ')}`);
-            }
-            return data.roles[0].name;
-        }));
-    if (!owner) {
-        throw new Error('No owner found');
-    }
-    const { data } = await retryOnLock(() => props.apiClient.createProjectBranchDatabase(props.projectId, branchId, {
-        database: {
-            name: props.name,
-            owner_name: owner,
-        },
-    }));
-    writer(props).end(data.database, {
-        fields: DATABASE_FIELDS,
-    });
-};
-export const deleteDb = async (props) => {
-    const branchId = await branchIdFromProps(props);
-    const { data } = await retryOnLock(() => props.apiClient.deleteProjectBranchDatabase(props.projectId, branchId, props.database));
-    writer(props).end(data.database, {
-        fields: DATABASE_FIELDS,
-    });
-};

package/commands/databases.test.js

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

package/commands/help.test.js

@@ -1,11 +0,0 @@
-import { describe, expect } from '@jest/globals';
-import { testCliCommand } from '../test_utils/test_cli_command.js';
-describe('help', () => {
-    testCliCommand({
-        name: 'without args',
-        args: [],
-        expected: {
-            stderr: expect.stringContaining(`neonctl <command> [options]`),
-        },
-    });
-});

package/commands/ip_allow.js

@@ -1,135 +0,0 @@
-import { writer } from '../writer.js';
-import { fillSingleProject } from '../utils/enrichers.js';
-import { projectUpdateRequest } from '../parameters.gen.js';
-import { log } from '../log.js';
-const IP_ALLOW_FIELDS = [
-    'id',
-    'name',
-    'IP_addresses',
-    'primary_branch_only',
-];
-export const command = 'ip-allow';
-export const describe = 'Manage IP Allow';
-export const builder = (argv) => {
-    return argv
-        .usage('$0 ip-allow <sub-command> [options]')
-        .options({
-        'project-id': {
-            describe: 'Project ID',
-            type: 'string',
-        },
-    })
-        .middleware(fillSingleProject)
-        .command('list', 'List the IP allowlist', (yargs) => yargs, async (args) => {
-        await list(args);
-    })
-        .command('add [ips...]', 'Add IP addresses to the IP allowlist', (yargs) => yargs
-        .usage('$0 ip-allow add [ips...]')
-        .positional('ips', {
-        describe: 'The list of IP addresses to add',
-        type: 'string',
-        default: [],
-        array: true,
-    })
-        .options({
-        'primary-only': {
-            describe: projectUpdateRequest['project.settings.allowed_ips.primary_branch_only'].description,
-            type: 'boolean',
-        },
-    }), async (args) => {
-        await add(args);
-    })
-        .command('remove [ips...]', 'Remove IP addresses from the IP allowlist', (yargs) => yargs.usage('$0 ip-allow remove [ips...]').positional('ips', {
-        describe: 'The list of IP addresses to remove',
-        type: 'string',
-        default: [],
-        array: true,
-    }), async (args) => {
-        await remove(args);
-    })
-        .command('reset [ips...]', 'Reset the IP allowlist', (yargs) => yargs.usage('$0 ip-allow reset [ips...]').positional('ips', {
-        describe: 'The list of IP addresses to reset',
-        type: 'string',
-        default: [],
-        array: true,
-    }), async (args) => {
-        await reset(args);
-    });
-};
-export const handler = (args) => {
-    return args;
-};
-const list = async (props) => {
-    const { data } = await props.apiClient.getProject(props.projectId);
-    writer(props).end(parse(data.project), {
-        fields: IP_ALLOW_FIELDS,
-    });
-};
-const add = async (props) => {
-    if (props.ips.length <= 0) {
-        throw new Error(`Enter individual IP addresses, define ranges with a dash, or use CIDR notation for more flexibility.
-       Example: neonctl ip-allow add 192.168.1.1, 192.168.1.20-192.168.1.50, 192.168.1.0/24 --project-id <id>`);
-    }
-    const project = {};
-    const { data } = await props.apiClient.getProject(props.projectId);
-    const existingAllowedIps = data.project.settings?.allowed_ips;
-    project.settings = {
-        allowed_ips: {
-            ips: [...new Set(props.ips.concat(existingAllowedIps?.ips ?? []))],
-            primary_branch_only: props.primaryOnly ?? existingAllowedIps?.primary_branch_only ?? false,
-        },
-    };
-    const { data: response } = await props.apiClient.updateProject(props.projectId, {
-        project,
-    });
-    writer(props).end(parse(response.project), {
-        fields: IP_ALLOW_FIELDS,
-    });
-};
-const remove = async (props) => {
-    if (props.ips.length <= 0) {
-        throw new Error(`Remove individual IP addresses and ranges. Example: neonctl ip-allow remove 192.168.1.1 --project-id <id>`);
-    }
-    const project = {};
-    const { data } = await props.apiClient.getProject(props.projectId);
-    const existingAllowedIps = data.project.settings?.allowed_ips;
-    project.settings = {
-        allowed_ips: {
-            ips: existingAllowedIps?.ips?.filter((ip) => !props.ips.includes(ip)) ?? [],
-            primary_branch_only: existingAllowedIps?.primary_branch_only ?? false,
-        },
-    };
-    const { data: response } = await props.apiClient.updateProject(props.projectId, {
-        project,
-    });
-    writer(props).end(parse(response.project), {
-        fields: IP_ALLOW_FIELDS,
-    });
-};
-const reset = async (props) => {
-    const project = {};
-    project.settings = {
-        allowed_ips: {
-            ips: props.ips,
-            primary_branch_only: false,
-        },
-    };
-    const { data } = await props.apiClient.updateProject(props.projectId, {
-        project,
-    });
-    writer(props).end(parse(data.project), {
-        fields: IP_ALLOW_FIELDS,
-    });
-    if (props.ips.length <= 0) {
-        log.info(`The IP allowlist has been reset. All databases on project "${data.project.name}" are now exposed to the internet`);
-    }
-};
-const parse = (project) => {
-    const ips = project.settings?.allowed_ips?.ips ?? [];
-    return {
-        id: project.id,
-        name: project.name,
-        IP_addresses: ips,
-        primary_branch_only: project.settings?.allowed_ips?.primary_branch_only ?? false,
-    };
-};

package/commands/ip_allow.test.js

@@ -1,78 +0,0 @@
-import { describe } from '@jest/globals';
-import { testCliCommand } from '../test_utils/test_cli_command.js';
-describe('ip-allow', () => {
-    testCliCommand({
-        name: 'list IP allow',
-        args: ['ip-allow', 'list', '--project-id', 'test'],
-        expected: {
-            snapshot: true,
-        },
-    });
-    testCliCommand({
-        name: 'list IP Allow with single-project',
-        args: ['ip-allow', 'list'],
-        mockDir: 'single_project',
-        expected: {
-            snapshot: true,
-        },
-    });
-    testCliCommand({
-        name: 'Add IP allow - Error',
-        args: ['ip-allow', 'add', '--projectId', 'test'],
-        expected: {
-            code: 1,
-            stderr: `ERROR: Enter individual IP addresses, define ranges with a dash, or use CIDR notation for more flexibility.
-       Example: neonctl ip-allow add 192.168.1.1, 192.168.1.20-192.168.1.50, 192.168.1.0/24 --project-id <id>`,
-        },
-    });
-    testCliCommand({
-        name: 'Add IP allow',
-        args: [
-            'ip-allow',
-            'add',
-            '127.0.0.1',
-            '192.168.10.1-192.168.10.15',
-            '--primary-only',
-            '--project-id',
-            'test',
-        ],
-        expected: {
-            snapshot: true,
-        },
-    });
-    testCliCommand({
-        name: 'Remove IP allow - Error',
-        args: ['ip-allow', 'remove', '--project-id', 'test'],
-        expected: {
-            code: 1,
-            stderr: `ERROR: Remove individual IP addresses and ranges. Example: neonctl ip-allow remove 192.168.1.1 --project-id <id>`,
-        },
-    });
-    testCliCommand({
-        name: 'Remove IP allow',
-        args: ['ip-allow', 'remove', '192.168.1.1', '--project-id', 'test'],
-        expected: {
-            snapshot: true,
-        },
-    });
-    testCliCommand({
-        name: 'Reset IP allow',
-        args: ['ip-allow', 'reset', '--project-id', 'test'],
-        expected: {
-            snapshot: true,
-            stdout: `id: test
-name: test_project
-IP_addresses: []
-primary_branch_only: false
-`,
-            stderr: `INFO: The IP allowlist has been reset. All databases on project "test_project" are now exposed to the internet`,
-        },
-    });
-    testCliCommand({
-        name: 'Reset IP allow to new list',
-        args: ['ip-allow', 'reset', '192.168.2.2', '--project-id', 'test'],
-        expected: {
-            snapshot: true,
-        },
-    });
-});