feat: route parameters

[polymathca]

Adds route parameters based on underscore-prefixed folders. See #133

Checklist

• run npm run test and npm run benchmark
• tests and/or benchmarks are included
• documentation is changed or added
• commit message and code follows the Developer's Certification of Origin
  and the Code of conduct

[polymathca]

I just noticed some strange behaviour in the output of fastify.printRoutes() if a file inside the parameterized folder (e.g. _id) doesn't have a root path defined (/), but does have a named path (/test) defined.

Given

# /routes/_id/index.js

export default async function (app, opts) {
  app.get('/test', async function (req, reply) {
  })
}

Instead of showing:

├── :id/test (GET)
└── / (GET)

it displays:

├── :/testid (GET)
└── / (GET)

The application itself still functions as expected, e.g. /routes/some_id/test will respond correctly. Adding;

app.get('/', async function (req, reply) {
})

Results in:

├── :id (GET)
└── / (GET)
    └── test (GET)
        └── / (GET)

Not sure what to make of it!

[climba03003]

My advice would be make use of fastify.log.debug or fastify.log.trace when you debug.
Then, just left the the log there as they are useful when you debugging. And this info should be useful when the others want to debug.

[polymathca]

My advice would be make use of fastify.log.debug or fastify.log.trace when you debug.
Then, just left the the log there as they are useful when you debugging. And this info should be useful when the others want to debug.

Thanks, I'll keep that in mind! I wasn't sure where to start logging, as the route is working properly, just not displaying correctly in the printRoutes() output.

[polymathca]

I added a new test to track this down. The route tree, at least on my system, looks like this:

└── / (GET)
    ├── pages (GET)
    │   └── / (GET)
    │       ├── archived (GET)
    │       └── :id (GET)
    │           └── / (GET)
    │               └── edit (GET)
    └── users/:/detailsid (GET)   <- this is scrambled, should be 'users/:id/details (GET)'

But all of the tests pass as expected, so it appears to just be an issue in how the tree is being displayed.

[mcollina]

The code looks good to me.
It would be awesome if you could identify why find-my-way printRoutes scrambles it (and maybe send a PR).

I would start trying to assemble the routes manually and see if you can reproduce the rendering problem.

[polymathca]

The code looks good to me.
It would be awesome if you could identify why find-my-way printRoutes scrambles it (and maybe send a PR).

I would start trying to assemble the routes manually and see if you can reproduce the rendering problem.

I believe I finally found the culprit! I created a PR here:

delvedor/find-my-way#182

(I'm not sure if github allows referencing between projects or not)

[mcollina]

The code looks ok! Could you add docs about it in the README.md?

[polymathca]

I updated the documentation and added CJS tests as well, should be good to go!

[mcollina]

lgtm

[mcollina]

lgtm