neonctl 1.31.0 → 1.32.0

package/commands/bootstrap/index.test.js

@@ -0,0 +1,104 @@
+import { test, expect, describe, beforeAll, afterAll } from 'vitest';
+import { runMockServer } from '../../test_utils/mock_server.js';
+import { fork } from 'node:child_process';
+import { join } from 'node:path';
+import { log } from '../../log';
+describe('bootstrap/create-app', () => {
+    let server;
+    const mockDir = 'main';
+    beforeAll(async () => {
+        server = await runMockServer(mockDir);
+    });
+    afterAll(async () => {
+        return new Promise((resolve) => {
+            server.close(() => {
+                resolve();
+            });
+        });
+    });
+    // We create an app without a schema and without deploying it, as
+    // a very simple check that the CLI works. Eventually, we need
+    // to have a much more complete test suite that actually verifies
+    // that launching all different app combinations works.
+    test.skip('very simple CLI interaction test', async () => {
+        // Most of this forking code is copied from `test_cli_command.ts`.
+        const cp = fork(join(process.cwd(), './dist/index.js'), [
+            '--api-host',
+            `http://localhost:${server.address().port}`,
+            '--output',
+            'yaml',
+            '--api-key',
+            'test-key',
+            '--no-analytics',
+            'create-app',
+        ], {
+            stdio: 'pipe',
+            env: {
+                PATH: `mocks/bin:${process.env.PATH}`,
+            },
+        });
+        process.on('SIGINT', () => {
+            cp.kill();
+        });
+        let neonProjectCreated = false;
+        return new Promise((resolve, reject) => {
+            cp.stdout?.on('data', (data) => {
+                const stdout = data.toString();
+                log.info(stdout);
+                // For some unknown, weird reason, when we send TAB clicks (\t),
+                // they only affect the next question. So, we send TAB below
+                // in order to affect the answer to the following prompt, not the
+                // current one.
+                if (stdout.includes('What is your project named')) {
+                    cp.stdin?.write('my-app\n');
+                }
+                else if (stdout.includes('Which package manager would you like to use')) {
+                    cp.stdin?.write('\n');
+                }
+                else if (stdout.includes('What framework would you like to use')) {
+                    cp.stdin?.write('\n');
+                }
+                else if (stdout.includes('What ORM would you like to use')) {
+                    cp.stdin?.write('\t'); // change auth.js
+                    cp.stdin?.write('\n');
+                }
+                else if (stdout.includes('What authentication framework do you want to use')) {
+                    cp.stdin?.write('\n');
+                }
+                else if (stdout.includes('What Neon project would you like to use')) {
+                    neonProjectCreated = true;
+                    cp.stdin?.write('\t'); // change deployment
+                    cp.stdin?.write('\t');
+                    cp.stdin?.write('\n');
+                }
+                else if (stdout.includes('Where would you like to deploy')) {
+                    cp.stdin?.write('\n');
+                    cp.stdin?.write('\n');
+                }
+            });
+            cp.stderr?.on('data', (data) => {
+                log.error(data.toString());
+            });
+            cp.on('error', (err) => {
+                throw err;
+            });
+            cp.on('close', (code) => {
+                // If we got to the point that a Neon project was successfully
+                // created, we consider the test run to be a success. We can't
+                // currently check that the template is properly generated, and that
+                // the project runs. We'll have to do that with containerization in
+                // the future, most likely.
+                if (neonProjectCreated) {
+                    resolve();
+                }
+                try {
+                    expect(code).toBe(0);
+                    resolve();
+                }
+                catch (err) {
+                    reject(err);
+                }
+            });
+        });
+    }, 1000 * 60 * 5);
+});

package/commands/bootstrap/is-folder-empty.js

