Cherry pick changes from Release v9.1.3 (W-19689442) (#227) and update to ESM (#234)

* Updating exports required for Core CLI v10.x

* 9.1.3

Co-authored-by: Santiago Bosio <[email protected]>

Author: zwhitfield3

package-lock.json

@@ -44,7 +44,7 @@
   "dependencies": {
     "@heroku-cli/color": "^2.0.4",
     "@heroku-cli/command": "^12.0.0",
-    "@heroku/http-call": "^5.4.0",
+    "@heroku/http-call": "^5.5.0",
     "@oclif/core": "^4.3.0",
     "@oclif/table": "0.4.14",
     "debug": "^4.4.0",

package.json

@@ -4,6 +4,8 @@ import {AmbiguousError} from './errors/ambiguous.js'
 import {NotFound} from './errors/not-found.js'
 import {AddOnWithRelatedData, ExtendedAddonAttachment, Link} from './types/pg/data-api.js'
 import {ConnectionDetails, ConnectionDetailsWithAttachment, TunnelConfig} from './types/pg/tunnel.js'
+import {getPsqlConfigs, sshTunnel} from './utils/pg/bastion.js'
+import {getConfigVarNameFromAttachment} from './utils/pg/config-vars.js'
 import DatabaseResolver from './utils/pg/databases.js'
 import getHost from './utils/pg/host.js'
 import PsqlService from './utils/pg/psql.js'
@@ -33,6 +35,7 @@ export const utils = {
   },
   pg: {
     DatabaseResolver,
+    PsqlService,
     fetcher: {
       database(
         heroku: APIClient,
@@ -54,6 +57,9 @@ export const utils = {
         const psqlService = new PsqlService(connectionDetails)
         return psqlService.execQuery(query, psqlCmdArgs)
       },
+      getConfigVarNameFromAttachment,
+      getPsqlConfigs,
+      sshTunnel,
     },
   },
 }

src/index.ts

@@ -10,7 +10,6 @@ import {
   BastionConfig,
   BastionConfigResponse,
   ConnectionDetails,
-  ConnectionDetailsWithAttachment,
   TunnelConfig,
 } from '../../types/pg/tunnel.js'
 import host from './host.js'
@@ -93,7 +92,7 @@ export const getBastionConfig = function (config: Record<string, string>, baseNa
  * @param connectionDetails - The database connection details with attachment information
  * @returns Object containing database environment variables and tunnel configuration
  */
-export function getPsqlConfigs(connectionDetails: ConnectionDetailsWithAttachment) {
+export function getPsqlConfigs(connectionDetails: ConnectionDetails) {
   const dbEnv: NodeJS.ProcessEnv = baseEnv(connectionDetails)
   const dbTunnelConfig = tunnelConfig(connectionDetails)
 
@@ -154,7 +153,7 @@ function baseEnv(connectionDetails: ConnectionDetails): NodeJS.ProcessEnv {
  * @param connectionDetails - The database connection details with attachment information
  * @returns The tunnel configuration object
  */
-function tunnelConfig(connectionDetails: ConnectionDetailsWithAttachment): TunnelConfig {
+function tunnelConfig(connectionDetails: ConnectionDetails): TunnelConfig {
   const localHost = '127.0.0.1'
   const localPort = Math.floor((Math.random() * (65_535 - 49_152)) + 49_152)
   return {
@@ -179,7 +178,7 @@ function tunnelConfig(connectionDetails: ConnectionDetailsWithAttachment): Tunne
  * @throws Error if unable to establish the tunnel
  */
 export async function sshTunnel(
-  connectionDetails: ConnectionDetailsWithAttachment,
+  connectionDetails: ConnectionDetails,
   dbTunnelConfig: TunnelConfig,
   timeout = 10_000,
   createSSHTunnel = createSSHTunnelAdapter,

src/utils/pg/bastion.ts

@@ -118,7 +118,8 @@ export default class DatabaseResolver {
    * @param connStringOrDbName - PostgreSQL connection string or local database name
    * @returns Connection details object with parsed connection information
    */
-  public parsePostgresConnectionString(connStringOrDbName: string): ConnectionDetails {
+  // eslint-disable-next-line perfectionist/sort-classes
+  public static parsePostgresConnectionString(connStringOrDbName: string): ConnectionDetails {
     const dbPath = /:\/\//.test(connStringOrDbName) ? connStringOrDbName : `postgres:///${connStringOrDbName}`
     const url = new URL(dbPath)
     const {hostname, password, pathname, port, username} = url
@@ -159,7 +160,8 @@ export default class DatabaseResolver {
    * @param config - The record of app config vars with their values
    * @returns Connection details with attachment information
    */
-  private getConnectionDetails(
+  // eslint-disable-next-line perfectionist/sort-classes
+  public getConnectionDetails(
     attachment: ExtendedAddonAttachment,
     config: Record<string, string> = {},
   ): ConnectionDetailsWithAttachment {
@@ -168,7 +170,7 @@ export default class DatabaseResolver {
     // build the default payload for non-bastion dbs
     pgDebug(`Using "${connStringVar}" to connect to your database…`)
 
-    const conn = this.parsePostgresConnectionString(config[connStringVar])
+    const conn = DatabaseResolver.parsePostgresConnectionString(config[connStringVar])
 
     const payload: ConnectionDetailsWithAttachment = {
       attachment,

src/utils/pg/databases.ts

@@ -10,7 +10,7 @@ import {Server} from 'node:net'
 import {Stream} from 'node:stream'
 import {finished} from 'node:stream/promises'
 
-import {ConnectionDetailsWithAttachment, TunnelConfig} from '../../types/pg/tunnel.js'
+import {ConnectionDetails, TunnelConfig} from '../../types/pg/tunnel.js'
 import {getPsqlConfigs, sshTunnel} from './bastion.js'
 
 const pgDebug = debug('pg')
@@ -39,7 +39,7 @@ export class Tunnel {
    * @returns Promise that resolves to a new Tunnel instance
    */
   static async connect(
-    connectionDetails: ConnectionDetailsWithAttachment,
+    connectionDetails: ConnectionDetails,
     tunnelConfig: TunnelConfig,
     tunnelFn: typeof sshTunnel,
   ) {
@@ -93,7 +93,7 @@ type SpawnPsqlOptions = {
 
 export default class PsqlService {
   constructor(
-    private readonly connectionDetails: ConnectionDetailsWithAttachment,
+    private readonly connectionDetails: ConnectionDetails,
     private readonly getPsqlConfigsFn = getPsqlConfigs,
     private readonly spawnFn = spawn,
     private readonly tunnelFn = sshTunnel,
@@ -188,7 +188,8 @@ export default class PsqlService {
    * @param options - The options for spawning the psql process
    * @returns Promise that resolves to the query result as a string
    */
-  private async runWithTunnel(
+  // eslint-disable-next-line perfectionist/sort-classes
+  public async runWithTunnel(
     tunnelConfig: TunnelConfig,
     options: Parameters<typeof this.spawnPsql>[0],
   ): Promise<string> {

src/utils/pg/psql.ts

@@ -461,15 +461,9 @@ describe('DatabaseResolver', function () {
   })
 
   describe('parsePostgresConnectionString', function () {
-    let databaseResolver: DatabaseResolver
     let env: typeof process.env
-    let config: Config
-    let heroku: APIClient
 
     beforeEach(async function () {
-      config = await Config.load()
-      heroku = new APIClient(config)
-      databaseResolver = new DatabaseResolver(heroku)
       env = process.env
     })
 
@@ -480,7 +474,7 @@ describe('DatabaseResolver', function () {
     describe('when parsing full PostgreSQL connection strings', function () {
       it('parses a complete PostgreSQL connection string with all components', function () {
         const connString = 'postgres://user1:[email protected]:5432/database1'
-        const result = databaseResolver.parsePostgresConnectionString(connString)
+        const result = DatabaseResolver.parsePostgresConnectionString(connString)
 
         expect(result).to.deep.equal({
           database: 'database1',
@@ -495,7 +489,7 @@ describe('DatabaseResolver', function () {
 
       it('parses connection string with no port specified', function () {
         const connString = 'postgres://user1:[email protected]/database1'
-        const result = databaseResolver.parsePostgresConnectionString(connString)
+        const result = DatabaseResolver.parsePostgresConnectionString(connString)
 
         expect(result).to.deep.equal({
           database: 'database1',
@@ -510,7 +504,7 @@ describe('DatabaseResolver', function () {
 
       it('parses connection string with custom port', function () {
         const connString = 'postgres://user1:[email protected]:5433/database1'
-        const result = databaseResolver.parsePostgresConnectionString(connString)
+        const result = DatabaseResolver.parsePostgresConnectionString(connString)
 
         expect(result).to.deep.equal({
           database: 'database1',
@@ -527,7 +521,7 @@ describe('DatabaseResolver', function () {
     describe('when parsing database names (without connection string format)', function () {
       it('converts database name to full connection string format', function () {
         const dbName = 'my_database'
-        const result = databaseResolver.parsePostgresConnectionString(dbName)
+        const result = DatabaseResolver.parsePostgresConnectionString(dbName)
 
         expect(result).to.deep.equal({
           database: 'my_database',
@@ -547,7 +541,7 @@ describe('DatabaseResolver', function () {
           PGPORT: '5433',
         }
         const connString = 'postgres://user1:[email protected]/database1'
-        const result = databaseResolver.parsePostgresConnectionString(connString)
+        const result = DatabaseResolver.parsePostgresConnectionString(connString)
 
         expect(result.port).to.equal('5433')
       })
@@ -557,7 +551,7 @@ describe('DatabaseResolver', function () {
           PGPORT: '5433',
         }
         const dbName = 'my_database'
-        const result = databaseResolver.parsePostgresConnectionString(dbName)
+        const result = DatabaseResolver.parsePostgresConnectionString(dbName)
 
         expect(result.port).to.equal('5433')
       })
@@ -567,7 +561,7 @@ describe('DatabaseResolver', function () {
           PGPORT: '5433',
         }
         const connString = 'postgres://user1:[email protected]:5434/database1'
-        const result = databaseResolver.parsePostgresConnectionString(connString)
+        const result = DatabaseResolver.parsePostgresConnectionString(connString)
 
         expect(result.port).to.equal('5434')
       })
@@ -577,7 +571,7 @@ describe('DatabaseResolver', function () {
           PGPORT: '5433',
         }
         const dbName = 'my_database'
-        const result = databaseResolver.parsePostgresConnectionString(dbName)
+        const result = DatabaseResolver.parsePostgresConnectionString(dbName)
 
         expect(result.port).to.equal('5433')
       })
@@ -587,23 +581,23 @@ describe('DatabaseResolver', function () {
       it('uses default port 5432 when no port is specified in connection string', function () {
         process.env = {}
         const connString = 'postgres://user1:[email protected]/database1'
-        const result = databaseResolver.parsePostgresConnectionString(connString)
+        const result = DatabaseResolver.parsePostgresConnectionString(connString)
 
         expect(result.port).to.equal('5432')
       })
 
       it('doesn\'t set a port when parsing database name without connection string', function () {
         process.env = {}
         const dbName = 'my_database'
-        const result = databaseResolver.parsePostgresConnectionString(dbName)
+        const result = DatabaseResolver.parsePostgresConnectionString(dbName)
 
         expect(result.port).to.equal('')
       })
 
       it('doesn\'t set a port when connection string has no port and no hostname', function () {
         process.env = {}
         const dbName = 'my_database'
-        const result = databaseResolver.parsePostgresConnectionString(dbName)
+        const result = DatabaseResolver.parsePostgresConnectionString(dbName)
 
         expect(result.port).to.equal('')
       })