Improve link kirbytag behavior when uuid point to non-existing page

[afbora]

This PR …

Fixes

• kirbytext() fails, if text contains a link to a non-existing page kirbytext() fails, if text contains a link to a non-existing page #6083

Breaking changes

None

Ready?

• Unit tests for fixed bug/feature
• In-code documentation (wherever needed)
• Tests and checks all pass

For review team

• Add changes to release notes draft in Notion
• Add to website docs release checklist (if needed)

[lukasbestle]

TBH I'm not sure about this. It could be pretty unexpected to get a link to the homepage instead of the intended deeplink.

An alternative could be to return an empty string instead (meaning the KirbyTag would produce an empty output, i.e. no link at all).

However both solutions have in common that they are very hard to debug. The exception on the other hand breaks the whole page. Difficult...

[afbora]

What about link to error page instead homepage?

[lukasbestle]

I like that. Then it's just a "broken link" as it would be with a hardcoded URL or path.

[distantnative]

I think other CMS in similar cases would output the text without any link in this case.

[afbora]

Good comments. I would merge ideas :)

• Link to the error page or throw exception if debug enabled
• Remove link from text if debug disabled

[afbora]

when text attr set

Will removed link. I got this case, OK.

Input

Lorem ipsum (link: page://not-exist text: Click Here) dolor sit amet

Output

Lorem ipsum Click Here dolor sit amet

when no text attr set

What would expected when no link text set?

Input

Lorem ipsum (link: page://not-exist) dolor sit amet

Output

Remove whole kirbytag like that?

Lorem ipsum dolor sit amet

[distantnative]

Given the amount of discussion about this, I think this should not go into a patch release.

On the discussion points

• What happens with a permalink when the UUID does not exist? Is it an exception or redirect to error? I would say the kirbytag should behave the same when debug is active
• With debug false, I think just rendering the text, not the link is ok.
• When no text is set, url should be rendered as pure text.

[afbora]

When no text is set, url should be rendered as pure text.

@distantnative So what would happen when no text is set, uuid is not exists and debug active?

[distantnative]

@afbora depends what our answer is to my first bullet point. Either exception or permalink as pure text.

[GiantCrocodile]

Another thing to consider: The expected behavior might depend on the importancy of the link. If it's a link to a legal document or important document, it should always fail to prevent failing legal or other processes afterwards. So maybe it might be important to have a way that the editor/admin can define the expected behavior by the importancy of the link.

[lukasbestle]

Considering everything, I think the following would be the best compromise to fulfill the most requirements:

• If debug mode is enabled, throw an exception to allow to pinpoint the source of the error. IMO that's what debug mode is for.
• Otherwise, render a link to the error page. It keeps the intended content structure, avoids printing the UUID to visitors who won't know what it means and also makes it visible to visitors that there should be a link but it isn't working (thus prompting them to contact the editors to correct the issue on the page).

[bastianallgeier]

I would change the wording for the exception (see suggestion). But I'm happy with the rest. @lukasbestle @distantnative do you want to have a last look at it? I would also move it to 4.1 though.

[lukasbestle]

Awesome! 👍
I agree with Bastian on the suggested change, apart from that it's great.