neonctl 2.11.0 → 2.13.0

package/README.md

@@ -145,13 +145,14 @@ Global options are supported with any Neon CLI command.
 To run the CLI locally, execute the build command after making changes:
 
 ```shell
-npm run build
+bun install
+bun run build
 ```
 
 To develop continuously:
 
 ```shell
-npm run watch
+bun run watch
 ```
 
 To run commands from the local build, replace the `neonctl` command with `node dist`; for example:

package/analytics.js

@@ -25,13 +25,26 @@ export const analyticsMiddleware = async (args) => {
         log.debug('Failed to read credentials file', err);
     }
     try {
-        if (!userId && args.apiKey) {
+        if (args.apiKey) {
             const apiClient = getApiClient({
                 apiKey: args.apiKey,
                 apiHost: args.apiHost,
             });
-            const resp = await apiClient?.getCurrentUserInfo?.();
-            userId = resp?.data?.id;
+            // Populating api key details for analytics
+            const authDetailsResponse = await apiClient.getAuthDetails();
+            const authDetails = authDetailsResponse.data;
+            args.accountId = authDetails.account_id;
+            args.authMethod = authDetails.auth_method;
+            args.authData = authDetails.auth_data;
+            // Get user id if not org api key
+            if (!userId && authDetails.auth_method !== 'api_key_org') {
+                const resp = await apiClient?.getCurrentUserInfo?.();
+                userId = resp?.data?.id;
+            }
+        }
+        else {
+            args.accountId = userId;
+            args.authMethod = 'oauth';
         }
     }
     catch (err) {

package/commands/auth.js

@@ -1,4 +1,4 @@
-import { existsSync, readFileSync, writeFileSync } from 'node:fs';
+import { existsSync, readFileSync, writeFileSync, rmSync } from 'node:fs';
 import { join } from 'node:path';
 import { createHash } from 'node:crypto';
 import { TokenSet } from 'openid-client';
@@ -153,4 +153,25 @@ export const ensureAuth = async (props) => {
         apiHost: props.apiHost,
     });
 };
+/**
+ * Deletes the credentials file at the specified path
+ * @param configDir Directory where credentials file is stored
+ */
+export const deleteCredentials = (configDir) => {
+    const credentialsPath = join(configDir, CREDENTIALS_FILE);
+    try {
+        if (existsSync(credentialsPath)) {
+            rmSync(credentialsPath);
+            log.info('Deleted credentials from %s', credentialsPath);
+        }
+        else {
+            log.debug('Credentials file %s does not exist', credentialsPath);
+        }
+    }
+    catch (err) {
+        const typedErr = err instanceof Error ? err : new Error('Unknown error');
+        log.error('Failed to delete credentials: %s', typedErr.message);
+        throw new Error('CREDENTIALS_DELETE_FAILED');
+    }
+};
 const md5hash = (s) => createHash('md5').update(s).digest('hex');

package/commands/auth.test.js

@@ -6,7 +6,7 @@ import { afterAll, beforeAll, beforeEach, describe, expect, vi } from 'vitest';
 import * as authModule from '../auth';
 import { test } from '../test_utils/fixtures';
 import { startOauthServer } from '../test_utils/oauth_server';
-import { authFlow, ensureAuth } from './auth';
+import { authFlow, ensureAuth, deleteCredentials } from './auth';
 vi.mock('open', () => ({ default: vi.fn((url) => axios.get(url)) }));
 vi.mock('../pkg.ts', () => ({ default: { version: '0.0.0' } }));
 describe('auth', () => {
@@ -163,3 +163,33 @@ describe('ensureAuth', () => {
         expect(props.apiKey).toBe('new-token');
     });
 });
