9103385347

Committed 15 May 2024 10:16PM UTC coverage: 31.857% (-0.07%) from 31.931%

Build # 9103385347

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #9286 from ForumMagnum/cached-for-non-hybrid-recommendations

implement caching for non-hybrid recommendations feed

Run Details

4784 of 39136 branches covered (12.22%)

Branch coverage included in aggregate %.

0 of 41 new or added lines in 2 files covered. (0.0%)

3 existing lines in 1 file now uncovered.

27828 of 63235 relevant lines covered (44.01%)

179.4 hits per line

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

12.6

/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';

// 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 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 postIds = results?.map(({post}) => post._id) ?? [];
  const postIdsWithScenario = results?.map(({ post, scenario, curated, stickied }) => {
    let loggedScenario = scenario;
    if (!loggedScenario) {
      if (curated) {
        loggedScenario = 'curated';
      } else if (stickied) {
        loggedScenario = 'stickied';
      } else {
        loggedScenario = 'hacker-news';
      }
    }
    
    return { postId: post._id, scenario: loggedScenario };
  }) ?? [];

  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 && !results) {
    return <PostsLoading placeholderCount={limit} />;
  }

  if (!results) {
    return null;
  }


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

ForumMagnum / ForumMagnum / 9103385347

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