search: do not sort results by stars on client side #3470
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Once upon a time, there was a website named ["The Docker index"][2]; a complimentary service for users of Docker, provided by dotCloud. The Docker Index was the place to find and explore pre-made container images, and allowed you to [share your images and download them][1]. The Docker Index evolved rapidly, and gained new features, such as [Trusted Images][3], and "stars" to rank your favorite images. The website also provided an API, which allowed you to search images, even from the comfort of your `docker` CLI. Things moved fast in container-land, and while there was an API to use, it was still a work in progress. While the Docker Index allowed users to "star" images, the search API did not rank results accordingly. As any engineer knows, there's no problem that can't be solved with some elbow- grease and a piece of Duct tape, so while the Docker Index team worked on making the search API better, the `docker` engine [fixed the problem on the client side][4] Years went by, and the Docker Index API became the "registry V1" specification, including search. The registry got a major "v2" rewrite and became the [OCI Distribution Spec][5], and Docker Index became Docker Hub, which included V2 and V3 search APIs. The V1 search API continued to be supported, as it was the only documented API for registries, but improvements were made, including ranking of search results. Duct tape is durable, and even though improvements were made, the Docker client continued to sort the results as well. Unfortunately, this meant that search results on the command-line were ranked different from their equivalent on the registry (such as Docker Hub). This patch removes the client-side sorting of results, using the order in which the search API returned them to (finally) celebrate the work of the engineers working on the search API, also when used from the command-line. [1]: https://web.archive.org/web/20130708004229/http://docker.io/ [2]: https://web.archive.org/web/20130623223614/https://index.docker.io/ [3]: https://web.archive.org/web/20140208001647/https://index.docker.io/ [4]: moby/moby@1669b80 [5]: https://github.com/opencontainers/distribution-spec Signed-off-by: Sebastiaan van Stijn <[email protected]>
ndeloof
approved these changes
Mar 15, 2022
|
🐶 |
|
Thx! Let's get this one in 😄 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Once upon a time, there was a website named "The Docker index"; a complimentary
service for users of Docker, provided by dotCloud. The Docker Index was the place
to find and explore pre-made container images, and allowed you to share your
images and download them. The Docker Index evolved rapidly, and gained new
features, such as Trusted Images, and "stars" to rank your favorite images.
The website also provided an API, which allowed you to search images, even from
the comfort of your
dockerCLI. Things moved fast in container-land, and whilethere was an API to use, it was still a work in progress. While the Docker Index
allowed users to "star" images, the search API did not rank results accordingly.
As any engineer knows, there's no problem that can't be solved with some elbow-
grease and a piece of Duct tape, so while the Docker Index team worked on making
the search API better, the
dockerengine fixed the problem on the client sideYears went by, and the Docker Index API became the "registry V1" specification,
including search. The registry got a major "v2" rewrite and became the OCI Distribution
Spec, and Docker Index became Docker Hub, which included V2 and V3 search APIs.
The V1 search API continued to be supported, as it was the only documented API
for registries, but improvements were made, including ranking of search results.
Duct tape is durable, and even though improvements were made, the Docker client
continued to sort the results as well. Unfortunately, this meant that search
results on the command-line were ranked different from their equivalent on the
registry (such as Docker Hub).
This patch removes the client-side sorting of results, using the order in which
the search API returned them to (finally) celebrate the work of the engineers
working on the search API, also when used from the command-line.
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)