+describe('deleteCredentials', () => {
+    let configDir = '';
+    beforeAll(() => {
+        configDir = mkdtempSync('test-config-delete');
+    });
+    afterAll(() => {
+        rmSync(configDir, { recursive: true });
+    });
+    test('should successfully delete credentials file', () => {
+        const credentialsPath = join(configDir, 'credentials.json');
+        writeFileSync(credentialsPath, 'test-content', { mode: 0o700 });
+        expect(existsSync(credentialsPath)).toBe(true);
+        deleteCredentials(configDir);
+        expect(existsSync(credentialsPath)).toBe(false);
+    });
+    test('should handle non-existent file gracefully', () => {
+        const nonExistentDir = mkdtempSync('test-config-nonexistent');
+        // Ensure the file doesn't exist
+        const credentialsPath = join(nonExistentDir, 'credentials.json');
+        if (existsSync(credentialsPath)) {
+            rmSync(credentialsPath);
+        }
+        expect(existsSync(credentialsPath)).toBe(false);
+        // Should not throw an error
+        expect(() => {
+            deleteCredentials(nonExistentDir);
+        }).not.toThrow();
+        rmSync(nonExistentDir, { recursive: true });
+    });
+});

package/commands/branches.js

@@ -142,6 +142,10 @@ export const builder = (argv) => argv
         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',
     },
+    name: {
+        type: 'string',
+        describe: 'Optional name of the compute',
+    },
 }), (args) => addCompute(args))
     .command('delete <id|name>', 'Delete a branch', (yargs) => yargs, (args) => deleteBranch(args))
     .command('get <id|name>', 'Get a branch', (yargs) => yargs, (args) => get(args))
