9750722561

Committed 01 Jul 2024 08:37PM UTC coverage: 31.908% (-0.03%) from 31.934%

Build Type

push

github

Committed by GitHub

Commit Message

Merge pull request #9459 from ForumMagnum/recommendations-not-interested-button

Run Details

4887 of 40064 branches covered (12.2%)

Branch coverage included in aggregate %.

20 of 66 new or added lines in 8 files covered. (30.3%)

5 existing lines in 5 files now uncovered.

28505 of 64586 relevant lines covered (44.13%)

180.64 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

11.92

/packages/lesswrong/components/posts/RecombeePostsList.tsx

import React, { useState } from 'react';
import { Components, fragmentTextForQuery, registerComponent } from '../../lib/vulcan-lib';
import { NetworkStatus, gql, useQuery } from '@apollo/client';
import { HybridRecombeeConfiguration, RecombeeConfiguration } from '../../lib/collections/users/recommendationSettings';
import { useOnMountTracking } from '../../lib/analyticsEvents';
import uniq from 'lodash/uniq';
import { filterNonnull } from '../../lib/utils/typeGuardUtils';
import moment from 'moment';
import { useCurrentUser } from '../common/withUser';
import { aboutPostIdSetting } from '@/lib/instanceSettings';

// Would be nice not to duplicate in postResolvers.ts but unfortunately the post types are different
interface RecombeeRecommendedPost {
  post: PostsListWithVotes,
  scenario: string,
  recommId: string,
  generatedAt: Date,
  curated?: never,
  stickied?: never,
}

type RecommendedPost = RecombeeRecommendedPost | {
  post: PostsListWithVotes,
  scenario?: never,
  recommId?: never,
  generatedAt?: never,
  curated: boolean,
  stickied: boolean,
};

type LoadMoreSettings = {
  loadMore: (RecombeeConfiguration | HybridRecombeeConfiguration)['loadMore'];
  excludedPostIds: string[];
} | {
  loadMore?: never;
  excludedPostIds: string[]
} | {
  loadMore: (RecombeeConfiguration | HybridRecombeeConfiguration)['loadMore'];
  excludedPostIds?: never
} | undefined;

const styles = (theme: ThemeType) => ({
  root: {

  }
});

const DEFAULT_RESOLVER_NAME = 'RecombeeLatestPosts';
const HYBRID_RESOLVER_NAME = 'RecombeeHybridPosts';

type RecombeeResolver = typeof DEFAULT_RESOLVER_NAME | typeof HYBRID_RESOLVER_NAME;

const getRecombeePostsQuery = (resolverName: RecombeeResolver) => gql`
  query get${resolverName}($limit: Int, $settings: JSON) {
    ${resolverName}(limit: $limit, settings: $settings) {
      results {
        post {
          ...PostsListWithVotes
        }
        scenario
        recommId
        generatedAt
        curated
        stickied
      }
    }
  }
  ${fragmentTextForQuery('PostsListWithVotes')}
`;

const isWithinLoadMoreWindow = (recGeneratedAt: Date) => {
  // Use 29 minutes instead of 30 as the cutoff for considering recommendations stale, just to have a bit of buffer.
  const loadMoreTtlMs = 1000 * 60 * 29;
  const cutoff = moment().subtract(loadMoreTtlMs, 'ms');

  return moment(recGeneratedAt).isAfter(cutoff);
};

