neonctl 1.28.0 → 1.29.3

package/commands/connection_string.js

@@ -2,6 +2,7 @@ import { EndpointType } from '@neondatabase/api-client';
 import { branchIdFromProps, fillSingleProject } from '../utils/enrichers.js';
 import { writer } from '../writer.js';
 import { psql } from '../utils/psql.js';
+import { parsePITBranch } from '../utils/point_in_time.js';
 const SSL_MODES = ['require', 'verify-ca', 'verify-full', 'omit'];
 export const command = 'connection-string [branch]';
 export const aliases = ['cs'];
@@ -9,8 +10,11 @@ export const describe = 'Get connection string';
 export const builder = (argv) => {
     return argv
         .usage('$0 connection-string [branch] [options]')
+        .example('$0 cs main', 'Get connection string for the main branch')
+        .example('$0 cs main@2024-01-01T00:00:00Z', 'Get connection string for the main branch at a specific point in time')
+        .example('$0 cs main@0/234235', 'Get connection string for the main branch at a specific LSN')
         .positional('branch', {
-        describe: 'Branch name or id. If ommited will use the primary branch',
+        describe: `Branch name or id. Defaults to the primary branch if omitted. Can be written in the point-in-time format: "branch@timestamp" or "branch@lsn"`,
         type: 'string',
     })
         .options({
@@ -61,6 +65,12 @@ export const builder = (argv) => {
 };
 export const handler = async (props) => {
     const projectId = props.projectId;
+    const parsedPIT = props.branch
+        ? parsePITBranch(props.branch)
+        : { tag: 'head', branch: '' };
+    if (props.branch) {
+        props.branch = parsedPIT.branch;
+    }
     const branchId = await branchIdFromProps(props);
     const { data: { endpoints }, } = await props.apiClient.listProjectBranchEndpoints(projectId, branchId);
     const matchEndpointType = props.endpointType ?? EndpointType.ReadWrite;
@@ -100,9 +110,12 @@ export const handler = async (props) => {
                 .join(', ')}`);
         }));
     const { data: { password }, } = await props.apiClient.getProjectBranchRolePassword(props.projectId, endpoint.branch_id, role);
-    const host = props.pooled
+    let host = props.pooled
         ? endpoint.host.replace(endpoint.id, `${endpoint.id}-pooler`)
         : endpoint.host;
+    if (parsedPIT.tag !== 'head') {
+        host = endpoint.host.replace(endpoint.id, endpoint.branch_id);
+    }
     const connectionString = new URL(`postgres://${host}`);
     connectionString.pathname = database;
     connectionString.username = role;
@@ -117,6 +130,12 @@ export const handler = async (props) => {
     if (props.ssl !== 'omit') {
         connectionString.searchParams.set('sslmode', props.ssl);
     }
+    if (parsedPIT.tag === 'lsn') {
+        connectionString.searchParams.set('options', `neon_lsn:${parsedPIT.lsn}`);
+    }
+    else if (parsedPIT.tag === 'timestamp') {
+        connectionString.searchParams.set('options', `neon_timestamp:${parsedPIT.timestamp}`);
+    }
     if (props.psql) {
         const psqlArgs = props['--'];
         await psql(connectionString.toString(), psqlArgs);

package/commands/connection_string.test.js

@@ -201,4 +201,36 @@ describe('connection_string', () => {
             snapshot: true,
         },
     });
+    testCliCommand({
+        name: 'connection_string with lsn',
+        args: [
+            'connection-string',
+            'test_branch@0/123456',
+            '--project-id',
+            'test',
+            '--database-name',
+            'test_db',
+            '--role-name',
+            'test_role',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
+    testCliCommand({
+        name: 'connection_string with timestamp',
+        args: [
+            'connection-string',
+            'test_branch@2021-01-01T00:00:00Z',
+            '--project-id',
+            'test',
+            '--database-name',
+            'test_db',
+            '--role-name',
+            'test_role',
+        ],
+        expected: {
+            snapshot: true,
+        },
+    });
 });

package/commands/projects.js

@@ -82,22 +82,38 @@ export const handler = (args) => {
     return args;
 };
 const list = async (props) => {
-    const result = [];
-    let cursor;
-    let end = false;
-    while (!end) {
-        const { data } = await props.apiClient.listProjects({
-            limit: PROJECTS_LIST_LIMIT,
-            cursor,
-        });
-        result.push(...data.projects);
-        cursor = data.pagination?.cursor;
-        log.debug('Got %d projects, with cursor: %s', data.projects.length, cursor);
-        if (data.projects.length < PROJECTS_LIST_LIMIT) {
-            end = true;
+    const getList = async (fn) => {
+        const result = [];
+        let cursor;
+        let end = false;
+        while (!end) {
+            const { data } = await fn({
+                limit: PROJECTS_LIST_LIMIT,
+                cursor,
+            });
+            result.push(...data.projects);
+            cursor = data.pagination?.cursor;
+            log.debug('Got %d projects, with cursor: %s', data.projects.length, cursor);
+            if (data.projects.length < PROJECTS_LIST_LIMIT) {
+                end = true;
+            }
         }
-    }
-    writer(props).end(result, { fields: PROJECT_FIELDS });
+        return result;
+    };
+    const [ownedProjects, sharedProjects] = await Promise.all([
+        getList(props.apiClient.listProjects),
+        getList(props.apiClient.listSharedProjects),
+    ]);
+    const out = writer(props);
+    out.write(ownedProjects, {
+        fields: PROJECT_FIELDS,
+        title: 'Projects',
+    });
+    out.write(sharedProjects, {
+        fields: PROJECT_FIELDS,
+        title: 'Shared with me',
+    });
+    out.end();
 };
 const create = async (props) => {
     const project = {};

package/package.json

@@ -2,10 +2,10 @@
   "name": "neonctl",
   "repository": {
     "type": "git",
-    "url": "git@github.com:neondatabase/neonctl.git"
+    "url": "git+ssh://git@github.com/neondatabase/neonctl.git"
   },
   "type": "module",
-  "version": "1.28.0",
+  "version": "1.29.3",
   "description": "CLI tool for NeonDB Cloud management",
   "main": "index.js",
   "author": "NeonDB",
@@ -46,7 +46,7 @@
     "pkg": "^5.8.1",
     "prettier": "^3.1.0",
     "rollup": "^3.26.2",
-    "semantic-release": "^21.0.2",
+    "semantic-release": "^23.0.8",
     "strip-ansi": "^7.1.0",
     "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
@@ -72,7 +72,8 @@
   },
   "pkg": {
     "assets": [
-      "callback.html"
+      "callback.html",
+      "package.json"
     ],
     "scripts": [
       "bundle/*.js"
@@ -91,7 +92,7 @@
     "build": "npm run generateParams && npm run clean && tsc && cp src/*.html package*.json README.md ./dist",
     "clean": "rm -rf dist",
     "generateParams": "node --loader ts-node/esm ./generateOptionsFromSpec.ts",
-    "start": "node src/index.js",
+    "start": "node dist/index.js",
     "pretest": "npm run build",
     "test": "node --experimental-vm-modules node_modules/.bin/jest",
     "prepare": "test -d .git && husky install || true"

package/utils/point_in_time.js

@@ -6,12 +6,12 @@ export class PointInTimeParseError extends Error {
         this.name = 'PointInTimeParseError';
     }
 }
-export const parsePointInTime = async ({ pointInTime, targetBranchId, projectId, api, }) => {
-    const splitIndex = pointInTime.lastIndexOf('@');
-    const sourceBranch = splitIndex === -1 ? pointInTime : pointInTime.slice(0, splitIndex);
-    const exactPIT = splitIndex === -1 ? null : pointInTime.slice(splitIndex + 1);
+export const parsePITBranch = (input) => {
+    const splitIndex = input.lastIndexOf('@');
+    const sourceBranch = splitIndex === -1 ? input : input.slice(0, splitIndex);
+    const exactPIT = splitIndex === -1 ? null : input.slice(splitIndex + 1);
     const result = {
-        branchId: '',
+        branch: sourceBranch,
         ...(exactPIT === null
             ? { tag: 'head' }
             : looksLikeLSN(exactPIT)
@@ -21,24 +21,30 @@ export const parsePointInTime = async ({ pointInTime, targetBranchId, projectId,
     if (result.tag === 'timestamp' && !looksLikeTimestamp(result.timestamp)) {
         throw new PointInTimeParseError('Invalid source branch format');
     }
-    if (sourceBranch === '^self') {
-        return {
-            ...result,
-            branchId: targetBranchId,
-        };
+    return result;
+};
+export const parsePointInTime = async ({ pointInTime, targetBranchId, projectId, api, }) => {
+    const parsedPIT = parsePITBranch(pointInTime);
+    let branchId = '';
+    if (parsedPIT.branch === '^self') {
+        branchId = targetBranchId;
     }
-    if (sourceBranch === '^parent') {
+    else if (parsedPIT.branch === '^parent') {
         const { data } = await api.getProjectBranch(projectId, targetBranchId);
         const { parent_id: parentId } = data.branch;
         if (parentId == null) {
             throw new PointInTimeParseError('Branch has no parent');
         }
-        return { ...result, branchId: parentId };
+        branchId = parentId;
     }
-    const branchId = await branchIdResolve({
-        branch: sourceBranch,
-        projectId,
-        apiClient: api,
-    });
-    return { ...result, branchId };
+    else {
+        branchId = await branchIdResolve({
+            branch: parsedPIT.branch,
+            projectId,
+            apiClient: api,
+        });
+    }
+    // @ts-expect-error extracting pit from parsedPIT
+    delete parsedPIT.branch;
+    return { ...parsedPIT, branchId };
 };