StreamFeed.subscribe() does not return a Faye Subscription.

[skam22]

export enum StreamFeedGroups {
  user = 'user',
  timeline = 'timeline',
  timeline_aggregated = 'timeline_aggregated',
  notification = 'notification',
}

const activityClient = connect(
  Config.STREAM_API_KEY,
  null,
  Config.STREAM_APP_ID,
);

const timelineFeed = activityClient.feed(
  StreamFeedGroups.timeline,
  userId,  // string
  userToken, // string
),

const Component = () => {

  useEffect(() => {
    let subscription: Subscription | null = null;

    timelineFeed.subscribe((data) => {
      console.log('New timeline data received':, data);
    }).then((fayeSubscription: Subscription) => {

      subscription = fayeSubscription;
      console.log('Timeline listener established', subscription);


        // expected object:
           type Subscription = {
             cancel: () => void;
           };
        // actual:
           undefined



    }).catch(error => {
      if (error instanceof Error) {
        console.error('Error setting up timeline listener', error)
      }
    });
   
    return () => {
      subscription?.cancel();
      subscription = null;
    }
  },[])
 
  return (
    ...
  )
}

[karthikkasturisfx]

I am facing the same issue. Any updates?

[Seetha-lab]

Hi, the issue here is that StreamFeed.subscribe() doesn't return a Faye Subscription object but a promise
https://getstream.io/activity-feeds/docs/node/v2/web_and_mobile/#subscribe-to-realtime-updates-via-api-client

stream-js/README.md

Line 365 in bffb182

const subscription = user1.subscribe(function (data) {

[karthikkasturisfx]

Hi @Seetha-lab , StreamFeed.subscribe()'s return type is Promise<Faye.Subscription>, whose result, in turn, is undefined. Due to this the callback is alive till the process is killed, since subscription.cancel is not accessible.

import { StreamClient } from "getstream";


const client = new StreamClient(
  process.env.NEXT_PUBLIC_STREAM_API_KEY,
  process.env.STREAM_API_SECRET,
  process.env.NEXT_PUBLIC_STREAM_APP_ID,
)

const feed = client.feed("parkplace_timeline", "global");

const subscription = await feed.subscribe(() => {
    console.log("Listening to feed updates...");
});

console.log(subscription, typeof subscription?.cancel);

Output:

% node --env-file=.env test.js
undefined undefined
^C

[karthikkasturisfx]

I have figured out the issue. The types are wrong. The call to subscribe() returns Faye.Subscription, not Promise<Faye.Subscription>. The implementation mentioned in your readme snippet works as mentioned, but typescript just goes bonkers because of the type declaration. @Seetha-lab

The type declaration is incorrect here

stream-js/types/modules.d.ts

Line 27 in bffb182

subscribe(channel: string, callback: SubscribeCallback<T>): Promise<Subscription>;

It needs to be updated to subscribe(channel: string, callback: SubscribeCallback<T>): Subscription;