Skip to content

"label" local context defined in helper.error(code, opt) is override by the label of Messages.root. #2950

Open
@hare0319

Description

@hare0319

Support plan

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

Context

  • node version: 18.15.0
  • module version with issue: 17.9.2
  • last module version without issue: Not sure
  • environment (e.g. node, browser, native): node
  • used with (e.g. hapi application, another framework, standalone, ...): standalone
  • any other relevant information:

What are you trying to achieve or the steps to reproduce?

I have a joi schema like

const schema = joi.object({
   id: joi.string()
   usr: joi.string().min(3).max(10),
   pwd: joi.string()
});

As id is assigned by db, I leave it optional. But later when I verify data come back from db. I want to check it is included in the data.
So, I defined a custom rule for this, which looks like

schema.custom((val, helper) => {
  if(val.id) return val;
  return helper.error('any.required', {local: 'id', key: 'id'})
}, 'custom validation').validate({
  usr: "test"
})

What I'm expecting is that an error reported for missing 'id'.

What was the result you got?

I actually get a validation error, but the message is "value" is required.
I checked the error details, key from local context is updated into error.details.context. But label is overridden by the root value.

What result did you expect?

The label defined in local context takes higher priority and shown in the error message. For the example case, the expecting message should "id" is required

Metadata

Metadata

Assignees

No one assigned

    Labels

    supportQuestions, discussions, and general support

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions