feat: Improve RouteShorthandOptions['constraints'] type by Fcmam5 · Pull Request #5097 · fastify/fastify

Fcmam5 · 2023-10-14T19:06:09Z

As mentioned in the the documentation, routes may have version, host or other custom constraints. This change only extends RouteShorthandOptions type with optional version and host attributes.

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

mcollina

lgtm

Fcmam5 · 2023-10-16T16:08:02Z

@mcollina can you check again? seems that the pipelines are pending after I changed my PR title 😬

Uzlopak · 2023-10-16T16:34:37Z

Shouldnt be host and version being string?

Fcmam5 · 2023-10-16T17:02:26Z

Shouldnt be host and version being string?

It seems that it can be used as a custom constraint object as in NestJS.

Or, would it be better to use string | ConstraintStrategy<FindMyWayVersion<RawServer>, unknown>?

mcollina · 2023-10-17T11:33:03Z

This actually needs a test, we use tsd for types

Fcmam5 · 2023-10-18T15:37:29Z

@mcollina, @Uzlopak can you check again?

tsd tests passed, and I used the following example to test it locally:

const fastify: FastifyInstance = Fastify({});

function databaseOperation(field, done) {
  done(null, field);
}

fastify.route({
  method: 'GET',
  url: '/',
  constraints: {
    version: '1.2.3',
    host: 'admin.dz',
    secret: {
      name: 'secret',
      storage: function () {
        let handlers = {};
        return {
          get: (type) => {
            return handlers[type] || null;
          },
          set: (type, store) => {
            handlers[type] = store;
          },
        };
      },
      deriveConstraint: (req, ctx, done) => {
        databaseOperation(req.headers['secret'], done);
      },
      mustMatchWhenDerived: true,
    },
  },
  handler: function (request, reply) {
    reply.send({ hello: 'world' });
  },
});

I played with the values/types to see if it still working as expected:

version:
- string
- RouteConstraint
Host:
- string
- RegEx
- RouteConstraint

And custom constraints must have RouteConstraint

mcollina

lgtm

climba03003 · 2023-12-14T06:35:40Z

I am a bit late here because just notice an error after this landing on 4.25.0.
constraints should accept any or unknown types instead of RouteConstraintType.
RouteConstraintType is used when passing fastify.addConstraintStrategy.

github-actions · 2024-12-14T00:29:18Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

Improve RouteShorthandOptions['constraints'] type

63992d3

github-actions bot added the typescript TypeScript related label Oct 14, 2023

Fcmam5 mentioned this pull request Oct 14, 2023

feat(fastify): add fastify route constraints nestjs/nest#12567

Merged

12 tasks

Merge branch 'main' into main

b67aa19

mcollina approved these changes Oct 15, 2023

View reviewed changes

Fcmam5 changed the title ~~Improve RouteShorthandOptions['constraints'] type~~ feat: Improve RouteShorthandOptions['constraints'] type Oct 15, 2023

Fcmam5 force-pushed the main branch from 2f7d225 to b67aa19 Compare October 18, 2023 00:23

Use more explicit types for route constraints

c47af0d

Fcmam5 force-pushed the main branch from 60d1ed3 to c47af0d Compare October 18, 2023 15:37

Fcmam5 requested a review from mcollina October 19, 2023 14:24

mcollina approved these changes Oct 23, 2023

View reviewed changes

mcollina merged commit dcac2eb into fastify:main Oct 23, 2023

climba03003 mentioned this pull request Dec 14, 2023

fix: route constraints #5207

Merged

4 tasks

github-actions bot locked as resolved and limited conversation to collaborators Dec 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Improve RouteShorthandOptions['constraints'] type#5097

feat: Improve RouteShorthandOptions['constraints'] type#5097
mcollina merged 3 commits intofastify:mainfrom
Fcmam5:main

Fcmam5 commented Oct 14, 2023 •

edited

Loading

Uh oh!

mcollina left a comment

Uh oh!

Fcmam5 commented Oct 16, 2023

Uh oh!

Uzlopak commented Oct 16, 2023

Uh oh!

Fcmam5 commented Oct 16, 2023

Uh oh!

mcollina commented Oct 17, 2023

Uh oh!

Fcmam5 commented Oct 18, 2023 •

edited

Loading

Uh oh!

mcollina left a comment

Uh oh!

climba03003 commented Dec 14, 2023

Uh oh!

github-actions bot commented Dec 14, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

Fcmam5 commented Oct 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

Fcmam5 commented Oct 16, 2023

Uh oh!

Uzlopak commented Oct 16, 2023

Uh oh!

Fcmam5 commented Oct 16, 2023

Uh oh!

mcollina commented Oct 17, 2023

Uh oh!

Fcmam5 commented Oct 18, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mcollina left a comment

Choose a reason for hiding this comment

Uh oh!

climba03003 commented Dec 14, 2023

Uh oh!

github-actions bot commented Dec 14, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Fcmam5 commented Oct 14, 2023 •

edited

Loading

Fcmam5 commented Oct 18, 2023 •

edited

Loading