Merge 279130b into dab722e

yext · May 24, 2021 · 5e32278 · 5e32278
2 parents dab722e + 279130b
commit 5e32278
Show file tree

Hide file tree

Showing 8 changed files with 112 additions and 46 deletions.
diff --git a/hbshelpers/sdkAssetUrl.js b/hbshelpers/sdkAssetUrl.js
@@ -0,0 +1,35 @@
+const RELEASE_BRANCH_REGEX = /^release\/v[0-9.]+$/;
+const HOTFIX_BRANCH_REGEX = /^hotfix\/v[0-9.]+$/;
+const SEM_VER_REGEX = /^[1-9]+$|^[1-9]+\.[0-9]+$|^[1-9]+\.[0-9]+\.[0-9]+$/;
+
+/**
+ * Given a branch (or release) of the SDK and a locale, this helper provides the correct
+ * URL in the CDN for the asset.
+ * 
+ * @param {string} branch The branch (or release) of the SDK.
+ * @param {string} locale The locale to use.
+ * @param {string} assetName The name of the desired asset.
+ * @returns {string} The CDN URL of the localized asset.
+ */
+module.exports = function sdkAssetUrl(branch, locale, assetName) {
+  const isReleasedBranch = SEM_VER_REGEX.test(branch);
+
+  let parsedBranch;
+  if (isReleasedBranch) {
+    parsedBranch = `v${branch}`;
+  } else {
+    parsedBranch = `dev/${branch.replace(/\//g, '-')}`;
+  }
+
+  const isPreReleaseBranch = 
+    RELEASE_BRANCH_REGEX.test(branch) || HOTFIX_BRANCH_REGEX.test(branch);
+  const isLocalizationSupported = 
+    (isReleasedBranch || isPreReleaseBranch) && 
+    !(locale.startsWith('en') || assetName === 'answers.css') ;
+
+  const parsedAssetName = isLocalizationSupported ?
+    `${locale}-${assetName}` :
+    assetName;
+
+  return `https://assets.sitescdn.net/answers/${parsedBranch}/${parsedAssetName}`;
+};
diff --git a/layouts/html.hbs b/layouts/html.hbs
@@ -139,7 +139,7 @@
     {{/babel}}
     </script>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/iframe-resizer/4.2.10/iframeResizer.contentWindow.min.js"></script>
-    <link rel="stylesheet" type="text/css" href="https://assets.sitescdn.net/answers/v{{global_config.sdkVersion}}/answers.css">
+    <link rel="stylesheet" type="text/css" href="{{sdkAssetUrl global_config.sdkVersion 'en' 'answers.css'}}">
     <link rel="stylesheet" type="text/css" href="{{relativePath}}/bundle.css" data-webpack-inline>
   </head>
   <body>

diff --git a/script/core.hbs b/script/core.hbs
@@ -4,7 +4,7 @@
     console.error('ERROR: no sdkVersion specified, please specify an sdkVersion in the global_config.');
   }
 </script>
