Type Coercion about express-openapi-validator HOT 6 CLOSED

Thanks @richdouglasevans. I'll have a look at providing an option coerceTypes.

from express-openapi-validator.

@richdouglasevans
i put together a test to try out your case. as far as i can tell it works correctly

Given the following spec for Pet (which is used in the POST request below)

    NewPet:
      required:
        - name
      properties:
        name:
          type: string
        tag:
          type: string
        is_cat:
          type: boolean

I created the following test
(note that is_cat is specified as a boolean in the spec above, however, it is passed in the request as a string and is thus is a candidate for type coercion)

     it.only('should coerce the string 'true' to the boolean true', async () =>
        request(app)
          .post(`${basePath}/pets`)
          .send({
            name: 'test',
            is_cat: 'true', 
          })
          .expect(200)
          .then(r => {
           // return the request body after validation
            expect(r.body.is_cat).to.be.a('boolean');
          }));

The test case works as expected, the string "is_cat": true is properly coerced to boolean which i echo back in the response

Next, I created a similar test but passed a boolean in the request. Here, I want to ensure that the boolean true remain a boolean after validation. Th

     it.only('should keep the boolean true as a boolean', async () =>
        request(app)
          .post(`${basePath}/pets`)
          .send({
            name: 'test',
            is_cat: true, 
          })
          .expect(200)
          .then(r => {
            expect(r.body.is_cat).to.be.a('boolean');
          }));

This test also looks good

All in all, it's very possible that my tests don't match your use case. If so, please let me know. An example is of course appreciated.

On another note. as a sanity check, it may be worth verifying that type for majorReferenceWork is defined with type boolean and not string

from express-openapi-validator.

Carmine you're a ⭐️ Thanks for the speedy reply.

Annoyingly, I'm unable to supply a failing example using the pets schema. The issue manifests consistently in the schema I'm using on this work project but I just can't get the same behaviour elsewhere.

Let me close this ticket because I need to spend some time understanding what, specifically, is causing the issue in my environment: if I can create a failing example using the pets schema I'll open another ticket.

👍

from express-openapi-validator.

np. i've added a couple tests around coercion in case we find a need for this. 3126ef9

from express-openapi-validator.

@richdouglasevans ive added the ability to disable type coercion. The option is described in the ready. Hope this helps. See v1.8.0

from express-openapi-validator.

I saw that Carmine, cheers! I'll be testing it next week at work 👌

from express-openapi-validator.