@@ -0,0 +1,56 @@
+// Code copied from `create-next-app`.
+import { lstatSync, readdirSync } from 'node:fs';
+import { join } from 'node:path';
+import chalk from 'chalk';
+// `isFolderEmpty` checks if a folder is empty and ready to onboard a Next.js package into it.
+// It will actually log to stdout as part of its execution.
+export function isFolderEmpty(root, name, writeStdout) {
+    const validFiles = new Set([
+        '.DS_Store',
+        '.git',
+        '.gitattributes',
+        '.gitignore',
+        '.gitlab-ci.yml',
+        '.hg',
+        '.hgcheck',
+        '.hgignore',
+        '.idea',
+        '.npmignore',
+        '.travis.yml',
+        'LICENSE',
+        'Thumbs.db',
+        'docs',
+        'mkdocs.yml',
+        'npm-debug.log',
+        'yarn-debug.log',
+        'yarn-error.log',
+        'yarnrc.yml',
+        '.yarn',
+    ]);
+    const conflicts = readdirSync(root).filter((file) => !validFiles.has(file) &&
+        // Support IntelliJ IDEA-based editors
+        !/\.iml$/.test(file));
+    if (conflicts.length > 0) {
+        writeStdout(`The directory ${chalk.green(name)} contains files that could conflict:\n`);
+        writeStdout('');
+        for (const file of conflicts) {
+            try {
+                const stats = lstatSync(join(root, file));
+                if (stats.isDirectory()) {
+                    writeStdout(`  ${chalk.blue(file)}/\n`);
+                }
+                else {
+                    writeStdout(`  ${file}\n`);
+                }
+            }
+            catch {
+                writeStdout(`  ${file}\n`);
+            }
+        }
+        writeStdout('\n');
+        writeStdout('Either try using a new directory name, or remove the files listed above.\n');
+        writeStdout('\n');
+        return false;
+    }
+    return true;
+}

package/commands/bootstrap/validate-pkg.js

@@ -0,0 +1,15 @@
+// Code copied from `create-next-app`.
+import validateProjectName from 'validate-npm-package-name';
+export function validateNpmName(name) {
+    const nameValidation = validateProjectName(name);
+    if (nameValidation.validForNewPackages) {
+        return { valid: true };
+    }
+    return {
+        valid: false,
+        problems: [
+            ...(nameValidation.errors || []),
+            ...(nameValidation.warnings || []),
+        ],
+    };
+}

package/commands/branches.js

@@ -8,6 +8,7 @@ import { psql } from '../utils/psql.js';
 import { parsePointInTime } from '../utils/point_in_time.js';
 import { log } from '../log.js';
 import { parseSchemaDiffParams, schemaDiff } from './schema_diff.js';
+import { getComputeUnits } from '../utils/compute_units.js';
 const BRANCH_FIELDS = [
     'id',
     'name',
@@ -61,6 +62,11 @@ export const builder = (argv) => argv
         implies: 'compute',
         default: 0,
     },
+    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',
+        implies: 'compute',
+    },
     psql: {
         type: 'boolean',
         describe: 'Connect to a new branch via psql',
@@ -119,6 +125,10 @@ export const builder = (argv) => argv
         describe: 'Type of compute to add',
         default: EndpointType.ReadOnly,
     },
+    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',
+    },
 }), async (args) => await addCompute(args))
     .command('delete <id|name>', 'Delete a branch', (yargs) => yargs, async (args) => await deleteBranch(args))
     .command('get <id|name>', 'Get a branch', (yargs) => yargs, async (args) => await get(args))
@@ -213,6 +223,7 @@ const create = async (props) => {
                 {
                     type: props.type,
                     suspend_timeout_seconds: props.suspendTimeout === 0 ? undefined : props.suspendTimeout,
+                    ...(props.cu ? getComputeUnits(props.cu) : undefined),
                 },
             ]
             : [],
