reinhardt-test 0.4.0-alpha.2

Testing utilities and helpers for Reinhardt framework
Documentation
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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
//! Handler types for intercepting and responding to requests.

use std::collections::HashMap;
use std::time::Duration;

use super::matcher::{UrlMatcher, extract_path};
use super::response::MockResponse;
use super::state::{HandlerThreadSafety, OnceFlag, ResponseFn};

/// An intercepted HTTP request extracted from JS.
#[derive(Debug, Clone)]
pub struct InterceptedRequest {
	/// The request URL.
	pub url: String,
	/// The HTTP method.
	pub method: String,
	/// Request headers.
	pub headers: HashMap<String, String>,
	/// Request body, if present.
	pub body: Option<String>,
}

/// HTTP method for handler matching.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum Method {
	Get,
	Post,
	Put,
	Delete,
	Patch,
}

impl Method {
	pub(crate) fn as_str(&self) -> &'static str {
		match self {
			Method::Get => "GET",
			Method::Post => "POST",
			Method::Put => "PUT",
			Method::Delete => "DELETE",
			Method::Patch => "PATCH",
		}
	}
}

/// Type-erased handler interface for heterogeneous storage.
pub(crate) trait ErasedHandler: HandlerThreadSafety {
	fn matches(&self, req: &InterceptedRequest) -> bool;
	/// Build the response. Does NOT apply delay (caller handles that).
	fn respond(&self, req: &InterceptedRequest) -> Option<MockResponse>;
	fn is_consumed(&self) -> bool;
	/// Returns the delay duration if configured.
	fn delay(&self) -> Option<Duration>;
	/// Returns true if this is a network error handler.
	fn is_network_error(&self) -> bool;
}

/// Handler for REST endpoints.
pub struct RestHandler {
	method: Method,
	matcher: UrlMatcher,
	response_fn: Option<Box<ResponseFn>>,
	once: bool,
	consumed: OnceFlag,
	delay: Option<Duration>,
	network_error: bool,
}

impl RestHandler {
	pub(crate) fn new(
		method: Method,
		matcher: UrlMatcher,
		response_fn: Box<ResponseFn>,
		once: bool,
		delay: Option<Duration>,
	) -> Self {
		Self {
			method,
			matcher,
			response_fn: Some(response_fn),
			once,
			consumed: OnceFlag::new(false),
			delay,
			network_error: false,
		}
	}

	pub(crate) fn network_error(method: Method, matcher: UrlMatcher, once: bool) -> Self {
		Self {
			method,
			matcher,
			response_fn: None,
			once,
			consumed: OnceFlag::new(false),
			delay: None,
			network_error: true,
		}
	}
}

impl ErasedHandler for RestHandler {
	fn matches(&self, req: &InterceptedRequest) -> bool {
		if self.consumed.get() {
			return false;
		}
		req.method == self.method.as_str() && self.matcher.matches(&req.url)
	}

	fn respond(&self, req: &InterceptedRequest) -> Option<MockResponse> {
		if self.once {
			self.consumed.set(true);
		}
		self.response_fn.as_ref().map(|f| f(req))
	}

	fn is_consumed(&self) -> bool {
		self.consumed.get()
	}

	fn delay(&self) -> Option<Duration> {
		self.delay
	}

	fn is_network_error(&self) -> bool {
		self.network_error
	}
}

use std::marker::PhantomData;

use reinhardt_pages::server_fn::MockableServerFn;
use reinhardt_pages::server_fn::ServerFnError;

use super::context::TestContext;

#[cfg(native)]
type ServerFnResponseFn<S> = dyn Fn(<S as MockableServerFn>::Args) -> Result<<S as MockableServerFn>::Response, ServerFnError>
	+ Send
	+ Sync;

#[cfg(wasm)]
type ServerFnResponseFn<S> = dyn Fn(
	<S as MockableServerFn>::Args,
) -> Result<<S as MockableServerFn>::Response, ServerFnError>;