const getLoadMoreSettings = (resolverName: RecombeeResolver, results: RecommendedPost[], loadMoreCount: number): LoadMoreSettings => {
  const staleRecommIds = filterNonnull(uniq(
    results
      .filter(({ generatedAt }) => generatedAt && !isWithinLoadMoreWindow(generatedAt))
      .map(({ recommId }) => recommId)
  ));

  const staleRecomms = results.filter(({ recommId }) => recommId && staleRecommIds.includes(recommId));
  const freshRecomms = results.filter(({ recommId }) => recommId && !staleRecommIds.includes(recommId));

  const excludedPostIds = staleRecomms.map(({ post: { _id } }) => _id);
  const [firstRecommId, secondRecommId] = filterNonnull(uniq(freshRecomms.map(({ recommId }) => recommId)));

  switch (resolverName) {
    case DEFAULT_RESOLVER_NAME: {
      if (staleRecomms.length && !freshRecomms.length) {
        return { excludedPostIds };
      } else if (!staleRecomms.length && freshRecomms.length) {
        return { loadMore: { prevRecommId: firstRecommId } };
      } else {
        return { excludedPostIds, loadMore: { prevRecommId: firstRecommId } };
      }
    }
    case HYBRID_RESOLVER_NAME: {
      if (staleRecomms.length && !freshRecomms.length) {
        return { excludedPostIds, loadMore: { prevRecommIds: [undefined, undefined], loadMoreCount } };
      } else if (!staleRecomms.length && freshRecomms.length) {
        return { loadMore: { prevRecommIds: [firstRecommId, secondRecommId], loadMoreCount } };
      } else {
        return { excludedPostIds, loadMore: { prevRecommIds: [firstRecommId, secondRecommId], loadMoreCount } };
      }
    }
  }
}

export const stickiedPostTerms: PostsViewTerms = {
  view: 'stickied',
  limit: 4, // seriously, shouldn't have more than 4 stickied posts
  forum: true
};

export const RecombeePostsList = ({ algorithm, settings, limit = 15, showRecommendationIcon = false, classes }: {
  algorithm: string,
  settings: RecombeeConfiguration,
  limit?: number,
  showRecommendationIcon?: boolean,
  classes: ClassesType<typeof styles>,
}) => {
  const { LoadMore, PostsItem, SectionFooter, PostsLoading } = Components;

  const [loadMoreCount, setLoadMoreCount] = useState(1);
  const currentUser = useCurrentUser();

  const recombeeSettings = { ...settings, scenario: algorithm };

  const resolverName = algorithm === 'recombee-hybrid'
    ? HYBRID_RESOLVER_NAME
    : DEFAULT_RESOLVER_NAME;

  const query = getRecombeePostsQuery(resolverName);
  const { data, loading, fetchMore, networkStatus } = useQuery(query, {
    notifyOnNetworkStatusChange: true,
    pollInterval: 0,
    variables: {
      limit,
      settings: recombeeSettings,
    },
  });

  const results: RecommendedPost[] | undefined = data?.[resolverName]?.results;

  const hiddenPostIds = currentUser?.hiddenPostsMetadata?.map(metadata => metadata.postId) ?? [];
  
  //exclude posts with hiddenPostIds
  const filteredResults = results?.filter(({ post }) => !hiddenPostIds.includes(post._id));

  const postIds = filteredResults?.map(({post}) => post._id) ?? [];
  const postIdsWithScenario = filteredResults?.map(({ post, scenario, curated, stickied, generatedAt }, idx) => {
    let loggedScenario = scenario;
    if (!loggedScenario) {
      if (post._id === aboutPostIdSetting.get() && idx === 0) {
        loggedScenario = 'welcome-post';
      } else if (curated) {
        loggedScenario = 'curated';
      } else if (stickied) {
        loggedScenario = 'stickied';
      } else {
        loggedScenario = 'hacker-news';
      }
    }

    const data = { postId: post._id, scenario: loggedScenario };

    if (generatedAt) {
      return {...data, generatedAt: new Date(generatedAt).toISOString()};
    }

    return data;
  }) ?? [];

  useOnMountTracking({
    eventType: "postList",
    // TODO: Remove postIds which is redundant once analytics dashboard written to use postIdsWithScenario
    eventProps: { postIds, postIdsWithScenario, algorithm },
    captureOnMount: (eventProps) => eventProps.postIds.length > 0,
    skip: !postIds.length || loading,
  });

  if (loading && !filteredResults) {
    return <PostsLoading placeholderCount={limit} />;
  }

  if (!filteredResults) {
    return null;
  }

  return <div>
    <div className={classes.root}>
      {filteredResults.map(({ post, recommId, curated, stickied }) => <PostsItem 
        key={post._id} 
        post={post} 
        recombeeRecommId={recommId} 
        curatedIconLeft={curated} 
        showRecommendationIcon={showRecommendationIcon}
        emphasizeIfNew={true}
        terms={stickied ? stickiedPostTerms : undefined}
      />)}
    </div>
    <SectionFooter>
      <LoadMore
        loading={loading || networkStatus === NetworkStatus.fetchMore}
        loadMore={() => {
          const loadMoreSettings = getLoadMoreSettings(resolverName, filteredResults, loadMoreCount);
          void fetchMore({
            variables: {
              settings: { ...recombeeSettings, ...loadMoreSettings },
            },
            // Update the apollo cache with the combined results of previous loads and the items returned by the current loadMore
            updateQuery: (prev: AnyBecauseHard, { fetchMoreResult }: AnyBecauseHard) => {
              setLoadMoreCount(loadMoreCount + 1);

              if (!fetchMoreResult) return prev;

              return {
                [resolverName]: {
                  __typename: fetchMoreResult[resolverName].__typename,
                  results: [...prev[resolverName].results, ...fetchMoreResult[resolverName].results]
                }
              };
            }
          });
        }}
        sectionFooterStyles
      />
    </SectionFooter>
  </div>;
}

