chore: Implement `useWriteStream` ServerContext (#36715)

Co-authored-by: Pierre Lehnen <55164754+pierre-lehnen-rc@users.noreply.github.com>

apps/meteor/client/providers/ServerProvider.tsx

@@ -69,6 +69,9 @@ const getStream =
 	<K extends StreamKeys<N>>(eventName: K, callback: (...args: StreamerCallbackArgs<N, K>) => void): (() => void) =>
 		sdk.stream(streamName, [eventName], callback).stop;
 
+const writeStream = <N extends StreamNames, K extends StreamKeys<N>>(streamName: N, streamKey: K, ...args: StreamerCallbackArgs<N, K>) =>
+	sdk.publish(streamName, [streamKey, ...args]);
+
 const disconnect = () => Meteor.disconnect();
 
 const reconnect = () => Meteor.reconnect();
@@ -92,6 +95,7 @@ const ServerProvider = ({ children }: ServerProviderProps) => {
 			callEndpoint,
 			uploadToEndpoint,
 			getStream,
+			writeStream,
 			disconnect,
 			reconnect,
 		}),

apps/meteor/tests/mocks/client/ServerProviderMock.tsx

@@ -59,6 +59,7 @@ const getStream = () => () => () => undefined; // to be implemented
 const callEndpoint = () => {
 	throw new Error('not implemented');
 }; // to be implemented
+const writeStream = () => undefined; // to be implemented
 
 const contextValue: ServerContextValue = {
 	connected: true,
@@ -72,6 +73,7 @@ const contextValue: ServerContextValue = {
 	getStream,
 	reconnect: () => undefined,
 	disconnect: () => undefined,
+	writeStream,
 };
 
 type ServerProviderMockProps = {

packages/mock-providers/src/MockedAppRootBuilder.tsx

@@ -85,6 +85,7 @@ export class MockedAppRootBuilder {
 		callMethod: () => Promise.reject(new Error('not implemented')),
 		disconnect: () => Promise.reject(new Error('not implemented')),
 		reconnect: () => Promise.reject(new Error('not implemented')),
+		writeStream: () => Promise.reject(new Error('not implemented')),
 	};
 
 	private router: ContextType<typeof RouterContext> = {

packages/ui-contexts/src/ServerContext.ts

@@ -48,6 +48,7 @@ export type ServerContextValue = {
 			retransmitToSelf?: boolean | undefined;
 		},
 	) => (eventName: K, callback: (...args: StreamerCallbackArgs<N, K>) => void) => () => void;
+	writeStream: <N extends StreamNames, K extends StreamKeys<N>>(streamName: N, eventName: K, ...args: StreamerCallbackArgs<N, K>) => void;
 	disconnect: () => void;
 	reconnect: () => void;
 };
@@ -65,6 +66,9 @@ export const ServerContext = createContext<ServerContextValue>({
 		throw new Error('not implemented');
 	},
 	getStream: () => () => (): void => undefined,
+	writeStream: () => {
+		throw new Error('not implemented');
+	},
 	disconnect: () => {
 		throw new Error('not implemented');
 	},

packages/ui-contexts/src/hooks/useWriteStream.ts

@@ -0,0 +1,19 @@
+import type { StreamNames, StreamKeys, StreamerCallbackArgs } from '@rocket.chat/ddp-client';
+import { useCallback, useContext } from 'react';
+
+import { ServerContext } from '../ServerContext';
+
+type WriteStreamCallback<N extends StreamNames> = <K extends StreamKeys<N>>(eventName: K, ...args: StreamerCallbackArgs<N, K>) => void;
+
+export function useWriteStream<N extends StreamNames>(streamName: N): WriteStreamCallback<N> {
+	const { writeStream } = useContext(ServerContext);
+
+	if (!writeStream) {
+		throw new Error(`cannot use useWriteStream(${streamName}) hook without a wrapping ServerContext`);
+	}
+
+	return useCallback(
+		<K extends StreamKeys<N>>(eventName: K, ...args: StreamerCallbackArgs<N, K>) => writeStream(streamName, eventName, ...args),
+		[writeStream, streamName],
+	);
+}

packages/ui-contexts/src/index.ts

@@ -96,6 +96,7 @@ export { useAccountsCustomFields } from './hooks/useAccountsCustomFields';
 export { useUserPresence } from './hooks/useUserPresence';
 export { useUnstoreLoginToken } from './hooks/useUnstoreLoginToken';
 export { useOnLogout } from './hooks/useOnLogout';
+export { useWriteStream } from './hooks/useWriteStream';
 
 export { UploadResult } from './ServerContext';
 export { TranslationKey, TranslationLanguage } from './TranslationContext';