(#3709) Add support for ordering strategies using a new `--order-by` argument on the search command #1619

bartvanandel · 2018-07-20T20:59:16Z

Description Of Changes

This change adds a new command line option "order-by", allowing the user to specify a few sorting strategies. By default the results will be sorted by id.

Motivation and Context

To allow uses to decide how they want the results being sorted when we can.

Testing

These tests assume you only have the Chocolatey Community Repository enabled as a source.

Do a search using choco search chrome --order-by='id'
Verify the resulting set is ordered by the Identifier with the first entry being 1password-chrome
Do the same search using --order-by='title'
Verify the first entry is choco-protocol-support (It is prefixed with (unofficial) in the title, and is expected to be the first result in this case.
Search again using --order-by='popularity'
Verify the package with most downloads is returned first (at this time it is GoogleChrome).
Search again using --order-by='unsorted'
Go to https://community.chocolatey.org/packages` and enter chrome in the search box and hit enter.
Verify the order of the search on Chocolatey Community Repository and the results from Chocolatey CLI is in the same/similar order.
Search again using --order-by='LastPublished'.
Verify a yellow warning is outputted with the text Order By 'LastPublished' has been specified. This order is done on client side and may lead to inconsistently ordered results.
Go to the website search previously made, and change the dropdown for the order to Recent.
Verify the order of packages is similar to the output from the Chocolatey CLI output (they may not be exactly the same due to client sort).
Search again using --order-by='other'.
Verify an error is outputted with the message Error: The order-by clause 'other' is not recognized. Use one of the supported clauses: 'Id', 'LastPublished', 'Popularity', 'Title', 'Unsorted'..

Operating Systems Testing

Windows 11

Change Types Made

Feature / Enhancement (non-breaking change).

Change Checklist

Requires a change to the documentation.
Tests to cover my changes, have been added.
All new and existing tests passed?

Related Issue

Fixes #3709

Additional Information

Note that some results may appear out-of-order, this is caused by the NuGet server returning them in the incorrect order, see chocolatey/NuGet.Server-chocolatey#2

src/chocolatey/infrastructure.app/commands/ChocolateyListCommand.cs

src/chocolatey/infrastructure.app/domain/PackageOrder.cs

src/chocolatey/infrastructure.app/nuget/NugetList.cs

ferventcoder

Hi @bartvanandel, thanks for taking a stab, this is a great start! I left a couple of comments here for you to look at. Apologies on not getting back sooner. We tend to sit the project down for a bit and then pick it up when we get closer to release. If you are unable make the adjustments, we can always take a look at them for you - however they are not as likely to make it into this release. HTH

ferventcoder · 2019-01-18T01:06:00Z

Minor nitpick, the git commit body (the message) needs to split at 72/80 characters as well.

bartvanandel · 2019-01-18T11:33:41Z

Minor nitpick, the git commit body (the message) needs to split at 72/80 characters as well.

Do you want 72 or 80?

ferventcoder · 2019-01-18T13:51:38Z

72 is what CONTRIBUTING states -
https://github.com/chocolatey/choco/blob/master/CONTRIBUTING.md#prepare-commits

bartvanandel · 2019-01-20T22:00:47Z

Wrapped commit body at 72 chars as requested.

bartvanandel · 2019-01-28T18:37:43Z

Just pushed a change to satisfy AppVeyor. Unfortunately Travis crashed before compilation even started. Anyway, any other changes you require before you decide to merge this pull request?

bartvanandel · 2020-05-01T18:00:01Z

@ferventcoder I put some effort into this branch 22 to 15 months ago, you requested some changes which I resolved back then, but after that, silence... I can try to rebase this onto current master (or merge master into this branch, which seems reasonable enough to me, you can squash merge anyway), but are you going to try and merge it after I do? The issue is still open so I assume it's still not fixed, but I don't feel like putting effort into this and being neglected again.

CLAassistant · 2020-06-08T14:49:33Z

All committers have signed the CLA.

bartvanandel · 2020-06-09T12:57:07Z

Weird. Codacy says there are 2 new issues, but when diving into the details by following the links you end up not seeing them in code. Also, Travis fails with an internal error, I don't think I can fix that. @ferventcoder can you see what's going on?

ferventcoder · 2020-06-10T04:49:48Z

@bartvanandel Yes, these are good changes. You can rebase or we can manage the rebase for you. I would say ignore Codacy at this point. I think Travis is likely failing here due to the merge conflict as it is trying to build/run it as if it is merged in.

bartvanandel · 2020-06-10T10:12:03Z

Well, happy to contribute! I think it's probably fastest if you do the rebase, as you know better about what has changed than I do (I basically don't have a clue at this point ;-) and you can merge directly when it's done.

bartvanandel · 2020-07-13T20:28:11Z

@ferventcoder any progress on this PR?

bartvanandel · 2020-07-25T19:41:48Z

@ferventcoder hello?

bartvanandel · 2020-08-15T12:14:48Z

@ferventcoder Are you going to resolve the merge conflicts and merge this branch at some point? This PR is over 2 years old and still applies. I put some effort into it, so it would be nice to see the results in a released version of the product at some point...

bartvanandel · 2020-08-15T12:21:49Z

BTW I don't think your earlier reviews apply anymore, those were resolved a year and a half ago, but due to rewritten history (as requested, because of the rebase) the commits that were reviewed cannot be found anymore. Basically the review is currently a dead-end street.

bartvanandel · 2021-03-25T11:09:33Z

@ferventcoder Any chance this PR is ever going to be merged? I just ran choco search screen and I'm still annoyed by the apparent lack of order in the 241 results long output. The PR is now over 2 years old...

BTW I suggest that you take a look at any merge conflicts, I've resolved them in the past but I don't feel like resolving them again only to see the PR still not being merged.

bartvanandel · 2021-05-10T21:05:23Z

@gep13 Are you the new maintainer? Would you be willing to finish up and merge this long-standing pull request?

bartvanandel · 2021-09-22T10:53:51Z

I give up. For more than 3 I've tried to get this PR reviewed and merged, but @ferventcoder doesn't seem interested enough.

src/chocolatey.resources/helpers/ChocolateyTabExpansion.ps1

gep13 · 2025-05-15T14:19:19Z

We will also need to look at deprecating the --order-by-popularity option, as this is essentially duplicated by --order-by="popularity"

bartvanandel · 2025-05-15T14:26:44Z

We will also need to look at deprecating the --order-by-popularity option, as this is essentially duplicated by --order-by="popularity"

Makes sense I guess.

If you don't mind, I won't be making any more changes. This PR is almost 7 years old and was essentially ignored for the past 5 years. I rebased once or twice on request, only to be left out in the cold again.

You're more than welcome to continue working on this branch though.

FWIW, the string "Available in 0.10.12+" is no longer valid either.

gep13 · 2025-05-15T17:02:28Z

@bartvanandel completely understood. Thank you again for getting this PR started, and apologies for the length of time taken.

The wheels turn slowly, but they do turn! 😄

AdmiringWorm · 2025-06-19T13:31:24Z

I have taken the liberty to update this PR to be compatible with the latest version of Chocolatey CLI, and rebased/retargeted it against develop.

src/chocolatey/infrastructure.app/commands/ChocolateySearchCommand.cs

src/chocolatey/infrastructure.app/domain/PackageOrder.cs

src/chocolatey/infrastructure.app/nuget/NugetList.cs

src/chocolatey/infrastructure.app/commands/ChocolateySearchCommand.cs

AdmiringWorm · 2025-06-20T13:34:31Z

I have updated the PR again, taking out the aliases and its related EnumExtension helper (I will move this to a different branch so we have a reference to it if needed in the future).

I have also wrapped all error and warning messages on column 80 as we discussed during our chat, and removed the prefixed Warning and Error since we aren't using that elsewhere in the codebase.

Add some more unit tests for the private methods that were added...

src/chocolatey.resources/helpers/ChocolateyTabExpansion.ps1

gep13

Minor nit picks.

src/chocolatey/infrastructure.app/commands/ChocolateySearchCommand.cs

Introduce a new 'order-by' option to the Chocolatey search command, allowing users to sort package results by various criteria such as Popularity, in addition to the default Id sorting. This replaces the deprecated 'order-by-popularity' flag, which now logs a warning and redirects users to the new option. Add a PackageOrder enum to define valid sorting options and update ListCommandConfiguration to use this enum for ordering. Mark the old OrderByPopularity property as obsolete to guide migration. These changes improve search flexibility and prepare for future removal of deprecated options while maintaining backward compatibility.

Add explicit support for the --order-by option in Chocolatey tab completion by introducing Get-ChocoOrderByOptions, which returns the canonical order-by values. Update the search command to accept an explicit --order-by parameter instead of a fixed --order-by-popularity. This change improves flexibility and accuracy of tab completion for the --order-by argument, aligning completions with Chocolatey's enum values and enabling users to discover valid sorting options interactively.

gep13

LGTM!

This PR has moved on this the last review from Rob, and approval is no longer required.

gep13 · 2025-06-20T16:17:07Z

@bartvanandel thanks again for getting this PR started, we really appreicate it!

Once the CI builds are complete here, I am going to get this merged, and this will be shipping as part of Chocolatey CLI 2.5.0.

gep13 · 2025-07-01T13:58:52Z

Removing this from the 2.5.0 milestone, since the issue associated with it has been added to the milestone.

ferventcoder reviewed Jan 18, 2019

View reviewed changes

src/chocolatey/infrastructure.app/commands/ChocolateyListCommand.cs Outdated Show resolved Hide resolved

ferventcoder reviewed Jan 18, 2019

View reviewed changes

src/chocolatey/infrastructure.app/domain/PackageOrder.cs Outdated Show resolved Hide resolved

ferventcoder reviewed Jan 18, 2019

View reviewed changes

src/chocolatey/infrastructure.app/nuget/NugetList.cs Outdated Show resolved Hide resolved

ferventcoder previously requested changes Jan 18, 2019

View reviewed changes

bartvanandel force-pushed the feat/order-by-parameter branch 2 times, most recently from bd1f31a to 6412eaf Compare January 20, 2019 21:57

bartvanandel force-pushed the feat/order-by-parameter branch from 6412eaf to 47c339c Compare January 20, 2019 22:37

bartvanandel requested a review from ferventcoder August 18, 2020 13:53

chocolatey deleted a comment from bartvanandel Sep 27, 2021

gep13 changed the title ~~(GH-256) Add order-by parameter and sort packages by name by default~~ (#256) Add order-by parameter and sort packages by name by default Oct 15, 2021

gep13 requested changes May 15, 2025

View reviewed changes

src/chocolatey.resources/helpers/ChocolateyTabExpansion.ps1 Outdated Show resolved Hide resolved

src/chocolatey.resources/helpers/ChocolateyTabExpansion.ps1 Outdated Show resolved Hide resolved

gep13 added this to the 2.5.0 milestone Jun 11, 2025

AdmiringWorm force-pushed the feat/order-by-parameter branch from ad029bf to c973666 Compare June 19, 2025 13:25

AdmiringWorm changed the title ~~(#256) Add order-by parameter and sort packages by name by default~~ (#3709) Add order-by parameter and sort packages by name by default Jun 19, 2025

AdmiringWorm changed the title ~~(#3709) Add order-by parameter and sort packages by name by default~~ (#3709) Add support for ordering strategies using a new --order-by argument on the search command Jun 19, 2025

AdmiringWorm requested a review from gep13 June 19, 2025 13:27

AdmiringWorm changed the base branch from master to develop June 19, 2025 13:29

AdmiringWorm force-pushed the feat/order-by-parameter branch from c973666 to eaa8030 Compare June 19, 2025 13:30

gep13 requested changes Jun 20, 2025

View reviewed changes

src/chocolatey/infrastructure.app/commands/ChocolateySearchCommand.cs Outdated Show resolved Hide resolved

AdmiringWorm force-pushed the feat/order-by-parameter branch from eaa8030 to fbd1608 Compare June 20, 2025 09:41

gep13 mentioned this pull request Jun 20, 2025

Providing "$orderby=Id" result set is not completely ordered by id chocolatey/NuGet.Server-chocolatey#2

Open

AdmiringWorm force-pushed the feat/order-by-parameter branch from fbd1608 to a436c00 Compare June 20, 2025 13:27

AdmiringWorm reviewed Jun 20, 2025

View reviewed changes

src/chocolatey.resources/helpers/ChocolateyTabExpansion.ps1 Outdated Show resolved Hide resolved

AdmiringWorm force-pushed the feat/order-by-parameter branch from a436c00 to fd5e410 Compare June 20, 2025 14:23

gep13 requested changes Jun 20, 2025

View reviewed changes

src/chocolatey/infrastructure.app/commands/ChocolateySearchCommand.cs Outdated Show resolved Hide resolved

src/chocolatey/infrastructure.app/commands/ChocolateySearchCommand.cs Outdated Show resolved Hide resolved

AdmiringWorm force-pushed the feat/order-by-parameter branch from fd5e410 to 576a2c2 Compare June 20, 2025 16:01

bartvanandel and others added 2 commits June 20, 2025 17:13

gep13 force-pushed the feat/order-by-parameter branch from 576a2c2 to 3a36bc8 Compare June 20, 2025 16:14

gep13 approved these changes Jun 20, 2025

View reviewed changes

gep13 merged commit 990e2d7 into chocolatey:develop Jun 20, 2025
5 checks passed

gep13 removed this from the 2.5.0 milestone Jul 1, 2025

(#3709) Add support for ordering strategies using a new --order-by argument on the search command #1619

(#3709) Add support for ordering strategies using a new --order-by argument on the search command #1619

Uh oh!

Conversation

bartvanandel commented Jul 20, 2018 • edited by AdmiringWorm Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description Of Changes

Motivation and Context

Testing

Operating Systems Testing

Change Types Made

Change Checklist

Related Issue

Additional Information

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ferventcoder left a comment

Choose a reason for hiding this comment

Uh oh!

ferventcoder commented Jan 18, 2019

Uh oh!

bartvanandel commented Jan 18, 2019

Uh oh!

ferventcoder commented Jan 18, 2019

Uh oh!

bartvanandel commented Jan 20, 2019

Uh oh!

bartvanandel commented Jan 28, 2019

Uh oh!

bartvanandel commented May 1, 2020

Uh oh!

CLAassistant commented Jun 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bartvanandel commented Jun 9, 2020

Uh oh!

ferventcoder commented Jun 10, 2020

Uh oh!

bartvanandel commented Jun 10, 2020

Uh oh!

bartvanandel commented Jul 13, 2020

Uh oh!

bartvanandel commented Jul 25, 2020

Uh oh!

bartvanandel commented Aug 15, 2020

Uh oh!

bartvanandel commented Aug 15, 2020

Uh oh!

bartvanandel commented Mar 25, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bartvanandel commented May 10, 2021

Uh oh!

bartvanandel commented Sep 22, 2021 • edited by pauby Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gep13 commented May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bartvanandel commented May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gep13 commented May 15, 2025

Uh oh!

AdmiringWorm commented Jun 19, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AdmiringWorm commented Jun 20, 2025

(#3709) Add support for ordering strategies using a new `--order-by` argument on the search command #1619

(#3709) Add support for ordering strategies using a new `--order-by` argument on the search command #1619

bartvanandel commented Jul 20, 2018 •

edited by AdmiringWorm

Loading

CLAassistant commented Jun 8, 2020 •

edited

Loading

bartvanandel commented Mar 25, 2021 •

edited

Loading

bartvanandel commented Sep 22, 2021 •

edited by pauby

Loading

gep13 commented May 15, 2025 •

edited

Loading

bartvanandel commented May 15, 2025 •

edited

Loading