Merge pull request #31 from edx/robrap/ARCH-748-fix-i18n-jobs

fix(i18n): fix i18n make targets
Merge pull request #32 from edx/astankiewicz/downgrade-query-string
2019-05-16 13:20:46 -04:00 · 2019-05-16 12:57:21 -04:00 · 2019-05-16 09:44:44 -07:00 · 2019-05-16 12:27:27 -04:00 · 2019-05-10 16:55:50 -04:00 · 2019-05-10 15:49:40 -04:00
9 changed files with 335 additions and 72 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -4,3 +4,5 @@ node_modules
 temp

 .idea/
+
+src/i18n/transifex_input.json
--- a/15
+++ b/15
@@ -1,8 +1,5 @@
-extract_translations: ## no prerequisites so we can control order of operations
-	echo "We have to define this target due to tooling assumptions"
-	echo "Also we have to npm install using this hook b/c there's no other place for it in the current setup"
+requirements:
 	npm install
-	npm run-script i18n_extract

 i18n.extract:
    # Pulling display strings from .jsx files into .json files...
@@ -12,6 +9,12 @@ i18n.concat:
    # Gathering JSON messages into one file...
 	./src/i18n/i18n-concat.js ./temp/src ./src/i18n/transifex_input.json

+
+# The following make targets are required by our tooling scripts found in:
+# - https://github.com/edx/ecommerce-scripts/tree/master/transifex
+
+extract_translations: | requirements i18n.extract i18n.concat
+
 detect_changed_source_translations:
 	git diff --exit-code ./src/i18n/transifex_input.json

@@ -19,7 +22,9 @@ tx_url1 = https://www.transifex.com/api/2/project/edx-platform/resource/frontend
 tx_url2 = https://www.transifex.com/api/2/project/edx-platform/resource/frontend-component-footer/source/

 # push translations to Transifex, doing magic so we can include the translator comments
-push_translations: | i18n.extract
+# Note: extract_translations is a prereq that our translation script calls separately.
+push_translations:
+	tx push -s
 	# Adding translator comments...
 	# Fetching strings from Transifex...
 	./node_modules/reactifex/bash_scripts/get_hashed_strings.sh $(tx_url1)
--- a/package-lock.json
+++ b/package-lock.json
@@ -5896,8 +5896,7 @@
    "decode-uri-component": {
      "version": "0.2.0",
      "resolved": "https://registry.npmjs.org/decode-uri-component/-/decode-uri-component-0.2.0.tgz",
-      "integrity": "sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU=",
-      "dev": true
+      "integrity": "sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU="
    },
    "decompress": {
      "version": "4.2.0",
@@ -12920,6 +12919,16 @@
        "cast-array": "~1.0.0",
        "object-filter": "~1.0.2",
        "query-string": "~2.4.1"
+      },
+      "dependencies": {
+        "query-string": {
+          "version": "2.4.2",
+          "resolved": "https://registry.npmjs.org/query-string/-/query-string-2.4.2.tgz",
+          "integrity": "sha1-fbBmZCCAS6qSrp8miWKFWnYUPfs=",
+          "requires": {
+            "strict-uri-encode": "^1.0.0"
+          }
+        }
      }
    },
    "make-dir": {
@@ -20068,10 +20077,12 @@
      "dev": true
    },
    "query-string": {
-      "version": "2.4.2",
-      "resolved": "https://registry.npmjs.org/query-string/-/query-string-2.4.2.tgz",
-      "integrity": "sha1-fbBmZCCAS6qSrp8miWKFWnYUPfs=",
+      "version": "5.1.1",
+      "resolved": "https://registry.npmjs.org/query-string/-/query-string-5.1.1.tgz",
+      "integrity": "sha512-gjWOsm2SoGlgLEdAGt7a6slVOk9mGiXmPFMqrEhLQ68rhQuBnpfs3+EmlvqKyxnCo9/PPlF+9MtY02S1aFg+Jw==",
      "requires": {
+        "decode-uri-component": "^0.2.0",
+        "object-assign": "^4.1.0",
        "strict-uri-encode": "^1.0.0"
      }
    },
