Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update realtime compiler to generate search indexes on demand #1405

Conversation

caendesilva
Copy link
Member

@caendesilva caendesilva commented Oct 28, 2023

Previously we required a site build to generate the documentation search index, leaving the realtime compiler to return a 404. This update automatically generates the index on each request.

I decided against caching because of how fast the generator is. The request time (which is asynchronous) is increased to ~160ms instead of ~30ms for the entire HydePHP documentation. Considering that this happens in the background, I find this an entirely acceptable tradeoff.

Fixes #1404

@caendesilva caendesilva linked an issue Oct 28, 2023 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Oct 28, 2023

Codecov Report

Merging #1405 (4ba0cfa) into master (a42101d) will not change coverage.
The diff coverage is n/a.

@@             Coverage Diff             @@
##             master    #1405     +/-   ##
===========================================
  Coverage     99.97%   99.97%             
- Complexity     1705     3410   +1705     
===========================================
  Files           180      360    +180     
  Lines          4619     9238   +4619     
===========================================
+ Hits           4618     9236   +4618     
- Misses            1        2      +1     

see 180 files with indirect coverage changes

@caendesilva caendesilva changed the title Update realtime compiler to create missing search index automatically Update realtime compiler to generate the search index each time it's requested Oct 28, 2023
@caendesilva caendesilva changed the title Update realtime compiler to generate the search index each time it's requested Update realtime compiler to generate search indexes on demand Oct 28, 2023
@caendesilva caendesilva marked this pull request as ready for review October 28, 2023 14:03
@caendesilva caendesilva added the run-visual-tests Internal label to trigger Browserstack visual testing label Oct 28, 2023
@caendesilva caendesilva merged commit e1535a4 into master Oct 28, 2023
17 checks passed
@caendesilva caendesilva deleted the support-realtime-documentation-searches-in-realtime-compiler branch October 28, 2023 14:08
@caendesilva caendesilva removed the run-visual-tests Internal label to trigger Browserstack visual testing label Mar 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support realtime searches in realtime compiler docs?
1 participant