@stream-io/feeds-client 0.2.0 → 0.2.1

package/src/feed/event-handlers/activity/handle-activity-pinned.test.ts

@@ -0,0 +1,60 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+
+import { Feed } from '../../../feed';
+import { FeedsClient } from '../../../feeds-client';
+import { handleActivityPinned } from './handle-activity-pinned';
+import {
+  generateActivityPinnedEvent,
+  generateActivityPinResponse,
+  generateFeedResponse,
+} from '../../../test-utils/response-generators';
+import { ActivityPinResponse } from '../../../gen/models';
+
+describe(handleActivityPinned.name, () => {
+  let feed: Feed;
+  let client: FeedsClient;
+  let pinnedActivity: ActivityPinResponse;
+  let otherPinnedActivity: ActivityPinResponse;
+
+  beforeEach(() => {
+    client = new FeedsClient('mock-api-key');
+    const feedResponse = generateFeedResponse({ id: 'main', group_id: 'user' });
+    feed = new Feed(
+      client,
+      feedResponse.group_id,
+      feedResponse.id,
+      feedResponse,
+    );
+    pinnedActivity = generateActivityPinResponse();
+    otherPinnedActivity = generateActivityPinResponse();
+    feed.state.next((currentState) => ({
+      ...currentState,
+      pinned_activities: [otherPinnedActivity],
+    }));
+  });
+
+  it('adds a new activity to pinned_activities', () => {
+    const event = generateActivityPinnedEvent({
+      pinned_activity: pinnedActivity,
+    });
+    handleActivityPinned.call(feed, event);
+    const { pinned_activities } = feed.currentState;
+    expect(pinned_activities).toHaveLength(2);
+    expect(pinned_activities![0].activity.id).toBe(pinnedActivity.activity.id);
+    expect(pinned_activities![1]).toBe(otherPinnedActivity);
+  });
+
+  it('creates pinned_activities if it was undefined', () => {
+    feed.state.next((currentState) => ({
+      ...currentState,
+      pinned_activities: undefined,
+    }));
+    const event = generateActivityPinnedEvent({
+      pinned_activity: pinnedActivity,
+    });
+    handleActivityPinned.call(feed, event);
+    const { pinned_activities } = feed.currentState;
+    expect(pinned_activities).toHaveLength(1);
+    expect(pinned_activities![0].activity.id).toBe(pinnedActivity.activity.id);
+  });
+});

package/src/feed/event-handlers/activity/handle-activity-pinned.ts

@@ -0,0 +1,30 @@
+import { ActivityPinResponse } from '../../../gen/models';
+import { EventPayload } from '../../../types-internal';
+import { Feed } from '../../feed';
+
+export function handleActivityPinned(
+  this: Feed,
+  event: EventPayload<'feeds.activity.pinned'>,
+) {
+  this.state.next((currentState) => {
+    const newState = {
+      ...currentState,
+    };
+
+    // FIXME: type mismatch PinActivityResponse vs ActivityPinResponse (almost identical but not quite)
+
+    // re-map the event value to match the ActivityPinResponse type
+    const pinnedActivity: ActivityPinResponse = {
+      ...event.pinned_activity,
+      user: event.user!,
+      feed: event.fid,
+      updated_at: new Date(),
+    };
+
+    newState.pinned_activities = currentState.pinned_activities
+      ? [pinnedActivity, ...currentState.pinned_activities]
+      : [pinnedActivity];
+
+    return newState;
+  });
+}

package/src/feed/event-handlers/activity/handle-activity-reaction-added.test.ts

