setPageMetadata metadata on first page load

[jschuler]

setPageMetadata does not currently send out additional metadata on first page load. This is also already called out here:
http://front-end-docs-insights.apps.ocp4.prod.psi.redhat.com/analytics

I'm creating this issue primarily for QE to reference since this has come up in our project testing (OCM). But it would be great to work on a fix!

[Hyperkid123]

The reason for this is that the route change and thus page event is fired before the JS module is loaded and can customize the page load event.

We have an option to leverage the module first page vent via the module definition in cloud service config (and frontend operator). The issue with this approach is that the module will not have total freedom in what data we pass to the page event. Anything static is good. But any dynamic data has to be restricted.

Do we know the nature of the data we want to send via the page event? Is this something dynamic? (requires async request etc.)

[jschuler]

Generally, once the route is mounted in OCM we send some additional metadata like:

ocm_resource_type: 'all' | 'moa' | 'ocp' | 'ocptrial' | and more based on product
path: some paths are overwritten, like cluster details paths (to strip out the unique IDs in the path name
// next 2 fields are sent from cluster details
ocm_cluster_id: cluster ID
resource_id: external cluster ID

This information is available after a route change. Using react-router-dom we send additional information like this:

const { pathname } = useLocation();
const { setPageMetadata } = useAnalytics();
useEffect(() => {
    setPageMetadata({
      // additional metadata here
    });
}, [pathname]);

No async call is needed as of now, as the redux store is updated with the information we need before the route mounts

[Hyperkid123]

Do you think it would be possible to create a route-based static specification of the data? Something like

{
  "eventConfig": {
    "routes": {
      "/foo/bar": {
       "ocm_resource_type": "something",
       ...
      },
      ...
    }
  }
}

[jschuler]

That could work for the ocm_resource_type field if wildcards are supported as well. You can see the implementation on gitlab here (VPN required)

[Hyperkid123]

We can use the router match notation to get the correct value.