--- a/package.json
+++ b/package.json
@@ -84,6 +84,7 @@
  "dependencies": {
    "@edx/paragon": "^3.8.0",
    "prop-types": "^15.5.10",
+    "query-string": "^5.1.1",
    "react": "^16.4.2",
    "react-dom": "^16.2.0",
    "react-intl": "2.x"
--- a/src/i18n/transifex_input.json
+++ b/src/i18n/transifex_input.json
@@ -1,39 +0,0 @@
-{
-  "footer.site-footer.link.about": "About",
-  "footer.site-footer.link.business": "{siteName} for Business",
-  "footer.site-footer.link.affiliates": "Affiliates",
-  "footer.site-footer.link.open-source": "Open {siteName}",
-  "footer.site-footer.link.careers": "Careers",
-  "footer.site-footer.link.news": "News",
-  "footer.site-footer.link.header.legal": "Legal",
-  "footer.site-footer.link.terms-of-service": "Terms of Service & Honor Code",
-  "footer.site-footer.link.privacy": "Privacy Policy",
-  "footer.site-footer.link.accessibility": "Accessibility Policy",
-  "footer.site-footer.link.trademark": "Trademark Policy",
-  "footer.site-footer.link.sitemap": "Sitemap",
-  "footer.site-footer.link.header.connect": "Connect",
-  "footer.site-footer.link.blog": "Blog",
-  "footer.site-footer.link.contact-us": "Contact Us",
-  "footer.site-footer.link.help-center": "Help Center",
-  "footer.site-footer.link.media-kit": "Media Kit",
-  "footer.site-footer.link.donate": "Donate",
-  "footer.site-footer.copyright-text": "{copyrightSymbol} {startDate}–{endDate} {siteName} Inc.",
-  "footer.site-footer.trademark-text": "EdX, Open edX, and MicroMasters are registered trademarks of edX Inc. | {icpLicense}",
-  "footer.site-footer.site-logo.alt-text": "{siteName} logo",
-  "footer.site-footer.site-logo.aria-label": "{siteName} Home",
-  "footer.site-footer.facebook.title": "Facebook",
-  "footer.site-footer.facebook.screen-reader-text": "Like {siteName} on Facebook",
-  "footer.site-footer.twitter.title": "Twitter",
-  "footer.site-footer.twitter.screen-reader-text": "Follow {siteName} on Twitter",
-  "footer.site-footer.youtube.title": "Youtube",
-  "footer.site-footer.youtube.screen-reader-text": "Subscribe to the {siteName} YouTube channel",
-  "footer.site-footer.linkedin.title": "LinkedIn",
-  "footer.site-footer.linkedin.screen-reader-text": "Follow {siteName} on LinkedIn",
-  "footer.site-footer.google-plus.title": "Google+",
-  "footer.site-footer.google-plus.screen-reader-text": "Follow {siteName} on Google+",
-  "footer.site-footer.reddit.title": "Reddit",
-  "footer.site-footer.reddit.screen-reader-text": "Subscribe to the {siteName} subreddit",
-  "footer.site-footer.apple-app-store.alt-text": "Download the {siteName} mobile app from the Apple App Store",
-  "footer.site-footer.google-play.alt-text": "Download the {siteName} mobile app from Google Play",
-  "footer.site-footer.footer.aria-label": "Page Footer"
-}
--- a/src/index.jsx
+++ b/src/index.jsx
@@ -66,6 +66,10 @@ const App = () => (
      siteName="edX"
      siteLogo={FooterLogo}
      marketingSiteBaseUrl="https://www.example.com"
+      enterpriseMarketingLink={{
+        url: 'https://business.edx.org',
+        queryParams: { utm_test: 'utm_test_value' },
+      }}
      supportUrl="https://www.example.com/support"
      contactUrl="https://www.example.com/contact"
      openSourceUrl="https://www.example.com/open"
--- a/src/lib/components/SiteFooter/SiteFooter.test.jsx
+++ b/src/lib/components/SiteFooter/SiteFooter.test.jsx
@@ -93,6 +93,10 @@ const completeSiteFooterComponent = mockHandleAllTrackEvents =>
        handleAllTrackEvents={mockHandleAllTrackEvents}
        supportedLanguages={supportedLanguages}
        languageForm={languageForm}
+        enterpriseMarketingLink={{
+          url: 'https://business.edx.org',
+          queryParams: { utm_test: 'utm_test_value' },
+        }}
      />
    </IntlProvider>
  );
@@ -125,6 +129,10 @@ describe('<SiteFooter />', () => {
              supportedLanguages={supportedLanguages}
              languageForm={languageForm}
              handleAllTrackEvents={jest.fn()}
+              enterpriseMarketingLink={{
+                url: 'https://business.edx.org',
+                queryParams: { utm_test: 'utm_test_value' },
+              }}
            />
          </IntlProvider>
        )).toJSON();
@@ -178,6 +186,28 @@ describe('<SiteFooter />', () => {
        )).toJSON();
      expect(tree).toMatchSnapshot();
    });
