Fixes #34320 - Hide Katello tabs & cards on new host detail page when host is unregistered

[jeremylenz]

What are the changes introduced in this pull request?

We need to allow Katello to hide its tabs and cards from the new host detail page.

• Adds new helper functions hostIsNotRegistered and hostIsRegistered

• Check if host is registered and if not, hide Errata and Content View overview cards

• Also hide Content, Traces, and Repository sets tabs for non-registered hosts. The way it works is as follows:

  • Adds a new slot metadata attribute, hideTab, that is sent to Foreman. This allows us to pass a function to Foreman which Foreman will then call with the host details when setting up the page.
  • If Refs #34442 - Allow plugins to hide tabs on new host detail page theforeman/foreman#9104 is applied, and hideTab returns true for that tab, Foreman will hide the tab from the host details page.
  • I'm using hostIsNotRegistered as the hideTab function here, but other functions could be used for other slots in the future.

• Also, recalculates errata counts on the host when unregistering to ensure they're properly cleared out.

Considerations taken when implementing this change?

Hiding cards I can do from Katello, but I found that changing Foreman code is the only clean way to hide an entire tab.
I found that passing the hideTab function to Foreman is a good way to keep Katello code in Katello and Foreman code in Foreman. This way Katello can be the one that cares about why we're hiding the tab, and Foreman doesn't have to touch such ugliness as subscription facets 😱.

What are the testing steps for this pull request?

• Apply this Katello change
• Register a host and get some installable errata on it
• Find its content_facet in Rails console
• Unregister the host
• View the content facet's attributes and verify that the errata counts are cleared out:

installable_security_errata_count: 0,
installable_enhancement_errata_count: 0,
installable_bugfix_errata_count: 0,

• Apply the Foreman change: Refs #34442 - Allow plugins to hide tabs on new host detail page theforeman/foreman#9104

• Reload the host detail page and verify:

  • Installable Errata card does not display
  • Content View overview card does not display
  • Content tab does not display
  • Traces tab does not display
  • Repository sets tab does not display

• Reregister the host and verify that

  • all tabs are back
  • errata counts are back to what they were before

[theforeman-bot]

Issues: #34320

[amirfefer]

Thanks, @jeremylenz! 👍

Tabs are registered with slot&fill which uses a registry for registering new fills, how about leveraging this runtime mechanism for unregistering a tab (fill)?

We use this helper to register a core's tab in runtime -
https://github.com/theforeman/foreman/blob/develop/webpack/assets/javascripts/react_app/components/HostDetails/Tabs/index.js#L7

We can leverage the slot's registry and create a helper for unregistering a specific tab directly from the registry.

[jeremylenz]

@amirfefer I did try unregistering, but ran into some problems which I can't remember now. I think it was something to do with the tab unregistering itself. I guess I will look into it again.. 🤔

[jeremylenz]

In TracesTab I added

  if (hostIsNotRegistered({ hostDetails })) {
    SlotsRegistry.remove('host-details-page-tabs', 'Traces');
    return null;
  }

But this didn't work because the tab itself was still there; it just didn't render any content inside it. Also, after a few seconds I got this console error

connectAdvanced.js:296 Uncaught TypeError: Cannot read properties of undefined (reading 'component')
    at selectFillsComponents (SlotSelectors.js:34:26)

and this screen:

[jeremylenz]

I also tried to use the Redux action

if (hostIsNotRegistered({ hostDetails })) {
    // SlotsRegistry.remove('host-details-page-tabs', 'Traces');
    dispatch(unregisterFillComponent('host-details-page-tabs', 'Traces'));
    return null;
  }

and I got

