New feature to make links environment-aware

[robert-bogos]

Description

To enhance the testing experience in the stage environment, we’ve implemented a feature that automatically converts production URLs, on Milo pages, to their stage counterparts.

Usage

To activate this feature, Milo consumers need to add a stageDomainsMap JSON to the config they set in their page loading script.

The stageDomainsMap JSON will basically tell Milo what set of conversions to do for a specific domain, and can be formatted as follows:

const stageDomainsMap = {
  'www.stage.adobe.com': {
    'www.adobe.com': 'origin',
    'helpx.adobe.com': 'helpx.stage.adobe.com',
  },
  '--bacom--adobecom.hlx.live': {
    'business.adobe.com': 'origin',
    'news.adobe.com': 'main--news--adobecom.hlx.live',
  },
  '--blog--adobecom.hlx.page': {
    'blog.adobe.com': 'origin',
    'business.adobe.com': 'main--bacom--adobecom.hlx.page',
  },
  '.business-graybox.adobe.com': { 'business.adobe.com': 'origin' },
  '^https://.*--milo--.*.hlx.page': {
    '^https://www.adobe.com/acrobat': 'https://main--dc--adobecom.hlx.page',
    '^https://business.adobe.com(?!/blog)': 'https://business.stage.adobe.com',
    '^https://business.adobe.com/blog': 'https://main--bacom-blog--adobecom.hlx.page',
    '^https://www.adobe.com': 'origin',
  },
};

Guidelines for configuring stageDomainsMap:

1. Define targeted stage domains as keys:

• Each key in the stageDomainsMap represents a stage domain or a pattern (plain string or regex) for which the rules will apply.
  From the example above, these would be 'www.stage.adobe.com', '--bacom--adobecom.hlx.live', '--blog--adobecom.hlx.page', '.business-graybox.adobe.com'., and '^https://.--milo--..hlx.page'.

2. Define the mappings as values:

• For each stage domain key, provide a JSON that maps production domains (or regex patterns) to their stage domain counterpart.
• Use the keyword 'origin' to indicate that the replacement should be calculated dynamically based on the current URL context. (useful for branch-based URLs)

Example:

An example of integrating this can be found in here.

[sukamat]

@robert-bogos Just to understand, for the below rule, do the links on the page that have .business-graybox.adobe.com get updated to business.adobe.com ? Or all relative links on a page loaded on .business-graybox.adobe.com endpoint change to business.adobe.com domain?

'.business-graybox.adobe.com': { 'business.adobe.com': 'origin' },

[robert-bogos]

Hi @sukamat !

The '.business-graybox.adobe.com': { 'business.adobe.com': 'origin' }, rule translates to:
On pages that load from a '.business-graybox.adobe.com' pattern domain, the links that point to 'business.adobe.com' will be converted to point to the origin of the page, in this case '.business-graybox.adobe.com'.

So if you are on 'something.business-graybox.adobe.com' and have a link that sends to 'business.adobe.com/abc', it will be converted to 'something.business-graybox.adobe.com/abc'

[sukamat]

Got it, thank you!

[sanrai]

Hi could we possibly unify this with what we have already w/ Milo + CaaS link transformation?

For consumers they update a config using regexes as followed.

      const config = {
       ...
       caasLinkTransformer: {
            enabled: true,
            hostnameTransforms: [
                {
                    from: '(https?:\\/\\/)business\\.adobe\\.com((?!\\/content\\/dam).*)',
                    to: '$1business.stage.adobe.com$2',
                },
                {
                    from: '(https?:\\/\\/)(www\\.adobe\\.com)(\\/max.*)',
                    to: '$1www.stage.adobe.com$3',
                },
            ],
        },
    }

Perhaps we could change this fromcaasLinkTransformer to just linkTransformer for both and share it across Milo.

But we use regexes as the business logic cases for rewriting we have is much more complex than having a config manually maintain a flat list of key/value pairs that you have.

You may want to change your standard to regexes as well as I would imagine business has much more complex cases that won't be accounted for with your above format.

Without regex support, we on CaaS won't be able to re-use your config.

[robert-bogos]

Hi @sanrai ! Thanks for the insight. I will consider regex when working on this enhancement.

[robert-bogos]

Hi @sanrai ! This feature got enhanced and supports regex now.