29 |
57 | );
58 | };
59 |
60 | export default CodeEditor;
61 |
--------------------------------------------------------------------------------
/src/main.rs:
--------------------------------------------------------------------------------
1 | use crate::single::ONLINE_USERS;
2 | use clap::Parser;
3 | use rust_embed::RustEmbed;
4 | use salvo::prelude::*;
5 | use salvo::serve_static::static_embed;
6 | use serde::Serialize;
7 | use tracing_subscriber::EnvFilter;
8 |
9 | mod broadcast;
10 | mod single;
11 |
12 | #[cfg(test)]
13 | mod tests;
14 |
15 | #[derive(RustEmbed)]
16 | #[folder = "static"]
17 | struct Assets;
18 |
19 | /// A lightweight WebSocket server for real-time messaging.
20 | #[derive(Parser, Debug)]
21 | #[command(author, version, about, long_about = None)]
22 | struct Cli {
23 | /// The port to listen on.
24 | #[arg(short, long, default_value_t = 5800)]
25 | port: u16,
26 | }
27 |
28 | #[handler]
29 | async fn health(res: &mut Response) {
30 | res.status_code(StatusCode::OK);
31 | }
32 |
33 | #[handler]
34 | async fn version() -> String {
35 | env!("CARGO_PKG_VERSION").to_string()
36 | }
37 |
38 | #[derive(Serialize)]
39 | struct ConnectionCount {
40 | count: usize,
41 | }
42 |
43 | #[handler]
44 | pub async fn connections(req: &mut Request, res: &mut Response) {
45 | let string_uid = req.query::WebSocket Message Handler Code
30 |
53 | Edit the JavaScript function body above to customize how WebSocket messages are handled, it now outputs receiving data to dev console.
54 | The function will receive: event (MessageEvent), arrayBufferToBase64 (function), sendMessage (function).
55 |
40 |
110 | );
111 | };
112 |
113 | export default WebSocketConfigComponent;
114 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Notir
2 |
3 | [](https://github.com/timzaak/notir/pkgs/container/notir)
4 |
5 | `Notir` is a lightweight WebSocket server built with Rust using the Salvo web framework and Tokio. It allows users to connect via WebSockets, subscribe to a real-time message feed, and publish messages to other connected clients.
6 |
7 | Feel free to open an issue anytime, for any reason.
8 |
9 | ## Features
10 |
11 | - WebSocket communication for real-time messaging.
12 | - Simple publish/subscribe model.
13 | - Containerized with Docker for easy deployment.
14 |
15 | ## Getting Started
16 |
17 | ### Quick Try
18 |
19 | It has been deployed on the public server, you can try it out right away:
20 | ```
21 | http://notir.fornetcode.com:5800?id=${uuid}
22 | ```
23 | Please change `uuid` to whatever you want, and now you can publish
24 | messages to the server like this:
25 |
26 | ```bash
27 | # Single mode - Point-to-point messaging
28 | curl -X POST http://notir.fornetcode.com:5800/single/pub?id=${uuid} \
29 | -H 'Content-Type: application/json' \
30 | -d '{"msg": "hello world"}'
31 |
32 | # Single mode with PingPong - Two-way communication
33 | curl -X POST http://notir.fornetcode.com:5800/single/pub?id=${uuid}&mode=ping_pong \
34 | -H 'Content-Type: application/json' \
35 | -d '{"msg": "hello world"}'
36 |
37 | # Broadcast mode - Message to all subscribers of a channel
38 | curl -X POST http://notir.fornetcode.com:5800/broad/pub?id=${uuid} \
39 | -H 'Content-Type: application/json' \
40 | -d '{"msg": "broadcast message"}'
41 | ```
42 |
43 | WebSocket Config
41 |
42 |
43 |
104 | {showNotification && (
105 |
44 |
47 |
56 |
57 |
58 |
59 |
62 |
72 |
73 |
63 | handleConfigChange('enableReconnect', e.target.checked)}
68 | className="text-blue-600 bg-gray-100 border-gray-300 rounded focus:ring-blue-500 focus:ring-2 disabled:opacity-50"
69 | />
70 |
71 |
74 |
77 | handleConfigChange('reconnectInterval', parseInt(e.target.value) || 3000)}
85 | className="px-3 py-1 text-sm border border-gray-300 rounded-md focus:outline-none focus:ring-2 focus:ring-blue-500 focus:border-transparent disabled:opacity-50 disabled:bg-gray-100"
86 | />
87 |
88 |
89 |
90 |
93 | handleConfigChange('maxReconnectAttempts', parseInt(e.target.value) || 5)}
100 | className="px-3 py-1 text-sm border border-gray-300 rounded-md focus:outline-none focus:ring-2 focus:ring-blue-500 focus:border-transparent disabled:opacity-50 disabled:bg-gray-100"
101 | />
102 |
103 |
106 |
108 | )}
109 | Need refresh the page for the auto connect change to take effect.
107 |
44 |
45 | ### Self Hosted
46 |
47 | The easiest way to run `Notir` is by using the pre-built Docker image available
48 | on GitHub Container Registry.
49 |
50 | ```bash
51 | docker run -d -p 5800:5800 --name notir ghcr.io/timzaak/notir:latest
52 |
53 | #The server will start on port 5800 by default. You can specify a different port using the `--port` or `-p` flag.
54 |
55 | docker run -d -p 8698:8698 --name notir ghcr.io/timzaak/notir:latest -- --port 8698
56 | ```
57 |
58 | ## API Endpoints
59 |
60 | ### Single Mode (Point-to-Point Communication)
61 |
62 | - `WS /single/sub?id=
70 |
84 |
238 |
239 |
240 |
--------------------------------------------------------------------------------
/src/single.rs:
--------------------------------------------------------------------------------
1 | use std::collections::VecDeque;
2 | use std::sync::LazyLock;
3 |
4 | use salvo::prelude::*;
5 | use salvo::websocket::{Message, WebSocket, WebSocketUpgrade};
6 |
7 | use bytes::Bytes;
8 | use dashmap::DashMap;
9 | use futures_util::{FutureExt, StreamExt};
10 | use nanoid::nanoid;
11 | use serde::Deserialize;
12 | use tokio::sync::{mpsc, oneshot};
13 | use tokio::time::{Duration, interval, timeout};
14 | use tokio_stream::wrappers::UnboundedReceiverStream;
15 |
16 | #[derive(Deserialize, Debug, Default)]
17 | #[serde(rename_all = "snake_case")]
18 | pub enum Mode {
19 | #[default]
20 | Shot,
21 | PingPong,
22 | }
23 |
24 | type Users = DashMapNOTIR
71 |
72 |
74 | Current Mode: Unknown
73 |
75 |
77 | Checking for ID in URL...
76 |
78 |
83 | 79 | Press Ctrl+Shift+J (Windows/Linux) or Cmd+Option+J (Mac) to 80 | open the Developer Console to see messages. 81 |
82 |
232 |
270 | );
271 | }
272 |
273 | export default App;
274 |
--------------------------------------------------------------------------------
/LICENSE-APACHE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [2025] [Timzaak]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
--------------------------------------------------------------------------------
/src/tests.rs:
--------------------------------------------------------------------------------
1 | #[cfg(test)]
2 | mod test {
3 | use crate::broadcast::{BROADCAST_USERS, Connection};
4 | use crate::single::{CALLBACK_CHANNELS, Mode, ONLINE_USERS, user_disconnected};
5 | use bytes::Bytes;
6 | use std::time::Duration;
7 | use tokio::sync::mpsc;
8 | use tokio::time::timeout;
9 |
10 | #[tokio::test]
11 | async fn test_single_shot_mode() {
12 | // 测试 Mode::Shot 的反序列化
13 | let mode_json = r#""shot""#;
14 | let mode: Mode = serde_json::from_str(mode_json).unwrap();
15 | assert!(matches!(mode, Mode::Shot));
16 |
17 | // 测试用户连接和消息发送逻辑
18 | let user_id = "test_user_shot".to_string();
19 | let (tx, mut rx) = mpsc::unbounded_channel();
20 |
21 | // 模拟用户连接
22 | let conn_id = "test_conn".to_string();
23 | ONLINE_USERS
24 | .entry(user_id.clone())
25 | .or_default()
26 | .insert(conn_id.clone(), tx);
27 |
28 | // 验证用户已连接
29 | assert!(ONLINE_USERS.contains_key(&user_id), "用户应该已连接");
30 |
31 | // 模拟发送消息到用户
32 | let test_message = "Hello from single shot test";
33 | if let Some(user_conns) = ONLINE_USERS.get(&user_id)
34 | && let Some(conn) = user_conns.get(&conn_id)
35 | {
36 | let msg = salvo::websocket::Message::text(test_message);
37 | assert!(conn.send(Ok(msg)).is_ok(), "消息发送应该成功");
38 | }
39 |
40 | // 验证消息接收
41 | let received = timeout(Duration::from_secs(1), rx.recv()).await;
42 | assert!(received.is_ok(), "应该接收到消息");
43 |
44 | // 清理
45 | ONLINE_USERS.remove(&user_id);
46 | }
47 |
48 | #[tokio::test]
49 | async fn test_ping_pong_mode() {
50 | // 测试 Mode::PingPong 的反序列化
51 | let mode_json = r#""ping_pong""#;
52 | let mode: Mode = serde_json::from_str(mode_json).unwrap();
53 | assert!(matches!(mode, Mode::PingPong));
54 |
55 | // 测试ping-pong模式的回调机制
56 | let user_id = "test_user_pingpong".to_string();
57 | let (tx, _rx) = mpsc::unbounded_channel();
58 |
59 | // 模拟用户连接
60 | let conn_id = "test_conn".to_string();
61 | ONLINE_USERS
62 | .entry(user_id.clone())
63 | .or_default()
64 | .insert(conn_id.clone(), tx);
65 |
66 | // 创建回调通道
67 | let (callback_tx, callback_rx) = tokio::sync::oneshot::channel();
68 | let callback_id = nanoid::nanoid!();
69 |
70 | // 添加回调到队列
71 | {
72 | let mut entry = CALLBACK_CHANNELS.entry(user_id.clone()).or_default();
73 | entry.push_back((callback_id.clone(), callback_tx));
74 | }
75 |
76 | // 验证回调通道已添加
77 | {
78 | let entry = CALLBACK_CHANNELS.get(&user_id).unwrap();
79 | assert_eq!(entry.len(), 1, "应该有一个回调通道");
80 | }
81 |
82 | // 模拟客户端回复
83 | let response_data = Bytes::from("Pong response from client");
84 | let user_id_clone = user_id.clone();
85 | tokio::spawn(async move {
86 | tokio::time::sleep(Duration::from_millis(10)).await;
87 | if let Some(mut entry) = CALLBACK_CHANNELS.get_mut(&user_id_clone)
88 | && let Some((_id, tx)) = entry.pop_front()
89 | {
90 | let _ = tx.send(response_data);
91 | }
92 | });
93 |
94 | // 等待回调响应
95 | let result = timeout(Duration::from_secs(1), callback_rx).await;
96 | assert!(result.is_ok(), "应该接收到回调响应");
97 |
98 | let response = result.unwrap().unwrap();
99 | assert_eq!(
100 | response,
101 | Bytes::from("Pong response from client"),
102 | "回调响应内容应该匹配"
103 | );
104 |
105 | // 清理
106 | ONLINE_USERS.remove(&user_id);
107 | CALLBACK_CHANNELS.remove(&user_id);
108 | }
109 |
110 | #[tokio::test]
111 | async fn test_single_shot_user_not_found() {
112 | // 测试向不存在的用户发送消息
113 | let non_existent_user = "non_existent_user".to_string();
114 |
115 | // 确保用户不存在
116 | assert!(
117 | !ONLINE_USERS.contains_key(&non_existent_user),
118 | "用户不应该存在"
119 | );
120 |
121 | // 模拟查找不存在的用户
122 | let user_found = ONLINE_USERS.get(&non_existent_user).is_some();
123 |
124 | assert!(!user_found, "不存在的用户查找应该返回false");
125 | }
126 |
127 | #[tokio::test]
128 | async fn test_ping_pong_timeout() {
129 | // 测试ping-pong模式的超时机制
130 | let user_id = "test_user_timeout".to_string();
131 | let (tx, _rx) = mpsc::unbounded_channel();
132 |
133 | // 模拟用户连接
134 | let conn_id = "test_conn".to_string();
135 | ONLINE_USERS
136 | .entry(user_id.clone())
137 | .or_default()
138 | .insert(conn_id.clone(), tx);
139 |
140 | // 创建回调通道但不回复
141 | let (callback_tx, callback_rx) = tokio::sync::oneshot::channel::NOTIR
233 |{statusMessage}
234 |
235 |
239 |
240 | 236 | Press Ctrl+Shift+J (Windows/Linux) or Cmd+Option+J (Mac) to see message. 237 |
238 |