Warning: Cannot update a component (`ConnectFunction`) while rendering a different component (`TracesTab`). To locate the bad setState() call inside `TracesTab`, follow the stack trace as described in https://fb.me/setstate-in-render
    in TracesTab
    in Slot (created by ConnectFunction)
    in ConnectFunction (created by Context.Consumer)
    in Route (created by TabRouter)
    in Switch (created by TabRouter)
    in Router (created by HashRouter)
    in HashRouter (created by TabRouter)
    in TabRouter (created by HostDetails)
    in section (created by PageSection)
    in PageSection (created by HostDetails)
    in HostDetails (created by Context.Consumer)
    in Route (created by AppSwitcher)
    in Switch (created by ForemanSwitcher)
    in ForemanSwitcher (created by AppSwitcher)
    in AppSwitcher (created by ReactApp)
    in ErrorBoundary (created by ReactApp)
    in div (created by LayoutContainer)
    in LayoutContainer (created by Layout)
    in Layout (created by ConnectedLayout)
    in ConnectedLayout (created by ReactApp)
    in Router (created by ConnectedRouter)
    in ConnectedRouter (created by Context.Consumer)
    in ConnectedRouterWithContext (created by ConnectFunction)
    in ConnectFunction (created by ReactApp)
    in ApolloProvider (created by ReactApp)
    in div (created by ReactApp)
    in ReactApp (created by I18nProviderWrapper(ReactApp))
    in IntlProvider (created by I18nProviderWrapper(ReactApp))
    in I18nProviderWrapper(ReactApp) (created by StoreProvider(I18nProviderWrapper(ReactApp)))
    in Provider (created by StoreProvider(I18nProviderWrapper(ReactApp)))
    in StoreProvider(I18nProviderWrapper(ReactApp)) (created by DataProvider(StoreProvider(I18nProviderWrapper(ReactApp))))
    in DataProvider(StoreProvider(I18nProviderWrapper(ReactApp)))

[jeremylenz]

I also tried to unregister the tab from ErrataOverviewCard:

Warning: Cannot update a component (`ConnectFunction`) while rendering a different component (`TracesTab`). To locate the bad setState() call inside `TracesTab`, follow the stack trace as described in https://fb.me/setstate-in-render
    in TracesTab
    in Slot (created by ConnectFunction)
    in ConnectFunction (created by Context.Consumer)
    in Route (created by TabRouter)
    in Switch (created by TabRouter)
    in Router (created by HashRouter)
    in HashRouter (created by TabRouter)
    in TabRouter (created by HostDetails)
    in section (created by PageSection)
    in PageSection (created by HostDetails)
    in HostDetails (created by Context.Consumer)
    in Route (created by AppSwitcher)
    in Switch (created by ForemanSwitcher)
    in ForemanSwitcher (created by AppSwitcher)
    in AppSwitcher (created by ReactApp)
    in ErrorBoundary (created by ReactApp)
    in div (created by LayoutContainer)
    in LayoutContainer (created by Layout)
    in Layout (created by ConnectedLayout)
    in ConnectedLayout (created by ReactApp)
    in Router (created by ConnectedRouter)
    in ConnectedRouter (created by Context.Consumer)
    in ConnectedRouterWithContext (created by ConnectFunction)
    in ConnectFunction (created by ReactApp)
    in ApolloProvider (created by ReactApp)
    in div (created by ReactApp)
    in ReactApp (created by I18nProviderWrapper(ReactApp))
    in IntlProvider (created by I18nProviderWrapper(ReactApp))
    in I18nProviderWrapper(ReactApp) (created by StoreProvider(I18nProviderWrapper(ReactApp)))
    in Provider (created by StoreProvider(I18nProviderWrapper(ReactApp)))
    in StoreProvider(I18nProviderWrapper(ReactApp)) (created by DataProvider(StoreProvider(I18nProviderWrapper(ReactApp))))
    in DataProvider(StoreProvider(I18nProviderWrapper(ReactApp)))

I think the problem is that there's simply no good place to put this code in Katello. That's why I think my solution of passing the function to Foreman is pretty clean and the best way to go.

@amirfefer thoughts?

[jeremylenz]

rebased

[parthaa]

Works well for me only oddity I saw was applicable_rpm_count: 1 in the content facet. Hiding stuff worked well.

#<Katello::Host::ContentFacet:0x00000000182b5850
 id: 1,
 host_id: 1,
 uuid: nil,
 content_view_id: 1,
 lifecycle_environment_id: 1,
 kickstart_repository_id: nil,
 content_source_id: nil,
 installable_security_errata_count: 0,
 installable_enhancement_errata_count: 0,
 installable_bugfix_errata_count: 0,
 applicable_rpm_count: 1,
 upgradable_rpm_count: 0,
 applicable_module_stream_count: 0,
 upgradable_module_stream_count: 0,
 applicable_deb_count: 0,
 upgradable_deb_count: 0>

[parthaa]

I think the problem is that there's simply no good place to put this code in Katello. That's why I think my solution of passing the function to Foreman is pretty clean and the best way to go.

Unregistering slot/fills seems complicated, require deeper changes in foreman and has potential for breaking other things. You approach seems much less invasive, cleaner and easier to maintain. APJ :)

[parthaa]

Works well for me. APJ

[jeremylenz]

[test katello]

[jeremylenz]

rebased