{item.datetime}
25 |{item.message}
26 | { 27 | item?.payload ? 28 |
35 |
36 | {item?.payload}
37 |
38 |
39 |
{app_name}
32 |
33 |
41 |
42 | ## More Info
43 |
44 | This is a basic approach towards making a websocket tester app which can be used to test the logic of any websocket server. Often we need to implement a websocket server for ourselves. However, testing process of the inner logic of the websocket quickly becomes tiresome. This app aims to lessen that effort.
45 |
46 | Spare a ⭐ to keep me motivated. 😃
47 |
48 | ## License
49 |
50 | This software is licensed under the MIT License (MIT). You are free to use and modify the code. A simple mention or reference would be highly appreciated.
51 |
--------------------------------------------------------------------------------
/src/serviceWorker.js:
--------------------------------------------------------------------------------
1 | // This optional code is used to register a service worker.
2 | // register() is not called by default.
3 |
4 | // This lets the app load faster on subsequent visits in production, and gives
5 | // it offline capabilities. However, it also means that developers (and users)
6 | // will only see deployed updates on subsequent visits to a page, after all the
7 | // existing tabs open on the page have been closed, since previously cached
8 | // resources are updated in the background.
9 |
10 | // To learn more about the benefits of this model and instructions on how to
11 | // opt-in, read https://bit.ly/CRA-PWA
12 |
13 | const isLocalhost = Boolean(
14 | window.location.hostname === 'localhost' ||
15 | // [::1] is the IPv6 localhost address.
16 | window.location.hostname === '[::1]' ||
17 | // 127.0.0.0/8 are considered localhost for IPv4.
18 | window.location.hostname.match(
19 | /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/
20 | )
21 | );
22 |
23 | export function register(config) {
24 | if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) {
25 | // The URL constructor is available in all browsers that support SW.
26 | const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href);
27 | if (publicUrl.origin !== window.location.origin) {
28 | // Our service worker won't work if PUBLIC_URL is on a different origin
29 | // from what our page is served on. This might happen if a CDN is used to
30 | // serve assets; see https://github.com/facebook/create-react-app/issues/2374
31 | return;
32 | }
33 |
34 | window.addEventListener('load', () => {
35 | const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`;
36 |
37 | if (isLocalhost) {
38 | // This is running on localhost. Let's check if a service worker still exists or not.
39 | checkValidServiceWorker(swUrl, config);
40 |
41 | // Add some additional logging to localhost, pointing developers to the
42 | // service worker/PWA documentation.
43 | navigator.serviceWorker.ready.then(() => {
44 | console.log(
45 | 'This web app is being served cache-first by a service ' +
46 | 'worker. To learn more, visit https://bit.ly/CRA-PWA'
47 | );
48 | });
49 | } else {
50 | // Is not localhost. Just register service worker
51 | registerValidSW(swUrl, config);
52 | }
53 | });
54 | }
55 | }
56 |
57 | function registerValidSW(swUrl, config) {
58 | navigator.serviceWorker
59 | .register(swUrl)
60 | .then(registration => {
61 | registration.onupdatefound = () => {
62 | const installingWorker = registration.installing;
63 | if (installingWorker == null) {
64 | return;
65 | }
66 | installingWorker.onstatechange = () => {
67 | if (installingWorker.state === 'installed') {
68 | if (navigator.serviceWorker.controller) {
69 | // At this point, the updated precached content has been fetched,
70 | // but the previous service worker will still serve the older
71 | // content until all client tabs are closed.
72 | console.log(
73 | 'New content is available and will be used when all ' +
74 | 'tabs for this page are closed. See https://bit.ly/CRA-PWA.'
75 | );
76 |
77 | // Execute callback
78 | if (config && config.onUpdate) {
79 | config.onUpdate(registration);
80 | }
81 | } else {
82 | // At this point, everything has been precached.
83 | // It's the perfect time to display a
84 | // "Content is cached for offline use." message.
85 | console.log('Content is cached for offline use.');
86 |
87 | // Execute callback
88 | if (config && config.onSuccess) {
89 | config.onSuccess(registration);
90 | }
91 | }
92 | }
93 | };
94 | };
95 | })
96 | .catch(error => {
97 | console.error('Error during service worker registration:', error);
98 | });
99 | }
100 |
101 | function checkValidServiceWorker(swUrl, config) {
102 | // Check if the service worker can be found. If it can't reload the page.
103 | fetch(swUrl, {
104 | headers: { 'Service-Worker': 'script' },
105 | })
106 | .then(response => {
107 | // Ensure service worker exists, and that we really are getting a JS file.
108 | const contentType = response.headers.get('content-type');
109 | if (
110 | response.status === 404 ||
111 | (contentType != null && contentType.indexOf('javascript') === -1)
112 | ) {
113 | // No service worker found. Probably a different app. Reload the page.
114 | navigator.serviceWorker.ready.then(registration => {
115 | registration.unregister().then(() => {
116 | window.location.reload();
117 | });
118 | });
119 | } else {
120 | // Service worker found. Proceed as normal.
121 | registerValidSW(swUrl, config);
122 | }
123 | })
124 | .catch(() => {
125 | console.log(
126 | 'No internet connection found. App is running in offline mode.'
127 | );
128 | });
129 | }
130 |
131 | export function unregister() {
132 | if ('serviceWorker' in navigator) {
133 | navigator.serviceWorker.ready
134 | .then(registration => {
135 | registration.unregister();
136 | })
137 | .catch(error => {
138 | console.error(error.message);
139 | });
140 | }
141 | }
142 |
--------------------------------------------------------------------------------
/src/components/WsClient.jsx:
--------------------------------------------------------------------------------
1 | import React, { useState, useRef, useEffect } from 'react';
2 | import dayjs from 'dayjs';
3 |
4 | import {
5 | Icon,
6 | Input,
7 | InputGroup,
8 | Panel,
9 | PanelGroup,
10 | Button,
11 | Notification,
12 | IconButton,
13 | Row,
14 | Col
15 | } from 'rsuite';
16 | import ResponsiveNav from '@rsuite/responsive-nav';
17 |
18 | import LogItem from './LogItem';
19 | import PayloadPopup from './PayloadPopup';
20 |
21 | import { useTracked } from './../Store';
22 |
23 | let websocket = null;
24 | let wsHost = '';
25 |
26 | const WsClient = (props) => {
27 |
28 | const [state, setState] = useTracked();
29 | const [connection, setConnection] = useState({ connected: false, connecting: false });
30 |
31 | const host = useRef();
32 | const payload = useRef();
33 | const stateRef = useRef({
34 | connectionLog: state.connectionLog,
35 | retryCount: 0,
36 | autoConnect: state.autoConnect
37 | });
38 |
39 | useEffect(() => {
40 | stateRef.current.autoConnect = state.autoConnect;
41 | }, [state.autoConnect]);
42 |
43 | useEffect(() => {
44 | let currentPayload = state.payloads.find(payload => payload.id === state.activePayload);
45 | if (!currentPayload) {
46 | setState(prev => ({ ...prev, activePayload: '0' }));
47 | }
48 | payload.current.value = state.payloads.find(payload => payload.id === state.activePayload)?.payload;
49 | }, [state.activePayload, state.payloads, setState]);
50 |
51 | const updateLog = (log) => {
52 | stateRef.current.connectionLog.unshift(log);
53 | setState(prev => ({ ...prev, connectionLog: [...stateRef.current.connectionLog] }));
54 | };
55 |
56 | const clearLog = () => {
57 | stateRef.current.connectionLog = [{
58 | datetime: dayjs().format('YYYY-MM-DD hh:mm:ss A'),
59 | message: `App started`
60 | }];
61 | setState(prev => ({
62 | ...prev, connectionLog: stateRef.current.connectionLog
63 | }));
64 | };
65 |
66 | const onOpen = (event) => {
67 | stateRef.current.retryCount = 0;
68 | updateLog({
69 | datetime: dayjs().format('YYYY-MM-DD hh:mm:ss A'),
70 | message: `Connected to "${event.target.url}"`
71 | });
72 | setConnection({ ...connection, connected: true, connecting: false });
73 | payload.current.focus();
74 | };
75 |
76 | const onMessage = (event) => {
77 | // console.log(event);
78 | updateLog({
79 | datetime: dayjs().format('YYYY-MM-DD hh:mm:ss A'),
80 | message: `Message received from "${event.origin}"`,
81 | payload: event.data,
82 | dataflow: 'incoming'
83 | });
84 | };
85 |
86 | const onError = (event) => {
87 | // Error handling
88 | // console.error(event);
89 | updateLog({
90 | datetime: dayjs().format('YYYY-MM-DD hh:mm:ss A'),
91 | message: `Could not connect to "${event.target.url}". You may be able to find more information using inspector.`
92 | });
93 | setConnection({ ...connection, connected: false, connecting: false });
94 | };
95 |
96 | const onClose = (event) => {
97 | // Close handling
98 | // console.log(event);
99 | updateLog({
100 | datetime: dayjs().format('YYYY-MM-DD hh:mm:ss A'),
101 | message: `Connection closed "${event.target.url}"`
102 | });
103 | setConnection({ ...connection, connected: false, connecting: false });
104 | reconnect();
105 | };
106 |
107 | const reconnect = () => {
108 | if (stateRef.current.autoConnect) {
109 | if (stateRef.current.retryCount >= 3) {
110 | Notification.warning({ title: 'Warning', description: `Stopped trying to reconnect after ${stateRef.current.retryCount} attempts.` });
111 | stateRef.current.retryCount = 0;
112 | }
113 | else {
114 | stateRef.current.retryCount = stateRef.current.retryCount + 1;
115 | connect();
116 | Notification.info({ title: 'Info', description: `Tried to reconnect ${stateRef.current.retryCount} times.` });
117 | }
118 | }
119 | };
120 |
121 | const connect = () => {
122 | if (host.current.value === '') {
123 | Notification.error({ title: 'Error', description: 'Websocket host is not defined.' });
124 | }
125 | else {
126 | wsHost = `${state.secure ? 'wss://' : 'ws://'}${host.current.value}`;
127 |
128 | setState(prev => ({ ...prev, host: host.current.value }));
129 | if (websocket?.readyState !== 1) {
130 | updateLog({
131 | datetime: dayjs().format('YYYY-MM-DD hh:mm:ss A'),
132 | message: `Connecting to "${wsHost}/"`
133 | });
134 | setConnection({ ...connection, connecting: true });
135 |
136 | if (state.protocols === '') {
137 | websocket = new WebSocket(wsHost);
138 | }
139 | else {
140 | websocket = new WebSocket(wsHost, state.protocols.replace(/\s+/g, '').split(','));
141 | }
142 | }
143 |
144 | websocket.onopen = onOpen;
145 | websocket.onmessage = onMessage;
146 | websocket.onerror = onError;
147 | websocket.onclose = onClose;
148 | }
149 | };
150 |
151 | const disconnect = () => {
152 | if (websocket?.readyState === 1) {
153 | websocket.close();
154 | }
155 | };
156 |
157 | const sendMessage = (message) => {
158 | // console.log(websocket?.readyState);
159 | setState(prev => ({
160 | ...prev, payloads: state.payloads.map(item => {
161 | if (item.id === state.activePayload) {
162 | return { ...item, payload: message };
163 | }
164 | return item;
165 | })
166 | }));
167 | switch (websocket?.readyState) {
168 | case 1:
169 | if (message) {
170 | websocket.send(message);
171 | updateLog({
172 | datetime: dayjs().format('YYYY-MM-DD hh:mm:ss A'),
173 | message: `Payload send to "${wsHost}"`,
174 | payload: message,
175 | dataflow: 'outgoing'
176 | });
177 | break;
178 | }
179 |
180 | Notification.error({ title: 'Error', description: 'Payload is empty.' });
181 | break;
182 |
183 | default:
184 | Notification.error({ title: 'Error', description: 'Websocket disconnected.' });
185 | break;
186 | }
187 |
188 | };
189 |
190 | return (
191 |