Infrastructure and Tools
What does actually happen when you navigate to a LaxarJS page using the browser?
How does LaxarJS load your widgets, their assets and styles?
And what is the difference between the
index.html in the application template?
Read on to understand the inner workings of a LaxarJS application.
Note: with LaxarJS v2.0, the grunt-based infrastructure was replaced by a webpack-based system. For the previous manual, make sure to browse the LaxarJS v1 documentation.
The LaxarJS Yeoman generator contains a
debug.html that contains the to bootstrap you application during development.
Additionally, there is an
index.html that shows how to run the application using optimized scripts and assets.
In your own application, you do not actually have to use these files: Depending on your setup, you may wish to copy the relevant parts into a Ruby on Rails or Django template, or into a JSP and bootstrap LaxarJS from there.
Let us dissect the startup process of a LaxarJS application based on the
debug.html, only that we have removed everything that is not absolutely required:
<!DOCTYPE html> <html> <head><!-- ... optional: meta elements, title, favicons go here ... --></head> <body> <div data-ax-page></div> <!-- ... optional: add scripts for improved source-map-support --> <script src="build/app.bundle.js"></script> </body> </html>
What do the individual elements mean?
data-ax-pageattribute is referenced by the
init.jsto determine where LaxarJS will place the layout for the current page.
scriptelement loads your application bundle based on the
init.jsentry point, as configured by the
init.jscollects all dependencies for your application and passes them to
laxar.create().….bootstrap()sets up the runtime services based on your configuration, and bootstraps all technology adapters used by your application.
If a flow was initialized before bootstrapping (using
laxar.create(…).flow( name, domNode )), it is now instantiated, and its patterns are used to set up the Navigo router.
The router matches the flow routing patterns against the current URL, and invokes the LaxarJS flow controller with the matching place, so that the current page is determined (possibly after following redirects).
The flow controller instantiates a page controller for the current page.
The page controller loads and inserts the page layout and instantiates the controllers for widgets and activities. Also, it loads the widget HTML templates and their CSS (during development). Widget and activity controllers may already start to make HTTP requests if they need to, while their view is being setup.
After all controllers have been instantiated, the page controller publishes the
beginLifecycleRequestevent to signal that widgets may start publishing events themselves. Then, all widget templates are instantiated, inserted into the layout DOM and linked to their controllers' scopes.
Finally, the page controller signals to the flow controller that navigation is complete, upon which the flow controller publishes the
didNavigateevent. This allows widgets to handle their URL place parameters, and from now on they may publish navigate requests for further navigation.
From this point on, the LaxarJS runtime interacts only through the event bus with widgets and activities. The only exception to this rule is the page teardown caused by navigation, either indirectly through a widget, or directly by changing the URL in the browser.
Before navigating away from a page, widgets receive
If the page is actually being left (there may just have been an update to the URL parameters of the current page) an
endLifecycleRequest event is published, before the widget scopes are destroyed through the regular AngularJS mechanism.
However, when the user simply closes the browser window, this is not always guaranteed.
If navigating to a new page, the startup process (described above) is repeated, starting at step 3.
The Artifacts Bundle
Internally, LaxarJS uses a single service to provide HTML, CSS and JSON assets used to instantiate widgets and controls:
The artifacts provider manages a bundle that was prepared by the
This avoids additional HTTP round trips in production, as well as during development.
Webpack and the laxar-loader
Most modern single page applications are no longer developed using just a text editor, and instead rely on additional development- and build-tools. The npm module laxar-loader helps to load LaxarJS application artifacts that using the popular webpack bundler. Used on a flow definition, this laxar-loader will bundle up all required artifacts, by following the flow via its pages and widgets to its controls and layouts.
LaxarJS does not actually require you to use webpack (for previous version, using RequireJS as loader was mandatory), because it does not perform module loading at runtime. However, to use a different tool chain, you will to generate the artifacts bundle yourself. If you need to do so, look into the laxar-loader and its dependency laxar-tooling for inspiration.
Running the Development Server
The excellent DevServer for webpack allows you to quickly prototype and review changes to your widget.
Depending on the integration technology, you might even be able to "hot-reload" widget templates without reloading the browser window.
For projects created with the Yeoman generator for LaxarJS, you can run the DevServer using