neonctl 1.36.0 → 2.0.0

package/commands/bootstrap/index.js

@@ -495,7 +495,7 @@ const bootstrap = async (props) => {
     let projectCreateRequest;
     let project;
     let devConnectionString;
-    const devBranchName = `dev-${cryptoRandomString({
+    const devBranchName = `dev/${cryptoRandomString({
         length: 10,
         type: 'url-safe',
     })}`;

package/commands/branches.js

@@ -12,7 +12,6 @@ import { getComputeUnits } from '../utils/compute_units.js';
 export const BRANCH_FIELDS = [
     'id',
     'name',
-    'primary',
     'default',
     'created_at',
     'updated_at',
@@ -20,7 +19,6 @@ export const BRANCH_FIELDS = [
 const BRANCH_FIELDS_RESET = [
     'id',
     'name',
-    'primary',
     'default',
     'created_at',
     'last_reset_at',
@@ -121,7 +119,6 @@ export const builder = (argv) => argv
     ],
 ]), (args) => restore(args))
     .command('rename <id|name> <new-name>', 'Rename a branch', (yargs) => yargs, (args) => rename(args))
-    .command('set-primary <id|name>', 'DEPRECATED: Use set-default. Set a branch as primary', (yargs) => yargs, (args) => setDefault(args))
     .command('set-default <id|name>', 'Set a branch as default', (yargs) => yargs, (args) => setDefault(args))
     .command('add-compute <id|name>', 'Add a compute to a branch', (yargs) => yargs.options({
     type: {
@@ -187,17 +184,16 @@ const list = async (props) => {
     });
 };
 const create = async (props) => {
-    const parentProps = await (() => {
+    const branches = await props.apiClient
+        .listProjectBranches(props.projectId)
+        .then(({ data }) => data.branches);
+    const parentProps = (() => {
         if (!props.parent) {
-            return props.apiClient
-                .listProjectBranches(props.projectId)
-                .then(({ data }) => {
-                const branch = data.branches.find((b) => b.default);
-                if (!branch) {
-                    throw new Error('No default branch found');
-                }
-                return { parent_id: branch.id };
-            });
+            const branch = branches.find((b) => b.default);
+            if (!branch) {
+                throw new Error('No default branch found');
+            }
+            return { parent_id: branch.id };
         }
         if (looksLikeLSN(props.parent)) {
             return { parent_lsn: props.parent };
@@ -208,15 +204,11 @@ const create = async (props) => {
         if (looksLikeBranchId(props.parent)) {
             return { parent_id: props.parent };
         }
-        return props.apiClient
-            .listProjectBranches(props.projectId)
-            .then(({ data }) => {
-            const branch = data.branches.find((b) => b.name === props.parent);
-            if (!branch) {
-                throw new Error(`Branch ${props.parent} not found`);
-            }
-            return { parent_id: branch.id };
-        });
+        const branch = branches.find((b) => b.name === props.parent);
+        if (!branch) {
+            throw new Error(`Branch ${props.parent} not found`);
+        }
+        return { parent_id: branch.id };
     })();
     const { data } = await retryOnLock(() => props.apiClient.createProjectBranch(props.projectId, {
         branch: {
@@ -236,21 +228,28 @@ const create = async (props) => {
             ? JSON.parse(props.annotation)
             : undefined,
     }));
+    const parent = branches.find((b) => b.id === data.branch.parent_id);
+    if (parent?.protected) {
+        log.warning('The parent branch is protected; a unique role password has been generated for the new branch.');
+    }
     const out = writer(props);
     out.write(data.branch, {
         fields: BRANCH_FIELDS,
         title: 'branch',
+        emptyMessage: 'No branches have been found.',
     });
     if (data.endpoints?.length > 0) {
         out.write(data.endpoints, {
             fields: ['id', 'created_at'],
             title: 'endpoints',
+            emptyMessage: 'No endpoints have been found.',
         });
     }
     if (data.connection_uris?.length) {
         out.write(data.connection_uris, {
             fields: ['connection_uri'],
             title: 'connection_uris',
+            emptyMessage: 'No connection uris have been found',
         });
     }
     out.end();
@@ -353,6 +352,7 @@ const restore = async (props) => {
     const writeInst = writer(props).write(data.branch, {
         title: 'Restored branch',
         fields: ['id', 'name', 'last_reset_at'],
+        emptyMessage: 'No branches have been restored.',
     });
     const parentId = data.branch.parent_id;
     if (props.preserveUnderName && parentId) {
@@ -360,6 +360,7 @@ const restore = async (props) => {
         writeInst.write(data.branch, {
             title: 'Backup branch',
             fields: ['id', 'name'],
+            emptyMessage: 'Backup branch has not been found.',
         });
     }
     writeInst.end();

package/commands/branches.test.js

@@ -157,16 +157,6 @@ describe('branches', () => {
             'test',
         ]);
     });
-    /* set primary */
-    test('set primary by id', async ({ testCliCommand }) => {
-        await testCliCommand([
-            'branches',
-            'set-primary',
-            'br-sunny-branch-123456',
-            '--project-id',
-            'test',
-        ]);
-    });
     /* set default */
     test('set default by id', async ({ testCliCommand }) => {
         await testCliCommand([

package/commands/ip_allow.js

@@ -36,13 +36,6 @@ export const builder = (argv) => {
             describe: projectUpdateRequest['project.settings.allowed_ips.protected_branches_only'].description,
             type: 'boolean',
         },
-    })
-        .options({
-        'primary-only': {
-            describe: projectUpdateRequest['project.settings.allowed_ips.primary_branch_only'].description,
-            type: 'boolean',
-            deprecated: 'See --protected-only',
-        },
     }), async (args) => {
         await add(args);
     })
@@ -83,7 +76,6 @@ const add = async (props) => {
     project.settings = {
         allowed_ips: {
             ips: [...new Set(props.ips.concat(existingAllowedIps?.ips ?? []))],
-            primary_branch_only: props.primaryOnly ?? existingAllowedIps?.primary_branch_only ?? false,
             protected_branches_only: props.protectedOnly ??
                 existingAllowedIps?.protected_branches_only ??
                 false,
@@ -106,7 +98,6 @@ const remove = async (props) => {
     project.settings = {
         allowed_ips: {
             ips: existingAllowedIps?.ips?.filter((ip) => !props.ips.includes(ip)) ?? [],
-            primary_branch_only: existingAllowedIps?.primary_branch_only ?? false,
             protected_branches_only: existingAllowedIps?.protected_branches_only ?? false,
         },
     };
@@ -122,7 +113,6 @@ const reset = async (props) => {
     project.settings = {
         allowed_ips: {
             ips: props.ips,
-            primary_branch_only: false,
             protected_branches_only: false,
         },
     };
@@ -142,7 +132,6 @@ const parse = (project) => {
         id: project.id,
         name: project.name,
         IP_addresses: ips,
-        primary_branch_only: project.settings?.allowed_ips?.primary_branch_only ?? false,
         protected_branches_only: project.settings?.allowed_ips?.protected_branches_only ?? false,
     };
 };

package/commands/ip_allow.test.js

@@ -16,17 +16,6 @@ describe('ip-allow', () => {
          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>`,
         });
     });
