fix(command-dev): replace deprecated static-server dep by fastify-static #5341

tinfoil-knight · 2022-12-31T12:47:28Z

🎉 Thanks for submitting a pull request! 🎉

Summary

The static-server dependency which is currently being used by the netlify dev command is now deprecated. This PR intends to replace the dependency with fastify-static (recommended by @lukasholzer).

For us to review and ship your PR efficiently, please perform the following steps:

Open a bug/issue before writing your code 🧑‍💻. This ensures we can discuss the changes and get feedback from everyone that should be involved. If you`re fixing a typo or something that`s on fire 🔥 (e.g. incident related), you can skip this step.
Read the contribution guidelines 📖. This ensures your code follows our style guide and
passes our tests.
Update or add tests (if any source code was changed or added) 🧪
Update or add documentation (if features were changed or added) 📝
Make sure the status checks below are successful ✅

A picture of a cute animal (not mandatory, but encouraged)
🦖

github-actions · 2022-12-31T12:48:52Z

📊 Benchmark results

Comparing with e1f661a

Package size: 259 MB

⬆️ 6.60% increase vs. e1f661a

^                                                                                                  259 MB 
│  249 MB  249 MB  249 MB  249 MB  249 MB  249 MB  249 MB  249 MB  249 MB  249 MB  249 MB  242 MB   ┌──┐  
│ ──┌──┐────┌──┐────┌──┐────┌──┐────┌──┐────┌──┐────┌──┐────┌──┐────┌──┐────┌──┐────┌──┐────┌──┐────|▒▒|──
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
└───┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴──>
    T-12    T-11    T-10    T-9     T-8     T-7     T-6     T-5     T-4     T-3     T-2     T-1      T

Legend

T-30 (62930d8): 254 MB
T-29 (345ce9c): 254 MB
T-28 (0041559): 254 MB
T-27 (e65f97c): 254 MB
T-26 (35123df): 254 MB
T-25 (a49e5fc): 249 MB
T-24 (6214768): 242 MB
T-23 (acdcbb6): 242 MB
T-22 (743b4d6): 242 MB
T-21 (f9f45ed): 249 MB
T-20 (22de9e2): 249 MB
T-19 (d64c875): 249 MB
T-18 (cd993b0): 249 MB
T-17 (9a7c666): 249 MB
T-16 (cf2f402): 249 MB
T-15 (6102e77): 249 MB
T-14 (d3dfa17): 249 MB
T-13 (9bb51a1): 249 MB
T-12 (81ac0c6): 249 MB
T-11 (bb16cec): 249 MB
T-10 (3ff4a57): 249 MB
T-9 (3b491be): 249 MB
T-8 (0bc18bb): 249 MB
T-7 (12664f3): 249 MB
T-6 (7ebf238): 249 MB
T-5 (df9260a): 249 MB
T-4 (e3db314): 249 MB
T-3 (7eb4479): 249 MB
T-2 (89b14e2): 249 MB
T-1 (e1f661a): 242 MB
T (current commit): 259 MB

tinfoil-knight · 2022-12-31T13:01:08Z

Relevant Documentation:

fastify : https://www.fastify.io/docs/latest/Reference/
- https://www.fastify.io/docs/latest/Reference/Hooks/#onrequest
- https://www.fastify.io/docs/latest/Reference/Server/#setnotfoundhandler
@fastify/static : https://github.com/fastify/fastify-static

tinfoil-knight · 2022-12-31T19:44:25Z

Change in Response Headers

For successful request OR not found requests with 404.html file present:
cache-control (public, max-age=0) is added.
For not found requests without any 404.html file:
transfer-encoding (chunked) is not there now.
content-type for responses with a file has changed from text/html to text/html; charset=UTF-8

Note
In production Netlify, cache-control is public, max-age=0, must-revalidate.

tinfoil-knight · 2022-12-31T20:14:44Z

src/commands/dev/dev.mjs

