#494 ✓wontfix
Dirk

Validation classes improvements

Reported by Dirk | December 15th, 2010 @ 03:04 PM

Suggested improvements:

  • make the fields of Error public
  • change the name of Error.key to Error.field
  • change the name of Error.message to Error.code
  • add a method Validation.errors(String field, String key)
  • add a method Validation.hasError(String field, String key)
  • refactor Validation.applyCheck method so that it doesn't add an extra Error object to the errors map when validating an object (if you validate an object and there is an error, a new Error is created with message "validation.object")

It is useful to be able to take different actions depending on the type of error. For example:

if(validation.hasError("captcha", "expired")) {
    String newCode = CaptchaServer.new()
    renderJson("{\"code\":"+newCode+"}")
}

When rendering an error object as json, the message() method hides the message field. So this is not possible:

function handleError(error) {
    // Fails because error.message is translated, eg "The captcha has expired"
    //if(error.key == field && error.message == "expired") {
    // This would be better:
    if(error.field == field && error.code == "expired") {
        showMessage(error.message);
        requestNewCaptcha();
    }
}

Comments and changes to this ticket

  • Erwan Loisant

    Erwan Loisant June 9th, 2011 @ 12:44 PM

    • State changed from “new” to “wontfix”
  • Dirk

    Dirk June 9th, 2011 @ 02:17 PM

    Could you explain why it won't be fixed?

  • Erwan Loisant

    Erwan Loisant June 9th, 2011 @ 02:53 PM

    I've done some clean up in the bug tracker, closing some bugs that didn't have activity for several months.

    This one in particular:
    * Has many unrelated points, making it impossible to deal with (there should be one bug per item) * Involves breaking APIs

  • Dirk

    Dirk June 9th, 2011 @ 03:00 PM

    The bugs are all related to Validation. If you want I can open a separate bug for each one, but I think it would be easier to fix them all at once because they're all in either the Error class or the Validation class.

    Changing the name of the fields won't break any APIs because they're private. The only thing which might break APIs is the request to remove the extra Error object, but I very much doubt anyone is relying on it as it doesn't really add any information to the validation response.

  • Dirk

    Dirk June 9th, 2011 @ 03:12 PM

    Something that may not be that clear from the original bug report: most of these changes are intended to make it easier to use validation with ajax. For example when the Error object is rendered as json, the names of the fields is important (whereas from Java you call a method so it's not relevant).

Please Sign in or create a free account to add a new ticket.

With your very own profile, you can contribute to projects, track your activity, watch tickets, receive and update tickets through your email and much more.

New-ticket Create new ticket

Create your profile

Help contribute to this project by taking a few moments to create your personal profile. Create your profile »

<h2>Play framework</h2>

Play makes it easier to build Web applications with Java. It is a clean alternative to bloated Enterprise Java stacks. It focuses on developer productivity and targets RESTful architectures. Learn more on the <a href="http://www.playframework.org">http://www.playframework.org</a> website.<br><br>

<h2>Source code is hosted on github</h2>Check out our repository at <a href="http://github.com/playframework/play">http://github.com/playframework/play</a><br><br>

<h2>Contributing, creating a patch</h2> Please read the <a href="http://play.lighthouseapp.com/projects/57987/contributor-guide">contributor guide</a><br><br>

<h2>Reporting Security Vulnerabilities</h2> Since all bug reports are public, please report any security vulnerability directly to <em>guillaume dot bort at gmail dot com</em>.<br><br>

<h2>Creating a bug report</h2> Bug reports are incredibly helpful, so take time to report bugs and request features in our ticket tracker. We’re always grateful for patches to Play’s code. Indeed, bug reports with attached patches will get fixed far quickly than those without any.<br><br>

Please include as much relevant information as possible including the exact framework version you're using and a code snippet that reproduces the problem.<br><br>

Don't have too much expectations. Unless the bug is really a serious "everything is broken" thing, you're creating a ticket to start a discussion. Having a patch (or a branch on Github we can pull from) is better, but then again we'll only pull high quality branches that make sense to be in the core of Play.

Tags

Pages