docbrown/app/javascript/packs/homePageFeed.jsx
PJ 3f7d1fbc1a
Create feed impression and click events (#20043)
* getting started: model setup

* basic controller action & spec

* somewhat working click events

* pick up on impressions

* there was an attempt at batching without duplicates

* (better) bulk upsert service

* fix specs?

* touch up feed events JS

* end-to-end specs??

* workers wip

* fix failing user delete spec
2023-09-11 13:32:36 +01:00

174 lines
4.1 KiB
JavaScript

import { h, Fragment, render } from 'preact';
import PropTypes from 'prop-types';
import { Article, LoadingArticle } from '../articles';
import { Feed } from '../articles/Feed';
import { TodaysPodcasts, PodcastEpisode } from '../podcasts';
import { articlePropTypes } from '../common-prop-types';
import { createRootFragment } from '../shared/preact/preact-root-fragment';
import { getUserDataAndCsrfToken } from '@utilities/getUserDataAndCsrfToken';
/**
* Sends analytics about the featured article.
*
* @param {number} articleId
*/
function sendFeaturedArticleGoogleAnalytics(articleId) {
(function logFeaturedArticleImpressionGA() {
if (!window.ga || !ga.create) {
setTimeout(logFeaturedArticleImpressionGA, 20);
return;
}
ga(
'send',
'event',
'view',
'featured-feed-impression',
`articles-${articleId}`,
null,
);
})();
}
function sendFeaturedArticleAnalyticsGA4(articleId) {
(function logFeaturedArticleImpressionGA4() {
if (!window.gtag) {
setTimeout(logFeaturedArticleImpressionGA4, 20);
return;
}
gtag('event', 'featured-feed-impression', {
event_category: 'view',
event_label: `articles-${articleId}`,
});
})();
}
function feedConstruct(
pinnedItem,
imageItem,
feedItems,
bookmarkedFeedItems,
bookmarkClick,
currentUserId,
) {
const commonProps = {
bookmarkClick,
};
const feedStyle = JSON.parse(document.body.dataset.user).feed_style;
if (imageItem) {
sendFeaturedArticleGoogleAnalytics(imageItem.id);
sendFeaturedArticleAnalyticsGA4(imageItem.id);
}
return feedItems.map((item) => {
// billboard is an html string
if (typeof item === 'string') {
return (
<div
key={item.id}
// eslint-disable-next-line react/no-danger
dangerouslySetInnerHTML={{
__html: item,
}}
/>
);
}
if (Array.isArray(item) && item[0].podcast) {
return <PodcastEpisodes key={item.id} episodes={item} />;
}
if (typeof item === 'object') {
return (
<Article
{...commonProps}
key={item.id}
article={item}
pinned={item.id === pinnedItem?.id}
isFeatured={item.id === imageItem?.id}
feedStyle={feedStyle}
isBookmarked={bookmarkedFeedItems.has(item.id)}
saveable={item.user_id != currentUserId}
// For "saveable" props, "!=" is used instead of "!==" to compare user_id
// and currentUserId because currentUserId is a String while user_id is an Integer
/>
);
}
});
}
const FeedLoading = () => (
<div data-testid="feed-loading">
<LoadingArticle version="featured" />
<LoadingArticle />
<LoadingArticle />
<LoadingArticle />
<LoadingArticle />
<LoadingArticle />
<LoadingArticle />
</div>
);
const PodcastEpisodes = ({ episodes }) => (
<TodaysPodcasts>
{episodes.map((episode) => (
<PodcastEpisode episode={episode} key={episode.podcast.id} />
))}
</TodaysPodcasts>
);
PodcastEpisodes.defaultProps = {
episodes: [],
};
PodcastEpisodes.propTypes = {
episodes: PropTypes.arrayOf(articlePropTypes),
};
/**
* Renders the main feed.
*/
export const renderFeed = async (timeFrame, afterRender) => {
const feedContainer = document.getElementById('homepage-feed');
const { currentUser } = await getUserDataAndCsrfToken();
const currentUserId = currentUser && currentUser.id;
const callback = ({
pinnedItem,
imageItem,
feedItems,
bookmarkedFeedItems,
bookmarkClick,
}) => {
if (feedItems.length === 0) {
// Fancy loading ✨
return <FeedLoading />;
}
return (
<Fragment>
{feedConstruct(
pinnedItem,
imageItem,
feedItems,
bookmarkedFeedItems,
bookmarkClick,
currentUserId,
)}
</Fragment>
);
};
render(
<Feed
timeFrame={timeFrame}
renderFeed={callback}
afterRender={afterRender}
/>,
createRootFragment(feedContainer, feedContainer.firstElementChild),
);
};