-    test('Add IP allow - Primary', async ({ testCliCommand }) => {
-        await testCliCommand([
-            'ip-allow',
-            'add',
-            '127.0.0.1',
-            '192.168.10.1-192.168.10.15',
-            '--primary-only',
-            '--project-id',
-            'test',
-        ]);
-    });
     test('Add IP allow - Protected', async ({ testCliCommand }) => {
         await testCliCommand([
             'ip-allow',

package/commands/orgs.js

@@ -18,6 +18,7 @@ const list = async (props) => {
     out.write(organizations, {
         fields: ORG_FIELDS,
         title: 'Organizations',
+        emptyMessage: 'You are not a member of any organization.',
     });
     out.end();
 };

package/commands/projects.js

@@ -1,5 +1,5 @@
 import { log } from '../log.js';
-import { projectCreateRequest, projectUpdateRequest, } from '../parameters.gen.js';
+import { projectCreateRequest } from '../parameters.gen.js';
 import { writer } from '../writer.js';
 import { psql } from '../utils/psql.js';
 import { updateContextFile } from '../context.js';
@@ -13,9 +13,11 @@ export const PROJECT_FIELDS = [
 const REGIONS = [
     'aws-us-west-2',
     'aws-ap-southeast-1',
+    'aws-ap-southeast-2',
     'aws-eu-central-1',
     'aws-us-east-2',
     'aws-us-east-1',
+    'azure-eastus2',
 ];
 const PROJECTS_LIST_LIMIT = 100;
 export const command = 'projects';
@@ -75,18 +77,6 @@ export const builder = (argv) => {
             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",
-        },
         cu: {
             describe: 'The number of Compute Units. Could be a fixed size (e.g. "2") or a range delimited by a dash (e.g. "0.5-3").',
             type: 'string',
@@ -124,19 +114,21 @@ const list = async (props) => {
         }
         return result;
     };
-    const ownedProjects = getList(props.apiClient.listProjects);
+    const ownedProjects = await getList(props.apiClient.listProjects);
     const sharedProjects = props.orgId
-        ? undefined
-        : getList(props.apiClient.listSharedProjects);
+        ? []
+        : await getList(props.apiClient.listSharedProjects);
     const out = writer(props);
-    out.write(await ownedProjects, {
+    out.write(ownedProjects, {
         fields: PROJECT_FIELDS,
         title: 'Projects',
+        emptyMessage: "You don't have any projects yet. See how to create a new project:\n> neonctl projects create --help",
     });
-    if (sharedProjects) {
-        out.write(await sharedProjects, {
+    if (!props.orgId) {
+        out.write(sharedProjects, {
             fields: PROJECT_FIELDS,
-            title: 'Shared with me',
+            title: 'Shared with you',
+            emptyMessage: 'No projects have been shared with you',
         });
     }
     out.end();
@@ -196,18 +188,6 @@ const update = async (props) => {
     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,
-            },
-        };
-    }
     if (props.cu) {
         project.default_endpoint_settings = props.cu
             ? getComputeUnits(props.cu)

package/commands/projects.test.js

@@ -102,29 +102,6 @@ describe('projects', () => {
             'test_project_new_name',
         ]);
     });
-    test('update ip allow', async ({ testCliCommand }) => {
-        await testCliCommand([
-            'projects',
-            'update',
-            'test',
-            '--ip-allow',
-            '127.0.0.1',
-            '192.168.1.2/22',
-            '--ip-primary-only',
-        ]);
-    });
-    test('update ip allow primary only flag', async ({ testCliCommand }) => {
-        await testCliCommand([
-            'projects',
-            'update',
-            'test',
-            '--ip-primary-only',
-            'false',
-        ]);
-    });
-    test('update ip allow remove', async ({ testCliCommand }) => {
-        await testCliCommand(['projects', 'update', 'test', '--ip-allow']);
-    });
     test('update project with default fixed size CU', async ({ testCliCommand, }) => {
         await testCliCommand([
             'projects',

package/index.js

@@ -137,6 +137,7 @@ builder = builder
     default: true,
 })
     .middleware(analyticsMiddleware, true)
+    .version(pkg.version)
     .group('version', 'Global options:')
     .alias('version', 'v')
     .completion()

package/log.js

@@ -6,6 +6,9 @@ export const log = {
             process.stderr.write(`DEBUG: ${format(...args)}\n`);
         }
     },
+    warning: (...args) => {
+        process.stderr.write(`WARNING: ${format(...args)}\n`);
+    },
     info: (...args) => {
         process.stderr.write(`INFO: ${format(...args)}\n`);
     },

package/package.json

@@ -5,7 +5,7 @@
     "url": "git+ssh://git@github.com/neondatabase/neonctl.git"
   },
   "type": "module",
-  "version": "1.36.0",
+  "version": "2.0.0",
   "description": "CLI tool for NeonDB Cloud management",
   "main": "index.js",
   "author": "NeonDB",

package/writer.js

@@ -22,6 +22,10 @@ const writeJson = (chunks) => {
 const writeTable = (chunks, out) => {
     chunks.forEach(({ data, config }) => {
         const arrayData = Array.isArray(data) ? data : [data];
+        if (!arrayData.length && config.emptyMessage) {
+            out.write('\n' + config.emptyMessage + '\n');
+            return;
+        }
         const fields = config.fields.filter((field) => arrayData.some((item) => item[field] !== undefined && item[field] !== ''));
         const table = new Table({
             style: {