@@ -0,0 +1,157 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import { Feed } from '../../../feed';
+import { FeedsClient } from '../../../feeds-client';
+import { handleActivityReactionAdded } from './handle-activity-reaction-added';
+import {
+  generateActivityPinResponse,
+  generateActivityResponse,
+  generateFeedResponse,
+  generateOwnUser,
+  generateActivityReactionAddedEvent,
+  getHumanId,
+} from '../../../test-utils/response-generators';
+
+describe(handleActivityReactionAdded.name, () => {
+  let feed: Feed;
+  let client: FeedsClient;
+  let currentUserId: string;
+
+  beforeEach(() => {
+    client = new FeedsClient('mock-api-key');
+    currentUserId = getHumanId();
+    client.state.partialNext({
+      connected_user: generateOwnUser({ id: currentUserId }),
+    });
+    const feedResponse = generateFeedResponse({
+      id: 'main',
+      group_id: 'user',
+      created_by: { id: currentUserId },
+    });
+    feed = new Feed(
+      client,
+      feedResponse.group_id,
+      feedResponse.id,
+      feedResponse,
+    );
+  });
+
+  it('adds a reaction to the correct activity for current user & updates activities with event.activity', () => {
+    const event = generateActivityReactionAddedEvent({
+      reaction: {
+        user: { id: currentUserId },
+      },
+      activity: {
+        reaction_count: 1,
+      },
+    });
+    const activity = generateActivityResponse({
+      id: event.activity.id,
+      reaction_count: 0,
+    });
+    const activityPin = generateActivityPinResponse({
+      activity: { ...activity },
+    });
+    feed.state.partialNext({
+      activities: [activity],
+      pinned_activities: [activityPin],
+    });
+
+    const stateBefore = feed.currentState;
+
+    expect(stateBefore.activities![0].reaction_count).toEqual(0);
+    expect(stateBefore.pinned_activities![0].activity.reaction_count).toEqual(
+      0,
+    );
+
+    handleActivityReactionAdded.call(feed, event);
+
+    const stateAfter = feed.currentState;
+
+    expect(stateAfter.activities![0].own_reactions).toContain(event.reaction);
+    expect(stateAfter.pinned_activities![0].activity.own_reactions).toContain(
+      event.reaction,
+    );
+    expect(stateAfter.activities![0].own_bookmarks).toEqual(
+      stateBefore.activities![0].own_bookmarks,
+    );
+    expect(stateAfter.pinned_activities![0].activity.own_bookmarks).toEqual(
+      stateBefore.pinned_activities![0].activity.own_bookmarks,
+    );
+    expect(stateAfter.activities![0].reaction_count).toEqual(1);
+    expect(stateAfter.pinned_activities![0].activity.reaction_count).toEqual(1);
+  });
+
+  it('does not add to own_reactions if reaction is from another user but still updates activity', () => {
+    const event = generateActivityReactionAddedEvent({
+      reaction: { user: { id: 'other-user-id' } },
+      activity: {
+        reaction_count: 1,
+      },
+    });
+    const activity = generateActivityResponse({
+      id: event.activity.id,
+      reaction_count: 0,
+    });
+    const activityPin = generateActivityPinResponse({
+      activity: { ...activity },
+    });
+    feed.state.partialNext({
+      activities: [activity],
+      pinned_activities: [activityPin],
+    });
+
+    const stateBefore = feed.currentState;
+
+    expect(stateBefore.activities![0].reaction_count).toEqual(0);
+    expect(stateBefore.pinned_activities![0].activity.reaction_count).toEqual(
+      0,
+    );
+
+    handleActivityReactionAdded.call(feed, event);
+
+    const stateAfter = feed.currentState;
+
+    expect(stateAfter.activities![0].own_reactions).toHaveLength(0);
+    expect(
+      stateAfter.pinned_activities![0].activity.own_reactions,
+    ).toHaveLength(0);
+    expect(stateAfter.activities![0].reaction_count).toEqual(1);
+    expect(stateAfter.pinned_activities![0].activity.reaction_count).toEqual(1);
+    expect(stateAfter.activities![0].own_bookmarks).toEqual(
+      stateBefore.activities![0].own_bookmarks,
+    );
+    expect(stateAfter.pinned_activities![0].activity.own_bookmarks).toEqual(
+      stateBefore.pinned_activities![0].activity.own_bookmarks,
+    );
+    expect(stateAfter.activities![0].own_reactions).toEqual(
+      stateBefore.activities![0].own_reactions,
+    );
+    expect(stateAfter.pinned_activities![0].activity.own_reactions).toEqual(
+      stateBefore.pinned_activities![0].activity.own_reactions,
+    );
+  });
+
+  it('does nothing if activity is not found', () => {
+    const event = generateActivityReactionAddedEvent({
+      reaction: { user: { id: currentUserId } },
+    });
+    const activity = generateActivityResponse({
+      id: 'unrelated',
+    });
+    const activityPin = generateActivityPinResponse({
+      activity: { ...activity },
+    });
+    feed.state.partialNext({
+      activities: [activity],
+      pinned_activities: [activityPin],
+    });
+
+    const stateBefore = feed.currentState;
+
+    handleActivityReactionAdded.call(feed, event);
+
+    const stateAfter = feed.currentState;
+
+    expect(stateAfter).toEqual(stateBefore);
+  });
+});

