(optional) null should be part of matchedData

[melroy89]

Hi,

TLDR: matchedData() is not returning my body field with JSON value of null, while I try to validate the data with the check API.

I don't know if I use your validator incorrect or if it's a feature request.. but..
I use your validator for my backend app before sending the JSON object further to the database (eg. MariaDB).

I have a database field what either can be of type integer or have the value of NULL. So I tried to use your validator in this way (at least this is what I thought should work):

body('journal_bank_id').optional({nullable: true}).isInt()

However, I'm also using the filter matchedData() function in order to guarantee that my data I put in my database is fully validated first by your validator package 👍

object = matchedData(req)

Now, when I try to request an API call to the Express backend using your validator with the HTTP body:

{"journal_bank_id": null}

Expected situation: I would expect the JSON object is now validated correctly and the journal_bank_id with null value becomes part of the returned object from matchedData(). Meaning the MySQL query will set the corresponding field to NULL accordantly. So basically I would expect matchedData() returns:
{"journal_bank_id": null}

Actual situation: matchedData() is not returning journal_bank_id with value null at all. Meaning my database field can't be set to NULL because of your validator.

Do I miss something here? Should I maybe not use optional()? I couldn't find isNull().. I have no clue anymore..

Thanks in advance!

Kind regards,
Melroy van den Berg

[melroy89]

Like previous version supported: .allow(null) if I'm not mistaken..

[gustavohenke]

Thanks for reporting this, @Danger89. Will need to add an option to include optional data, otherwise could break people's applications.

[melroy89]

Sure whatever is needed

[melroy89]

@gustavohenke
The interface says filterOptionals not includeOptionals. So what is it? Is this a typo or?

export interface MatchedDataOptions {
  filterOptionals: boolean;
  onlyValidData: boolean;
  locations: Location[];
}

[melroy89]

And waiting on a new release 👍

[gustavohenke]

The interface is wrong

[JoseExposito]

First, thank you very much for the PR @gustavohenke

Any estimated release date? I'm also affetected by this issue. See #605

[gustavohenke]

I have been unable to dedicate much time to this project lately, that's why I haven't released it yet.
I don't expect to add anything else to the already quite big log of changes of an eventual v5.3.0.

[JoseExposito]

Thank you very much for your answer and effort put in the project.

Looking forward for the next release and hopping you manage to spare some time. This kind of projects can be very time consuming, so let me know if you need help with the release.

[gustavohenke]

Shipped on v5.3.0! 🚢

[GitStorageOne]

Current logic is not correct in my opinion.
ValidationSchema contain:

optional: {
  options: { nullable: true }
}

matchedData() removes fields with null value.
null is proper data type, that present in JSON, JS and Databases, and should not be dropped when nullable: true.

If we pass includeOptionals, we would be able to receive null values, but this adds undesired effect, because if datashape is not include optional field at all, matchedData will add it with undefined value.

Expected behavior is to pass null without includeOptionals option when nullable: true.
So, when client not specify optional field, we will not see it, as expected.
When client send null, we will get null as expected and database will accept that type.
That would be correct logic, but may break some user projects.

Current workaround is to set includeOptionals = true and manually delete all undefined fields which is not great.

[lock]

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