+
+    it('does not render business links', () => {
+      const tree = renderer
+        .create((
+          <IntlProvider locale="en">
+            <SiteFooter
+              siteName="example"
+              siteLogo={FooterLogo}
+              marketingSiteBaseUrl="https://www.example.com"
+              supportUrl="https://www.example.com/support"
+              contactUrl="https://www.example.com/contact"
+              openSourceUrl="https://www.example.com/open"
+              termsOfServiceUrl="https://www.example.com/terms-of-service"
+              privacyPolicyUrl="https://www.example.com/privacy-policy"
+              appleAppStoreUrl="https://store.apple.com"
+              googlePlayUrl="https://play.google.com"
+              handleAllTrackEvents={jest.fn()}
+            />
+          </IntlProvider>
+        )).toJSON();
+      expect(tree).toMatchSnapshot();
+    });
  });

  describe('handles analytics', () => {
--- a/src/lib/components/SiteFooter/snapshots/SiteFooter.test.jsx.snap
+++ b/src/lib/components/SiteFooter/snapshots/SiteFooter.test.jsx.snap
@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP

-exports[`<SiteFooter /> renders correctly does not render language selector 1`] = `
+exports[`<SiteFooter /> renders correctly does not render business links 1`] = `
 <footer
  aria-label="Page Footer"
  className="footer d-flex justify-content-center border-top py-3 px-4"
@@ -44,10 +44,246 @@ exports[`<SiteFooter /> renders correctly does not render language selector 1`]
        </li>
        <li>
          <a
-            href="https://www.example.com/enterprise"
+            href="https://www.example.com/affiliate-program"
          >
            <span>
-              example for Business
+              Affiliates
+            </span>
+          </a>
+        </li>
+        <li>
+          <a
+            href="https://www.example.com/open"
+          >
+            <span>
+              Open example
+            </span>
+          </a>
+        </li>
+        <li>
+          <a
+            href="https://www.example.com/careers"
+          >
+            <span>
+              Careers
+            </span>
+          </a>
+        </li>
+        <li>
+          <a
+            href="https://www.example.com/news-announcements"
+          >
+            <span>
+              News
+            </span>
+          </a>
+        </li>
+      </ul>
+    </div>
+    <div
+      className="area-3"
+    >
+      <h2>
+        <span>
+          Legal
+        </span>
+      </h2>
+      <ul
+        className="list-unstyled p-0 m-0"
+      >
+        <li>
+          <a
+            href="https://www.example.com/terms-of-service"
+          >
+            <span>
+              Terms of Service & Honor Code
+            </span>
+          </a>
+        </li>
+        <li>
+          <a
+            href="https://www.example.com/privacy-policy"
+          >
+            <span>
+              Privacy Policy
+            </span>
+          </a>
+        </li>
+        <li>
+          <a
+            href="https://www.example.com/accessibility"
+          >
+            <span>
+              Accessibility Policy
+            </span>
+          </a>
+        </li>
+        <li>
+          <a
+            href="https://www.example.com/trademarks"
+          >
+            <span>
+              Trademark Policy
+            </span>
+          </a>
+        </li>
+        <li>
+          <a
+            href="https://www.example.com/sitemap"
+          >
+            <span>
+              Sitemap
+            </span>
+          </a>
+        </li>
+      </ul>
+    </div>
+    <div
+      className="area-4"
+    >
+      <h2>
+        <span>
+          Connect
+        </span>
+      </h2>
+      <ul
+        className="list-unstyled p-0 m-0"
+      >
+        <li>
+          <a
+            href="https://www.example.com/blog"
+          >
+            <span>
+              Blog
+            </span>
+          </a>
+        </li>
+        <li>
+          <a
+            href="https://www.example.com/contact"
+          >
+            <span>
+              Contact Us
+            </span>
+          </a>
+        </li>
+        <li>
+          <a
+            href="https://www.example.com/support"
+          >
+            <span>
+              Help Center
+            </span>
+          </a>
+        </li>
+        <li>
+          <a
+            href="https://www.example.com/media-kit"
+          >
+            <span>
+              Media Kit
+            </span>
+          </a>
+        </li>
+        <li>
+          <a
+            href="https://www.example.com/donate"
+          >
+            <span>
+              Donate
+            </span>
+          </a>
+        </li>
+      </ul>
+    </div>
+    <div
+      className="area-5"
+    >
+      <ul
+        className="d-flex flex-row justify-content-between list-unstyled max-width-264 p-0 mb-5"
+      >
+        <li>
+          <a
+            href="https://store.apple.com"
+            onClick={[Function]}
+            rel="noopener noreferrer"
+            target="_blank"
+          >
+            <img
+              alt="Download the example mobile app from the Apple App Store"
+              className="max-height-39"
+              src="https://prod-edxapp.edx-cdn.org/static/images/app/app_store_badge_135x40.d0558d910630.svg"
+            />
+          </a>
+        </li>
+        <li>
+          <a
+            href="https://play.google.com"
+            onClick={[Function]}
+            rel="noopener noreferrer"
+            target="_blank"
+          >
+            <img
+              alt="Download the example mobile app from Google Play"
+              className="max-height-39"
+              src="https://prod-edxapp.edx-cdn.org/static/images/app/google_play_badge_45.6ea466e328da.png"
+            />
+          </a>
+        </li>
+      </ul>
+      <p>
+        <span>
+          © 2012–2019 example Inc.
+        </span>
+        <br />
+        <span>
+          EdX, Open edX, and MicroMasters are registered trademarks of edX Inc. | 粤ICP备17044299号-2
+        </span>
+      </p>
+    </div>
+  </div>
+</footer>
+`;
+
+exports[`<SiteFooter /> renders correctly does not render language selector 1`] = `
+<footer
+  aria-label="Page Footer"
+  className="footer d-flex justify-content-center border-top py-3 px-4"
+  role="contentinfo"
+>
+  <div
+    className="max-width-1180 d-grid"
+  >
+    <div
+      className="area-1"
+    >
+      <a
+        aria-label="example Home"
+        href="https://www.example.com/"
+        onClick={[Function]}
+        target="_self"
+      >
+        <img
+          alt="example logo"
+          src="test-file-stub"
+        />
+      </a>
+    </div>
+    <div
+      className="area-2"
+    >
+      <h2>
+        example
+      </h2>
+      <ul
+        className="list-unstyled p-0 m-0"
+      >
+        <li>
+          <a
+            href="https://www.example.com/about-us"
+          >
+            <span>
+              About
            </span>
          </a>
        </li>
@@ -354,15 +590,6 @@ exports[`<SiteFooter /> renders correctly does not render mobile links 1`] = `
            </span>
          </a>
        </li>
-        <li>
-          <a
-            href="https://www.example.com/enterprise"
-          >
-            <span>
-              example for Business
-            </span>
-          </a>
-        </li>
        <li>
          <a
            href="https://www.example.com/affiliate-program"
@@ -832,7 +1059,7 @@ exports[`<SiteFooter /> renders correctly does not render social links 1`] = `
        </li>
        <li>
          <a
-            href="https://www.example.com/enterprise"
+            href="https://business.edx.org/?utm_test=utm_test_value"
          >
            <span>
              example for Business
@@ -1144,7 +1371,7 @@ exports[`<SiteFooter /> renders correctly renders with social and mobile links 1
        </li>
        <li>
          <a
-            href="https://www.example.com/enterprise"
+            href="https://business.edx.org/?utm_test=utm_test_value"
          >
            <span>
              example for Business
--- a/src/lib/components/SiteFooter/index.jsx
+++ b/src/lib/components/SiteFooter/index.jsx
@@ -2,6 +2,7 @@ import React from 'react';
 import PropTypes from 'prop-types';
 import { FormattedMessage, injectIntl, intlShape } from 'react-intl';
 import { Hyperlink } from '@edx/paragon';
+import qs from 'query-string';

 import messages from './SiteFooter.messages';

@@ -50,6 +51,14 @@ class SiteFooter extends React.Component {
    return `${this.props.marketingSiteBaseUrl}${path}`;
  }

+  renderEnterpriseMarketingSiteUrl(enterpriseLinkData) {
+    const {
+      queryParams,
+      url,
+    } = enterpriseLinkData;
+    return queryParams ? `${url}/?${qs.stringify(queryParams)}` : url;
+  }
+
  renderMobileLinks() {
    const {
      intl,
@@ -92,6 +101,22 @@ class SiteFooter extends React.Component {
    return mobileLinks;
  }

+  renderBusinessMarketingListItem() {
+    const { siteName, enterpriseMarketingLink } = this.props;
+    return enterpriseMarketingLink && (
+      <li>
+        <a href={this.renderEnterpriseMarketingSiteUrl(enterpriseMarketingLink)}>
+          <FormattedMessage
+            id="footer.site-footer.link.business"
+            defaultMessage="{siteName} for Business"
+            description="A link that points to a business marketing page for a specified website"
+            values={{ siteName }}
+          />
+        </a>
+      </li>
+    );
+  }
+
  render() {
    const {
      intl,
@@ -159,15 +184,7 @@ class SiteFooter extends React.Component {
                  />
                </a>
              </li>
-              <li>
-                <a href={this.renderMarketingSiteUrl('/enterprise')}>
-                  <FormattedMessage
-                    id="footer.site-footer.link.business"
-                    defaultMessage="{siteName} for Business"
-                    values={{ siteName }}
-                  />
-                </a>
-              </li>
+              {this.renderBusinessMarketingListItem()}
              <li>
                <a href={this.renderMarketingSiteUrl('/affiliate-program')}>
                  <FormattedMessage
@@ -357,6 +374,10 @@ SiteFooter.propTypes = {
  siteName: PropTypes.string,
  siteLogo: PropTypes.node,
  marketingSiteBaseUrl: PropTypes.string,
+  enterpriseMarketingLink: PropTypes.shape({
+    url: PropTypes.string,
+    queryParams: PropTypes.shape({}),
+  }),
  supportUrl: PropTypes.string,
  contactUrl: PropTypes.string,
  openSourceUrl: PropTypes.string,
@@ -390,6 +411,7 @@ SiteFooter.defaultProps = {
  siteName: null,
  siteLogo: null,
  marketingSiteBaseUrl: null,
+  enterpriseMarketingLink: null,
  supportUrl: null,
  contactUrl: null,
  openSourceUrl: null,
Author	SHA1	Message	Date
Robert Raposa	2f33c6718b	Merge pull request #31 from edx/robrap/ARCH-748-fix-i18n-jobs fix(i18n): fix i18n make targets	2019-05-16 13:20:46 -04:00
Adam Stankiewicz	89397fcfdb	Merge pull request #32 from edx/astankiewicz/downgrade-query-string fix(query-string): downgrade query-string to version 5 for es5	2019-05-16 12:57:21 -04:00
Adam Stankiewicz	278b4b1473	fix(query-string): downgrade query-string to version 5 for es5	2019-05-16 09:44:44 -07:00
Robert Raposa	7ff9039bb7	fix(i18n): fix i18n make targets ARCH-748	2019-05-16 12:27:27 -04:00
Chris Pappas	0cf3164901	Merge pull request #28 from edx/cpappas/ENT-1888 fix: updating enterprise marketing link logic	2019-05-10 16:55:50 -04:00
Christopher Pappas	bf8020dfac	fix: updating business marketing footer fix: adding https:// to business marketing link fix: fixing marketing link for business fix: fixing marketing link for business	2019-05-10 15:49:40 -04:00