ویرگول
ورودثبت نام
عامر لطفی اوریمی
عامر لطفی اوریمیدولوپر فرانت‌اند - علاقمند به جاوااسکریپ (تایپ‌اسکریپت)، ری‌اکت، ری‌اکت‌نیتیو - فرانت‌اند دولوپر سابق دیجی‌کالا، دیجی‌کالامگ، شیپور و سیبچه
عامر لطفی اوریمی
عامر لطفی اوریمی
خواندن ۹ دقیقه·۲۵ روز پیش

کتابخانه نرم افزاری چت Tinode برای React Native و وب، react-native-tinode

react-native-tinode روی iOS و وب
react-native-tinode روی iOS و وب

مقدمه

یک سال و نیم پیش لازم داشتم توی یه اپ React Native چت بذارم. چت واقعی، نه یه صفحه نمایشی؛ لیست مخاطبها، تعداد پیامهای نخونده، «داره مینویسه... همون is typing» و تیک خونده شدن. نوشتن سرور چت از صفر کار یه نفر نیست و پول دادن به یه سرویس آماده به ازای هر کاربر هم مورد بسیار گرونیه و یک استارتاپ نمیتونست پرداختش کنه. تیم به دنبال یه سرور open source بود و ما رسیدیم به Tinode.

Tinode یه سرور پیامرسان یا همون instant messaging هستش که با Go نوشته شده و یه SDK رسمی جاوااسکریپتی هم داره به اسم tinode-js که روی npm اسمش tinode-sdkهست.

با خودم گفتم خوب جاوااسکریپته دیگه، React Native هم جاوااسکریپت اجرا میکنه، نصبش میکنم و تمام. ولی خیلی هم تمام نبود. اون کتابخانه نرم افزاری کامل برای محیط مرورگر نوشته شده بود!

وقت ندارید؟ پکیج روی npm هست و کدها هم روی GitHub. برید ببینید و استفاده کنید.


یه تاریخچه کوتاه

نقشه اولم خیلی ساده بود. tinode-sdk رو wrap کنم، براش تایپ TypeScript بنویسم، چند تا shim برای چیزهایی که React Native نداره بذارم و چند تا hook ری‌اکتی هم روش سوار کنم. نقشه رو توی یه فایل نوشتم و کلی هم ذوق داشتم.

بعد شروع کردم سورس tinode-js رو فایل به فایل خوندن و لیست چیزهای مخصوص مرورگر هی بلندتر شد:

  • توی helper فایلهای بزرگ

  • document برای ذخیره فایل دانلود شده

  • indexedDB برای کش

  • Intl.Segmenter توی Drafty (فرمت متن غنی Tinode) که Hermes اصلا نداره

  • navigator.userAgent توی constructor

  • و از همه بامزه‌تر، موقع import یه global.window الکی میسازه

حالا اگر بخوای همه این‌ها رو از بیرون shim کنی یعنی باید به global‌های کل اپ دست بزنی. من یکی از کتابخونه‌ای که سر خود global‌های اپم رو عوض کنه اصلا خوشم نمیاد. پس نظرم برگشت و tinode-js نسخهء 0.25.4 رو ماژول به ماژول با TypeScript بازنویسی کردم، با همون اسم فایل‌ها، کلاس‌ها و متد‌ها. نسخه 0.1.0 ـه react-native-tinode روز ۵ اکتبر ۲۰۲۶ رفت روی npm.


گپ با نگهدارنده Tinode

همون روز یه issue روی tinode-js باز کردم و کتابخونه رو معرفی کردم. or-else که نگهدارنده (maintainer) ـه Tinode هستش خیلی محترمانه جواب داد، ولی حرفش روشن بود: این یه بازنویسی کامل با TypeScript ـه، نمیشه با SDK جاوااسکریپتی merge ش کرد و کسی هم نمی‌تونه این دو تا رو با هم همگام نگه داره.

بعد یه PR دادم که همین port ـه TypeScript رو ببره توی خود tinode-js. این بار هم جواب نه بود، ولی این دفعه اصل حرف رو گرفتم: SDK باید جاوااسکریپت بمونه و PR فقط باید چیز‌هایی رو داشته باشه که React Native لازم داره.

