Use Public Suffix for homarr_domain

[ColinHebert]

Category

Feature

Overview

Changes the homarr_domain detection to take the complete domain rather than the top domain only.

When the domain of homarr is homarr.myMachine.domain.tld, myMachine.domain.tld is detected as publicSuffix

This makes use of allowPrivateDomains to detect the suffix as documented on https://www.npmjs.com/package/tldts

tldts.parse('https://spark-public.s3.amazonaws.com/dataanalysis/loansData.csv');
// { domain: 'amazonaws.com',
//   domainWithoutSuffix: 'amazonaws',
//   hostname: 'spark-public.s3.amazonaws.com',
//   isIcann: true,
//   isIp: false,
//   isPrivate: false,
//   publicSuffix: 'com',
//   subdomain: 'spark-public.s3' }

tldts.parse(
  'https://spark-public.s3.amazonaws.com/dataanalysis/loansData.csv',
  { allowPrivateDomains: true },
);
// { domain: 'spark-public.s3.amazonaws.com',
//   domainWithoutSuffix: 'spark-public',
//   hostname: 'spark-public.s3.amazonaws.com',
//   isIcann: false,
//   isIp: false,
//   isPrivate: true,
//   publicSuffix: 's3.amazonaws.com',
//   subdomain: '' }

Issue Number

Related issue: #2146

[github-actions]

Hi 👋. Thank you for making your first contribution to Homarr. Please ensure that you've completed all the points in the TODO checklist. We'll review your changes shortly.

[Meierschlumpf]

I would suggest to add a new variable, otherwise this is a breaking change

[SeDemal]

You're also have to add the var in the informational pop up where this element can be used (Mostly thinking of the apps setting's External address entry).

I also would try to find a different name for the var as "domain" is the really non-descriptive way of addressing the address, and is normally followed or prefaced with a descriptor to better isolate the part, and alone would be common for the TLD - SLD combination only. (In this case, it was also based on tldts very definition of it listed further down from your example)

For your var I would personally call it "Parent-Domain" or "Parent" for the short version. So "homarr_parent" feels more fitting here.

My suggestion:

        return appType.behaviour.externalUrl
          .replace('[homarr_base]', `${window.location.protocol}//${window.location.hostname}`)
          .replace('[homarr_hostname]', tldts.getHostname(window.location.href) ?? '')
          .replace('[homarr_domain]', tldts.getDomain(window.location.href) ?? '')
          .replace('{homarr_parent]', tldts.getPublicSuffix(window.location.href, { allowPrivateDomains: true }) ?? '')
          .replace('[homarr_protocol]', window.location.protocol.replace(':', ''))
          .replace('[homarr_port]', window.location.port);

remove parsedUrl and change the bracket under from that to "window.location".

Edits: I'm a bit blind don't mind me.

[JoJenH]

But then it would seem like an infinite number of new variables would need to be defined for multiple domains.
It is recommended to use a list-like approach to get the elements. Using index for different level domain name, like homarr_domain[4] for homarr.myMachine.domain.tld, homarr_domain[2] to get the domain.tld. Or some other way.
Also, we want to add a homarr_port variable to get the port, which is important in cases where different hostnames or URIs are used to differentiate services on the same port(different ports for internal and external networks).

[SeDemal]

@ColinHebert Are you still working on this or would you rather we take care of it?

[SeDemal]

Closing the PR since it was voted in this PR #2189 that we won't be pursuing URI's with variable and they will be removed altogether.
I am guessing they might stay as is in v0.15 but won't in V1.0.