Fixing Dojo 1.6.1 in Domino 8.5.3


This all stems form an issue with Dojo less than 1.6.2 in Chrome 29 and any browser that used the same child node reference. This post specifically covers how to fix this (as it occurs with Domino 8.5.3) and get one of the most popular web standards compliant browsers back in the game with Domino and the ExtLib/UP1 controls.

Fixing Dojo 1.6.1 in Domino 8.5.3

I ran into a situation recently that required a bit of determination to fix. The BLUF: my implementation of the Dojo Enhanced DataGrid was breaking when applying the dojox.grid.enhanced.plugins.Filter due to an issue with the Dojo queries of elements rooted at the specified element. For example:

 dojo.query('> *', dojo.byId('container')) 

Thankfully, that doesn't keep a good developer down.

Domino 9, 8.5.3 UP1, and my Woes

IBM Domino 9 brings a great many changes to the Domino server and has been fairly well received. Stuck, for now, with 8.5.3, I was at least able to get Upgrade Pack 1 applied, giving me the basic level of the majority of the same new controls.

That being said, I still had the controls I wanted to play with, so I still tried the "play at home" version of Brad Balassaitis' excellent series on Dojo Grids in XPages. When I hit Part 14: Enhanced Filtering with No Coding, I found that the Filtering plugin would cause my control to break in a rather unexpected fashion.

Dojo 1.6.1

Domino 8.5.3 has Dojo 1.6.1. The culprit in question, as I found out from attempting to use Chrome with the Enhanced Grid, the issue was with the child selector call.

![the beast in its lair])(./images/dojoBeastInLair.png)

After finding what the issue was, followed by some intense Google searching, I had found the fix for this in Dojo 1.6.2. The fix was small enough, I thought, "why can't I implement this?" So I did.

Doing Something About It

1. Extract the Source Dojo from the JAR

Starting about Domino 8.5.3, the Dojo library inclusion migrated from the usual source path in <Domino>\data\domino\js\dojo-1.x.x folder structure on the file system to a JAR deployment. The 1.6.1 source can be found in <Domino program>\osgi\shared\eclipse\plugins\ To begin, we need to extract the 1.6.1 source files out of the JAR, I recommend using 7zip, though any method of un-zipping the JAR will suffice. The folder structure is in the resources\dojo-version directory. Extract that to the older format js directory in the Domino\data path and you now have a working version of the 1.6.1 Dojo library. I recommend giving your extract Dojo library a better name than my very boring 1.6.1.source; like .modified ;-)

2. Apply the Fix

Per the relevant commit in Dojo 1.6.2, which addressed this issue, we need to make our change to the dojo.js file in two locations. I recommend making a backup copy of:

  • dojo.js
  • dojo.js.gz
  • dojo.js.uncompressed.js

You can see there are actually three files, one minified, one minified and gzip'd, and one un-minified. Per the description in the commit message, we need to find the root[childNodesName] references and replace them with root.children || root.childNodes, found in two locations. They specified two line numbers, but mine turned out to be lines 8644 and 8925. I'm chalking up the variance to our 1.6.1 version coming to us via IBM (I'm guessing comments). Since the lines we change are those directly dealing with our issue, the child dependency handling, I know we're good. Save your file over the dojo.js.uncompressed.js file.

3. Apply Again

Now that the original, un-compressed version has its updates, it's time for those minified and minified and gzip'd versions. If you're using an editor like Notepad++, you can use a plugin such as JSTool to perform the JSMin operation.

minifying with JSTool in Notepad++

Save that file over the dojo.js file. Now for the gzip'd version. With 7zip, you can perform a right-click on the dojo.js file and select 7zip > Add to Archive. For the settings, select the correct archive format, ensuring the .gz extension gets applied and overwrite the existing dojo.js.gz file.

gzip-ing with 7zip

4. Restart and Use

Now you only need to restart the Domino server and you can start using it. Just restarting the http task doesn't quite do it, as Domino needs to fully re-register all its known libraries (not just re-initialize the handling of http connections). If you don't, but you set the library in the Xsp Properties, you will not be able to load your new version, as the selected library will return a runtime error, as the server hasn't registered it yet.

no dice yet, restart the server

To use it in an NSF, open the Xsp Properties file and specify your modified name in the Dojo version field. If you prefer the source, it's applied by xsp.client.script.dojo.version=1.6.1.modified (or .source, whichever you call it). Note to leave off the dojo- prefix.

specify the new dojo library in XSP Properties


You are now able to use the Dojo Enhanced DataGrid with the dojox.grid.enhanced.plugins.Filter!

winter is coming