Closing in on Tapestry 5.4
Closing in on Tapestry 5.4
Join the DZone community and get the full member experience.Join For Free
FlexNet Code Aware, a free scan tool for developers. Scan Java, NuGet, and NPM packages for open source security and open source license compliance issues.
Before the switch, the application was already using jQuery, Bootstrap, and a limited amount of Backbone; under Tapestry 5.3, that means that Prototype and Scriptaculous were also in the mix ... and there were quite a few conflicts between Prototype and jQuery.
It's not just that Prototype and jQuery both want to use
window.$ as their point of entry; the conflicts can be deeper and more subtle. For example, I had a nasty time with a Boostrap modal dialog that didn't dismiss correctly. After a lot of debugging, I found out that jQuery treats a method on an element as an event handler for the event with the matching name; Bootstrap was triggering a
hide event, and jQuery was invoking the
hide() Element method added by Prototype. That kind of thing has been my life under the mixed stack.
The transition from 5.3 to 5.4 was a chance to review and improve all that code. Here's a few observations.
The application has some very complex client-side forms; well beyond the abilities of Tapestry to manage using the FormInjector and FormFragment components. Instead, we use Backbone is a kind of hybrid mode, where the Backbone Model or Collection is persisted to a hidden field, so that the data collected or edited is transmitted to the server as part of an over-all form submission.
Of course, this means creating a lot of content, including form control elements, on the fly. One of the main problem was integrating Tapestry's client-side validation for the newly created fields.
Under 5.3, this required examining and often hacking (or monkey patching) the Tapestry client-side code, which create
FieldEventManager objects for each form or form control element ... and there was lots of hackery to tap into the form's submission cycle to perform validations.
Under 5.4 it is much easier, when creating the new fields, we can specify the desired validations via attributes:
EditAddressView = BaseCountryRegionCityView.extend template: """ <div> <div class="control-group"> <label class="control-label"> <span data-insert="prefix"/> <span data-insert="recipient-name"/>: </label> <div class="controls"> <input class="input-xlarge" data-bind="name"/> </div> </div> <div class="control-group"> <label class="control-label"> <span data-insert="prefix"/> Address <span data-insert="suffix"/>: </label> <div class="controls"> <input class="input-xlarge" data-bind="street1" data-validation="true" data-optionality="required" data-required-message="You must provide a street address."/> </div> </div>
data-validation attribute indicates the field participates in validation; it will have events triggered on it when the enclosing form submits. The
t5/core/validation module supplies the code that handles fields with
data-optionality="required" and ensures that a value is provided, displaying the
data-required-message if the field is left blank.
That's the pattern throughout 5.4;
data- attributes are used to identify where special behavior is desired, and a well documented system of events is used handle the processing of the behavior.
I made some improvements, adding a special development-mode in-memory cache that would only recompile the CoffeeScript if the underlying source file content had changed. Since application restarts are rare in Tapestry, this was sufficient. I eventually added a file-system cache so that compilation could be avoided, even over restarts of the application.
I found that the out-of-the-box support for Less4J supplied by WRO4J was insufficient: it didn't do a great job with
@import; a change to an imported source file didn't force a recompilation. I've addressed that with a custom (for Tapestry) wrapper that properly tracks dependencies.
So where does that leave us? There's still a huge amount of work to do before Tapestry 5.4 is ready for release, but it's mostly fixing bugs and other rough edges. As too often happens, the reality of earning a living have made me postpone some of my ideas for a later release.
I think that Tapestry is aging, if not gracefully, then at least comfortably, into a growing age where rich, single-page applications built with Backbone, AngularJS, or something else are the norm, and not the exception. I'm the first to admit that Tapestry was designed for a simpler time when Ajax was seasoning, not the meat-and-potatoes of the application. There's a lot of baggage in there, particularly related to forms and form controls. Yet, even so, there's some amazingly useful parts to Tapestry that apply equally well to modern applications:
- Asset Pipeline
- Asynchronous Module Definition (AMD) Support
- Superior Feedback and Exception Reporting
When working on other stacks, the thing I miss the most now is Tapestry's exception reporting. This is cleanly integrated in Tapestry, where a server side failure will result in a detailed HTML report on the client. For Ajax requests, this report is presented in a floating
<iframe>. The wealth of information available from the server side and reported directly in the client makes developing complex applications with involved server-side interaction much easier.
As Tapestry 5.4 transitions to beta, and to an eventual final release, I'm still targeted on the future ... and I'm focused on making Tapestry be a great choice for single-page apps as well as traditional applications. My head is bubbling with ideas to make this happen.
Published at DZone with permission of Howard Lewis Ship , DZone MVB. See the original article here.
Opinions expressed by DZone contributors are their own.