nearform / the-fastify-workshop

A workshop about Fastify

The Fastify Workshop

Slideshow Presentation

The Fastify Workshop Slides

Requirements

• Node LTS
• npm >=7 - you can install it with npm install -g npm@latest
• docker
• docker-compose

Setup

• npm ci
• npm run db:up
• npm run db:migrate

Run automated tests

• npm test --workspaces

Run automated tests on a single project

• npm test -w src/step-05-testing

Running the modules

• cd src/step-{n}-{name}
• check each module's README file to see which scripts are available

Presenting

• npm start

the-fastify-workshop's Issues

Rewrite using WebContainers

https://webcontainers.io/

Would it be possible to use WebContainers to implement this workshop so that it runs entirely in the browser?

rename steps folders to have 2 digits so they are ordered on the file system

01, 02, ...

Add hosted slides link to README

If someone is relying on just the README then they could easily miss the hosted slides link. It would be helpful to make it more obvious how to proceed through the workshop with the slides front and center in the README.

Make the type checking work

Check how to turn on the types checking works on the IDE for the serialization after setting the JSON schemas.

use folders & prefixes in fastify-autoload

as titled

Database section localhost -> 0.0.0.0

On page 74 the following postgres address is suggested
PG_CONNECTION_STRING=postgres://postgres:postgres@localhost:5433/postgres
This didn't work for me, and resulted in the following error message:

req: {
      "method": "POST",
      "url": "/login",
      "hostname": "localhost:3000",
      ...
    }
    res: {
      "statusCode": 500
    }
    err: {
      "type": "Error",
      "message": "connect ECONNREFUSED ::1:5433",
      "stack":
          Error: connect ECONNREFUSED ::1:5433
              at TCPConnectWrap.afterConnect [as oncomplete] (node:net:1494:16)
      "errno": -61,
      "code": "ECONNREFUSED",
      "syscall": "connect",
      "address": "::1",
      "port": 5433
    }
 ...

As you can see the address points to ::1. After discussing this with @SociableSteve it appears to be that using localhost doesn't work in PG_CONNECTION_STRING. Replacing it with 0.0.0.0 resolved the issue, and would recommend this change, however, my understanding of it is limited, and so if there is a better way, please let me know.

don't understand the "services" folder

I would remove the config from there and put in the main startup file

Images are not rendering well

Most of the images are too small to the presentation

use onRequest instead of preValidation in step10

As titled, using onRequest is actually preferred.

create an empty "work-here" folder

as titled, this will direct our attendees to work there

Make fastify workshop slides scrollable

Problem
At the moment when the content is higher than the available height, the offset is invisible:

Solution
Make the container scrollable so the offset can be viewed.

Update fastify-workshop links

The workshop links are referring to the old Fastify documentation.

chore: add --watch flag to "start-here" folder

Fix css issue

Slides have an issue with the div of the copyright

Remove unused variable in test file

Fix step 9 to import newly created plugin

Whilst the decorator created in step 9 is not used at this point, the plugin also includes the registration of fastify-jwt and without this the /users route will crash.

Migrate to Node's test runner

Tap has been causing issues recently due to major changes in the latest versions.

Because we're not using any tap-specific features in this repo, we should consider migrating to Node's built-in test runner.

do not use prettyPrint for logs

prettyPrint should be used only in production scenarios

Add section about constraints

https://www.fastify.io/docs/latest/Reference/Routes/#constraints

Figure out what the best place for it is in the workshop, make sure to create slides and that the examples fit well in the existing flow of the workshop

Feat: Update broken links in the slides

The plugins links that are broken:

• autoload
• postgres
• On exercise 14, should be Step 10 instead of Step 9 (based on git history) and the link is also broken

Add dependabot automerge

Based on https://www.nearform.com/blog/automatic-dependency-bump/. See how other repos use it

Add Typescript section

Section related to declaration merging and maybe typebox support in the validations.

Add logger config/slides and exercises

Invert serialization and validation steps

I think the workshop would flow more naturally - in our latest discussion at NodeCongress people where very confused by the topic of serialization.

Slide "Step 7: Exercise /2" has text missing

The slide 44 has too much info and its text is cutting off bellow the screen:

automate the install of all dependencies in the modules in src

Currently we are using a hack in CI to make test pass.

A "proper", cross-platform fix is needed so npm test works on windows too.

See #8 for more details.

put schemas together with routes

I think that code that change together should stay together, and so the schema for a POST should stay in the same file

Step 12 - Incorrect JWT signing

The shape of the object passed to the JWT sign method changes in step 12, this causes the /user endpoint to fail.

avoid t.test and use test with tap

const { test } = require('tap')

Add permission to deploy workflow

Only one exercise per step

Currently a few steps have more than one exercise in them. Those should be split into multiple steps.

Add deployment workflow

As requested by @simoneb .

fix tests timing out

it seems that the tests have been failing more consistently as of late. let's fix them and go back to a consistently green build

update fastify.listen with opt object

Fix for warning:

@deprecated — Variadic listen method is deprecated. Please use .listen(optionsObject) instead. The variadic signature will be removed in fastify@5

Ecosystem plugins integration testing

use c8 shorthand for 100 coverage

Unable to start

I run npm start and I'm getting:

2:10:28 PM [vite] Internal server error: EMFILE: too many open files, open '/Users/matteo/repositories/the-fastify-workshop/src/step-2/node_modules/@babel/generator/node_modules/source-map/README.md'
   (x3)
node:internal/process/promises:246
          triggerUncaughtException(err, true /* fromPromise */);
          ^

[Error: EMFILE: too many open files, open '/Users/matteo/repositories/the-fastify-workshop/components.d.ts'] {
  errno: -24,
  code: 'EMFILE',
  syscall: 'open',
  path: '/Users/matteo/repositories/the-fastify-workshop/components.d.ts'
}

I don't know what is the problem.

Replace nf-present with Slidev

At the moment, the Fastify-workshop uses nf-present to build the slide-deck for presentation.

A Nearform slidev template is available here which has better support for content formatting and already has NF design.

Migrate the Fastify workshop from using nf-present to slidev

Make fastify workshop slides scrollable

Make sure test setup has coverage reporting working

See tapjs/tapjs#735 for details/workarounds

Error running tests inside the modules folder

When running tests inside the modules folders, the error below is returned:

Error: invalid argument: --esm

Fix slidev build command

The npm run build command throws errors due to image paths not being detected correctly.

Coverage at zero

Using ESM the tests show ZERO coverage.

We should fix this behaviour

`work-here` folder easy to miss

When self-serving the fastify workshop, I missed both the hosted slides and the work-here folder. Instead, I just went through from step-01-hello-world which I later realised were the solutions.

If we changed the work-here to start-here then it will appear before all the solutions avoiding future confusion.

CI: Add a way to test on windows

Add a way to test the workshop on windows

npm v7 support vs yarn?

As titled