waymark 0.1.0

Pathfinding and spatial queries on navigation meshes
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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
//! Comprehensive invalid parameter validation tests
//!
//! This module tests edge cases and invalid parameter handling to ensure
//! robust error handling that exceeds the C++ implementation.

#[cfg(test)]
mod tests {
    use crate::nav_mesh_query::NavMeshQuery;
    use crate::{NavMesh, NavMeshParams, PolyRef, QueryFilter};
    use glam::Vec3;

    #[test]
    fn test_navmesh_invalid_params() {
        // Test invalid NavMeshParams

        // Zero tile dimensions
        let invalid_params1 = NavMeshParams {
            origin: [0.0, 0.0, 0.0],
            tile_width: 0.0, // Invalid
            tile_height: 10.0,
            max_tiles: 1,
            max_polys_per_tile: 1,
        };
        assert!(NavMesh::new(invalid_params1).is_err());

        // Negative tile dimensions
        let invalid_params2 = NavMeshParams {
            origin: [0.0, 0.0, 0.0],
            tile_width: -10.0, // Invalid
            tile_height: 10.0,
            max_tiles: 1,
            max_polys_per_tile: 1,
        };
        assert!(NavMesh::new(invalid_params2).is_err());

        // Zero max tiles
        let invalid_params3 = NavMeshParams {
            origin: [0.0, 0.0, 0.0],
            tile_width: 10.0,
            tile_height: 10.0,
            max_tiles: 0, // Invalid
            max_polys_per_tile: 1,
        };
        assert!(NavMesh::new(invalid_params3).is_err());

        // Zero max polys per tile
        let invalid_params4 = NavMeshParams {
            origin: [0.0, 0.0, 0.0],
            tile_width: 10.0,
            tile_height: 10.0,
            max_tiles: 1,
            max_polys_per_tile: 0, // Invalid
        };
        assert!(NavMesh::new(invalid_params4).is_err());
    }

    #[test]
    fn test_query_invalid_polygon_refs() -> Result<(), Box<dyn std::error::Error>> {
        // Create minimal valid navmesh
        let params = NavMeshParams {
            origin: [0.0, 0.0, 0.0],
            tile_width: 10.0,
            tile_height: 10.0,
            max_tiles: 1,
            max_polys_per_tile: 1,
        };
        let nav_mesh = NavMesh::new(params)?;
        let query = NavMeshQuery::new(&nav_mesh);
        let filter = QueryFilter::default();

        // Test with invalid (zero) polygon reference
        let invalid_ref = PolyRef::new(0);
        let pos = Vec3::new(5.0, 0.0, 5.0);
        let dir = Vec3::new(1.0, 0.0, 0.0);

        // All these should return proper errors, not crash
        assert!(query.raycast(invalid_ref, pos, dir, 10.0, &filter).is_err());
        assert!(query.closest_point_on_poly(invalid_ref, pos).is_err());

        // Test with very large polygon reference (invalid)
        let huge_ref = PolyRef::new(0xFFFFFFFF);
        assert!(query.raycast(huge_ref, pos, dir, 10.0, &filter).is_err());
        assert!(
            query
                .closest_point_on_poly(huge_ref, Vec3::from(pos))
                .is_err()
        );

        Ok(())
    }

