Can I warn on Unkown

[moonmeister]

Support plan

• is this issue currently blocking your project? (yes/no): yes
• is this issue affecting a production system? (yes/no): yes

Context

• node version: v14.17.4
• module version: v17.4.2
• environment (e.g. node, browser, native): node
• used with (e.g. hapi application, another framework, standalone, ...): Part of the Gatsby project
• any other relevant information:

How can we help?

We don't want to strip unknown object keys but we do want to throw a warning to user.

We're using validateAsync and must do so as we're using external.

allowUnkown disables errors, but doesn't let us catch unknown keys as warnings.

An initial implementation caught errors and filtered the error type on object.unknown and warned based on that. However, because this was catching a thrown error from Joi that meant the rest of our code in the try block stopped running and we can't return the modified value that should be returned thus causing a bug I just found. This is still true even with abortEarly: false.

I need a way to either catch and filter errors before they throw or to make is so unknowns are allowed but return in the warning object. Is this possible?

[moonmeister]

Still hoping to solve this problem. I'm happy to submit a PR that enables returning errors from validateAsync. Would that be accepted?

[hueniverse]

Joi.object().pattern(/.*/, Joi.any().warning('any.unknown'));

[moonmeister]

Thanks, much appreciated.

[imjoshin]

Hello @hueniverse ! I'm curious if you have any ideas for marking Joi.object().pattern(/.*/, Joi.any().warning('any.unknown')); recursively. I acknowledge this isn't the greatest approach, but I couldn't think of a better way to do this at a high level without reaching into the internals of Joi.

const wrappedJoiObjectWithUnknownWarnings = <TSchema = any, T = TSchema>(schema?: SchemaMap<T>): ObjectSchema<TSchema> =>
  joi.object(schema)
    .pattern(/.*/, joiInstance.any().warning(`any.unknown`))

joiInstance.object = wrappedJoiObjectWithUnknownWarnings

This basically wraps any .object call to also throw warnings on unknown fields, using the example above. From what I can see, it works, but is not great.

[hueniverse]

@j0sh77 Are you looking to turn an error into a warning globally?

[tyhopp]

@hueniverse In a nutshell yes, for a given schema we want to turn all unknown key errors into warnings.

The issue we're facing now when trying the solution you shared is that it works for the root level keys but not for nested object keys.

I've tried using Joi link to achieve this but with no luck.

[hueniverse]

Please open a new issue for recursive warning support and I'll try to get to it.

[imjoshin]

Thank you! Filed #2739.