[Log Explorer] Restore dataset selector state from URL

[weltenwort]

📓 Summary

The dataset selector creates ad-hoc dataviews with random uuids for the selected dataset. Since Discover only persists the dataview id in the URL but not the content, reloading or sharing the page fails since Discover can't reconstruct the dataview. Similarly, the dataset selector can't reconstruct its selection state. To fix that we want to encode the selection state in the dataview id and reconstruct the dataview from it.

• 🛑 blocked by: [Logs+] Implement Logs Dataset selector #159907
• 🛑 blocked by: [Log Explorer] Add "all" entry to dataset selector #160146

✔️ Acceptance criteria

• Should restore the selection to "All logs" when loading the Discover log-explorer profile without a dataview ID in the URL.
• When reloading the Discover log-explorer profile with a dataview ID in the URL...
  • the Dataset selector customization should parse the encoded dataview ID and extract the selection state information.
  • should intercept the dataview resolution step to create an ad-hoc dataview from the parsed state, storing the new dataview into the adHoc views list in the stateContainer.
  • should restore the dataset selection and any other relevant details associated with the dataview, verifying the internal Discover logic correctly resolves the ad-hoc dataview.
  • should initialize the Dataser selector component with the decoded selection state using the associated mode.
• When the dataset selector has a new dataset(s) selection...
  • should store the selection in the DatasetSelector state machine based on the current mode (single, multi, all).
  • should compress/encode the selection data structure into a unique string (the shortest as possible), and use it as the new ad-hoc dataview to create.
  • should store the newly created dataview id in a URL query parameter.
• When there is a failure in parsing the dataview id...
  • should notify the user with a notification.
  • should fall back to the "All logs" selection and store the selection in the URL query parameter.

🎨 Mock-ups

💡 Implementation hints

• The Discover plugin registers the customizations during the start lifecycle hook execution, but it mounts the customized components later when necessary.
  To correctly create and restore the ad-hoc data view, this step needs to be done when creating the log explorer profile customization, during the plugin initialization.
• The different state modes data structures could be something like this:

// Single selection
{
  selectionType: 'single',
  selection: {
    name: 'elasticsearch',
    dataset: {
      title: 'gc',
      name: 'logs-elasticsearch.gc-*'
    }
  }
}

// Many datasets
{
  selectionType: 'multi',
  selection: [
    {
      name: 'uncategorized',
      datasets: []
    },
    {
      name: 'elastic_agent',
      datasets: []
    },
    {
      name: 'elasticsearch',
      datasets: [
        {
          title: 'gc',
          name: 'logs-elasticsearch.gc-*'
        },
      ]
    },
    {
      name: 'system',
      datasets: []
    }
  ]
}

// All datasets
{
  selectionType: 'all'
}

Open questions

• What should be the human-readable name for the synthesized ad-hoc dataview in case of multiple datasets?
  • <count> datasets ?
  • Same as the concatenated index?

[elasticmachine]

Pinging @elastic/infra-monitoring-ui (Team:Infra Monitoring UI)

[weltenwort]

@tonyghiani, thanks for filling out the ACs.

replace the URL index query parameter with the newly create ad-hoc dataview id.

If we successfully parse and restore the dataview, we don't need to change the index param, because it already contains the correct id, doesn't it?

[tonyghiani]

@tonyghiani, thanks for filling out the ACs.

replace the URL index query parameter with the newly create ad-hoc dataview id.

If we successfully parse and restore the dataview, we don't need to change the index param, because it already contains the correct id, doesn't it?

Correct, we have two possible cases:

• Read the id ➡️ Valid selection state ➡️ Create dataview ➡️ Discover restore from the index params (no URL replace)
• Read the id ➡️ Invalid selection state or missing ➡️ Create dataview from default (all) ➡️ Store the new index in the URL state ➡️ Discover restore from the index param