heroku 10.13.2 → 11.0.0-alpha.2

package/lib/lib/pg/fetcher.js

@@ -1,137 +1,163 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRelease = exports.database = exports.getAddon = exports.getAttachment = exports.all = exports.arbitraryAppDB = void 0;
-const api_client_1 = require("@heroku-cli/command/lib/api-client");
-const debug_1 = require("debug");
-const resolve_1 = require("../addons/resolve");
-const bastion_1 = require("./bastion");
-const config_1 = require("./config");
-const color_1 = require("@heroku-cli/color");
-const util_1 = require("./util");
-const pgDebug = (0, debug_1.default)('pg');
-async function arbitraryAppDB(heroku, app) {
-    // Since Postgres backups are tied to the app and not the add-on, but
-    // we require *an* add-on to interact with, make sure that add-on is
-    // attached to the right app.
-    pgDebug(`fetching arbitrary app db on ${app}`);
-    const { body: addons } = await heroku.get(`/apps/${app}/addons`);
-    const addon = addons.find(a => { var _a, _b, _c; return ((_a = a === null || a === void 0 ? void 0 : a.app) === null || _a === void 0 ? void 0 : _a.name) === app && ((_c = (_b = a === null || a === void 0 ? void 0 : a.plan) === null || _b === void 0 ? void 0 : _b.name) === null || _c === void 0 ? void 0 : _c.startsWith('heroku-postgresql')); });
-    if (!addon)
-        throw new Error(`No heroku-postgresql databases on ${app}`);
-    return addon;
+export {};
+/*
+import {APIClient} from '@heroku-cli/command'
+import type {AddOnAttachment} from '@heroku-cli/schema'
+import * as Heroku from '@heroku-cli/schema'
+import {HerokuAPIError} from '@heroku-cli/command/lib/api-client'
+import debug from 'debug'
+import {AmbiguousError, appAttachment} from '../addons/resolve'
+import {fetchConfig} from './bastion'
+import {getConfig} from './config'
+import color from '@heroku-cli/color'
+import type {AddOnAttachmentWithConfigVarsAndPlan, AddOnWithRelatedData} from './types'
+import {bastionKeyPlan, getConfigVarName, getConnectionDetails} from './util'
+
+const pgDebug = debug('pg')
+
+export async function arbitraryAppDB(heroku: APIClient, app: string) {
+  // Since Postgres backups are tied to the app and not the add-on, but
+  // we require *an* add-on to interact with, make sure that add-on is
+  // attached to the right app.
+
+  pgDebug(`fetching arbitrary app db on ${app}`)
+  const {body: addons} = await heroku.get<Heroku.AddOn[]>(`/apps/${app}/addons`)
+  const addon = addons.find(a => a?.app?.name === app && a?.plan?.name?.startsWith('heroku-postgresql'))
+  if (!addon) throw new Error(`No heroku-postgresql databases on ${app}`)
+  return addon
 }
-exports.arbitraryAppDB = arbitraryAppDB;
-function getAttachmentNamesByAddon(attachments) {
-    return attachments.reduce((results, a) => {
-        results[a.addon.id] = (results[a.addon.id] || []).concat(a.name);
-        return results;
-    }, {});
+
+function getAttachmentNamesByAddon(attachments: AddOnAttachmentWithConfigVarsAndPlan[]): AddOnAttachmentWithConfigVarsAndPlan {
+  return attachments.reduce((results: any, a) => {
+    results[a.addon.id] = (results[a.addon.id] || []).concat(a.name)
+    return results
+  }, {})
 }
-async function all(heroku, app_id) {
-    const { uniqBy } = require('lodash');
-    pgDebug(`fetching all DBs on ${app_id}`);
-    const attachments = await allAttachments(heroku, app_id);
-    let addons = attachments.map(a => a.addon);
-    // Get the list of attachment names per addon here and add to each addon obj
-    const attachmentNamesByAddon = getAttachmentNamesByAddon(attachments);
-    addons = uniqBy(addons, 'id');
-    addons.forEach(addon => {
-        addon.attachment_names = attachmentNamesByAddon[addon.id];
-    });
-    return addons;
+
+export async function all(heroku: APIClient, app_id: string): Promise<AddOnWithRelatedData[]> {
+  const {uniqBy} = require('lodash')
+
+  pgDebug(`fetching all DBs on ${app_id}`)
+
+  const attachments = await allAttachments(heroku, app_id)
+  let addons: AddOnWithRelatedData[] = attachments.map(a => a.addon)
+
+  // Get the list of attachment names per addon here and add to each addon obj
+  const attachmentNamesByAddon = getAttachmentNamesByAddon(attachments)
+  addons = uniqBy(addons, 'id')
+  addons.forEach(addon => {
+    addon.attachment_names = attachmentNamesByAddon[addon.id]
+  })
+
+  return addons
 }
-exports.all = all;
-async function matchesHelper(heroku, app, db, namespace) {
-    var _a;
-    (0, debug_1.default)(`fetching ${db} on ${app}`);
-    const addonService = process.env.HEROKU_POSTGRESQL_ADDON_NAME || 'heroku-postgresql';
-    (0, debug_1.default)(`addon service: ${addonService}`);
-    try {
-        const attached = await (0, resolve_1.appAttachment)(heroku, app, db, { addon_service: addonService, namespace });
-        return ({ matches: [attached] });
+
+async function matchesHelper(heroku: APIClient, app: string, db: string, namespace?: string): Promise<{matches: AddOnAttachment[] | null, error?: AmbiguousError | HerokuAPIError}> {
+  debug(`fetching ${db} on ${app}`)
+
+  const addonService = process.env.HEROKU_POSTGRESQL_ADDON_NAME || 'heroku-postgresql'
+  debug(`addon service: ${addonService}`)
+  try {
+    const attached = await appAttachment(heroku, app, db, {addon_service: addonService, namespace})
+    return ({matches: [attached]})
+  } catch (error) {
+    if (error instanceof AmbiguousError && error.body?.id === 'multiple_matches' && error.matches) {
+      return {matches: error.matches, error}
     }
-    catch (error) {
-        if (error instanceof resolve_1.AmbiguousError && ((_a = error.body) === null || _a === void 0 ? void 0 : _a.id) === 'multiple_matches' && error.matches) {
-            return { matches: error.matches, error };
-        }
-        if (error instanceof api_client_1.HerokuAPIError && error.http.statusCode === 404 && error.body && error.body.id === 'not_found') {
-            return { matches: null, error };
-        }
-        throw error;
+
+    if (error instanceof HerokuAPIError && error.http.statusCode === 404 && error.body && error.body.id === 'not_found') {
+      return {matches: null, error}
     }
+
+    throw error
+  }
 }
-async function getAttachment(heroku, app, db = 'DATABASE_URL', namespace = '') {
-    var _a;
-    const matchesOrError = await matchesHelper(heroku, app, db, namespace);
-    let { matches } = matchesOrError;
-    const { error } = matchesOrError;
-    // happy path where the resolver matches just one
-    if (matches && matches.length === 1) {
-        return matches[0];
+
+export async function getAttachment(heroku: APIClient, app: string, db = 'DATABASE_URL', namespace = ''): Promise<Required<AddOnAttachment & {addon: AddOnAttachmentWithConfigVarsAndPlan}>> {
+  const matchesOrError = await matchesHelper(heroku, app, db, namespace)
+  let {matches} = matchesOrError
+  const {error} = matchesOrError
+  // happy path where the resolver matches just one
+  if (matches && matches.length === 1) {
+    return matches[0] as Required<AddOnAttachment & {addon: AddOnAttachmentWithConfigVarsAndPlan}>
+  }
+
+  // case for 404 where there are implicit attachments
+  if (!matches) {
+    const appConfigMatch = /^(.+?)::(.+)/.exec(db)
+    if (appConfigMatch) {
+      app = appConfigMatch[1]
+      db = appConfigMatch[2]
     }
-    // case for 404 where there are implicit attachments
-    if (!matches) {
-        const appConfigMatch = /^(.+?)::(.+)/.exec(db);
-        if (appConfigMatch) {
-            app = appConfigMatch[1];
-            db = appConfigMatch[2];
-        }
-        if (!db.endsWith('_URL')) {
-            db += '_URL';
-        }
-        const [config = {}, attachments] = await Promise.all([
-            (0, config_1.getConfig)(heroku, app),
-            allAttachments(heroku, app),
-        ]);
-        if (attachments.length === 0) {
-            throw new Error(`${color_1.default.app(app)} has no databases`);
-        }
-        matches = attachments.filter(attachment => config[db] && config[db] === config[(0, util_1.getConfigVarName)(attachment.config_vars)]);
-        if (matches.length === 0) {
-            const validOptions = attachments.map(attachment => (0, util_1.getConfigVarName)(attachment.config_vars));
-            throw new Error(`Unknown database: ${db}. Valid options are: ${validOptions.join(', ')}`);
-        }
+
+    if (!db.endsWith('_URL')) {
+      db += '_URL'
     }
-    // case for multiple attachments with passedDb
-    const first = matches[0];
-    // case for 422 where there are ambiguous attachments that are equivalent
-    if (matches.every(match => { var _a, _b, _c, _d; return ((_a = first.addon) === null || _a === void 0 ? void 0 : _a.id) === ((_b = match.addon) === null || _b === void 0 ? void 0 : _b.id) && ((_c = first.app) === null || _c === void 0 ? void 0 : _c.id) === ((_d = match.app) === null || _d === void 0 ? void 0 : _d.id); })) {
-        const config = (_a = await (0, config_1.getConfig)(heroku, first.app.name)) !== null && _a !== void 0 ? _a : {};
-        if (matches.every(match => config[(0, util_1.getConfigVarName)(first.config_vars)] === config[(0, util_1.getConfigVarName)(match.config_vars)])) {
-            return first;
-        }
+
+    const [config = {}, attachments] = await Promise.all([
+      getConfig(heroku, app),
+      allAttachments(heroku, app),
+    ])
+
+    if (attachments.length === 0) {
+      throw new Error(`${color.app(app)} has no databases`)
     }
-    throw error;
+
+    matches = attachments.filter(attachment => config[db] && config[db] === config[getConfigVarName(attachment.config_vars as string[])])
+
+    if (matches.length === 0) {
+      const validOptions = attachments.map(attachment => getConfigVarName(attachment.config_vars as string[]))
+      throw new Error(`Unknown database: ${db}. Valid options are: ${validOptions.join(', ')}`)
+    }
+  }
+
+  // case for multiple attachments with passedDb
+  const first = matches[0] as Required<AddOnAttachment & {addon: AddOnAttachmentWithConfigVarsAndPlan}>
+
+  // case for 422 where there are ambiguous attachments that are equivalent
+  if (matches.every(match => first.addon?.id === match.addon?.id && first.app?.id === match.app?.id)) {
+    const config = await getConfig(heroku, first.app.name as string) ?? {}
+
+    if (matches.every(match => config[getConfigVarName(first.config_vars)] === config[getConfigVarName(match.config_vars)])) {
+      return first
+    }
+  }
+
+  throw error
 }
-exports.getAttachment = getAttachment;
-async function allAttachments(heroku, app_id) {
-    const { body: attachments } = await heroku.get(`/apps/${app_id}/addon-attachments`, {
-        headers: { 'Accept-Inclusion': 'addon:plan,config_vars' },
-    });
-    return attachments.filter((a) => { var _a, _b; return (_b = (_a = a.addon.plan) === null || _a === void 0 ? void 0 : _a.name) === null || _b === void 0 ? void 0 : _b.startsWith('heroku-postgresql'); });
+
+async function allAttachments(heroku: APIClient, app_id: string): Promise<AddOnAttachmentWithConfigVarsAndPlan[]> {
+  const {body: attachments} = await heroku.get<AddOnAttachmentWithConfigVarsAndPlan[]>(`/apps/${app_id}/addon-attachments`, {
+    headers: {'Accept-Inclusion': 'addon:plan,config_vars'},
+  })
+  return attachments.filter((a: AddOnAttachmentWithConfigVarsAndPlan) => a.addon.plan?.name?.startsWith('heroku-postgresql'))
 }
-async function getAddon(heroku, app, db = 'DATABASE_URL') {
-    return (await getAttachment(heroku, app, db)).addon;
+
+export async function getAddon(heroku: APIClient, app: string, db = 'DATABASE_URL') {
+  return (await getAttachment(heroku, app, db)).addon
 }
-exports.getAddon = getAddon;
-async function database(heroku, app, db, namespace) {
-    const attached = await getAttachment(heroku, app, db, namespace);
-    // would inline this as well but in some cases attachment pulls down config
-    // as well, and we would request twice at the same time but I did not want
-    // to push this down into attachment because we do not always need config
-    const config = await (0, config_1.getConfig)(heroku, attached.app.name);
-    const database = (0, util_1.getConnectionDetails)(attached, config);
-    if ((0, util_1.bastionKeyPlan)(attached.addon) && !database.bastionKey) {
-        const { body: bastionConfig } = await (0, bastion_1.fetchConfig)(heroku, attached.addon);
-        const bastionHost = bastionConfig.host;
-        const bastionKey = bastionConfig.private_key;
-        Object.assign(database, { bastionHost, bastionKey });
-    }
-    return database;
+
+export async function database(heroku: APIClient, app: string, db?: string, namespace?: string) {
+  const attached = await getAttachment(heroku, app, db, namespace)
+
+  // would inline this as well but in some cases attachment pulls down config
+  // as well, and we would request twice at the same time but I did not want
+  // to push this down into attachment because we do not always need config
+  const config = await getConfig(heroku, attached.app.name as string)
+
+  const database = getConnectionDetails(attached, config)
+  if (bastionKeyPlan(attached.addon) && !database.bastionKey) {
+    const {body: bastionConfig} = await fetchConfig(heroku, attached.addon)
+    const bastionHost = bastionConfig.host
+    const bastionKey = bastionConfig.private_key
+
+    Object.assign(database, {bastionHost, bastionKey})
+  }
+
+  return database
 }
-exports.database = database;
-async function getRelease(heroku, appName, id) {
-    const { body: release } = await heroku.get(`/apps/${appName}/releases/${id}`);
-    return release;
+
+export async function getRelease(heroku: APIClient, appName: string, id: string) {
+  const {body: release} = await heroku.get<Heroku.Release>(`/apps/${appName}/releases/${id}`)
+  return release
 }
-exports.getRelease = getRelease;
+*/

package/lib/lib/pg/host.js

@@ -1,6 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-function default_1() {
+export default function () {
     return process.env.HEROKU_DATA_HOST || 'api.data.heroku.com';
 }
-exports.default = default_1;

package/lib/lib/pg/psql.d.ts

@@ -1,48 +1 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-import { SpawnOptions, type SpawnOptionsWithStdioTuple } from 'child_process';
-import type { ChildProcess } from 'node:child_process';
-import { EventEmitter } from 'node:events';
-import type { Server } from 'node:net';
-import { Stream } from 'node:stream';
-import { getConfigs, TunnelConfig } from './bastion';
-import { ConnectionDetails, getConnectionDetails } from './util';
-export declare function psqlQueryOptions(query: string, dbEnv: NodeJS.ProcessEnv, cmdArgs?: string[]): {
-    dbEnv: NodeJS.ProcessEnv;
-    psqlArgs: string[];
-    childProcessOptions: SpawnOptionsWithStdioTuple<"ignore", "pipe", "inherit">;
-};
-export declare function psqlFileOptions(file: string, dbEnv: NodeJS.ProcessEnv): {
-    dbEnv: NodeJS.ProcessEnv;
-    psqlArgs: string[];
-    childProcessOptions: SpawnOptions;
-};
-export declare function psqlInteractiveOptions(prompt: string, dbEnv: NodeJS.ProcessEnv): {
-    dbEnv: NodeJS.ProcessEnv;
-    psqlArgs: string[];
-    childProcessOptions: SpawnOptions;
-};
-export declare function execPSQL({ dbEnv, psqlArgs, childProcessOptions }: {
-    dbEnv: NodeJS.ProcessEnv;
-    psqlArgs: string[];
-    childProcessOptions: SpawnOptions;
-}): ChildProcess;
-export declare function waitForPSQLExit(psql: EventEmitter): Promise<void>;
-export declare const trapAndForwardSignalsToChildProcess: (childProcess: ChildProcess) => () => void;
-export declare function consumeStream(inputStream: Stream): Promise<unknown>;
-export declare function runWithTunnel(db: ConnectionDetails, tunnelConfig: TunnelConfig, options: Parameters<typeof execPSQL>[0]): Promise<string>;
-export declare class Tunnel {
-    private readonly bastionTunnel;
-    private readonly events;
-    constructor(bastionTunnel: Server);
-    waitForClose(): Promise<void>;
-    close(): void;
-    static connect(db: ConnectionDetails, tunnelConfig: TunnelConfig): Promise<Tunnel>;
-}
-export declare function fetchVersion(db: Parameters<typeof exec>[0]): Promise<string | undefined>;
-export declare function exec(db: ConnectionDetails, query: string, cmdArgs?: string[]): Promise<string>;
-export declare function execFile(db: Parameters<typeof getConfigs>[0], file: string): Promise<string>;
-export declare function interactive(db: ReturnType<typeof getConnectionDetails>): Promise<string>;
+export {};