+  const rootPath = path.resolve(settings.dist)
+  server.register(fastifyStatic, {
+    root: rootPath,
+    etag: false,


ETag generation is disabled since the proxy already handles that.

tinfoil-knight · 2022-12-31T20:19:28Z

src/commands/dev/dev.mjs

+  })
+
+  server.addHook('onRequest', (req, reply, done) => {
+    reply.header('X-Powered-by', 'netlify-dev')


The name: 'netlify-dev' configuration in static-server used to set the X-Powered-by header which is now being done manually here.

danez

Awesome. Happy new year.
I was already thinking about doing this. and even replacing express everywhere, but that would be a much bigger task I think.

kodiakhq · 2023-01-03T11:26:00Z

This PR currently has a merge conflict. Please resolve this and then re-add the automerge label.

tinfoil-knight · 2023-01-03T11:35:15Z

Awesome. Happy new year.

Happy new year to you too @danez. It was fun working w/ you & other folks on the Netlify team past year.

tinfoil-knight self-assigned this Dec 31, 2022

tinfoil-knight added type: security code to address security issues area: command: dev labels Dec 31, 2022

tinfoil-knight force-pushed the 4511-remove-static-server-dep branch 2 times, most recently from 48c7005 to d83296e Compare December 31, 2022 14:20

tinfoil-knight commented Dec 31, 2022

View reviewed changes

tinfoil-knight requested review from danez and lukasholzer December 31, 2022 20:32

tinfoil-knight marked this pull request as ready for review December 31, 2022 20:32

danez previously approved these changes Jan 3, 2023

View reviewed changes

danez added the automerge Add to Kodiak auto merge queue label Jan 3, 2023

kodiakhq bot removed the automerge Add to Kodiak auto merge queue label Jan 3, 2023

tinfoil-knight dismissed danez’s stale review via 51f163e January 3, 2023 11:30

tinfoil-knight added 6 commits January 3, 2023 12:31

fix(command-dev): replace deprecated static-server dep by fastify-static

0328bab

fix: callback for onRequest

f1e8245

fix: stop generating etags, add status in error handler

c5eac34

fix: send response body with status text for invalid methods

00f6ef2

fix: update test response, fix path resolution

72f5685

fix: resolve path correctly, make headers compatible

f62b4f4

danez force-pushed the 4511-remove-static-server-dep branch from 51f163e to f62b4f4 Compare January 3, 2023 11:32

danez approved these changes Jan 3, 2023

View reviewed changes

danez added the automerge Add to Kodiak auto merge queue label Jan 3, 2023

kodiakhq bot merged commit 2994d3e into netlify:main Jan 3, 2023

tinfoil-knight deleted the 4511-remove-static-server-dep branch January 3, 2023 11:43

token-generator-app bot mentioned this pull request Jan 3, 2023

chore(main): release 12.6.0 #5343

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(command-dev): replace deprecated static-server dep by fastify-static #5341

fix(command-dev): replace deprecated static-server dep by fastify-static #5341

tinfoil-knight commented Dec 31, 2022 •

edited

github-actions bot commented Dec 31, 2022 •

edited

tinfoil-knight commented Dec 31, 2022 •

edited

tinfoil-knight commented Dec 31, 2022 •

edited

tinfoil-knight Dec 31, 2022

tinfoil-knight Dec 31, 2022 •

edited

danez left a comment

kodiakhq bot commented Jan 3, 2023

tinfoil-knight commented Jan 3, 2023

fix(command-dev): replace deprecated static-server dep by fastify-static #5341

fix(command-dev): replace deprecated static-server dep by fastify-static #5341

Conversation

tinfoil-knight commented Dec 31, 2022 • edited

Summary

github-actions bot commented Dec 31, 2022 • edited

📊 Benchmark results

Package size: 259 MB

tinfoil-knight commented Dec 31, 2022 • edited

tinfoil-knight commented Dec 31, 2022 • edited

tinfoil-knight Dec 31, 2022

Choose a reason for hiding this comment

tinfoil-knight Dec 31, 2022 • edited

Choose a reason for hiding this comment

danez left a comment

Choose a reason for hiding this comment

kodiakhq bot commented Jan 3, 2023

tinfoil-knight commented Jan 3, 2023

tinfoil-knight commented Dec 31, 2022 •

edited

github-actions bot commented Dec 31, 2022 •

edited

tinfoil-knight commented Dec 31, 2022 •

edited

tinfoil-knight commented Dec 31, 2022 •

edited

tinfoil-knight Dec 31, 2022 •

edited