rivet-envoy-protocol 3.0.0-preview.4

Versioned Envoy protocol types for Rivet actor hosts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

use anyhow::Result;
use vbare::{Bytes, DecodeError, DecodeErrorKind, Encode, EncodeError, Sink, Versioned};

use crate::generated::v8;

/// The oldest Envoy protocol version a v3 Engine accepts. v8 shipped with RivetKit 2.3.20.
pub const MIN_PROTOCOL_VERSION: u16 = 8;

/// Implements [`Versioned`] for an envelope `enum $name { V8(v8::$name) }`.
///
/// v8 is both the latest and the oldest supported version, so there are no converters. vbare
/// never calls `decode_version` for the latest version, so every version it sees is refused.
macro_rules! impl_versioned {
	($name:ident) => {
		impl Versioned for $name {
			type Latest = v8::$name;

			const LATEST: u16 = 8;

			fn wrap_latest(latest: Self::Latest) -> Self {
				Self::V8(latest)
			}

			fn unwrap_latest(self) -> Result<Self::Latest> {
				match self {
					Self::V8(x) => Ok(x),
				}
			}

			fn decode_version(version: u16, _body: Bytes) -> std::result::Result<Self, DecodeError> {
				Err(DecodeError::with_detail(
					DecodeErrorKind::UnsupportedVersion,
					0,
					format!(
						"unsupported envoy protocol version {version}, the oldest supported is {MIN_PROTOCOL_VERSION}"
					),
				))
			}

			fn encode_version<S: Sink>(
				&self,
				version: u16,
				out: &mut S,
			) -> std::result::Result<(), EncodeError> {
				if version < MIN_PROTOCOL_VERSION {
					return Err(EncodeError::UnsupportedVersion(version));
				}
				match self {
					Self::V8(x) => x.encode(out),
				}
				Ok(())
			}
		}
	};
}

// MARK: ToEnvoy

pub enum ToEnvoy {
	V8(v8::ToEnvoy),
}

impl_versioned!(ToEnvoy);

// MARK: ToRivet

pub enum ToRivet {
	V8(v8::ToRivet),
}

impl_versioned!(ToRivet);

// MARK: ToEnvoyConn

pub enum ToEnvoyConn {
	V8(v8::ToEnvoyConn),
}

impl_versioned!(ToEnvoyConn);

// MARK: ToGateway

pub enum ToGateway {
	V8(v8::ToGateway),
}

impl_versioned!(ToGateway);

// MARK: ToOutbound

pub enum ToOutbound {
	V8(v8::ToOutbound),
}

impl_versioned!(ToOutbound);

// MARK: ActorCommandKeyData

pub enum ActorCommandKeyData {
	V8(v8::ActorCommandKeyData),
}

impl_versioned!(ActorCommandKeyData);

// MARK: Tests