While working on a recent LiveCycle Mosaic demo, I discovered some interesting consequences of using Mosaic services with large amounts of data and memory heavy tiles. Since the cause of the issues was not immediately apparent, and the solution is quite simple, I thought I’d share my findings.
The demo I was constructing consists of quite a few Mosaic tiles that rely on common data. Basically each tile shows a different aspect of the data, so the user gets a graphical breakdown of a current situation. Since much of the data is shared across several tiles, I figured it would be a good use of a common Mosaic service. Then each tile can access the same service and the data only needs to be loaded once. The service will read an XML file from the Mosaic catalog, process it and will have functions that will present aspects of the data to the Tiles.
In the service implementation class, I have a standard Flex HTTPService object that I use to load the data into an XML object. After the data is loaded into the service there are several functions that can be called by the tiles.
For early testing I created a simple XML file and a couple of quickie tiles. By watching the Flash Builder 4 console, I could see that the service was loading, then the tiles. The tiles could access the data via the service with no problems. As I continued adding more complex tiles, and increasing the size of the XML file, strange things started happening.
Every once in a while a tile would give a null pointer error. Upon further inspection, this happened only in tiles that called the service functions on creation complete. It looked as if the service had not loaded the data, but when I put break points in my code I could see that the data was loaded. To aggravate the issue, it wasn’t consistent as to when the problem would happen. I could load the application a dozen times and it would work fine, then it would fail once or twice and then be fine again.
Somebody tell Schrodinger his cat is dead
If all else fails, procrastinate. I ignored the problem and continued working on the rest of the demo – hey it worked most of the time. As I continued to add additional tiles and functionality to the service things steadily got worse. Eventually it got to a point where it would fail more often than it would not. To be fair to myself (and who else will), it really was a good thing to delay looking for the root of the problem. At least now I could take a serious look at what was going wrong and have a reasonable chance of looking at a failed case.
I’ll save you the tribulation of my debugging efforts, needless to say I learned a lot about working with a non-linear multi-faceted environment such as Mosaic. Not the least of which was – just observe, don’t participate. Trying to find intermittent problems with multiple tiles, services, asynchronous events and a black box framework takes a level of patience for which I am not well equipped. I tried to be Zen about it but The Norse part of my genetics just wanted to smash it with a big axe and go burn a village (ah, simpler times…)
After stepping through the code multiple times, and adding more trace statements than I’d like to admit, I was able to figure out that there were actually two separate problems. One was fairly obvious, the other not so much.
Problems and Solutions
The first problem was in the service itself. The tiles depended on the data provided by the service. The service implementation uses an HTTPService to read the data from an XML file. Since the HTTPService load operation is asynchronous (waits for a ResultEvent), a tile may try to access the service before the data is loaded. When the tile makes the call to the service, the XML data is empty and an exception is thrown when the service tries to perform an operation on the data object. When there wasn’t much data it loaded quickly enough not to present a problem. As the test data became larger it took more time to load and the problem started to show itself.
If this was a “normal” Flex app, I’d just have the service dispatch an event when the data was loaded. Flex components that depended on that service would have event listeners that would wait for the service to say it is ready. This won’t work in the Mosaic framework however, because of the decoupled nature of services and tiles. The tile does not have direct knowledge of the service context and therefore cannot pickup events thrown by the service. The solution is to have the service send a message to the Mosaic framework, and have the tiles listen to the framework for a message. Unfortunately, Mosaic service implementations don’t directly inherit the Mosaic context. Yes, I can import the IContext class, but there is no way to initialize it directly with the Mosaic framework’s information.
The solution was a bit of a cheat. I can get the Mosaic context information from a tile, it’s a property of the inherited mosaicApp object. So what I did was to add an IContext variable to the service, with a setter function. Then I had one of the tiles pass its context to the service using the setter. Now when the service decides that both the data and context are set, it can set a Mosaic attribute saying that its ready. Tiles will check the attribute before attempting to access the service. As a bonus, tiles can watch for the attribute to change which will tell them the data has been updated.
I implemented the fix, and tested it out. Everything worked fine … for a while.
Every once and a while the tile that passed its context to the service would throw an exception. The exception stated that the service itself was null. From what I understood about the way Mosaic handled the services, this should not be possible. Mosaic is supposed to load the services before the tiles, guaranteeing that they would exist. Another round of step through and trace statements ensued. From what I was able to deduce, Mosaic was indeed loading the service before the tiles, however the tiles could be created before the reference to the service was injected. In other words, because I was setting the context on the tile’s creationComplete event, the service implementation’s reference may not be fully realized – resulting in a null pointer error.
The solution to this problem was less pleasant. The only way I could figure to make sure the service reference was complete was to put a timer into the tile that set the service context. Basically I check to see if the service object is null. If it is then I set a timer’s event listener and start the timer. The event listener checks again to see if the service is null. If it is then it resets the timer. If it is not then I set the context object and we move on.
I’m not a fan of these kind of timed wait loops. However; without being able to get an event from the service, I can’t see any other way of doing it. The problem is that I can’t get an event without the context being set and I can’t set the context until I know the service is not null.
I also added a check in the other tiles to not only look for the service’s data loaded attribute, but they also check to see that the service object is not null. Belt and suspenders programming at its best.
Here is the short version of what happened:
- Services that perform asynchronous operations need to tell their dependent tiles when these operations are complete
- Service have no direct way of notifying tiles as they don’t have access to the Mosaic context
- A tile can pass that context to the service if the service exposes a context object setter function
- Service load before tiles, however tiles can reach creation complete before the service injection has happened. This means that the tile’s service object may be null.
- The only thing to do is to have the tile wait (using a timer loop) for the injection to be complete.