keystonejs/keystone-classic

Mongoose validator message not displayed in Admin UI

Open

#4634 opened on May 16, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (14,656 stars) (2,288 forks)batch import
4.x candidatebughelp wanted

Description

Expected behavior

When using a custom validator on a field, the validation message should be surfaced in the admin UI.

Actual/Current behavior

The message value is not displayed. Instead, ValidationError: [model name] validation failed is displayed, which does not indicate which field the error corresponds to.

Steps to reproduce the actual/current behavior

Create a Mongoose model and add a validate object to a field. Example:

[YourModel].add({
  phone: {
    type: Types.Text,
    required: true,
    initial: true,
    validate: {
      validator: function(value: any) {
        return /\d{3}-\d{3}-\d{4}/.test(value);
      },
      message: '{VALUE} is not a valid phone number',
    },
  }
});

Environment

Software Version
Keystone 4, Beta 8
Node 8.11.1
Mongoose 5.1.1

Contributor guide

Tech stack
javascriptnodejsmongodbreact
Domain
backendfrontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.jsKeystoneJS basicsMongoose validation concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate how Mongoose validation errors are processed when saving a model. The error message from the custom validator is not being passed to the Admin UI. Look at the validation error handling in the backend (likely in the model update/create API) and the frontend components that display field errors. Ensure the message property is surfaced in the UI instead of the generic 'ValidationError' message.