adobe.com
Replies: 1 comment 4 replies
-
Why/where do you need the map in the first place? Could you elaborate a bit further on the use-case you are trying to solve? |
Beta Was this translation helpful? Give feedback.
-
ProblemA milo-based "adobe url" has 4 forms:
Example 1:
Example 2:
Given any form of the url, determine the other three. DiscussionThis problem has presented itself on multiple occasions. Our akamai configuration is the source of truth for these mappings, I belive the aem sidekick does something similar, but I am not aware how this works. Right now, I use regex to parse two different types of urls: *.adobe.com and hlx.live. export const CLOUD_BY_FOLDER: Record<string, string> = {
acrobat: 'dc',
creativecloud: 'cc',
express: 'express',
default: 'homepage',
// etc.
};This is not ideal, because we need to create and maintain these maps. Furthermore, when developing a cloud locally, we do not have the appropriate fqdn available to us. Using X-Adobe-ContentIf we can fetch the url, then we can use the /**
* Given *.adobe.com url return name of milo repo it pertains to.
* Returns null if it is not a milo repo.
*/
async function getMiloRepoByUrl(url) {
const response = await fetch(url, { method: 'HEAD' });
const header = response.headers.get('x-adobe-content')?.toLowerCase();
if (!header?.match(/milo|helix/)) return null;
const repo = header.replace(/milo|helix/, '').trim(); // this may not always work
return repo;
}Examples: The problem with this is that it requires a request. Creating the mappings programmaticallyWe can run a query to find all our Franklin repos: /**
* Find all of adobecom's Milo (Franklin) repos and return their names.
*/
async function getAllMiloRepos() {
const response = await fetch('https://api.github.com/users/adobecom/repos?per_page=100'); // FIXME: pagination
const repos = await response.json();
const miloRepos = [];
for (const repo of repos) {
const url = `https://raw.githubusercontent.com/${repo.full_name}/${repo.default_branch}/helix-version.txt`;
const r = await fetch(url);
if (!r.ok) continue;
const version = await r.text();
if (version.match(/v[\d]+/)) miloRepos.push(repo.name);
}
return miloRepos;
}Unfortunately this won't tell us anything about url mapping, |
Beta Was this translation helpful? Give feedback.
-
|
@hparra and @mokimo interestingly, we just had a use case with the dynamic nav feature coming from Bacom stakeholders that also required us to know which repo was running milo code. Since the dynamic nav saves a gnav source in session storage, Narcis brought up the concern that a user may navigate to a different consumer site and the bacom nav would follow them. In order to address this I added a In my mind, really that Adding an identifying field in the config seems like a good way to save the headache of some of the methods @hparra mentions above. I do think we'd have to be vigilant of anti-patterns sneaking into blocks, i.e. checking the consuming repo conditionally for some consumer specific logic to run. But overall, it could help in very specific situations. |
Beta Was this translation helpful? Give feedback.
-
|
@JasonHowellSlavin milo pr is simple but we'd have to add We segment by cloud for our data (sharepoint), our repos, our origins (*.hlx), and our content providers (cp) in Akamai. It would be nice if runtime code knew which cloud they pertain to. |
Beta Was this translation helpful? Give feedback.
-
|
Makes sense. I'd assume we could probably open PRs against other consumers once a decision is made on what to call the property in the config and if it is something we want to do. |
Beta Was this translation helpful? Give feedback.
-
I have a feature that needs to understand which repo Milo is running from.
I was recommended to use
imsClientIdsince each repo has a unique one:Should we instead require a
repoorcloudfield in milo config? This way we avoid a map like above that needs to be updated with each new repo. Example:It is possible to determine repo from url in many cases, but there is ambiguity sometimes, especially when running from localhost.
Beta Was this translation helpful? Give feedback.
All reactions