package/src/feed/event-handlers/activity/handle-activity-reaction-added.ts

@@ -1,67 +1,109 @@
 import type { Feed } from '../../../feed';
 import type {
+  ActivityPinResponse,
   ActivityReactionAddedEvent,
   ActivityResponse,
 } from '../../../gen/models';
-import type { EventPayload, UpdateStateResult } from '../../../types-internal';
+import type { EventPayload } from '../../../types-internal';
+import { updateEntityInArray } from '../../../utils';
 
-import { updateActivityInState } from './handle-activity-updated';
+// shared function to update the activity with the new reaction
+const sharedUpdateActivity = ({
+  currentActivity,
+  event,
+  eventBelongsToCurrentUser,
+}: {
+  currentActivity: ActivityResponse;
+  event: ActivityReactionAddedEvent;
+  eventBelongsToCurrentUser: boolean;
+}) => {
+  let newOwnReactions = currentActivity.own_reactions;
 
-export const addReactionToActivity = (
-  event: ActivityReactionAddedEvent,
-  activity: ActivityResponse,
-  isCurrentUser: boolean,
-): UpdateStateResult<ActivityResponse> => {
-  // Update own_reactions if the reaction is from the current user
-  const ownReactions = [...(activity.own_reactions || [])];
-  if (isCurrentUser) {
-    ownReactions.push(event.reaction);
+  if (eventBelongsToCurrentUser) {
+    newOwnReactions = [...currentActivity.own_reactions, event.reaction];
   }
 
   return {
-    ...activity,
-    own_reactions: ownReactions,
-    latest_reactions: event.activity.latest_reactions,
-    reaction_groups: event.activity.reaction_groups,
-    changed: true,
+    ...event.activity,
+    own_reactions: newOwnReactions,
+    own_bookmarks: currentActivity.own_bookmarks,
   };
 };
 
 export const addReactionToActivities = (
   event: ActivityReactionAddedEvent,
   activities: ActivityResponse[] | undefined,
-  isCurrentUser: boolean,
-): UpdateStateResult<{ activities: ActivityResponse[] }> => {
-  if (!activities) {
-    return { changed: false, activities: [] };
-  }
+  eventBelongsToCurrentUser: boolean,
+) =>
+  updateEntityInArray({
+    entities: activities,
+    matcher: (activity) => activity.id === event.activity.id,
+    updater: (matchedActivity) =>
+      sharedUpdateActivity({
+        currentActivity: matchedActivity,
+        event,
+        eventBelongsToCurrentUser,
+      }),
+  });
 
-  const activityIndex = activities.findIndex((a) => a.id === event.activity.id);
-  if (activityIndex === -1) {
-    return { changed: false, activities };
-  }
+export const addReactionToPinnedActivities = (
+  event: ActivityReactionAddedEvent,
+  pinnedActivities: ActivityPinResponse[] | undefined,
+  eventBelongsToCurrentUser: boolean,
+) =>
+  updateEntityInArray({
+    entities: pinnedActivities,
+    matcher: (pinnedActivity) =>
+      pinnedActivity.activity.id === event.activity.id,
+    updater: (matchedPinnedActivity) => {
+      const newActivity = sharedUpdateActivity({
+        currentActivity: matchedPinnedActivity.activity,
+        event,
+        eventBelongsToCurrentUser,
+      });
 
-  const activity = activities[activityIndex];
-  const updatedActivity = addReactionToActivity(event, activity, isCurrentUser);
-  return updateActivityInState(updatedActivity, activities, true);
-};
+      // this should never happen, but just in case
+      if (newActivity === matchedPinnedActivity.activity) {
+        return matchedPinnedActivity;
+      }
+
+      return {
+        ...matchedPinnedActivity,
+        activity: newActivity,
+      };
+    },
+  });
 
 export function handleActivityReactionAdded(
   this: Feed,
   event: EventPayload<'feeds.activity.reaction.added'>,
 ) {
-  const currentActivities = this.currentState.activities;
+  const {
+    activities: currentActivities,
+    pinned_activities: currentPinnedActivities,
+  } = this.currentState;
   const connectedUser = this.client.state.getLatestValue().connected_user;
-  const isCurrentUser = Boolean(
-    connectedUser && event.reaction.user.id === connectedUser.id,
-  );
+  const eventBelongsToCurrentUser =
+    typeof connectedUser !== 'undefined' &&
+    event.reaction.user.id === connectedUser.id;
+
+  const [result1, result2] = [
+    addReactionToActivities(
+      event,
+      currentActivities,
+      eventBelongsToCurrentUser,
+    ),
+    addReactionToPinnedActivities(
+      event,
+      currentPinnedActivities,
+      eventBelongsToCurrentUser,
+    ),
+  ];
 
-  const result = addReactionToActivities(
-    event,
-    currentActivities,
-    isCurrentUser,
-  );
-  if (result.changed) {
-    this.state.partialNext({ activities: result.activities });
+  if (result1.changed || result2.changed) {
+    this.state.partialNext({
+      activities: result1.entities,
+      pinned_activities: result2.entities,
+    });
   }
 }

package/src/feed/event-handlers/activity/handle-activity-reaction-deleted.test.ts

@@ -0,0 +1,200 @@
+import { describe, it, expect, beforeEach } from 'vitest';
+import { Feed } from '../../../feed';
+import { FeedsClient } from '../../../feeds-client';
+import { handleActivityReactionDeleted } from './handle-activity-reaction-deleted';
+import {
+  generateActivityPinResponse,
+  generateActivityResponse,
+  generateFeedReactionResponse,
+  generateFeedResponse,
+  generateOwnUser,
+  getHumanId,
+  generateActivityReactionDeletedEvent,
+} from '../../../test-utils/response-generators';
+
+describe(handleActivityReactionDeleted.name, () => {
+  let feed: Feed;
+  let client: FeedsClient;
+  let currentUserId: string;
+
+  beforeEach(() => {
+    client = new FeedsClient('mock-api-key');
+    currentUserId = getHumanId();
+    client.state.partialNext({
+      connected_user: generateOwnUser({ id: currentUserId }),
+    });
+    const feedResponse = generateFeedResponse({
+      id: 'main',
+      group_id: 'user',
+      created_by: { id: currentUserId },
+    });
+    feed = new Feed(
+      client,
+      feedResponse.group_id,
+      feedResponse.id,
+      feedResponse,
+    );
+  });
+
+  it('removes a reaction from the correct activity for current user & updates activities with event.activity', () => {
+    const event = generateActivityReactionDeletedEvent({
+      activity: {
+        reaction_count: 0,
+      },
+      reaction: {
+        type: 'like',
+        user: { id: currentUserId },
+      },
+      user: { id: currentUserId },
+    });
+
+    const activity = generateActivityResponse({
+      reaction_count: 1,
+      own_reactions: [
+        generateFeedReactionResponse({
+          type: 'like',
+          user: { id: currentUserId },
+          activity_id: event.activity.id,
+        }),
+      ],
+      id: event.activity.id,
+    });
+    const activityPin = generateActivityPinResponse({
+      activity: { ...activity },
+    });
+    feed.state.partialNext({
+      activities: [activity],
+      pinned_activities: [activityPin],
+    });
+
+    const stateBefore = feed.currentState;
+    expect(stateBefore.activities![0].own_reactions).toHaveLength(1);
+    expect(
+      stateBefore.pinned_activities![0].activity.own_reactions,
+    ).toHaveLength(1);
+    expect(stateBefore.activities![0].reaction_count).toEqual(1);
+    expect(stateBefore.pinned_activities![0].activity.reaction_count).toEqual(
+      1,
+    );
+
+    handleActivityReactionDeleted.call(feed, event);
+
+    const stateAfter = feed.currentState;
+    expect(stateAfter.activities![0].own_reactions).toHaveLength(0);
+    expect(
+      stateAfter.pinned_activities![0].activity.own_reactions,
+    ).toHaveLength(0);
+    expect(stateAfter.activities![0].reaction_count).toEqual(0);
+    expect(stateAfter.pinned_activities![0].activity.reaction_count).toEqual(0);
+    expect(stateAfter.activities![0].own_bookmarks).toEqual(
+      stateBefore.activities![0].own_bookmarks,
+    );
+    expect(stateAfter.pinned_activities![0].activity.own_bookmarks).toEqual(
+      stateBefore.pinned_activities![0].activity.own_bookmarks,
+    );
+  });
+
+  it('does not remove from own_reactions if reaction is from another user but still updates activity', () => {
+    const event = generateActivityReactionDeletedEvent({
+      activity: {
+        reaction_count: 0,
+      },
+      reaction: {
+        type: 'like',
+        user: { id: 'other-user-id' },
+      },
+      user: { id: 'other-user-id' },
+    });
+
+    const activity = generateActivityResponse({
+      reaction_count: 1,
+      own_reactions: [
+        generateFeedReactionResponse({
+          type: 'like',
+          user: { id: currentUserId },
+          activity_id: event.activity.id,
+        }),
+      ],
+      id: event.activity.id,
+    });
+    const activityPin = generateActivityPinResponse({
+      activity: { ...activity },
+    });
+    feed.state.partialNext({
+      activities: [activity],
+      pinned_activities: [activityPin],
+    });
+
+    const stateBefore = feed.currentState;
+    expect(stateBefore.activities![0].own_reactions).toHaveLength(1);
+    expect(
+      stateBefore.pinned_activities![0].activity.own_reactions,
+    ).toHaveLength(1);
+    expect(stateBefore.activities![0].reaction_count).toEqual(1);
+    expect(stateBefore.pinned_activities![0].activity.reaction_count).toEqual(
+      1,
+    );
+
+    handleActivityReactionDeleted.call(feed, event);
+
+    const stateAfter = feed.currentState;
+    expect(stateAfter.activities![0].own_reactions).toHaveLength(1);
+    expect(stateAfter.activities![0].own_reactions).toEqual(
+      stateBefore.activities![0].own_reactions,
+    );
+    expect(stateAfter.pinned_activities![0].activity.own_reactions).toEqual(
+      stateBefore.pinned_activities![0].activity.own_reactions,
+    );
+    expect(stateAfter.activities![0].own_bookmarks).toEqual(
+      stateBefore.activities![0].own_bookmarks,
+    );
+    expect(stateAfter.pinned_activities![0].activity.own_bookmarks).toEqual(
+      stateBefore.pinned_activities![0].activity.own_bookmarks,
+    );
+    expect(
+      stateAfter.pinned_activities![0].activity.own_reactions,
+    ).toHaveLength(1);
+    expect(stateAfter.activities![0].reaction_count).toEqual(0);
+    expect(stateAfter.pinned_activities![0].activity.reaction_count).toEqual(0);
+  });
+
+  it('does nothing if activity is not found', () => {
+    const event = generateActivityReactionDeletedEvent({
+      activity: {
+        reaction_count: 0,
+      },
+      reaction: {
+        type: 'like',
+        user: { id: currentUserId },
+      },
+      user: { id: currentUserId },
+    });
+
+    const activity = generateActivityResponse({
+      reaction_count: 1,
+      own_reactions: [
+        generateFeedReactionResponse({
+          type: 'like',
+          user: { id: currentUserId },
+          activity_id: 'activity1',
+        }),
+      ],
+      id: 'activity1',
+    });
+    const activityPin = generateActivityPinResponse({
+      activity: { ...activity },
+    });
+    feed.state.partialNext({
+      activities: [activity],
+      pinned_activities: [activityPin],
+    });
+
+    const stateBefore = feed.currentState;
+
+    handleActivityReactionDeleted.call(feed, event);
+
+    const stateAfter = feed.currentState;
+
+    expect(stateAfter).toBe(stateBefore);
+  });
+});