-<script src="https://assets.sitescdn.net/answers/v{{global_config.sdkVersion}}/{{#if params.sdkLocaleOverride}}{{#unless (eq params.sdkLocaleOverride 'en')}}{{params.sdkLocaleOverride}}-{{/unless}}{{else if global_config.locale}}{{#unless (eq global_config.locale 'en')}}{{global_config.locale}}-{{/unless}}{{/if}}answerstemplates.compiled.min.js" defer></script>
+<script src="{{sdkAssetUrl global_config.sdkVersion (findFirst params.sdkLocaleOverride global_config.locale 'en') 'answerstemplates.compiled.min.js'}}" defer></script>
 <script>
 {{#babel}}
   function initAnswers() {

diff --git a/script/partials/sdk-js-script-tags.hbs b/script/partials/sdk-js-script-tags.hbs
@@ -4,12 +4,12 @@
   @param sdkVersion
 --}}
 <script
-  src="{{> script/partials/sdk-url sdkAsset="answers-modern.min.js" locale=locale sdkVersion=sdkVersion}}"
+  src="{{sdkAssetUrl sdkVersion locale "answers-modern.min.js"}}"
   type="module"
   onload="initAnswers()"
 ></script>
 <script
-  src="{{> script/partials/sdk-url sdkAsset="answers.min.js" locale=locale sdkVersion=sdkVersion}}"
+  src="{{sdkAssetUrl sdkVersion locale "answers.min.js"}}"
   nomodule
   onload="initAnswers()"
   defer

diff --git a/script/partials/sdk-url.hbs b/script/partials/sdk-url.hbs
diff --git a/tests/hbshelpers/sdkAssetUrl.js b/tests/hbshelpers/sdkAssetUrl.js
@@ -0,0 +1,73 @@
+import sdkAssetUrl from '../../hbshelpers/sdkAssetUrl';
+
+describe('URLs are computed properly for released versions', () => {
+  it('works correctly when locale is "en"', () => {
+    const expectedJSUrl = 'https://assets.sitescdn.net/answers/v1.8/answers.min.js';
+    const expectedCSSUrl = 'https://assets.sitescdn.net/answers/v1.8/answers.css'
+
+    expect(sdkAssetUrl('1.8', 'en', 'answers.min.js')).toEqual(expectedJSUrl);
+    expect(sdkAssetUrl('1.8', 'en', 'answers.css')).toEqual(expectedCSSUrl);
+  });
+
+  it('works correctly when locale is not "en"', () => {
+    const expectedJSUrl = 'https://assets.sitescdn.net/answers/v1.8/fr-answers.min.js';
+    const expectedCSSUrl = 'https://assets.sitescdn.net/answers/v1.8/answers.css'
+
+    expect(sdkAssetUrl('1.8', 'fr', 'answers.min.js')).toEqual(expectedJSUrl);
+    expect(sdkAssetUrl('1.8', 'fr', 'answers.css')).toEqual(expectedCSSUrl);
+  });
+});
+
+describe('URLs are computed properly for release branches', () => {
+  it('works correctly when locale is "en"', () => {
+    const expectedJSUrl = 'https://assets.sitescdn.net/answers/dev/release-v1.8/answers.min.js';
+    const expectedCSSUrl = 'https://assets.sitescdn.net/answers/dev/release-v1.8/answers.css'
+
+    expect(sdkAssetUrl('release/v1.8', 'en', 'answers.min.js')).toEqual(expectedJSUrl);
+    expect(sdkAssetUrl('release/v1.8', 'en', 'answers.css')).toEqual(expectedCSSUrl);
+  });
+
+  it('works correctly when locale is not "en"', () => {
+    const expectedJSUrl = 'https://assets.sitescdn.net/answers/dev/release-v1.8/fr-answers.min.js';
+    const expectedCSSUrl = 'https://assets.sitescdn.net/answers/dev/release-v1.8/answers.css'
+
+    expect(sdkAssetUrl('release/v1.8', 'fr', 'answers.min.js')).toEqual(expectedJSUrl);
+    expect(sdkAssetUrl('release/v1.8', 'fr', 'answers.css')).toEqual(expectedCSSUrl);
+  });
+});
+
+describe('URLs are computed properly for hotfix branches', () => {
+  it('works correctly when locale is "en"', () => {
+    const expectedJSUrl = 'https://assets.sitescdn.net/answers/dev/hotfix-v1.8.1/answers.min.js';
+    const expectedCSSUrl = 'https://assets.sitescdn.net/answers/dev/hotfix-v1.8.1/answers.css'
+
+    expect(sdkAssetUrl('hotfix/v1.8.1', 'en', 'answers.min.js')).toEqual(expectedJSUrl);
+    expect(sdkAssetUrl('hotfix/v1.8.1', 'en', 'answers.css')).toEqual(expectedCSSUrl);
+  });
+
+  it('works correctly when locale is not "en"', () => {
+    const expectedJSUrl = 'https://assets.sitescdn.net/answers/dev/hotfix-v1.8.1/fr-answers.min.js';
+    const expectedCSSUrl = 'https://assets.sitescdn.net/answers/dev/hotfix-v1.8.1/answers.css'
+
+    expect(sdkAssetUrl('hotfix/v1.8.1', 'fr', 'answers.min.js')).toEqual(expectedJSUrl);
+    expect(sdkAssetUrl('hotfix/v1.8.1', 'fr', 'answers.css')).toEqual(expectedCSSUrl);
+  });
+});
+
+describe('URLs are computed properly for all other branches', () => {
+  it('works correctly when locale is "en"', () => {
+    const expectedJSUrl = 'https://assets.sitescdn.net/answers/dev/feature-foo/answers.min.js';
+    const expectedCSSUrl = 'https://assets.sitescdn.net/answers/dev/feature-foo/answers.css'
+
+    expect(sdkAssetUrl('feature/foo', 'en', 'answers.min.js')).toEqual(expectedJSUrl);
+    expect(sdkAssetUrl('feature/foo', 'en', 'answers.css')).toEqual(expectedCSSUrl);
+  });
+
+  it('works correctly when locale is not "en"', () => {
+    const expectedJSUrl = 'https://assets.sitescdn.net/answers/dev/feature-foo/answers.min.js';
+    const expectedCSSUrl = 'https://assets.sitescdn.net/answers/dev/feature-foo/answers.css'
+
+    expect(sdkAssetUrl('feature/foo', 'fr', 'answers.min.js')).toEqual(expectedJSUrl);
+    expect(sdkAssetUrl('feature/foo', 'fr', 'answers.css')).toEqual(expectedCSSUrl);
+  });
+});
diff --git a/tests/script/partials/sdk-js-script-tags.js b/tests/script/partials/sdk-js-script-tags.js
@@ -24,11 +24,6 @@ const jaOutput = `<script
   defer
 ></script>`;
 
-it('creates correct tags when no locale specified', () => {
-  const partialUsage = '{{> script/partials/sdk-js-script-tags sdkVersion=1.8}}'
-  expect(hbs.compile(partialUsage)()).toEqual(defaultOutput);
-});
-
 it('creates correct tags for en', () => {
   const partialUsage = `{{> script/partials/sdk-js-script-tags
     sdkVersion=1.8

diff --git a/tests/script/partials/sdk-url.js b/tests/script/partials/sdk-url.js