Remove the override releated links from service pages

[andybroomfield]

Fix #72

What does this change?

This is a holdover from the old BHCC site, but the functionality for automated links was never implemented in Localgov Drupal.

This will remove this field for new sites, and will always render the related links if they are present regardless.

How to test

Do a fresh install, create a service page.
There should no longer be a replace automatically generated related links.
When adding a related link, this will now show on a service page all the time.
Before, if the above was not checked, then related links would not display, since the auto generation function was never implemented in LGD.

How can we measure success?

Related links now work as an editor would expect.

Have we considered potential risks?

Some councils may be using this 'feature' to hide related links and not show them, we should check that.

Images

Accessibility

n/a

[andybroomfield]

@localgovdrupal/maintainers Does this need an update to remove it, or are we happy others removing it themselves? Councils might already have done?

[finnlewis]

@willguv is adding this whole topics / related links to the content group / review functionality list.

In the mean time, @ekes suggests we refactor this to just do the minimum to hide this from new installs:

1. hide the checkbox on the node form
2. default new installs to have the default to display the links
3. remove commented or redundant code
4. but keep the block functionality just in case people are using it.

[ekes]

@andybroomfield Let me just double-check a bit of logic here:

If we leave this method in:

localgov_services/modules/localgov_services_page/src/Plugin/Block/ServicesRelatedLinksBlock.php

Line 123 in 4986458

if ($this->node->hasField('localgov_override_related_links') && !$this->node->get('localgov_override_related_links')->isEmpty()) {

sites that have got the field will continue to return either the links (TRUE) or an empty array (FALSE).

Maybe we rename it getShouldOverrideLinks() and comment it as legacy to be removed.

We then also change the default return value to TRUE, and remove the field for new installs. They will get the desired default behaviour of showing the links if there are any.

Then the line

localgov_services/modules/localgov_services_page/src/Plugin/Block/ServicesRelatedLinksBlock.php

Line 29 in 4986458

$links = $this->getShouldUseManual() ? $this->buildManual() : $this->buildAutomated();

can be changed for something like

    $links = $this->getShouldOverrideLinks() ? $this->getLinks() : [];

The rest of your patch remains, remove the field for new installs, remove the redundant commented out code.

[ekes]

@andybroomfield sommat like that 50567a8

[andybroomfield]

I think that should work @ekes, though for completeness do we need to add the methods getShouldUseManual buildManual and buildAutomated in case someone has extended the block? Marking them as deprecated. Or do we think its fine (as said, I think this feature was never really implemented.

[ekes]

@andybroomfield

for completeness do we need to add the methods getShouldUseManual buildManual and buildAutomated in case someone has extended the block?

They were private so that's easy, no need to keep BC. Although I'd be inclined to remove them anyway as you say they didn't work.

[finnlewis]

I'm testing this now.

[finnlewis]

Tested and happy.

Confirmed that

1. on an existing install, the behaviour is unaffected. Existing related links continue to work with the (odd) toggle switch.
2. On a fresh install, the toggle is gone and the links display if they are present and not if they are not.

Added a related issue #297 where if no link text, the link displays blank, but we can deal with that separately.

[willguv]

Thanks for checking this @finnlewis

Also thanks to @andybroomfield and @ekes for spotting this and fixing

[Adnan-cds]

• Noticed no difference to our existing site. As Finn has said above, "Existing related links continue to work"
• Once I uncheck the Replace automatically generated links checkbox on an existing page, the related links disappear from the sidebar of the page. This happens with or without this change. So I guess this behaviour has remained unchanged as well.

[finnlewis]

Note: add some release notes to explain how the original behaviour was broken and how this removes that.