Add crate filter parameter in URL

[GuillaumeGomez]

Fixes #92621.

r? @jsha

[rust-highfive]

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez,@Folyd

[jsha]

Can you add a description of 0bd7b06fdf5c3cfa9e69728542bbc751b690a4e0 in the PR description?

[jsha]

Why the change to query.raw here? Do we actually use this field of the history state?

[GuillaumeGomez]

It was invalid before for some reason...

[GuillaumeGomez]

Also, we don't use as it seems. So I guess it only makes it smaller?

[jsha]

I'll clarify: We should just pass null here (and in the replaceState call below) because we never use the resulting state in our popstate event handler.

[GuillaumeGomez]

Oh I see! Let's do this then!

[jsha]

Why is the "update URL" code path only activated when selecting "All crates"? It seems like we should always update the URL after the user makes a selection from the crates dropdown.

[GuillaumeGomez]

Because it'll be done in the search for the other cases (ie, when we have a filter crate). This needs to be changed the current URL before we make the search so that the filter crate won't be picked since there isn't one anymore.

[GuillaumeGomez]

Updated!

[jsha]

Let's add some JSDoc comments to this function, indicating that filterCrates is optional - or better yet, make it non-optional, and specify that it should be "null" for "no filter". Then we can remove the !== "undefined" check below.

Also, let's move this function to search.js. It's search-specific functionality, after all. And we shouldn't call it in hideResults; we should keep the code currently there, which doesn't care about search URL parameters.

In general, many of the things in searchState can and should be moved to search.js eventually. What's in there is the stuff that had relationships with other things in main.js that I didn't want to untangle in my initial refactoring to split search.js.

[jsha]

Let's not do this. Instead, let's move putBackSearch into search.js.

Since putBackSearch is referenced from the event listener created in setup, we'll also have to move the registration of that event listener into search.js.

[GuillaumeGomez]

👍

[GuillaumeGomez]

Actually it's not possible because we load the search.js file thanks to this event, making its functions unavailable until they're loaded (so after this event is triggered). I'll try to find another way.

[GuillaumeGomez]

Nevermind, it's totally possible. I misunderstood what putBackSearch was doing.

[jsha]

In main.js we have:

        setup: function() {
            ...
            search_input.addEventListener("focus", function() {
                searchState.putBackSearch(this);
                search_input.origPlaceholder = searchState.input.placeholder;
                search_input.placeholder = "Type your search here.";
                loadSearch();
            });
            search_input.addEventListener("blur", function() {
                search_input.placeholder = searchState.input.origPlaceholder;
            });

Those addEventListener calls should be moved into search.js, in registerSearchEvents. I think that should work. At the time that function runs, putBackSearch will be available, even if it's defined inside search.js.

[GuillaumeGomez]

I still need to keep focus in here because it loads the script. And to make it smoother, I'll keep the placeholder update before the search scripts are loaded.

[jsha]

By the way, I've been thinking: maybe we can do the placeholder with CSS: https://developer.mozilla.org/en-US/docs/Web/CSS/::placeholder

#search-input::placeholder {
  content: "Click or press 'S' for search...";
}

#search-input:focus::placeholder {
  content: "Type your search here.";
}

[GuillaumeGomez]

I thought you didn't want to put text in the CSS? I remember something like that. Well, if so, I'll send a small PR for that. :)

[GuillaumeGomez]

Just tried it, you can't set content for ::placeholder unfortunately...

[jsha]

I'll clarify: We should just pass null here (and in the replaceState call below) because we never use the resulting state in our popstate event handler.

[jsha]

I had another thought about this: We could make the crate dropdown edit the textual search. For instance, if you are on https://doc.rust-lang.org/nightly/std/index.html?search=panic and select "core" from the drop-down, the URL would change to https://doc.rust-lang.org/nightly/std/index.html?search=panic+crate:core. And we would also parse crate:core in the search box to mean "filter to just the core crate."

[GuillaumeGomez]

That would mean strongly changing the search syntax (which I have another PR for :p). Better to be done as part of the other PR. Or in a follow-up, as you prefer. But changing the search input syntax isn't a good idea before the parser is merged.

[GuillaumeGomez]

I think I applied all your comments as much as I could. I moved parts of the event subscriptions on the search input in the search.js file but I couldn't move all of them (the focus one cannot for example).

[jsha]

@bors r+ rollup

Looks great, thanks!

[bors]

📌 Commit 829a047 has been approved by jsha