Skip to content

chore: ranking vars now accepts both string and Record #616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
itsmeadi merged 2 commits into from
Feb 20, 2025
Merged

chore: ranking vars now accepts both string and Record #616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
781ca39
chore: ranking vars now accept both string and maps
Feb 20, 2025
53e1208
chore: ranking vars add tests
Feb 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions src/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -503,7 +503,7 @@ export class StreamClient<StreamFeedGenerics extends DefaultGenerics = DefaultGe
}

replaceReactionOptions = (options: {
rankingVars?: Record<string, string | number>;
rankingVars?: string | Record<string, string | number>;
reactionKindsFilter?: string[];
reactions?: Record<string, string | boolean | string[] | Record<string, string | number>>;
withOwnChildren?: boolean;
Expand All @@ -522,7 +522,15 @@ export class StreamClient<StreamFeedGenerics extends DefaultGenerics = DefaultGe
options.withRecentReactions = options.reactions.recent as boolean;
}
if (options.reactions.ranking_vars != null) {
options.rankingVars = options.reactions.ranking_vars as Record<string, string | number>;
if (typeof options.reactions.ranking_vars === 'object') {
options.rankingVars = options.reactions.ranking_vars as Record<string, string | number>;
} else if (typeof options.reactions.ranking_vars === 'string') {
options.rankingVars = options.reactions.ranking_vars as string;
}
}
// if ranking vars are Record, json stringify them
if (options.rankingVars && typeof options.rankingVars === 'object') {
options.rankingVars = JSON.stringify(options.rankingVars);
}
if (options.reactions.score_vars != null) {
options.withScoreVars = options.reactions.score_vars as boolean;
Expand Down
2 changes: 1 addition & 1 deletion src/feed.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ export type FeedPaginationOptions = {
export type RankedFeedOptions = {
offset?: number;
ranking?: string;
rankingVars?: Record<string, string | number>;
rankingVars?: string | Record<string, string | number>;
session?: string;
withScoreVars?: boolean;
};
Expand Down
30 changes: 30 additions & 0 deletions test/integration/cloud/reaction.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,36 @@ describe('Reaction pagination', () => {
});
});

describe('#withRankingVarsAsMap', () => {
ctx.requestShouldNotError(async () => {
ctx.response = await ctx.bob.feed('user', ctx.alice.userId).get({
reactions: { score_vars: true },
limit: 4,
offset: 2,
rankingVars: { popular: 1, music: 4 },
});
});
});
describe('#withRankingVarsShouldErr', () => {
ctx.requestShouldError(400, async () => {
ctx.response = await ctx.bob.feed('user', ctx.alice.userId).get({
reactions: { score_vars: true },
limit: 4,
offset: 2,
rankingVars: ['popular', 1],
});
});
});
describe('#withRankingVarsAsString', () => {
ctx.requestShouldNotError(async () => {
ctx.response = await ctx.bob.feed('user', ctx.alice.userId).get({
reactions: { score_vars: true },
limit: 4,
offset: 2,
rankingVars: '{"sports":1,"music":4}',
});
});
});
describe('When bob reads alice her feed with all enrichment enabled', () => {
ctx.requestShouldNotError(async () => {
ctx.response = await ctx.bob.feed('user', ctx.alice.userId).get({
Expand Down