#[cfg(native)]
type ServerFnContextResponseFn<S> = dyn Fn(
		<S as MockableServerFn>::Args,
		&TestContext,
	) -> Result<<S as MockableServerFn>::Response, ServerFnError>
	+ Send
	+ Sync;

#[cfg(wasm)]
type ServerFnContextResponseFn<S> =
	dyn Fn(
		<S as MockableServerFn>::Args,
		&TestContext,
	) -> Result<<S as MockableServerFn>::Response, ServerFnError>;

/// Type-safe handler for server functions.
pub(crate) struct ServerFnHandler<S: MockableServerFn> {
	response_fn: Box<ServerFnResponseFn<S>>,
	once: bool,
	consumed: OnceFlag,
	delay: Option<Duration>,
	_marker: PhantomData<fn() -> S>,
}

impl<S: MockableServerFn> ServerFnHandler<S> {
	pub(crate) fn new(
		response_fn: Box<ServerFnResponseFn<S>>,
		once: bool,
		delay: Option<Duration>,
	) -> Self {
		Self {
			response_fn,
			once,
			consumed: OnceFlag::new(false),
			delay,
			_marker: PhantomData,
		}
	}
}

impl<S: MockableServerFn> ErasedHandler for ServerFnHandler<S> {
	fn matches(&self, req: &InterceptedRequest) -> bool {
		if self.consumed.get() {
			return false;
		}
		req.method == "POST" && extract_path(&req.url) == S::PATH
	}

	fn respond(&self, req: &InterceptedRequest) -> Option<MockResponse> {
		if self.once {
			self.consumed.set(true);
		}
		let body = req.body.as_deref().unwrap_or("{}");
		let args: S::Args = serde_json::from_str(body).ok()?;
		let result = (self.response_fn)(args);
		match result {
			Ok(response) => {
				let body = serde_json::to_string(&response).ok()?;
				Some(MockResponse {
					status: 200,
					headers: {
						let mut h = HashMap::new();
						h.insert("content-type".to_string(), "application/json".to_string());
						h
					},
					body,
				})
			}
			Err(err) => Some(server_fn_error_response(err)),
		}
	}

	fn is_consumed(&self) -> bool {
		self.consumed.get()
	}

	fn delay(&self) -> Option<Duration> {
		self.delay
	}

	fn is_network_error(&self) -> bool {
		false
	}
}

/// Type-safe handler for server functions with DI test context.
pub(crate) struct ServerFnContextHandler<S: MockableServerFn> {
	response_fn: Box<ServerFnContextResponseFn<S>>,
	context: TestContext,
	once: bool,
	consumed: OnceFlag,
	delay: Option<Duration>,
	_marker: PhantomData<fn() -> S>,
}

impl<S: MockableServerFn> ServerFnContextHandler<S> {
	pub(crate) fn new(
		context: TestContext,
		response_fn: Box<ServerFnContextResponseFn<S>>,
		once: bool,
		delay: Option<Duration>,
	) -> Self {
		Self {
			response_fn,
			context,
			once,
			consumed: OnceFlag::new(false),
			delay,
			_marker: PhantomData,
		}
	}
}

impl<S: MockableServerFn> ErasedHandler for ServerFnContextHandler<S> {
	fn matches(&self, req: &InterceptedRequest) -> bool {
		if self.consumed.get() {
			return false;
		}
		req.method == "POST" && extract_path(&req.url) == S::PATH
	}

	fn respond(&self, req: &InterceptedRequest) -> Option<MockResponse> {
		if self.once {
			self.consumed.set(true);
		}
		let body = req.body.as_deref().unwrap_or("{}");
		let args: S::Args = serde_json::from_str(body).ok()?;
		let result = (self.response_fn)(args, &self.context);
		match result {
			Ok(response) => {
				let body = serde_json::to_string(&response).ok()?;
				Some(MockResponse {
					status: 200,
					headers: {
						let mut h = HashMap::new();
						h.insert("content-type".to_string(), "application/json".to_string());
						h
					},
					body,
				})
			}
			Err(err) => Some(server_fn_error_response(err)),
		}
	}

