Repository navigation
Commit 3e73e45
authored
perf: validate options with a precompiled schema (#5746)
* perf: validate options with a precompiled schema
`schema-utils`'s `validate()` compiles the options schema with ajv on its
first call. That cost 117ms of every `new Server()` — measured over eight
interleaved runs, 117.3 +/- 2.8ms, against 0.07ms for each call after it.
It is a one-time price every user pays on every start.
`lib/options.check.js` is that schema precompiled by `ajv`'s standalone
codegen. The constructor asks it first and only falls back to
`schema-utils` when it rejects, so the happy path never loads ajv and an
invalid config still gets the same message. webpack solves its own schema
the same way, and the generated validator agrees with `schema-utils` on
all 183 cases of the `validate-options` corpus plus 62 hand-written ones.
The constructor drops to 1.0ms, and time-to-listening for a hello-world
falls from 565 +/- 14ms to 523 +/- 25ms.
* chore: document the generator's callbacks
* refactor: validate options through the compiler where webpack allows it
`compiler.hooks.validate` and `compiler.validate`'s lazy-schema and
precompiled-check parameters landed together in webpack 5.106, so the
hook doubles as the feature probe for them. When it is there, validation
goes through the compiler the way webpack's own plugins do, which also
lets `validate: false` turn it off.
The direct path stays as the fallback, with a TODO to drop it once the
minimum supported webpack carries the hook. It is also what runs when no
compiler was passed, which is how the server is constructed for `apply()`.
* fix: validate against the compiler that owns the dev server
`compiler.validate` honours that compiler's own `validate` option, so
asking the first child of a `MultiCompiler` read a policy that was never
about these options: with `validate: false` on child 0 and the dev server
configured on child 1, invalid options reached normalization instead of
throwing.
`getCompilerOptions` already had the selection rule — the child naming
`devServer`, else the one targeting the web, else the first. It moves to
`findDevServerCompiler`, which both callers now use so the two cannot
drift apart again.
Reported by CodeRabbit on #5746.
* chore: regenerate types for the validation helpers
* test: cover the validation fallbacks
codecov reported 6 uncovered lines in the diff, all of them fallbacks:
`findDevServerCompiler` returning the first child when none names
`devServer` or targets the web, and the direct `schema-utils` call taken
when there is no compiler to ask, which is how the server is constructed
for `apply()`.
lib/Server.js's changed lines go from 70/76 to 76/76 covered.
* test: close the compilers the routing tests create
Each `webpack()` call leaves a compiler holding a file-system cache and
its purge timer. Node's test runner runs files concurrently, so those
stayed alive alongside the browser suites for the rest of the run.
Windows Node 22 timed out in `test/e2e/overlay.test.js` on the previous
commit, which was test-only; that suite already uses most of its 400s
there, and this is the load these tests were adding to it.
* fix: honour the owning compiler's validate option in plugin mode
Used as a plugin the server is constructed without a compiler, so
validating in the constructor had no `validate` policy to read and threw
before `apply()` could bring the compiler the options are about. Validate
in the constructor only when one is passed, and in `apply()` otherwise.1 parent e44bdae commit 3e73e45
11 files changed
Lines changed: 486 additions & 42 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| 7 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
7 | 12 | | |
8 | 13 | | |
9 | 14 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| 8 | + | |
8 | 9 | | |
9 | 10 | | |
10 | 11 | | |
| |||
343 | 344 | | |
344 | 345 | | |
345 | 346 | | |
346 | | - | |
347 | | - | |
348 | | - | |
349 | | - | |
350 | | - | |
351 | 347 | | |
| 348 | + | |
| 349 | + | |
352 | 350 | | |
353 | 351 | | |
354 | 352 | | |
| |||
578 | 576 | | |
579 | 577 | | |
580 | 578 | | |
| 579 | + | |
| 580 | + | |
| 581 | + | |
| 582 | + | |
| 583 | + | |
| 584 | + | |
| 585 | + | |
| 586 | + | |
| 587 | + | |
| 588 | + | |
| 589 | + | |
| 590 | + | |
| 591 | + | |
| 592 | + | |
| 593 | + | |
| 594 | + | |
| 595 | + | |
| 596 | + | |
| 597 | + | |
| 598 | + | |
| 599 | + | |
| 600 | + | |
| 601 | + | |
| 602 | + | |
| 603 | + | |
| 604 | + | |
| 605 | + | |
| 606 | + | |
| 607 | + | |
| 608 | + | |
| 609 | + | |
| 610 | + | |
| 611 | + | |
| 612 | + | |
| 613 | + | |
| 614 | + | |
| 615 | + | |
| 616 | + | |
| 617 | + | |
| 618 | + | |
| 619 | + | |
| 620 | + | |
| 621 | + | |
| 622 | + | |
| 623 | + | |
| 624 | + | |
| 625 | + | |
| 626 | + | |
| 627 | + | |
| 628 | + | |
| 629 | + | |
| 630 | + | |
| 631 | + | |
| 632 | + | |
| 633 | + | |
| 634 | + | |
| 635 | + | |
| 636 | + | |
| 637 | + | |
| 638 | + | |
| 639 | + | |
| 640 | + | |
| 641 | + | |
| 642 | + | |
| 643 | + | |
| 644 | + | |
| 645 | + | |
| 646 | + | |
| 647 | + | |
| 648 | + | |
581 | 649 | | |
582 | 650 | | |
583 | 651 | | |
| |||
792 | 860 | | |
793 | 861 | | |
794 | 862 | | |
795 | | - | |
796 | | - | |
797 | | - | |
798 | | - | |
799 | | - | |
800 | | - | |
801 | | - | |
802 | | - | |
803 | | - | |
804 | | - | |
805 | | - | |
806 | | - | |
807 | | - | |
808 | | - | |
809 | | - | |
810 | | - | |
811 | | - | |
812 | | - | |
813 | | - | |
814 | | - | |
815 | | - | |
816 | | - | |
817 | | - | |
818 | | - | |
819 | | - | |
820 | | - | |
821 | | - | |
822 | | - | |
823 | | - | |
824 | | - | |
825 | | - | |
826 | | - | |
827 | | - | |
828 | | - | |
| 863 | + | |
| 864 | + | |
| 865 | + | |
829 | 866 | | |
830 | 867 | | |
831 | 868 | | |
| |||
3761 | 3798 | | |
3762 | 3799 | | |
3763 | 3800 | | |
| 3801 | + | |
| 3802 | + | |
| 3803 | + | |
| 3804 | + | |
| 3805 | + | |
3764 | 3806 | | |
3765 | 3807 | | |
3766 | 3808 | | |
| |||
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
49 | 49 | | |
50 | 50 | | |
51 | 51 | | |
52 | | - | |
| 52 | + | |
53 | 53 | | |
54 | 54 | | |
55 | 55 | | |
| |||
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
63 | | - | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
64 | 66 | | |
65 | 67 | | |
66 | 68 | | |
| |||
102 | 104 | | |
103 | 105 | | |
104 | 106 | | |
| 107 | + | |
105 | 108 | | |
106 | 109 | | |
107 | 110 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
0 commit comments