created pg setting for log min error statements (#2992)

packages/cli/src/commands/pg/settings/log-min-error-statement.ts

@@ -0,0 +1,27 @@
+import {Args} from '@oclif/core'
+import heredoc from 'tsheredoc'
+import {PGSettingsCommand} from '../../../lib/pg/setter'
+import type {Setting, SettingKey} from '../../../lib/pg/types'
+
+export default class LogMinErrorStatement extends PGSettingsCommand {
+ static description = heredoc(`
+ log-min-error-statement controls the logging of SQL statements that cause an error at a specified severity level.
+ This setting is useful to prevent logging SQL queries that might contain sensitive information.
+ Use this setting to prevent logging SQL queries that contain sensitive information. Default is "error".
+ `)
+
+ static args = {
+ database: Args.string(),
+ value: Args.string({options: ['error', 'log', 'fatal', 'panic']}),
+ }
+
+ protected settingKey: SettingKey = 'log_min_error_statement'
+
+ protected convertValue(val: string): string {
+ return val
+ }
+
+ protected explain(setting: Setting<string>) {
+ return setting.values[setting.value]
+ }
+}

packages/cli/src/lib/pg/types.ts

@@ -210,6 +210,7 @@ export type SettingKey =
  'log_lock_waits'
  | 'log_connections'
  | 'log_min_duration_statement'
+ | 'log_min_error_statement'
  | 'log_statement'
  | 'track_functions'
  | 'pgbouncer_max_client_conn'

packages/cli/test/unit/commands/pg/settings/log-min-error-statement.test.ts

@@ -0,0 +1,47 @@
+import {expect} from '@oclif/test'
+import * as nock from 'nock'
+import {stdout} from 'stdout-stderr'
+import heredoc from 'tsheredoc'
+import runCommand from '../../../../helpers/runCommand'
+import Cmd from '../../../../../src/commands/pg/settings/log-min-error-statement'
+import * as fixtures from '../../../../fixtures/addons/fixtures'
+
+describe('pg:settings:log-min-error-statement', function () {
+ const addon = fixtures.addons['dwh-db']
+
+ beforeEach(function () {
+ nock('https://api.heroku.com')
+ .post('/actions/addons/resolve', {
+ app: 'myapp',
+ addon: 'test-database',
+ }).reply(200, [addon])
+ })
+
+ afterEach(function () {
+ nock.cleanAll()
+ })
+
+ it('shows settings for log_min_error_statement', async function () {
+ nock('https://api.data.heroku.com')
+ .get(`/postgres/v0/databases/${addon.id}/config`)
+ .reply(200, {
+ log_min_error_statement: {
+ value: 'error',
+ desc: 'Specify the minimum severity level of SQL errors to be logged.',
+ default: 'error',
+ values: {
+ error: 'Logs all ERROR, LOG, FATAL, and PANIC level messages. (Default)',
+ log: 'Logs all LOG, FATAL, and PANIC level messages.',
+ fatal: 'Logs all FATAL and PANIC level messages.',
+ panic: 'Logs only PANIC level messages.',
+ },
+ },
+ })
+
+ await runCommand(Cmd, ['--app', 'myapp', 'test-database'])
+ expect(stdout.output).to.equal(heredoc(`
+ log-min-error-statement is set to error for ${addon.name}.
+ Logs all ERROR, LOG, FATAL, and PANIC level messages. (Default)
+ `))
+ })
+})