@stream-io/feeds-client 0.2.9 → 0.2.10

package/src/utils/index.ts

@@ -4,4 +4,5 @@ export * from './constants';
 export * from './type-assertions';
 export * from './state-update-queue';
 export * from './update-entity-in-array';
-export * from './logger';
+export * from './logger';
+export * from './ensure-exhausted';

package/src/utils/logger.ts

@@ -4,7 +4,8 @@ type AvailableScopes =
   | 'api-client'
   | 'event-dispatcher'
   | 'token-manager'
-  | 'stable-ws-connection';
+  | 'stable-ws-connection'
+  | 'helpers';
 
 export type ConfigureLoggersOptions =
   loggerInternal.ConfigureLoggersOptions<AvailableScopes>;

package/src/utils/state-update-queue.ts

@@ -1,5 +1,49 @@
-import { isFollowResponse, isReactionResponse } from './type-assertions';
-import { AddCommentReactionResponse, AddReactionResponse } from '../gen/models';
+import {
+  FollowResponse,
+} from '../gen/models';
+import {
+  ActivityReactionAddedPayload,
+  ActivityReactionDeletedPayload,
+  ActivityUpdatedPayload,
+  CommentAddedPayload,
+  CommentDeletedPayload,
+  CommentReactionAddedPayload,
+  CommentReactionDeletedPayload,
+  CommentUpdatedPayload,
+} from '../feed';
+import { ensureExhausted } from './ensure-exhausted';
+
+export type StateUpdateQueuePrefix =
+  | 'activity-updated'
+  | 'activity-reaction-created'
+  | 'activity-reaction-deleted'
+  | 'comment-reaction-created'
+  | 'comment-reaction-deleted'
+  | 'follow-created'
+  | 'follow-deleted'
+  | 'follow-updated'
+  | 'comment-created'
+  | 'comment-deleted'
+  | 'comment-updated';
+
+type StateUpdateQueuePayloadByPrefix = {
+  'activity-updated': ActivityUpdatedPayload;
+  'activity-reaction-created': ActivityReactionAddedPayload;
+  'activity-reaction-deleted': ActivityReactionDeletedPayload;
+  'comment-reaction-created': CommentReactionAddedPayload;
+  'comment-reaction-deleted': CommentReactionDeletedPayload;
+  'follow-created': FollowResponse;
+  'follow-deleted': FollowResponse;
+  'follow-updated': FollowResponse;
+  'comment-created': CommentAddedPayload;
+  'comment-deleted': CommentDeletedPayload;
+  'comment-updated': CommentUpdatedPayload;
+};
+
+// Union of ([payload, prefix]) tuples:
+export type StateUpdateQueuePairTuples = {
+  [K in StateUpdateQueuePrefix]: [StateUpdateQueuePayloadByPrefix[K], K];
+}[StateUpdateQueuePrefix];
 
 /**
  * Decide whether to apply a state update that may arrive twice (HTTP + WS)
@@ -82,13 +126,13 @@ export const shouldUpdateState = ({
   fromWs = true,
   isTriggeredByConnectedUser = false,
 }: {
-  stateUpdateQueueId: string;
+  stateUpdateQueueId?: string;
   stateUpdateQueue: Set<string>;
   watch: boolean;
   fromWs?: boolean;
   isTriggeredByConnectedUser: boolean;
 }): boolean => {
-  if (!watch || !isTriggeredByConnectedUser) {
+  if (!watch || !isTriggeredByConnectedUser || !stateUpdateQueueId) {
     return true;
   }
 
@@ -109,27 +153,47 @@ export const shouldUpdateState = ({
 };
 
 export function getStateUpdateQueueId(
-  data: object,
-  prefix?: 'deleted' | 'updated' | 'created' | (string & {}),
+  ...args: StateUpdateQueuePairTuples
 ) {
-  const toJoin = prefix ? [prefix] : [];
-  if (isFollowResponse(data)) {
-    return toJoin
-      .concat([data.source_feed.feed, data.target_feed.feed])
-      .join('-');
-  } else if (isReactionResponse(data)) {
-    return toJoin
-      .concat([
-        (data as AddReactionResponse).activity.id ??
-          (data as AddCommentReactionResponse).comment.id,
-        data.reaction.type,
-      ])
-      .join('-');
-  }
-  // else if (isMemberResponse(data)) {
-  // }
+  const [data, prefix] = args;
+  const toJoin = [prefix as string];
 
-  throw new Error(
-    `Cannot create state update queueId for data: ${JSON.stringify(data)}`,
-  );
+  switch (prefix) {
+    case 'activity-updated': {
+      return toJoin.concat([data.activity.id]).join('-')
+    }
+    case 'activity-reaction-created':
+    case 'activity-reaction-deleted': {
+      return toJoin
+        .concat([
+          data.activity.id,
+          data.reaction.type,
+        ])
+        .join('-');
+    }
+    case 'comment-reaction-created':
+    case 'comment-reaction-deleted': {
+      return toJoin
+        .concat([
+          data.comment.id,
+          data.reaction.type,
+        ])
+        .join('-');
+    }
+    case 'comment-created':
+    case 'comment-deleted':
+    case 'comment-updated': {
+      return toJoin.concat([data.comment.id]).join('-')
+    }
+    case 'follow-created':
+    case 'follow-deleted':
+    case 'follow-updated': {
+      return toJoin
+        .concat([data.source_feed.feed, data.target_feed.feed])
+        .join('-');
+    }
+    default: {
+      ensureExhausted(data, 'Encountered unknown state update queue prefix.')
+    }
+  }
 }

package/src/utils/type-assertions.ts

@@ -6,7 +6,6 @@ import {
   FollowResponse,
 } from '../gen/models';
 import { StreamFile } from '../types';
-import { CommentParent } from '../types';
 import { DeleteReactionResponse } from '@stream-io/node-sdk';
 
 export const isFollowResponse = (data: object): data is FollowResponse => {
@@ -20,7 +19,7 @@ export const isReactionResponse = (
   | AddCommentReactionResponse
   | DeleteReactionResponse
   | DeleteCommentReactionResponse
-) & { fid: string } => {
+) => {
   return (
     'reaction' in data &&
     ('activity' in data || 'comment' in data)
@@ -28,7 +27,7 @@ export const isReactionResponse = (
 };
 
 export const isCommentResponse = (
-  entity: CommentParent,
+  entity: object,
 ): entity is CommentResponse => {
   return typeof (entity as CommentResponse)?.object_id === 'string';
 };