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

feat(shell-api): Support boolean "true" with currentOp MONGOSH-1131 #1219

Merged
merged 2 commits into from
Mar 10, 2022
Merged

feat(shell-api): Support boolean "true" with currentOp MONGOSH-1131 #1219

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a736605
Support boolean "true" with currentOp
leorossi Mar 1, 2022
13df548
adds support for falsy parameter
leorossi Mar 1, 2022
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
11 changes: 11 additions & 0 deletions packages/shell-api/src/database.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1555,6 +1555,17 @@ describe('Database', () => {
{ currentOp: 1 }
);
});
it('allows boolean parameter', async() => {
await database.currentOp(true);

expect(serviceProvider.runCommandWithCheck).to.have.been.calledWith(
ADMIN_DB,
{
currentOp: 1,
$all: true
}
);
});
it('calls serviceProvider.runCommandWithCheck on the database with options', async() => {
await database.currentOp({
$ownOps: true,
Expand Down
5 changes: 4 additions & 1 deletion packages/shell-api/src/database.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -787,8 +787,11 @@ export default class Database extends ShellApiWithMongoClass {

@returnsPromise
@apiVersions([])
async currentOp(opts: Document = {}): Promise<Document> {
async currentOp(opts: Document | boolean = {}): Promise<Document> {
this._emitDatabaseApiCall('currentOp', { opts: opts });
if (opts === true) {
opts = { $all: true };
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you want something like

Suggested change
if (opts === true) {
opts = { $all: true };
if (typeof opts === 'boolean') {
opts = { $all: opts };

even though it probably won’t be used with false as an argument much?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

By documentation it seems that only true is an accepted value. It's not clear what happens using false as value.

Copy link
Contributor

Choose a reason for hiding this comment

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

I mean, passing false is the same as passing no argument, but the docs do explicitly say “Can pass either a boolean or a document”.

(The legacy shell just ignores the argument entirely if it is false: https://github.com/mongodb/mongo/blob/8c85963c5e8e6cec0ba996de80e3cc7aa5a6b39d/src/mongo/shell/db.js#L835)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok makes sense. Added this case and related test case.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think you might have forgotten to git push? :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, exactly, now the ocde is updated

}
return await this._runAdminCommand(
{
currentOp: 1,
Expand Down