Viewgroup preloading

[pekura]

No description provided.

[pekura]

Implementation details

• View group preloading is triggered after navigation has changed and the view is rendered (after the microfrontend view sends confirmation to luigi core that the navigation was successful ('luigi.navigation.ok' event) or context was requested ('luigi.get-context' event). This won't affect user experience when clicking on navigation node and it is likely that after that for some time there will be no further interaction with the UI.
• Only one view group gets preloaded the first time. The subsequent preloading events will decide the batch size (how many view groups get preloaded at once in parallel) based on measured loading time of previously preloaded view groups (if this information is available). The batch size can be 1 to 3. It gets reevaluated each time.
• If at the time view groups preloading should be triggered there are view groups being loaded the preloading gets skipped completely till next navigation event happens. These throttling measures are there to minimize impact on user perceived responsiveness of the application.

How to test

You need at least on view group configured in the Luigi configuration, better more that one. In navigation section of Luigi config you need to specify it like this:

  viewGroupSettings = {
    ananas: {
      preloadUrl: '/ananasapp.html#/preload',
    },
    tets: {
      preloadUrl: '/tetsapp.html#/preload',
    },
    tets2: {
      preloadUrl: '/tets2app.html#/preload',
    }
}

Preload URL should be rather empty page that includes LuigiClient so that it can react on 'luigi.navigat.ok' event properly!

You also need to mark some navigation nodes to belong to a view group like this:

   {
     category: { label: 'Settings', icon: 'action-settings' },
     pathSegment: 'settings',
     label: 'Project Settings',
     viewUrl: '/sampleapp.html#/projects/' + projectId + '/settings',
    icon: 'settings',
    viewGroup: 'ananas'
   },

Than you can click around in the application and watch iframes with preloaded viewgroups getting preloaded (there are also debug messages to be seen in the console).

[jesusreal]

Please see my comments below