    #[test]
    fn test_query_invalid_positions() -> Result<(), Box<dyn std::error::Error>> {
        let params = NavMeshParams {
            origin: [0.0, 0.0, 0.0],
            tile_width: 10.0,
            tile_height: 10.0,
            max_tiles: 1,
            max_polys_per_tile: 1,
        };
        let nav_mesh = NavMesh::new(params)?;
        let query = NavMeshQuery::new(&nav_mesh);
        let filter = QueryFilter::default();

        // Test with NaN positions
        let nan_pos = [f32::NAN, 0.0, 0.0];
        let valid_pos = [5.0, 0.0, 5.0];
        let half_extents = [1.0, 1.0, 1.0];

        // Should handle NaN gracefully
        let result =
            query.find_nearest_poly(Vec3::from(nan_pos), Vec3::from(half_extents), &filter);
        assert!(result.is_err() || result.unwrap().0 == PolyRef::new(0));

        // Test with infinite positions
        let inf_pos = [f32::INFINITY, 0.0, 0.0];
        let result2 =
            query.find_nearest_poly(Vec3::from(inf_pos), Vec3::from(half_extents), &filter);
        assert!(result2.is_err() || result2.unwrap().0 == PolyRef::new(0));

        // Test with very large coordinates
        let huge_pos = [1e30, 0.0, 1e30];
        let result3 =
            query.find_nearest_poly(Vec3::from(huge_pos), Vec3::from(half_extents), &filter);
        // Should not crash, either succeed or fail gracefully
        assert!(result3.is_ok() || result3.is_err());

        Ok(())
    }

    #[test]
    fn test_query_invalid_extents() -> Result<(), Box<dyn std::error::Error>> {
        let params = NavMeshParams {
            origin: [0.0, 0.0, 0.0],
            tile_width: 10.0,
            tile_height: 10.0,
            max_tiles: 1,
            max_polys_per_tile: 1,
        };
        let nav_mesh = NavMesh::new(params)?;
        let query = NavMeshQuery::new(&nav_mesh);
        let filter = QueryFilter::default();

        let pos = [5.0, 0.0, 5.0];

        // Test with zero extents
        let zero_extents = [0.0, 0.0, 0.0];
        let result = query.find_nearest_poly(Vec3::from(pos), Vec3::from(zero_extents), &filter);
        // Should either succeed (finding exact position) or fail gracefully
        assert!(result.is_ok() || result.is_err());

        // Test with negative extents
        let neg_extents = [-1.0, -1.0, -1.0];
        let result2 = query.find_nearest_poly(Vec3::from(pos), Vec3::from(neg_extents), &filter);
        // Should handle negative extents gracefully
        assert!(result2.is_ok() || result2.is_err());

        // Test with NaN extents
        let nan_extents = [f32::NAN, 1.0, 1.0];
        let result3 = query.find_nearest_poly(Vec3::from(pos), Vec3::from(nan_extents), &filter);
        assert!(result3.is_err() || result3.unwrap().0 == PolyRef::new(0));

        Ok(())
    }

    #[test]
    fn test_raycast_invalid_directions() -> Result<(), Box<dyn std::error::Error>> {
        let params = NavMeshParams {
            origin: [0.0, 0.0, 0.0],
            tile_width: 10.0,
            tile_height: 10.0,
            max_tiles: 1,
            max_polys_per_tile: 1,
        };
        let nav_mesh = NavMesh::new(params)?;
        let query = NavMeshQuery::new(&nav_mesh);
        let filter = QueryFilter::default();

        // We can't easily get a valid polygon ref without mesh data,
        // but we can test the parameter validation
        let dummy_ref = PolyRef::new(1);
        let pos = Vec3::new(5.0, 0.0, 5.0);

        // Test with zero direction vector
        let zero_dir = Vec3::new(0.0, 0.0, 0.0);
        let result = query.raycast(dummy_ref, pos, zero_dir, 10.0, &filter);
        // Should handle zero direction gracefully (either error or no movement)
        assert!(result.is_err() || result.unwrap().2 == 0.0);

        // Test with NaN direction
        let nan_dir = Vec3::new(f32::NAN, 0.0, 0.0);
        let result2 = query.raycast(dummy_ref, pos, nan_dir, 10.0, &filter);
        assert!(result2.is_err());

        // Test with infinite direction
        let inf_dir = Vec3::new(f32::INFINITY, 0.0, 0.0);
        let result3 = query.raycast(dummy_ref, pos, inf_dir, 10.0, &filter);
        assert!(result3.is_err());

        Ok(())
    }

