[2.x] Rewrite documentation search page internals to be based on dynamic pages instead of a build task

[caendesilva]

Abstract

Changes the internals of how the documentation search index and full search page are handled. This is a quite extensive refactor, as part of v2, and is basically how I would/should have implemented this feature from the start, which I couldn't because the original feature predates the improved code API we have now.

Previously, these were generated in a post-build task, with this change, they are now full page objects within the kernel page and route collection.

This targets v2 as while the generated sites won't change, there are several side-effects of this change. These effects are desirable however, and are the reason for the change. But they are sideffects, as can be seen by the amount of files being adapted in this PR.

The biggest change, and the reason behind wanting to make this change, is that with the build tasks, HydePHP has no real knowledge of the files as they are not present in the kernel. This means we've had to make hacky patches for example to serve the pages from the realtime compiler, leading to issues like hydephp/realtime-compiler#19.

By bringing these pages into the kernel, we can serve them directly in the compiler. However, this also means that two new pages are added to the kernel, hence the side effects that could break other integrations. (And it affects tests that don't expect the new pages, hence one of the reasons behind the large amount of files changed in the PR as tests needed to be adapted). Still, the impact is low, as I don't think that many people, if any, have extended the build task. The main impact noticeable to users would be the implicit changes like the pages showing up in the dashboard and route list command.

Release strategy

This contains breaking changes, and thus targets v2.

For the code being deleted, we will want to cherry pick the deprecations to master for a minor release version.

Since this also has a realtime compiler BC break, that will be bumped to a new major version as well.

Breaking changes

High impact:

Low impact:

• The GenerateSearch post-build task has been removed. If you have previously extended or customized this class,
  you will need to adapt your code, as the search index files are now handled implicitly during the standard build process,
  as the search pages are now added to the kernel page and route collection. ([2.x] Rewrite documentation search page internals to be based on dynamic pages instead of a build task #1498)
• If your site has a custom documentation search page, for example _docs/search.md or _pages/docs/search.blade.php,
  that page will no longer be build when using the specific build:search command. It will, of course,
  be built using the standard build command. 82dc71f
• In the highly unlikely event your site customizes any of the search pages by replacing them in the kernel route collection,
  you would now need to do that in the kernel page collection due to the search pages being generated earlier in the lifecycle.
  82dc71f

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d52c996) 100.00% compared to head (99a235f) 99.95%.
Report is 38 commits behind head on 2.x-dev.

Additional details and impacted files

@@              Coverage Diff              @@
##             2.x-dev    #1498      +/-   ##
=============================================
- Coverage     100.00%   99.95%   -0.05%     
- Complexity      1740     1744       +4     
=============================================
  Files            180      180              
  Lines           4715     4723       +8     
=============================================
+ Hits            4715     4721       +6     
- Misses             0        2       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.