Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions packages/pg/lib/defaults.js
Original file line number Diff line number Diff line change
@@ -1,18 +1,33 @@
'use strict'

let user
try {
user = process.platform === 'win32' ? process.env.USERNAME : process.env.USER
} catch {
// ignore, e.g., Deno without --allow-env
// the operating system user, read on the first access of `user` rather than at module load
const readUser = function () {
try {
return process.platform === 'win32' ? process.env.USERNAME : process.env.USER
} catch {
// ignore, e.g., Deno without --allow-env
return undefined
}
}

module.exports = {
// a plain data property, as the object literal entry `user` would have created
const defineUser = function (target, value) {
Object.defineProperty(target, 'user', { value, writable: true, enumerable: true, configurable: true })
}

const defaults = (module.exports = {
// database host. defaults to localhost
host: 'localhost',

// database user's name
user,
// database user's name (read on first access, then a plain data property)
get user() {
const value = readUser()
defineUser(defaults, value)
return value
},
set user(value) {
defineUser(this, value)
},

// name of database to connect
database: undefined,
Expand Down Expand Up @@ -80,7 +95,7 @@ module.exports = {
keepalives: 1,

keepalives_idle: 0,
}
})

const pgTypes = require('pg-types')
// save default parsers
Expand Down
102 changes: 102 additions & 0 deletions packages/pg/test/unit/defaults-tests.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
'use strict'
const helper = require('./test-helper')
const assert = require('assert')
const suite = new helper.Suite()
const test = suite.test.bind(suite)

const userKey = process.platform === 'win32' ? 'USERNAME' : 'USER'
const modulePath = require.resolve('../../lib/defaults')

// load a fresh copy of lib/defaults.js while recording which environment keys are read
const loadDefaults = function (env) {
const reads = []
const realEnv = process.env
const savedModule = require.cache[modulePath]
delete require.cache[modulePath]
process.env = new Proxy(Object.assign({}, env), {
get(target, key) {
reads.push(key)
return target[key]
},
})
let defaults
try {
defaults = require(modulePath)
} finally {
process.env = realEnv
if (savedModule) {
require.cache[modulePath] = savedModule
} else {
delete require.cache[modulePath]
}
}
return { defaults, reads }
}

test('defaults.user', function () {
test('is not read from the environment when the module is loaded', function () {
const { reads } = loadDefaults({ [userKey]: 'alice' })
assert.deepEqual(reads, [])
})

test('is read on first access and then stays a plain data property', function () {
const realEnv = process.env
const { defaults } = loadDefaults({})
process.env = { [userKey]: 'alice' }
try {
assert.equal(defaults.user, 'alice')
process.env = { [userKey]: 'bob' }
assert.equal(defaults.user, 'alice')
} finally {
process.env = realEnv
}
assert.deepEqual(Object.getOwnPropertyDescriptor(defaults, 'user'), {
value: 'alice',
writable: true,
enumerable: true,
configurable: true,
})
})

test('keeps its position in the key order', function () {
const { defaults } = loadDefaults({})
assert.deepEqual(Object.keys(defaults).slice(0, 3), ['host', 'user', 'database'])
})

test('can be assigned before it is read', function () {
const { defaults } = loadDefaults({ [userKey]: 'alice' })
defaults.user = 'carol'
assert.equal(defaults.user, 'carol')
assert.deepEqual(Object.getOwnPropertyDescriptor(defaults, 'user'), {
value: 'carol',
writable: true,
enumerable: true,
configurable: true,
})
})

test('can be deleted before it is read', function () {
const { defaults } = loadDefaults({ [userKey]: 'alice' })
delete defaults.user
assert.equal(defaults.user, undefined)
assert.equal('user' in defaults, false)
})

test('is undefined when the environment cannot be read', function () {
const realEnv = process.env
const { defaults } = loadDefaults({})
process.env = new Proxy(
{},
{
get() {
throw new Error('env access denied')
},
}
)
try {
assert.strictEqual(defaults.user, undefined)
} finally {
process.env = realEnv
}
})
})
Loading