راستش حق داشت. وقتی دوباره نگاه کردم دیدم مشکل اصلی هیچ وقت جاوااسکریپت نبود. مشکل این بود که SDK سر خود storage و شبکه‌اش رو از global‌های مرورگر برمی‌داشت. پس port ـه TypeScript رو از PR بیرون کشیدم و فقط یه تغییر کوچیک تزریق وابستگی (Dependency Injection) با جاوااسکریپت خالص نگه داشتم:

  • گزینهء storage با سه تا adapter توی خود SDK: IndexedDBAdapter (که هنوز پیش‌فرض مرورگره)، KeyValueAdapter برای store‌هایی مثل expo-sqlite kv-store و MMKV و AsyncStorage، و MemoryAdapter

  • گزینهء netInfo که وقتی شبکه برمی‌گرده، کلاینت همون لحظه دوباره وصل بشه

  • گزینهء network برای WebSocket و XMLHttpRequest

وب‌اپ خود Tinode هم بدون هیچ تغییری باهاش build میشه و کار می‌کنه. روز ۲۵ اکتبر ۲۰۲۶ این PR توی branch ـه devel مرج شد و من که خیلی خوشحال شدم. یعنی الآن tinode-sdk دیگه مخصوص مرورگر نیست، یه کتابخونه جاوااسکریپت خالصه که هر جا بخواید اجرا میشه، فقط موقع ساختن instance ـه Tinode چیز‌هایی که پلتفرمتون داره رو بهش پاس میدید.

همین امروز نسخه 0.2.0 ـه react-native-tinode رو منتشر کردم. port ـه TypeScript خودم رو کامل پاک کردم و الآن پکیج فقط یه لایه نازک React روی tinode-sdk ـه رسمیه. fix‌های پروتکل از خود upstream میان و دیگه لازم نیست چیزی رو دستی port کنم.


ایدهاش چیه؟

ایده اینه که یه کلاینت Tinode داشته باشیم که هر جا React Native اجرا میشه اونم اجرا بشه و زیرش هم SDK ـه رسمی باشه:

  • هیچ کد native ی نداره. یعنی همین یه پکیج توی Expo Go، توی React Native خالی (bare) و روی وب کار می‌کنه.

  • کلاینتش همون tinode-sdk ـه رسمیه، پس مستندات رسمی دقیقا به دردتون می‌خوره.

  • تایپ‌های TypeScript برای کل SDK، چون tinode-sdk جاوااسکریپت خالصه و تایپ نداره.

  • دو تا polyfill کوچیک برای Hermes، یعنی Intl.Segmenter و TextDecoder، که فقط وقتی نصب میشن که نباشن. بدون این‌ها SDK همون موقع load شدن روی Hermes کرش می‌کنه.

  • یه سری hook ری‌اکتی روش: useConnection، useLogin، useMeTopic، useTopic، useMessages و useTyping.

  • store کش یا NetInfo مال اپ خودتون هستن، شما پاسشون می‌دید و کتابخونه هیچ وقت import شون نمی‌کنه.

یه نکته ریز هم بگم که خودم خیلی دوستش دارم. توی Tinode، callbackهایی مثل onData فقط یه جا برای یه تابع دارن. یعنی اگر یه hook مقدارش رو بذاره، handler خودتون بی سر و صدا میپره. واسه همین hookها listenerهاشون رو از طریق یه multiplexer کوچولو اضافه میکنن که با اسم attach export شده و شما هم میتونید ازش استفاده کنید. اگر چند تا کامپوننت هم از یه topic استفاده کنن، همه یه subscription مشترک دارن و چند لحظه بعد از unmount شدن آخری، topic رو ترک میکنه.


خوب بریم سراغ نصب

۱. پکیج رو نصب کنید. من نسخه رو قفل می‌کنم چون نسخه‌های 0.x زود به زود عوض میشن:

yarn add [email protected]

‏tinode-sdk هم خودش همراهش نصب میشه. فقط حواستون باشه، تغییر من merge شده ولی نسخه بعدی tinode-sdk هنوز روی npm نیومده، برای همین فعلا از یه commit قفل شده از branch ـه devel ـه tinode-js نصب میشه. یعنی سیستمتون و CI تون باید git داشته باشن و به github.com دسترسی داشته باشن. وقتی نسخه بعدی tinode-sdk بیاد روی npm این داستان هم تمومه.

