9963184119

Committed 16 Jul 2024 07:50PM UTC coverage: 31.861% (-2.0%) from 33.852%

Build # 9963184119

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #9506 from ForumMagnum/clean-up-console-and-error-log-spam

clean up console and sentry log spam

Run Details

4903 of 40258 branches covered (12.18%)

Branch coverage included in aggregate %.

0 of 6 new or added lines in 1 file covered. (0.0%)

1 existing line in 1 file now uncovered.

28606 of 64916 relevant lines covered (44.07%)

180.32 hits per line

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

12.7

/packages/lesswrong/lib/recombee/client.ts

import { AddDetailView, AddRating, ApiClient, SetViewPortion } from 'recombee-js-api-client';
import { captureException } from '@sentry/core';
import { recombeeDatabaseIdSetting, recombeePublicApiTokenSetting } from '../instanceSettings';

export interface RecombeeViewPortionProps {
  timestamp: Date;
  userId: string;
  postId: string;
  portion: number;
  recommId?: string;
}

const getRecombeeClientOrThrow = (() => {
  let client: ApiClient;

  return () => {
    if (!client) {
      const databaseId = recombeeDatabaseIdSetting.get();
      const apiToken = recombeePublicApiTokenSetting.get();

      if (!databaseId || !apiToken) {
        throw new Error('Missing either databaseId or api token when initializing Recombee client!');
      }
      
      // TODO - pull out client options like region to db settings?
      client = new ApiClient(databaseId, apiToken, { region: 'us-west' });
    }

    return client;
  };
})();

const voteTypeRatingsMap: Partial<Record<string, number>> = {
  bigDownvote: -1,
  smallDownvote: -0.5,
  neutral: 0,
  smallUpvote: 0.5,
  bigUpvote: 1,
};

const recombeeRequestHelpers = {
  createViewPortionRequest(viewPortionProps: RecombeeViewPortionProps) {
    const { userId, postId, portion, timestamp, recommId } = viewPortionProps;
    return new SetViewPortion(userId, postId, portion, {
      timestamp: timestamp.toISOString(), 
      cascadeCreate: false,
      recommId: recommId
    });
  },

  createDetailViewRequest(postId: string, userId: string, recommId?: string) {
    return new AddDetailView(userId, postId, {
      timestamp: new Date().toISOString(),
      recommId,
      cascadeCreate: false
    });
  },

  createRatingRequest(postId: string, userId: string, voteType: string, recommId?: string) {
    const rating = voteTypeRatingsMap[voteType];
    if (typeof rating !== 'number') {
      // eslint-disable-next-line no-console
      console.log(`Attempted to create a recombee rating request for a non-karma vote on post with id ${postId}, voteType: ${voteType}`);
      return;
    }

    return new AddRating(userId, postId, rating, {
      timestamp: new Date().toISOString(),
      recommId,
      cascadeCreate: false
    });
  },

  shouldLogRecombeeError(error: AnyBecauseIsInput) {
    // If there isn't a statusCode, then it's not a standard recombee error and we should definitely log it to Sentry
    // 404 generally indicates a missing userId or itemId with cascadeCreate not set to true
    // This can happen if we've e.g. failed to prevent an event from getting sent for a post that shouldn't (and doesn't) exist in recombee
    // 409 generally indicates we're trying to create/set something which already exists in recombee, i.e. a detail view for a given post by a given user
    // See https://docs.recombee.com/api for more specific details
    return !('statusCode' in error) || (error.statusCode !== 404 && error.statusCode !== 409);
  },
}


const recombeeApi = {
  async createViewPortion(viewPortionProps: RecombeeViewPortionProps) {
    const client = getRecombeeClientOrThrow();
    const request = recombeeRequestHelpers.createViewPortionRequest(viewPortionProps);

    try {
      await client.send(request);
    } catch (error) {
      if (recombeeRequestHelpers.shouldLogRecombeeError(error)) {
        captureException(error);
      }
    }
  },

  async createDetailView(postId: string, userId: string, recommId?: string) {
    const client = getRecombeeClientOrThrow();
    const request = recombeeRequestHelpers.createDetailViewRequest(postId, userId, recommId);

    try {
      await client.send(request);
    } catch (error) {
      if (recombeeRequestHelpers.shouldLogRecombeeError(error)) {
        captureException(error);
      }
    }
  },

  async createRating(postId: string, userId: string, voteType: string, recommId?: string) {
    const client = getRecombeeClientOrThrow();
    const request = recombeeRequestHelpers.createRatingRequest(postId, userId, voteType, recommId);
    if (!request) {
      return;
    }

    try {
      await client.send(request);
    } catch (error) {
      if (recombeeRequestHelpers.shouldLogRecombeeError(error)) {
        captureException(error);
      }
    }
  },
}

export { recombeeRequestHelpers, recombeeApi }

