neonctl 1.29.1 → 1.29.3

package/commands/branches.test.js

@@ -0,0 +1,321 @@
+import { describe } from '@jest/globals';
+import { testCliCommand } from '../test_utils/test_cli_command.js';
+describe('branches', () => {
+    /* list */
+    testCliCommand({
+        name: 'list',
+        args: ['branches', 'list', '--project-id', 'test'],
+        expected: {
+            snapshot: true,
+        },
+    });
+    /* create */
+    testCliCommand({
+        name: 'create by default with r/w endpoint',
+        args: [
+            'branches',
+            'create',
+            '--project-id',
+            'test',
+            '--name',
+            'test_branch',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'create branch and connect with psql',
+        args: [
+            'branches',
+            'create',
+            '--project-id',
+            'test',
+            '--name',
+            'test_branch',
+            '--psql',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'create branch and connect with psql and psql args',
+        args: [
+            'branches',
+            'create',
+            '--project-id',
+            'test',
+            '--name',
+            'test_branch',
+            '--psql',
+            '--',
+            '-c',
+            'SELECT 1',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'create with readonly endpoint',
+        args: [
+            'branches',
+            'create',
+            '--project-id',
+            'test',
+            '--name',
+            'test_branch',
+            '--type',
+            'read_only',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'create without endpoint',
+        args: [
+            'branches',
+            'create',
+            '--project-id',
+            'test',
+            '--name',
+            'test_branch',
+            '--no-compute',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'create with parent by name',
+        args: [
+            'branches',
+            'create',
+            '--project-id',
+            'test',
+            '--name',
+            'test_branch_with_parent_name',
+            '--parent',
+            'main',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'create with parent by lsn',
+        args: [
+            'branches',
+            'create',
+            '--project-id',
+            'test',
+            '--name',
+            'test_branch_with_parent_lsn',
+            '--parent',
+            '0/123ABC',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'create with parent by timestamp',
+        args: [
+            'branches',
+            'create',
+            '--project-id',
+            'test',
+            '--name',
+            'test_branch_with_parent_timestamp',
+            '--parent',
+            '2021-01-01T00:00:00.000Z',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'create with suspend timeout',
+        args: [
+            'branches',
+            'create',
+            '--project-id',
+            'test',
+            '--name',
+            'test_branch_with_suspend_timeout',
+            '--suspend-timeout',
+            '60',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    /* delete */
+    testCliCommand({
+        name: 'delete by id',
+        args: [
+            'branches',
+            'delete',
+            'br-sunny-branch-123456',
+            '--project-id',
+            'test',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    /* rename */
+    testCliCommand({
+        name: 'rename',
+        args: [
+            'branches',
+            'rename',
+            'test_branch',
+            'new_test_branch',
+            '--project-id',
+            'test',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    /* set primary */
+    testCliCommand({
+        name: 'set primary by id',
+        args: [
+            'branches',
+            'set-primary',
+            'br-sunny-branch-123456',
+            '--project-id',
+            'test',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    /* get */
+    testCliCommand({
+        name: 'get by id',
+        args: ['branches', 'get', 'br-sunny-branch-123456', '--project-id', 'test'],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'get by id',
+        args: [
+            'branches',
+            'get',
+            'br-cloudy-branch-12345678',
+            '--project-id',
+            'test',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'get by name',
+        args: ['branches', 'get', 'test_branch', '--project-id', 'test'],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'get by name with numeric name',
+        args: ['branches', 'get', '123', '--project-id', 'test'],
+        expected: {
+            snapshot: true,
+        },
+    });
+    /* add compute */
+    testCliCommand({
+        name: 'add compute',
+        args: ['branches', 'add-compute', 'test_branch', '--project-id', 'test'],
+        expected: {
+            snapshot: true,
+        },
+    });
+    /* reset */
+    testCliCommand({
+        name: 'reset branch to parent',
+        args: [
+            'branches',
+            'reset',
+            'test_branch',
+            '--project-id',
+            'test',
+            '--parent',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    /* restore */
+    testCliCommand({
+        name: 'restore branch to lsn',
+        args: [
+            'branches',
+            'restore',
+            'br-self-tolsn-123456',
+            '^self@0/123ABC',
+            '--project-id',
+            'test',
+            '--preserve-under-name',
+            'backup',
+        ],
+        mockDir: 'restore',
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'restore to parent branch timestamp by name',
+        args: [
+            'branches',
+            'restore',
+            'parent-tots',
+            '^parent@2021-01-01T00:00:00.000Z',
+            '--project-id',
+            'test',
+        ],
+        mockDir: 'restore',
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'restore to another branch head',
+        args: [
+            'branches',
+            'restore',
+            'br-another-branch-123456',
+            'br-any-branch-123456',
+            '--project-id',
+            'test',
+        ],
+        mockDir: 'restore',
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'restore with unexisted branch outputs error',
+        args: [
+            'branches',
+            'restore',
+            'unexisting-branch',
+            '^parent',
+            '--project-id',
+            'test',
+        ],
+        mockDir: 'restore',
+        expected: {
+            code: 1,
+            stderr: `ERROR: Branch unexisting-branch not found.
+               Available branches: self-tolsn-123456, any-branch, parent-tots, another-branch`,
+        },
+    });
+});

package/commands/connection_string.js

@@ -0,0 +1,156 @@
+import { EndpointType } from '@neondatabase/api-client';
+import { branchIdFromProps, fillSingleProject } from '../utils/enrichers.js';
+import { writer } from '../writer.js';
+import { psql } from '../utils/psql.js';
+import { parsePITBranch } from '../utils/point_in_time.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]')
+        .example('$0 cs main', 'Get connection string for the main branch')
+        .example('$0 cs main@2024-01-01T00:00:00Z', 'Get connection string for the main branch at a specific point in time')
+        .example('$0 cs main@0/234235', 'Get connection string for the main branch at a specific LSN')
+        .positional('branch', {
+        describe: `Branch name or id. Defaults to the primary branch if omitted. Can be written in the point-in-time format: "branch@timestamp" or "branch@lsn"`,
+        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 parsedPIT = props.branch
+        ? parsePITBranch(props.branch)
+        : { tag: 'head', branch: '' };
+    if (props.branch) {
+        props.branch = parsedPIT.branch;
+    }
+    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);
+    let host = props.pooled
+        ? endpoint.host.replace(endpoint.id, `${endpoint.id}-pooler`)
+        : endpoint.host;
+    if (parsedPIT.tag !== 'head') {
+        host = endpoint.host.replace(endpoint.id, endpoint.branch_id);
+    }
+    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 (parsedPIT.tag === 'lsn') {
+        connectionString.searchParams.set('options', `neon_lsn:${parsedPIT.lsn}`);
+    }
+    else if (parsedPIT.tag === 'timestamp') {
+        connectionString.searchParams.set('options', `neon_timestamp:${parsedPIT.timestamp}`);
+    }
+    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

@@ -0,0 +1,236 @@
+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,
+        },
+    });
+    testCliCommand({
+        name: 'connection_string with lsn',
+        args: [
+            'connection-string',
+            'test_branch@0/123456',
+            '--project-id',
+            'test',
+            '--database-name',
+            'test_db',
+            '--role-name',
+            'test_role',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'connection_string with timestamp',
+        args: [
+            'connection-string',
+            'test_branch@2021-01-01T00:00:00Z',
+            '--project-id',
+            'test',
+            '--database-name',
+            'test_db',
+            '--role-name',
+            'test_role',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+});