[2.x] Massive Windows performance improvement of the Vite integration

[emmadesilva]

Abstract

Follow up to #2016, to fix Windows performance with a much faster "hotfile" system like Laravel uses, instead of a slow socket connection test.

• Targets HydePHP v2.x Development #1565 via [2.x] New asset system #2006

Details

This pull request includes changes to improve the performance and functionality of the Vite development server integration. The most important changes include replacing the Vite dev server check with a hot file check and restructuring the Vite configuration to manage the hot file lifecycle.

Improvements to Vite dev server integration:

• packages/framework/src/Facades/Vite.php: Replaced the Vite dev server check with a more efficient hot file check to improve performance, especially on Windows.

Restructuring Vite configuration:

• vite.config.js: Introduced a new hydeVitePlugin to handle the creation and removal of the Vite hot file when the server starts and stops, respectively. This ensures the hot file accurately reflects the server's state. [1] [2]

Benchmark (Windows)

Instead of the the ~100ms delay on Windows when running npm run dev manually instead of through php hyde serve --vite we now only have a ~0.035ms delay for each page preview.

Starting/stopping the Vite server brings a tiny performance impact, which is negligible in this context:

Signal Handler Setup: 0.23ms

  VITE v5.4.10  ready in 840 ms

  ➜  Local:   http://127.0.0.1:5173/
  ➜  Network: use --host to expose
  ➜  press h + enter to show help
Cleanup Operation: 0.981ms

This means the new setup is about 99.965% or ~2857 times faster for individual page previews.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (ec1583a) to head (18ccd6b).
Report is 6 commits behind head on new-asset-system.

Additional details and impacted files

@@                 Coverage Diff                  @@
##             new-asset-system     #2021   +/-   ##
====================================================
  Coverage              100.00%   100.00%           
+ Complexity               1907      1906    -1     
====================================================
  Files                     195       195           
  Lines                    5084      5078    -6     
====================================================
- Hits                     5084      5078    -6     

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