@planningcenter/chat-react-native 4.8.0-rc.1 → 4.8.0-rc.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/build/contexts/api_provider.d.ts.map +1 -1
  2. package/build/contexts/api_provider.js +2 -0
  3. package/build/contexts/api_provider.js.map +1 -1
  4. package/build/contexts/chat_context.d.ts +0 -2
  5. package/build/contexts/chat_context.d.ts.map +1 -1
  6. package/build/contexts/chat_context.js +16 -93
  7. package/build/contexts/chat_context.js.map +1 -1
  8. package/build/contexts/session_context.d.ts.map +1 -1
  9. package/build/contexts/session_context.js +3 -0
  10. package/build/contexts/session_context.js.map +1 -1
  11. package/build/hooks/groups/use_group_chat_conversation_payload.d.ts +11 -1
  12. package/build/hooks/groups/use_group_chat_conversation_payload.d.ts.map +1 -1
  13. package/build/hooks/groups/use_group_chat_conversation_payload.js +92 -47
  14. package/build/hooks/groups/use_group_chat_conversation_payload.js.map +1 -1
  15. package/build/hooks/groups/use_group_members_for_new_conversation.d.ts +27 -25
  16. package/build/hooks/groups/use_group_members_for_new_conversation.d.ts.map +1 -1
  17. package/build/hooks/groups/use_group_members_for_new_conversation.js +125 -110
  18. package/build/hooks/groups/use_group_members_for_new_conversation.js.map +1 -1
  19. package/build/hooks/groups/use_groups_conversation_create.d.ts.map +1 -1
  20. package/build/hooks/groups/use_groups_conversation_create.js +39 -31
  21. package/build/hooks/groups/use_groups_conversation_create.js.map +1 -1
  22. package/build/hooks/groups/use_groups_proxy.d.ts +2 -0
  23. package/build/hooks/groups/use_groups_proxy.d.ts.map +1 -0
  24. package/build/hooks/groups/use_groups_proxy.js +18 -0
  25. package/build/hooks/groups/use_groups_proxy.js.map +1 -0
  26. package/build/hooks/use_conversation_jolt_events.d.ts.map +1 -1
  27. package/build/hooks/use_conversation_jolt_events.js +3 -2
  28. package/build/hooks/use_conversation_jolt_events.js.map +1 -1
  29. package/build/hooks/use_conversations_actions.d.ts +9 -9
  30. package/build/hooks/use_conversations_actions.d.ts.map +1 -1
  31. package/build/hooks/use_conversations_actions.js +12 -7
  32. package/build/hooks/use_conversations_actions.js.map +1 -1
  33. package/build/hooks/use_conversations_cache.d.ts +1 -3
  34. package/build/hooks/use_conversations_cache.d.ts.map +1 -1
  35. package/build/hooks/use_conversations_cache.js +79 -124
  36. package/build/hooks/use_conversations_cache.js.map +1 -1
  37. package/build/hooks/use_conversations_jolt_events.d.ts.map +1 -1
  38. package/build/hooks/use_conversations_jolt_events.js +47 -20
  39. package/build/hooks/use_conversations_jolt_events.js.map +1 -1
  40. package/build/hooks/use_features.d.ts +1 -0
  41. package/build/hooks/use_features.d.ts.map +1 -1
  42. package/build/hooks/use_features.js +1 -0
  43. package/build/hooks/use_features.js.map +1 -1
  44. package/build/hooks/use_groups_groups.d.ts.map +1 -1
  45. package/build/hooks/use_groups_groups.js +25 -9
  46. package/build/hooks/use_groups_groups.js.map +1 -1
  47. package/build/hooks/use_mark_latest_message_read.d.ts.map +1 -1
  48. package/build/hooks/use_mark_latest_message_read.js +5 -4
  49. package/build/hooks/use_mark_latest_message_read.js.map +1 -1
  50. package/build/hooks/use_new_conversation_from_filter.d.ts.map +1 -1
  51. package/build/hooks/use_new_conversation_from_filter.js +11 -1
  52. package/build/hooks/use_new_conversation_from_filter.js.map +1 -1
  53. package/build/hooks/use_product_analytics.d.ts.map +1 -1
  54. package/build/hooks/use_product_analytics.js +93 -75
  55. package/build/hooks/use_product_analytics.js.map +1 -1
  56. package/build/screens/conversation_new/components/groups_form.d.ts.map +1 -1
  57. package/build/screens/conversation_new/components/groups_form.js +96 -93
  58. package/build/screens/conversation_new/components/groups_form.js.map +1 -1
  59. package/build/types/jolt_events/index.d.ts +2 -0
  60. package/build/types/jolt_events/index.d.ts.map +1 -1
  61. package/build/types/jolt_events/index.js.map +1 -1
  62. package/build/types/jolt_events/person_events.d.ts +9 -0
  63. package/build/types/jolt_events/person_events.d.ts.map +1 -0
  64. package/build/types/jolt_events/person_events.js +2 -0
  65. package/build/types/jolt_events/person_events.js.map +1 -0
  66. package/build/types/resources/groups/groups_group_resource.d.ts +1 -1
  67. package/build/types/resources/groups/groups_group_resource.d.ts.map +1 -1
  68. package/build/types/resources/groups/groups_group_resource.js.map +1 -1
  69. package/build/types/resources/groups/groups_membership_resource.d.ts +11 -0
  70. package/build/types/resources/groups/groups_membership_resource.d.ts.map +1 -0
  71. package/build/types/resources/groups/groups_membership_resource.js +2 -0
  72. package/build/types/resources/groups/groups_membership_resource.js.map +1 -0
  73. package/build/types/resources/groups/index.d.ts +1 -0
  74. package/build/types/resources/groups/index.d.ts.map +1 -1
  75. package/build/types/resources/groups/index.js +1 -0
  76. package/build/types/resources/groups/index.js.map +1 -1
  77. package/build/utils/jolt/parse_stream_user_event_type.d.ts +3 -0
  78. package/build/utils/jolt/parse_stream_user_event_type.d.ts.map +1 -0
  79. package/build/utils/jolt/parse_stream_user_event_type.js +9 -0
  80. package/build/utils/jolt/parse_stream_user_event_type.js.map +1 -0
  81. package/build/utils/product_analytics_token.d.ts +12 -0
  82. package/build/utils/product_analytics_token.d.ts.map +1 -0
  83. package/build/utils/product_analytics_token.js +84 -0
  84. package/build/utils/product_analytics_token.js.map +1 -0
  85. package/build/utils/throttled_refresh.d.ts +7 -0
  86. package/build/utils/throttled_refresh.d.ts.map +1 -0
  87. package/build/utils/throttled_refresh.js +42 -0
  88. package/build/utils/throttled_refresh.js.map +1 -0
  89. package/package.json +2 -2
  90. package/src/__tests__/hooks/use_group_chat_conversation_payload.test.tsx +31 -0
  91. package/src/contexts/api_provider.tsx +2 -0
  92. package/src/contexts/chat_context.tsx +2 -58
  93. package/src/contexts/session_context.tsx +3 -0
  94. package/src/hooks/__tests__/jolt_refresh_throttling.test.tsx +229 -0
  95. package/src/hooks/__tests__/use_conversations_jolt_events.test.tsx +1 -0
  96. package/src/hooks/__tests__/use_conversations_mark_read.test.tsx +38 -12
  97. package/src/hooks/__tests__/use_hide_conversation.test.tsx +15 -3
  98. package/src/hooks/__tests__/use_mark_latest_message_read.test.tsx +23 -2
  99. package/src/hooks/__tests__/use_product_analytics.test.tsx +304 -0
  100. package/src/hooks/groups/use_group_chat_conversation_payload.ts +30 -12
  101. package/src/hooks/groups/use_group_members_for_new_conversation.ts +49 -18
  102. package/src/hooks/groups/use_groups_conversation_create.ts +10 -14
  103. package/src/hooks/groups/use_groups_proxy.ts +6 -0
  104. package/src/hooks/use_conversation_jolt_events.ts +2 -1
  105. package/src/hooks/use_conversations_actions.ts +7 -4
  106. package/src/hooks/use_conversations_cache.ts +1 -23
  107. package/src/hooks/use_conversations_jolt_events.ts +24 -10
  108. package/src/hooks/use_features.ts +1 -0
  109. package/src/hooks/use_groups_groups.ts +21 -16
  110. package/src/hooks/use_mark_latest_message_read.ts +6 -5
  111. package/src/hooks/use_new_conversation_from_filter.ts +13 -5
  112. package/src/hooks/use_product_analytics.ts +74 -41
  113. package/src/screens/conversation_new/components/groups_form.tsx +11 -9
  114. package/src/types/jolt_events/index.ts +2 -0
  115. package/src/types/jolt_events/person_events.ts +16 -0
  116. package/src/types/resources/groups/groups_group_resource.ts +1 -1
  117. package/src/types/resources/groups/groups_membership_resource.ts +10 -0
  118. package/src/types/resources/groups/index.ts +1 -0
  119. package/src/utils/__tests__/throttled_refresh.test.ts +101 -0
  120. package/src/utils/jolt/__tests__/parse_stream_user_event_type.test.ts +27 -0
  121. package/src/utils/jolt/parse_stream_user_event_type.ts +16 -0
  122. package/src/utils/product_analytics_token.ts +120 -0
  123. package/src/utils/throttled_refresh.ts +62 -0
