Separate core search logic with search ui

[Folyd]

Currenty, the search.js mixed with UI/DOM manipulation codes and search logic codes, I propose to extract the search logic to a class for following benefits:

• Clean code. Separation of DOM manipulation and search logic can lead better code maintainability and easy code testings.
• Easy share the search logic for third party to utilize the search function, such as Rust Search Extension, https://query.rs.

This PR added a new class called DocSearch, which mainly expose following methods:

class DocSearch {
	// Dependency inject searchIndex, rootPath and searchState
	constructor(rawSearchIndex, rootPath, searchState) {
		// build search index...
	}

	static parseQuery(userQuery) {
	}

	async execQuery(parsedQuery, filterCrates, currentCrate) {
	}
}

[rustbot]

r? @notriddle

rustbot has assigned @notriddle.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

[notriddle]

Separating the logic into a class makes sense, as long as it doesn't impose another HTTP request on the actual browser.

[bors]

☔ The latest upstream changes (presumably #126205) made this pull request unmergeable. Please resolve the merge conflicts.

[Folyd]

Hi, @notriddle do you know how to fix this?

/checkout/src/librustdoc/html/static/js/search-core.js
  3321:5  error  'exports' is not defined  no-undef

[rustbot]

Some changes occurred in HTML/CSS/JS.

cc @GuillaumeGomez, @jsha

[rustbot]

There are merge commits (commits with multiple parents) in your changes. We have a no merge policy so these commits will need to be removed for this pull request to be merged.

You can start a rebase with the following commands:

$ # rebase
$ git pull --rebase https://github.com/rust-lang/rust.git master
$ git push --force-with-lease

The following commits are merge commits:

• 5e52943

[Folyd]

I'm not sure how to fix this error:

Testing stage2 rustdoc-js-std (x86_64-unknown-linux-gnu)
  TypeError: exports.DocSearch is not a constructor
      at initSearch (/checkout/obj/build/x86_64-unknown-linux-gnu/doc/static.files/search-5cb5038de88a08b8.js:5:8904)
      at /checkout/obj/build/x86_64-unknown-linux-gnu/doc/static.files/search-5cb5038de88a08b8.js:5:9076
      at Object.<anonymous> (/checkout/obj/build/x86_64-unknown-linux-gnu/doc/static.files/search-5cb5038de88a08b8.js:5:9100)
      at Module._compile (node:internal/modules/cjs/loader:1218:14)
      at Module._extensions..js (node:internal/modules/cjs/loader:1272:10)
      at Module.load (node:internal/modules/cjs/loader:1081:32)
      at Module._load (node:internal/modules/cjs/loader:922:12)
      at Module.require (node:internal/modules/cjs/loader:1105:19)
      at require (node:internal/modules/cjs/helpers:103:18)
      at loadSearchJS (/checkout/src/tools/rustdoc-js/tester.js:436:26)

[GuillaumeGomez]

The GUI tests are not supposed to fail since you're only moving code to end up with the same output. So what I recommend is opening the test and look what it's checking so you can see what is going wrong with your changes.

[notriddle]

In particular, try:

• running the GUI tests:
  ./x.py test tests/rustdoc-ui (edit: gui, not ui)
  • it'll prompt you to npm install its dependencies, if you don't have them
• if they fail, try opening the test case and reproducing it in your browser:
  xdg-open build/x86_64-unknown-linux-gnu/test/rustdoc-gui/doc/lib2/index.html
  • on Windows, xdg-open is just start, and on macos it's just open
• if you get browser console errors, replace the script in rustdoc-gui with a non-escaped one:
  cp src/librustdoc/html/static/js/search.js build/x86_64-unknown-linux-gnu/test/rustdoc-gui/doc/static.files/search-*

[Folyd]

Thanks @notriddle. The GUI test is success on my macOS.

$ ./x.py test tests/rustdoc-ui
Building bootstrap
    Finished `dev` profile [unoptimized] target(s) in 0.43s

Creating a sysroot for stage2 compiler (use `rustup toolchain link 'name' build/host/stage2`)
Building stage0 library artifacts (x86_64-apple-darwin)
    Finished `release` profile [optimized] target(s) in 0.45s
Building stage0 tool compiletest (x86_64-apple-darwin)

Testing stage2 compiletest suite=rustdoc-ui mode=ui (x86_64-apple-darwin)

running 282 tests
iii................................................i....................................  88/282
........................................................................................ 176/282
......i.............i......i............................................................ 264/282
..................

test result: ok. 275 passed; 0 failed; 7 ignored; 0 measured; 0 filtered out; finished in 52.24s

Build completed successfully in 0:02:57

[notriddle]

Oh, sorry.

You need to run ./x.py test tests/rustdoc-gui

[Folyd]

Finally, all testings passed. 🥳

[GuillaumeGomez]

Time to squash the commits. :D

Then I'll review more in details.

[Folyd]

Do I need git squash manually?

[GuillaumeGomez]

Yes. If you don't know how, I wrote a tutorial a while ago here.

[Folyd]

Rebase done. Thanks for the tutorial. ❤️ @GuillaumeGomez

[GuillaumeGomez]

Looks good to me! Since all tests are passing, I'm pretty confident everything is ok. Just letting @notriddle take a look to ensure nothing was missed.

[notriddle]

@bors r=GuillaumeGomez,notriddle

[bors]

📌 Commit 1eb4cb4 has been approved by GuillaumeGomez,notriddle

It is now in the queue for this repository.