۲. یه سرور Tinode لازم دارید. برای تست، با Docker طبق این راهنما یه سرور local بالا بیارید. چند تا کاربر تستی هم همراهش هست، مثلا alice با رمز alice123.

۳. توی src یه فولدر به اسم chat بسازید و داخلش فایل ChatRoot.tsx رو با کد زیر:

import { TinodeProvider } from 'react-native-tinode'; import { SupportChat } from './SupportChat'; const config = { appName: 'CoinWallet/1.0', host: 'localhost:6060', apiKey: 'AQEAAAABAAD_rAp4DJh05a1HAwFT3A6K', secure: false, }; export function ChatRoot() { return ( <TinodeProvider config={config}> <SupportChat /> </TinodeProvider> ); }

اگر روی امولاتور اندروید هستید حواستون باشه localhost خود امولاتوره، به جاش 10.0.2.2:6060 بنویسید.

۴. حالا لاگین و لیست چتها. کنارش فایل SupportChat.tsx رو بسازید:

import { useEffect, useState } from 'react'; import { FlatList, Pressable, Text } from 'react-native'; import { useConnection, useLogin, useMeTopic } from 'react-native-tinode'; import { ChatRoom } from './ChatRoom'; export function SupportChat() { const { status } = useConnection(); const { loginBasic, user } = useLogin(); useEffect(() => { loginBasic('alice', 'alice123'); }, [loginBasic]); if (!user) { return <Text>{status}...</Text>; } return <Chats />; } function Chats() { const { contacts } = useMeTopic(); const [openTopic, setOpenTopic] = useState<string | null>(null); if (openTopic) { return <ChatRoom topic={openTopic} onBack={() => setOpenTopic(null)} />; } return ( <FlatList data={contacts} keyExtractor={(item) => item.name} renderItem={({ item }) => ( <Pressable onPress={() => setOpenTopic(item.name)}> <Text> {(item.public as { fn?: string } | undefined)?.fn ?? item.name} {item.unread > 0 ? ` (${item.unread})` : ''} </Text> </Pressable> )} /> ); }

loginBasic خودش وصل میشه، لازم نیست اول connect صدا بزنید. لیست رو هم بعد از لاگین رندر کردم چون topic ـه me یا همون topic شخصی کاربر، فقط با کاربر لاگین شده کار میکنه. contacts هم مرتب شده میاد، آخرین چت اول لیسته.

۵. و خود صفحه چت، ChatRoom.tsx:

import { useEffect, useState } from 'react'; import { Button, FlatList, Text, TextInput, View } from 'react-native'; import { useMessages, useTyping } from 'react-native-tinode'; export function ChatRoom({ topic, onBack }: { topic: string; onBack: () => void }) { const { messages, hasMore, loadMore, send, markRead } = useMessages(topic, { pageSize: 20 }); const { typingUsers, notifyTyping } = useTyping(topic); const [text, setText] = useState(''); const lastSeq = messages[messages.length - 1]?.seq; useEffect(() => { if (lastSeq !== undefined) { markRead(lastSeq); } }, [markRead, lastSeq]); const submit = () => { if (text.trim()) { send(text.trim()); setText(''); } }; return ( <View style={{ flex: 1 }}> <Button title="Back" onPress={onBack} /> <FlatList inverted data={[...messages].reverse()} keyExtractor={(msg) => String(msg.seq)} Reached={() => hasMore && loadMore()} renderItem={({ item }) => ( <Text>{typeof item.content === 'string' ? item.content : item.content?.txt}</Text> )} /> {typingUsers.length > 0 && <Text>typing...</Text>} <TextInput value={text} placeholder="Write to support" Text={(value) => { setText(value); notifyTyping(); }} Editing={submit} /> </View> ); }

دیدید؟ توی این فایل نه onData هست، نه subscribe و نه leave. useMessages خودش subscribe میکنه، صفحه اول پیامها رو میاره، loadMore رو برای پیامهای قدیمیتر بهتون میده و markRead هم رسید خونده شدن یا همون read receipt رو برای طرف مقابل میفرسته. notifyTyping هم داخل کتابخونه throttle شده، پس با خیال راحت روی هر کلید صداش بزنید.

