Merge pull request #6 from edx/robrap/ARCH-378-add-test

fix(analytics): add test and fix youtube

package-lock.json

@@ -21666,6 +21666,16 @@
             "snapdragon": "^0.8.1",
             "to-regex": "^3.0.2"
           }
+        },
+        "watch": {
+          "version": "0.18.0",
+          "resolved": "https://registry.npmjs.org/watch/-/watch-0.18.0.tgz",
+          "integrity": "sha1-KAlUdsbffJDJYxOJkMClQj60uYY=",
+          "dev": true,
+          "requires": {
+            "exec-sh": "^0.2.0",
+            "minimist": "^1.2.0"
+          }
         }
       }
     },
@@ -24627,9 +24637,9 @@
       }
     },
     "watch": {
-      "version": "0.18.0",
-      "resolved": "https://registry.npmjs.org/watch/-/watch-0.18.0.tgz",
-      "integrity": "sha1-KAlUdsbffJDJYxOJkMClQj60uYY=",
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/watch/-/watch-1.0.2.tgz",
+      "integrity": "sha1-NApxe952Vyb6CqB9ch4BR6VR3ww=",
       "dev": true,
       "requires": {
         "exec-sh": "^0.2.0",

package.json

@@ -78,7 +78,6 @@
   "peerDependencies": {
     "@edx/paragon": "^3.8.0",
     "clean-webpack-plugin": "^0.1.19",
-    "copy-webpack-plugin": "^4.6.0",
     "html-webpack-plugin": "^3.2.0",
     "prop-types": "^15.5.10",
     "react": "^16.4.2",

src/lib/components/SiteFooter/SiteFooter.test.jsx

@@ -1,81 +1,112 @@
 import React from 'react';
 import renderer from 'react-test-renderer';
+import { mount } from 'enzyme';
 
 import FooterLogo from '../../../edx-footer.png';
-import SiteFooter from '../../index';
+import SiteFooter, { EVENT_NAMES } from './index';
+
+const completeSiteFooterComponent = mockHandleAllTrackEvents =>
+  (<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"
+    facebookUrl="https://www.facebook.com"
+    twitterUrl="https://www.twitter.com"
+    youTubeUrl="https://www.youtube.com"
+    linkedInUrl="https://www.linkedin.com"
+    googlePlusUrl="https://plus.google.com"
+    redditUrl="https://reddit.com"
+    appleAppStoreUrl="https://store.apple.com"
+    googlePlayUrl="https://play.google.com"
+    handleAllTrackEvents={mockHandleAllTrackEvents}
+  />);
 
 describe('<SiteFooter />', () => {
-  it('renders correctly', () => {
-    const tree = renderer
-      .create(<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"
-        facebookUrl="https://www.facebook.com"
-        twitterUrl="https://www.twitter.com"
-        youTubeUrl="https://www.youtube.com"
-        linkedInUrl="https://www.linkedin.com"
-        googlePlusUrl="https://plus.google.com"
-        redditUrl="https://reddit.com"
-        appleAppStoreUrl="https://store.apple.com"
-        googlePlayUrl="https://play.google.com"
-      />)
-      .toJSON();
-    expect(tree).toMatchSnapshot();
+  describe('renders correctly', () => {
+    it('renders with social and mobile links', () => {
+      const mockHandleAllTrackEvents = jest.fn();
+      const tree = renderer
+        .create(completeSiteFooterComponent(mockHandleAllTrackEvents))
+        .toJSON();
+      expect(tree).toMatchSnapshot();
+    });
+
+    it('does not render social links', () => {
+      const tree = renderer
+        .create(<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"
+          facebookUrl="https://www.facebook.com"
+          twitterUrl="https://www.twitter.com"
+          youTubeUrl="https://www.youtube.com"
+          linkedInUrl="https://www.linkedin.com"
+          googlePlusUrl="https://plus.google.com"
+          redditUrl="https://reddit.com"
+          appleAppStoreUrl="https://store.apple.com"
+          googlePlayUrl="https://play.google.com"
+          handleAllTrackEvents={jest.fn()}
+          showSocialLinks={false}
+        />)
+        .toJSON();
+      expect(tree).toMatchSnapshot();
+    });
+
+    it('does not render mobile links', () => {
+      const tree = renderer
+        .create(<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"
+          facebookUrl="https://www.facebook.com"
+          twitterUrl="https://www.twitter.com"
+          youTubeUrl="https://www.youtube.com"
+          linkedInUrl="https://www.linkedin.com"
+          googlePlusUrl="https://plus.google.com"
+          redditUrl="https://reddit.com"
+          appleAppStoreUrl="https://store.apple.com"
+          googlePlayUrl="https://play.google.com"
+          handleAllTrackEvents={jest.fn()}
+          showMobileLinks={false}
+        />)
+        .toJSON();
+      expect(tree).toMatchSnapshot();
+    });
   });
 
-  it('does not render social links', () => {
-    const tree = renderer
-      .create(<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"
-        facebookUrl="https://www.facebook.com"
-        twitterUrl="https://www.twitter.com"
-        youTubeUrl="https://www.youtube.com"
-        linkedInUrl="https://www.linkedin.com"
-        googlePlusUrl="https://plus.google.com"
-        redditUrl="https://reddit.com"
-        appleAppStoreUrl="https://store.apple.com"
-        googlePlayUrl="https://play.google.com"
-        showSocialLinks={false}
-      />)
-      .toJSON();
-    expect(tree).toMatchSnapshot();
-  });
+  describe('handles analytics', () => {
+    it('calls handleAllTrackEvents prop when external links clicked', () => {
+      const mockHandleAllTrackEvents = jest.fn();
+      const footer = mount((completeSiteFooterComponent(mockHandleAllTrackEvents)));
+      const externalLinks = footer.find("a[target='_blank']");
 
-  it('does not render mobile links', () => {
-    const tree = renderer
-      .create(<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"
-        facebookUrl="https://www.facebook.com"
-        twitterUrl="https://www.twitter.com"
-        youTubeUrl="https://www.youtube.com"
-        linkedInUrl="https://www.linkedin.com"
-        googlePlusUrl="https://plus.google.com"
-        redditUrl="https://reddit.com"
-        appleAppStoreUrl="https://store.apple.com"
-        googlePlayUrl="https://play.google.com"
-        showMobileLinks={false}
-      />)
-      .toJSON();
-    expect(tree).toMatchSnapshot();
+      expect(externalLinks).toHaveLength(8);
+      externalLinks.forEach((externalLink) => {
+        const callIndex = mockHandleAllTrackEvents.mock.calls.length;
+        externalLink.simulate('click');
+        expect(mockHandleAllTrackEvents.mock.calls[callIndex]).toEqual([
+          EVENT_NAMES.FOOTER_LINK,
+          {
+            category: 'outbound_link',
+            label: externalLink.prop('href'),
+          },
+        ]);
+      });
+    });
   });
 });

src/lib/components/SiteFooter/__snapshots__/SiteFooter.test.jsx.snap

@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`<SiteFooter /> does not render mobile links 1`] = `
+exports[`<SiteFooter /> renders correctly does not render mobile links 1`] = `
 <footer
   aria-label="Page Footer"
   className="footer d-flex justify-content-center border-top py-3 px-4"
@@ -220,6 +220,7 @@ exports[`<SiteFooter /> does not render mobile links 1`] = `
         <li>
           <a
             href="https://www.youtube.com"
+            onClick={[Function]}
             rel="noopener noreferrer"
             target="_blank"
             title="Youtube"
@@ -311,7 +312,7 @@ exports[`<SiteFooter /> does not render mobile links 1`] = `
 </footer>
 `;
 
-exports[`<SiteFooter /> does not render social links 1`] = `
+exports[`<SiteFooter /> renders correctly does not render social links 1`] = `
 <footer
   aria-label="Page Footer"
   className="footer d-flex justify-content-center border-top py-3 px-4"
@@ -531,7 +532,7 @@ exports[`<SiteFooter /> does not render social links 1`] = `
 </footer>
 `;
 
-exports[`<SiteFooter /> renders correctly 1`] = `
+exports[`<SiteFooter /> renders correctly renders with social and mobile links 1`] = `
 <footer
   aria-label="Page Footer"
   className="footer d-flex justify-content-center border-top py-3 px-4"
@@ -751,6 +752,7 @@ exports[`<SiteFooter /> renders correctly 1`] = `
         <li>
           <a
             href="https://www.youtube.com"
+            onClick={[Function]}
             rel="noopener noreferrer"
             target="_blank"
             title="Youtube"

src/lib/components/SiteFooter/index.jsx

@@ -81,6 +81,7 @@ class SiteFooter extends React.Component {
               title="Youtube"
               rel="noopener noreferrer"
               target="_blank"
+              onClick={this.externalLinkClickHandler}
             >
               <Icon className={['fa', 'fa-youtube-square', 'fa-2x']} screenReaderText={`Subscribe to the ${siteName} YouTube channel`} />
             </a>