neonctl 1.18.2 → 1.19.1

package/analytics.js

@@ -1,33 +1,63 @@
+import { readFileSync } from 'node:fs';
+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 { log } from './log.js';
 import pkg from './pkg.js';
 const WRITE_KEY = '3SQXn5ejjXWLEJ8xU2PRYhAotLtTaeeV';
+let client;
+let userId = '';
 export const analyticsMiddleware = (args) => {
     if (!args.analytics) {
         return;
     }
-    const client = new Analytics({
+    try {
+        const credentialsPath = join(args.configDir, CREDENTIALS_FILE);
+        const credentials = readFileSync(credentialsPath, { encoding: 'utf-8' });
+        userId = JSON.parse(credentials).user_id;
+    }
+    catch (err) {
+        log.debug('Failed to read credentials file', err);
+    }
+    client = new Analytics({
         writeKey: WRITE_KEY,
         host: 'https://track.neon.tech',
     });
-    (args.apiClient?.getCurrentUserInfo() ??
-        Promise.resolve({ data: { id: undefined } }))
-        .then(({ data }) => data.id)
-        .then((userId) => {
-        client.track({
-            userId,
-            event: 'CLI Started',
-            properties: {
-                version: pkg.version,
-                command: args._.join(' '),
-                flags: {
-                    output: args.output,
-                },
-                ci: isCi(),
+    client.identify({
+        userId: userId?.toString() ?? 'anonymous',
+    });
+    client.track({
+        userId: userId ?? 'anonymous',
+        event: 'CLI Started',
+        properties: {
+            version: pkg.version,
+            command: args._.join(' '),
+            flags: {
+                output: args.output,
             },
-        });
-        client.closeAndFlush();
-    })
-        // eslint-disable-next-line @typescript-eslint/no-empty-function
-        .catch(() => { });
+            ci: isCi(),
+        },
+    });
+    client.closeAndFlush();
+    log.debug('Sent CLI started event with userId: %s', userId);
+};
+export const sendError = (err, errCode) => {
+    if (!client) {
+        return;
+    }
+    const axiosError = isAxiosError(err) ? err : undefined;
+    client.track({
+        event: 'CLI Error',
+        userId: userId ?? 'anonymous',
+        properties: {
+            message: err.message,
+            stack: err.stack,
+            errCode,
+            statusCode: axiosError?.response?.status,
+        },
+    });
+    client.closeAndFlush();
+    log.debug('Sent CLI error event: %s', errCode);
 };

package/commands/auth.js

@@ -5,7 +5,7 @@ import { auth, refreshToken } from '../auth.js';
 import { log } from '../log.js';
 import { getApiClient } from '../api.js';
 import { isCi } from '../env.js';
-const CREDENTIALS_FILE = 'credentials.json';
+import { CREDENTIALS_FILE } from '../config.js';
 export const command = 'auth';
 export const aliases = ['login'];
 export const describe = 'Authenticate';
@@ -13,7 +13,7 @@ export const builder = (yargs) => yargs;
 export const handler = async (args) => {
     await authFlow(args);
 };
-export const authFlow = async ({ configDir, oauthHost, clientId, forceAuth, }) => {
+export const authFlow = async ({ configDir, oauthHost, clientId, apiHost, forceAuth, }) => {
     if (!forceAuth && isCi()) {
         throw new Error('Cannot run interactive auth in CI');
     }
@@ -22,17 +22,25 @@ export const authFlow = async ({ configDir, oauthHost, clientId, forceAuth, }) =
         clientId: clientId,
     });
     const credentialsPath = join(configDir, CREDENTIALS_FILE);
-    updateCredentialsFile(credentialsPath, JSON.stringify(tokenSet));
+    await preserveCredentials(credentialsPath, tokenSet, getApiClient({
+        apiKey: tokenSet.access_token || '',
+        apiHost,
+    }));
     log.info(`Saved credentials to ${credentialsPath}`);
     log.info('Auth complete');
     return tokenSet.access_token || '';
 };
-// updateCredentialsFile correctly sets needed permissions for the credentials file
-function updateCredentialsFile(path, contents) {
+const preserveCredentials = async (path, credentials, apiClient) => {
+    const { data: { id }, } = await apiClient.getCurrentUserInfo();
+    const contents = JSON.stringify({
+        ...credentials,
+        user_id: id,
+    });
+    // correctly sets needed permissions for the credentials file
     writeFileSync(path, contents, {
         mode: 0o700,
     });
-}
+};
 export const ensureAuth = async (props) => {
     if (props._.length === 0) {
         return;
@@ -63,7 +71,7 @@ export const ensureAuth = async (props) => {
                     apiKey: props.apiKey,
                     apiHost: props.apiHost,
                 });
-                updateCredentialsFile(credentialsPath, JSON.stringify(refreshedTokenSet));
+                await preserveCredentials(credentialsPath, refreshedTokenSet, props.apiClient);
                 return;
             }
             const token = tokenSet.access_token || 'UNKNOWN';

package/commands/auth.test.js

@@ -2,6 +2,7 @@ import axios from 'axios';
 import { beforeAll, describe, test, jest, afterAll, expect, } from '@jest/globals';
 import { mkdtempSync, rmSync, readFileSync } from 'node:fs';
 import { startOauthServer } from '../test_utils/oauth_server';
+import { runMockServer } from '../test_utils/mock_server';
 jest.unstable_mockModule('open', () => ({
     __esModule: true,
     default: jest.fn((url) => {
@@ -12,26 +13,30 @@ jest.unstable_mockModule('open', () => ({
 const authModule = await import('./auth');
 describe('auth', () => {
     let configDir = '';
-    let server;
+    let oauthServer;
+    let mockServer;
     beforeAll(async () => {
         configDir = mkdtempSync('test-config');
-        server = await startOauthServer();
+        oauthServer = await startOauthServer();
+        mockServer = await runMockServer('main');
     });
-    afterAll(() => {
+    afterAll(async () => {
         rmSync(configDir, { recursive: true });
-        server.stop();
+        await oauthServer.stop();
+        await new Promise((resolve) => mockServer.close(resolve));
     });
     test('should auth', async () => {
         await authModule.authFlow({
             _: ['auth'],
-            apiHost: 'http://localhost:1111',
+            apiHost: `http://localhost:${mockServer.address().port}`,
             clientId: 'test-client-id',
             configDir,
             forceAuth: true,
-            oauthHost: 'http://localhost:7777',
+            oauthHost: `http://localhost:${oauthServer.address().port}`,
         });
         const credentials = JSON.parse(readFileSync(`${configDir}/credentials.json`, 'utf-8'));
         expect(credentials.access_token).toEqual(expect.any(String));
         expect(credentials.refresh_token).toEqual(expect.any(String));
+        expect(credentials.user_id).toEqual(expect.any(String));
     });
 });

package/commands/branches.test.js

@@ -114,6 +114,19 @@ describe('branches', () => {
             snapshot: true,
         },
     });
+    testCliCommand({
+        name: 'delete by id',
+        args: [
+            'branches',
+            'delete',
+            'br-cloudy-branch-12345678',
+            '--project-id',
+            'test',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
     testCliCommand({
         name: 'rename',
         args: [
@@ -141,6 +154,19 @@ describe('branches', () => {
             snapshot: true,
         },
     });
+    testCliCommand({
+        name: 'set primary by id',
+        args: [
+            'branches',
+            'set-primary',
+            'br-cloudy-branch-12345678',
+            '--project-id',
+            'test',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
     testCliCommand({
         name: 'get by id',
         args: ['branches', 'get', 'br-sunny-branch-123456', '--project-id', 'test'],
@@ -148,6 +174,13 @@ describe('branches', () => {
             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'],

package/commands/connection_string.test.js

@@ -17,6 +17,38 @@ describe('connection_string', () => {
             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',
+        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: [
@@ -34,6 +66,40 @@ describe('connection_string', () => {
             snapshot: true,
         },
     });
+    testCliCommand({
+        name: 'connection_string pooled branch id',
+        args: [
+            'connection-string',
+            'br-sunny-branch-123456',
+            '--project-id',
+            'test',
+            '--database-name',
+            'test_db',
+            '--role-name',
+            'test_role',
+            '--pooled',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'connection_string pooled branch id',
+        args: [
+            'connection-string',
+            'br-cloudy-branch-12345678',
+            '--project-id',
+            'test',
+            '--database-name',
+            'test_db',
+            '--role-name',
+            'test_role',
+            '--pooled',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
     testCliCommand({
         name: 'connection_string prisma',
         args: [
@@ -51,6 +117,40 @@ describe('connection_string', () => {
             snapshot: true,
         },
     });
+    testCliCommand({
+        name: 'connection_string pooled branch id',
+        args: [
+            'connection-string',
+            'br-sunny-branch-123456',
+            '--project-id',
+            'test',
+            '--database-name',
+            'test_db',
+            '--role-name',
+            'test_role',
+            '--pooled',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'connection_string pooled branch id',
+        args: [
+            'connection-string',
+            'br-cloudy-branch-12345678',
+            '--project-id',
+            'test',
+            '--database-name',
+            'test_db',
+            '--role-name',
+            'test_role',
+            '--pooled',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
     testCliCommand({
         name: 'connection_string prisma pooled',
         args: [
@@ -69,6 +169,42 @@ describe('connection_string', () => {
             snapshot: true,
         },
     });
+    testCliCommand({
+        name: 'connection_string prisma pooled branch id',
+        args: [
+            'connection-string',
+            'br-sunny-branch-123456',
+            '--project-id',
+            'test',
+            '--database-name',
+            'test_db',
+            '--role-name',
+            'test_role',
+            '--prisma',
+            '--pooled',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'connection_string prisma pooled branch id',
+        args: [
+            'connection-string',
+            'br-cloudy-branch-12345678',
+            '--project-id',
+            'test',
+            '--database-name',
+            'test_db',
+            '--role-name',
+            'test_role',
+            '--prisma',
+            '--pooled',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
     testCliCommand({
         name: 'connection_string without any args should pass',
         args: ['connection-string'],

package/commands/projects.js

@@ -82,8 +82,11 @@ const create = async (props) => {
         project,
     });
     const out = writer(props);
-    out.write(data.project, { fields: PROJECT_FIELDS });
-    out.write(data.connection_uris, { fields: ['connection_uri'] });
+    out.write(data.project, { fields: PROJECT_FIELDS, title: 'Project' });
+    out.write(data.connection_uris, {
+        fields: ['connection_uri'],
+        title: 'Connection URIs',
+    });
     out.end();
 };
 const deleteProject = async (props) => {

package/config.js

@@ -2,6 +2,7 @@ import { join } from 'node:path';
 import { homedir } from 'node:os';
 import { existsSync, mkdirSync } from 'node:fs';
 import { isCi } from './env.js';
+export const CREDENTIALS_FILE = 'credentials.json';
 export const defaultDir = join(process.env.XDG_CONFIG_HOME || join(homedir(), '.config'), 'neonctl');
 export const ensureConfigDir = async ({ 'config-dir': configDir, 'force-auth': forceAuth, }) => {
     if (!existsSync(configDir) && (!isCi() || forceAuth)) {

package/errors.js

@@ -0,0 +1,13 @@
+const ERROR_MATCHERS = [
+    [/^Unknown command: (.*)$/, 'UNKNOWN_COMMAND'],
+    [/^Missing required argument: (.*)$/, 'MISSING_ARGUMENT'],
+];
+export const matchErrorCode = (message) => {
+    for (const [matcher, code] of ERROR_MATCHERS) {
+        const match = message.match(matcher);
+        if (match) {
+            return code;
+        }
+    }
+    return 'UNKNOWN_ERROR';
+};

package/index.js

@@ -20,9 +20,10 @@ import { defaultClientID } from './auth.js';
 import { fillInArgs } from './utils/middlewares.js';
 import pkg from './pkg.js';
 import commands from './commands/index.js';
-import { analyticsMiddleware } from './analytics.js';
+import { analyticsMiddleware, sendError } from './analytics.js';
 import { isCi } from './env.js';
 import { isAxiosError } from 'axios';
+import { matchErrorCode } from './errors.js';
 let builder = yargs(hideBin(process.argv));
 builder = builder
     .scriptName(pkg.name)
@@ -88,7 +89,7 @@ builder = builder
     type: 'boolean',
     default: !isCi(),
 })
-    .middleware(analyticsMiddleware)
+    .middleware(analyticsMiddleware, true)
     .group('version', 'Global options:')
     .alias('version', 'v')
     .group('help', 'Global options:')
@@ -99,16 +100,20 @@ builder = builder
     if (isAxiosError(err)) {
         if (err.code === 'ECONNABORTED') {
             log.error('Request timed out');
+            sendError(err, 'REQUEST_TIMEOUT');
         }
         else if (err.response?.status === 401) {
+            sendError(err, 'AUTH_FAILED');
             log.error('Authentication failed, please run `neonctl auth`');
         }
         else {
             log.debug('Fail: %d | %s', err.response?.status, err.response?.statusText);
             log.error(err.response?.data?.message);
+            sendError(err, 'API_ERROR');
         }
     }
     else {
+        sendError(err || new Error(msg), matchErrorCode(msg || err?.message));
         log.error(msg || err?.message);
     }
     err?.stack && log.debug('Stack: %s', err.stack);

package/package.json

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

package/test_utils/mock_server.js

@@ -8,7 +8,7 @@ export const runMockServer = async (mockDir) => new Promise((resolve) => {
     app.use('/', emocks(join(process.cwd(), 'mocks', mockDir)));
     const server = app.listen(0);
     server.on('listening', () => {
+        resolve(server);
         log.info('Mock server listening at %d', server.address().port);
     });
-    resolve(server);
 });

package/test_utils/oauth_server.js

@@ -3,7 +3,7 @@ import { OAuth2Server } from 'oauth2-mock-server';
 export const startOauthServer = async () => {
     const server = new OAuth2Server();
     await server.issuer.keys.generate('RS256');
-    await server.start(7777, 'localhost');
+    await server.start(0, 'localhost');
     log.info('Started OAuth server');
     return server;
 };

package/utils/string.js

@@ -0,0 +1,4 @@
+export const toSnakeCase = (str) => str
+    .split(' ')
+    .map((word) => word.toLowerCase())
+    .join('_');

package/writer.js

@@ -2,6 +2,7 @@ import YAML from 'yaml';
 import Table from 'cli-table';
 import chalk from 'chalk';
 import { isCi } from './env.js';
+import { toSnakeCase } from './utils/string.js';
 /**
  *
  * Parses the output format, takes data and writes the output to stdout.
@@ -32,7 +33,7 @@ export const writer = (props) => {
                 out.write(YAML.stringify(chunks.length === 1
                     ? chunks[0].data
                     : Object.fromEntries(chunks.map(({ config, data }, idx) => [
-                        config.title ?? idx,
+                        config.title ? toSnakeCase(config.title) : idx,
                         data,
                     ])), null, 2));
                 return;
@@ -41,7 +42,7 @@ export const writer = (props) => {
                 out.write(JSON.stringify(chunks.length === 1
                     ? chunks[0].data
                     : Object.fromEntries(chunks.map(({ config, data }, idx) => [
-                        config.title ?? idx,
+                        config.title ? toSnakeCase(config.title) : idx,
                         data,
                     ])), null, 2));
                 return;