    #[test]
    fn test_raycast_invalid_distances() -> Result<(), Box<dyn std::error::Error>> {
        let params = NavMeshParams {
            origin: [0.0, 0.0, 0.0],
            tile_width: 10.0,
            tile_height: 10.0,
            max_tiles: 1,
            max_polys_per_tile: 1,
        };
        let nav_mesh = NavMesh::new(params)?;
        let query = NavMeshQuery::new(&nav_mesh);
        let filter = QueryFilter::default();

        let dummy_ref = PolyRef::new(1);
        let pos = Vec3::new(5.0, 0.0, 5.0);
        let dir = Vec3::new(1.0, 0.0, 0.0);

        // Test with negative distance
        let result = query.raycast(dummy_ref, pos, dir, -10.0, &filter);
        // Should handle negative distance gracefully
        assert!(result.is_err() || result.unwrap().2 == 0.0);

        // Test with NaN distance
        let result2 = query.raycast(dummy_ref, pos, dir, f32::NAN, &filter);
        assert!(result2.is_err());

        // Test with infinite distance
        let result3 = query.raycast(dummy_ref, pos, dir, f32::INFINITY, &filter);
        // Should either error or handle large distances
        assert!(result3.is_ok() || result3.is_err());

        Ok(())
    }

    #[test]
    fn test_pathfinding_invalid_params() -> Result<(), Box<dyn std::error::Error>> {
        let params = NavMeshParams {
            origin: [0.0, 0.0, 0.0],
            tile_width: 10.0,
            tile_height: 10.0,
            max_tiles: 1,
            max_polys_per_tile: 1,
        };
        let nav_mesh = NavMesh::new(params)?;
        let mut query = NavMeshQuery::new(&nav_mesh);
        let filter = QueryFilter::default();

        let invalid_ref = PolyRef::new(0);
        let valid_ref = PolyRef::new(1); // May not exist, but not zero
        let pos = [5.0, 0.0, 5.0];

        // Test pathfinding with invalid start ref
        let result = query.find_path(
            invalid_ref,
            valid_ref,
            Vec3::from(pos),
            Vec3::from(pos),
            &filter,
        );
        assert!(result.is_err());

        // Test pathfinding with invalid end ref
        let result2 = query.find_path(
            valid_ref,
            invalid_ref,
            Vec3::from(pos),
            Vec3::from(pos),
            &filter,
        );
        assert!(result2.is_err());

        // Test pathfinding with same start and end (edge case)
        let result3 = query.find_path(
            valid_ref,
            valid_ref,
            Vec3::from(pos),
            Vec3::from(pos),
            &filter,
        );
        // Should either succeed immediately or fail gracefully
        assert!(result3.is_ok() || result3.is_err());

        Ok(())
    }

    #[test]
    fn test_sliced_pathfinding_invalid_params() -> Result<(), Box<dyn std::error::Error>> {
        let params = NavMeshParams {
            origin: [0.0, 0.0, 0.0],
            tile_width: 10.0,
            tile_height: 10.0,
            max_tiles: 1,
            max_polys_per_tile: 1,
        };
        let nav_mesh = NavMesh::new(params)?;
        let mut query = NavMeshQuery::new(&nav_mesh);
        let filter = QueryFilter::default();

        let invalid_ref = PolyRef::new(0);
        let valid_ref = PolyRef::new(1);
        let pos = [5.0, 0.0, 5.0];

        // Test sliced pathfinding init with invalid refs
        let result = query.init_sliced_find_path(
            invalid_ref,
            valid_ref,
            Vec3::from(pos),
            Vec3::from(pos),
            &filter,
            0,
        );
        assert!(result.is_err());

        // Test update without init
        let result2 = query.update_sliced_find_path(10);
        assert!(result2.is_err()); // Should require init first

        // Test finalize without init
        let result3 = query.finalize_sliced_find_path(100);
        assert!(result3.is_err()); // Should require init first

        Ok(())
    }