	fn is_consumed(&self) -> bool {
		self.consumed.get()
	}

	fn delay(&self) -> Option<Duration> {
		self.delay
	}

	fn is_network_error(&self) -> bool {
		false
	}
}

fn server_fn_error_response(err: ServerFnError) -> MockResponse {
	let status = err.status().unwrap_or(500);
	let body = serde_json::to_string(&err)
		.expect("ServerFnError must serialize into its versioned error envelope");
	MockResponse {
		status,
		headers: {
			let mut h = HashMap::new();
			h.insert("content-type".to_string(), "application/json".to_string());
			h
		},
		body,
	}
}

#[cfg(test)]
mod tests {
	use super::*;
	use rstest::*;

	fn make_intercepted(url: &str, method: &str) -> InterceptedRequest {
		InterceptedRequest {
			url: url.to_string(),
			method: method.to_string(),
			headers: HashMap::new(),
			body: None,
		}
	}

	#[rstest]
	fn rest_handler_matches_method_and_url() {
		let handler = RestHandler::new(
			Method::Get,
			"/api/users".into(),
			Box::new(|_| MockResponse::empty()),
			false,
			None,
		);
		assert!(handler.matches(&make_intercepted("/api/users", "GET")));
		assert!(!handler.matches(&make_intercepted("/api/users", "POST")));
		assert!(!handler.matches(&make_intercepted("/api/posts", "GET")));
	}

	#[rstest]
	fn rest_handler_once_is_consumed_after_respond() {
		let handler = RestHandler::new(
			Method::Get,
			"/api/users".into(),
			Box::new(|_| MockResponse::empty()),
			true,
			None,
		);
		assert!(!handler.is_consumed());
		let _ = handler.respond(&make_intercepted("/api/users", "GET"));
		assert!(handler.is_consumed());
	}

	#[rstest]
	fn rest_handler_reusable_not_consumed() {
		let handler = RestHandler::new(
			Method::Get,
			"/api/users".into(),
			Box::new(|_| MockResponse::empty()),
			false,
			None,
		);
		let _ = handler.respond(&make_intercepted("/api/users", "GET"));
		let _ = handler.respond(&make_intercepted("/api/users", "GET"));
		assert!(!handler.is_consumed());
	}

	#[rstest]
	fn rest_handler_delay() {
		let handler = RestHandler::new(
			Method::Get,
			"/api/users".into(),
			Box::new(|_| MockResponse::empty()),
			false,
			Some(Duration::from_millis(100)),
		);
		assert_eq!(handler.delay(), Some(Duration::from_millis(100)));
	}

	#[rstest]
	fn network_error_handler() {
		let handler = RestHandler::network_error(Method::Get, "/api/fail".into(), false);
		assert!(handler.matches(&make_intercepted("/api/fail", "GET")));
		assert!(handler.is_network_error());
		assert!(
			handler
				.respond(&make_intercepted("/api/fail", "GET"))
				.is_none()
		);
	}

	#[rstest]
	fn server_fn_error_response_uses_the_versioned_json_envelope() {
		// Arrange
		let error = ServerFnError::server(503, "Mock unavailable");

		// Act
		let response = server_fn_error_response(error);
		let decoded: ServerFnError =
			serde_json::from_str(&response.body).expect("response must contain a ServerFnError");

		// Assert
		assert_eq!(response.status, 503);
		assert_eq!(
			response.headers.get("content-type"),
			Some(&"application/json".to_string())
		);
		assert_eq!(
			decoded.kind(),
			reinhardt_pages::server_fn::ServerFnErrorKind::Server
		);
		assert_eq!(decoded.status(), Some(503));
		assert_eq!(decoded.user_message(), "Mock unavailable");
	}
}