@@ -1,12 +1,10 @@
1
- import { useQuery } from '@tanstack/react-query'
2
1
  import { merge } from 'lodash'
3
2
  import React, { createContext, useMemo } from 'react'
4
3
  import { ColorSchemeName, useColorScheme } from 'react-native'
5
4
  import { AgeCheckContactInfo } from '../screens/age_check/screen_props'
6
- import { ApiResource, DeepPartial } from '../types'
5
+ import { DeepPartial } from '../types'
7
6
  import { FailedResponse } from '../types'
8
- import { ProductAnalyticsConfig } from '../types/product_analytics'
9
- import { Client, ENV, OauthType, PartialToken, Session, Uri } from '../utils'
7
+ import { ENV, OauthType, PartialToken, Session } from '../utils'
10
8
  import { setLiquidGlassCapability } from '../utils/liquid_glass'
11
9
  import { ChatTheme, defaultTheme, DefaultTheme } from '../utils/theme'
12
10
 
@@ -27,7 +25,6 @@ export interface ChatContextValue extends Omit<ChatProviderProps, 'theme'> {
27
25
  session: Session
28
26
  theme: ChatTheme
29
27
  onAgeDisqualification: (params: AgeCheckContactInfo) => void
30
- productAnalyticsConfig: ProductAnalyticsConfig | undefined
31
28
  }
