Skip to main content

Play Framework with RequireJS and YUI

I've concluded an older post with a promise to investigate the issues of integration of Play Framework with RequireJS and YUI. Finally I've got some time to resolve all issues so I'm going to showcase a working sample multi-page project in this article.
  1. Sample project.
  2. Issues.
Sample project
Play Framework offers a nice official tutorial for RequireJS-support. However, it appeared that not all RequireJS features are fully supported by Play Framework yet (see below in Issues section). So it required some tuning before everything started working. I've published a sample project on github so you're welcome to look into it. Some of the issues that I faced are described in the section below. Here I'm going to show a couple of screenshots of the sample application. This is how one page of the application looks like:
Below is the screenshot of the network tab of the Google Chrome developer tools showing all page resources in the production mode. You can see that the following resources are loaded:
  • require.js - its script tag is injected by Play Framework;
  • main1.js - custom JS resources that are combined, minified and loaded by RequireJS;
  • yui-min.js - pre-minified version of YUI that is only loaded by RequireJS without minification;
  • combo - YUI dependencies managed by YUI loader.

In order to save others' time I'm going to list and comment on the RequireJS issues that I faced. They only appeared while running Play in production mode (i.e. play start or play stage).
JavaException: /appl/sample-application/target/scala-2.10/classes/public/javascripts-min/lib.js (No such file or directory)
In module tree:
Solution: I've removed an additional app directory and have put the main page resources under assets/javascripts/* while the dependent libraries can still be placed in child directories.
Explanation: It's appeared that baseUrl RequireJS config property leads to inconsistent behavior if compared between development and production modes. It looks like it's not properly used by Play Framework in production mode.
JavaException: /appl/sample-application/target/scala-2.10/classes/public/javascripts-min/YUI.js (No such file or directory)
In module tree:
Solution: I've found a solution in baratox's project. I've created build.js file (see the code ) and have added it as a shim config in build.sbt.
Explanation: RequireJS fails to optimize YUI js so it should be prevented.
TypeError: YUI is not a function, it is undefined.
In module tree:
Solution: I've added load() invocation in UseYUI.js when YUI is undefined.
Explanation: As it worked fine in development mode, it's most likely caused by RequireJS attempt to optimize YUI in production mode that fails. So I believe load() invocation helps to ignore the YUI dependency during the optimization.


Post a Comment

Popular posts from this blog

Connection to Amazon Neptune endpoint from EKS during development

This small article will describe how to connect to Amazon Neptune database endpoint from your PC during development. Amazon Neptune is a fully managed graph database service from Amazon. Due to security reasons direct connections to Neptune are not allowed, so it's impossible to attach a public IP address or load balancer to that service. Instead access is restricted to the same VPC where Neptune is set up, so applications should be deployed in the same VPC to be able to access the database. That's a great idea for Production however it makes it very difficult to develop, debug and test applications locally. The instructions below will help you to create a tunnel towards Neptune endpoint considering you use Amazon EKS - a managed Kubernetes service from Amazon. As a side note, if you don't use EKS, the same idea of creating a tunnel can be implemented using a Bastion server . In Kubernetes we'll create a dedicated proxying pod. Prerequisites. Setting up a tunnel.

DynamicReports and Spring MVC integration

This is a tutorial on how to exploit DynamicReports reporting library in an existing  Spring MVC based web application. It's a continuation to the previous post where DynamicReports has been chosen as the most appropriate solution to implement an export feature in a web application (for my specific use case). The complete code won't be provided here but only the essential code snippets together with usage remarks. Also I've widely used this tutorial that describes a similar problem for an alternative reporting library. So let's turn to the implementation description and start with a short plan of this how-to: Adding project dependencies. Implementing the Controller part of the MVC pattern. Modifying the View part of the MVC pattern. Modifying web.xml. Adding project dependencies I used to apply Maven Project Builder throughout my Java applications, thus the dependencies will be provided in the Maven format. Maven project pom.xml file: net.sourcefo

Cocoon authentication

This article will guide you through the steps showing how to use the Authentication Framework in a Cocoon 2.2 application. Maven dependencies. Spring configuration. Sitemap. Login page and controls. Maven dependencies You need the following dependency in your pom.xml : <dependency> <groupId>org.apache.cocoon</groupId> <artifactId>cocoon-auth-impl</artifactId> <version>1.0.0</version> </dependency> Spring configuration Authentication Framework has a flexible configuration based on a concepts of applications and security handlers . There can be several applications defined and running at the same that are simply independent security zones of your web application. The security details of an application are specified using a security handler. There are several implementations provided and you're free to implement your own. Here is the SimpleSecurityHandler used that takes the hardcoded credentials: <?xml versio