neonctl 1.37.0 → 2.1.0

package/analytics.js

@@ -3,7 +3,7 @@ import { join } from 'node:path';
 import { Analytics } from '@segment/analytics-node';
 import { isAxiosError } from 'axios';
 import { CREDENTIALS_FILE } from './config.js';
-import { isCi } from './env.js';
+import { getGithubEnvVars, isCi } from './env.js';
 import { log } from './log.js';
 import pkg from './pkg.js';
 import { getApiClient } from './api.js';
@@ -55,6 +55,7 @@ export const analyticsMiddleware = async (args) => {
                 output: args.output,
             },
             ci: isCi(),
+            githubEnvVars: getGithubEnvVars(process.env),
         },
     });
 };

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: {
@@ -239,17 +236,20 @@ const create = async (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();
@@ -352,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) {
@@ -359,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';
@@ -77,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',
@@ -126,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 you',
+            emptyMessage: 'No projects have been shared with you',
         });
     }
     out.end();
@@ -198,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/env.js

@@ -4,3 +4,39 @@ export const isCi = () => {
 export const isDebug = () => {
     return Boolean(process.env.DEBUG);
 };
+export const getGithubEnvVars = (env) => {
+    const vars = [
+        // github action info
+        'GITHUB_ACTION',
+        'GITHUB_ACTION_PATH',
+        'GITHUB_ACTION_REPOSITORY',
+        // source github repository and actor info
+        'GITHUB_REF_TYPE',
+        'GITHUB_REF',
+        'GITHUB_REF_NAME',
+        'GITHUB_BASE_REF',
+        'GITHUB_HEAD_REF',
+        'GITHUB_JOB',
+        'GITHUB_SHA',
+        'GITHUB_REPOSITORY',
+        'GITHUB_REPOSITORY_ID',
+        'GITHUB_REPOSITORY_OWNER',
+        'GITHUB_REPOSITORY_OWNER_ID',
+        'GITHUB_TRIGGERING_ACTOR',
+        'GITHUB_ACTOR',
+        'GITHUB_ACTOR_ID',
+        'GITHUB_EVENT_NAME',
+        'GITHUB_RUN_NUMBER',
+        // reusable workflow info
+        'GITHUB_WORKFLOW',
+        'GITHUB_WORKFLOW_REF',
+        'GITHUB_WORKFLOW_SHA',
+    ];
+    const map = new Map();
+    vars.forEach((v) => {
+        if (env[v]) {
+            map.set(v, env[v]);
+        }
+    });
+    return Object.fromEntries(map);
+};

package/env.test.js

@@ -0,0 +1,56 @@
+import { describe, it, expect } from 'vitest';
+import { getGithubEnvVars } from './env';
+describe('getGithubEnvVars', () => {
+    it('success all keys', () => {
+        const env = {
+            GITHUB_ACTION: '1',
+            GITHUB_ACTION_PATH: '2',
+            GITHUB_ACTION_REPOSITORY: '3',
+            GITHUB_REF_TYPE: '4',
+            GITHUB_REF: '5',
+            GITHUB_REF_NAME: '6',
+            GITHUB_BASE_REF: '7',
+            GITHUB_HEAD_REF: '8',
+            GITHUB_JOB: '9',
+            GITHUB_SHA: '10',
+            GITHUB_REPOSITORY: '11',
+            GITHUB_REPOSITORY_ID: '12',
+            GITHUB_REPOSITORY_OWNER: '13',
+            GITHUB_REPOSITORY_OWNER_ID: '14',
+            GITHUB_TRIGGERING_ACTOR: '15',
+            GITHUB_ACTOR: '16',
+            GITHUB_ACTOR_ID: '17',
+            GITHUB_EVENT_NAME: '18',
+            GITHUB_RUN_NUMBER: '19',
+            GITHUB_WORKFLOW: '20',
+            GITHUB_WORKFLOW_REF: '21',
+            GITHUB_WORKFLOW_SHA: '22',
+            unrelated: 'unrelated',
+        };
+        const ret = {
+            GITHUB_ACTION: '1',
+            GITHUB_ACTION_PATH: '2',
+            GITHUB_ACTION_REPOSITORY: '3',
+            GITHUB_REF_TYPE: '4',
+            GITHUB_REF: '5',
+            GITHUB_REF_NAME: '6',
+            GITHUB_BASE_REF: '7',
+            GITHUB_HEAD_REF: '8',
+            GITHUB_JOB: '9',
+            GITHUB_SHA: '10',
+            GITHUB_REPOSITORY: '11',
+            GITHUB_REPOSITORY_ID: '12',
+            GITHUB_REPOSITORY_OWNER: '13',
+            GITHUB_REPOSITORY_OWNER_ID: '14',
+            GITHUB_TRIGGERING_ACTOR: '15',
+            GITHUB_ACTOR: '16',
+            GITHUB_ACTOR_ID: '17',
+            GITHUB_EVENT_NAME: '18',
+            GITHUB_RUN_NUMBER: '19',
+            GITHUB_WORKFLOW: '20',
+            GITHUB_WORKFLOW_REF: '21',
+            GITHUB_WORKFLOW_SHA: '22',
+        };
+        expect(getGithubEnvVars(env)).toEqual(ret);
+    });
+});

package/package.json

@@ -5,7 +5,7 @@
     "url": "git+ssh://git@github.com/neondatabase/neonctl.git"
   },
   "type": "module",
-  "version": "1.37.0",
+  "version": "2.1.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: {