import { ApolloClient, ApolloError, OperationVariables, SubscriptionOptions, } from 'apollo-client'; import { DocumentNode } from 'graphql'; import { useEffect, useRef, useState } from 'react'; import { useApolloClient } from './ApolloContext'; import actHack from './internal/actHack'; import { Omit, objToKey } from './utils'; export type OnSubscriptionData = ( options: OnSubscriptionDataOptions ) => any; export interface OnSubscriptionDataOptions { client: ApolloClient; subscriptionData: SubscriptionHookResult; } export interface SubscriptionHookOptions extends Omit, 'query'> { skip?: boolean; onSubscriptionData?: OnSubscriptionData; client?: ApolloClient; } export interface SubscriptionHookResult { data?: TData; error?: ApolloError; loading: boolean; } export function useSubscription< TData = any, TVariables = OperationVariables, TCache = object >( query: DocumentNode, { onSubscriptionData, client: overrideClient, ...options }: SubscriptionHookOptions = {} ): SubscriptionHookResult { const client = useApolloClient(overrideClient); const onSubscriptionDataRef = useRef< OnSubscriptionData | null | undefined >(null); const [result, setResultBase] = useState>({ loading: true, }); onSubscriptionDataRef.current = onSubscriptionData; function setResult(newResult: SubscriptionHookResult) { // A hack to get rid React warnings during tests. actHack(() => { setResultBase(newResult); }); } useEffect( () => { if (options.skip === true) { return; } const subscription = client .subscribe({ ...options, query, }) .subscribe( nextResult => { const newResult = { data: nextResult.data, error: undefined, loading: false, }; setResult(newResult); if (onSubscriptionDataRef.current) { onSubscriptionDataRef.current({ client, subscriptionData: newResult, }); } }, error => { setResult({ loading: false, data: result.data, error }); } ); return () => { setResult({ loading: true }); subscription.unsubscribe(); }; }, [query, options && objToKey(options)] ); return result; }