1use futures::io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt as _};
2use prost::Message;
3use std::{
4 convert::TryInto,
5 io,
6 time::{Duration, SystemTime, UNIX_EPOCH},
7};
8
9include!(concat!(env!("OUT_DIR"), "/zed.messages.rs"));
10
11pub trait EnvelopedMessage: Sized + Send + 'static {
12 const NAME: &'static str;
13 fn into_envelope(
14 self,
15 id: u32,
16 responding_to: Option<u32>,
17 original_sender_id: Option<u32>,
18 ) -> Envelope;
19 fn matches_envelope(envelope: &Envelope) -> bool;
20 fn from_envelope(envelope: Envelope) -> Option<Self>;
21}
22
23pub trait RequestMessage: EnvelopedMessage {
24 type Response: EnvelopedMessage;
25}
26
27macro_rules! message {
28 ($name:ident) => {
29 impl EnvelopedMessage for $name {
30 const NAME: &'static str = std::stringify!($name);
31
32 fn into_envelope(
33 self,
34 id: u32,
35 responding_to: Option<u32>,
36 original_sender_id: Option<u32>,
37 ) -> Envelope {
38 Envelope {
39 id,
40 responding_to,
41 original_sender_id,
42 payload: Some(envelope::Payload::$name(self)),
43 }
44 }
45
46 fn matches_envelope(envelope: &Envelope) -> bool {
47 matches!(&envelope.payload, Some(envelope::Payload::$name(_)))
48 }
49
50 fn from_envelope(envelope: Envelope) -> Option<Self> {
51 if let Some(envelope::Payload::$name(msg)) = envelope.payload {
52 Some(msg)
53 } else {
54 None
55 }
56 }
57 }
58 };
59}
60
61macro_rules! request_message {
62 ($req:ident, $resp:ident) => {
63 message!($req);
64 message!($resp);
65 impl RequestMessage for $req {
66 type Response = $resp;
67 }
68 };
69}
70
71request_message!(Auth, AuthResponse);
72request_message!(ShareWorktree, ShareWorktreeResponse);
73request_message!(OpenWorktree, OpenWorktreeResponse);
74request_message!(OpenBuffer, OpenBufferResponse);
75message!(CloseBuffer);
76
77/// A stream of protobuf messages.
78pub struct MessageStream<T> {
79 byte_stream: T,
80 buffer: Vec<u8>,
81}
82
83impl<T> MessageStream<T> {
84 pub fn new(byte_stream: T) -> Self {
85 Self {
86 byte_stream,
87 buffer: Default::default(),
88 }
89 }
90
91 pub fn inner_mut(&mut self) -> &mut T {
92 &mut self.byte_stream
93 }
94}
95
96impl<T> MessageStream<T>
97where
98 T: AsyncWrite + Unpin,
99{
100 /// Write a given protobuf message to the stream.
101 pub async fn write_message(&mut self, message: &Envelope) -> io::Result<()> {
102 let message_len: u32 = message
103 .encoded_len()
104 .try_into()
105 .map_err(|_| io::Error::new(io::ErrorKind::InvalidData, "message is too large"))?;
106 self.buffer.clear();
107 self.buffer.extend_from_slice(&message_len.to_be_bytes());
108 message.encode(&mut self.buffer)?;
109 self.byte_stream.write_all(&self.buffer).await
110 }
111}
112
113impl<T> MessageStream<T>
114where
115 T: AsyncRead + Unpin,
116{
117 /// Read a protobuf message of the given type from the stream.
118 pub async fn read_message(&mut self) -> io::Result<Envelope> {
119 let mut delimiter_buf = [0; 4];
120 self.byte_stream.read_exact(&mut delimiter_buf).await?;
121 let message_len = u32::from_be_bytes(delimiter_buf) as usize;
122 self.buffer.resize(message_len, 0);
123 self.byte_stream.read_exact(&mut self.buffer).await?;
124 Ok(Envelope::decode(self.buffer.as_slice())?)
125 }
126}
127
128impl Into<SystemTime> for Timestamp {
129 fn into(self) -> SystemTime {
130 UNIX_EPOCH
131 .checked_add(Duration::new(self.seconds, self.nanos))
132 .unwrap()
133 }
134}
135
136impl From<SystemTime> for Timestamp {
137 fn from(time: SystemTime) -> Self {
138 let duration = time.duration_since(UNIX_EPOCH).unwrap();
139 Self {
140 seconds: duration.as_secs(),
141 nanos: duration.subsec_nanos(),
142 }
143 }
144}
145
146#[cfg(test)]
147mod tests {
148 use super::*;
149 use std::{
150 pin::Pin,
151 task::{Context, Poll},
152 };
153
154 #[test]
155 fn test_round_trip_message() {
156 smol::block_on(async {
157 let byte_stream = ChunkedStream {
158 bytes: Vec::new(),
159 read_offset: 0,
160 chunk_size: 3,
161 };
162
163 let message1 = Auth {
164 user_id: 5,
165 access_token: "the-access-token".into(),
166 }
167 .into_envelope(3, None, None);
168
169 let message2 = OpenBuffer {
170 worktree_id: 0,
171 path: "some/path".to_string(),
172 }
173 .into_envelope(5, None, None);
174
175 let mut message_stream = MessageStream::new(byte_stream);
176 message_stream.write_message(&message1).await.unwrap();
177 message_stream.write_message(&message2).await.unwrap();
178 let decoded_message1 = message_stream.read_message().await.unwrap();
179 let decoded_message2 = message_stream.read_message().await.unwrap();
180 assert_eq!(decoded_message1, message1);
181 assert_eq!(decoded_message2, message2);
182 });
183 }
184
185 struct ChunkedStream {
186 bytes: Vec<u8>,
187 read_offset: usize,
188 chunk_size: usize,
189 }
190
191 impl AsyncWrite for ChunkedStream {
192 fn poll_write(
193 mut self: Pin<&mut Self>,
194 _: &mut Context<'_>,
195 buf: &[u8],
196 ) -> Poll<io::Result<usize>> {
197 let bytes_written = buf.len().min(self.chunk_size);
198 self.bytes.extend_from_slice(&buf[0..bytes_written]);
199 Poll::Ready(Ok(bytes_written))
200 }
201
202 fn poll_flush(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<io::Result<()>> {
203 Poll::Ready(Ok(()))
204 }
205
206 fn poll_close(self: Pin<&mut Self>, _: &mut Context<'_>) -> Poll<io::Result<()>> {
207 Poll::Ready(Ok(()))
208 }
209 }
210
211 impl AsyncRead for ChunkedStream {
212 fn poll_read(
213 mut self: Pin<&mut Self>,
214 _: &mut Context<'_>,
215 buf: &mut [u8],
216 ) -> Poll<io::Result<usize>> {
217 let bytes_read = buf
218 .len()
219 .min(self.chunk_size)
220 .min(self.bytes.len() - self.read_offset);
221 let end_offset = self.read_offset + bytes_read;
222 buf[0..bytes_read].copy_from_slice(&self.bytes[self.read_offset..end_offset]);
223 self.read_offset = end_offset;
224 Poll::Ready(Ok(bytes_read))
225 }
226 }
227}