const RecombeePostsListComponent = registerComponent('RecombeePostsList', RecombeePostsList, {styles});

declare global {
  interface ComponentTypes {
    RecombeePostsList: typeof RecombeePostsListComponent
  }
}

1	import React, { useState } from 'react';	54✔
2	import { Components, fragmentTextForQuery, registerComponent } from '../../lib/vulcan-lib';	18✔
3	import { NetworkStatus, gql, useQuery } from '@apollo/client';	18✔
4	import { HybridRecombeeConfiguration, RecombeeConfiguration } from '../../lib/collections/users/recommendationSettings';
5	import { useOnMountTracking } from '../../lib/analyticsEvents';	18✔
6	import uniq from 'lodash/uniq';	18✔
7	import { filterNonnull } from '../../lib/utils/typeGuardUtils';	18✔
8	import moment from 'moment';	18✔
9	import { useCurrentUser } from '../common/withUser';	18✔
10	import { aboutPostIdSetting } from '@/lib/instanceSettings';	18✔
11
12	// Would be nice not to duplicate in postResolvers.ts but unfortunately the post types are different
13	interface RecombeeRecommendedPost {
14	post: PostsListWithVotes,
15	scenario: string,
16	recommId: string,
17	generatedAt: Date,
18	curated?: never,
19	stickied?: never,
20	}
21
22	type RecommendedPost = RecombeeRecommendedPost \| {
23	post: PostsListWithVotes,
24	scenario?: never,
25	recommId?: never,
26	generatedAt?: never,
27	curated: boolean,
28	stickied: boolean,
29	};
30
31	type LoadMoreSettings = {
32	loadMore: (RecombeeConfiguration \| HybridRecombeeConfiguration)['loadMore'];
33	excludedPostIds: string[];
34	} \| {
35	loadMore?: never;
36	excludedPostIds: string[]
37	} \| {
38	loadMore: (RecombeeConfiguration \| HybridRecombeeConfiguration)['loadMore'];
39	excludedPostIds?: never
40	} \| undefined;
41
42	const styles = (theme: ThemeType) => ({	18✔
43	root: {
44
45	}
46	});
47
48	const DEFAULT_RESOLVER_NAME = 'RecombeeLatestPosts';	18✔
49	const HYBRID_RESOLVER_NAME = 'RecombeeHybridPosts';	18✔
50
51	type RecombeeResolver = typeof DEFAULT_RESOLVER_NAME \| typeof HYBRID_RESOLVER_NAME;
52
53	const getRecombeePostsQuery = (resolverName: RecombeeResolver) => gql`	18✔
54	query get${resolverName}($limit: Int, $settings: JSON) {
55	${resolverName}(limit: $limit, settings: $settings) {
56	results {
57	post {
58	...PostsListWithVotes
59	}
60	scenario
61	recommId
62	generatedAt
63	curated
64	stickied
65	}
66	}
67	}
68	${fragmentTextForQuery('PostsListWithVotes')}
69	`;
70
71	const isWithinLoadMoreWindow = (recGeneratedAt: Date) => {	18✔
72	// Use 29 minutes instead of 30 as the cutoff for considering recommendations stale, just to have a bit of buffer.
73	const loadMoreTtlMs = 1000 * 60 * 29;	×
74	const cutoff = moment().subtract(loadMoreTtlMs, 'ms');	×
75
76	return moment(recGeneratedAt).isAfter(cutoff);	×
77	};
78
79	const getLoadMoreSettings = (resolverName: RecombeeResolver, results: RecommendedPost[], loadMoreCount: number): LoadMoreSettings => {	18✔
80	const staleRecommIds = filterNonnull(uniq(	×
81	results
82	.filter(({ generatedAt }) => generatedAt && !isWithinLoadMoreWindow(generatedAt))	×
83	.map(({ recommId }) => recommId)	×
84	));
85
86	const staleRecomms = results.filter(({ recommId }) => recommId && staleRecommIds.includes(recommId));	×
87	const freshRecomms = results.filter(({ recommId }) => recommId && !staleRecommIds.includes(recommId));	×
88
89	const excludedPostIds = staleRecomms.map(({ post: { _id } }) => _id);	×
90	const [firstRecommId, secondRecommId] = filterNonnull(uniq(freshRecomms.map(({ recommId }) => recommId)));	×
91
92	switch (resolverName) {	×
93	case DEFAULT_RESOLVER_NAME: {
94	if (staleRecomms.length && !freshRecomms.length) {	×
95	return { excludedPostIds };	×
96	} else if (!staleRecomms.length && freshRecomms.length) {	×
97	return { loadMore: { prevRecommId: firstRecommId } };	×
98	} else {
99	return { excludedPostIds, loadMore: { prevRecommId: firstRecommId } };	×
100	}
101	}
102	case HYBRID_RESOLVER_NAME: {
103	if (staleRecomms.length && !freshRecomms.length) {	×
104	return { excludedPostIds, loadMore: { prevRecommIds: [undefined, undefined], loadMoreCount } };	×
105	} else if (!staleRecomms.length && freshRecomms.length) {	×
106	return { loadMore: { prevRecommIds: [firstRecommId, secondRecommId], loadMoreCount } };	×
107	} else {
108	return { excludedPostIds, loadMore: { prevRecommIds: [firstRecommId, secondRecommId], loadMoreCount } };	×
109	}
110	}
111	}
112	}
113
114	export const stickiedPostTerms: PostsViewTerms = {	18✔
115	view: 'stickied',
116	limit: 4, // seriously, shouldn't have more than 4 stickied posts
117	forum: true
118	};
119
120	export const RecombeePostsList = ({ algorithm, settings, limit = 15, showRecommendationIcon = false, classes }: {	18!
121	algorithm: string,
122	settings: RecombeeConfiguration,
123	limit?: number,
124	showRecommendationIcon?: boolean,
125	classes: ClassesType<typeof styles>,
126	}) => {
127	const { LoadMore, PostsItem, SectionFooter, PostsLoading } = Components;	×
128
129	const [loadMoreCount, setLoadMoreCount] = useState(1);	×
NEW 130	const currentUser = useCurrentUser();	×
131
132	const recombeeSettings = { ...settings, scenario: algorithm };	×
133
134	const resolverName = algorithm === 'recombee-hybrid'	×
135	? HYBRID_RESOLVER_NAME	×
136	: DEFAULT_RESOLVER_NAME;
137
138	const query = getRecombeePostsQuery(resolverName);	×
139	const { data, loading, fetchMore, networkStatus } = useQuery(query, {	×
140	notifyOnNetworkStatusChange: true,
141	pollInterval: 0,
142	variables: {
143	limit,
144	settings: recombeeSettings,
145	},
146	});
147
148	const results: RecommendedPost[] \| undefined = data?.[resolverName]?.results;	×
149
NEW 150	const hiddenPostIds = currentUser?.hiddenPostsMetadata?.map(metadata => metadata.postId) ?? [];	×
151
152	//exclude posts with hiddenPostIds
NEW 153	const filteredResults = results?.filter(({ post }) => !hiddenPostIds.includes(post._id));	×
154
NEW 155	const postIds = filteredResults?.map(({post}) => post._id) ?? [];	×
NEW 156	const postIdsWithScenario = filteredResults?.map(({ post, scenario, curated, stickied, generatedAt }, idx) => {	×
157	let loggedScenario = scenario;	×
158	if (!loggedScenario) {	×
NEW 159	if (post._id === aboutPostIdSetting.get() && idx === 0) {	×
NEW 160	loggedScenario = 'welcome-post';	×
NEW 161	} else if (curated) {	×
162	loggedScenario = 'curated';	×
163	} else if (stickied) {	×
164	loggedScenario = 'stickied';	×
165	} else {
166	loggedScenario = 'hacker-news';	×
167	}
168	}
169
170	const data = { postId: post._id, scenario: loggedScenario };	×
171
172	if (generatedAt) {	×
173	return {...data, generatedAt: new Date(generatedAt).toISOString()};	×
174	}
175
176	return data;	×
177	}) ?? [];
178
179	useOnMountTracking({	×
180	eventType: "postList",
181	// TODO: Remove postIds which is redundant once analytics dashboard written to use postIdsWithScenario
182	eventProps: { postIds, postIdsWithScenario, algorithm },
183	captureOnMount: (eventProps) => eventProps.postIds.length > 0,	×
184	skip: !postIds.length \|\| loading,	×
185	});
186
NEW 187	if (loading && !filteredResults) {	×
188	return <PostsLoading placeholderCount={limit} />;	×
189	}
190
NEW 191	if (!filteredResults) {	×
192	return null;	×
193	}
194
UNCOV 195	return <div>	×
196	<div className={classes.root}>
NEW 197	{filteredResults.map(({ post, recommId, curated, stickied }) => <PostsItem	×
198	key={post._id}
199	post={post}
200	recombeeRecommId={recommId}
201	curatedIconLeft={curated}
202	showRecommendationIcon={showRecommendationIcon}
203	emphasizeIfNew={true}
204	terms={stickied ? stickiedPostTerms : undefined}	×
205	/>)}
206	</div>
207	<SectionFooter>
208	<LoadMore
209	loading={loading \|\| networkStatus === NetworkStatus.fetchMore}	×
210	loadMore={() => {
NEW 211	const loadMoreSettings = getLoadMoreSettings(resolverName, filteredResults, loadMoreCount);	×
212	void fetchMore({	×
213	variables: {
214	settings: { ...recombeeSettings, ...loadMoreSettings },
215	},
216	// Update the apollo cache with the combined results of previous loads and the items returned by the current loadMore
217	updateQuery: (prev: AnyBecauseHard, { fetchMoreResult }: AnyBecauseHard) => {
218	setLoadMoreCount(loadMoreCount + 1);	×
219
220	if (!fetchMoreResult) return prev;	×
221
222	return {	×
223	[resolverName]: {
224	__typename: fetchMoreResult[resolverName].__typename,
225	results: [...prev[resolverName].results, ...fetchMoreResult[resolverName].results]
226	}
227	};
228	}
229	});
230	}}
231	sectionFooterStyles
232	/>
233	</SectionFooter>
234	</div>;
235	}
236
237	const RecombeePostsListComponent = registerComponent('RecombeePostsList', RecombeePostsList, {styles});	18✔
238
239	declare global {
240	interface ComponentTypes {
241	RecombeePostsList: typeof RecombeePostsListComponent
242	}
243	}

ForumMagnum / ForumMagnum / 9750722561

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous