refactor: remove stale subscriber count logic and types refactor

GetStream · Nov 14, 2024 · f7c01d4 · f7c01d4
1 parent 3efe254
commit f7c01d4
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 96 deletions.
diff --git a/package/src/components/MessageList/hooks/useMessageList.ts b/package/src/components/MessageList/hooks/useMessageList.ts
@@ -1,9 +1,6 @@
 import type { ChannelState, MessageResponse } from 'stream-chat';
 
-import {
-  ChannelContextValue,
-  useChannelContext,
-} from '../../../contexts/channelContext/ChannelContext';
+import { useChannelContext } from '../../../contexts/channelContext/ChannelContext';
 import { useChatContext } from '../../../contexts/chatContext/ChatContext';
 import {
   DeletedMessagesVisibilityType,
@@ -61,7 +58,7 @@ export const useMessageList = <
   const { threadMessages } = useThreadContext<StreamChatGenerics>();
 
   const messageList = threadList ? threadMessages : messages;
-  const readList: ChannelContextValue<StreamChatGenerics>['read'] | undefined = threadList
+  const readList: ChannelState<StreamChatGenerics>['read'] | undefined = threadList
     ? undefined
     : read;
 

diff --git a/package/src/components/MessageList/utils/getReadStates.ts b/package/src/components/MessageList/utils/getReadStates.ts
@@ -1,4 +1,4 @@
-import type { ChannelContextValue } from '../../../contexts/channelContext/ChannelContext';
+import { ChannelState } from 'stream-chat';
 import type { PaginatedMessageListContextValue } from '../../../contexts/paginatedMessageListContext/PaginatedMessageListContext';
 import type { ThreadContextValue } from '../../../contexts/threadContext/ThreadContext';
 import type { DefaultStreamChatGenerics } from '../../../types/types';
@@ -10,7 +10,7 @@ export const getReadStates = <
   messages:
     | PaginatedMessageListContextValue<StreamChatGenerics>['messages']
     | ThreadContextValue<StreamChatGenerics>['threadMessages'],
-  read?: ChannelContextValue<StreamChatGenerics>['read'],
+  read?: ChannelState<StreamChatGenerics>['read'],
 ) => {
   const readData: Record<string, number> = {};
 

diff --git a/package/src/contexts/channelsStateContext/ChannelsStateContext.tsx b/package/src/contexts/channelsStateContext/ChannelsStateContext.tsx
@@ -7,11 +7,11 @@ import React, {
   useReducer,
   useRef,
 } from 'react';
+import { ChannelState as StreamChannelState } from 'stream-chat';
 
 import type { DefaultStreamChatGenerics } from '../../types/types';
 import { ActiveChannelsProvider } from '../activeChannelsRefContext/ActiveChannelsRefContext';
 
-import type { ChannelContextValue } from '../channelContext/ChannelContext';
 import type { PaginatedMessageListContextValue } from '../paginatedMessageListContext/PaginatedMessageListContext';
 import type { ThreadContextValue } from '../threadContext/ThreadContext';
 import type { TypingContextValue } from '../typingContext/TypingContext';
@@ -22,14 +22,13 @@ import { isTestEnvironment } from '../utils/isTestEnvironment';
 export type ChannelState<
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics,
 > = {
-  members: ChannelContextValue<StreamChatGenerics>['members'];
+  members: StreamChannelState<StreamChatGenerics>['members'];
   messages: PaginatedMessageListContextValue<StreamChatGenerics>['messages'];
-  read: ChannelContextValue<StreamChatGenerics>['read'];
-  subscriberCount: number;
+  read: StreamChannelState<StreamChatGenerics>['read'];
   threadMessages: ThreadContextValue<StreamChatGenerics>['threadMessages'];
   typing: TypingContextValue<StreamChatGenerics>['typing'];
-  watcherCount: ChannelContextValue<StreamChatGenerics>['watcherCount'];
-  watchers: ChannelContextValue<StreamChatGenerics>['watchers'];
+  watcherCount: number;
+  watchers: StreamChannelState<StreamChatGenerics>['watchers'];
 };
 
 type ChannelsState<
@@ -56,25 +55,12 @@ type SetStateAction<
   type: 'SET_STATE';
 };
 
-type IncreaseSubscriberCountAction = {
-  payload: { cid: string };
-  type: 'INCREASE_SUBSCRIBER_COUNT';
-};
-type DecreaseSubscriberCountAction = {
-  payload: { cid: string };
-  type: 'DECREASE_SUBSCRIBER_COUNT';
-};
-
 type Action<StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics> =
-  | SetStateAction<StreamChatGenerics>
-  | IncreaseSubscriberCountAction
-  | DecreaseSubscriberCountAction;
+  SetStateAction<StreamChatGenerics>;
 
 export type ChannelsStateContextValue<
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics,
 > = {
-  decreaseSubscriberCount: (value: { cid: string }) => void;
-  increaseSubscriberCount: (value: { cid: string }) => void;
   setState: (value: Payload<Keys, StreamChatGenerics>) => void;
   state: ChannelsState<StreamChatGenerics>;
 };
@@ -95,39 +81,6 @@ function reducer(state: ChannelsState, action: Action) {
         },
       };
 
-    case 'INCREASE_SUBSCRIBER_COUNT': {
-      const currentCount = state[action.payload.cid]?.subscriberCount ?? 0;
-      return {
-        ...state,
-        [action.payload.cid]: {
-          ...(state[action.payload.cid] || {}),
-          subscriberCount: currentCount + 1,
-        },
-      };
-    }
-
-    case 'DECREASE_SUBSCRIBER_COUNT': {
-      const currentCount = state[action.payload.cid]?.subscriberCount ?? 0;
-
-      // If there last subscribed Channel component unsubscribes, we clear the channel state.
-      if (currentCount <= 1) {
-        const stateShallowCopy = {
-          ...state,
-        };
-
-        delete stateShallowCopy[action.payload.cid];
-
-        return stateShallowCopy;
-      }
-
-      return {
-        ...state,
-        [action.payload.cid]: {
-          ...(state[action.payload.cid] || {}),
-          subscriberCount: currentCount - 1,
-        },
-      };
-    }
     default:
       throw new Error();
   }
@@ -150,18 +103,8 @@ export const ChannelsStateProvider = <
     dispatch({ payload, type: 'SET_STATE' });
   }, []);
 
-  const increaseSubscriberCount = useCallback((payload: { cid: string }) => {
-    dispatch({ payload, type: 'INCREASE_SUBSCRIBER_COUNT' });
-  }, []);
-
-  const decreaseSubscriberCount = useCallback((payload: { cid: string }) => {
-    dispatch({ payload, type: 'DECREASE_SUBSCRIBER_COUNT' });
-  }, []);
-
   const value = useMemo(
     () => ({
-      decreaseSubscriberCount,
-      increaseSubscriberCount,
       setState,
       state,
     }),

diff --git a/package/src/contexts/channelsStateContext/useChannelState.ts b/package/src/contexts/channelsStateContext/useChannelState.ts
@@ -1,4 +1,4 @@
-import { useCallback, useEffect, useMemo } from 'react';
+import { useCallback, useMemo } from 'react';
 
 import type { Channel as ChannelType } from 'stream-chat';
 
@@ -11,15 +11,12 @@ import type { DefaultStreamChatGenerics } from '../../types/types';
 type StateManagerParams<
   Key extends Keys,
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics,
-> = Omit<
-  ChannelsStateContextValue<StreamChatGenerics>,
-  'increaseSubscriberCount' | 'decreaseSubscriberCount'
-> & {
+> = ChannelsStateContextValue<StreamChatGenerics> & {
   cid: string;
   key: Key;
 };
 
-/* 
+/*
   This hook takes care of creating a useState-like interface which can be used later to call
   updates to the ChannelsStateContext reducer. It receives the cid and key which it wants to update
   and perform the state updates. Also supports a initialState.
@@ -28,15 +25,7 @@ function useStateManager<
   Key extends Keys,
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics,
 >(
-  {
-    cid,
-    key,
-    setState,
-    state,
-  }: Omit<
-    StateManagerParams<Key, StreamChatGenerics>,
-    'increaseSubscriberCount' | 'decreaseSubscriberCount'
-  >,
+  { cid, key, setState, state }: StateManagerParams<Key, StreamChatGenerics>,
   initialValue?: ChannelState<StreamChatGenerics>[Key],
 ) {
   // eslint-disable-next-line react-hooks/exhaustive-deps
@@ -79,17 +68,7 @@ export function useChannelState<
   threadId?: string,
 ): UseChannelStateValue<StreamChatGenerics> {
   const cid = channel?.id || 'id'; // in case channel is not initialized, use generic id string for indexing
-  const { decreaseSubscriberCount, increaseSubscriberCount, setState, state } =
-    useChannelsStateContext<StreamChatGenerics>();
-
-  // Keeps track of how many Channel components are subscribed to this Channel state (Channel vs Thread concurrency)
-  useEffect(() => {
-    increaseSubscriberCount({ cid });
-    return () => {
-      decreaseSubscriberCount({ cid });
-    };
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, []);
+  const { setState, state } = useChannelsStateContext<StreamChatGenerics>();
 
   const [members, setMembers] = useStateManager(
     {