1	import { AddDetailView, AddRating, ApiClient, SetViewPortion } from 'recombee-js-api-client';	54✔
2	import { captureException } from '@sentry/core';	18✔
3	import { recombeeDatabaseIdSetting, recombeePublicApiTokenSetting } from '../instanceSettings';	18✔
4
5	export interface RecombeeViewPortionProps {
6	timestamp: Date;
7	userId: string;
8	postId: string;
9	portion: number;
10	recommId?: string;
11	}
12
13	const getRecombeeClientOrThrow = (() => {	18✔
14	let client: ApiClient;
15
16	return () => {	18✔
17	if (!client) {	×
18	const databaseId = recombeeDatabaseIdSetting.get();	×
19	const apiToken = recombeePublicApiTokenSetting.get();	×
20
21	if (!databaseId \|\| !apiToken) {	×
22	throw new Error('Missing either databaseId or api token when initializing Recombee client!');	×
23	}
24
25	// TODO - pull out client options like region to db settings?
26	client = new ApiClient(databaseId, apiToken, { region: 'us-west' });	×
27	}
28
29	return client;	×
30	};
31	})();
32
33	const voteTypeRatingsMap: Partial<Record<string, number>> = {	18✔
34	bigDownvote: -1,
35	smallDownvote: -0.5,
36	neutral: 0,
37	smallUpvote: 0.5,
38	bigUpvote: 1,
39	};
40
41	const recombeeRequestHelpers = {	18✔
42	createViewPortionRequest(viewPortionProps: RecombeeViewPortionProps) {
43	const { userId, postId, portion, timestamp, recommId } = viewPortionProps;	×
44	return new SetViewPortion(userId, postId, portion, {	×
45	timestamp: timestamp.toISOString(),
46	cascadeCreate: false,
47	recommId: recommId
48	});
49	},
50
51	createDetailViewRequest(postId: string, userId: string, recommId?: string) {
52	return new AddDetailView(userId, postId, {	×
53	timestamp: new Date().toISOString(),
54	recommId,
55	cascadeCreate: false
56	});
57	},
58
59	createRatingRequest(postId: string, userId: string, voteType: string, recommId?: string) {
60	const rating = voteTypeRatingsMap[voteType];	×
61	if (typeof rating !== 'number') {	×
62	// eslint-disable-next-line no-console
63	console.log(`Attempted to create a recombee rating request for a non-karma vote on post with id ${postId}, voteType: ${voteType}`);	×
64	return;	×
65	}
66
67	return new AddRating(userId, postId, rating, {	×
68	timestamp: new Date().toISOString(),
69	recommId,
70	cascadeCreate: false
71	});
72	},
73
74	shouldLogRecombeeError(error: AnyBecauseIsInput) {
75	// If there isn't a statusCode, then it's not a standard recombee error and we should definitely log it to Sentry
76	// 404 generally indicates a missing userId or itemId with cascadeCreate not set to true
77	// This can happen if we've e.g. failed to prevent an event from getting sent for a post that shouldn't (and doesn't) exist in recombee
78	// 409 generally indicates we're trying to create/set something which already exists in recombee, i.e. a detail view for a given post by a given user
79	// See https://docs.recombee.com/api for more specific details
NEW 80	return !('statusCode' in error) \|\| (error.statusCode !== 404 && error.statusCode !== 409);	×
81	},
82	}
83
84
85	const recombeeApi = {	18✔
86	async createViewPortion(viewPortionProps: RecombeeViewPortionProps) {
87	const client = getRecombeeClientOrThrow();	×
88	const request = recombeeRequestHelpers.createViewPortionRequest(viewPortionProps);	×
89
90	try {	×
91	await client.send(request);	×
92	} catch (error) {
NEW 93	if (recombeeRequestHelpers.shouldLogRecombeeError(error)) {	×
UNCOV 94	captureException(error);	×
95	}
96	}
97	},
98
99	async createDetailView(postId: string, userId: string, recommId?: string) {
100	const client = getRecombeeClientOrThrow();	×
101	const request = recombeeRequestHelpers.createDetailViewRequest(postId, userId, recommId);	×
102
103	try {	×
104	await client.send(request);	×
105	} catch (error) {
NEW 106	if (recombeeRequestHelpers.shouldLogRecombeeError(error)) {	×
NEW 107	captureException(error);	×
108	}
109	}
110	},
111
112	async createRating(postId: string, userId: string, voteType: string, recommId?: string) {
113	const client = getRecombeeClientOrThrow();	×
114	const request = recombeeRequestHelpers.createRatingRequest(postId, userId, voteType, recommId);	×
115	if (!request) {	×
116	return;	×
117	}
118
119	try {	×
120	await client.send(request);	×
121	} catch (error) {
NEW 122	if (recombeeRequestHelpers.shouldLogRecombeeError(error)) {	×
NEW 123	captureException(error);	×
124	}
125	}
126	},
127	}
128
129	export { recombeeRequestHelpers, recombeeApi }

ForumMagnum / ForumMagnum / 9963184119

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