@@ -282,6 +293,7 @@ const addCompute = async (props) => {
         endpoint: {
             branch_id: branchId,
             type: props.type,
+            ...(props.cu ? getComputeUnits(props.cu) : undefined),
         },
     }));
     writer(props).end(data.endpoint, {

package/commands/branches.test.js

@@ -1,4 +1,4 @@
-import { describe } from '@jest/globals';
+import { describe } from 'vitest';
 import { testCliCommand } from '../test_utils/test_cli_command.js';
 describe('branches', () => {
     /* list */
@@ -152,6 +152,38 @@ describe('branches', () => {
             snapshot: true,
         },
     });
+    testCliCommand({
+        name: 'create with fixed size CU',
+        args: [
+            'branches',
+            'create',
+            '--project-id',
+            'test',
+            '--name',
+            'test_branch_with_fixed_cu',
+            '--cu',
+            '2',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'create with autoscaled CU',
+        args: [
+            'branches',
+            'create',
+            '--project-id',
+            'test',
+            '--name',
+            'test_branch_with_autoscaling',
+            '--cu',
+            '0.5-2',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
     /* delete */
     testCliCommand({
         name: 'delete by id',
@@ -252,6 +284,36 @@ describe('branches', () => {
             snapshot: true,
         },
     });
+    testCliCommand({
+        name: 'add compute with fixed size CU',
+        args: [
+            'branches',
+            'add-compute',
+            'test_branch_with_fixed_cu',
+            '--project-id',
+            'test',
+            '--cu',
+            '2',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'add compute with autoscaled CU',
+        args: [
+            'branches',
+            'add-compute',
+            'test_branch_with_autoscaling',
+            '--project-id',
+            'test',
+            '--cu',
+            '0.5-2',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
     /* reset */
     testCliCommand({
         name: 'reset branch to parent',

package/commands/connection_string.test.js

@@ -1,4 +1,4 @@
-import { describe, expect } from '@jest/globals';
+import { describe, expect } from 'vitest';
 import { testCliCommand } from '../test_utils/test_cli_command';
 describe('connection_string', () => {
     testCliCommand({

package/commands/databases.test.js

@@ -1,4 +1,4 @@
-import { describe } from '@jest/globals';
+import { describe } from 'vitest';
 import { testCliCommand } from '../test_utils/test_cli_command.js';
 describe('databases', () => {
     testCliCommand({

package/commands/help.test.js

@@ -1,4 +1,4 @@
-import { describe, expect } from '@jest/globals';
+import { describe, expect } from 'vitest';
 import { testCliCommand } from '../test_utils/test_cli_command.js';
 describe('help', () => {
     testCliCommand({

package/commands/index.js

@@ -9,6 +9,7 @@ import * as roles from './roles.js';
 import * as operations from './operations.js';
 import * as cs from './connection_string.js';
 import * as setContext from './set_context.js';
+import * as bootstrap from './bootstrap/index.js';
 export default [
     auth,
     users,
@@ -21,4 +22,5 @@ export default [
     operations,
     cs,
     setContext,
+    bootstrap,
 ];

package/commands/ip_allow.js

@@ -6,7 +6,7 @@ const IP_ALLOW_FIELDS = [
     'id',
     'name',
     'IP_addresses',
-    'primary_branch_only',
+    'protected_branches_only',
 ];
 export const command = 'ip-allow';
 export const describe = 'Manage IP Allow';
@@ -30,11 +30,18 @@ export const builder = (argv) => {
         type: 'string',
         default: [],
         array: true,
+    })
+        .options({
+        'protected-only': {
+            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);
@@ -77,6 +84,9 @@ const add = async (props) => {
         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,
         },
     };
     const { data: response } = await props.apiClient.updateProject(props.projectId, {
@@ -97,6 +107,7 @@ const remove = async (props) => {
         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,
         },
     };
     const { data: response } = await props.apiClient.updateProject(props.projectId, {
@@ -112,6 +123,7 @@ const reset = async (props) => {
         allowed_ips: {
             ips: props.ips,
             primary_branch_only: false,
+            protected_branches_only: false,
         },
     };
     const { data } = await props.apiClient.updateProject(props.projectId, {
@@ -131,5 +143,6 @@ const parse = (project) => {
         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

@@ -1,4 +1,4 @@
-import { describe } from '@jest/globals';
+import { describe } from 'vitest';
 import { testCliCommand } from '../test_utils/test_cli_command.js';
 describe('ip-allow', () => {
     testCliCommand({
@@ -26,7 +26,7 @@ describe('ip-allow', () => {
         },
     });
     testCliCommand({
-        name: 'Add IP allow',
+        name: 'Add IP allow - Primary',
         args: [
             'ip-allow',
             'add',
@@ -40,6 +40,21 @@ describe('ip-allow', () => {
             snapshot: true,
         },
     });
+    testCliCommand({
+        name: 'Add IP allow - Protected',
+        args: [
+            'ip-allow',
+            'add',
+            '127.0.0.1',
+            '192.168.10.1-192.168.10.15',
+            '--protected-only',
+            '--project-id',
+            'test',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
     testCliCommand({
         name: 'Remove IP allow - Error',
         args: ['ip-allow', 'remove', '--project-id', 'test'],
@@ -64,6 +79,7 @@ describe('ip-allow', () => {
 name: test_project
 IP_addresses: []
 primary_branch_only: false
+protected_branches_only: false
 `,
             stderr: `INFO: The IP allowlist has been reset. All databases on project "test_project" are now exposed to the internet`,
         },

package/commands/operations.test.js

@@ -1,4 +1,4 @@
-import { describe } from '@jest/globals';
+import { describe } from 'vitest';
 import { testCliCommand } from '../test_utils/test_cli_command.js';
 describe('operations', () => {
     testCliCommand({

package/commands/orgs.test.js

@@ -0,0 +1,11 @@
+import { describe } from 'vitest';
+import { testCliCommand } from '../test_utils/test_cli_command.js';
+describe('orgs', () => {
+    testCliCommand({
+        name: 'list',
+        args: ['orgs', 'list'],
+        expected: {
+            snapshot: true,
+        },
+    });
+});

package/commands/projects.js

@@ -3,7 +3,13 @@ import { projectCreateRequest, projectUpdateRequest, } from '../parameters.gen.j
 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'];
+import { getComputeUnits } from '../utils/compute_units.js';
+export const PROJECT_FIELDS = [
+    'id',
+    'name',
+    'region_id',
+    'created_at',
+];
 const REGIONS = [
     'aws-us-west-2',
     'aws-ap-southeast-1',
@@ -48,6 +54,10 @@ export const builder = (argv) => {
             describe: 'Set the current context to the new project',
             default: false,
         },
+        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',
+        },
     }), async (args) => {
         await create(args);
     })
@@ -68,6 +78,10 @@ export const builder = (argv) => {
             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',
+        },
     }), async (args) => {
         await update(args);
     })
@@ -130,13 +144,17 @@ const create = async (props) => {
     if (props.role) {
         project.branch.role_name = props.role;
     }
+    if (props.cu) {
+        project.default_endpoint_settings = props.cu
+            ? getComputeUnits(props.cu)
+            : undefined;
+    }
     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);
@@ -175,6 +193,11 @@ const update = async (props) => {
             },
         };
     }
+    if (props.cu) {
+        project.default_endpoint_settings = props.cu
+            ? getComputeUnits(props.cu)
+            : undefined;
+    }
     const { data } = await props.apiClient.updateProject(props.id, {
         project,
     });

package/commands/projects.test.js

@@ -1,4 +1,4 @@
-import { afterAll, describe, expect, test } from '@jest/globals';
+import { afterAll, describe, expect, test } from 'vitest';
 import { readFileSync, rmSync } from 'node:fs';
 import { tmpdir } from 'node:os';
 import { join } from 'node:path';
@@ -73,6 +73,34 @@ describe('projects', () => {
             snapshot: true,
         },
     });
+    testCliCommand({
+        name: 'create project with default fixed size CU',
+        args: [
+            'projects',
+            'create',
+            '--name',
+            'test_project_with_fixed_cu',
+            '--cu',
+            '2',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'create project with default autoscaled CU',
+        args: [
+            'projects',
+            'create',
+            '--name',
+            'test_project_with_autoscaling',
+            '--cu',
+            '0.5-2',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
     afterAll(() => {
         rmSync(CONTEXT_FILE);
     });
@@ -122,6 +150,26 @@ describe('projects', () => {
             snapshot: true,
         },
     });
+    testCliCommand({
+        name: 'update project with default fixed size CU',
+        args: ['projects', 'update', 'test_project_with_fixed_cu', '--cu', '2'],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'update project with default autoscaled CU',
+        args: [
+            'projects',
+            'update',
+            'test_project_with_autoscaling',
+            '--cu',
+            '0.5-2',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
     testCliCommand({
         name: 'get',
         args: ['projects', 'get', 'test'],

package/commands/roles.test.js

@@ -1,4 +1,4 @@
-import { describe } from '@jest/globals';
+import { describe } from 'vitest';
 import { testCliCommand } from '../test_utils/test_cli_command.js';
 describe('roles', () => {
     testCliCommand({

package/commands/set_context.test.js

@@ -1,7 +1,7 @@
 import { tmpdir } from 'node:os';
 import { join } from 'node:path';
 import { rmSync, writeFileSync } from 'node:fs';
-import { afterAll, describe } from '@jest/globals';
+import { afterAll, describe } from 'vitest';
 import { testCliCommand } from '../test_utils/test_cli_command';
 const CONTEXT_FILE = join(tmpdir(), `neon_${Date.now()}`);
 describe('set_context', () => {

package/index.js

@@ -26,11 +26,16 @@ import { matchErrorCode } from './errors.js';
 import { showHelp } from './help.js';
 import { currentContextFile, enrichFromContext } from './context.js';
 const NO_SUBCOMMANDS_VERBS = [
+    // aliases
     'auth',
     'me',
+    // aliases
     'cs',
     'connection-string',
     'set-context',
+    // aliases
+    'create-app',
+    'bootstrap',
 ];
 let builder = yargs(hideBin(process.argv));
 builder = builder