Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Add check to pkg command to deal with empty values #6902

Merged
merged 14 commits into from
Oct 16, 2023
Merged

fix: Add check to pkg command to deal with empty values #6902

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
8924565
Discern result key from overlapping value
NeonArray Oct 13, 2023
61f7266
Add test for multiple args and empty value
NeonArray Oct 13, 2023
a1963b0
Revert overlap check
NeonArray Oct 13, 2023
7e8639f
Return empty string if prop exists and undef
NeonArray Oct 13, 2023
49e9e44
Modify error message for accuracy
NeonArray Oct 13, 2023
c654451
Add view test for empty value
NeonArray Oct 13, 2023
e808248
Add empty property to yellow
NeonArray Oct 13, 2023
6bf0fff
Remove version tag from test
NeonArray Oct 16, 2023
d017ecb
Update view snapshot
NeonArray Oct 16, 2023
4ed95aa
Check for explicit boolean value
NeonArray Oct 16, 2023
8fb8ddf
Return value instead of _data[k]
NeonArray Oct 16, 2023
6fdc97f
Simplify check to only return undefined
NeonArray Oct 16, 2023
1c71e20
Remove temporary var value
NeonArray Oct 16, 2023
b4ea660
Replace undefined check with hasOwn
NeonArray Oct 16, 2023
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
16 changes: 8 additions & 8 deletions lib/utils/queryable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,14 +111,14 @@ const getter = ({ data, key }) => {
}, {})
return _data
} else {
// if can't find any more values, it means it's just over
// and there's nothing to return
if (!_data[k]) {
return undefined
}

// otherwise sets the next value
_data = _data[k]
const value = _data[k]
if (typeof value === 'boolean' || (value === '' && Object.hasOwn(_data, k))) {
_data = value
} else if (value === undefined) {
Copy link
Member

@wraithgar wraithgar Oct 16, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if value === undefined and value = _data[k] then returning _data[k] would return undefined anyways. Not sure what this check gains us.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, I did overcomplicate that. The undefined check is needed since other functionality/tests expect it to be returned and not just set to _data.

I simplified it so now it only returns undefined, else just sets up _data = value

Copy link
Member

@wraithgar wraithgar Oct 16, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

> The undefined check is needed since other functionality/tests expect it to be returned and not just set to _data.

Can you show me where this is happening? That still seems very counterintuitive.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oooooh I see it now. we're not returning otherwise. My bad!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK I think we're getting somewhere. I think this check should be JUST a hasOwn, and if that's false we return undefined. Otherwise we let it fall through.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That works, change has been made

return undefined
} else {
_data = _data[k]
}
}

label += k
Expand Down
4 changes: 4 additions & 0 deletions tap-snapshots/test/lib/commands/view.js.test.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,10 @@ maintainers[0].name = 'claudia'
maintainers[1].name = 'isaacs'
`

exports[`test/lib/commands/view.js TAP specific field names fields with empty values > must match snapshot 1`] = `

`

exports[`test/lib/commands/view.js TAP specific field names maintainers with email > must match snapshot 1`] = `
maintainers = [
{ name: 'claudia', email: '[email protected]', twitter: 'cyellow' },
Expand Down
44 changes: 44 additions & 0 deletions test/lib/commands/pkg.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,50 @@ t.test('get single arg', async t => {
)
})

t.test('get multiple arg', async t => {
const { pkg, OUTPUT } = await mockNpm(t, {
prefixDir: {
'package.json': JSON.stringify({
name: 'foo',
version: '1.1.1',
}),
},
})

await pkg('get', 'name', 'version')

t.strictSame(
JSON.parse(OUTPUT()),
{
name: 'foo',
version: '1.1.1',
},
'should print retrieved package.json field'
)
})

t.test('get multiple arg with empty value', async t => {
const { pkg, OUTPUT } = await mockNpm(t, {
prefixDir: {
'package.json': JSON.stringify({
name: 'foo',
author: '',
}),
},
})

await pkg('get', 'name', 'author')

t.strictSame(
JSON.parse(OUTPUT()),
{
name: 'foo',
author: '',
},
'should print retrieved package.json field regardless of empty value'
)
})

t.test('get nested arg', async t => {
const { pkg, OUTPUT } = await mockNpm(t, {
prefixDir: {
Expand Down
6 changes: 6 additions & 0 deletions test/lib/commands/view.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ const packument = (nv, opts) => {
email: '[email protected]',
twitter: 'foo',
},
empty: '',
readme: 'a very useful readme',
versions: {
'1.0.0': {
Expand Down Expand Up @@ -425,6 +426,11 @@ t.test('specific field names', async t => {
await view.exec(['[email protected]', 'maintainers.name'])
t.matchSnapshot(outputs.join('\n'))
})

t.test('fields with empty values', async t => {
await view.exec(['yellow', 'empty'])
t.matchSnapshot(outputs.join('\n'))
})
})

t.test('throw error if global mode', async t => {
Expand Down