DOP-4457: Strip away locale code from slugs before localizing them #1041
Conversation
| const smartlingNoRewriteClass = 'sl_norewrite'; | ||
| const smartlingNoRewriteClass = 'sl_opaque'; |
There was a problem hiding this comment.
Curious: what Smartling behavior changes with this?
There was a problem hiding this comment.
Great question! This was the solution provided to me by Arnaud (from Smartling) to prevent the hreflang link from being overwritten. For some reason the sl_norewrite class wasn't doing it so he wanted me to try it the opaque class. Here's a link to the docs, although I'm not sure how different they'd be for this use case.
I should've added this to the description, but I deployed one versions of the Node docs, and you can see in Simplified Chinese docs that the hreflang link for x-default is incorrect (it should be the English URL), most likely because it's being overwritten.
| const code = localeCode && validateCode(localeCode) ? localeCode : getCurrLocale(); | ||
| const languagePrefix = code === 'en-us' ? '' : `${code}/`; | ||
| let newPath = languagePrefix + pathname; | ||
| let newPath = languagePrefix + unlocalizedPath; | ||
| if (pathname.startsWith('/')) { |
There was a problem hiding this comment.
Should this conditional use the unlocalizedPath or does it matter because it looks like you've tried to replicate the leading character anyway?
There was a problem hiding this comment.
I believe it should be the pathname to ensure the "original" slug is the source of truth. But I don't think it matters? 🤔
|
|
||
| // Replace from the original slug to maintain original form | ||
| const res = validateCode(firstPathSlug) ? normalizePath(slug.replace(firstPathSlug, '')) : slug; | ||
| if (res.startsWith('/') && !slug.startsWith('/')) { |
There was a problem hiding this comment.
[not blocking] seems like we are doing a lot of slash handling. would prefer if we could handle it in the exported function and helpers can just do simple string manipulations on input. also not seeing where this is called so may not have to export
There was a problem hiding this comment.
Agreed that there's a lot of slash handling... I've made the function local, but as discussed offline, I'm afraid of how Smartling is handling these slugs, so I want to ensure that the output string doesn't accidentally manipulate the input. Happy to revisit this logic during a less stressful situation to help clean up
Stories/Links:
DOP-4457
Current Behavior:
Server prod
Staging Links:
Server staging - mostly to spot check that things (the version dropdown, hreflang links, and footer language selector) aren't broken. Unfortunately, this will need to be tested in production due to Smartling's production-only logic.
Notes:
The situation is that Smartling overrides some frontend logic on their end to allow the frontend to properly link to other docs pages within the same locale. We purposely have logic that localizes URLs ourselves, so that we can link to them (for example: the language selector at the footer). This works fine on the English docs, but on the translated docs, Smartling's overridden localized slugs cause our localization of the same slug to result in two locale codes in the URL. A solution would be to remove the locale code from the beginning of a slug (if it exists), before localizing the slug.
README updates