feat: Add optional support to pipes

[AbdlrahmanSaberAbdo]

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Other... Please describe:

What is the current behavior?

Issue Number: #11865

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

[AbdlrahmanSaberAbdo]

@kamilmysliwiec Thank you for your comments. I have implemented the requested changes. Should I open a new PR specifically for the other pipes? or should we first decide which pipes should be optional?

[coveralls]

Pull Request Test Coverage Report for Build 002d47fb-fb1d-47c3-a863-1ceb404778b9

• 20 of 20 (100.0%) changed or added relevant lines in 5 files are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+0.02%) to 92.863%

---

Totals
Change from base Build 3f7492c5-30a2-408e-8707-ac4c6ee9465f:	0.02%
Covered Lines:	6363
Relevant Lines:	6852

---

💛 - Coveralls

[micalevisk]

for consistency sake I think we should update all the other pipes here as well

• parse-array
• parse-bool
• parse-float
• parse-int
• parse-uuid

[AbdlrahmanSaberAbdo]

for consistency sake I think we should update all the other pipes here as well

• parse-array
• parse-bool
• parse-float
• parse-int
• parse-uuid

Do you think that should I change the PR title to reflect the changes I made for adding the optional property to pipes, regardless of the branch name? Or would it be better to create a new branch and PR specifically for the other changes related to adding optional parameters to pipes?

[AbdlrahmanSaberAbdo]

for consistency sake I think we should update all the other pipes here as well

• parse-array
• parse-bool
• parse-float
• parse-int
• parse-uuid

I updated other pipes, if you think that we should do it in another PR let me know. parse-array already has an optional property.

[AbdlrahmanSaberAbdo]

@kamilmysliwiec @micalevisk I checked the failed test but did not really get why it fails, I don't think that's related to my changes, any inputs would be appreciated!

[rubiin]

Everything looks good so far, But i think a documentation update about this on the pipes section should follow as well

[kamilmysliwiec]

LGTM

[danewilson]

This PR introduced a bug where these validators throw an (unexpected) error if the value is missing and the options argument wasn't supplied:

if (isNil(value) && this.options.optional) { // Cannot read properties of undefined (reading 'optional')
  return value;
}

[AbdlrahmanSaberAbdo]

This PR introduced a bug where these validators throw an (unexpected) error if the value is missing and the options argument wasn't supplied:

if (isNil(value) && this.options.optional) { // Cannot read properties of undefined (reading 'optional')
  return value;
}

Thanks for pointing this out

[kamilmysliwiec]

Fixed in 10.0.5

[igorgbianchi]

Could someone tells me what I'm doing wrong in this case? I'm trying to use the property optional: true but it keeps giving this error when the query param is not sent:

{
    "message": [
        "property apigeeVersion should not exist"
    ],
    "error": "Bad Request",
    "statusCode": 400
}

The defintion:

@Query('apigeeVersion', new ParseEnumPipe(ApigeeVersionEnum, {optional: true})) apigeeVersion: ApigeeVersionDto

@nestjs/core@10.3.1

[igorgbianchi]

Could someone tells me what I'm doing wrong in this case? I'm trying to use the property optional: true but it keeps giving this error when the query param is not sent:

{
    "message": [
        "property apigeeVersion should not exist"
    ],
    "error": "Bad Request",
    "statusCode": 400
}

The defintion:

@Query('apigeeVersion', new ParseEnumPipe(ApigeeVersionEnum, {optional: true})) apigeeVersion: ApigeeVersionDto

@nestjs/core@10.3.1

Fixed, changed to:

    @Query('apigeeVersion', new ParseEnumPipe(ApigeeVersionEnum, { optional: true }))
    apigeeVersion: ApigeeVersionEnum

And added before the method:

@ApiQuery({ name: 'apigeeVersion', type: ApigeeVersionDto })