@@ -319,11 +323,13 @@ const get = async (props) => {
 };
 const addCompute = async (props) => {
     const branchId = await branchIdFromProps(props);
+    const computeName = props.name ? { name: props.name } : null;
     const { data } = await retryOnLock(() => props.apiClient.createProjectEndpoint(props.projectId, {
         endpoint: {
             branch_id: branchId,
             type: props.type,
             ...(props.cu ? getComputeUnits(props.cu) : undefined),
+            ...computeName,
         },
     }));
     writer(props).end(data.endpoint, {

package/commands/branches.test.js

@@ -274,6 +274,19 @@ describe('branches', () => {
             '0.5-2',
         ]);
     });
+    test('add compute with a name', async ({ testCliCommand }) => {
+        await testCliCommand([
+            'branches',
+            'add-compute',
+            'test_branch_with_autoscaling',
+            '--project-id',
+            'test',
+            '--cu',
+            '0.5-2',
+            '--name',
+            'My fancy new compute',
+        ]);
+    });
     /* reset */
     test('reset branch to parent', async ({ testCliCommand }) => {
         await testCliCommand([

package/commands/connection_string.js

@@ -131,6 +131,7 @@ export const handler = async (props) => {
     }
     if (props.ssl !== 'omit') {
         connectionString.searchParams.set('sslmode', props.ssl);
+        connectionString.searchParams.set('channel_binding', 'require');
     }
     if (parsedPIT.tag === 'lsn') {
         connectionString.searchParams.set('options', `neon_lsn:${parsedPIT.lsn}`);

package/help.js

@@ -71,9 +71,9 @@ const formatHelp = (help) => {
     }
     // command description
     // example command to see: neonctl projects list
-    const descritpionBlock = consumeBlockIfMatches(lines, /^(?!.*options:)/i);
-    if (descritpionBlock.length > 0) {
-        result.push(...descritpionBlock);
+    const descriptionBlock = consumeBlockIfMatches(lines, /^(?!.*options:)/i);
+    if (descriptionBlock.length > 0) {
+        result.push(...descriptionBlock);
         result.push('');
     }
     while (true) {

package/index.js

@@ -13,7 +13,7 @@ axiosDebug({
         debug(error);
     },
 });
-import { ensureAuth } from './commands/auth.js';
+import { ensureAuth, deleteCredentials } from './commands/auth.js';
 import { defaultDir, ensureConfigDir } from './config.js';
 import { log } from './log.js';
 import { defaultClientID } from './auth.js';
@@ -143,19 +143,33 @@ builder = builder
     .scriptName(basename(process.argv[1]) === 'neon' ? 'neon' : 'neonctl')
     .epilog('For more information, visit https://neon.tech/docs/reference/neon-cli')
     .wrap(null)
-    .fail(async (msg, err) => {
+    .fail(false);
+async function handleError(msg, err) {
     if (process.argv.some((arg) => arg === '--help' || arg === '-h')) {
         await showHelp(builder);
         process.exit(0);
     }
+    // Log stack trace if available
+    if (err instanceof Error && err.stack) {
+        log.debug('Stack: %s', err.stack);
+    }
     if (isAxiosError(err)) {
         if (err.code === 'ECONNABORTED') {
             log.error('Request timed out');
             sendError(err, 'REQUEST_TIMEOUT');
+            return false;
         }
         else if (err.response?.status === 401) {
             sendError(err, 'AUTH_FAILED');
-            log.error('Authentication failed, please run `neonctl auth`');
+            log.info('Authentication failed, deleting credentials...');
+            try {
+                deleteCredentials(defaultDir);
+                return true; // Allow retry for auth failures
+            }
+            catch (deleteErr) {
+                log.debug('Failed to delete credentials: %s', deleteErr instanceof Error ? deleteErr.message : 'unknown error');
+                return false;
+            }
         }
         else {
             if (err.response?.data?.message) {
@@ -163,33 +177,47 @@ builder = builder
             }
             log.debug('status: %d %s | path: %s', err.response?.status, err.response?.statusText, err.request?.path);
             sendError(err, 'API_ERROR');
+            return false;
         }
     }
     else {
-        sendError(err || new Error(msg), matchErrorCode(msg || err?.message));
-        log.error(msg || err?.message);
-    }
-    await closeAnalytics();
-    if (err?.stack) {
-        log.debug('Stack: %s', err.stack);
+        const error = err instanceof Error ? err : new Error(msg || 'Unknown error');
+        sendError(error, matchErrorCode(error.message));
+        log.error(error.message);
+        return false;
     }
-    process.exit(1);
-});
+}
 void (async () => {
-    try {
-        const args = await builder.argv;
-        trackEvent('cli_command_success', {
-            ...getAnalyticsEventProperties(args),
-            projectId: args.projectId,
-            branchId: args.branchId,
-        });
-        if (args._.length === 0 || args.help) {
-            await showHelp(builder);
+    // Main loop with max 2 attempts (initial + 1 retry):
+    let attempts = 0;
+    const MAX_ATTEMPTS = 2;
+    while (attempts < MAX_ATTEMPTS) {
+        try {
+            const args = await builder.argv;
+            // Send analytics for a successful attempt
+            trackEvent('cli_command_success', {
+                ...getAnalyticsEventProperties(args),
+                projectId: args.projectId,
+                branchId: args.branchId,
+                accountId: args.accountId,
+                authMethod: args.authMethod,
+                authData: args.authData,
+            });
+            if (args._.length === 0 || args.help) {
+                await showHelp(builder);
+                process.exit(0);
+            }
+            await closeAnalytics();
             process.exit(0);
         }
-        await closeAnalytics();
-    }
-    catch {
-        // noop
+        catch (err) {
+            attempts++;
+            const shouldRetry = await handleError('', err);
+            if (!shouldRetry || attempts >= MAX_ATTEMPTS) {
+                await closeAnalytics();
+                process.exit(1);
+            }
+            // If shouldRetry is true and we haven't hit max attempts, loop continues
+        }
     }
 })();

package/package.json

@@ -5,7 +5,7 @@
     "url": "git+ssh://git@github.com/neondatabase/neonctl.git"
   },
   "type": "module",
-  "version": "2.11.0",
+  "version": "2.13.0",
   "description": "CLI tool for NeonDB Cloud management",
   "main": "index.js",
   "author": "NeonDB",
@@ -110,6 +110,5 @@
       "eslint --cache --fix",
       "prettier --write"
     ]
-  },
-  "packageManager": "pnpm@9.4.0+sha512.f549b8a52c9d2b8536762f99c0722205efc5af913e77835dbccc3b0b0b2ca9e7dc8022b78062c17291c48e88749c70ce88eb5a74f1fa8c4bf5e18bb46c8bd83a"
+  }
 }