32
29
 
33
30
  export const ChatContext = createContext<ChatContextValue>({
@@ -40,7 +37,6 @@ export const ChatContext = createContext<ChatContextValue>({
40
37
  token: undefined,
41
38
  edgeToEdge: true,
42
39
  liquidGlassEnabled: false,
43
- productAnalyticsConfig: undefined,
44
40
  })
45
41
 
46
42
  export function ChatProvider({ children, value }: { children: any; value: ChatProviderProps }) {
@@ -64,7 +60,6 @@ export function ChatProvider({ children, value }: { children: any; value: ChatPr
64
60
  [env, prototypeName, token, tokenType]
65
61
  )
66
62
 
67
- const productAnalyticsConfig = useProductAnalyticsConfig(session)
68
63
  const contextValue: ChatContextValue = {
69
64
  ...value,
70
65
  edgeToEdge,
@@ -76,7 +71,6 @@ export function ChatProvider({ children, value }: { children: any; value: ChatPr
76
71
  session,
77
72
  theme,
78
73
  token,
79
- productAnalyticsConfig,
80
74
  }
81
75
 
82
76
  return <ChatContext.Provider value={contextValue}>{children}</ChatContext.Provider>
@@ -107,53 +101,3 @@ export const useCreateChatTheme = ({
107
101
 
108
102
  return theme
109
103
  }
110
-
111
- interface ProductAnalyticsTokenResponse {
112
- type: 'ProductAnalyticsToken'
113
- id: string
114
- url: string
115
- metadata: Record<string, unknown>
116
- }
117
-
118
- // expiry time comes from here:
119
- // https://github.com/planningcenter/pco-product-analytics/blob/e5bbc4c31b715b3c329c06a162829ee6967d3094/lib/pco/product/analytics/client_token_provider.rb#L24
120
- const TOKEN_EXPIRY_TIME = 604800 * 1000 // 7 days in milliseconds
121
-
122
- const useProductAnalyticsConfig = (session: Session): ProductAnalyticsConfig | undefined => {
123
- const uri = useMemo(() => new Uri({ session }), [session])
124
- const apiClient = useMemo(
125
- () =>
126
- new Client({
127
- root: uri.api(`/chat/v2`),
128
- defaultHeaders: uri.headers,
129
- version: '2018-11-01',
130
- }),
131
- [uri]
132
- )
133
-
134
- const { data: config } = useQuery<ProductAnalyticsConfig>({
135
- queryKey: ['product-analytics-token'],
136
- queryFn: () =>
137
- apiClient
138
- .post<ApiResource<ProductAnalyticsTokenResponse>>({
139
- url: '/me/product_analytics_authorize',
140
- data: {
141
- data: {
142
- type: 'ProductAnalyticsToken',
143
- attributes: {},
144
- },
145
- },
146
- })
147
- .then(res => ({
148
- token: res.data.id,
149
- endpoint: res.data.url,
150
- metadata: res.data.metadata,
151
- })),
152
- staleTime: TOKEN_EXPIRY_TIME,
153
- gcTime: TOKEN_EXPIRY_TIME,
154
- refetchInterval: TOKEN_EXPIRY_TIME,
155
- enabled: process.env.NODE_ENV !== 'test',
156
- })
157
-
158
- return config
159
- }
@@ -17,6 +17,7 @@ import { ApiResource } from '../types/api_primitives'
17
17
  import { ENV, PartialToken, Session, UNAUTHENTICATED_SESSION_ID } from '../utils'
18
18
  import { StorageAdapter } from '../utils/native_adapters/storage_adapter'
19
19
  import { SessionManager } from '../utils/session_manager'
20
+ import { cancelThrottledRefreshes } from '../utils/throttled_refresh'
20
21
  import { chatQueryClient } from './api_provider'
21
22
 
22
23
  type Sessions = Record<string, string> // Key is session ID
@@ -143,6 +144,8 @@ export function SessionContextProvider({
143
144
  })
144
145
 
145
146
  const handleClearQueryClient = useCallback(() => {
147
+ cancelThrottledRefreshes(chatQueryClient)
148
+ cancelThrottledRefreshes(queryClient)
146
149
  chatQueryClient.clear()
147
150
  queryClient.clear()
148
151
  }, [queryClient])
@@ -0,0 +1,229 @@
1
+ import { QueryClient, QueryClientProvider, useQuery } from '@tanstack/react-query'
2
+ import { act, render } from '@testing-library/react-native'
3
+ import React, { Suspense } from 'react'
4
+ import { buildTestQueryClient } from '../../__utils__/query_client'
5
+ import type { ApiResource, ConversationResource, CurrentPersonResource } from '../../types'
6
+ import { getConversationsRequestArgs } from '../../utils/request/conversation'
7
+ import { cancelThrottledRefreshes, REFRESH_THROTTLE_MS } from '../../utils/throttled_refresh'
8
+ import { getConversationRequestArgs } from '../use_conversation'
9
+ import { useConversationJoltEvents } from '../use_conversation_jolt_events'
10
+ import { useConversationsJoltEvents } from '../use_conversations_jolt_events'
11
+ import { currentPersonQueryKey } from '../use_current_person'
12
+ import { getRequestQueryKey } from '../use_suspense_api'
13
+
14
+ type Handler = (event: unknown) => void
15
+ const mockHandlers = new Map<string, Set<Handler>>()
16
+
17
+ jest.mock('../use_jolt', () => {
18
+ const { useEffect } = jest.requireActual<typeof import('react')>('react')
19
+ return {
20
+ useJoltChannel: (channelName: string) => channelName,
21
+ useJoltEvent: (channel: string, eventName: string, handler: Handler) => {
22
+ useEffect(() => {
23
+ const key = `${channel}:${eventName}`
24
+ const bound = mockHandlers.get(key) ?? new Set<Handler>()
25
+ mockHandlers.set(key, bound)
26
+ bound.add(handler)
27
+ return () => {
28
+ bound.delete(handler)
29
+ }
30
+ }, [channel, eventName, handler])
31
+ },
32
+ }
33
+ })
34
+ jest.mock('../use_api', () => ({ useApiGet: () => ({ data: { id: 1 } }) }))
35
+ jest.mock('../../contexts/conversations_context', () => ({
36
+ useConversationsContext: () => ({ args: {} }),
37
+ }))
38
+
39
+ const mockGet = jest.fn()
40
+ jest.mock('../use_api_client', () => ({ useApiClient: () => ({ chat: { get: mockGet } }) }))
41
+
42
+ const personId = 1
43
+ const conversationId = 7
44
+ const peopleChannel = `chat.people.${personId}`
45
+ const conversationChannel = `chat.conversations.${conversationId}`
46
+ const listQueryKey = getRequestQueryKey(getConversationsRequestArgs({}))
47
+ const conversationQueryKey = getRequestQueryKey(
48
+ getConversationRequestArgs({ conversation_id: conversationId })
49
+ )
50
+ const listUrl = listQueryKey[0]
51
+ const conversationUrl = conversationQueryKey[0]
52
+ const meUrl = currentPersonQueryKey[0]
53
+
54
+ let queryClient: QueryClient
55
+
56
+ const ConversationsList = () => {
57
+ useConversationsJoltEvents()
58
+ return null
59
+ }
60
+
61
+ const ConversationScreen = () => {
62
+ useConversationJoltEvents({ conversationId })
63
+ useQuery({
64
+ queryKey: conversationQueryKey,
65
+ queryFn: () => mockGet({ url: conversationUrl }),
66
+ staleTime: Infinity,
67
+ })
68
+ return null
69
+ }
70
+
71
+ const fire = (channel: string, eventName: string, payload: Record<string, unknown>) => {
72
+ const message = { event: eventName, channel, ...payload }
73
+ mockHandlers.get(`${channel}:${eventName}`)?.forEach(handler => handler(message))
74
+ }
75
+
76
+ const conversationUpdated = () => {
77
+ const data = { data: { id: conversationId, last_message_author_id: 2 } }
78
+ fire(peopleChannel, 'conversation.updated', { data })
79
+ fire(conversationChannel, 'conversation.updated', { data })
80
+ }
81
+
82
+ const conversationRead = () => {
83
+ const data = { data: { id: conversationId, latest_read_message_sort_key: 'z' } }
84
+ fire(peopleChannel, 'conversation.read', { data })
85
+ fire(conversationChannel, 'conversation.read', { data })
86
+ }
87
+
88
+ const streamUserUpdated = (payload: Record<string, unknown>) =>
89
+ fire(peopleChannel, 'STREAM_USER_UPDATED', { data: { data: JSON.stringify(payload) } })
90
+
91
+ const requestsFor = (url: string) =>
92
+ mockGet.mock.calls.filter(([request]) => request.url === url).length
93
+
94
+ const advance = (ms: number) => act(async () => jest.advanceTimersByTime(ms))
95
+
96
+ const seed = () => {
97
+ queryClient.setQueryData<ApiResource<CurrentPersonResource>>(currentPersonQueryKey, {
98
+ data: { type: 'Person', id: personId },
99
+ } as ApiResource<CurrentPersonResource>)
100
+ queryClient.setQueryData<ApiResource<ConversationResource>>(conversationQueryKey, {
101
+ data: { type: 'Conversation', id: conversationId },
102
+ } as ApiResource<ConversationResource>)
103
+ queryClient.setQueryData(listQueryKey, {
104
+ pages: [{ data: [{ type: 'Conversation', id: conversationId }], links: {}, meta: {} }],
105
+ pageParams: [undefined],
106
+ })
107
+ }
108
+
109
+ const mountTwoListsAndTwoScreens = async () => {
110
+ seed()
111
+ render(
112
+ <QueryClientProvider client={queryClient}>
113
+ <Suspense fallback={null}>
114
+ <ConversationsList />
115
+ <ConversationsList />
116
+ <ConversationScreen />
117
+ <ConversationScreen />
118
+ </Suspense>
119
+ </QueryClientProvider>
120
+ )
121
+ await advance(1)
122
+ mockGet.mockClear()
123
+ }
124
+
125
+ beforeEach(async () => {
126
+ jest.useFakeTimers()
127
+ mockHandlers.clear()
128
+ mockGet.mockReset()
129
+ mockGet.mockImplementation(({ url }: { url: string }) => {
130
+ if (url === meUrl) return Promise.resolve({ data: { type: 'Person', id: personId } })
131
+ if (url === conversationUrl) {
132
+ return Promise.resolve({ data: { type: 'Conversation', id: conversationId } })
133
+ }
134
+ return Promise.resolve({ data: [{ type: 'Conversation', id: conversationId }] })
135
+ })
136
+ queryClient = buildTestQueryClient({ defaultOptions: { queries: { gcTime: Infinity } } })
137
+ await mountTwoListsAndTwoScreens()
138
+ })
139
+
140
+ afterEach(() => {
141
+ cancelThrottledRefreshes(queryClient)
142
+ jest.useRealTimers()
143
+ })
144
+
145
+ describe('conversation.updated across two lists and two screens', () => {
146
+ it('collapses 50 events into one request now and one when the window ends', async () => {
147
+ for (let i = 0; i < 50; i++) conversationUpdated()
148
+ await advance(1)
149
+
150
+ expect(requestsFor(listUrl)).toBe(1)
151
+ expect(requestsFor(conversationUrl)).toBe(1)
152
+
153
+ await advance(REFRESH_THROTTLE_MS)
154
+
155
+ expect(requestsFor(listUrl)).toBe(2)
156
+ expect(requestsFor(conversationUrl)).toBe(2)
157
+ })
158
+
159
+ it('refreshes immediately for a lone event and makes no second request', async () => {
160
+ conversationUpdated()
161
+ await advance(1)
162
+
163
+ expect(requestsFor(listUrl)).toBe(1)
164
+ expect(requestsFor(conversationUrl)).toBe(1)
165
+
166
+ await advance(REFRESH_THROTTLE_MS * 2)
167
+
168
+ expect(requestsFor(listUrl)).toBe(1)
169
+ expect(requestsFor(conversationUrl)).toBe(1)
170
+ })
171
+
172
+ it('gives an event inside the window a trailing refresh opened its own trailing refresh', async () => {
173
+ conversationUpdated()
174
+ await advance(1000)
175
+ conversationUpdated()
176
+ await advance(REFRESH_THROTTLE_MS - 1000)
177
+
178
+ expect(requestsFor(listUrl)).toBe(2)
179
+ expect(requestsFor(conversationUrl)).toBe(2)
180
+
181
+ await advance(500)
182
+ conversationUpdated()
183
+ await advance(1)
184
+
185
+ expect(requestsFor(listUrl)).toBe(2)
186
+ expect(requestsFor(conversationUrl)).toBe(2)
187
+
188
+ await advance(REFRESH_THROTTLE_MS)
189
+
190
+ expect(requestsFor(listUrl)).toBe(3)
191
+ expect(requestsFor(conversationUrl)).toBe(3)
192
+ })
193
+ })
194
+
195
+ describe('/me refreshes', () => {
196
+ it('makes no /me request for message.created stream events or conversation.read events', async () => {
197
+ for (let i = 0; i < 50; i++) {
198
+ streamUserUpdated({ event_type: 'message.created' })
199
+ conversationRead()
200
+ }
201
+ await advance(REFRESH_THROTTLE_MS * 2)
202
+
203
+ expect(requestsFor(meUrl)).toBe(0)
204
+ })
205
+
206
+ it('ignores the other read-state event types', async () => {
207
+ streamUserUpdated({ event_type: 'conversation.mark_read' })
208
+ streamUserUpdated({ event_type: 'conversation.mark_unread' })
209
+ streamUserUpdated({ event_type: 'person.mark_all_read' })
210
+ streamUserUpdated({ event_type: 'conversation.destroy' })
211
+ await advance(REFRESH_THROTTLE_MS * 2)
212
+
213
+ expect(requestsFor(meUrl)).toBe(0)
214
+ })
215
+
216
+ it('refetches /me once for app_grant.synced', async () => {
217
+ streamUserUpdated({ event_type: 'app_grant.synced' })
218
+ await advance(REFRESH_THROTTLE_MS * 2)
219
+
220
+ expect(requestsFor(meUrl)).toBe(1)
221
+ })
222
+
223
+ it('refetches /me once for an event with no event_type', async () => {
224
+ streamUserUpdated({})
225
+ await advance(REFRESH_THROTTLE_MS * 2)
226
+
227
+ expect(requestsFor(meUrl)).toBe(1)
228
+ })
229
+ })
@@ -18,6 +18,7 @@ jest.mock('../use_jolt', () => ({
18
18
  jest.mock('../use_api', () => ({ useApiGet: () => ({ data: { id: 1 } }) }))
19
19
  jest.mock('../use_current_person', () => ({
20
20
  currentPersonRequestArgs: {},
21
+ currentPersonQueryKey: ['/me'],
21
22
  useCurrentPersonCache: () => ({ invalidate: jest.fn() }),
22
23
  }))
23
24
 
@@ -1,4 +1,4 @@
1
- import { QueryClientProvider } from '@tanstack/react-query'
1
+ import { QueryClient, QueryClientProvider } from '@tanstack/react-query'
2
2
  import { act, renderHook } from '@testing-library/react-native'
3
3
  import React from 'react'
4
4
  import { buildTestQueryClient } from '../../__utils__/query_client'
@@ -7,27 +7,53 @@ import { getConversationsRequestArgs } from '../../utils/request/conversation'
7
7
  import { useConversationsMarkRead } from '../use_conversations_actions'
8
8
  import { getRequestQueryKey } from '../use_suspense_api'
9
9
 
10
+ const mockPost = jest.fn()
11
+ const mockGet = jest.fn()
10
12
  jest.mock('../use_api_client', () => ({
11
- useApiClient: () => ({
12
- chat: { post: jest.fn().mockResolvedValue({}), get: jest.fn().mockResolvedValue({ data: [] }) },
13
- }),
13
+ useApiClient: () => ({ chat: { post: mockPost, get: mockGet } }),
14
14
  }))
15
15
 
16
+ const conversation = { id: 7, unreadCount: 8 } as ConversationResource
17
+ const listKey = getRequestQueryKey(getConversationsRequestArgs())
18
+ const archivedListKey = getRequestQueryKey(getConversationsRequestArgs({ show_archived: true }))
19
+ let queryClient: QueryClient
20
+
21
+ const wrapper = ({ children }: { children: React.ReactNode }) => (
22
+ <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
23
+ )
24
+
25
+ const listShows = (key: typeof listKey) => queryClient.getQueryData(key)
26
+
27
+ beforeEach(() => {
28
+ mockPost.mockReset()
29
+ mockGet.mockReset()
30
+ queryClient = buildTestQueryClient({ defaultOptions: { queries: { gcTime: Infinity } } })
31
+ queryClient.setQueryData(listKey, { pages: [{ data: [conversation] }], pageParams: [] })
32
+ queryClient.setQueryData(archivedListKey, { pages: [{ data: [conversation] }], pageParams: [] })
33
+ })
34
+
16
35
  describe('useConversationsMarkRead', () => {
17
36
  it('marks the conversation read in a list outside the current conversations context', async () => {
18
- const conversation = { id: 7, unreadCount: 8 } as ConversationResource
19
- const archivedListKey = getRequestQueryKey(getConversationsRequestArgs({ show_archived: true }))
20
- const queryClient = buildTestQueryClient({ defaultOptions: { queries: { gcTime: Infinity } } })
21
- queryClient.setQueryData(archivedListKey, { pages: [{ data: [conversation] }], pageParams: [] })
22
- const wrapper = ({ children }: { children: React.ReactNode }) => (
23
- <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
24
- )
37
+ mockPost.mockResolvedValue({ data: { type: 'Conversation', id: 7, unreadCount: 0 } })
25
38
  const { result } = renderHook(() => useConversationsMarkRead({ conversation }), { wrapper })
26
39
 
27
40
  await act(async () => result.current.markRead(true))
28
41
 
29
- expect(queryClient.getQueryData(archivedListKey)).toMatchObject({
42
+ expect(listShows(archivedListKey)).toMatchObject({
30
43
  pages: [{ data: [{ id: 7, unreadCount: 0 }] }],
31
44
  })
32
45
  })
46
+
47
+ it('shows the unread count from the response without refetching the conversation', async () => {
48
+ mockPost.mockResolvedValue({ data: { type: 'Conversation', id: 7, unreadCount: 3 } })
49
+ const { result } = renderHook(() => useConversationsMarkRead({ conversation }), { wrapper })
50
+
51
+ await act(async () => result.current.markRead(false))
52
+
53
+ expect(mockGet).not.toHaveBeenCalled()
54
+ expect(listShows(listKey)).toMatchObject({ pages: [{ data: [{ id: 7, unreadCount: 3 }] }] })
55
+ expect(listShows(archivedListKey)).toMatchObject({
56
+ pages: [{ data: [{ id: 7, unreadCount: 3 }] }],
57
+ })
58
+ })
33
59
  })
@@ -47,6 +47,16 @@ const wrapper = ({ children }: { children: React.ReactNode }) => (
47
47
  <QueryClientProvider client={queryClient}>{children}</QueryClientProvider>
48
48
  )
49
49
 
50
+ // A mutation left pending keeps Jest alive: with no observers, TanStack Query
51
+ // re-arms its gc timer until the mutation settles.
52
+ let settlePatch: (() => void) | undefined
53
+ const mockPendingPatch = () =>
54
+ mockPatch.mockReturnValue(
55
+ new Promise(resolve => {
56
+ settlePatch = () => resolve({ data: {} })
57
+ })
58
+ )
59
+
50
60
  const renderHide = (target: ConversationResource = conversation, hidden?: boolean) =>
51
61
  renderHook(() => useHideConversation({ conversation: target, hidden }), { wrapper })
52
62
 
@@ -63,12 +73,14 @@ describe('useHideConversation', () => {
63
73
  jest.spyOn(Alert, 'alert').mockImplementation(() => {})
64
74
  })
65
75
 
66
- afterEach(() => {
76
+ afterEach(async () => {
77
+ await act(async () => settlePatch?.())
78
+ settlePatch = undefined
67
79
  jest.restoreAllMocks()
68
80
  })
69
81
 
70
82
  it('removes the conversation from every list before the request resolves', async () => {
71
- mockPatch.mockReturnValue(new Promise(() => {}))
83
+ mockPendingPatch()
72
84
  const { result } = renderHide()
73
85
 
74
86
  await act(async () => result.current.setHidden(true))
@@ -152,7 +164,7 @@ describe('useHideConversation', () => {
152
164
  })
153
165
 
154
166
  it('removes the conversation from the hidden list before the request resolves', async () => {
155
- mockPatch.mockReturnValue(new Promise(() => {}))
167
+ mockPendingPatch()
156
168
  const { result } = renderHide(conversation, true)
157
169
 
158
170
  expect(result.current.hidden).toBe(true)
@@ -34,12 +34,33 @@ describe('useMarkLatestMessageRead', () => {
34
34
  expect(mockMarkRead).toHaveBeenCalledTimes(1)
35
35
 
36
36
  rerender({ conversation: { ...conversation, unreadCount: 2 }, enabled: false })
37
- act(() => jest.advanceTimersByTime(1000))
37
+ act(() => jest.advanceTimersByTime(3000))
38
38
 
39
39
  expect(mockMarkRead).toHaveBeenCalledTimes(1)
40
40
 
41
41
  rerender({ conversation: { ...conversation, unreadCount: 2 }, enabled: true })
42
- act(() => jest.advanceTimersByTime(1000))
42
+ act(() => jest.advanceTimersByTime(3000))
43
+
44
+ expect(mockMarkRead).toHaveBeenCalledTimes(2)
45
+ jest.useRealTimers()
46
+ })
47
+
48
+ it('collapses unread bumps inside three seconds into one trailing mark-read', () => {
49
+ jest.useFakeTimers()
50
+ const { rerender } = renderHook<void, { conversation: ConversationResource }>(
51
+ props => useMarkLatestMessageRead({ ...props, messages: [] }),
52
+ { initialProps: { conversation } }
53
+ )
54
+ expect(mockMarkRead).toHaveBeenCalledTimes(1)
55
+
56
+ for (let i = 0; i < 3; i++) {
57
+ rerender({ conversation: { ...conversation, unreadCount: 0 } })
58
+ act(() => jest.advanceTimersByTime(500))
59
+ rerender({ conversation: { ...conversation, unreadCount: 1 } })
60
+ }
61
+ expect(mockMarkRead).toHaveBeenCalledTimes(1)
62
+
63
+ act(() => jest.advanceTimersByTime(3000))
43
64
 
44
65
  expect(mockMarkRead).toHaveBeenCalledTimes(2)
45
66
  jest.useRealTimers()