۶. اپ رو اجرا کنید، از لیست alice چت bob رو باز کنید و یه سلام بدید. ایول!

اپ نمونه روی شبیه‌ساز iOS
اپ نمونه روی شبیه‌ساز iOS


کش، که چتها سریع باز بشن

به صورت پیشفرض هیچی کش نمیشه (persist: false). اگر میخواید چتها همون لحظه باز شدن اپ نمایش داده بشن و آفلاین هم قابل خوندن باشن، یه store بهش بدید. برای اپ Expo من expo-sqlite/kv-store رو پیشنهاد میکنم، چون توی Expo Go کار میکنه و محدودیت حجمی که AsyncStorage روی اندروید داره رو نداره:

yarn expo install expo-sqlite

بعد config رو اینطوری عوض کنید:

import Storage from 'expo-sqlite/kv-store'; import { KeyValueAdapter } from 'react-native-tinode'; const config = { appName: 'CoinWallet/1.0', host: 'localhost:6060', apiKey: 'AQEAAAABAAD_rAp4DJh05a1HAwFT3A6K', secure: false, persist: true, storage: new KeyValueAdapter(Storage), };

این adapter‌ها الآن توی خود tinode-sdk هستن و react-native-tinode فقط export شون می‌کنه. اگر اپتون @react-native-community/netinfo داره، netInfo: NetInfo رو هم توی همین config بذارید که کلاینت همون لحظه برگشتن شبکه دوباره وصل بشه.

روی وب persist: true از IndexedDB استفاده می‌کنه و store نمی‌خواد، برای همین store رو توی یه فایل .native.ts بذارید. برای React Native خالی راهنمای MMKV هست و اگر اپتون از قبل AsyncStorage داره، راهنمای اون هم هست. اینجا بیشتر از این توضیح نمیدم که متن طولانی نشه، همه‌شون توی فولدر docs هستن. توکن لاگین رو هم کتابخونه کش نمی‌کنه، یه راهنمای جدا برای لاگین موندن کاربر با expo-secure-store نوشتم.


مثال کامل

توی ریپو یه اپ Expo نمونه هست که لاگین، لیست مخاطبها، صفحهبندی پیامها و «داره مینویسه» رو داره. ریپو رو clone کنید، توی root یه yarn بزنید و بعد:

EXPO_PUBLIC_TINODE_HOST=localhost:6060 EXPO_PUBLIC_TINODE_SECURE=false yarn example start

بعدش چی؟

PR بعدی من به tinode-js قراره fix‌های runtime ـه React Native رو بیاره توی خود SDK (fallback‌های Hermes و دانلود بدون DOM) و بعد از اون دو تا polyfill من هم میرن کنار. تا اون موقع download() ـه helper فایل‌های بزرگ فقط روی وب کار می‌کنه و روی موبایل باید خودتون با fetch فایل رو دانلود کنید. یه adapter ـه SQLite هم برای تاریخچه‌های آفلاین بزرگ توی برنامه هست که می‌تونید توی issue شماره ۱ دنبالش کنید. push notification هم با registerDeviceToken کار می‌کنه ولی اون بماند برای یه مقاله دیگه.

اگر شما هم Tinode رو توی React Native استفاده میکنید یه امتحانش کنید و هر جا خراب شد بهم بگید، به همه issueها جواب میدم. اگر هم ایده بهتری دارید fork کنید و PR بدید، با کمال میل قبول میکنم.

از or-else هم ممنونم که PR من رو review و merge کرد.

امیدوارم به دردتون بخوره، شاد و موفق باشید.

react nativechat
۰
۰
عامر لطفی اوریمی
عامر لطفی اوریمی
دولوپر فرانت‌اند - علاقمند به جاوااسکریپ (تایپ‌اسکریپت)، ری‌اکت، ری‌اکت‌نیتیو - فرانت‌اند دولوپر سابق دیجی‌کالا، دیجی‌کالامگ، شیپور و سیبچه
شاید از این پست‌ها خوشتان بیاید