    #[test]
    fn test_query_filter_edge_cases() -> Result<(), Box<dyn std::error::Error>> {
        let params = NavMeshParams {
            origin: [0.0, 0.0, 0.0],
            tile_width: 10.0,
            tile_height: 10.0,
            max_tiles: 1,
            max_polys_per_tile: 1,
        };
        let nav_mesh = NavMesh::new(params)?;
        let query = NavMeshQuery::new(&nav_mesh);

        // Test filter that excludes everything
        let mut exclude_all_filter = QueryFilter::default();
        exclude_all_filter.include_flags = crate::PolyFlags::empty(); // Include nothing

        let pos = [5.0, 0.0, 5.0];
        let half_extents = [1.0, 1.0, 1.0];

        let result = query.find_nearest_poly(
            Vec3::from(pos),
            Vec3::from(half_extents),
            &exclude_all_filter,
        );
        // Should fail to find any polygons
        assert!(result.is_err() || result.unwrap().0 == PolyRef::new(0));

        // Test filter with extreme area costs
        let mut extreme_cost_filter = QueryFilter::default();
        extreme_cost_filter.area_cost[0] = f32::INFINITY;

        // Should handle infinite costs gracefully
        let result2 = query.find_nearest_poly(
            Vec3::from(pos),
            Vec3::from(half_extents),
            &extreme_cost_filter,
        );
        assert!(result2.is_ok() || result2.is_err());

        Ok(())
    }

    #[test]
    fn test_mesh_memory_safety() {
        // Test creating very large mesh parameters (should fail gracefully)
        let huge_params = NavMeshParams {
            origin: [0.0, 0.0, 0.0],
            tile_width: 10.0,
            tile_height: 10.0,
            max_tiles: i32::MAX,          // Extreme value
            max_polys_per_tile: i32::MAX, // Extreme value
        };

        // Should fail gracefully, not crash or allocate excessive memory
        let result = NavMesh::new(huge_params);
        assert!(result.is_err());
    }

    #[test]
    fn test_concurrent_access_safety() -> Result<(), Box<dyn std::error::Error>> {
        // Test that read-only queries are safe for concurrent access
        let params = NavMeshParams {
            origin: [0.0, 0.0, 0.0],
            tile_width: 10.0,
            tile_height: 10.0,
            max_tiles: 1,
            max_polys_per_tile: 1,
        };
        let nav_mesh = NavMesh::new(params)?;
        let query = NavMeshQuery::new(&nav_mesh);
        let filter = QueryFilter::default();

        // This is mainly a compile-time test - NavMeshQuery should be Send + Sync
        // for read-only operations
        let pos = [5.0, 0.0, 5.0];
        let half_extents = [1.0, 1.0, 1.0];

        // Multiple queries should not interfere (if they were concurrent)
        for _ in 0..10 {
            let _result =
                query.find_nearest_poly(Vec3::from(pos), Vec3::from(half_extents), &filter);
            // Results may fail due to no mesh data, but should not crash
        }

        Ok(())
    }

    #[test]
    fn test_rust_specific_safety() {
        // Test Rust-specific safety improvements over C++

        // 1. No null pointer dereferences (automatic with Rust)
        // 2. No buffer overflows (automatic with Rust bounds checking)
        // 3. No memory leaks (automatic with Rust RAII)
        // 4. No use-after-free (automatic with Rust borrow checker)

        // These are compile-time guarantees in Rust, but let's test some edge cases

        // Test vector bounds checking (should panic in debug, not corrupt memory)
        let mut test_vec = vec![1, 2, 3];
        let _last = test_vec.pop(); // Safe operation

        // Test option handling (no null pointer equivalent)
        let maybe_value: Option<i32> = None;
        assert!(maybe_value.is_none()); // Safe check

        // Test that our error types are properly defined
        use crate::Status;
        let status = Status::InvalidParam;
        assert!(!status.to_string().is_empty());
    }
}