|
| 1 | +import React from 'react'; |
| 2 | +import Sockette from 'sockette'; |
| 3 | +import throttle from 'lodash/throttle'; |
| 4 | +import { withSnackbar, WithSnackbarProps } from 'notistack'; |
| 5 | + |
| 6 | +import { addAccessTokenParameter } from '../authentication'; |
| 7 | +import { extractEventValue } from '.'; |
| 8 | + |
| 9 | +export interface WebSocketControllerProps<D> extends WithSnackbarProps { |
| 10 | + handleValueChange: (name: keyof D) => (event: React.ChangeEvent<HTMLInputElement>) => void; |
| 11 | + |
| 12 | + setData: (data: D, callback?: () => void) => void; |
| 13 | + saveData: () => void; |
| 14 | + saveDataAndClear(): () => void; |
| 15 | + |
| 16 | + connected: boolean; |
| 17 | + data?: D; |
| 18 | +} |
| 19 | + |
| 20 | +interface WebSocketControllerState<D> { |
| 21 | + ws: Sockette; |
| 22 | + connected: boolean; |
| 23 | + clientId?: string; |
| 24 | + data?: D; |
| 25 | +} |
| 26 | + |
| 27 | +enum WebSocketMessageType { |
| 28 | + ID = "id", |
| 29 | + PAYLOAD = "payload" |
| 30 | +} |
| 31 | + |
| 32 | +interface WebSocketIdMessage { |
| 33 | + type: typeof WebSocketMessageType.ID; |
| 34 | + id: string; |
| 35 | +} |
| 36 | + |
| 37 | +interface WebSocketPayloadMessage<D> { |
| 38 | + type: typeof WebSocketMessageType.PAYLOAD; |
| 39 | + origin_id: string; |
| 40 | + payload: D; |
| 41 | +} |
| 42 | + |
| 43 | +export type WebSocketMessage<D> = WebSocketIdMessage | WebSocketPayloadMessage<D>; |
| 44 | + |
| 45 | +export function webSocketController<D, P extends WebSocketControllerProps<D>>(wsUrl: string, wsThrottle: number, WebSocketController: React.ComponentType<P & WebSocketControllerProps<D>>) { |
| 46 | + return withSnackbar( |
| 47 | + class extends React.Component<Omit<P, keyof WebSocketControllerProps<D>> & WithSnackbarProps, WebSocketControllerState<D>> { |
| 48 | + constructor(props: Omit<P, keyof WebSocketControllerProps<D>> & WithSnackbarProps) { |
| 49 | + super(props); |
| 50 | + this.state = { |
| 51 | + ws: new Sockette(addAccessTokenParameter(wsUrl), { |
| 52 | + onmessage: this.onMessage, |
| 53 | + onopen: this.onOpen, |
| 54 | + onclose: this.onClose, |
| 55 | + }), |
| 56 | + connected: false |
| 57 | + } |
| 58 | + } |
| 59 | + |
| 60 | + componentWillUnmount() { |
| 61 | + this.state.ws.close(); |
| 62 | + } |
| 63 | + |
| 64 | + onMessage = (event: MessageEvent) => { |
| 65 | + const rawData = event.data; |
| 66 | + if (typeof rawData === 'string' || rawData instanceof String) { |
| 67 | + this.handleMessage(JSON.parse(rawData as string) as WebSocketMessage<D>); |
| 68 | + } |
| 69 | + } |
| 70 | + |
| 71 | + handleMessage = (message: WebSocketMessage<D>) => { |
| 72 | + switch (message.type) { |
| 73 | + case WebSocketMessageType.ID: |
| 74 | + this.setState({ clientId: message.id }); |
| 75 | + break; |
| 76 | + case WebSocketMessageType.PAYLOAD: |
| 77 | + const { clientId, data } = this.state; |
| 78 | + if (clientId && (!data || clientId !== message.origin_id)) { |
| 79 | + this.setState( |
| 80 | + { data: message.payload } |
| 81 | + ); |
| 82 | + } |
| 83 | + break; |
| 84 | + } |
| 85 | + } |
| 86 | + |
| 87 | + onOpen = () => { |
| 88 | + this.setState({ connected: true }); |
| 89 | + } |
| 90 | + |
| 91 | + onClose = () => { |
| 92 | + this.setState({ connected: false, clientId: undefined, data: undefined }); |
| 93 | + } |
| 94 | + |
| 95 | + setData = (data: D, callback?: () => void) => { |
| 96 | + this.setState({ data }, callback); |
| 97 | + } |
| 98 | + |
| 99 | + saveData = throttle(() => { |
| 100 | + const { ws, connected, data } = this.state; |
| 101 | + if (connected) { |
| 102 | + ws.json(data); |
| 103 | + } |
| 104 | + }, wsThrottle); |
| 105 | + |
| 106 | + saveDataAndClear = throttle(() => { |
| 107 | + const { ws, connected, data } = this.state; |
| 108 | + if (connected) { |
| 109 | + this.setState({ |
| 110 | + data: undefined |
| 111 | + }, () => ws.json(data)); |
| 112 | + } |
| 113 | + }, wsThrottle); |
| 114 | + |
| 115 | + handleValueChange = (name: keyof D) => (event: React.ChangeEvent<HTMLInputElement>) => { |
| 116 | + const data = { ...this.state.data!, [name]: extractEventValue(event) }; |
| 117 | + this.setState({ data }); |
| 118 | + } |
| 119 | + |
| 120 | + render() { |
| 121 | + return <WebSocketController |
| 122 | + handleValueChange={this.handleValueChange} |
| 123 | + setData={this.setData} |
| 124 | + saveData={this.saveData} |
| 125 | + saveDataAndClear={this.saveDataAndClear} |
| 126 | + connected={this.state.connected} |
| 127 | + data={this.state.data} |
| 128 | + {...this.props as P} |
| 129 | + />; |
| 130 | + } |
| 131 | + |
| 132 | + }); |
| 133 | +} |
0 commit comments