From 0d023163ba5ccddc794076422bb07d0d111fa121 Mon Sep 17 00:00:00 2001
From: Arit Amana <32520970+msarit@users.noreply.github.com>
Date: Thu, 28 Apr 2022 12:33:01 -0400
Subject: [PATCH] Hide 'Save' button on posts that belong to the current user
 (#17293)

* implement change

* struggling with tests

* extend implementation to relevant views

* update Article.test.jsx snapshot

* fix failing specs

* query userData more robustly

* default saveable value in SaveButton component

* fix spec

* fetch currentUser async
---
 .../javascripts/initializers/initScrolling.js |  9 ++++++--
 .../javascripts/utilities/buildArticleHTML.js |  6 ++++--
 app/javascript/articles/Article.jsx           |  4 ++++
 .../articles/__tests__/Article.test.jsx       | 21 +++++++++++++++++++
 .../articles/components/SaveButton.jsx        |  5 +++--
 .../components/__tests__/SaveButton.test.jsx  | 10 +++++++++
 app/javascript/packs/hideBookmarkButtons.js   | 12 +++++++++++
 app/javascript/packs/homePageFeed.jsx         | 11 +++++++++-
 app/javascript/packs/searchParams.js          |  4 +++-
 app/views/articles/_single_story.html.erb     |  9 +++++++-
 app/views/collections/show.html.erb           |  2 +-
 app/views/organizations/show.html.erb         |  2 +-
 .../stories/tagged_articles/index.html.erb    |  2 +-
 app/views/users/show.html.erb                 |  2 +-
 14 files changed, 86 insertions(+), 13 deletions(-)
 create mode 100644 app/javascript/packs/hideBookmarkButtons.js

diff --git a/app/assets/javascripts/initializers/initScrolling.js b/app/assets/javascripts/initializers/initScrolling.js
index 184052974..9371950e1 100644
--- a/app/assets/javascripts/initializers/initScrolling.js
+++ b/app/assets/javascripts/initializers/initScrolling.js
@@ -207,6 +207,8 @@ function insertArticles(articles) {
   var list = document.getElementById('substories');
   var newArticlesHTML = '';
   var el = document.getElementById('home-articles-object');
+  var currentUser = userData();
+  var currentUserId = currentUser && currentUser.id;
   if (el) {
     el.outerHTML = '';
   }
@@ -226,9 +228,12 @@ function insertArticles(articles) {
       existingEl.parentElement.classList.contains('crayons-story') &&
       !document.getElementById('video-player-' + article.id)
     ) {
-      existingEl.parentElement.outerHTML = buildArticleHTML(article);
+      existingEl.parentElement.outerHTML = buildArticleHTML(
+        article,
+        currentUserId,
+      );
     } else if (!existingEl) {
-      var newHTML = buildArticleHTML(article);
+      var newHTML = buildArticleHTML(article, currentUserId);
       newArticlesHTML += newHTML;
       initializeReadingListIcons();
     }
diff --git a/app/assets/javascripts/utilities/buildArticleHTML.js b/app/assets/javascripts/utilities/buildArticleHTML.js
index e00410ec5..eedeaa509 100644
--- a/app/assets/javascripts/utilities/buildArticleHTML.js
+++ b/app/assets/javascripts/utilities/buildArticleHTML.js
@@ -2,7 +2,7 @@
 
 /* eslint-disable no-multi-str */
 
-function buildArticleHTML(article) {
+function buildArticleHTML(article, currentUserId = null) {
   var tagIcon = `<svg width="24" height="24" viewBox="0 0 24 24" class="crayons-icon" xmlns="http://www.w3.org/2000/svg"><path d="M7.784 14l.42-4H4V8h4.415l.525-5h2.011l-.525 5h3.989l.525-5h2.011l-.525 5H20v2h-3.784l-.42 4H20v2h-4.415l-.525 5h-2.011l.525-5H9.585l-.525 5H7.049l.525-5H4v-2h3.784zm2.011 0h3.99l.42-4h-3.99l-.42 4z"/></svg>`;
   if (article && article.class_name === 'Tag') {
     return `<article class="crayons-story">
@@ -278,7 +278,9 @@ function buildArticleHTML(article) {
     }
 
     var saveButton = '';
-    if (article.class_name === 'Article') {
+    // "!=" instead of "!==" used to compare user_id and currentUserId because
+    // currentUserId is a String while user_id is an Integer
+    if (article.class_name === 'Article' && article.user_id != currentUserId) {
       saveButton =
         '<button type="button" id="article-save-button-' +
         article.id +
diff --git a/app/javascript/articles/Article.jsx b/app/javascript/articles/Article.jsx
index a7569f708..471cd2d72 100644
--- a/app/javascript/articles/Article.jsx
+++ b/app/javascript/articles/Article.jsx
@@ -23,6 +23,7 @@ export const Article = ({
   bookmarkClick,
   feedStyle,
   pinned,
+  saveable,
 }) => {
   if (article && article.type_of === 'podcast_episodes') {
     return <PodcastArticle article={article} />;
@@ -133,6 +134,7 @@ export const Article = ({
                   article={article}
                   isBookmarked={isBookmarked}
                   onClick={bookmarkClick}
+                  saveable={saveable}
                 />
               </div>
             </div>
@@ -155,6 +157,7 @@ Article.defaultProps = {
   isBookmarked: false,
   isFeatured: false,
   feedStyle: 'basic',
+  saveable: true,
 };
 
 Article.propTypes = {
@@ -164,4 +167,5 @@ Article.propTypes = {
   feedStyle: PropTypes.string,
   bookmarkClick: PropTypes.func.isRequired,
   pinned: PropTypes.bool,
+  saveable: PropTypes.bool.isRequired,
 };
diff --git a/app/javascript/articles/__tests__/Article.test.jsx b/app/javascript/articles/__tests__/Article.test.jsx
index fcc255adc..b3ea22d68 100644
--- a/app/javascript/articles/__tests__/Article.test.jsx
+++ b/app/javascript/articles/__tests__/Article.test.jsx
@@ -263,4 +263,25 @@ describe('<Article /> component', () => {
 
     expect(queryByText('person', { selector: 'span' })).toBeDefined();
   });
+
+  it('should show bookmark button when article is saveable (default)', () => {
+    const { queryByTestId } = render(
+      <Article {...commonProps} isBookmarked={false} article={article} />,
+    );
+
+    expect(queryByTestId(`article-save-button-${article.id}`)).toBeDefined();
+  });
+
+  it('should hide bookmark button when article is not saveable', () => {
+    const { queryByTestId } = render(
+      <Article
+        {...commonProps}
+        isBookmarked={false}
+        article={article}
+        saveable={false}
+      />,
+    );
+
+    expect(queryByTestId(`article-save-button-${article.id}`)).toBeNull();
+  });
 });
diff --git a/app/javascript/articles/components/SaveButton.jsx b/app/javascript/articles/components/SaveButton.jsx
index 11543bc88..8aa2bd7fc 100644
--- a/app/javascript/articles/components/SaveButton.jsx
+++ b/app/javascript/articles/components/SaveButton.jsx
@@ -15,7 +15,7 @@ export class SaveButton extends Component {
 
   render() {
     const { buttonText } = this.state;
-    const { article, isBookmarked, onClick } = this.props;
+    const { article, isBookmarked, onClick, saveable = true } = this.props;
 
     const mouseMove = (_e) => {
       this.setState({ buttonText: isBookmarked ? 'Unsave' : 'Save' });
@@ -33,7 +33,7 @@ export class SaveButton extends Component {
       });
     };
 
-    if (article.class_name === 'Article') {
+    if (article.class_name === 'Article' && saveable) {
       return (
         <button
           type="button"
@@ -74,6 +74,7 @@ SaveButton.propTypes = {
   article: articlePropTypes.isRequired,
   isBookmarked: PropTypes.bool.isRequired,
   onClick: PropTypes.func.isRequired,
+  saveable: PropTypes.bool.isRequired,
 };
 
 SaveButton.displayName = 'SaveButton';
diff --git a/app/javascript/articles/components/__tests__/SaveButton.test.jsx b/app/javascript/articles/components/__tests__/SaveButton.test.jsx
index 40245e59b..d69552116 100644
--- a/app/javascript/articles/components/__tests__/SaveButton.test.jsx
+++ b/app/javascript/articles/components/__tests__/SaveButton.test.jsx
@@ -3,6 +3,16 @@ import { fireEvent, render } from '@testing-library/preact';
 import { axe } from 'jest-axe';
 import { SaveButton } from '../SaveButton';
 
+it('should not show bookmark button when saveable is false', () => {
+  const article = { class_name: 'Article', id: 1 };
+  const { queryByText } = render(
+    <SaveButton article={article} saveable={false} />,
+  );
+  const saveButton = queryByText('Saved');
+
+  expect(saveButton).toBeNull();
+});
+
 it('should have no a11y violations', async () => {
   const article = { class_name: 'Article', id: 1 };
   const { container } = render(<SaveButton article={article} />);
diff --git a/app/javascript/packs/hideBookmarkButtons.js b/app/javascript/packs/hideBookmarkButtons.js
new file mode 100644
index 000000000..9a7354898
--- /dev/null
+++ b/app/javascript/packs/hideBookmarkButtons.js
@@ -0,0 +1,12 @@
+import { getUserDataAndCsrfToken } from '@utilities/getUserDataAndCsrfToken';
+
+getUserDataAndCsrfToken().then(({ currentUser }) => {
+  const currentUserId = currentUser && currentUser.id;
+
+  document.querySelectorAll('.bookmark-button').forEach((button) => {
+    const { articleAuthorId } = button.dataset;
+    if (currentUserId && articleAuthorId == currentUserId) {
+      button.classList.add('hidden');
+    }
+  });
+});
diff --git a/app/javascript/packs/homePageFeed.jsx b/app/javascript/packs/homePageFeed.jsx
index b21a10b32..86e64826c 100644
--- a/app/javascript/packs/homePageFeed.jsx
+++ b/app/javascript/packs/homePageFeed.jsx
@@ -4,6 +4,7 @@ import { Article, LoadingArticle } from '../articles';
 import { Feed } from '../articles/Feed';
 import { TodaysPodcasts, PodcastEpisode } from '../podcasts';
 import { articlePropTypes } from '../common-prop-types';
+import { getUserDataAndCsrfToken } from '@utilities/getUserDataAndCsrfToken';
 
 /**
  * Sends analytics about the featured article.
@@ -59,9 +60,12 @@ PodcastEpisodes.propTypes = {
 /**
  * Renders the main feed.
  */
-export const renderFeed = (timeFrame) => {
+export const renderFeed = async (timeFrame) => {
   const feedContainer = document.getElementById('homepage-feed');
 
+  const { currentUser } = await getUserDataAndCsrfToken();
+  const currentUserId = currentUser && currentUser.id;
+
   render(
     <Feed
       timeFrame={timeFrame}
@@ -92,6 +96,8 @@ export const renderFeed = (timeFrame) => {
         // 2. Show the featured story next
         // 3. Podcast episodes out today
         // 4. Rest of the stories for the feed
+        // For "saveable", "!=" is used instead of "!==" to compare user_id
+        // and currentUserId because currentUserId is a String while user_id is an Integer
         return (
           <div>
             {timeFrame === '' && pinnedArticle && (
@@ -101,6 +107,7 @@ export const renderFeed = (timeFrame) => {
                 pinned={true}
                 feedStyle={feedStyle}
                 isBookmarked={bookmarkedFeedItems.has(pinnedArticle.id)}
+                saveable={pinnedArticle.user_id != currentUserId}
               />
             )}
             {featuredStory && (
@@ -110,6 +117,7 @@ export const renderFeed = (timeFrame) => {
                 isFeatured
                 feedStyle={feedStyle}
                 isBookmarked={bookmarkedFeedItems.has(featuredStory.id)}
+                saveable={featuredStory.user_id != currentUserId}
               />
             )}
             {podcastEpisodes.length > 0 && (
@@ -122,6 +130,7 @@ export const renderFeed = (timeFrame) => {
                 article={story}
                 feedStyle={feedStyle}
                 isBookmarked={bookmarkedFeedItems.has(story.id)}
+                saveable={story.user_id != currentUserId}
               />
             ))}
           </div>
diff --git a/app/javascript/packs/searchParams.js b/app/javascript/packs/searchParams.js
index 78e955325..4a6a9b006 100644
--- a/app/javascript/packs/searchParams.js
+++ b/app/javascript/packs/searchParams.js
@@ -185,8 +185,10 @@ function search(query, filters, sortBy, sortDirection) {
     .then((response) => response.json())
     .then((content) => {
       const resultDivs = [];
+      const currentUser = userData();
+      const currentUserId = currentUser && currentUser.id;
       content.result.forEach((story) => {
-        resultDivs.push(buildArticleHTML(story));
+        resultDivs.push(buildArticleHTML(story, currentUserId));
       });
       document.getElementById('substories').innerHTML = resultDivs.join('');
       initializeReadingListIcons();
diff --git a/app/views/articles/_single_story.html.erb b/app/views/articles/_single_story.html.erb
index c69b31f8d..c90711183 100644
--- a/app/views/articles/_single_story.html.erb
+++ b/app/views/articles/_single_story.html.erb
@@ -147,7 +147,14 @@
           <small class="crayons-story__tertiary fs-xs mr-2">
             <%= t("views.articles.reading_time", count: story.reading_time < 1 ? 1 : story.reading_time) %>
           </small>
-          <button type="button" id="article-save-button-<%= story.id %>" class="crayons-btn crayons-btn--secondary crayons-btn--s w-max bookmark-button" data-reactable-id="<%= story.id %>" aria-label="<%= t("views.articles.save.aria_label") %>" title="<%= t("views.articles.save.title") %>">
+          <button
+            type="button"
+            id="article-save-button-<%= story.id %>"
+            class="crayons-btn crayons-btn--secondary crayons-btn--s w-max bookmark-button"
+            data-reactable-id="<%= story.id %>"
+            data-article-author-id="<%= story.user_id %>"
+            aria-label="<%= t("views.articles.save.aria_label") %>"
+            title="<%= t("views.articles.save.title") %>">
             <span class="bm-initial"><%= t("views.articles.save.initial") %></span>
             <span class="bm-success"><%= t("views.articles.save.success") %></span>
           </button>
diff --git a/app/views/collections/show.html.erb b/app/views/collections/show.html.erb
index 7f152ba56..d2ea5c900 100644
--- a/app/views/collections/show.html.erb
+++ b/app/views/collections/show.html.erb
@@ -17,7 +17,7 @@
         <% @articles.each do |article| %>
           <%= render "articles/single_story", story: article.decorate, featured: article.main_image.present? %>
         <% end %>
-        <%= javascript_packs_with_chunks_tag "followButtons", "feedPreviewCards", defer: true %>
+        <%= javascript_packs_with_chunks_tag "followButtons", "feedPreviewCards", "hideBookmarkButtons", defer: true %>
       <% else %>
         <p><%= t("views.series.list.empty") %></p>
       <% end %>
diff --git a/app/views/organizations/show.html.erb b/app/views/organizations/show.html.erb
index 8fbaaabe6..4c44c637f 100644
--- a/app/views/organizations/show.html.erb
+++ b/app/views/organizations/show.html.erb
@@ -24,4 +24,4 @@
   <%= render "organizations/sidebar_additional" %>
 </div>
 
-<%= javascript_packs_with_chunks_tag "storiesList", "followButtons", defer: true %>
+<%= javascript_packs_with_chunks_tag "storiesList", "followButtons", "hideBookmarkButtons", defer: true %>
diff --git a/app/views/stories/tagged_articles/index.html.erb b/app/views/stories/tagged_articles/index.html.erb
index 6f5bc9928..f460bb336 100644
--- a/app/views/stories/tagged_articles/index.html.erb
+++ b/app/views/stories/tagged_articles/index.html.erb
@@ -130,5 +130,5 @@
     <%= render "stories/tagged_articles/sidebar_additional" %>
   </div>
 
-  <%= javascript_packs_with_chunks_tag "storiesList", "followButtons", "feedPreviewCards", defer: true %>
+  <%= javascript_packs_with_chunks_tag "storiesList", "followButtons", "feedPreviewCards", "hideBookmarkButtons", defer: true %>
 <% end %>
diff --git a/app/views/users/show.html.erb b/app/views/users/show.html.erb
index 71f69a9d2..5014a6af4 100644
--- a/app/views/users/show.html.erb
+++ b/app/views/users/show.html.erb
@@ -151,4 +151,4 @@
 </div>
 </main>
 
-<%= javascript_packs_with_chunks_tag "storiesList", "followButtons", "feedPreviewCards", defer: true %>
+<%= javascript_packs_with_chunks_tag "storiesList", "followButtons", "feedPreviewCards", "hideBookmarkButtons", defer: true %>