neonctl 1.21.3 → 1.23.0

package/analytics.js

@@ -9,7 +9,7 @@ import pkg from './pkg.js';
 const WRITE_KEY = '3SQXn5ejjXWLEJ8xU2PRYhAotLtTaeeV';
 let client;
 let userId = '';
-export const analyticsMiddleware = (args) => {
+export const analyticsMiddleware = async (args) => {
     if (!args.analytics) {
         return;
     }
@@ -40,7 +40,7 @@ export const analyticsMiddleware = (args) => {
             ci: isCi(),
         },
     });
-    client.closeAndFlush();
+    await client.closeAndFlush();
     log.debug('Sent CLI started event with userId: %s', userId);
 };
 export const sendError = (err, errCode) => {

package/callback.html

@@ -14,6 +14,14 @@ body, html {
   flex-direction: column;
   justify-content: center;
   align-items: center;
+  background-color: #ffffff;
+  color: #2d374c;
+}
+@media (prefers-color-scheme: dark) {
+  body, html {
+    background-color: #191919;
+    color: #bfbfbf;
+  }
 }
 .logo {
   display: inline-block;
@@ -32,6 +40,6 @@ svg {
     </div>
     <h1>Thank you for using Neon</h1>
     <p>
-        You may close the page now
+        You may close this page now
     </p>
 </body>

package/commands/help.test.js

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

package/commands/index.js

@@ -6,6 +6,7 @@ import * as databases from './databases.js';
 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';
 export default [
     auth,
     users,
@@ -15,4 +16,5 @@ export default [
     roles,
     operations,
     cs,
+    setContext,
 ];

package/commands/projects.js

@@ -3,6 +3,7 @@ import { log } from '../log.js';
 import { projectCreateRequest } from '../parameters.gen.js';
 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'];
 const REGIONS = [
     'aws-us-west-2',
@@ -10,6 +11,7 @@ const REGIONS = [
     'aws-eu-central-1',
     'aws-us-east-2',
     'aws-us-east-1',
+    'aws-il-central-1',
 ];
 const PROJECTS_LIST_LIMIT = 100;
 export const command = 'projects';
@@ -36,6 +38,11 @@ export const builder = (argv) => {
             describe: 'Connect to a new project via psql',
             default: false,
         },
+        'set-context': {
+            type: 'boolean',
+            describe: 'Set the current context to the new project',
+            default: false,
+        },
     }), async (args) => {
         await create(args);
     })
@@ -86,6 +93,12 @@ const create = async (props) => {
     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);
     out.write(data.project, { fields: PROJECT_FIELDS, title: 'Project' });
     out.write(data.connection_uris, {

package/commands/projects.test.js

@@ -1,5 +1,9 @@
-import { describe } from '@jest/globals';
+import { afterAll, describe, expect, test } from '@jest/globals';
+import { readFileSync, rmSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
 import { testCliCommand } from '../test_utils/test_cli_command.js';
+const CONTEXT_FILE = join(tmpdir(), `neon_project_create_ctx_${Date.now()}`);
 describe('projects', () => {
     testCliCommand({
         name: 'list',
@@ -24,11 +28,41 @@ describe('projects', () => {
     });
     testCliCommand({
         name: 'create and connect with psql and psql args',
-        args: ['projects', 'create', '--name', 'test_project', '--psql', '--', '-c', 'SELECT 1'],
+        args: [
+            'projects',
+            'create',
+            '--name',
+            'test_project',
+            '--psql',
+            '--',
+            '-c',
+            'SELECT 1',
+        ],
         expected: {
             snapshot: true,
         },
     });
+    testCliCommand({
+        name: 'create project with setting the context',
+        args: [
+            'projects',
+            'create',
+            '--name',
+            'test_project',
+            '--context-file',
+            CONTEXT_FILE,
+            '--set-context',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    afterAll(() => {
+        rmSync(CONTEXT_FILE);
+    });
+    test('context file should exist and contain the project id', () => {
+        expect(readFileSync(CONTEXT_FILE, 'utf-8')).toContain('new-project-123456');
+    });
     testCliCommand({
         name: 'delete',
         args: ['projects', 'delete', 'test'],

package/commands/set_context.js

@@ -0,0 +1,27 @@
+import yargs from 'yargs';
+import { showHelpMiddleware } from '../help.js';
+import { updateContextFile } from '../context.js';
+import { branchIdFromProps } from '../utils/enrichers.js';
+export const command = 'set-context';
+export const describe = 'Set the current context';
+export const builder = (argv) => argv
+    .middleware(showHelpMiddleware(yargs, true))
+    .usage('$0 set-context [options]')
+    .options({
+    'project-id': {
+        describe: 'Project ID',
+        type: 'string',
+    },
+    branch: {
+        describe: 'Branch ID or name',
+        type: 'string',
+    },
+});
+export const handler = async (props) => {
+    const branchId = await branchIdFromProps(props);
+    const context = {
+        projectId: props.projectId,
+        branchId,
+    };
+    updateContextFile(props.contextFile, context);
+};

package/commands/set_context.test.js

@@ -0,0 +1,30 @@
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
+import { rmSync } from 'node:fs';
+import { afterAll, describe } from '@jest/globals';
+import { testCliCommand } from '../test_utils/test_cli_command';
+const CONTEXT_FILE = join(tmpdir(), `neon_${Date.now()}`);
+describe('set_context', () => {
+    afterAll(() => {
+        rmSync(CONTEXT_FILE);
+    });
+    describe('should set the context', () => {
+        testCliCommand({
+            name: 'set-context',
+            args: [
+                'set-context',
+                '--project-id',
+                'test',
+                '--context-file',
+                CONTEXT_FILE,
+            ],
+        });
+        testCliCommand({
+            name: 'list branches selecting project from the context',
+            args: ['branches', 'list', '--context-file', CONTEXT_FILE],
+            expected: {
+                snapshot: true,
+            },
+        });
+    });
+});

package/context.js

@@ -0,0 +1,48 @@
+import { accessSync, readFileSync, writeFileSync } from 'node:fs';
+import { homedir } from 'node:os';
+import { normalize, resolve } from 'node:path';
+const CONTEXT_FILE = '.neon';
+const CHECK_FILES = [CONTEXT_FILE, 'package.json', '.git'];
+const wrapWithContextFile = (dir) => resolve(dir, CONTEXT_FILE);
+export const currentContextFile = () => {
+    const cwd = process.cwd();
+    let currentDir = cwd;
+    const root = normalize('/');
+    const home = homedir();
+    while (currentDir !== root && currentDir !== home) {
+        for (const file of CHECK_FILES) {
+            try {
+                accessSync(resolve(currentDir, file));
+                return wrapWithContextFile(currentDir);
+            }
+            catch (e) {
+                // ignore
+            }
+        }
+        currentDir = resolve(currentDir, '..');
+    }
+    return wrapWithContextFile(cwd);
+};
+export const readContextFile = (file) => {
+    try {
+        return JSON.parse(readFileSync(file, 'utf-8'));
+    }
+    catch (e) {
+        return {};
+    }
+};
+export const enrichFromContext = (args) => {
+    if (args._[0] === 'set-context') {
+        return;
+    }
+    const context = readContextFile(args.contextFile);
+    if (!args.branch) {
+        args.branch = context.branchId;
+    }
+    if (!args.projectId) {
+        args.projectId = context.projectId;
+    }
+};
+export const updateContextFile = (file, context) => {
+    writeFileSync(file, JSON.stringify(context, null, 2));
+};

package/index.js

@@ -21,10 +21,10 @@ import { fillInArgs } from './utils/middlewares.js';
 import pkg from './pkg.js';
 import commands from './commands/index.js';
 import { analyticsMiddleware, sendError } from './analytics.js';
-import { isCi } from './env.js';
 import { isAxiosError } from 'axios';
 import { matchErrorCode } from './errors.js';
 import { showHelp } from './help.js';
+import { currentContextFile, enrichFromContext } from './context.js';
 let builder = yargs(hideBin(process.argv));
 builder = builder
     .scriptName(pkg.name)
@@ -61,38 +61,45 @@ builder = builder
     default: false,
 })
     .middleware(ensureConfigDir)
-    // Auth flow
-    .option('oauth-host', {
-    description: 'URL to Neon OAuth host',
-    hidden: true,
-    default: 'https://oauth2.neon.tech',
-})
-    .option('client-id', {
-    description: 'OAuth client id',
-    hidden: true,
-    type: 'string',
-    default: defaultClientID,
-})
-    .option('api-key', {
-    describe: 'API key',
-    group: 'Global options:',
-    type: 'string',
-    default: process.env.NEON_API_KEY ?? '',
-})
-    .option('apiClient', {
-    hidden: true,
-    coerce: (v) => v,
-    default: null,
+    .options({
+    'oauth-host': {
+        description: 'URL to Neon OAuth host',
+        hidden: true,
+        default: 'https://oauth2.neon.tech',
+    },
+    'client-id': {
+        description: 'OAuth client id',
+        hidden: true,
+        type: 'string',
+        default: defaultClientID,
+    },
+    'api-key': {
+        describe: 'API key',
+        group: 'Global options:',
+        type: 'string',
+        default: process.env.NEON_API_KEY ?? '',
+    },
+    apiClient: {
+        hidden: true,
+        coerce: (v) => v,
+        default: null,
+    },
+    'context-file': {
+        describe: 'Context file',
+        type: 'string',
+        default: currentContextFile,
+    },
 })
     .middleware((args) => fillInArgs(args), true)
     .middleware(ensureAuth)
+    .middleware(enrichFromContext)
     .command(commands)
     .strictCommands()
     .option('analytics', {
     describe: 'Manage analytics. Example: --no-analytics, --analytics false',
     group: 'Global options:',
     type: 'boolean',
-    default: !isCi(),
+    default: true,
 })
     .middleware(analyticsMiddleware, true)
     .group('version', 'Global options:')

package/package.json

@@ -5,7 +5,7 @@
     "url": "git@github.com:neondatabase/neonctl.git"
   },
   "type": "module",
-  "version": "1.21.3",
+  "version": "1.23.0",
   "description": "CLI tool for NeonDB Cloud management",
   "main": "index.js",
   "author": "NeonDB",
@@ -47,6 +47,7 @@
     "prettier": "^2.7.1",
     "rollup": "^3.26.2",
     "semantic-release": "^21.0.2",
+    "strip-ansi": "^7.1.0",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
     "typescript": "^4.7.4"

package/test_utils/test_cli_command.js

@@ -2,6 +2,7 @@ import { test, expect, describe, beforeAll, afterAll } from '@jest/globals';
 import { fork } from 'node:child_process';
 import { join } from 'node:path';
 import { log } from '../log.js';
+import strip from 'strip-ansi';
 import { runMockServer } from './mock_server.js';
 export const testCliCommand = ({ args, name, expected, mockDir = 'main', }) => {
     let server;
@@ -52,10 +53,10 @@ export const testCliCommand = ({ args, name, expected, mockDir = 'main', }) => {
                                 expect(output).toMatchSnapshot();
                             }
                             if (expected.stdout !== undefined) {
-                                expect(output).toEqual(expected.stdout);
+                                expect(strip(output)).toEqual(expected.stdout);
                             }
                             if (expected.stderr !== undefined) {
-                                expect(error).toEqual(expected.stderr);
+                                expect(strip(error)).toEqual(expected.stderr);
                             }
                         }
                         resolve();