chore: ranking vars now accepts only json string (#616)

* chore: ranking vars now accept both string and maps

* chore: ranking vars add tests

---------

Co-authored-by: aditya <[email protected]>

Author: itsmeadi

src/client.ts

@@ -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;
@@ -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;

src/feed.ts

@@ -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;
 };

test/integration/cloud/reaction.js

@@ -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({